openproject/lib/api/v3/relations/relation_collection_representer.rb

#-- encoding: UTF-8
#-- copyright
# OpenProject is a project management system.
# Copyright (C) 2012-2015 the OpenProject Foundation (OPF)
#
# 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 doc/COPYRIGHT.rdoc for more details.
#++

module API
  module V3
    module Relations
      class RelationCollectionRepresenter < ::API::Decorators::UnpaginatedCollection
        element_decorator ::API::V3::Relations::RelationRepresenter

        # TODO: we should not pass in the work_package here.  It is done,
        # so that we can differentiate the relation type e.g.
        # Relation::Follows vs. Relation::Precedes.  However, this causes
        # the relation (a resource in it's own right) to change depending
        # on the work package this is queried for.  We could either:
        # * change the relation self href to only be valid within a work
        #   package scope
        # * remove the difference between the relation pairs
        #   (e.g. Follows/Precedes) and by that remove the necessity to have
        #   work package passed in.

        def initialize(models, self_link, current_user:, work_package: nil)
          @work_package = work_package
          super(models, self_link, current_user: current_user)
        end

        collection :elements,
                   getter: -> (*) {
                     represented.map { |model|
                       element_decorator.create(model,
                                                current_user: current_user,
                                                work_package: @work_package)
                     }
                   },
                   exec_context: :decorator,
                   embedded: true
      end
    end
  end
end