decidim-consultations 0.11.0.pre1

data/app/constraints/decidim/consultations/current_component.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    # This class infers the current component on an consultation context
+    # request parameters and injects it into the environment.
+    class CurrentComponent
+      # Public: Initializes the class.
+      #
+      # manifest - The manifest of the component to check against.
+      def initialize(manifest)
+        @manifest = manifest
+      end
+
+      # Public: Matches the request against a component and injects it into the
+      #         environment.
+      #
+      # request - The request that holds the current component relevant information.
+      #
+      # Returns a true if the request matches a consultation and a
+      # component belonging to that consultation, false otherwise
+      def matches?(request)
+        CurrentQuestion.new.matches?(request) &&
+          Decidim::CurrentComponent.new(@manifest).matches?(request)
+      end
+    end
+  end
+end

data/app/constraints/decidim/consultations/current_question.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    # This class infers the current consultation we're scoped to by
+    # looking at the request parameters and the organization in the request
+    # environment, and injects it into the environment.
+    class CurrentQuestion
+      # Public: Matches the request against a question and injects it
+      #         into the environment.
+      #
+      # request - The request that holds the question relevant
+      #           information.
+      #
+      # Returns a true if the request matched, false otherwise
+      def matches?(request)
+        env = request.env
+
+        @organization = env["decidim.current_organization"]
+        return false unless @organization
+
+        current_question(env, request.params) ? true : false
+      end
+
+      private
+
+      def current_question(env, params)
+        env["decidim.current_participatory_space"] ||= detect_current_question(params)
+      end
+
+      def detect_current_question(params)
+        Decidim::Consultations::Question.find_by(slug: params[:question_slug], organization: @organization)
+      end
+    end
+  end
+end

data/app/controllers/concerns/decidim/consultations/action_authorization.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  module Consultations
+    module ActionAuthorization
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :action_authorization
+      end
+
+      # Public: Returns the authorization object for an authorization.
+      #
+      # action_name - The action to authorize against.
+      #
+      # Returns an AuthorizationStatus
+      def action_authorization(action_name)
+        return AuthorizationStatus.new(:ok) if can?(action_name.to_sym, Question)
+
+        AuthorizationStatus.new(:denied)
+      end
+
+      class AuthorizationStatus
+        attr_reader :code
+
+        def initialize(code)
+          @code = code.to_sym
+        end
+
+        def ok?
+          @code == :ok
+        end
+      end
+    end
+  end
+end

data/app/controllers/concerns/decidim/consultations/admin/consultation_admin.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  module Consultations
+    module Admin
+      # This concern is meant to be included in all controllers that are scoped
+      # into an consultation's admin panel. It will override the layout so it shows
+      # the sidebar, preload the consultation, etc.
+      module ConsultationAdmin
+        extend ActiveSupport::Concern
+
+        included do
+          include NeedsConsultation
+
+          layout "decidim/admin/consultation"
+
+          alias_method :current_participatory_space, :current_consultation
+        end
+      end
+    end
+  end
+end

data/app/controllers/concerns/decidim/consultations/admin/question_admin.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  module Consultations
+    module Admin
+      # This concern is meant to be included in all controllers that are scoped
+      # into an question's admin panel. It will override the layout so it shows
+      # the sidebar, preload the consultation, etc.
+      module QuestionAdmin
+        extend ActiveSupport::Concern
+
+        included do
+          include NeedsQuestion
+
+          include Decidim::Admin::ParticipatorySpaceAdminContext
+          participatory_space_admin_layout
+
+          def current_participatory_space
+            return current_consultation if params.has_key? :consultation_slug
+            current_question
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/concerns/decidim/consultations/needs_consultation.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    # This module, when injected into a controller, ensures there's a
+    # consultation available and deducts it from the context.
+    module NeedsConsultation
+      def self.enhance_controller(instance_or_module)
+        instance_or_module.class_eval do
+          helper_method :current_consultation
+        end
+      end
+
+      def self.extended(base)
+        base.extend Decidim::NeedsOrganization, InstanceMethods
+
+        enhance_controller(base)
+      end
+
+      def self.included(base)
+        base.include Decidim::NeedsOrganization, InstanceMethods
+
+        enhance_controller(base)
+      end
+
+      module InstanceMethods
+        # Public: Finds the current Consultation given this controller's
+        # context.
+        #
+        # Returns the current Consultation.
+        def current_consultation
+          @current_consultation ||= detect_consultation
+        end
+
+        alias current_participatory_space current_consultation
+
+        private
+
+        def ability_context
+          super.merge(current_consultation: current_consultation)
+        end
+
+        def detect_consultation
+          request.env["current_consultation"] ||
+            organization_consultations.find_by(slug: params[:consultation_slug] || params[:slug])
+        end
+
+        def organization_consultations
+          @organization_consultations ||= OrganizationConsultations.new(current_organization).query
+        end
+      end
+    end
+  end
+end

