openproject/app/seeders/demo_data/project_seeder.rb

#-- copyright

# OpenProject is an open source project management software.
# Copyright (C) 2012-2023 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.
module DemoData
  class ProjectSeeder < Seeder
    # Careful: The seeding recreates the seeded project before it runs, so any changes
    # on the seeded project will be lost.
    def seed_data!
      puts ' ↳ Updating settings'
      seed_settings

      seed_projects = demo_data_for('projects').keys

      seed_projects.each do |key|
        puts " ↳ Creating #{key} project..."

        puts '   -Creating/Resetting project'
        project = reset_project key

        puts '   -Setting project status.'
        set_project_status(project, key)

        puts '   -Setting members.'
        set_members(project)

        puts '   -Creating news.'
        seed_news(project, key)

        puts '   -Assigning types.'
        set_types(project, key)

        puts '   -Creating categories'
        seed_categories(project, key)

        puts '   -Creating versions.'
        seed_versions(project, key)

        puts '   -Creating queries.'
        seed_queries(project, key)

        project_data_seeders(project, key).each do |seeder|
          puts "   -#{seeder.class.name.demodulize}"
          seeder.seed!
        end

        Setting.demo_projects_available = true
      end

      puts ' ↳ Assign groups to projects'
      set_groups

      puts ' ↳ Update form configuration with global queries'
      set_form_configuration
    end

    def applicable?
      Project.count.zero?
    end

    def project_data_seeders(project, key)
      seeders = [
        DemoData::WikiSeeder,
        DemoData::CustomFieldSeeder,
        DemoData::WorkPackageSeeder,
        DemoData::WorkPackageBoardSeeder
      ]

      seeders.map { |seeder| seeder.new project, key }
    end

    def seed_settings
      seedable_welcome_settings
        .select { |k,| Settings::Definition[k].writable? }
        .each do |k, v|
        Setting[k] = v
      end
    end

    def seedable_welcome_settings
      welcome = demo_data_for('welcome')
      return {} if welcome.blank?

      {
        welcome_title: welcome[:title],
        welcome_text: welcome[:text],
        welcome_on_homescreen: 1
      }
    end

    def reset_project(key)
      delete_project(key)
      create_project(key)
    end

    def create_project(key)
      Project.create! project_data(key)
    end

    def delete_project(key)
      if delete_me = find_project(key)
        delete_me.destroy
      end
    end

    def set_project_status(project, key)
      status_code = project_data_for(key, 'status.code')
      status_explanation = project_data_for(key, 'status.description')

      if status_code || status_explanation
        Projects::Status.create!(
          project:,
          code: status_code,
          explanation: status_explanation
        )
      end
    end

    def set_members(project)
      role = Role.find_by(name: translate_with_base_url(:default_role_project_admin))
      user = User.user.admin.first

      Member.create!(
        project:,
        principal: user,
        roles: [role]
      )
    end

    def set_groups
      DemoData::GroupSeeder.new.add_projects_to_groups
    end

    def set_form_configuration
      Type.all.each do |type|
        BasicData::TypeSeeder.new.set_attribute_groups_for_type(type)
      end
    end

    def set_types(project, key)
      project.types.clear
      Array(project_data_for(key, 'types')).each do |type_name|
        type = Type.find_by(name: translate_with_base_url(type_name))
        project.types << type
      end
    end

    def seed_categories(project, key)
      Array(project_data_for(key, 'categories')).each do |cat_name|
        project.categories.create name: cat_name
      end
    end

    def seed_news(project, key)
      user = User.admin.first
      Array(project_data_for(key, 'news')).each do |news|
        News.create! project:, author: user, title: news[:title], summary: news[:summary], description: news[:description]
      end
    end

    def seed_queries(project, key)
      Array(project_data_for(key, 'queries')).each do |config|
        QueryBuilder.new(config, project).create!
      end
    end

    def seed_versions(project, key)
      version_data = Array(project_data_for(key, 'versions'))

      version_data.each do |attributes|
        VersionBuilder.new(attributes, project).create!
      end
    end

    def seed_board(project)
      Forum.create!(
        project:,
        name: demo_data_for('board.name'),
        description: demo_data_for('board.description')
      )
    end

    module Data
      module_function

      def project_data(key)
        {
          name: project_name(key),
          identifier: project_identifier(key),
          description: project_description(key),
          enabled_module_names: project_modules(key),
          types: project_types,
          parent_id: parent_project_id(key)
        }
      end

      def parent_project_id(key)
        parent_project(key).try(:id)
      end

      def parent_project(key)
        identifier = project_data_for(key, 'parent')
        return nil unless identifier.present?

        Project.find_by(identifier:)
      end

      def project_name(key)
        project_data_for(key, 'name')
      end

      def project_identifier(key)
        project_data_for(key, 'identifier')
      end

      def project_description(key)
        project_data_for(key, 'description')
      end

      def project_types
        Type.all
      end

      def project_modules(key)
        project_data_for(key, 'modules')
      end

      def find_project(key)
        Project.find_by(identifier: project_identifier(key))
      end
    end

    include Data
  end
end