Class: Decidim::ParticipatorySpaceManifest

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

Overview

This class handles all the logic associated to configuring a participatory space, the highest level object of Decidim.

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

Instance Method Summary collapse

Instance Method Details

#context(name = :public, &block) ⇒ Object

A context used to set the layout and behavior of a participatory space. Full documentation can be found looking at the ‘ParticipatorySpaceContextManifest` class.

Example:

context(:public) do |context|
  context.layout "layouts/decidim/some_layout"
end

context(:public).layout
# => "layouts/decidim/some_layout"

Returns Nothing.



63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/decidim/participatory_space_manifest.rb', line 63

def context(name = :public, &block)
  name = name.to_sym
  @contexts ||= {}

  if block
    context = ParticipatorySpaceContextManifest.new
    context.instance_eval(&block)
    @contexts[name] = context
  end

  @contexts.fetch(name)
end

#export_manifests ⇒ Object

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

Returns an Array of <Decidim::Exporters::ExportManifest>.



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

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

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

name - The name of the artifact for this export. Should be unique in the context of the space. block - A block that receives the manifest as its only argument.

Returns nothing.



142
143
144
145
146
147
148
 
# File 'lib/decidim/participatory_space_manifest.rb', line 142

def exports(name, &block)
  return unless name

  @exports ||= []
  @exports << [name, block]
  @export_manifests = nil
end

#participatory_spaces(&block) ⇒ Object

Public: A block that retrieves all the participatory spaces for the manifest. The block receives a ‘Decidim::Organization` as a parameter in order to filter. The block is expected to return an `ActiveRecord::Association`.

Returns nothing.



103
104
105
 
# File 'lib/decidim/participatory_space_manifest.rb', line 103

def participatory_spaces(&block)
  @participatory_spaces ||= 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.



112
113
114
 
# File 'lib/decidim/participatory_space_manifest.rb', line 112

def permissions_class
  permissions_class_name&.constantize
end

#register_resource(name, &block) ⇒ Object

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

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.



126
127
128
 
# File 'lib/decidim/participatory_space_manifest.rb', line 126

def register_resource(name, &block)
  Decidim.register_resource(name, &block)
end

#route_name ⇒ Object

The name of the named Rails route to create the url to the resource.

Returns a String.



94
95
96
 
# File 'lib/decidim/participatory_space_manifest.rb', line 94

def route_name
  super || model_class_name.demodulize.underscore
end

#seed! ⇒ Object

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

Returns nothing.



86
87
88
89
 
# File 'lib/decidim/participatory_space_manifest.rb', line 86

def seed!
  print "Creating seeds for the #{name} space...\n" unless Rails.env.test?
  @seeds&.call
end

#seeds(&block) ⇒ Object

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

Returns nothing.



79
80
81
 
# File 'lib/decidim/participatory_space_manifest.rb', line 79

def seeds(&block)
  @seeds = block
end