decidim-consultations 0.19.1 → 0.23.0

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/consultation_form.rb

@@ -6,6 +6,7 @@ module Decidim
       # A form object used to create consultations from the admin dashboard.
       class ConsultationForm < Form
         include TranslatableAttributes
+        include Decidim::HasUploadValidations
 
         mimic :consultation
 
@@ -29,12 +30,10 @@ module Decidim
         validates :end_voting_date, presence: true, date: { after_or_equal_to: :start_voting_date }
         validate :slug_uniqueness
 
-        validates :banner_image,
-                  file_size: { less_than_or_equal_to: ->(_record) { Decidim.maximum_attachment_size } },
-                  file_content_type: { allow: ["image/jpeg", "image/png"] }
-        validates :introductory_image,
-                  file_size: { less_than_or_equal_to: ->(_record) { Decidim.maximum_attachment_size } },
-                  file_content_type: { allow: ["image/jpeg", "image/png"] }
+        validates :banner_image, passthru: { to: Decidim::Consultation }
+        validates :introductory_image, passthru: { to: Decidim::Consultation }
+
+        alias organization current_organization
 
         def highlighted_scope
           @highlighted_scope ||= current_organization.scopes.find_by(id: decidim_highlighted_scope_id)

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

@@ -6,6 +6,7 @@ module Decidim
       # A form object used to create questions for a consultation from the admin dashboard.
       class QuestionForm < Form
         include TranslatableAttributes
+        include Decidim::HasUploadValidations
 
         mimic :question
 
@@ -32,17 +33,15 @@ module Decidim
         validates :slug, presence: true, format: { with: Decidim::Consultations::Question.slug_format }
         validates :title, :promoter_group, :participatory_scope, :subtitle, :what_is_decided, translatable_presence: true
         validates :decidim_scope_id, presence: true
-        validates :hero_image,
-                  file_size: { less_than_or_equal_to: ->(_record) { Decidim.maximum_attachment_size } },
-                  file_content_type: { allow: ["image/jpeg", "image/png"] }
-        validates :banner_image,
-                  file_size: { less_than_or_equal_to: ->(_record) { Decidim.maximum_attachment_size } },
-                  file_content_type: { allow: ["image/jpeg", "image/png"] }
+        validates :hero_image, passthru: { to: Decidim::Consultations::Question }
+        validates :banner_image, passthru: { to: Decidim::Consultations::Question }
         validate :slug_uniqueness
         validates :origin_scope, :origin_title, translatable_presence: true, if: :has_origin_data?
         validates :i_frame_url, presence: true, if: :external_voting
         validates :order, numericality: { only_integer: true, allow_nil: true, allow_blank: true }
 
+        alias organization current_organization
+
         private
 
         def slug_uniqueness

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,11 @@ module Decidim
     include Decidim::Loggable
     include Decidim::ParticipatorySpaceResourceable
     include Decidim::Randomable
+    include Decidim::Searchable
+    include Decidim::HasUploadValidations
+    include Decidim::TranslatableResource
+
+    translatable_fields :title, :subtitle, :description
 
     belongs_to :organization,
                foreign_key: "decidim_organization_id",
@@ -26,10 +31,15 @@ module Decidim
              inverse_of: :consultation,
              dependent: :destroy
 
+    alias component_ids question_ids
+
     validates :slug, uniqueness: { scope: :organization }
     validates :slug, presence: true, format: { with: Decidim::Consultation.slug_format }
 
+    validates_upload :banner_image
     mount_uploader :banner_image, Decidim::BannerImageUploader
+
+    validates_upload :introductory_image
     mount_uploader :introductory_image, Decidim::BannerImageUploader
 
     scope :upcoming, -> { published.where("start_voting_date > ?", Time.now.utc) }
@@ -41,6 +51,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 +105,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

@@ -7,7 +7,7 @@ module Decidim
       include Decidim::HasResourcePermission
       include Decidim::Participable
       include Decidim::Publicable
-      include Decidim::Scopable
+      include Decidim::ScopableParticipatorySpace
       include Decidim::Comments::Commentable
       include Decidim::Followable
       include Decidim::HasAttachments
@@ -16,6 +16,10 @@ module Decidim
       include Decidim::Loggable
       include Decidim::ParticipatorySpaceResourceable
       include Decidim::Randomable
+      include Decidim::HasUploadValidations
+      include Decidim::TranslatableResource
+
+      translatable_fields :title, :subtitle, :what_is_decided, :promoter_group, :participatory_scope, :question_context, :origin_scope, :origin_title, :instructions
 
       belongs_to :consultation,
                  foreign_key: "decidim_consultation_id",
@@ -39,13 +43,22 @@ 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",
                dependent: :destroy,
                as: :participatory_space
 
+      validates_upload :hero_image
       mount_uploader :hero_image, Decidim::HeroImageUploader
+
+      validates_upload :banner_image
       mount_uploader :banner_image, Decidim::BannerImageUploader
 
       default_scope { order(order: :asc) }
@@ -88,6 +101,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
@@ -171,6 +200,10 @@ module Decidim
       def allow_resource_permissions?
         true
       end
+
+      def attachment_context
+        :admin
+      end
     end
   end
 end

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

@@ -3,6 +3,10 @@
 module Decidim
   module Consultations
     class Response < ApplicationRecord
+      include Decidim::TranslatableResource
+
+      translatable_fields :title
+
       belongs_to :question,
                  foreign_key: "decidim_consultations_questions_id",
                  class_name: "Decidim::Consultations::Question",
@@ -14,6 +18,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,23 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    class ResponseGroup < ApplicationRecord
+      include Decidim::TranslatableResource
+
+      translatable_fields :title
+
+      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/presenters/decidim/consultations/question_stats_presenter.rb

@@ -15,7 +15,7 @@ module Decidim
           "question/#{question.id}/comments_count",
           expires_in: Decidim::Consultations.stats_cache_expiration_time
         ) do
-          Decidim::Comments::Comment.where(root_commentable: question).count
+          question.comments_count
         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