decidim-consultations 0.19.1 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e545d964f19b6346252bf1daa1fa7ee713c9ac43668c85fa8f2536ea4b17b619
-  data.tar.gz: fdf8ccf5ba93997db71195d78e7e120293503acdd2dcf999e3ba94e83b2ad967
+  metadata.gz: 770756382de23cf53682dd57ab217078711bf73a1e8c2df0a8f56afdc7ebe745
+  data.tar.gz: 764efb1bf1e01147a7b5a82203ff7f8ba64e2910181d9dfc0f850c1a5011d76e
 SHA512:
-  metadata.gz: e127db0074ad1c5d8fc8bef2e982f3d87eba236269afab8fb3e7e99634fda00a10d056db166aa9c2f9dcc7186182932e189eb105e7ed638da3d2bc42b5cd5589
-  data.tar.gz: a866cd5cfadd3f766947185d3464ec1605d2b08cd2d99211abe64993844cd794bf82dd31483e02fd8475cd9fa68b99caee6029153ad44c5d39af72077830ff10
+  metadata.gz: c13bfb201a61ef24723c27f2ee4b0e2573ee01178b2b29b1b86e7998e4824932f11698f846a541f45dcda0716ec89ee85df67f928d6b481665128ff42a975e9c
+  data.tar.gz: 7e1f3862681a23cfcbbb1f744d2a686e9576e6ff4c07efe55a8504226b473c60ea0726143852126f1fa6d3e45cc748f3e5cc484de35cf9c052638b12b8eb8ede

data/app/assets/javascripts/decidim/consultations/utils_multiple.js

