decidim-elections 0.31.5 → 0.32.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96c37dba7e69df06576460094925f300e2eaf7df879568b83d2bb9d67c5cf9d6
-  data.tar.gz: 9202c1b60fef070ae9524a73b2eaad08c85c3b8fbc0eeee3abe2d62169cc5362
+  metadata.gz: 4ed28042a5ba0fce7e077a20442c88ba8aa8d8e3521fc4e2f9f6a8ccda083757
+  data.tar.gz: 297dcd5aa0f624246f8fc9c0e657b7cf6c734e299f3da9ec5495fcdaa29e2b87
 SHA512:
-  metadata.gz: 1f81d1f6f8e9bbf8b5c21c4a9d5327bcb85fc8699f84688a7485334b2295acb22354f0521a14a12afbfd96be50bf2ea77bc2541567ccd5371f7075be079446c3
-  data.tar.gz: 1b1207e84a3f74151fde3d2e33a07cfb4712527ada1bacf944e0dd5596ba3a1575a9fa568aca41a4062b3ffd7fc2ca14ddde3db130ce5f9f835db676bb369548
+  metadata.gz: 0f0cac1305197050665c4f751d57643818f76b99966e180993a78044fb367f75c71b2dab404fff2a5ae247465d1c0b6c1fdaa36fb553693e2ad675eb50d6ebb7
+  data.tar.gz: 3bb3edb2068ea51e0e24933e7de96637241d7b1a83b1766c3ed8ba6dd5801b6ee072df2acddbabca53cb965880a247e9cc2e8d42b5526d1c3394d5acfd942d0e

data/README.md

@@ -1,7 +1,11 @@
-# Decidim::Elections
+# decidim-elections
 
 The Decidim::Elections is a component that allows users to setup non-cryptographic elections. Elections are basically polls/surveys with census access management built-in. This allows registered or non-registered users to directly participate in them.
 
+## Usage
+
+Elections will be available as a Component for a Participatory Space.
+
 ## Installation
 
 In order to install use this module, you need at least Decidim 0.31 to be installed.
@@ -10,6 +14,8 @@ To install this module, run in your console:
 
 ```bash
 bundle add decidim-elections
+bundle exec rails decidim:upgrade
+bundle exec rails db:migrate
 ```
 
 ## Contributing

data/app/commands/decidim/elections/admin/process_census.rb

@@ -9,7 +9,7 @@ module Decidim
         def attributes
           {
             census_manifest: resource.census.name,
-            census_settings: census_settings
+            census_settings:
           }
         end
 

data/app/commands/decidim/elections/admin/update_election.rb

@@ -5,6 +5,7 @@ module Decidim
     module Admin
       class UpdateElection < Decidim::Commands::UpdateResource
         include ::Decidim::GalleryMethods
+
         fetch_form_attributes :title, :description, :start_at, :end_at, :results_availability
 
         def initialize(form, election)

data/app/commands/decidim/elections/admin/update_election_status.rb

@@ -5,7 +5,7 @@ module Decidim
     module Admin
       class UpdateElectionStatus < Decidim::Command
         def initialize(action, election)
-          @action = action.to_sym
+          @action = action.try(:to_sym)
           @election = election
         end
 

data/app/commands/decidim/elections/admin/update_questions.rb

@@ -47,6 +47,7 @@ module Decidim
             body: question_form.body,
             description: question_form.description,
             question_type: question_form.question_type,
+            max_choices: question_form.max_choices,
             position: index
           )
 

data/app/commands/decidim/elections/cast_votes.rb

@@ -40,11 +40,11 @@ module Decidim
         voted_questions.each do |question, responses|
           raise StandardError, "No responses for question #{question.id}" if responses.blank?
 
-          question.votes.where(voter_uid: voter_uid).destroy_all
+          question.votes.where(voter_uid:).destroy_all
           responses.each do |response_option|
             question.votes.create!(
-              voter_uid: voter_uid,
-              response_option: response_option
+              voter_uid:,
+              response_option:
             )
           end
         end

