decidim-consultations 0.18.1 → 0.19.0

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    module Admin
+      # Controller that allows managing Questions
+      # permissions in the admin panel.
+      class QuestionPermissionsController < Decidim::Admin::ResourcePermissionsController
+        include QuestionAdmin
+        # layout "decidim/admin/Question"
+
+        register_permissions(::Decidim::Consultations::Admin::QuestionPermissionsController,
+                             ::Decidim::Consultations::Permissions,
+                             ::Decidim::Admin::Permissions)
+
+        def permission_class_chain
+          ::Decidim.permissions_registry.chain_for(::Decidim::Consultations::Admin::QuestionPermissionsController)
+        end
+
+        def edit
+          enforce_permission_to :update, :question, question: current_question
+          super
+        end
+
+        def update
+          enforce_permission_to :update, :question, question: current_question
+          super
+        end
+
+        def return_path
+          consultation_questions_path current_consultation
+        end
+      end
+    end
+  end
+end

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

@@ -5,6 +5,7 @@ module Decidim
     module Admin
       class QuestionsController < Decidim::Consultations::Admin::ApplicationController
         include QuestionAdmin
+        helper ::Decidim::Admin::ResourcePermissionsHelper
 
         def index
           enforce_permission_to :read, :question

data/app/controllers/decidim/consultations/authorization_vote_modals_controller.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    class AuthorizationVoteModalsController < Decidim::Consultations::ApplicationController
+      include NeedsQuestion
+
+      helper_method :authorizations, :authorize_action_path
+      layout false
+
+      def show
+        render template: "decidim/authorization_modals/show"
+      end
+
+      private
+
+      def authorize_action_path(handler_name)
+        authorizations.status_for(handler_name).current_path(redirect_url: URI(request.referer).path)
+      end
+
+      def authorizations
+        @authorizations ||= action_authorized_to(:vote, resource: nil, permissions_holder: current_question)
+      end
+    end
+  end
+end

data/app/controllers/decidim/consultations/consultations_controller.rb

@@ -10,7 +10,7 @@ module Decidim
       include NeedsConsultation
       include FilterResource
       include Paginable
-      include Orderable
+      include Decidim::Consultations::Orderable
       include ParticipatorySpaceContext
 
       helper_method :collection, :consultations, :finished_consultations, :active_consultations, :filter

data/app/controllers/decidim/consultations/question_multiple_votes_controller.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    class QuestionMultipleVotesController < Decidim::Consultations::ApplicationController
+      layout "layouts/decidim/question_multivote"
+      include NeedsQuestion
+      include Decidim::FormFactory
+
+      helper QuestionsHelper
+
+      before_action :authenticate_user!
+
+      # Non-ajax votings (such as multi-reponses) have a html page
+      def show
+        enforce_permission_to :vote, :question, question: current_question
+        @form = form(MultiVoteForm).instance(current_question: current_question)
+      end
+
+      def create
+        enforce_permission_to :vote, :question, question: current_question
+
+        multivote_form = form(MultiVoteForm).from_params(params, current_question: current_question)
+
+        MultipleVoteQuestion.call(multivote_form, current_user) do
+          on(:ok) do
+            redirect_to question_path(current_question)
+          end
+
+          on(:invalid) do |_form, error|
+            flash[:error] = I18n.t("question_votes.create.error", scope: "decidim.consultations")
+            flash[:error] << " (#{error})" if error
+            redirect_to question_question_multiple_votes_path
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/consultations/question_votes_controller.rb

@@ -23,7 +23,7 @@ module Decidim
           on(:invalid) do
             render json: {
               error: I18n.t("question_votes.create.error", scope: "decidim.consultations")
-            }, status: 422
+            }, status: :unprocessable_entity
           end
         end
       end

data/app/forms/decidim/consultations/admin/question_configuration_form.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    module Admin
+      # A form object used to create questions for a consultation from the admin dashboard.
+      class QuestionConfigurationForm < Form
+        include TranslatableAttributes
+        mimic :question
+
+        attribute :max_votes, Integer, default: 1
+        attribute :min_votes, Integer, default: 1
+        translatable_attribute :instructions, String
+
+        validates :max_votes, numericality: { greater_than_or_equal_to: 1 }
+        validates :min_votes, numericality: { greater_than_or_equal_to: 1 }
+        validate :min_lower_than_max
+
+        def min_lower_than_max
+          return if min_votes.to_i <= max_votes.to_i
+
+          errors.add(:max_votes, :lower_than_min)
+        end
+      end
+    end
+  end
+end

