decidim-core 0.8.3 → 0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57b7690831d061951bff19709653676583f7ef7e
-  data.tar.gz: 24e3aa8fbbc19862a9891cb7f501430e98a3ab4c
+  metadata.gz: 0ad061f43f8c514c854f0ea29035179e9f9010aa
+  data.tar.gz: 880adff366f398867619dd379122a0bb2704d153
 SHA512:
-  metadata.gz: dfeedbe421c2b4a64b1e2870e9b5f51f8c981cc57c38b9aa26b0399ad8e0abebadb7fc5ad60c8ca4496dbf1f72433631b1abe4fc0ed9d0dc01f06feb8d3890f3
-  data.tar.gz: 1c8fe1ffcef6c25e84c40e88c472303ffc026166716cceb766392296353aee3ecbb54e208c8413e2e16f64b98aa68a3a4059a5854d561449ad6e6f6f06067b5a
+  metadata.gz: 80b4ae4bfee8d712fcbc8ec4aacbc630e3e294b887cebd70fe716b435cf51904f47c1179a56e4f1a92d50f1944f8bf6947259bb78a416e7651853e637f032a11
+  data.tar.gz: 607fdd0f547ee9b38348fc2d0a752fcb1be3fbd431931f4e04b22b3447ac07dd03825482d9bf1689a470c3fb51153d069ce6f795b61e833ef95d74006636cc76

data/app/controllers/concerns/decidim/participatory_space_context.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Decidim
+  # This module contains all the logic needed for a controller to render a participatory space
+  # public layout.
+  #
+  module ParticipatorySpaceContext
+    extend ActiveSupport::Concern
+
+    class_methods do
+      # Public: Called on a controller, it sets up all the surrounding methods to render a
+      # participatory space's template. It expects the method `current_participatory_space` to be
+      # defined, from which it will extract the participatory manifest.
+      #
+      # options - A hash used to modify the behavior of the layout. :only: - An array of actions on
+      #           which the layout will be applied.
+      #
+      # Returns nothing.
+      def participatory_space_layout(options = {})
+        layout :layout, options
+        before_action :authorize_participatory_space, options
+      end
+    end
+
+    included do
+      include Decidim::NeedsOrganization
+
+      helper ParticipatorySpaceHelpers, IconHelper
+      helper_method :current_participatory_space
+      helper_method :current_participatory_space_manifest
+      helper_method :current_participatory_space_context
+
+      delegate :manifest, to: :current_participatory_space, prefix: true
+    end
+
+    private
+
+    def current_participatory_space_context
+      :public
+    end
+
+    def current_participatory_space
+      raise NotImplementedError
+    end
+
+    def authorize_participatory_space
+      authorize! :read, current_participatory_space
+    end
+
+    def ability_context
+      super.merge(
+        current_participatory_space: current_participatory_space,
+      )
+    end
+
+    def layout
+      current_participatory_space_manifest.context(current_participatory_space_context).layout
+    end
+  end
+end

data/app/controllers/decidim/features/base_controller.rb

@@ -9,6 +9,9 @@ module Decidim
       include Settings
       include ActionAuthorization
 
+      include ParticipatorySpaceContext
+      participatory_space_layout
+
       helper Decidim::FiltersHelper
       helper Decidim::OrdersHelper
       helper Decidim::FeatureReferenceHelper
@@ -27,11 +30,13 @@ module Decidim
       skip_authorize_resource
 
       before_action do
-        extend current_participatory_space.extension_module
-
         authorize! :read, current_feature
       end
 
+      def current_participatory_space
+        request.env["decidim.current_participatory_space"]
+      end
+
       def current_feature
         request.env["decidim.current_feature"]
       end
@@ -40,10 +45,6 @@ module Decidim
         @current_manifest ||= current_feature.manifest
       end
 