data/app/controllers/concerns/decidim/elections/uses_census_access.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Elections
+    module UsesCensusAccess
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :exit_path, :election, :session_authenticated?, :session_attributes, :voter_uid
+      end
+
+      private
+
+      def election
+        @election ||= Election.where(component: current_component).published.find(params[:election_id])
+      end
+
+      def session_authenticated?
+        @session_authenticated ||= election.census.valid_user?(election, session_attributes, current_user:)
+      end
+
+      def voter_uid
+        @voter_uid ||= election.census.voter_uid(election, session_attributes, current_user:)
+      end
+
+      def session_attributes
+        session[:session_attributes] ||= {}
+      end
+
+      def exit_path
+        @exit_path ||= if allowed_to?(:read, :election, election:)
+                         election_path(election)
+                       else
+                         elections_path
+                       end
+      end
+    end
+  end
+end

data/app/controllers/concerns/decidim/elections/uses_votes_booth.rb

@@ -7,8 +7,10 @@ module Decidim
       extend ActiveSupport::Concern
 
       included do
+        include UsesCensusAccess
+
         layout "decidim/election_booth"
-        helper_method :exit_path, :election, :questions, :question, :response_chosen?, :votes_buffer
+        helper_method :questions, :question, :response_chosen?, :votes_buffer
 
         before_action except: [:new, :create, :receipt] do
           next if session_authenticated?
@@ -64,10 +66,6 @@ module Decidim
 
       private
 
-      def election
-        @election ||= Election.where(component: current_component).published.find(params[:election_id])
-      end
-
       def questions
         @questions ||= election.questions
       end
@@ -76,22 +74,10 @@ module Decidim
         @question ||= questions.find_by(id: params[:id]) || questions.first
       end
 
-      def session_authenticated?
-        @session_authenticated ||= election.census.valid_user?(election, session_attributes, current_user:)
-      end
-
-      def voter_uid
-        @voter_uid ||= election.census.voter_uid(election, session_attributes, current_user:)
-      end
-
       def votes_buffer
         session[:votes_buffer] ||= {}
       end
 
-      def session_attributes
-        session[:session_attributes] ||= {}
-      end
-
       def response_chosen?(response_option)
         response_ids = if votes_buffer.has_key?(question.id.to_s)
                          votes_buffer[question.id.to_s]
@@ -105,17 +91,9 @@ module Decidim
 
       def previous_responses
         @previous_responses ||= election.questions.to_h do |question|
-          [question.id.to_s, question.votes.where(voter_uid: voter_uid).pluck(:response_option_id).map(&:to_s)]
+          [question.id.to_s, question.votes.where(voter_uid:).pluck(:response_option_id).map(&:to_s)]
         end
       end
-
-      def exit_path
-        @exit_path ||= if allowed_to?(:read, :election, election:)
-                         election_path(election)
-                       else
-                         elections_path
-                       end
-      end
     end
   end
 end

data/app/controllers/decidim/elections/admin/census_controller.rb

@@ -11,15 +11,15 @@ module Decidim
         before_action :set_census_manifest, only: [:edit, :update]
 
         def edit
-          enforce_permission_to :update, :census, election: election
+          enforce_permission_to(:update, :census, election:)
 
-          @form = form(election.census.admin_form.constantize).from_params(election.census_settings, election: election) if election.census && election.census.admin_form.present?
+          @form = form(election.census.admin_form.constantize).from_params(election.census_settings, election:) if election.census && election.census.admin_form.present?
         end
 
         def update
-          enforce_permission_to :update, :census, election: election
+          enforce_permission_to(:update, :census, election:)
 
-          @form = form(election.census.admin_form.constantize).from_params(params, election: election) if election.census.admin_form.present?
+          @form = form(election.census.admin_form.constantize).from_params(params, election:) if election.census.admin_form.present?
 
           ProcessCensus.call(@form, election) do
             on(:ok) do
@@ -28,7 +28,7 @@ module Decidim
             end
             on(:invalid) do
               flash[:alert] = t("decidim.elections.admin.census.update.error")
-              render :edit, status: :unprocessable_entity
+              render :edit, status: :unprocessable_content
             end
           end
         end

data/app/controllers/decidim/elections/admin/elections_controller.rb

@@ -35,7 +35,7 @@ module Decidim
 
             on(:invalid) do
               flash.now[:alert] = I18n.t("elections.create.invalid", scope: "decidim.elections.admin")
-              render action: "new", status: :unprocessable_entity
+              render action: "new", status: :unprocessable_content
             end
           end
         end
@@ -46,7 +46,7 @@ module Decidim
         end
 
         def update
-          enforce_permission_to :update, :election, election: election
+          enforce_permission_to(:update, :election, election:)
 
           @form = form(Decidim::Elections::Admin::ElectionForm).from_params(params, current_component:, election:)
 