data/app/forms/decidim/consultations/multi_vote_form.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    # This form validates a MultiVote Question
+    class MultiVoteForm < Form
+      mimic :responses
+
+      attribute :responses, Array[Integer]
+
+      validate :valid_num_of_votes
+      validate :valid_responses
+
+      def vote_forms
+        @vote_forms ||= responses.map do |response_id|
+          VoteForm.from_params(decidim_consultations_response_id: response_id)
+        end
+      end
+
+      private
+
+      def valid_num_of_votes
+        return if responses.count.between?(context.current_question.min_votes, context.current_question.max_votes)
+
+        errors.add(
+          :responses,
+          I18n.t("activerecord.errors.models.decidim/consultations/vote.attributes.question.invalid_num_votes")
+        )
+      end
+
+      def valid_responses
+        return if vote_forms.all?(&:valid?)
+
+        errors.add(
+          :responses,
+          I18n.t("decidim_consultations_response_id.not_found", scope: "activemodel.errors.vote")
+        )
+      end
+    end
+  end
+end

data/app/forms/decidim/consultations/vote_form.rb

@@ -18,6 +18,7 @@ module Decidim
 
       def response_exists
         return unless response.nil?
+
         errors.add(
           :decidim_consultations_response_id,
           I18n.t("decidim_consultations_response_id.not_found", scope: "activemodel.errors.vote")

data/app/helpers/decidim/consultations/questions_helper.rb

@@ -9,19 +9,40 @@ module Decidim
       def display_next_previous_button(direction, optional_classes = "")
         css = "card__button button hollow " + optional_classes
 
+        # Do not show anything if is a lonely question
+        return unless previous_published_question || next_published_question
+
         case direction
         when :previous
           i18n_text = t("previous_button", scope: "decidim.questions")
-          question = previous_question || current_question
-          css << " disabled" if previous_question.nil?
+          question = previous_published_question || current_question
+          css << " disabled" if previous_published_question.nil?
         when :next
           i18n_text = t("next_button", scope: "decidim.questions")
-          question = next_question || current_question
-          css << " disabled" if next_question.nil?
+          question = next_published_question || current_question
+          css << " disabled" if next_published_question.nil?
         end
 
         link_to(i18n_text, decidim_consultations.question_path(question), class: css)
       end
+
+      def authorized_vote_modal_button(question, html_options, &block)
+        return if current_user && action_authorized_to(:vote, resource: nil, permissions_holder: question).ok?
+
+        tag = "button"
+        html_options ||= {}
+
+        if !current_user
+          html_options["data-open"] = "loginModal"
+        else
+          html_options["data-open"] = "authorizationModal"
+          html_options["data-open-url"] = decidim_consultations.authorization_vote_modal_question_path(question)
+        end
+
+        html_options["onclick"] = "event.preventDefault();"
+
+        send("#{tag}_to", "", html_options, &block)
+      end
     end
   end
 end

data/app/models/decidim/consultation.rb

@@ -10,6 +10,7 @@ module Decidim
     include Decidim::Traceable
     include Decidim::Loggable
     include Decidim::ParticipatorySpaceResourceable
+    include Decidim::Randomable
 
     belongs_to :organization,
                foreign_key: "decidim_organization_id",
@@ -64,6 +65,14 @@ module Decidim
       questions.published.group_by(&:scope)
     end
 
+    def total_votes
+      @total_votes ||= questions.published.sum(:votes_count)
+    end
+
+    def total_participants
+      @total_participants ||= questions.published.joins(:votes).select(:decidim_author_id).distinct.count
+    end
+
     # This method exists with the only purpose of getting rid of whats seems to be an issue in
     # the new scope picker: This engine is a bit special: consultations and questions are a kind of
     # nested participatory spaces. When a new question is created the consultation is the participatory space.
@@ -73,13 +82,6 @@ module Decidim
       nil
     end
 
-    def self.order_randomly(seed)
-      transaction do
-        connection.execute("SELECT setseed(#{connection.quote(seed)})")
-        select('"decidim_consultations".*, RANDOM()').order(Arel.sql("RANDOM()")).load
-      end
-    end
-
     def closed?
       !active?
     end

data/app/models/decidim/consultations/question.rb

@@ -4,6 +4,7 @@ module Decidim
   module Consultations
     # The data store for Consultation questions in the Decidim::Consultations component.
     class Question < ApplicationRecord
+      include Decidim::HasResourcePermission
       include Decidim::Participable
       include Decidim::Publicable
       include Decidim::Scopable
@@ -14,6 +15,7 @@ module Decidim
       include Decidim::Traceable
       include Decidim::Loggable
       include Decidim::ParticipatorySpaceResourceable
+      include Decidim::Randomable
 
       belongs_to :consultation,
                  foreign_key: "decidim_consultation_id",
@@ -59,14 +61,33 @@ module Decidim
         responses.order(votes_count: :desc)
       end
 
+      # if results can be shown to admins
+      def publishable_results?
+        consultation.finished? && sorted_results.any?
+      end
+
       def most_voted_response
         @most_voted_response ||= responses.order(votes_count: :desc).first
       end
 
+      # Total number of votes, on multiple votes questions does not match users voting
       def total_votes
         @total_votes ||= responses.sum(&:votes_count)
       end
 
+      # Total number of users voting
+      def total_participants
+        @total_participants ||= votes.select(:decidim_author_id).distinct.count
+      end
+
+      # Multiple answers allowed?
+      def multiple?
+        return false if external_voting
+        return false if max_votes.blank?
+
+        max_votes > 1
+      end
+
       # Public: Overrides the `comments_have_alignment?` Commentable concern method.
       def comments_have_alignment?
         true
@@ -142,16 +163,14 @@ module Decidim
         Decidim.find_participatory_space_manifest(Decidim::Consultation.name.demodulize.underscore.pluralize)
       end
 
-      def self.order_randomly(seed)
-        transaction do
-          connection.execute("SELECT setseed(#{connection.quote(seed)})")
-          select('"decidim_consultations_questions".*, RANDOM()').order(Arel.sql("RANDOM()")).load
-        end
-      end
-
       def resource_description
         subtitle
       end
+
+      # Public: Overrides the `allow_resource_permissions?` Resourceable concern method.
+      def allow_resource_permissions?
+        true
+      end
     end
   end
 end

data/app/models/decidim/consultations/vote.rb

@@ -18,7 +18,8 @@ module Decidim
                  inverse_of: :votes,
                  counter_cache: :votes_count
 
-      validates :author, uniqueness: { scope: [:decidim_user_group_id, :question] }
+      validates :author, uniqueness: { scope: [:decidim_user_group_id, :question] }, unless: -> { question.multiple? }
+      validate :votes_per_author
       validate :author_and_question_same_organization
 
       delegate :organization, to: :question
@@ -28,8 +29,17 @@ module Decidim
       # Private: check if the question and the author have the same organization
       def author_and_question_same_organization
         return if !question || !author
+
         errors.add(:question, :invalid) unless author.organization == question.organization
       end
+
+      # Author can vote multiple times constrained to question limits
+      def votes_per_author
+        return unless question.multiple?
+
+        total = Vote.where(author: author, question: question, decidim_user_group_id: decidim_user_group_id).count
+        errors.add(:question, :invalid_num_votes) unless total < question.max_votes
+      end
     end
   end
 end

data/app/permissions/decidim/consultations/admin/permissions.rb

@@ -72,7 +72,7 @@ module Decidim
           case permission_action.action
           when :create, :read
             allow!
-          when :update, :destroy, :preview
+          when :update, :destroy, :preview, :configure
             toggle_allow(question.present?)
           when :publish
             toggle_allow(question.external_voting || question.responses_count.positive?)

data/app/permissions/decidim/consultations/permissions.rb

@@ -7,6 +7,7 @@ module Decidim
         allowed_public_anonymous_action?
 
         return permission_action unless user
+
         allowed_public_action?
 
         return Decidim::Consultations::Admin::Permissions.new(user, permission_action, context).permissions if permission_action.scope == :admin
@@ -24,6 +25,12 @@ module Decidim
         @consultation ||= context.fetch(:consultation, nil)
       end
 
+      def authorized?(permission_action, resource: nil)
+        return unless resource || question
+
+        ActionAuthorizer.new(user, permission_action, question, resource).authorize.ok?
+      end
+
       def allowed_public_anonymous_action?
         return unless permission_action.action == :read
         return unless permission_action.scope == :public
@@ -42,6 +49,9 @@ module Decidim
         return unless permission_action.scope == :public
         return unless permission_action.subject == :question
 
+        # check if question has been limited by admins first
+        return unless authorized? :vote
+
         case permission_action.action
         when :vote
           toggle_allow(question.can_be_voted_by?(user))

data/app/views/decidim/consultations/admin/consultations/edit.html.erb

@@ -1,4 +1,7 @@
-<%= decidim_form_for(@form, html: { class: "form edit_consultation" }) do |f| %>
+<%= decidim_form_for @form,
+                     method: :patch,
+                     url: consultation_path(current_consultation),
+                     html: { class: "form edit_consultation" } do |f| %>
   <%= render partial: "form", object: f %>
   <div class="button--double form-general-submit">
     <%= f.submit t("consultations.edit.update", scope: "decidim.admin"), class: "button" %>