decidim-elections 0.27.4 → 0.28.0.rc5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86f9af4eb56a517eb85ce45e079ba761c916040de349fb52b878886a3ad5b27c
-  data.tar.gz: '0436869e21f87e86847c41940ffd617cfcfbe6516e86bff3d2d6e2f7b9e6308b'
+  metadata.gz: 8f2c5af649b48958fda0b1f019a10ec4be908097cd003758e3331bd65b1d305b
+  data.tar.gz: dccdb02537d49b0139d60c22d335dd6af3e4bdc7698cf102dcc4527c098b3bdf
 SHA512:
-  metadata.gz: 798f01f86d2c7a1d3232c8e76d6a2fe9289c585265d6f488178f0e1fa71931a7ae49d2f645b4ec42d0b44fd890094908e644315f31c6f8c003ddf618abd09b4a
-  data.tar.gz: b87ebc1509c74e59911917343b529498c3ba163ae35d691e90ff10cfbc337a4d4eca1654f4176033a4bb85c15948515cbe0e0c898975f8e7d14e3eb5522b10fb
+  metadata.gz: bf24d820c12d305690d9a52bd0ebb65dfd9592cb040f40086f987bd9853e37949a044febb4b450a84494c123f899b66b90edf62b7ff0850ac2119a7cdd48f6c5
+  data.tar.gz: 3fea3faaaa7b5599ddba18bfe8586604aa8263ccbd383c2eeb8f4b6bfc42612f45d32b6b536fa99aa0b83728af811fd2a7a74e6e0847ed6fce60710dd08d9b81

data/README.md

