openproject/lib/api/decorators/collection.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.
#++

require 'roar/decorator'
require 'roar/json/hal'

module API
  module Decorators
    class Collection < Roar::Decorator
      include Roar::JSON::HAL
      include Roar::Hypermedia
      include API::Utilities::UrlHelper

      def initialize(models, total, self_link, context: {})
        @total = total
        @self_link = self_link
        @context = context

        super(models)
      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
      end

      as_strategy = API::Utilities::CamelCasingStrategy.new

      link :self do
        { href: @self_link }
      end

      property :_type, getter: -> (*) { 'Collection' }
      property :total, getter: -> (*) { @total }, exec_context: :decorator
      property :count, getter: -> (*) { empty? ? 0 : count }

      collection :elements,
                 getter: -> (*) {
                   represented.map { |model|
                     element_decorator.new(model, context)
                   }
                 },
                 exec_context: :decorator,
                 embedded: true

      private

      attr_reader :context
    end
  end
end