decidim-consultations 0.11.0.pre1

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    class QuestionVotesController < Decidim::ApplicationController
+      include NeedsQuestion
+      include Decidim::FormFactory
+
+      before_action :authenticate_user!
+
+      def create
+        authorize! :vote, current_question
+
+        vote_form = form(VoteForm).from_params(params, current_question: current_question)
+        VoteQuestion.call(vote_form) do
+          on(:ok) do
+            current_question.reload
+            render :update_vote_button
+          end
+
+          on(:invalid) do
+            render json: {
+              error: I18n.t("question_votes.create.error", scope: "decidim.consultations")
+            }, status: 422
+          end
+        end
+      end
+
+      def destroy
+        authorize! :unvote, current_question
+        UnvoteQuestion.call(current_question, current_user) do
+          on(:ok) do
+            current_question.reload
+            render :update_vote_button
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    # This controller provides a widget that allows embedding the question
+    class QuestionWidgetsController < Decidim::WidgetsController
+      include NeedsQuestion
+
+      helper Decidim::SanitizeHelper
+
+      private
+
+      def model
+        @model ||= current_question
+      end
+
+      def current_participatory_space
+        model
+      end
+
+      def iframe_url
+        @iframe_url ||= question_question_widget_url(model)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    # A controller that holds the logic to show questions in a
+    # public layout.
+    class QuestionsController < Decidim::ApplicationController
+      layout "layouts/decidim/question"
+
+      include NeedsQuestion
+
+      helper Decidim::SanitizeHelper
+      helper Decidim::IconHelper
+      helper Decidim::Comments::CommentsHelper
+      helper Decidim::AttachmentsHelper
+      helper Decidim::ResourceReferenceHelper
+
+      def show
+        authorize! :read, current_question
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    module Admin
+      # A form object used to create consultations from the admin dashboard.
+      class ConsultationForm < Form
+        include TranslatableAttributes
+
+        mimic :consultation
+
+        translatable_attribute :title, String
+        translatable_attribute :subtitle, String
+        translatable_attribute :description, String
+        attribute :slug, String
+        attribute :banner_image
+        attribute :remove_banner_image
+        attribute :introductory_video_url, String
+        attribute :introductory_image, String
+        attribute :decidim_highlighted_scope_id, Integer
+        attribute :start_voting_date, Date
+        attribute :end_voting_date, Date
+
+        validates :slug, presence: true, format: { with: Decidim::Consultation.slug_format }
+        validates :title, :subtitle, :description, translatable_presence: true
+        validates :decidim_highlighted_scope_id, presence: true
+        validates :start_voting_date, presence: true, date: { before_or_equal_to: :end_voting_date }
+        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"] }
+
+        def highlighted_scope
+          @highlighted_scope ||= current_organization.scopes.find_by(id: decidim_highlighted_scope_id)
+        end
+
+        private
+
+        def slug_uniqueness
+          return unless OrganizationConsultations
+                        .new(current_organization)
+                        .query
+                        .where(slug: slug)
+                        .where.not(id: context[:consultation_id]).any?
+
+          errors.add(:slug, :taken)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+# 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 QuestionForm < Form
+        include TranslatableAttributes
+
+        mimic :question
+
+        translatable_attribute :title, String
+        translatable_attribute :promoter_group, String
+        translatable_attribute :participatory_scope, String
+        translatable_attribute :question_context, String
+        translatable_attribute :subtitle, String
+        translatable_attribute :what_is_decided, String
+        translatable_attribute :origin_scope, String
+        translatable_attribute :origin_title, String
+        attribute :origin_url, String
+        attribute :slug, String
+        attribute :remove_hero_image
+        attribute :hero_image
+        attribute :banner_image
+        attribute :remove_banner_image
+        attribute :hashtag, String
+        attribute :decidim_scope_id, Integer
+        attribute :external_voting, Boolean, default: false
+        attribute :i_frame_url, String
+        attribute :order, Integer
+
+        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"] }
+        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 }
+
+        private
+
+        def slug_uniqueness
+          return unless OrganizationQuestions
+                        .new(current_organization)
+                        .query
+                        .where(slug: slug)
+                        .where.not(id: context[:question_id]).any?
+
+          errors.add(:slug, :taken)
+        end
+
+        def has_origin_data?
+          has_value?(origin_title) || has_value?(origin_scope) || origin_url.present?
+        end
+
+        def has_value?(translatable_attribute)
+          return false if translatable_attribute.nil?
+
+          Decidim.available_locales.each do |locale|
+            return true if translatable_attribute.with_indifferent_access[locale].present?
+          end
+
+          false
+        end
+      end
+    end
+  end
+end