@@ -58,13 +58,13 @@ module Decidim
 
             on(:invalid) do
               flash.now[:alert] = I18n.t("elections.update.invalid", scope: "decidim.elections.admin")
-              render action: "edit", status: :unprocessable_entity
+              render action: "edit", status: :unprocessable_content
             end
           end
         end
 
         def publish
-          enforce_permission_to :publish, :election, election: election
+          enforce_permission_to(:publish, :election, election:)
 
           PublishElection.call(election, current_user) do
             on(:ok) do
@@ -74,13 +74,13 @@ module Decidim
 
             on(:invalid) do
               flash.now[:alert] = I18n.t("elections.publish.invalid", scope: "decidim.elections.admin")
-              render action: "index", status: :unprocessable_entity
+              render action: "index", status: :unprocessable_content
             end
           end
         end
 
         def unpublish
-          enforce_permission_to :unpublish, :election, election: election
+          enforce_permission_to(:unpublish, :election, election:)
 
           Decidim::Elections::Admin::UnpublishElection.call(election, current_user) do
             on(:ok) do
@@ -90,13 +90,13 @@ module Decidim
 
             on(:invalid) do
               flash.now[:alert] = I18n.t("elections.unpublish.invalid", scope: "decidim.elections.admin")
-              render action: "index", status: :unprocessable_entity
+              render action: "index", status: :unprocessable_content
             end
           end
         end
 
         def dashboard
-          enforce_permission_to :dashboard, :election, election: election
+          enforce_permission_to(:dashboard, :election, election:)
 
           respond_to do |format|
             format.html { render :dashboard }
@@ -107,7 +107,7 @@ module Decidim
         end
 
         def update_status
-          enforce_permission_to :update, :election, election: election
+          enforce_permission_to(:update, :election, election:)
 
           status_action = params[:status_action]
           UpdateElectionStatus.call(status_action, election) do
@@ -122,6 +122,17 @@ module Decidim
           redirect_to dashboard_election_path(election)
         end
 
+        def toggle_census_check
+          enforce_permission_to(:update, :election, election:)
+
+          value = ActiveModel::Type::Boolean.new.cast(params[:allow_census_check_before_start])
+          election.update!(allow_census_check_before_start: value)
+
+          render json: { success: true, allow_census_check_before_start: election.allow_census_check_before_start }
+        rescue StandardError
+          render json: { success: false, error: I18n.t("elections.toggle_census_check.error", scope: "decidim.elections.admin") }, status: :unprocessable_content
+        end
+
         private
 
         def per_question_waiting?

data/app/controllers/decidim/elections/admin/questions_controller.rb

@@ -29,7 +29,7 @@ module Decidim
 
             on(:invalid) do
               flash.now[:alert] = I18n.t("update.invalid", scope: "decidim.elections.admin.questions")
-              render :edit_questions, status: :unprocessable_entity
+              render :edit_questions, status: :unprocessable_content
             end
           end
         end

data/app/controllers/decidim/elections/census_checks_controller.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Elections
+    # Allows participants to verify they belong to an election census before voting starts.
+    class CensusChecksController < Decidim::Elections::ApplicationController
+      include UsesCensusAccess
+
+      layout "decidim/election_booth"
+
+      before_action :redirect_if_authenticated, only: :new
+      before_action :ensure_session_authenticated!, only: :show
+
+      def new
+        enforce_permission_to(:create, :census_check, election:)
+
+        @form = election.census.form_instance({}, election:, current_user:)
+        render "decidim/elections/votes/new"
+      end
+
+      def create
+        enforce_permission_to(:create, :census_check, election:)
+
+        @form = election.census.form_instance(params, election:, current_user:)
+        if @form.valid?
+          session[:session_attributes] = @form.attributes
+          redirect_to election_census_check_path(election)
+        else
+          flash[:alert] = @form.errors.full_messages.join("<br>").presence || t("failed", scope: "decidim.elections.votes.check_census")
+          redirect_to new_election_census_check_path(election)
+        end
+      end
+
+      def show
+        enforce_permission_to(:read, :census_check, election:)
+      end
+
+      private
+
+      # Allows admins to access unpublished elections for preview.
+      def election
+        @election ||= Election.where(component: current_component)
+                              .then { |scope| current_user&.admin? ? scope : scope.published }
+                              .find(params[:election_id])
+      end
+
+      def redirect_if_authenticated
+        redirect_to election_census_check_path(election) if session_authenticated?
+      end
+
+      def ensure_session_authenticated!
+        return if session_authenticated?
+
+        redirect_to new_election_census_check_path(election), alert: t("decidim.elections.votes.check_census.failed")
+      end
+    end
+  end
+end

