decidim-consultations 0.19.0 → 0.22.0

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/controllers/decidim/consultations/consultations_controller.rb

@@ -7,11 +7,11 @@ module Decidim
     class ConsultationsController < Decidim::Consultations::ApplicationController
       layout "layouts/decidim/consultation", only: :show
 
+      include ParticipatorySpaceContext
       include NeedsConsultation
       include FilterResource
       include Paginable
       include Decidim::Consultations::Orderable
-      include ParticipatorySpaceContext
 
       helper_method :collection, :consultations, :finished_consultations, :active_consultations, :filter
 

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
@@ -85,5 +96,10 @@ module Decidim
     def closed?
       !active?
     end
+
+    # Allow ransacker to search for a key in a hstore column (`title`.`en`)
+    ransacker :title do |parent|
+      Arel::Nodes::InfixOperation.new("->>", parent.table[:title], Arel::Nodes.build_quoted(I18n.locale.to_s))
+    end
   end
 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/permissions/decidim/consultations/permissions.rb

@@ -42,6 +42,8 @@ module Decidim
           toggle_allow(consultation.published? || user&.admin?)
         when :question
           toggle_allow(question.published? || user&.admin?)
+        when :participatory_space
+          allow!
         end
       end
 

data/app/types/decidim/consultations/consultation_question_type.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    # This type represents a consultation.
+    ConsultationQuestionType = GraphQL::ObjectType.define do
+      interfaces [
+        -> { Decidim::Core::ScopableInterface },
+        -> { Decidim::Core::AttachableInterface },
+        -> { Decidim::Comments::CommentableInterface }
+      ]
+
+      name "ConsultationQuestion"
+      description "A consultation question"
+
+      field :id, !types.ID, "Internal ID of the question"
+      field :title, Decidim::Core::TranslatedFieldType, "Title of the question"
+      field :subtitle, Decidim::Core::TranslatedFieldType, "The subtitle of this question"
+      field :slug, !types.String, "Slug of the question"
+      field :createdAt, !Decidim::Core::DateTimeType, "The time this question was created", property: :created_at
+      field :updatedAt, !Decidim::Core::DateTimeType, "The time this question was updated", property: :updated_at
+      field :publishedAt, !Decidim::Core::DateTimeType, "The time this question was published", property: :published_at
+
+      field :components, types[Decidim::Core::ComponentInterface] do
+        description "Lists the components this space contains."
+
+        resolve ->(participatory_space, _args, _ctx) {
+                  Decidim::Component.where(
+                    participatory_space: participatory_space
+                  ).published
+                }
+      end
+
+      field :bannerImage, types.String, "The banner image for this question", property: :banner_image
+      field :heroImage, types.String, "The hero image for this question", property: :hero_image
+
+      field :whatIsDecided, Decidim::Core::TranslatedFieldType, "What is decided in this question", property: :what_is_decided
+      field :promoterGroup, Decidim::Core::TranslatedFieldType, "The promoter group of this question", property: :promoter_group
+      field :participatoryScope, Decidim::Core::TranslatedFieldType, "The participatory scope of this question", property: :participatory_scope
+      field :questionContext, Decidim::Core::TranslatedFieldType, "The context for this question", property: :question_context
+      field :reference, types.String, "The reference for this question", property: :reference
+      field :hashtag, types.String, "The hashtag of this question", property: :hashtag
+      field :votesCount, types.Int, "The number of votes in this question", property: :votes_count
+      field :originScope, Decidim::Core::TranslatedFieldType, "The origin scope of this question", property: :origin_scope
+      field :originTitle, Decidim::Core::TranslatedFieldType, "The origin title of this question", property: :origin_title
+      field :originUrl, types.String, "The origin URL for this question", property: :origin_url
+      field :iFrameUrl, types.String, "The iframe URL for this question", property: :i_frame_url
+      field :externalVoting, types.Boolean, "If the question has external voting", property: :external_voting
+      field :responsesCount, types.Int, "The number of responses for this question", property: :responses_count
+      field :order, types.Int, "The order in which the question should be represented", property: :order
+      field :maxVotes, types.Int, "The maximum number of votes in this question", property: :max_votes
+      field :minVotes, types.Int, "The minimum number of votes in this question", property: :min_votes
+      field :responseGroupsCount, types.Int, "The number of group responses for this question", property: :response_groups_count
+      field :instructions, Decidim::Core::TranslatedFieldType, "Instructions for this question", property: :instructions
+    end
+  end
+end

data/app/types/decidim/consultations/consultation_type.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    # This type represents a consultation.
+    ConsultationType = GraphQL::ObjectType.define do
+      interfaces [
+        -> { Decidim::Core::ParticipatorySpaceInterface }
+      ]
+
+      name "Consultation"
+      description "A consultation"
+
+      field :subtitle, Decidim::Core::TranslatedFieldType, "The subtitle of this consultation"
+      field :description, Decidim::Core::TranslatedFieldType, "The description of this consultation"
+      field :slug, !types.String, "Slug of this consultation"
+      field :createdAt, !Decidim::Core::DateTimeType, "The time this consultation was created", property: :created_at
+      field :updatedAt, !Decidim::Core::DateTimeType, "The time this consultation was updated", property: :updated_at
+      field :publishedAt, !Decidim::Core::DateTimeType, "The time this consultation was published", property: :published_at
+
+      field :introductoryVideoUrl, types.String, "The introductory video url for this consultation", property: :introductory_video_url
+      field :introductoryImage, types.String, "The introductory image for this consultation", property: :introductory_image
+      field :bannerImage, types.String, "The banner image for this consultation", property: :banner_image
+      field :highlightedScope, Decidim::Core::ScopeApiType, "This is the highlighted scope of this consultation", property: :highlighted_scope
+      field :startVotingDate, Decidim::Core::DateType, "Start date of the voting for this consultation", property: :start_voting_date
+      field :endVotingDate, Decidim::Core::DateType, "End date of the voting for this consultation", property: :end_voting_date
+      field :resultsPublishedAt, Decidim::Core::DateType, "Date when the results have been published", property: :results_published_at
+
+      field :questions, types[Decidim::Consultations::ConsultationQuestionType], ""
+    end
+  end
+end

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

@@ -1,4 +1,4 @@
-<div class="card" id="consultations">
+<div class="card with-overflow" id="consultations">
   <div class="card-divider">
     <h2 class="card-title">
       <%= t "decidim.admin.titles.consultations" %>
@@ -6,13 +6,14 @@
                   ["new", "consultation"], class: "button tiny button--title" if allowed_to? :create, :consultation %>
     </h2>
   </div>
+  <%= admin_filter_selector %>
   <div class="card-section">
     <div class="table-scroll">
       <table class="table-list">
         <thead>
           <tr>
             <th><%= t("models.consultation.fields.title", scope: "decidim.admin") %></th>
-            <th><%= t("models.consultation.fields.created_at", scope: "decidim.admin") %></th>
+            <th><%= sort_link(query, :created_at, t("models.consultation.fields.created_at", scope: "decidim.admin"), default_order: :desc) %></th>
             <th class="table-list__actions">
               <%= t("models.consultation.fields.published", scope: "decidim.admin") %>
             </th>

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 %>