Enable documents module by default when real-time collaboration is enabled

Note: For existing instances, documents will only be added to defaults
if real-time collaboration is enabled when the migration runs.
Enabling collaboration later requires manual addition to default modules.

Author: akabiru

app/seeders/standard.yml

@@ -91,6 +91,7 @@ projects:
       - board_view
       - team_planner_view
       - meetings
+      - documents
     news:
       - t_title: Welcome to your demo project
         t_summary: |
@@ -389,6 +390,7 @@ projects:
       - work_package_tracking
       - gantt
       - board_view
+      - documents
     news:
       - t_title: Welcome to your Scrum demo project
         t_summary: |

config/constants/settings/definition.rb

@@ -346,7 +346,14 @@ class Definition
         allowed: -> { Redmine::I18n.all_languages }
       },
       default_projects_modules: {
-        default: %w[calendar board_view work_package_tracking gantt news costs wiki],
+        default: -> {
+          base_modules = %w[calendar board_view work_package_tracking gantt news costs wiki]
+          if Setting.real_time_text_collaboration_enabled?
+            base_modules + %w[documents]
+          else
+            base_modules
+          end
+        },
         allowed: -> { OpenProject::AccessControl.available_project_modules.map(&:to_s) }
       },
       default_projects_public: {

db/migrate/20260106151226_add_documents_to_default_projects_modules.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+#-- copyright
+# OpenProject is an open source project management software.
+# Copyright (C) the OpenProject GmbH
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License version 3.
+#
+# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
+# Copyright (C) 2006-2013 Jean-Philippe Lang
+# Copyright (C) 2010-2013 the ChiliProject Team
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+# See COPYRIGHT and LICENSE files for more details.
+#++
+
+class AddDocumentsToDefaultProjectsModules < ActiveRecord::Migration[8.0]
+  def up
+    return unless Setting.real_time_text_collaboration_enabled?
+
+    # Only update if setting exists in DB (avoid updating on new installations - seeder handles that)
+    setting = Setting.find_by(name: "default_projects_modules")
+    return unless setting
+
+    current_modules = setting.value || []
+    return if current_modules.include?("documents")
+
+    Setting.default_projects_modules = current_modules + ["documents"]
+  end
+
+  def down
+    # No-op
+  end
+end

spec/migrations/add_documents_to_default_projects_modules_spec.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+#-- copyright
+# OpenProject is an open source project management software.
+# Copyright (C) the OpenProject GmbH
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License version 3.
+#
+# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
+# Copyright (C) 2006-2013 Jean-Philippe Lang
+# Copyright (C) 2010-2013 the ChiliProject Team
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+# See COPYRIGHT and LICENSE files for more details.
+#++
+
+require "spec_helper"
+require Rails.root.join("db/migrate/20260106151226_add_documents_to_default_projects_modules")
+
+RSpec.describe AddDocumentsToDefaultProjectsModules, type: :model do
+  let(:base_modules) { %w[calendar board_view work_package_tracking gantt news costs wiki] }
+
+  before do
+    # Ensure a clean state
+    Setting.find_by(name: "default_projects_modules")&.destroy
+    Setting.clear_cache
+  end
+
+  context "when real_time_text_collaboration is enabled",
+          with_settings: { real_time_text_collaboration_enabled: true } do
+    context "when default_projects_modules setting exists in DB" do
+      before do
+        Setting.default_projects_modules = base_modules
+      end
+
+      it "adds documents to the default modules" do
+        ActiveRecord::Migration.suppress_messages { described_class.migrate(:up) }
+
+        Setting.clear_cache
+        expect(Setting.default_projects_modules).to include("documents")
+      end
+
+      it "preserves existing modules" do
+        ActiveRecord::Migration.suppress_messages { described_class.migrate(:up) }
+
+        Setting.clear_cache
+        expect(Setting.default_projects_modules).to include(*base_modules)
+      end
+
+      context "when documents is already in the default modules" do
+        before do
+          Setting.default_projects_modules = base_modules + ["documents"]
+        end
+
+        it "does not duplicate documents" do
+          ActiveRecord::Migration.suppress_messages { described_class.migrate(:up) }
+
+          Setting.clear_cache
+          expect(Setting.default_projects_modules.count("documents")).to eq(1)
+        end
+      end
+    end
+
+    context "when default_projects_modules setting does not exist in DB" do
+      it "does not create the setting (seeder handles new installations)" do
+        expect(Setting.find_by(name: "default_projects_modules")).to be_nil
+
+        ActiveRecord::Migration.suppress_messages { described_class.migrate(:up) }
+
+        # Setting should still not exist - seeder will handle it
+        expect(Setting.find_by(name: "default_projects_modules")).to be_nil
+      end
+    end
+  end
+
+  context "when real_time_text_collaboration is disabled",
+          with_settings: { real_time_text_collaboration_enabled: false } do
+    before do
+      Setting.default_projects_modules = base_modules
+    end
+
+    it "does not modify the default modules" do
+      ActiveRecord::Migration.suppress_messages { described_class.migrate(:up) }
+
+      Setting.clear_cache
+      expect(Setting.default_projects_modules).not_to include("documents")
+      expect(Setting.default_projects_modules).to match_array(base_modules)
+    end
+  end
+end

spec/models/setting_spec.rb

@@ -603,4 +603,30 @@
       end
     end
   end
+
+  describe "default_projects_modules conditional default" do
+    context "when real_time_text_collaboration is enabled",
+            with_settings: { real_time_text_collaboration_enabled: true } do
+      it "includes documents in the default modules" do
+        expect(Settings::Definition[:default_projects_modules].default).to include("documents")
+      end
+
+      it "includes the base modules" do
+        base_modules = %w[calendar board_view work_package_tracking gantt news costs wiki]
+        expect(Settings::Definition[:default_projects_modules].default).to include(*base_modules)
+      end
+    end
+
+    context "when real_time_text_collaboration is disabled",
+            with_settings: { real_time_text_collaboration_enabled: false } do
+      it "does not include documents in the default modules" do
+        expect(Settings::Definition[:default_projects_modules].default).not_to include("documents")
+      end
+
+      it "includes the base modules" do
+        base_modules = %w[calendar board_view work_package_tracking gantt news costs wiki]
+        expect(Settings::Definition[:default_projects_modules].default).to include(*base_modules)
+      end
+    end
+  end
 end