data/app/controllers/decidim/elections/elections_controller.rb

@@ -30,7 +30,7 @@ module Decidim
       end
 
       def election
-        @election ||= current_user&.admin? ? available_elections.find(params[:id]) : elections.find(params[:id])
+        @election ||= current_user&.admin? ? available_elections.find_by(id: params[:id]) : elections.find_by(id: params[:id])
       end
 
       def questions
@@ -59,6 +59,16 @@ module Decidim
           with_any_state: "all"
         }
       end
+
+      def add_breadcrumb_item
+        return {} if election.blank?
+
+        {
+          label: translated_attribute(election.title),
+          url: Decidim::EngineRouter.main_proxy(current_component).election_path(election),
+          active: false
+        }
+      end
     end
   end
 end

data/app/controllers/decidim/elections/votes_controller.rb

@@ -20,6 +20,14 @@ module Decidim
       def update
         enforce_permission_to(:create, :vote, election:)
 
+        response_ids = Array(params.dig(:response, question.id.to_s)).compact
+
+        if question.max_choices.present? && response_ids.size > question.max_choices
+          flash.now[:alert] = t("votes.question.max_choices_exceeded", scope: "decidim.elections", max: question.max_choices)
+          render :show
+          return
+        end
+
         votes_buffer[question.id.to_s] = params.dig(:response, question.id.to_s)
         redirect_to next_vote_step_path
       end

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

@@ -10,6 +10,7 @@ module Decidim
 
         attribute :question_type, String, default: "multiple_option"
         attribute :response_options, Array[Decidim::Elections::Admin::ResponseOptionForm]
+        attribute :max_choices, Integer
         attribute :deleted, Boolean, default: false
 
         translatable_attribute :body, String
@@ -18,6 +19,7 @@ module Decidim
         validates :body, translatable_presence: true
         validates :question_type, inclusion: { in: Decidim::Elections::Question.question_types }, if: :editable?
         validates :response_options, presence: true, if: :editable?
+        validates :max_choices, numericality: { only_integer: true, greater_than: 1, less_than_or_equal_to: ->(form) { form.number_of_options } }, allow_blank: true
 
         def election
           @election ||= context[:election]
@@ -32,6 +34,10 @@ module Decidim
         def editable?
           @editable ||= id.blank? || Decidim::Elections::Question.exists?(id:)
         end
+
+        def number_of_options
+          response_options.size
+        end
       end
     end
   end

data/app/forms/decidim/elections/censuses/internal_users_form.rb

