Class: Para::ComponentsConfiguration::Component

Inherits:
Object
  • Object
show all
Defined in:
lib/para/components_configuration.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(identifier, type_identifier, shown_if: nil, **options, &block) ⇒ Component

Returns a new instance of Component.



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/para/components_configuration.rb', line 182

def initialize(identifier, type_identifier, shown_if: nil, **options, &block)
  @identifier = identifier.to_s
  @type = Para::Component.registered_components[type_identifier]
  @options = options
  @shown_if = shown_if
  @parent = options.delete(:parent)

  # Build child components if a block is provided
  instance_eval(&block) if block

  unless type
    raise UndefinedComponentTypeError, "Undefined Para component : #{type_identifier}. " +
                                       'Please ensure that your app or gems define this component type.'
  end
end

Instance Attribute Details

#identifier ⇒ Object

Returns the value of attribute identifier.



180
181
182
 
# File 'lib/para/components_configuration.rb', line 180

def identifier
  @identifier
end

#model ⇒ Object

Returns the value of attribute model.



180
181
182
 
# File 'lib/para/components_configuration.rb', line 180

def model
  @model
end

#options ⇒ Object

Returns the value of attribute options.



180
181
182
 
# File 'lib/para/components_configuration.rb', line 180

def options
  @options
end

#parent ⇒ Object

Returns the value of attribute parent.



180
181
182
 
# File 'lib/para/components_configuration.rb', line 180

def parent
  @parent
end

#shown_if ⇒ Object

Returns the value of attribute shown_if.



180
181
182
 
# File 'lib/para/components_configuration.rb', line 180

def shown_if
  @shown_if
end

#type ⇒ Object

Returns the value of attribute type.



180
181
182
 
# File 'lib/para/components_configuration.rb', line 180

def type
  @type
end

Instance Method Details

#child_components ⇒ Object 



207
208
209
 
# File 'lib/para/components_configuration.rb', line 207

def child_components
  @child_components ||= []
end

#component(*args, **child_options, &block) ⇒ Object

Raises:



198
199
200
201
202
203
204
205
 
# File 'lib/para/components_configuration.rb', line 198

def component(*args, **child_options, &block)
  # Do not allow nesting components more than one level as the display of illimited
  # child nesting deepness is not implemented
  raise ComponentTooDeepError, 'Cannot nest components more than one level' if parent

  child_component_options = child_options.merge(parent: self)
  child_components << Component.new(*args, **child_component_options, &block)
end

#options_with_defaults ⇒ Object

Ensures unset :configuration store options are set to nil to allow removing a configuration option from the components.rb file



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/para/components_configuration.rb', line 224

def options_with_defaults
  configurable_keys = type.local_stored_attributes.try(:[], :configuration) || []
  configurable_keys += options.keys
  configurable_keys.uniq!

  options_with_defaults = {}

  # Assign parent component resource to the final attribute options, assigning nil
  # if the `:parent` option is empty, to allow extracting a component from its
  # parent by just moving the component call outside of its parent block.
  options_with_defaults[:parent_component] = parent&.model

  configurable_keys.each_with_object(options_with_defaults) do |key, hash|
    hash[key] = options[key]
  end
end

#refresh(attributes = {}) ⇒ Object 



211
212
213
214
215
216
217
218
219
 
# File 'lib/para/components_configuration.rb', line 211

def refresh(attributes = {})
  @model = type.where(identifier: identifier).first_or_initialize
  model.update_with(attributes.merge(options_with_defaults))
  model.save!

  child_components.each_with_index do |child_component, child_index|
    child_component.refresh(component_section: nil, position: child_index)
  end
end