data/app/controllers/concerns/decidim/consultations/needs_question.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    # This module, when injected into a controller, ensures there's a
+    # question available and deducts it from the context.
+    module NeedsQuestion
+      def self.enhance_controller(instance_or_module)
+        instance_or_module.class_eval do
+          helper_method :current_question, :current_consultation, :current_participatory_space, :stats,
+                        :sorted_results
+
+          helper Decidim::WidgetUrlsHelper
+          helper Decidim::ActionAuthorizationHelper
+        end
+      end
+
+      def self.extended(base)
+        base.extend Decidim::NeedsOrganization, InstanceMethods
+        base.include Decidim::Consultations::ActionAuthorization
+
+        enhance_controller(base)
+      end
+
+      def self.included(base)
+        base.include Decidim::NeedsOrganization, InstanceMethods, Decidim::Consultations::ActionAuthorization
+
+        enhance_controller(base)
+      end
+
+      module InstanceMethods
+        # Public: Finds the current Question given this controller's
+        # context.
+        #
+        # Returns the current Question.
+        def current_question
+          @current_question ||= detect_question
+        end
+
+        # Public: Finds the current Consultation given this controller's
+        # context.
+        #
+        # Returns the current Consultation.
+        def current_consultation
+          @current_consultation ||= current_question&.consultation || detect_consultation
+        end
+
+        alias current_participatory_space current_question
+
+        private
+
+        def ability_context
+          super.merge(
+            current_question: current_question,
+            current_consultation: current_consultation
+          )
+        end
+
+        def detect_question
+          request.env["current_question"] ||
+            OrganizationQuestions.for(current_organization).find_by(slug: params[:question_slug] || params[:slug])
+        end
+
+        def detect_consultation
+          request.env["current_consultation"] ||
+            organization_consultations.find_by(slug: params[:consultation_slug])
+        end
+
+        def organization_consultations
+          @organization_consultations ||= OrganizationConsultations.new(current_organization).query
+        end
+
+        def stats
+          @stats ||= QuestionStatsPresenter.new(question: current_question)
+        end
+      end
+    end
+  end
+end

data/app/controllers/concerns/decidim/consultations/orderable.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  module Consultations
+    # Common logic to ordering resources
+    module Orderable
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :order, :available_orders, :random_seed
+
+        private
+
+        # Gets how the proposals should be ordered based on the choice
+        # made by the user.
+        def order
+          @order ||= detect_order(params[:order]) || default_order
+        end
+
+        def detect_order(candidate)
+          available_orders.detect { |order| order == candidate }
+        end
+
+        # Available orders based on enabled settings
+        def available_orders
+          %w(random recent)
+        end
+
+        def default_order
+          "random"
+        end
+
+        def reorder(consultations)
+          case order
+          when "recent"
+            consultations.order_by_most_recent
+          else
+            consultations.order_randomly(random_seed)
+          end
+        end
+
+        # Returns: A random float number between -1 and 1 to be used as a
+        # random seed at the database.
+        def random_seed
+          @random_seed ||= (params[:random_seed] ? params[:random_seed].to_f : (rand * 2 - 1))
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/consultations/admin/application_controller.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    module Admin
+      # The main admin application controller for consultations
+      class ApplicationController < Decidim::Admin::ApplicationController
+        layout "decidim/admin/consultations"
+
+        helper Decidim::SanitizeHelper
+      end
+    end
+  end
+end

data/app/controllers/decidim/consultations/admin/categories_controller.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    module Admin
+      # Controller that allows managing categories for questions.
+      #
+      class CategoriesController < Decidim::Admin::CategoriesController
+        include QuestionAdmin
+      end
+    end
+  end
+end

data/app/controllers/decidim/consultations/admin/component_permissions_controller.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    module Admin
+      # Controller that allows managing the Consultation Component
+      # permissions in the admin panel.
+      class ComponentPermissionsController < Decidim::Admin::ComponentPermissionsController
+        include QuestionAdmin
+      end
+    end
+  end
+end

data/app/controllers/decidim/consultations/admin/components_controller.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    module Admin
+      # Controller that allows managing the Question's Components in the
+      # admin panel.
+      class ComponentsController < Decidim::Admin::ComponentsController
+        include QuestionAdmin
+      end
+    end
+  end
+end

data/app/controllers/decidim/consultations/admin/consultation_publications_controller.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    module Admin
+      # Controller that allows managing consultation publications.
+      class ConsultationPublicationsController < Decidim::Admin::ApplicationController
+        include ConsultationAdmin
+
+        def create
+          authorize! :publish, current_consultation
+
+          PublishConsultation.call(current_consultation) do
+            on(:ok) do
+              flash[:notice] = I18n.t("consultation_publications.create.success", scope: "decidim.admin")
+            end
+
+            on(:invalid) do
+              flash[:alert] = I18n.t("consultation_publications.create.error", scope: "decidim.admin")
+            end
+
+            redirect_back(fallback_location: consultations_path)
+          end
+        end
+
+        def destroy
+          authorize! :publish, current_consultation
+
+          UnpublishConsultation.call(current_consultation) do
+            on(:ok) do
+              flash[:notice] = I18n.t("consultation_publications.destroy.success", scope: "decidim.admin")
+            end
+
+            on(:invalid) do
+              flash[:alert] = I18n.t("consultation_publications.destroy.error", scope: "decidim.admin")
+            end
+
+            redirect_back(fallback_location: consultations_path)
+          end
+        end
+      end
+    end
+  end
+end