Class: Blueprinter::ViewCollection Private

Inherits:
Object
  • Object
show all
Defined in:
lib/blueprinter/view_collection.rb

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ViewCollection

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of ViewCollection.



8
9
10
11
12
13
14
 
# File 'lib/blueprinter/view_collection.rb', line 8

def initialize
  @views = {
    identifier: View.new(:identifier),
    default: View.new(:default)
  }
  @sort_by_definition = Blueprinter.configuration.sort_fields_by.eql?(:definition)
end

Instance Attribute Details

#sort_by_definition ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



6
7
8
 
# File 'lib/blueprinter/view_collection.rb', line 6

def sort_by_definition
  @sort_by_definition
end

#views ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



6
7
8
 
# File 'lib/blueprinter/view_collection.rb', line 6

def views
  @views
end

Instance Method Details

#[](view_name) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



43
44
45
 
# File 'lib/blueprinter/view_collection.rb', line 43

def [](view_name)
  @views[view_name] ||= View.new(view_name)
end

#fields_for(view_name) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



26
27
28
29
30
31
32
33
34
35
 
# File 'lib/blueprinter/view_collection.rb', line 26

def fields_for(view_name)
  return identifier_fields if view_name == :identifier

  fields, excluded_fields = sortable_fields(view_name)
  sorted_fields = sort_by_definition ? sort_by_def(view_name, fields) : fields.values.sort_by(&:name)

  (identifier_fields + sorted_fields).tap do |fields_array|
    fields_array.reject! { |field| excluded_fields.include?(field.name) }
  end
end

#inherit(view_collection) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



16
17
18
19
20
 
# File 'lib/blueprinter/view_collection.rb', line 16

def inherit(view_collection)
  view_collection.views.each do |view_name, view|
    self[view_name].inherit(view)
  end
end

#transformers(view_name) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



37
38
39
40
41
 
# File 'lib/blueprinter/view_collection.rb', line 37

def transformers(view_name)
  included_transformers = gather_transformers_from_included_views(view_name).reverse
  all_transformers = [*views[:default].view_transformers, *included_transformers].uniq
  all_transformers.empty? ? Blueprinter.configuration.default_transformers : all_transformers
end

#view?(view_name) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean) 


22
23
24
 
# File 'lib/blueprinter/view_collection.rb', line 22

def view?(view_name)
  views.key? view_name
end