Module: Brainstem::Concerns::PresenterDSL::ClassMethods
- Defined in:
- lib/brainstem/concerns/presenter_dsl.rb
Instance Method Summary collapse
- #associations(&block) ⇒ Object
- #brainstem_key(key) ⇒ Object
- #conditionals(&block) ⇒ Object
- #default_sort_order(sort_string = nil) ⇒ Object
- #description(str, options = { nodoc: false }) ⇒ Object
-
#documented! ⇒ Object
Temporary implementation to track controllers that have been documented.
- #fields(&block) ⇒ Object
- #filter(name, type, options = {}, &block) ⇒ Object
-
#helper(mod = nil, &block) ⇒ Object
Declare a helper module or block whose methods will be available in dynamic fields and associations.
- #nodoc! ⇒ Object
- #preload(*args) ⇒ Object
- #query_strategy(strategy) ⇒ Object
- #reset_configuration! ⇒ Object private
- #search(&block) ⇒ Object
- #sort_order(name, *args, &block) ⇒ Object
- #title(str, options = { nodoc: false }) ⇒ Object
Instance Method Details
#associations(&block) ⇒ Object
38 39 40 |
# File 'lib/brainstem/concerns/presenter_dsl.rb', line 38 def associations(&block) AssociationsBlock.new(configuration, &block) end |
#brainstem_key(key) ⇒ Object
159 160 161 |
# File 'lib/brainstem/concerns/presenter_dsl.rb', line 159 def brainstem_key(key) configuration[:brainstem_key] = key.to_s end |
#conditionals(&block) ⇒ Object
30 31 32 |
# File 'lib/brainstem/concerns/presenter_dsl.rb', line 30 def conditionals(&block) ConditionalsBlock.new(configuration, &block) end |
#default_sort_order(sort_string) ⇒ String #default_sort_order ⇒ String
82 83 84 85 |
# File 'lib/brainstem/concerns/presenter_dsl.rb', line 82 def default_sort_order(sort_string = nil) configuration[:default_sort_order] = sort_string if sort_string configuration[:default_sort_order] end |
#description(str, options = { nodoc: false }) ⇒ Object
46 47 48 |
# File 'lib/brainstem/concerns/presenter_dsl.rb', line 46 def description(str, = { nodoc: false }) configuration[:description] = .merge(info: str) end |
#documented! ⇒ Object
Temporary implementation to track controllers that have been documented.
57 58 59 |
# File 'lib/brainstem/concerns/presenter_dsl.rb', line 57 def documented! configuration[:documented] = true end |
#fields(&block) ⇒ Object
34 35 36 |
# File 'lib/brainstem/concerns/presenter_dsl.rb', line 34 def fields(&block) FieldsBlock.new(configuration[:fields], &block) end |
#filter(name, type, options = {}) ⇒ Object #filter(name, type, options = {}) {|scope, arg| ... } ⇒ Object
141 142 143 144 145 146 147 148 149 150 151 152 153 |
# File 'lib/brainstem/concerns/presenter_dsl.rb', line 141 def filter(name, type, = {}, &block) if type.to_s == 'array' [:item_type] = [:item_type].to_s.presence || DEFAULT_FILTER_DATA_TYPE end = %w(default info include_params nodoc items item_type) .select! { |k, v| .include?(k.to_s) } configuration[:filters][name] = .merge({ value: (block_given? ? block : nil), type: type.to_s, }) end |
#helper(mod = nil, &block) ⇒ Object
Declare a helper module or block whose methods will be available in dynamic fields and associations.
62 63 64 65 66 67 68 69 70 |
# File 'lib/brainstem/concerns/presenter_dsl.rb', line 62 def helper(mod = nil, &block) if mod configuration[:helpers] << mod end if block configuration[:helpers] << Module.new.tap { |mod| mod.module_eval(&block) } end end |
#nodoc! ⇒ Object
50 51 52 |
# File 'lib/brainstem/concerns/presenter_dsl.rb', line 50 def nodoc! configuration[:nodoc] = true end |
#preload(*args) ⇒ Object
26 27 28 |
# File 'lib/brainstem/concerns/presenter_dsl.rb', line 26 def preload(*args) configuration.array!(:preloads).concat args end |
#query_strategy(strategy) ⇒ Object
163 164 165 |
# File 'lib/brainstem/concerns/presenter_dsl.rb', line 163 def query_strategy(strategy) configuration[:query_strategy] = strategy end |
#reset_configuration! ⇒ 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.
168 169 170 171 172 173 174 175 176 177 178 179 |
# File 'lib/brainstem/concerns/presenter_dsl.rb', line 168 def reset_configuration! configuration.array!(:preloads) configuration.array!(:helpers) configuration.nest!(:conditionals) configuration.nest!(:fields) configuration.nest!(:filters) configuration.nest!(:sort_orders) configuration.nest!(:associations) configuration.nonheritable!(:title) configuration.nonheritable!(:description) configuration.nonheritable!(:nodoc) end |
#search(&block) ⇒ Object
155 156 157 |
# File 'lib/brainstem/concerns/presenter_dsl.rb', line 155 def search(&block) configuration[:search] = block end |
#sort_order(name, order, options) ⇒ Object #sort_order(name, options) {|scope| ... } ⇒ Object
109 110 111 112 113 114 115 116 117 118 119 |
# File 'lib/brainstem/concerns/presenter_dsl.rb', line 109 def sort_order(name, *args, &block) = %w(info nodoc) = args. .select { |k, v| .include?(k.to_s) } order = args.first raise ArgumentError, "A sort order must be given" unless block_given? || order configuration[:sort_orders][name] = .merge({ value: (block_given? ? block : order) }) end |
#title(str, options = { nodoc: false }) ⇒ Object
42 43 44 |
# File 'lib/brainstem/concerns/presenter_dsl.rb', line 42 def title(str, = { nodoc: false }) configuration[:title] = .merge(info: str) end |