OpenProject is the leading open source project management software.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
openproject/lib/api/decorators/collection.rb

86 lines
2.6 KiB

#-- 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 docs/COPYRIGHT.rdoc for more details.
#++
module API
module Decorators
class Collection < ::API::Decorators::Single
include API::Utilities::UrlHelper
def initialize(models, total, self_link:, current_user:)
@total = total
@self_link = self_link
super(models, current_user: current_user)
end
class_attribute :element_decorator_class
def self.element_decorator(klass)
self.element_decorator_class = klass
end
def element_decorator
self.class.element_decorator_class || deduce_element_decorator
end
def deduce_element_decorator
name = self.class.name
unless name.end_with?('CollectionRepresenter')
raise ArgumentError, "Can't deduce representer name from #{name}, please specify it with `element_decorator ClassName`"
end
name
.gsub("CollectionRepresenter", "Representer")
.constantize
end
link :self do
{ href: @self_link }
end
property :total, getter: ->(*) { @total }, exec_context: :decorator
property :count, getter: ->(*) { count }
collection :elements,
getter: ->(*) {
represented.map do |model|
element_decorator.create(model, current_user: current_user)
end
},
exec_context: :decorator,
embedded: true
def _type
'Collection'
end
end
end
end