openproject/app/seeders/basic_data/role_seeder.rb

#-- encoding: UTF-8

#-- copyright
# OpenProject is an open source project management software.
# Copyright (C) 2012-2021 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 BasicData
  class RoleSeeder < Seeder
    def seed_data!
      Role.transaction do
        roles.each do |attributes|
          Role.create!(attributes)
        end

        global_roles.each do |attributes|
          GlobalRole.create!(attributes)
        end

        builtin_roles.each do |attributes|
          Role.find_by!(name: attributes[:name]).update(attributes)
        end
      end
    end

    def applicable?
      Role.where(builtin: false).empty?
    end

    def not_applicable_message
      'Skipping roles as there are already some configured'
    end

    def roles
      [project_admin, member, reader]
    end

    def global_roles
      [project_creator]
    end

    def builtin_roles
      [non_member, anonymous]
    end

    def member
      {
        name: I18n.t(:default_role_member),
        position: 3,
        permissions: %i[
          view_work_packages
          export_work_packages
          add_work_packages
          move_work_packages
          edit_work_packages
          assign_versions
          add_work_package_notes
          edit_own_work_package_notes
          manage_work_package_relations
          manage_subtasks
          manage_public_queries
          save_queries
          view_work_package_watchers
          add_work_package_watchers
          delete_work_package_watchers
          view_calendar
          comment_news
          manage_news
          log_time
          view_time_entries
          view_own_time_entries
          edit_own_time_entries
          view_timelines
          edit_timelines
          delete_timelines
          view_reportings
          edit_reportings
          delete_reportings
          manage_wiki
          manage_wiki_menu
          rename_wiki_pages
          change_wiki_parent_page
          delete_wiki_pages
          view_wiki_pages
          export_wiki_pages
          view_wiki_edits
          edit_wiki_pages
          delete_wiki_pages_attachments
          protect_wiki_pages
          list_attachments
          add_messages
          edit_own_messages
          delete_own_messages
          browse_repository
          view_changesets
          commit_access
          view_commit_author_statistics
          view_members
          manage_board_views
          show_board_views
        ]
      }
    end

    def reader
      {
        name: I18n.t(:default_role_reader),
        position: 4,
        permissions: %i[
          view_work_packages
          add_work_package_notes
          edit_own_work_package_notes
          save_queries
          view_calendar
          comment_news
          view_timelines
          view_reportings
          view_wiki_pages
          export_wiki_pages
          list_attachments
          add_messages
          edit_own_messages
          delete_own_messages
          browse_repository
          view_changesets
          show_board_views
        ]
      }
    end

    def project_admin
      {
        name: I18n.t(:default_role_project_admin),
        position: 5,
        permissions: Roles::CreateContract.new(Role.new, nil).assignable_permissions.map(&:name)
      }
    end

    def non_member
      {
        name: I18n.t(:default_role_non_member),
        permissions: %i[
          view_work_packages
          view_calendar
          comment_news
          browse_repository
          view_changesets
          view_wiki_pages
          show_board_views
        ]
      }
    end

    def anonymous
      {
        name: I18n.t(:default_role_anonymous),
        permissions: %i[
          view_work_packages
          browse_repository
          view_changesets
          view_wiki_pages
        ]
      }
    end

    def project_creator
      {
        name: I18n.t(:default_role_project_creator_and_staff_manager),
        position: 6,
        permissions: %i[
          add_project
          manage_user
          manage_placeholder_user
        ]
      }
    end
  end
end