decidim-elections 0.22.0 → 0.23.0

data/app/forms/decidim/elections/admin/answer_import_proposals_form.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Elections
+    module Admin
+      # A form object to be used when admin users want to import a collection of proposals
+      # from another component into answers resource.
+      class AnswerImportProposalsForm < Decidim::Form
+        mimic :proposals_import
+
+        attribute :origin_component_id, Integer
+        attribute :import_all_accepted_proposals, Boolean
+        attribute :weight, Integer, default: 0
+
+        validates :origin_component_id, :origin_component, :current_component, presence: true
+
+        def origin_component
+          @origin_component ||= origin_components.find_by(id: origin_component_id)
+        end
+
+        def origin_components
+          @origin_components ||= current_participatory_space.components.where(manifest_name: :proposals)
+        end
+
+        def origin_components_collection
+          origin_components.map do |component|
+            [component.name[I18n.locale.to_s], component.id]
+          end
+        end
+
+        def election
+          @election ||= context[:election]
+        end
+
+        def question
+          @question ||= context[:question]
+        end
+      end
+    end
+  end
+end

data/app/forms/decidim/elections/admin/election_form.rb

@@ -8,16 +8,29 @@ module Decidim
         include TranslatableAttributes
 
         translatable_attribute :title, String
-        translatable_attribute :subtitle, String
         translatable_attribute :description, String
         attribute :start_time, Decidim::Attributes::TimeWithZone
         attribute :end_time, Decidim::Attributes::TimeWithZone
+        attribute :attachment, AttachmentForm
+        attribute :photos, Array[String]
+        attribute :add_photos, Array
 
         validates :title, translatable_presence: true
-        validates :subtitle, translatable_presence: true
         validates :description, translatable_presence: true
         validates :start_time, presence: true, date: { before: :end_time }
         validates :end_time, presence: true, date: { after: :start_time }
+        validate :notify_missing_attachment_if_errored
+
+        private
+
+        # This method will add an error to the `photos` field only if there's
+        # any error in any other field. This is needed because when the form has
+        # an error, the attachment is lost, so we need a way to inform the user of
+        # this problem.
+        def notify_missing_attachment_if_errored
+          errors.add(:attachment, :needs_to_be_reattached) if errors.any? && attachment.present?
+          errors.add(:add_photos, :needs_to_be_reattached) if errors.any? && add_photos.present?
+        end
       end
     end
   end

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

@@ -12,6 +12,7 @@ module Decidim
         attribute :max_selections, Integer, default: 1
         attribute :weight, Integer, default: 0
         attribute :random_answers_order, Boolean, default: true
+        attribute :min_selections, Integer, default: 1
 
         validates :title, translatable_presence: true
         validates :description, translatable_presence: true

data/app/helpers/decidim/elections/application_helper.rb

@@ -5,6 +5,18 @@ module Decidim
     # Custom helpers, scoped to the elections engine.
     #
     module ApplicationHelper
+      include Decidim::CheckBoxesTreeHelper
+
+      def state_filter_values
+        TreeNode.new(
+          TreePoint.new("", t("elections.elections.filters.all", scope: "decidim")),
+          [
+            TreePoint.new("active", t("elections.elections.filters.active", scope: "decidim")),
+            TreePoint.new("upcoming", t("elections.elections.filters.upcoming", scope: "decidim")),
+            TreePoint.new("finished", t("elections.elections.filters.finished", scope: "decidim"))
+          ]
+        )
+      end
     end
   end
 end

data/app/helpers/decidim/elections/election_cells_helper.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Elections
+    # Custom helpers for election cells.
+    #
+    module ElectionCellsHelper
+      include PaginateHelper
+      include Decidim::Comments::CommentsHelper
+    end
+  end
+end

data/app/helpers/decidim/elections/votes_helper.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Elections
+    # Custom helpers for the voting booth views.
+    #
+    module VotesHelper
+      def ordered_answers(question)
+        if question.random_answers_order
+          question.answers.shuffle
+        else
+          question.answers.sort_by { |answer| [answer.weight, answer.id] }
+        end
+      end
+
+      def more_information?(answer)
+        answer.description || answer.proposals.any? || answer.photos.any?
+      end
+    end
+  end
+end

data/app/models/decidim/elections/answer.rb

@@ -11,13 +11,17 @@ module Decidim
       include Traceable
       include Loggable
 
