openproject/lib/api/utilities/meta_property.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 docs/COPYRIGHT.rdoc for more details.
#++

module API
  module Utilities
    module MetaProperty
      extend ActiveSupport::Concern

      included do
        attr_accessor :meta

        property :meta,
                 as: :_meta,
                 exec_context: :decorator,
                 getter: ->(*) { meta_representer },
                 setter: ->(fragment:, **) { represented.meta = meta_representer.from_hash(fragment) }

        singleton_class.prepend MetaPropertyConstructor
      end

      module MetaPropertyConstructor
        def create(model, **args)
          meta = args.delete(:meta)

          super(model, **args).tap do |instance|
            instance.meta = meta
          end
        end
      end

      protected

      def meta_representer
        meta_representer_class.create(meta || OpenStruct.new, current_user: current_user)
      end

      def meta_representer_class
        raise NotImplementedError
      end
    end
  end
end