Class: ApiPresenter::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/api_presenter/base.rb

Direct Known Subclasses

ApplicationApiPresenter

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(current_user: nil, relation:, params: {}) ⇒ Base

Returns a new instance of Base.

Parameters:

  • current_user (User) (defaults to: nil) —

    Optional. current_user context.

  • relation (ActiveRecord::Relation, Array) —

    Relation or array-wrapped record(s) to present

  • params (Hash) (defaults to: {}) —

    Controller params

Options Hash (params:):

  • :count (Boolean) —

    Optional. If true, return count only.

  • :include (String, Array) —

    Optional. Associated resources to include.

  • :policies (Boolean) —

    Optional. If true, resolve polciies for relation.



28
29
30
31
32
 
# File 'lib/api_presenter/base.rb', line 28

def initialize(current_user: nil, relation:, params: {})
  @current_user = current_user
  @relation     = relation
  @params       = params
end

Instance Attribute Details

#current_user ⇒ Object (readonly)

Returns the value of attribute current_user.



4
5
6
 
# File 'lib/api_presenter/base.rb', line 4

def current_user
  @current_user
end

#params ⇒ Object (readonly)

Returns the value of attribute params.



4
5
6
 
# File 'lib/api_presenter/base.rb', line 4

def params
  @params
end

#relation ⇒ Object (readonly)

Returns the value of attribute relation.



4
5
6
 
# File 'lib/api_presenter/base.rb', line 4

def relation
  @relation
end

Class Method Details

.call(**kwargs) ⇒ ApiPresenter::Base

Examples:

@presenter = PostPresenter.call(
  current_user: current_user,
  relation:     relation,
  params:       params
)

Parameters:

  • current_user (User) —

    Optional. current_user context.

  • relation (ActiveRecord::Relation, Array) —

    Relation or array-wrapped record(s) to present

  • params (Hash) —

    Controller params

Returns:



17
18
19
 
# File 'lib/api_presenter/base.rb', line 17

def self.call(**kwargs)
  new(kwargs).call
end

Instance Method Details

#associations_map ⇒ Hash

This method is abstract.

Hash map that defines the sources for included collection names

Examples:

def associations_map
  {
    categories:     { associations: { sub_category: :category } },
    sub_categories: { associations: :sub_category },
    users:          { associations: [:creator, :publisher] }
  }
end

Returns:

  • (Hash) 


128
129
130
 
# File 'lib/api_presenter/base.rb', line 128

def associations_map
  {}
end

#call ⇒ ApiPresenter::Base

Returns:



36
37
38
39
40
41
 
# File 'lib/api_presenter/base.rb', line 36

def call
  return self if count_only?
  initialize_resolvers
  call_resolvers
  self
end

#collection ⇒ ActiveRecord::Relation, Array<ActiveRecord::Base>

Primary collection, empty if count requested

Returns:

  • (ActiveRecord::Relation, Array<ActiveRecord::Base>) 


47
48
49
 
# File 'lib/api_presenter/base.rb', line 47

def collection
  count_only? ? [] : relation
end

#included_collection_names ⇒ Array<Symbol>

Class names of included collections

Examples:

[:categories, :sub_categories, :users]

Returns:

  • (Array<Symbol>) 


82
83
84
 
# File 'lib/api_presenter/base.rb', line 82

def included_collection_names
  @included_collection_names ||= Parsers::ParseIncludeParams.call(params[ApiPresenter.configuration.include_param])
end

#included_collections ⇒ Hash

Map of included collection names and loaded record

Examples:

{
  categories:     [#<Category id:1>],
  sub_categories: [#<SubCategory id:1>],
  users:          [#<User id:1>, #<User id:2]
}

Returns:

  • (Hash) 


97
98
99
 
# File 'lib/api_presenter/base.rb', line 97

def included_collections
  @included_collections_resolver ? @included_collections_resolver.resolved_collections : {}
end

#policies ⇒ <Array<Hash>]

Policies for the primary collection

Examples:

[
  { post_id: 1, update: true, destroy: true },
  { post_id: 2, update: false, destroy: false }
]

Returns:

  • (<Array<Hash>]) —

    <Array<Hash>]



71
72
73
 
# File 'lib/api_presenter/base.rb', line 71

def policies
  @policies_resolver ? @policies_resolver.resolved_policies : {}
end

#policy_associations ⇒ Symbol+

This method is abstract.

Policy associations to preload to optimize policy resolution

Examples:

Single

def policy_associations
  :user_profile
end

Multiple

def policy_associations
  [:user_profile, :company]
end

Returns:

  • (Symbol, Array<Symbol>) 


168
169
170
 
# File 'lib/api_presenter/base.rb', line 168

def policy_associations
  []
end

#policy_methods ⇒ Symbol+

This method is abstract.

Policy methods to resolve for the primary relation

Examples:

Single

def policy_methods
  :update
end

Multiple

def policy_methods
  [:update, :destroy]
end

Returns:

  • (Symbol, Array<Symbol>) 


148
149
150
 
# File 'lib/api_presenter/base.rb', line 148

def policy_methods
  []
end

#preload(associations) ⇒ Object

Note:

Called by resolvers, but can also be called if additional data is required that does not need to be loaded as an included collection, and for some reason cannot be chained onto the original relation.

Preload additional records with the relation

Parameters:

  • associations (Symbol, Array<Symbol>) 


109
110
111
 
# File 'lib/api_presenter/base.rb', line 109

def preload(associations)
  @relation = @relation.preload(associations)
end

#total_count ⇒ Integer

Note:

Delegate to Kaminari’s ‘total_count` property, or regular count if not a paginated relation

Count of primary collection

Returns:

  • (Integer) 


57
58
59
 
# File 'lib/api_presenter/base.rb', line 57

def total_count
  relation.respond_to?(:total_count) ? relation.total_count : relation.count
end