Class: Decidim::ComponentManifest

Inherits:
Object
  • Object
show all
Includes:
ActiveModel::Model
Defined in:
lib/decidim/component_manifest.rb

Overview

This class handles all the logic associated to configuring a component associated to a participatory process.

It’s normally not used directly but through the API exposed through ‘Decidim.register_component`.

Instance Method Summary collapse

Instance Method Details

#export_manifests ⇒ Object

Pubic: Returns a collection of previously registered export manifests for this component.

Returns an Array<Decidim::Components::ExportManifest>.



153
154
155
156
157
158
159
 
# File 'lib/decidim/component_manifest.rb', line 153

def export_manifests
  @export_manifests ||= @exports.map do |(name, block)|
    Decidim::Components::ExportManifest.new(name).tap do |manifest|
      block.call(manifest)
    end
  end
end

#exports(name, &block) ⇒ Object

Public: Registers an export artifact with a name and its properties defined in ‘Decidim::Components::ExportManifest`.

Export artifacts provide an unified way for components to register exportable collections serialized via a ‘Serializer` than eventually are transformed to their formats.

name - The name of the artifact. Should be unique in the context of

the component.

block - A block that receives the manifest as its only argument.

Returns nothing.



143
144
145
146
147
 
# File 'lib/decidim/component_manifest.rb', line 143

def exports(name, &block)
  @exports ||= []
  @exports << [name, block]
  @export_manifests = nil
end

#on(event_name, &block) ⇒ Object

Public: Registers a hook to this manifest. Hooks get fired when some lifecycle events happen, like the creation of a component or its destruction.

event_name - A String or Symbol with the event name. &block - The block to run when the hook gets triggered.

Returns nothing.



67
68
69
70
 
# File 'lib/decidim/component_manifest.rb', line 67

def on(event_name, &block)
  hooks[event_name.to_sym] ||= []
  hooks[event_name.to_sym] << block
end

#permissions_class ⇒ Object

Public: Finds the permission class from its name, using the ‘permissions_class_name` attribute. If the class does not exist, it raises an exception. If the class name is not set, it returns nil.

Returns a Class.



184
185
186
 
# File 'lib/decidim/component_manifest.rb', line 184

def permissions_class
  permissions_class_name&.constantize
end

#register_resource(name) ⇒ Object

Public: Registers a resource. Exposes a DSL defined by ‘Decidim::ResourceManifest`. Automatically sets the component manifest for that resource to the current one.

Resource manifests are a way to expose a resource from one engine to the whole system. This way resources can be linked between them.

name - A name for that resource. Should be singular (ie not plural). block - A Block that will be called to set the Resource attributes.

Returns nothing.



199
200
201
202
203
204
205
206
207
208
 
# File 'lib/decidim/component_manifest.rb', line 199

def register_resource(name)
  my_component_manifest = self

  my_block = proc do |resource|
    resource.component_manifest = my_component_manifest
    yield(resource)
  end

  Decidim.register_resource(name, &my_block)
end

#register_stat(name, options = {}, &block) ⇒ Object

Public: Registers a stat inside a component manifest.

name - The name of the stat options - A hash of options

* primary: Whether the stat is primary or not.
* priority: The priority of the stat used for render issues.

block - A block that receive the components to filter out the stat.

Returns nothing.



175
176
177
 
# File 'lib/decidim/component_manifest.rb', line 175

def register_stat(name, options = {}, &block)
  stats.register(name, options, &block)
end

#reset_hooks! ⇒ Object

Semiprivate: Resets all the hooks of this manifest. Mostly useful when testing.

Returns nothing.



91
92
93
 
# File 'lib/decidim/component_manifest.rb', line 91

def reset_hooks!
  self.hooks = {}
end

#run_hooks(event_name, context = nil) ⇒ Object

Public: Runs all the hooks associated with this manifest and a particular event.

event_name - A String or Symbol with the event name. context - An optional context that will be provided to the block as a

parameter. Usually the subject of the hook.

Returns nothing.



80
81
82
83
84
85
 
# File 'lib/decidim/component_manifest.rb', line 80

def run_hooks(event_name, context = nil)
  return unless hooks[event_name]
  hooks[event_name.to_sym].each do |hook|
    hook.call(context)
  end
end

#seed!(participatory_space) ⇒ Object

Public: Creates the seeds for this components in order to populate the database.

Returns nothing.



105
106
107
108
 
# File 'lib/decidim/component_manifest.rb', line 105

def seed!(participatory_space)
  print "-- Creating #{name} component seeds for the participatory space with ID: #{participatory_space.id}...\n" unless Rails.env.test?
  @seeds&.call(participatory_space)
end

#seeds(&block) ⇒ Object

Public: A block that gets called when seeding for this component takes place.

Returns nothing.



98
99
100
 
# File 'lib/decidim/component_manifest.rb', line 98

def seeds(&block)
  @seeds = block
end

#settings(name = :global) {|settings| ... } ⇒ Object

Public: Adds configurable attributes for this component, scoped to a name. It uses the DSL specified under ‘Decidim::SettingsManifest`.

name - Either ‘global` or `step` &block - The DSL present on `Decidim::SettingsManifest`

Examples:

component.settings(:global) do |settings|
  settings.attribute :voting_enabled, type: :boolean, default: true
end

Returns nothing.

Yields:



123
124
125
126
127
128
129
 
# File 'lib/decidim/component_manifest.rb', line 123

def settings(name = :global, &block)
  @settings ||= {}
  name = name.to_sym
  settings = (@settings[name] ||= SettingsManifest.new)
  yield(settings) if block
  settings
end

#stats ⇒ Object

Public: Stores an instance of StatsRegistry



162
163
164
 
# File 'lib/decidim/component_manifest.rb', line 162

def stats
  @stats ||= StatsRegistry.new
end