openproject/app/models/projects/exports/query_exporter.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 Projects::Exports
  class QueryExporter < Exports::Exporter
    self.model = Project

    alias :query :object

    def columns
      @columns ||= (forced_columns + selected_columns)
    end

    def page
      options[:page] || 1
    end

    def projects
      @projects ||= query
                      .results
                      .page(page)
                      .per_page(Setting.work_packages_export_limit.to_i)
    end

    private

    def forced_columns
      [
        { name: :id, caption: Project.human_attribute_name(:id) },
        { name: :identifier, caption: Project.human_attribute_name(:identifier) },
        { name: :name, caption: Project.human_attribute_name(:name) }
      ]
    end

    def selected_columns
      ::Projects::TableCell
        .new(nil, current_user: User.current)
        .all_columns
        .reject { |_, options| options[:builtin] } # We add builtin columns ourselves
        .select { |name, _| Setting.enabled_projects_columns.include?(name.to_s) }
        .map { |name, options| { name: name, caption: options[:caption] } }
    end
  end
end