@@ -10,6 +10,40 @@ Elections will be available as a Component for a Participatory Space.
 
 In order to celebrate [End-to-end auditable votings](https://en.wikipedia.org/wiki/End-to-end_auditable_voting_systems) using the Elections module, you will need to connect your Decidim instance with an instance of the [Decidim Bulletin Board application](https://github.com/decidim/decidim-bulletin-board/). To create this connection, please check the [instructions](https://docs.decidim.org/en/services/elections_bulletin_board/).
 
+## Development
+
+In the case that you only want to use this module for local development or testing purposes, you have an example docker-compose configuration in `docs/`. Mind that this setup is not recommended for production environments. It works with default seeds and configurations for a Decidim installation, so you should not do anything.
+
+```bash
+cd docs/docker/bulletin_board
+docker-compose up
+```
+
+One important caveat is that as the Trustees' key generation functionality uses the IndexedDB API, and at least in Firefox there is unsupported in the Private Browsing mode (see ticket [#1639542 in Mozilla's Bugzilla](https://bugzilla.mozilla.org/show_bug.cgi?id=1639542)). As a workaround there is the [Firefox Multi-Account Containers addon](https://addons.mozilla.org/es/firefox/addon/multi-account-containers/).
+
+## Testing
+
+Besides the [set-up typical for Decidim](https://docs.decidim.org/en/develop/develop/testing), for some of the specs a Bulletin Board installation is needed, running in port 5017 by default with the `DATABASE_CLEANER_ALLOW_REMOTE_DATABASE_URL` environment variable set up with the "true" string. There is a working configuration on `docs`.
+
+```bash
+cd docs/docker/bulletin_board_test
+docker-compose up
+```
+
+As the Bulletin Board service is a necessary dependency for this module to work, if it is not running while executing the specs, the following exception will be shown.
+
+> Failure/Error: Decidim::Elections.bulletin_board.reset_test_database
+>
+> StandardError:
+> Sorry, something went wrong
+>
+> ./spec/shared/test_bulletin_board_shared_context.rb:6:in 'block (2 levels) in <top (required)>'
+> (...)
+> -- Caused by:
+> Errno::ECONNREFUSED:
+> Connection refused - connect(2) for 127.0.0.1:5017
+> ./spec/shared/test_bulletin_board_shared_context.rb:6:in 'block (2 levels) in <top (required)>'
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -26,17 +60,40 @@ bundle
 
 ## Configuration
 
+### Identification numbers
+
+For the verification of the participants' data in the Voting's census, you can configure which type of documents a participant can have. By default these documents are `identification_number` and `passport`, but in some countries you may need to adapt these to your specifics needs. For instance, in Spain there are `dni`, `nie` and `passport`.
+
+For configuring these you can do so with the Environment Variable `ELECTIONS_DOCUMENT_TYPES`.
+
+```env
+ELECTIONS_DOCUMENT_TYPES="dni,nie,passport"
+```
+
+You need to also add the following keys in your i18n files (i.e. `config/locales/en.yml`).
+
+```yaml
+en:
+  decidim:
+    votings:
+      census:
+        document_types:
+          dni: DNI
+          nie: NIE
+          passport: Passport
+```
+
 ### Scheduled tasks
 
 For the Elections module to function as expected, there are some background tasks that should be scheduled to be executed regularly. Alternatively you could use `whenever` gem or the scheduled jobs of your hosting provider.
 
-You can configure it with `crontab -e`, for instance if you've created your Decidim application on /home/user/decidim_application:
-```
+You can configure it with `crontab -e`, for instance if you have created your Decidim application on /home/user/decidim_application:
+
+```bash
 # Remove census export files
 0 0 * * * cd /home/user/decidim_application && RAILS_ENV=production bundle exec rake decidim_votings_census:delete_census_access_codes_export
 ```
 
-
 ## Contributing
 
 See [Decidim](https://github.com/decidim/decidim).

data/app/cells/decidim/elections/content_blocks/related_elections_cell.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Elections
+    module ContentBlocks
+      class RelatedElectionsCell < Decidim::ContentBlocks::HighlightedElementsWithCellForListCell
+        private
+
+        def list_cell_path = "decidim/elections/highlighted_elections_for_component"
+      end
+    end
+  end
+end

data/app/cells/decidim/elections/election_cell.rb

@@ -3,7 +3,7 @@
 module Decidim
   module Elections
     # This cell renders the election card for an instance of an election
-    # the default size is the Medium Card (:m)
+    # the default size is the Search Card (:s)
     class ElectionCell < Decidim::ViewModel
       include ElectionCellsHelper
       include Cell::ViewModel::Partial
@@ -15,7 +15,12 @@ module Decidim
       private
 
       def card_size
-        "decidim/elections/election_m"
+        case @options[:size]
+        when :s
+          "decidim/elections/election_s"
+        else
+          "decidim/elections/election_g"
+        end
       end
     end
   end

data/app/cells/decidim/elections/election_g_cell.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Elections
+    # This cell renders the Grid (:g) election card
+    # for a given instance of an Election
+    class ElectionGCell < Decidim::CardGCell
+      include ElectionCellsHelper
+
+      def metadata_cell
+        "decidim/elections/election_metadata"
+      end
+
+      def has_image?
+        model.photos.present?
+      end
+
+      def resource_image_path
+        model.photos.first.url if has_image?
+      end
+    end
+  end
+end

data/app/cells/decidim/elections/election_metadata_cell.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Elections
+    # This cell renders metadata for an instance of an Election
+    class ElectionMetadataCell < Decidim::CardMetadataCell
+      def initialize(*)
+        super
+
+        @items.prepend(*election_items)
+      end
+
+      private
+
+      def election_items
+        [dates_metadata_item, state_item]
+      end
+
+      def state_item
+        return if model.voting_period_status.blank?
+
+        { text: content_tag(:span, I18n.t(model.voting_period_status, scope: "decidim.elections.election_m.badge_name"), class: "label #{state_class}") }
+      end
+
+      def state_class
+        case model.voting_period_status
+        when :ongoing
+          "success"
+        when :upcoming
+          "warning"
+        end
+      end
+
+      def start_date
+        return unless model.start_time
+
+        model.start_time.to_date
+      end
+
+      def end_date
+        return unless model.end_time
+
+        model.end_time.to_date
+      end
+
+      def dates_metadata_item
+        {
+          icon: "calendar-todo-line",
+          text: [
+            start_date.present? ? l(start_date, format: :decidim_short_with_month_name_short) : "?",
+            end_date.present? ? l(end_date, format: :decidim_short_with_month_name_short) : "?"
+          ].join(" → ")
+        }
+      end
+    end
+  end
+end

data/app/cells/decidim/elections/election_preview/show.erb

@@ -1,28 +1,28 @@
-<div class="row">
-  <div class="columns large-8">
-    <h3 class="section-heading"><%= t("decidim.elections.elections.preview.title") %></h3>
+<div class="election__section-title">
+  <%= icon "question-mark" %>
+  <h2 class="h4"><%= t("decidim.elections.elections.preview.title") %></h2>
+</div>
 
-    <p><%= t("decidim.elections.elections.preview.description") %></p>
+<p class="election__section-desc"><%= t("decidim.elections.elections.preview.description") %></p>
 
-    <ul class="accordion mb-m evote__preview"
-      data-accordion
-      data-multi-expand="true"
-      data-allow-all-closed="true">
-      <% model.questions.each do |question| %>
-        <li class="accordion-item evote__preview-question <%= " is-active" if model.questions.one? %>" data-accordion-item>
-          <a href="#" class="accordion-title flex--sbc"><%= translated_attribute(question.title) %></a>
+<ul id="accordion-preview" class="space-y-8" data-component="accordion">
+  <% model.questions.each_with_index do |question, ix| %>
+    <li class="election__accordion">
+      <button id="accordion-trigger-<%= ix %>" data-controls="accordion-panel-<%= ix %>" class="election__accordion-trigger" <%= " data-open='true'" if model.questions.one? %>>
+        <%= translated_attribute(question.title) %>
+        <%= icon "arrow-down-s-line" %>
+        <%= icon "arrow-up-s-line" %>
+      </button>
 
-          <div class="accordion-content" data-tab-content>
-            <strong><%= t("decidim.elections.elections.preview.available_answers") %></strong>
+      <div id="accordion-panel-<%= ix %>" class="election__accordion-panel" aria-hidden="true">
+        <strong><%= t("decidim.elections.elections.preview.available_answers") %></strong>
 
-            <ul>
-              <% question.answers.each do |answer| %>
-                <li><%= translated_attribute(answer.title) %></li>
-              <% end %>
-            </ul>
-          </div>
-        </li>
-      <% end %>
-    </ul>
-  </div>
-</div>
+        <ul>
+          <% question.answers.each do |answer| %>
+            <li><%= translated_attribute(answer.title) %></li>
+          <% end %>
+        </ul>
+      </div>
+    </li>
+  <% end %>
+</ul>

data/app/cells/decidim/elections/election_results/progress_bar.erb

@@ -1,16 +1,15 @@
-<div class="progress__bar">
-  <div class="evote__preview-bar">
-    <div class="progress progress__bar__bar" role="progressbar" tabindex="0" aria-valuenow="<%= results_percentage %>%" aria-valuemin="0" aria-valuetext="<%= results_percentage %>% percent" aria-valuemax="100">
-      <div class="progress-meter progress__bar__bar--complete" style="width: <%= results_percentage %>%"></div>
-      <div class="progress__bar__bar--incomplete" style="width:calc(100% - <%= results_percentage %>%);"></div>
+<div>
+  <div class="flex items-center justify-between gap-2">
+    <div class="flex justify-between grow bg-gray" role="progressbar" tabindex="0" aria-labelledby="total-answers-<%= id %>" aria-valuenow="<%= results_percentage %>" aria-valuemin="0" aria-valuetext="<%= results_percentage %> %" aria-valuemax="100">
+      <div class="h-2 bg-success" style="width: <%= results_percentage %>%"></div>
     </div>
 
-    <div class="evote__preview-perc">
+    <div class="w-1/6 md:w-1/12 font-bold text-right">
       <%= t("decidim.elections.elections.results.percentage", count: results_percentage) %>
     </div>
   </div>
 
-  <div class="evote__preview-label">
+  <div id="total-answers-<%= id %>" class="text-sm font-semibold">
     <%= t("decidim.elections.elections.results.votes", count: results_total) %>
   </div>
 </div>

data/app/cells/decidim/elections/election_results/show.erb

@@ -1,40 +1,43 @@
-<div class="row">
-  <div class="columns large-8">
-    <h3 class="section-heading"><%= t("decidim.elections.elections.results.title") %></h3>
+<div class="election__section-title">
+  <%= icon "bar-chart-box-line" %>
+  <h2 class="h4"><%= t("decidim.elections.elections.results.title") %></h2>
+</div>
 
-    <p><%= t("decidim.elections.elections.results.description") %></p>
+<p class="election__section-desc"><%= t("decidim.elections.elections.results.description") %></p>
 
-    <ul class="accordion mb-m evote__preview"
-      data-accordion
-      data-multi-expand="true"
-      data-allow-all-closed="true">
-      <% model.questions.each_with_index do |question, i| %>
-        <li class="accordion-item evote__preview-question <%= " is-active" if i == 0 %>" data-accordion-item>
-          <a href="#" class="accordion-title flex--sbc"><%= translated_attribute(question.title) %></a>
+<ul id="accordion-results" class="space-y-8" data-component="accordion">
+  <% model.questions.each_with_index do |question, ix| %>
+    <li class="election__accordion">
+      <button id="accordion-trigger-<%= ix %>" data-controls="accordion-panel-<%= ix %>" class="election__accordion-trigger" <%= " data-open='true'" if ix.zero? %>>
+        <%= translated_attribute(question.title) %>
+        <%= icon "arrow-down-s-line" %>
+        <%= icon "arrow-up-s-line" %>
+      </button>
 
-          <div class="accordion-content" data-tab-content>
-            <% question.answers.each do |answer| %>
-              <div class="evote__preview-result">
-                <h3 class="evote__preview-option">
-                  <%= translated_attribute(answer.title) %>
+      <div id="accordion-panel-<%= ix %>" class="election__accordion-panel" aria-hidden="true">
+        <% question.answers.each do |answer| %>
+          <div>
+            <p>
+              <%= translated_attribute(answer.title) %>
 
-                  <% if answer.selected? %>
-                    <span class="label label--small label--highlight">
-                      <%= t("decidim.elections.elections.results.selected") %>
-                    </span>
-                  <% end %>
-                </h3>
+              <% if answer.selected? %>
+                <span class="label">
+                  <%= t("decidim.elections.elections.results.selected") %>
+                </span>
+              <% end %>
+            </p>
 
-                <%= render view: :progress_bar, locals: { results_percentage: answer.results_percentage, results_total: answer.results_total } %>
-              </div>
-            <% end %>
+            <%= render view: :progress_bar, locals: { id: answer.id, results_percentage: answer.results_percentage, results_total: answer.results_total } %>
+          </div>
+        <% end %>
 
-            <% if question.results.blank_answers.any? %>
-              <%= render view: :blank_votes, locals: { question: question } %>
-            <% end %>
+        <% if question.results.blank_answers.any? %>
+          <div>
+            <p><%= t("decidim.elections.votes.new.nota_option") %></p>
+            <%= render view: :progress_bar, locals: { id: answer.id, results_percentage: question.blank_votes_percentage, results_total: question.blank_votes } %>
           </div>
-        </li>
-      <% end %>
-    </ul>
-  </div>
-</div>
+        <% end %>
+      </div>
+    </li>
+  <% end %>
+</ul>

data/app/cells/decidim/elections/election_s_cell.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Elections
+    # This cell renders the Search (:s) election card
+    # for a given instance of an Election
+    class ElectionSCell < Decidim::CardSCell
+    end
+  end
+end

data/app/cells/decidim/elections/election_vote_cta/show.erb

@@ -2,34 +2,22 @@
   <%= cell("decidim/announcement", callout_text) %>
 <% end %>
 
-<div>
-  <% if model.ongoing? %>
-    <% if vote_flow.login_path(new_election_vote_path) %>
-      <%= link_to vote_flow.login_path(new_election_vote_path), class: "button button--sc" do %>
-        <%= vote_action_button_text %>
-      <% end %>
-    <% else %>
-      <%= action_authorized_link_to :vote, new_election_vote_path, resource: model, class: "button button--sc" do %>
-        <%= vote_action_button_text %>
-      <% end %>
+<% if model.ongoing? %>
+  <% if vote_flow.login_path(new_election_vote_path) %>
+    <%= link_to vote_flow.login_path(new_election_vote_path), class: "button button__lg button__secondary w-full" do %>
+      <%= vote_action_button_text %>
     <% end %>
-  <% elsif !model.finished? %>
-    <span class="button button--sc disabled"><%= t("action_button.vote", scope: "decidim.elections.elections.show") %></span>
-  <% end %>
-
-  <% if preview_mode? && can_preview? %>
-    <%= link_to new_election_vote_path, class: "button button--sc" do %>
-      <%= t("preview", scope: "decidim.elections.elections.show") %>
+  <% else %>
+    <%= action_authorized_link_to :vote, new_election_vote_path, resource: model, class: "button button__lg button__secondary w-full" do %>
+      <%= vote_action_button_text %>
     <% end %>
   <% end %>
-</div>
-
-<div class="text-sm">
-<% if model.started? %>
-  <%= t("verify.already_voted", scope: "decidim.elections.elections.show") %>
+<% elsif !model.finished? %>
+  <button class="button button__lg button__secondary w-full" disabled><%= t("action_button.vote", scope: "decidim.elections.elections.show") %></button>
+<% end %>
 
-  <%= link_to t("verify.verify_here", scope: "decidim.elections.elections.show"), election_vote_verify_path %>
-<% else %>
-  <span class="disabled"><%= t("verify.will_verify", scope: "decidim.elections.elections.show") %></span>
+<% if preview_mode? && can_preview? %>
+  <%= link_to new_election_vote_path, class: "button button__lg button__secondary w-full mt-4" do %>
+    <%= t("preview", scope: "decidim.elections.elections.show") %>
+  <% end %>
 <% end %>
-</div>

data/app/cells/decidim/elections/election_vote_cta_cell.rb

@@ -41,15 +41,6 @@ module Decidim
         end
       end
 
-      def election_vote_verify_path
-        engine_router.election_vote_verify_path(
-          "#{key_participatory_space_slug}": current_participatory_space.slug,
-          component_id: current_component.id,
-          election_id: model.id,
-          vote_id: "_"
-        )
-      end
-
       def callout_text
         if last_vote_pending?
           t("callout.pending_vote", scope: "decidim.elections.elections.show")

data/app/cells/decidim/elections/highlighted_elections_for_component/show.erb

@@ -0,0 +1,18 @@
+<div class="content-block__title">
+  <h2 class="h2 decorator">
+    <%= single_component? ? translated_attribute(model.name) : t("decidim.components.elections.name") %>
+  </h2>
+  <div class="label text-lg"><%= elections_count %></div>
+  <% if see_all_path.present? %>
+    <%= link_to see_all_path, class: "button button__sm button__text-secondary" do %>
+      <span><%= t("decidim.participatory_spaces.related_elections.see_all") %></span>
+      <%= icon "arrow-right-line" %>
+    <% end %>
+  <% end %>
+</div>
+
+<div class="participatory-space__block-grid">
+  <% elections.each do |election| %>
+    <%= card_for(election, link_whole_card: true, title_tag: :h3, **options.slice(:show_space)) %>
+  <% end %>
+</div>

data/app/cells/decidim/elections/highlighted_elections_for_component_cell.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "cell/partial"
+
+module Decidim
+  module Elections
+    # This cell renders the highlighted elections for a given participatory
+    # space. It is intended to be used in the `participatory_space_highlighted_elements`
+    # view hook.
+    class HighlightedElectionsForComponentCell < Decidim::ViewModel
+      include ElectionCellsHelper
+      include Decidim::ComponentPathHelper
+      include Decidim::CardHelper
+
+      def show
+        render unless items_blank?
+      end
+
+      def items_blank?
+        elections_count.zero?
+      end
+
+      private
+
+      def elections_count
+        @elections_count ||= elections.size
+      end
+
+      def elections
+        @elections ||= Decidim::Elections::Election.where(component: model).published
+      end
+
+      def single_component?
+        @single_component ||= model.is_a?(Decidim::Component)
+      end
+
+      def see_all_path
+        @see_all_path ||= options[:see_all_path] || (single_component? && main_component_path(model))
+      end
+
+      def cache_hash
+        hash = []
+        hash << "decidim/elections/highlighted_elections_for_component"
+        hash << elections.cache_key_with_version
+        hash << I18n.locale.to_s
+        hash.join(Decidim.cache_key_separator)
+      end
+    end
+  end
+end

data/app/cells/decidim/elections/remaining_time_callout/show.erb

@@ -1,5 +1,3 @@
 <% if needs_to_show_remaining_time? %>
-  <div class="callout secondary">
-    <%= remaining_time %>
-  </div>
+  <%= cell("decidim/announcement", remaining_time) %>
 <% end %>

data/app/cells/decidim/elections/voting_step_navigation/show.erb

@@ -1,29 +1,25 @@
-<div class="focus__footer">
-  <div class="row">
-    <% if first_step? %>
-      <a></a>
-    <% else %>
-      <%= link_to(
-        icon("chevron-left", class: "icon", role: "img", "aria-hidden": true) + " " + t("decidim.elections.votes.voting_step.back"),
-        "#",
-        class: "focus__back",
-        data: {
-          toggle: [previous_step_dom_id, current_step_dom_id].join(" ")
-        }
-      ) %>
-    <% end %>
-
-    <span class="button focus__next disabled-continue disabled">
-      <%= button_continue_text %>
-    </span>
-
-    <%= link_to(
-      button_continue_text,
-      "#",
-      class: "button focus__next enabled-continue",
+<div class="form__wrapper-block flex-col-reverse md:flex-row justify-between">
+  <% unless first_step? %>
+    <%= button_tag(
+      t("decidim.elections.votes.voting_step.back"),
+      type: "button",
+      id: "back-#{current_step_index}",
+      class: "button button__sm md:button__lg button__transparent-secondary",
       data: {
-        toggle: [next_step_dom_id, current_step_dom_id].join(" ")
+        toggle: [previous_step_dom_id, current_step_dom_id].join(" ")
       }
     ) %>
-  </div>
+  <% end %>
+
+  <%= button_tag(
+    class: "button button__sm md:button__lg button__secondary",
+    type: "button",
+    id: "next-#{current_step_index}",
+    data: {
+      toggle: [next_step_dom_id, current_step_dom_id].join(" ")
+    }
+  ) do %>
+    <span><%= button_continue_text %></span>
+    <%= icon "arrow-right-line" %>
+  <% end %>
 </div>

data/app/cells/decidim/elections/voting_step_navigation_cell.rb

@@ -23,7 +23,7 @@ module Decidim
       end
 
       def button_continue_text
-        "#{t("decidim.elections.votes.voting_step.continue")}  #{icon("chevron-right", class: "icon", role: "img", "aria-hidden": true)}"
+        t("decidim.elections.votes.voting_step.continue")
       end
 
       def previous_step_dom_id
@@ -31,7 +31,7 @@ module Decidim
       end
 
       def next_step_dom_id
-        "step-#{current_step_index + 1}"
+        last_step? ? "step-confirm" : "step-#{current_step_index + 1}"
       end
 
       def current_step_dom_id

data/app/cells/decidim/votings/content_block_cell.rb

@@ -6,7 +6,11 @@ module Decidim
       delegate :scoped_resource, to: :controller
 
       def edit_content_block_path
-        decidim_votings.edit_voting_landing_page_content_block_path(scoped_resource, manifest_name)
+        decidim_votings.edit_voting_landing_page_content_block_path(scoped_resource, model)
+      end
+
+      def content_block_path
+        decidim_votings.voting_landing_page_content_block_path(scoped_resource, model)
       end
 
       def decidim_votings