debian-mirror-gitlab/lib/api/helpers/presentable.rb

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

31 lines
1,012 B
Ruby
Raw Normal View History

2019-02-02 18:00:53 +05:30
# frozen_string_literal: true
module API
module Helpers
##
# This module makes it possible to use `app/presenters` with
2020-04-22 19:07:51 +05:30
# Grape Entities. It instantiates the model presenter and passes
2019-02-02 18:00:53 +05:30
# options defined in the API endpoint to the presenter itself.
#
# present object, with: Entities::Something,
# current_user: current_user,
# another_option: 'my options'
#
# Example above will make `current_user` and `another_option`
# values available in the subclass of `Gitlab::View::Presenter`
# thorough a separate method in the presenter.
#
# The model class needs to have `::Presentable` module mixed in
# if you want to use `API::Helpers::Presentable`.
#
module Presentable
extend ActiveSupport::Concern
def initialize(object, options = {})
2020-04-22 19:07:51 +05:30
options = options.opts_hash if options.is_a?(Grape::Entity::Options)
2021-01-03 14:25:43 +05:30
super(object.present(**options), options)
2019-02-02 18:00:53 +05:30
end
end
end
end