-      def current_participatory_space
-        current_feature.participatory_space
-      end
-
       def ability_context
         super.merge(
           current_manifest: current_manifest,

data/app/helpers/decidim/participatory_space_helpers.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatorySpaceHelpers
+    # Public: This method gets exposed on all controllers that have `ParticipatorySpaceContext`
+    # included as a module.
+    #
+    # Through this method, you can access helpers that are unique to a particular participatory
+    # space. These helpers are defined in the participatory space manifest, via the `context`
+    # helper.
+    #
+    # Example:
+    #
+    #     # If you had a `ParticipatoryProcessHelper` with a `participatory_process_header` method
+    #     participatory_process_helpers.participatory_process_header(current_participatory_space)
+    #
+    # Returns an Object that includes the Helpers as public methods.
+    def participatory_space_helpers
+      return @participatory_space_helpers if defined?(@participatory_space_helpers)
+
+      helper = current_participatory_space_manifest.context(current_participatory_space_context).helper
+
+      klass = Class.new(SimpleDelegator) do
+        include helper.constantize if helper
+      end
+
+      @participatory_space_helpers = klass.new(self)
+    end
+  end
+end

data/config/routes.rb

@@ -23,7 +23,7 @@ Decidim::Core::Engine.routes.draw do
   resource :locale, only: [:create]
 
   Decidim.participatory_space_manifests.each do |manifest|
-    mount manifest.engine, at: "/", as: "decidim_#{manifest.name}"
+    mount manifest.context(:public).engine, at: "/", as: "decidim_#{manifest.name}"
   end
 
   mount Decidim::Verifications::Engine, at: "/", as: "decidim_verifications"

data/lib/decidim/abilities/participatory_process_role_ability.rb

@@ -55,7 +55,7 @@ module Decidim
       end
 
       def current_participatory_process
-        @current_participatory_process ||= @context[:current_participatory_process]
+        @current_participatory_process ||= @context[:current_participatory_space]
       end
     end
   end

data/lib/decidim/core/version.rb

@@ -4,7 +4,7 @@ module Decidim
   # This holds the decidim-core version.
   module Core
     def self.version
-      "0.8.3"
+      "0.8.4"
     end
   end
 end

data/lib/decidim/participable.rb

@@ -42,10 +42,6 @@ module Decidim
         }
       end
 
-      def extension_module
-        "#{module_name}::#{demodulized_name}Context".constantize
-      end
-
       def admin_extension_module
         "#{admin_module_name}::#{demodulized_name}Context".constantize
       end

data/lib/decidim/participatory_space_context_manifest.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Decidim
+  # This class holds the configuration for a participatory space's context. A context consists of an
+  # engine, a layout and a set of helpers (usually used by the layout itself).
+  class ParticipatorySpaceContextManifest
+    include ActiveModel::Model
+    include Virtus.model
+
+    attribute :engine, Rails::Engine
+    attribute :helper
+    attribute :layout
+  end
+end

data/lib/decidim/participatory_space_manifest.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "decidim/settings_manifest"
+require "decidim/participatory_space_context_manifest"
 
 module Decidim
   # This class handles all the logic associated to configuring a participatory
@@ -12,9 +13,6 @@ module Decidim
     include ActiveModel::Model
     include Virtus.model
 
-    attribute :admin_engine, Rails::Engine
-    attribute :engine, Rails::Engine
-
     attribute :name, Symbol
 
     # The ActiveRecord class name of the model we're exposing
@@ -30,6 +28,32 @@ module Decidim
 
     validates :name, presence: true
 
+    # 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.
+    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
+
     # Public: A block that gets called when seeding for this feature takes place.
     #
     # Returns nothing.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decidim-core
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.8.4
 platform: ruby
 authors:
 - Josep Jaume Rey Peroy
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-15 00:00:00.000000000 Z
+date: 2018-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_link_to
@@ -508,28 +508,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: 0.8.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: 0.8.4
 - !ruby/object:Gem::Dependency
   name: decidim-dev
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: 0.8.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: 0.8.4
 description: Adds core features so other engines can hook into the framework.
 email:
 - josepjaume@gmail.com
@@ -679,6 +679,7 @@ files:
 - app/controllers/concerns/decidim/needs_authorization.rb
 - app/controllers/concerns/decidim/needs_organization.rb
 - app/controllers/concerns/decidim/paginable.rb
+- app/controllers/concerns/decidim/participatory_space_context.rb
 - app/controllers/concerns/decidim/payload_info.rb
 - app/controllers/concerns/decidim/settings.rb
 - app/controllers/concerns/decidim/user_profile.rb
@@ -741,6 +742,7 @@ files:
 - app/helpers/decidim/omniauth_helper.rb
 - app/helpers/decidim/orders_helper.rb
 - app/helpers/decidim/paginate_helper.rb
+- app/helpers/decidim/participatory_space_helpers.rb
 - app/helpers/decidim/replace_buttons_helper.rb
 - app/helpers/decidim/resource_helper.rb
 - app/helpers/decidim/sanitize_helper.rb
@@ -1100,6 +1102,7 @@ files:
 - lib/decidim/messaging.rb
 - lib/decidim/page_finder.rb
 - lib/decidim/participable.rb
+- lib/decidim/participatory_space_context_manifest.rb
 - lib/decidim/participatory_space_manifest.rb
 - lib/decidim/publicable.rb
 - lib/decidim/query_extensions.rb