@@ -29,7 +29,7 @@ module Decidim
             [
               adapter,
               Decidim::Verifications::Authorizations.new(
-                organization: organization,
+                organization:,
                 user: current_user,
                 name: adapter.name
               ).first

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

@@ -21,6 +21,7 @@ module Decidim
         @filter_sections ||= begin
           items = [{
             method: :with_any_state,
+            name: "[with_any_state]",
             collection: filter_elections_state_values,
             label: t("decidim.elections.elections.filters.state"),
             id: "date",
@@ -37,9 +38,13 @@ module Decidim
         (defined?(current_component) && translated_attribute(current_component&.name).presence) || t("decidim.components.elections.name")
       end
 
-      def question_title(question, tag = :h3, **options)
-        content_tag(tag, **options) do
-          translated_attribute(question.body)
+      def question_title(question, tag = :h3, **)
+        content_tag(tag, **) do
+          title = translated_attribute(question.body)
+          if question.max_choices.present? && question.question_type == "multiple_option"
+            title += " (#{t("decidim.elections.votes.question.max_choices", count: question.max_choices)})"
+          end
+          title
         end
       end
 

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

@@ -28,6 +28,7 @@ module Decidim
       end
 
       def max_votable_options
+        return max_choices if max_choices.present? && question_type == "multiple_option"
         return response_options.size if question_type == "multiple_option"
 
         1

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

@@ -4,6 +4,7 @@ module Decidim
   module Elections
     class Vote < Elections::ApplicationRecord
       include Decidim::Traceable
+
       belongs_to :question, class_name: "Decidim::Elections::Question", counter_cache: true, inverse_of: :votes
       belongs_to :response_option, class_name: "Decidim::Elections::ResponseOption", counter_cache: true, inverse_of: :votes
 
@@ -31,7 +32,7 @@ module Decidim
 
       def max_votable_options
         return unless question && response_option
-        return if question.votes.where.not(id: id).where(voter_uid: voter_uid).count < question.max_votable_options
+        return if question.votes.where.not(id:).where(voter_uid:).count < question.max_votable_options
 
         errors.add(:response_option, :invalid)
       end

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

@@ -4,6 +4,7 @@ module Decidim
   module Elections
     class Voter < Elections::ApplicationRecord
       include Decidim::Traceable
+
       belongs_to :election, class_name: "Decidim::Elections::Election"
 
       validates :data, presence: true

data/app/packs/entrypoints/decidim_elections.js

@@ -1,5 +1,7 @@
+import "src/decidim/elections/elections.js"
 import "src/decidim/elections/waiting_room.js"
 import "src/decidim/elections/live_results_update.js";
+import "src/decidim/elections/census_check_visibility.js";
 import "src/decidim/elections/question_status_checker.js";
 
 // Images

data/app/packs/entrypoints/decidim_elections_admin.js

@@ -1,6 +1,7 @@
 // JS
 import "src/decidim/elections/admin/election_form.js";
 import "src/decidim/elections/admin/census_form.js";
+import "src/decidim/elections/admin/census_check_toggle.js";
 import "src/decidim/elections/live_results_update.js";
 
 // CSS

data/app/packs/src/decidim/elections/admin/census_check_toggle.js

@@ -0,0 +1,44 @@
+document.addEventListener("turbo:load", () => {
+  const checkbox = document.querySelector(".census-check-toggle");
+
+  if (!checkbox) {
+    return;
+  }
+
+  checkbox.addEventListener("change", () => {
+    const url = checkbox.dataset.url;
+    const checked = checkbox.checked;
+    const csrfToken = document.querySelector("meta[name='csrf-token']");
+
+    if (!csrfToken) {
+      console.error("CSRF token not found. Please refresh the page.");
+      checkbox.checked = !checked;
+      return;
+    }
+
+    fetch(url, {
+      method: "PATCH",
+      headers: {
+        "Content-Type": "application/json",
+        "X-CSRF-Token": csrfToken.content
+      },
+      body: JSON.stringify({
+        // eslint-disable-next-line camelcase
+        allow_census_check_before_start: checked
+      })
+    }).then((response) => {
+      if (!response.ok) {
+        throw new Error(`HTTP error! status: ${response.status}`);
+      }
+      return response.json();
+    }).then((data) => {
+      if (!data.success) {
+        checkbox.checked = !checked;
+        console.error(`Error updating setting: ${data.error || "Unknown error"}`);
+      }
+    }).catch((error) => {
+      checkbox.checked = !checked;
+      console.error(`Error updating setting: ${error.message}`);
+    });
+  });
+});

data/app/packs/src/decidim/elections/census_check_visibility.js

@@ -0,0 +1,52 @@
+document.addEventListener("DOMContentLoaded", () => {
+  const censusCheckButton = document.querySelector("[data-census-check-button]");
+
+  if (!censusCheckButton) {
+    return;
+  }
+
+  const url = censusCheckButton.dataset.censusCheckUrl;
+
+  if (!url) {
+    return;
+  }
+
+  const explanation = document.querySelector("[data-census-check-explanation]");
+
+  const toggleVisibility = (show) => {
+    censusCheckButton.classList.toggle("hidden", !show);
+    if (explanation) {
+      explanation.classList.toggle("hidden", !show);
+    }
+  };
+
+  const updateVisibility = async () => {
+    try {
+      const response = await fetch(url, {
+        method: "GET",
+        headers: {
+          "Accept": "application/json",
+          "Content-Type": "application/json",
+          "X-Requested-With": "XMLHttpRequest"
+        }
+      });
+
+      if (!response.ok) {
+        return;
+      }
+
+      const data = await response.json();
+      const shouldShow = data.allow_census_check_before_start && data.census_ready && data.scheduled;
+
+      toggleVisibility(shouldShow);
+
+      if (data.scheduled) {
+        setTimeout(updateVisibility, 4000);
+      }
+    } catch (error) {
+      setTimeout(updateVisibility, 4000);
+    }
+  };
+
+  updateVisibility();
+});