data/app/forms/decidim/consultations/admin/response_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 ResponseForm < Form
+        include TranslatableAttributes
+
+        mimic :response
+
+        translatable_attribute :title, String
+
+        validates :title, translatable_presence: true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    class VoteForm < Form
+      mimic :vote
+
+      attribute :decidim_consultations_response_id, Integer
+
+      validates :decidim_consultations_response_id, presence: true
+      validate :response_exists
+
+      def response
+        @response ||= Response.find_by(id: decidim_consultations_response_id)
+      end
+
+      private
+
+      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")
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    module Admin
+      # Helper for consultation controller
+      module ConsultationsHelper
+        def consultation_example_slug
+          "consultation-#{Time.now.utc.year}-#{Time.now.utc.month}-1"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    module Admin
+      # Helper for questions controller
+      module QuestionsHelper
+        def question_example_slug
+          "question-#{Time.now.utc.year}-#{Time.now.utc.month}-1"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    module ConsultationsHelper
+      # Returns  options for state filter selector.
+      def options_for_state_filter
+        [
+          ["all", t("consultations.filters.all", scope: "decidim")],
+          ["active", t("consultations.filters.active", scope: "decidim")],
+          ["upcoming", t("consultations.filters.upcoming", scope: "decidim")],
+          ["finished", t("consultations.filters.finished", scope: "decidim")]
+        ]
+      end
+    end
+  end
+end

data/app/models/concerns/decidim/consultations/override_categorization.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  module Consultations
+    module OverrideCategorization
+      extend ActiveSupport::Concern
+
+      included do
+        # This relationship exists only by compatibility reasons.
+        # Consultations are not intended to have categories.
+        has_many :categories,
+                 foreign_key: "decidim_participatory_space_id",
+                 foreign_type: "decidim_participatory_space_type",
+                 dependent: :destroy,
+                 as: :participatory_space
+      end
+    end
+  end
+end

data/app/models/concerns/decidim/consultations/publicable_results.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  module Consultations
+    # This concern contains the logic related to results publication and promotion.
+    module PublicableResults
+      extend ActiveSupport::Concern
+
+      class_methods do
+        # Public: Scope to return only records with its results published.
+        #
+        # Returns an ActiveRecord::Relation.
+        def results_published
+          where.not(results_published_at: nil)
+        end
+
+        # Public: Scope to return only records with its results unpublished.
+        #
+        # Returns an ActiveRecord::Relation.
+        def results_unpublished
+          where(results_published_at: nil)
+        end
+      end
+
+      # Public: Checks whether the record has its results published or not.
+      #
+      # Returns true if published, false otherwise.
+      def results_published?
+        results_published_at.present?
+      end
+
+      #
+      # Public: Publishes the results of the given component
+      #
+      # Returns true if the record was properly saved, false otherwise.
+      def publish_results!
+        update!(results_published_at: Time.current)
+      end
+
+      #
+      # Public: Unpublishes the results
+      #
+      # Returns true if the record was properly saved, false otherwise.
+      def unpublish_results!
+        update!(results_published_at: nil)
+      end
+    end
+  end
+end

data/app/models/decidim/consultation.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Decidim
+  # The data store for a Consultation in the Decidim::Consultations component.
+  class Consultation < ApplicationRecord
+    include Decidim::Participable
+    include Decidim::Publicable
+    include Decidim::Consultations::PublicableResults
+
+    belongs_to :organization,
+               foreign_key: "decidim_organization_id",
+               class_name: "Decidim::Organization"
+
+    belongs_to :highlighted_scope,
+               foreign_key: "decidim_highlighted_scope_id",
+               class_name: "Decidim::Scope"
+
+    has_many :questions,
+             foreign_key: "decidim_consultation_id",
+             class_name: "Decidim::Consultations::Question",
+             inverse_of: :consultation,
+             dependent: :destroy
+
+    validates :slug, uniqueness: { scope: :organization }
+    validates :slug, presence: true, format: { with: Decidim::Consultation.slug_format }
+
+    mount_uploader :banner_image, Decidim::BannerImageUploader
+    mount_uploader :introductory_image, Decidim::BannerImageUploader
+
+    scope :upcoming, -> { published.where("start_voting_date > ?", Time.now.utc) }
+    scope :active, lambda {
+      published
+        .where("start_voting_date <= ?", Time.now.utc)
+        .where("end_voting_date >= ?", Time.now.utc)
+    }
+    scope :finished, -> { published.where("end_voting_date < ?", Time.now.utc) }
+    scope :order_by_most_recent, -> { order(created_at: :desc) }
+
+    def to_param
+      slug
+    end
+
+    def upcoming?
+      start_voting_date > Time.now.utc
+    end
+
+    def active?
+      start_voting_date <= Time.now.utc && end_voting_date >= Time.now.utc
+    end
+
+    def finished?
+      end_voting_date < Time.now.utc
+    end
+
+    def highlighted_questions
+      questions.published.where(decidim_scope_id: decidim_highlighted_scope_id)
+    end
+
+    def regular_questions
+      questions.published.where.not(decidim_scope_id: decidim_highlighted_scope_id).group_by(&:scope)
+    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.
+    # Since seems that the scope picker is asking to the current participatory space for its scope
+    # this method is necessary to exist an return nil in order to be able to browse the scope hierarchy
+    def scope
+      nil
+    end
+
+    def self.order_randomly(seed)
+      transaction do
+        connection.execute("SELECT setseed(#{connection.quote(seed)})")
+        select('"decidim_consultations".*, RANDOM()').order("RANDOM()").load
+      end
+    end
+  end
+end