@@ -11,7 +11,7 @@ $(document).ready(function () {
       max += 1;
     }
     if (max < 0) {
-      $(this).attr("checked", false);
+      $(this).prop("checked", false);
       event.preventDefault();
     }
     else {

data/app/assets/stylesheets/decidim/consultations/_question_multiple_votes.scss

@@ -0,0 +1,22 @@
+.question-masonry-group{
+  $masonry-css-column-gap: $global-margin;
+
+  column-count: 1;
+  column-gap: $masonry-css-column-gap;
+
+  @include breakpoint(map-get($breakpoints, medium)){
+    column-count: 2;
+  }
+
+  @include breakpoint(map-get($breakpoints, large)){
+    column-count: 3;
+  }
+
+  .column{
+    // override float styles from foundation
+    float: none !important;
+    width: auto !important;
+    break-inside: avoid;
+    margin-bottom: $masonry-css-column-gap;
+  }
+}

data/app/assets/stylesheets/decidim/consultations/consultations.scss

@@ -1,4 +1,5 @@
 @import "question";
+@import "question_multiple_votes";
 @import "video_wrapper";
 @import "stats";
 @import "consultations/*";

data/app/commands/decidim/consultations/admin/create_response.rb

@@ -31,7 +31,8 @@ module Decidim
         def create_response
           Response.create(
             question: form.context.current_question,
-            title: form.title
+            title: form.title,
+            response_group: form.response_group
           )
         end
       end

data/app/commands/decidim/consultations/admin/create_response_group.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    module Admin
+      # A command with all the business logic when creating a new response group
+      class CreateResponseGroup < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # form - A form object with the params.
+        def initialize(form)
+          @form = form
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if the form wasn't valid and we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          broadcast(:ok, create_response_group)
+        end
+
+        private
+
+        attr_reader :form
+
+        def create_response_group
+          ResponseGroup.create(
+            question: form.context.current_question,
+            title: form.title
+          )
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/consultations/admin/destroy_response_group.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    module Admin
+      # A command with all the business logic to destroy a response group in the
+      # system.
+      class DestroyResponseGroup < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # response_group - A ResponseGroup that will be destroyed
+        def initialize(response_group)
+          @response_group = response_group
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if the data wasn't valid and we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) if response_group.nil? || response_group.responses.any?
+
+          destroy_response_group
+          broadcast(:ok)
+        end
+
+        private
+
+        attr_reader :response_group
+
+        def destroy_response_group
+          response_group.destroy!
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/consultations/admin/update_response.rb

@@ -33,12 +33,13 @@ module Decidim
 
         def update_response
           response.assign_attributes(attributes)
-          response.save
+          response.save!
         end
 
         def attributes
           {
-            title: form.title
+            title: form.title,
+            response_group: form.response_group
           }
         end
       end

data/app/commands/decidim/consultations/admin/update_response_group.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    module Admin
+      # A command with all the business logic when updating a new response group
+      class UpdateResponseGroup < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # response_group - the response group to update
+        # form - A form object with the params.
+        def initialize(response_group, form)
+          @response_group = response_group
+          @form = form
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if the form wasn't valid and we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          broadcast(:ok, update_response_group)
+        end
+
+        private
+
+        attr_reader :form, :response_group
+
+        def update_response_group
+          response_group.assign_attributes(attributes)
+          response_group.save!
+        end
+
+        def attributes
+          {
+            title: form.title
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    module Admin
+      # Controller that manages responses for a question
+      class ResponseGroupsController < Decidim::Consultations::Admin::ApplicationController
+        include QuestionAdmin
+
+        helper_method :current_response_group
+
+        def index
+          enforce_permission_to :read, :response_group, question: current_question
+        end
+
+        def new
+          enforce_permission_to :create, :response_group, question: current_question
+          @form = response_group_form.instance
+        end
+
+        def create
+          enforce_permission_to :create, :response_group, question: current_question
+          @form = response_group_form.from_params(params, current_question: current_question)
+
+          CreateResponseGroup.call(@form) do
+            on(:ok) do
+              flash[:notice] = I18n.t("response_groups.create.success", scope: "decidim.admin")
+              redirect_to response_groups_path(current_question)
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("response_groups.create.error", scope: "decidim.admin")
+              render :new
+            end
+          end
+        end
+
+        def edit
+          enforce_permission_to :update, :response_group, response_group: current_response_group
+          @form = response_group_form.from_model(current_response_group)
+        end
+
+        def update
+          enforce_permission_to :update, :response_group, response_group: current_response_group
+
+          @form = response_group_form.from_params(params)
+          UpdateResponseGroup.call(current_response_group, @form) do
+            on(:ok) do
+              flash[:notice] = I18n.t("response_groups.update.success", scope: "decidim.admin")
+              redirect_to response_groups_path(current_question)
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("response_groups.update.error", scope: "decidim.admin")
+              render :edit
+            end
+          end
+        end
+
+        def destroy
+          enforce_permission_to :destroy, :response_group, response_group: current_response_group
+
+          DestroyResponseGroup.call(current_response_group) do
+            on(:ok) do
+              flash[:notice] = I18n.t("response_groups.destroy.success", scope: "decidim.admin")
+            end
+
+            on(:invalid) do
+              flash[:alert] = I18n.t("response_groups.destroy.error", scope: "decidim.admin")
+            end
+
+            redirect_to response_groups_path(current_question)
+          end
+        end
+
+        private
+
+        def current_response_group
+          @current_response_group ||= ResponseGroup.find_by(id: params[:id])
+        end
+
+        def response_group_form
+          form(ResponseGroupForm)
+        end
+      end
+    end
+  end
+end

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

@@ -7,6 +7,7 @@ module Decidim
       class ResponsesController < Decidim::Consultations::Admin::ApplicationController
         include QuestionAdmin
 
+        helper Admin::QuestionsHelper
         helper_method :current_response
 
         def index

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

@@ -10,8 +10,13 @@ module Decidim
         mimic :response
 
         translatable_attribute :title, String
+        attribute :decidim_consultations_response_group_id, Integer
 
         validates :title, translatable_presence: true
+
+        def response_group
+          ResponseGroup.find_by(id: decidim_consultations_response_group_id) if decidim_consultations_response_group_id
+        end
       end
     end
   end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    module Admin
+      # A form object used to create responses for a question from the admin dashboard.
+      class ResponseGroupForm < Form
+        include TranslatableAttributes
+
+        mimic :response_group
+
+        translatable_attribute :title, String
+
+        validates :title, translatable_presence: true
+      end
+    end
+  end
+end

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

@@ -5,9 +5,20 @@ module Decidim
     module Admin
       # Helper for questions controller
       module QuestionsHelper
+        include Decidim::TranslationsHelper
+
+        Option = Struct.new(:id, :title)
+
         def question_example_slug
           "question-#{Time.now.utc.year}-#{Time.now.utc.month}-1"
         end
+
+        def question_response_groups(question = current_question)
+          [Option.new("", "-")] +
+            question.response_groups.map do |group|
+              Option.new(group.id, translated_attribute(group.title))
+            end
+        end
       end
     end
   end

data/app/models/decidim/consultation.rb

@@ -11,6 +11,7 @@ module Decidim
     include Decidim::Loggable
     include Decidim::ParticipatorySpaceResourceable
     include Decidim::Randomable
+    include Decidim::Searchable
 
     belongs_to :organization,
                foreign_key: "decidim_organization_id",
@@ -41,6 +42,16 @@ module Decidim
     scope :finished, -> { published.where("end_voting_date < ?", Time.now.utc) }
     scope :order_by_most_recent, -> { order(created_at: :desc) }
 
+    searchable_fields({
+                        participatory_space: :itself,
+                        A: :title,
+                        B: :subtitle,
+                        D: :description,
+                        datetime: :published_at
+                      },
+                      index_on_create: ->(_process) { false },
+                      index_on_update: ->(process) { process.visible? })
+
     def to_param
       slug
     end

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

@@ -39,6 +39,12 @@ module Decidim
                inverse_of: :question,
                dependent: :destroy
 
+      has_many :response_groups,
+               foreign_key: "decidim_consultations_questions_id",
+               class_name: "Decidim::Consultations::ResponseGroup",
+               inverse_of: :question,
+               dependent: :destroy
+
       has_many :categories,
                foreign_key: "decidim_participatory_space_id",
                foreign_type: "decidim_participatory_space_type",
@@ -88,6 +94,22 @@ module Decidim
         max_votes > 1
       end
 
+      # Sorted responses by date so admins have a way to predict it
+      def sorted_responses
+        @sorted_responses ||= responses.sort_by(&:created_at)
+      end
+
+      # matrix of responses by group (sorted by configuration)
+      def grouped_responses
+        @grouped_responses ||= sorted_responses.group_by(&:response_group)
+      end
+
+      def grouped?
+        return false unless multiple?
+
+        response_groups_count.positive?
+      end
+
       # Public: Overrides the `comments_have_alignment?` Commentable concern method.
       def comments_have_alignment?
         true

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

@@ -14,6 +14,13 @@ module Decidim
                class_name: "Decidim::Consultations::Vote",
                inverse_of: :response,
                dependent: :restrict_with_error
+
+      belongs_to :response_group,
+                 foreign_key: "decidim_consultations_response_group_id",
+                 class_name: "Decidim::Consultations::ResponseGroup",
+                 inverse_of: :responses,
+                 counter_cache: :responses_count,
+                 optional: true
     end
   end
 end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    class ResponseGroup < ApplicationRecord
+      belongs_to :question,
+                 foreign_key: "decidim_consultations_questions_id",
+                 class_name: "Decidim::Consultations::Question",
+                 counter_cache: :response_groups_count,
+                 inverse_of: :response_groups
+
+      has_many :responses,
+               foreign_key: "decidim_consultations_response_group_id",
+               class_name: "Decidim::Consultations::Response",
+               inverse_of: :response_group,
+               dependent: :restrict_with_error
+    end
+  end
+end

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

@@ -27,6 +27,7 @@ module Decidim
           allowed_consultation_action?
           allowed_question_action?
           allowed_response_action?
+          allowed_response_group_action?
 
           permission_action
         end
@@ -45,6 +46,10 @@ module Decidim
           @response ||= context.fetch(:response, nil)
         end
 
+        def response_group
+          @response_group ||= context.fetch(:response_group, nil)
+        end
+
         def allowed_action_on_component?
           return unless permission_action.subject == :component
 
@@ -90,6 +95,17 @@ module Decidim
           end
         end
 
+        def allowed_response_group_action?
+          return unless permission_action.subject == :response_group
+
+          case permission_action.action
+          when :create, :read
+            toggle_allow(question&.multiple?)
+          when :update, :destroy
+            toggle_allow(response_group.present?)
+          end
+        end
+
         # Only admin users can enter the consultations area.
         def user_can_enter_space_area?
           return unless permission_action.action == :enter &&

data/app/views/decidim/consultations/admin/response_groups/_form.html.erb

@@ -0,0 +1,11 @@
+<div class="card">
+  <div class="card-divider">
+    <h2 class="card-title"><%= t "response_groups.form.title", scope: "decidim.admin" %></h2>
+  </div>
+
+  <div class="card-section">
+    <div class="row column">
+      <%= form.translated :text_field, :title, autofocus: true %>
+    </div>
+  </div>
+</div>

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

@@ -0,0 +1,18 @@
+<%= decidim_form_for @form,
+                     url: response_group_path(current_question, current_response_group),
+                     html: { class: "form edit_response_group" } do |f| %>
+  <%= render partial: "form", object: f %>
+  <div class="button--double form-general-submit">
+    <%= f.submit t("response_groups.edit.update", scope: "decidim.admin"),
+                 class: "button",
+                 data: { disable_with: true } %>
+
+    <% if allowed_to? :destroy, :response_group, response_group: current_response_group %>
+      <%= link_to t("decidim.admin.actions.destroy"),
+                  response_group_path(current_question, current_response_group),
+                  method: :delete,
+                  class: "alert button",
+                  data: { confirm: t("decidim.admin.actions.confirm_destroy") } %>
+    <% end %>
+  </div>
+<% end %>

data/app/views/decidim/consultations/admin/response_groups/index.html.erb

@@ -0,0 +1,56 @@
+<div class="card" id="questions">
+  <div class="card-divider">
+    <h2 class="card-title">
+      <%= t "decidim.admin.titles.response_groups" %>
+      <%= link_to t("actions.new_response_group", scope: "decidim.admin"),
+                  new_response_group_path(current_question),
+                  class: "button tiny button--title" if allowed_to? :create, :response_group, question: current_question %>
+      <%= link_to t("actions.back_to_responses", scope: "decidim.admin"),
+                  responses_path(current_question),
+                  class: "button tiny button--title" if allowed_to? :read, :response %>
+    </h2>
+  </div>
+  <div class="card-section">
+    <p>
+      <%= t "decidim.admin.response_groups.help" %>
+    </p>
+  </div>
+  <div class="card-section">
+    <div class="table-scroll">
+      <table class="table-list">
+        <thead>
+          <tr>
+            <th><%= t("models.response.fields.title", scope: "decidim.admin") %></th>
+            <th><%= t("models.response.fields.created_at", scope: "decidim.admin") %></th>
+            <th></th>
+          </tr>
+        </thead>
+        <tbody>
+          <% current_question.response_groups.each do |group| %>
+            <tr>
+              <td>
+                <% if allowed_to? :update, :response_group, response_group: group %>
+                  <%= link_to translated_attribute(group.title),
+                              edit_response_group_path(current_question, group) %>
+                <% else %>
+                  <%= translated_attribute(group.title) %>
+                <% end %>
+              </td>
+              <td>
+                <%= l group.created_at, format: :short %>
+              </td>
+              <td class="table-list__actions">
+                <% if allowed_to? :update, :response_group, response_group: group %>
+                  <%= icon_link_to "pencil",
+                                   edit_response_group_path(current_question, group),
+                                   t("actions.configure", scope: "decidim.admin"),
+                                   class: "action-icon--edit" %>
+                <% end %>
+              </td>
+            </tr>
+          <% end %>
+        </tbody>
+      </table>
+    </div>
+  </div>
+</div>

data/app/views/decidim/consultations/admin/response_groups/new.html.erb

@@ -0,0 +1,13 @@
+<h2 class="questions-title-summary">
+  <%= t "response_groups.new.title", scope: "decidim.admin" %>
+</h2>
+
+<%= decidim_form_for @form,
+                     url: response_groups_path(current_question),
+                     html: { class: "form new_response_group" } do |f| %>
+  <%= render partial: "form", object: f %>
+
+  <div class="button--double form-general-submit">
+    <%= f.submit t("response_groups.new.create", scope: "decidim.admin"), data: { disable_with: true } %>
+  </div>
+<% end %>

data/app/views/decidim/consultations/admin/responses/_form.html.erb

@@ -6,6 +6,9 @@
   <div class="card-section">
     <div class="row column">
       <%= form.translated :text_field, :title, autofocus: true %>
+      <% if allowed_to? :create, :response_group, question: current_question %>
+        <%= form.collection_select :decidim_consultations_response_group_id, question_response_groups, :id, :title %>
+      <% end %>
     </div>
   </div>
 </div>

data/app/views/decidim/consultations/admin/responses/index.html.erb

@@ -5,6 +5,9 @@
       <%= link_to t("actions.new_response", scope: "decidim.admin"),
                   new_response_path(current_question),
                   class: "button tiny button--title" if allowed_to? :create, :response %>
+      <%= link_to t("actions.response_groups", scope: "decidim.admin"),
+                  response_groups_path(current_question),
+                  class: "button tiny button--title" if allowed_to? :create, :response_group, question: current_question %>
     </h2>
   </div>
   <div class="card-section">
@@ -13,12 +16,15 @@
         <thead>
           <tr>
             <th><%= t("models.response.fields.title", scope: "decidim.admin") %></th>
+            <% if allowed_to? :create, :response_group, question: current_question %>
+              <th><%= t("models.response.fields.response_group", scope: "decidim.admin") %></th>
+            <% end %>
             <th><%= t("models.response.fields.created_at", scope: "decidim.admin") %></th>
             <th></th>
           </tr>
         </thead>
         <tbody>
-          <% current_question.responses.each do |response| %>
+          <% current_question.sorted_responses.each do |response| %>
             <tr>
               <td>
                 <% if allowed_to? :update, :response, response: response %>
@@ -28,6 +34,11 @@
                   <%= translated_attribute(response.title) %>
                 <% end %>
               </td>
+              <% if allowed_to? :create, :response_group, question: current_question %>
+              <td>
+                  <%= translated_attribute(response&.response_group&.title) %>
+              </td>
+              <% end %>
               <td>
                 <%= l response.created_at, format: :short %>
               </td>