-      delegate :component, to: :question
       delegate :organization, :participatory_space, to: :component
 
       belongs_to :question, foreign_key: "decidim_elections_question_id", class_name: "Decidim::Elections::Question", inverse_of: :answers
+      has_one :election, through: :question, foreign_key: "decidim_elections_election_id", class_name: "Decidim::Elections::Election"
+      has_one :component, through: :election, foreign_key: "decidim_component_id", class_name: "Decidim::Component"
 
       default_scope { order(weight: :asc, id: :asc) }
 
+      # Public: Get all the proposals related to the answer
+      #
+      # Returns an ActiveRecord::Relation.
       def proposals
         linked_resources(:proposals, "related_proposals")
       end

data/app/models/decidim/elections/election.rb

@@ -5,18 +5,87 @@ module Decidim
     # The data store for an Election in the Decidim::Elections component. It stores a
     # title, description and any other useful information to perform an election.
     class Election < ApplicationRecord
+      include Decidim::HasAttachments
+      include Decidim::HasAttachmentCollections
+      include Decidim::Publicable
       include Decidim::Resourceable
       include Decidim::HasComponent
+      include Decidim::TranslatableResource
       include Traceable
       include Loggable
 
+      translatable_fields :title, :description
+
       component_manifest_name "elections"
 
       has_many :questions, foreign_key: "decidim_elections_election_id", class_name: "Decidim::Elections::Question", inverse_of: :election, dependent: :destroy
 
+      scope :active, lambda {
+        where("start_time <= ?", Time.current)
+          .where("end_time >= ?", Time.current)
+      }
+
+      scope :upcoming, lambda {
+        where("start_time > ?", Time.current)
+          .where("end_time > ?", Time.current)
+      }
+
+      scope :finished, lambda {
+        where("start_time < ?", Time.current)
+          .where("end_time < ?", Time.current)
+      }
+
+      def self.log_presenter_class_for(_log)
+        Decidim::Elections::AdminLog::ElectionPresenter
+      end
+
+      # Public: Checks if the election started
+      #
+      # Returns a boolean.
       def started?
         start_time <= Time.current
       end
+
+      # Public: Checks if the election finished
+      #
+      # Returns a boolean.
+      def finished?
+        end_time < Time.current
+      end
+
+      # Public: Checks if the election ongoing now
+      #
+      # Returns a boolean.
+      def ongoing?
+        started? && !finished?
+      end
+
+      # Public: Checks if the election questions are valid
+      #
+      # Returns a boolean.
+      def valid_questions?
+        questions.each do |question|
+          return false unless question.valid_max_selection?
+        end
+      end
+
+      # Public: Gets the voting period status of the election
+      #
+      # Returns one of these symbols: upcoming, ongoing or finished
+      def voting_period_status
+        if finished?
+          :finished
+        elsif started?
+          :ongoing
+        else
+          :upcoming
+        end
+      end
+
+      # Public: Overrides the Resourceable concern method to allow setting permissions at resource level
+      def allow_resource_permissions?
+        true
+      end
     end
   end
 end

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

@@ -9,12 +9,19 @@ module Decidim
       include Traceable
       include Loggable
 
-      delegate :component, to: :election
-
       belongs_to :election, foreign_key: "decidim_elections_election_id", class_name: "Decidim::Elections::Election", inverse_of: :questions
       has_many :answers, foreign_key: "decidim_elections_question_id", class_name: "Decidim::Elections::Answer", inverse_of: :question, dependent: :destroy
 
+      has_one :component, through: :election, foreign_key: "decidim_component_id", class_name: "Decidim::Component"
+
       default_scope { order(weight: :asc, id: :asc) }
+
+      # Public: Checks if enough answers are given for max_selections attribute
+      #
+      # Returns a boolean.
+      def valid_max_selection?
+        max_selections <= answers.count
+      end
     end
   end
 end

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

@@ -12,15 +12,17 @@ module Decidim
             case permission_action.action
             when :create, :update, :delete
               allow_if_not_started
+            when :import_proposals
+              allow_if_not_started
             end
           when :election
             case permission_action.action
             when :create, :read
               allow!
-            when :update
-              toggle_allow(election)
-            when :delete
+            when :delete, :update, :unpublish
               allow_if_not_started
+            when :publish
+              allow_if_valid_and_not_started
             end
           end
 
@@ -33,9 +35,17 @@ module Decidim
           @election ||= context.fetch(:election, nil)
         end
 
