Class: Decidim::FeatureManifest

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

Overview

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

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

Instance Method Summary collapse

Instance Method Details

#export_manifests ⇒ Object

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

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



159
160
161
162
163
164
165
 
# File 'lib/decidim/feature_manifest.rb', line 159

def export_manifests
  @export_manifests ||= @exports.map do |(name, block)|
    Decidim::Features::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::Features::ExportManifest`.

Export artifacts provide an unified way for features 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 feature.

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

Returns nothing.



149
150
151
152
153
 
# File 'lib/decidim/feature_manifest.rb', line 149

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.



57
58
59
60
 
# File 'lib/decidim/feature_manifest.rb', line 57

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

#register_resource {|manifest| ... } ⇒ Object

Public: Registers a resource inside a feature manifest. Exposes a DSL defined by ‘Decidim::ResourceManifest`.

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

block - A Block that will be called to set the Resource attributes.

Returns nothing.

Yields:

  • (manifest) 


129
130
131
132
133
134
135
 
# File 'lib/decidim/feature_manifest.rb', line 129

def register_resource
  manifest = ResourceManifest.new
  manifest.feature_manifest = self
  yield(manifest)
  manifest.validate!
  resource_manifests << manifest
end

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

Public: Registers a stat inside a feature 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 features to filter out the stat.

Returns nothing.



189
190
191
 
# File 'lib/decidim/feature_manifest.rb', line 189

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.



81
82
83
 
# File 'lib/decidim/feature_manifest.rb', line 81

def reset_hooks!
  self.hooks = {}
end

#resource_manifests ⇒ Object

Public: Finds all the registered resource manifest’s via the ‘register_resource` method.

Returns an Array.



171
172
173
 
# File 'lib/decidim/feature_manifest.rb', line 171

def resource_manifests
  @resource_manifests ||= []
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.



70
71
72
73
74
75
 
# File 'lib/decidim/feature_manifest.rb', line 70

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! ⇒ Object

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

Returns nothing.



95
96
97
 
# File 'lib/decidim/feature_manifest.rb', line 95

def seed!
  @seeds&.call
end

#seeds(&block) ⇒ Object

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

Returns nothing.



88
89
90
 
# File 'lib/decidim/feature_manifest.rb', line 88

def seeds(&block)
  @seeds = block
end

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

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

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

Examples:

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

Returns nothing.

Yields:



112
113
114
115
116
117
118
 
# File 'lib/decidim/feature_manifest.rb', line 112

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

#stats ⇒ Object

Public: Stores an instance of StatsRegistry



176
177
178
 
# File 'lib/decidim/feature_manifest.rb', line 176

def stats
  @stats ||= StatsRegistry.new
end