+        def question
+          @question ||= context.fetch(:question, nil)
+        end
+
         def allow_if_not_started
           toggle_allow(election && !election.started?)
         end
+
+        def allow_if_valid_and_not_started
+          toggle_allow(election && !election.started? && election.valid_questions?)
+        end
       end
     end
   end

data/app/permissions/decidim/elections/permissions.rb

@@ -4,13 +4,48 @@ module Decidim
   module Elections
     class Permissions < Decidim::DefaultPermissions
       def permissions
+        # Anonymous users can only view elections
+        toggle_allow(can_view?) if permission_action.scope == :public && permission_action.subject == :election && permission_action.action == :view
+
         return permission_action unless user
 
         # Delegate the admin permission checks to the admin permissions class
         return Decidim::Elections::Admin::Permissions.new(user, permission_action, context).permissions if permission_action.scope == :admin
 
+        return permission_action if permission_action.scope != :public
+        return permission_action if permission_action.subject != :election
+
+        case permission_action.action
+        when :vote
+          toggle_allow(can_vote?)
+        when :preview
+          toggle_allow(can_preview?)
+        end
+
         permission_action
       end
+
+      private
+
+      def can_view?
+        election.published? || user&.admin?
+      end
+
+      def can_vote?
+        election.published? && election.ongoing? && authorized_to_vote?
+      end
+
+      def can_preview?
+        user.admin? && !can_vote?
+      end
+
+      def authorized_to_vote?
+        authorized?(:vote, resource: election)
+      end
+
+      def election
+        @election ||= context[:election]
+      end
     end
   end
 end

data/app/presenters/decidim/elections/admin_log/election_presenter.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Elections
+    module AdminLog
+      # This class holds the logic to present a `Decidim::Election`
+      # for the `AdminLog` log.
+      #
+      # Usage should be automatic and you shouldn't need to call this class
+      # directly, but here's an example:
+      #
+      #    action_log = Decidim::ActionLog.last
+      #    view_helpers # => this comes from the views
+      #    ElectionPresenter.new(action_log, view_helpers).present
+      class ElectionPresenter < Decidim::Log::BasePresenter
+        private
+
+        def diff_fields_mapping
+          {
+            name: :i18n,
+            published_at: :date,
+            weight: :integer
+          }
+        end
+
+        def i18n_labels_scope
+          "activemodel.attributes.election"
+        end
+
+        def action_string
+          case action
+          when "publish", "unpublish"
+            "decidim.elections.admin_log.election.#{action}"
+          else
+            super
+          end
+        end
+      end
+    end
+  end
+end

data/app/presenters/decidim/elections/election_presenter.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Elections
+    #
+    # Decorator for election
+    #
+    class ElectionPresenter < SimpleDelegator
+      include Decidim::SanitizeHelper
+      include Decidim::TranslatableAttributes
+
+      def election
+        __getobj__
+      end
+
+      def title
+        content = translated_attribute(election.title)
+        decidim_html_escape(content)
+      end
+
+      def description(strip_tags: false)
+        content = translated_attribute(election.description)
+        content = strip_tags(content) if strip_tags
+        content
+      end
+    end
+  end
+end

data/app/queries/decidim/elections/filtered_elections.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Elections
+    # A class used to find elections filtered by its state
+    class FilteredElections < Rectify::Query
+      # Syntactic sugar to initialize the class and return the queried objects.
+      #
+      # components - An array of Decidim::Component
+      # start_at - A date to filter resources created after it
+      # end_at - A date to filter resources created before it.
+      def self.for(components, start_at = nil, end_at = nil)
+        new(components, start_at, end_at).query
+      end
+
+      # Initializes the class.
+      #
+      # components - An array of Decidim::Component
+      # start_at - A date to filter resources created after it
+      # end_at - A date to filter resources created before it.
+      def initialize(components, start_at = nil, end_at = nil)
+        @components = components
+        @start_at = start_at
+        @end_at = end_at
+      end
+
+      # Finds the Projects scoped to an array of components and filtered
+      # by a range of dates.
+      def query
+        elections = Decidim::Elections::Election.where(component: @components)
+        elections = elections.where("created_at >= ?", @start_at) if @start_at.present?
+        elections = elections.where("created_at <= ?", @end_at) if @end_at.present?
+        elections
+      end
+    end
+  end
+end