decidim-elections 0.28.5 → 0.31.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 285c44851b31f386e25cc97ac7b942246272056bed068a68400a8dd6cc54b85e
-  data.tar.gz: b7377231ab56b066fdad040db6947c1a3a12c78597f3dba76c83356a42b2678d
+  metadata.gz: 964c1cb8bdbc697caa2249a77c682922a0f86c40991fdb82764a87aab5571e5d
+  data.tar.gz: 3c70711e52d4da42332d93dc788169af7da4c7c8881fe00745a9510320a8a590
 SHA512:
-  metadata.gz: e9273ef5f82a5a0c44c1fe2a84250a5d917a26d16cb1a5cc77d0ea2710b6e61d7385a50071f96b94422c2008b2d9e1de292a75c417ee6b06daf4abc6324e9382
-  data.tar.gz: de2d28dee365b2fb496c57c8625e1305922b23a0b979c62c7153d7cecd409a9e5a7130adc1ae3a17bc2dcad56ca8a022690f2c983e1a2af912661004f34b03b2
+  metadata.gz: 10695624537f8c405989c17ded7f678af45980ee351bacf122e642a8bcad349927be80af7beb03908d363c9652b946722c2314e8419d35797dd45e7bedf1809d
+  data.tar.gz: ee3232a438080cc45f64b6c563f5121d8495812f9cad611fde725429ac8a67e7a239edace584bce7fc03c3ad26a552b37b1f91b7cdd8afbb1984dbac5db8bee9

data/README.md

@@ -1,97 +1,15 @@
 # Decidim::Elections
 
-:warning: This module is under development and is not ready to be used in production.
-
-The Elections module adds elections to any participatory space.
-
-## Usage
-
-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)>'
+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.
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem "decidim-elections"
-```
-
-And then execute:
-
-```bash
-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.
+In order to install use this module, you need at least Decidim 0.31 to be installed.
 
-You can configure it with `crontab -e`, for instance if you have created your Decidim application on /home/user/decidim_application:
+To install this module, run in your console:
 
 ```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
+bundle add decidim-elections
 ```
 
 ## Contributing

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Elections
+    # This cell renders metadata for an instance of a Meeting
+    class ElectionCardMetadataCell < Decidim::CardMetadataCell
+      include Decidim::LayoutHelper
+      include ActionView::Helpers::DateHelper
+
+      alias election model
+
+      delegate :start_at, :end_at, to: :election
+
+      def initialize(*)
+        super
+
+        @items.prepend(*election_items)
+      end
+
+      def election_items
+        [label, progress_item]
+      end
+
+      def label
+        {
+          text: content_tag("span", t(election.status, scope: "decidim.elections.status"), class: "#{election.status} label")
+        }
+      end
+
+      def current_date
+        @current_date ||= Time.current.to_time
+      end
+
+      def start_date
+        return if start_at.blank?
+
+        @start_date ||= start_at.to_time
+      end
+
+      def end_date
+        return if end_at.blank?
+
+        @end_date ||= end_at.to_time
+      end
+
+      def progress_text
+        if election.published_results? && election.finished?
+          return t("published_results", scope: "decidim.metadata.progress",
+                                        end_date: l(election.results_at.to_time, format: :decidim_short))
+        end
+
+        super
+      end
+    end
+  end
+end

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

@@ -2,10 +2,7 @@
 
 module Decidim
   module Elections
-    # This cell renders the election card for an instance of an election
-    # the default size is the Search Card (:s)
     class ElectionCell < Decidim::ViewModel
-      include ElectionCellsHelper
       include Cell::ViewModel::Partial
 
       def show
@@ -18,8 +15,10 @@ module Decidim
         case @options[:size]
         when :s
           "decidim/elections/election_s"
-        else
+        when :g
           "decidim/elections/election_g"
+        else
+          "decidim/elections/election_l"
         end
       end
     end

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

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

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "cell/partial"
+
+module Decidim
+  module Elections
+    # This cell renders the Search (:s) election card
+    # for a given instance of an Election
+    class ElectionLCell < Decidim::CardLCell
+      delegate :photo, to: :model
+
+      private
+
+      def has_description?
+        true
+      end
+
+      def title
+        present(model).title(html_escape: true)
+      end
+
+      def description
+        text = translated_attribute(model.description)
+
+        decidim_sanitize(html_truncate(text, length: 240), strip_tags: true)
+      end
+
+      def metadata_cell
+        "decidim/elections/election_card_metadata"
+      end
+
+      def resource_image_url
+        return if photo.blank?
+
+        photo.url
+      end
+    end
+  end
+end

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

@@ -1,10 +1,21 @@
 # frozen_string_literal: true
 
+require "cell/partial"
+
 module Decidim
   module Elections
     # This cell renders the Search (:s) election card
     # for a given instance of an Election
     class ElectionSCell < Decidim::CardSCell
+      private
+
+      def title
+        present(model).title(html_escape: true)
+      end
+
+      def metadata_cell
+        "decidim/elections/election_card_metadata"
+      end
     end
   end
 end

data/app/commands/decidim/elections/admin/censuses/token_csv.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Elections
+    module Admin
+      module Censuses
+        # A command with the business logic to create census data for an
+        # election.
+        class TokenCsv < Decidim::Command
+          def initialize(form, election)
+            @form = form
+            @election = election
+          end
+
+          # Executes the command. Broadcast these events:
+          # - :ok when everything is valid
+          # - :invalid when the form was not valid and could not proceed-
+          #
+          # Returns nothing.
+          def call
+            return broadcast(:invalid) if @form.invalid?
+            return broadcast(:invalid) if @form.remove_all && @election.census.blank?
+
+            # If the form is set to remove all, we just delete all voters
+            if @form.remove_all
+              @election.voters.delete_all
+              return broadcast(:ok)
+            end
+            return broadcast(:invalid) unless @form.file
+
+            rows = @form.data
+            return broadcast(:invalid) if rows.blank?
+
+            Voter.bulk_insert(@election, rows.map { |row| { email: row.first.downcase, token: row.second } })
+            broadcast(:ok)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -3,56 +3,45 @@
 module Decidim
   module Elections
     module Admin
-      # This command is executed when the user creates an Election
-      # from the admin panel.
-      class CreateElection < Decidim::Command
+      class CreateElection < Decidim::Commands::CreateResource
         include ::Decidim::GalleryMethods
 
-        def initialize(form)
-          @form = form
-        end
+        fetch_form_attributes :title, :description, :start_at, :end_at, :results_availability
+
+        protected
+
+        attr_reader :gallery
 
-        # Creates the election if valid.
-        #
-        # Broadcasts :ok if successful, :invalid otherwise.
-        def call
-          return broadcast(:invalid) if form.invalid?
+        def resource_class = Decidim::Elections::Election
 
-          if process_gallery?
-            build_gallery
-            return broadcast(:invalid) if gallery_invalid?
-          end
+        def extra_params
+          { visibility: "all" }
+        end
 
-          transaction do
-            create_election!
-            create_gallery if process_gallery?
-          end
+        def attributes
+          parsed_title = Decidim::ContentProcessor.parse(form.title, current_organization: form.current_organization).rewrite
+          parsed_description = Decidim::ContentProcessor.parse_with_processor(:inline_images, form.description, current_organization: form.current_organization).rewrite
+
+          super.merge({
+                        component: form.current_component,
+                        title: parsed_title,
+                        description: parsed_description,
+                        start_at: form.manual_start ? nil : form.start_at,
+                        end_at: form.end_at,
+                        results_availability: form.results_availability
+                      })
+        end
 
-          broadcast(:ok, election)
+        def run_after_hooks
+          @attached_to = resource
+          create_gallery if process_gallery?
         end
 
-        private
-
-        attr_reader :form, :election, :gallery
-
-        def create_election!
-          attributes = {
-            title: form.title,
-            description: form.description,
-            start_time: form.start_time,
-            end_time: form.end_time,
-            component: form.current_component,
-            questionnaire: Decidim::Forms::Questionnaire.new,
-            salt: Tokenizer.random_salt
-          }
-
-          @election = Decidim.traceability.create!(
-            Election,
-            form.current_user,
-            attributes,
-            visibility: "all"
-          )
-          @attached_to = @election
+        def run_before_hooks
+          return unless process_gallery?
+
+          build_gallery
+          raise Decidim::Commands::HookError if gallery_invalid?
         end
       end
     end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Elections
+    module Admin
+      # A command with the business logic to create census data for an
+      # election.
+      class ProcessCensus < Decidim::Commands::UpdateResource
+        def attributes
+          {
+            census_manifest: resource.census.name,
+            census_settings: census_settings
+          }
+        end
+
+        # This will run any post-processing hooks defined in the census manifest
+        def run_after_hooks
+          command = resource.census.after_update_command&.safe_constantize
+          return unless command
+
+          command.call(form, resource)
+        end
+
+        def census_settings
+          return {} unless form.respond_to?(:census_settings)
+
+          form.census_settings
+        end
+      end
+    end
+  end
+end

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

@@ -3,23 +3,28 @@
 module Decidim
   module Elections
     module Admin
-      # This command gets called when an election is published from the admin panel.
       class PublishElection < Decidim::Command
-        # Public: Initializes the command.
+        # A command to publish an election.
         #
-        # election - The election to publish.
-        # current_user - the user performing the action
+        #  election - Decidim::Elections::Election
+        # Current_user - the user performing the action
         def initialize(election, current_user)
           @election = election
           @current_user = current_user
         end
 
-        # Public: Publishes the Election.
+        # Executes the command. Broadcasts these events:
         #
-        # Broadcasts :ok if published, :invalid otherwise.
+        # - :ok when everything is valid.
+        # - :invalid if the form was not valid and we could not proceed.
+        #
+        # Returns nothing.
         def call
-          publish_election
-          publish_event unless election.previously_published?
+          return broadcast(:invalid) if election.published?
+
+          transaction do
+            publish_election
+          end
 
           broadcast(:ok, election)
         end
@@ -29,7 +34,7 @@ module Decidim
         attr_reader :election, :current_user
 
         def publish_election
-          Decidim.traceability.perform_action!(
+          @election = Decidim.traceability.perform_action!(
             :publish,
             election,
             current_user,
@@ -39,15 +44,6 @@ module Decidim
             election
           end
         end
-
-        def publish_event
-          Decidim::EventsManager.publish(
-            event: "decidim.events.elections.election_published",
-            event_class: ::Decidim::Elections::ElectionPublishedEvent,
-            resource: election,
-            followers: election.participatory_space.followers
-          )
-        end
       end
     end
   end

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

@@ -3,40 +3,42 @@
 module Decidim
   module Elections
     module Admin
-      # This command gets called when an election is unpublished from the admin panel.
+      # A command with all the business logic that unpublishes an
+      # existing election.
       class UnpublishElection < Decidim::Command
-        # Public: Initializes the command.
+        # Public: initializes the command.
         #
-        # election - The election to unpublish.
+        # election - Decidim::Elections::Election
         # current_user - the user performing the action
         def initialize(election, current_user)
           @election = election
           @current_user = current_user
         end
 
-        # Public: Unpublishes the Election.
+        # Executes the command. Broadcasts these events:
         #
-        # Broadcasts :ok if unpublished, :invalid otherwise.
+        # - :ok when everything is valid.
+        # - :invalid if the form was not valid and we could not proceed.
+        #
+        # Returns nothing.
         def call
-          unpublish_election
-
-          broadcast(:ok)
-        end
+          return broadcast(:invalid) unless election.published?
 
-        private
-
-        attr_reader :election, :current_user
-
-        def unpublish_election
-          Decidim.traceability.perform_action!(
+          @election = Decidim.traceability.perform_action!(
             :unpublish,
             election,
-            current_user
+            current_user,
+            visibility: "all"
           ) do
             election.unpublish!
             election
           end
+          broadcast(:ok, election)
         end
+
+        private
+
+        attr_reader :election, :current_user
       end
     end
   end

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

@@ -3,55 +3,55 @@
 module Decidim
   module Elections
     module Admin
-      # This command is executed when the user updates an Election
-      # from the admin panel.
-      class UpdateElection < Decidim::Command
+      class UpdateElection < Decidim::Commands::UpdateResource
         include ::Decidim::GalleryMethods
+        fetch_form_attributes :title, :description, :start_at, :end_at, :results_availability
 
         def initialize(form, election)
-          @form = form
-          @election = election
+          super
           @attached_to = election
         end
 
-        # Updates the election if valid.
-        #
-        # Broadcasts :ok if successful, :invalid otherwise.
-        def call
-          return broadcast(:invalid) if form.invalid?
+        private
 
-          if process_gallery?
-            build_gallery
-            return broadcast(:invalid) if gallery_invalid?
-          end
+        alias election resource
 
-          transaction do
-            update_election!
-            create_gallery if process_gallery?
-            photo_cleanup!
-          end
+        def attributes
+          election.published? ? published_election_attributes : unpublished_election_attributes
+        end
 
-          broadcast(:ok, election)
+        def published_election_attributes
+          { description: parsed_description }
         end
 
-        private
+        def unpublished_election_attributes
+          {
+            title: parsed_title,
+            description: parsed_description,
+            start_at: form.manual_start ? nil : form.start_at,
+            end_at: form.end_at,
+            results_availability: form.results_availability
+          }
+        end
 
-        attr_reader :form, :election, :gallery
+        def parsed_title
+          Decidim::ContentProcessor.parse(form.title, current_organization: form.current_organization).rewrite
+        end
 
-        def update_election!
-          attributes = {
-            title: form.title,
-            description: form.description,
-            start_time: form.start_time,
-            end_time: form.end_time
-          }
+        def parsed_description
+          Decidim::ContentProcessor.parse(form.description, current_organization: form.current_organization).rewrite
+        end
+
+        def run_after_hooks
+          create_gallery if process_gallery?
+          photo_cleanup!
+        end
+
+        def run_before_hooks
+          return unless process_gallery?
 
-          Decidim.traceability.update!(
-            election,
-            form.current_user,
-            attributes,
-            visibility: "all"
-          )
+          build_gallery
+          raise Decidim::Commands::HookError if gallery_invalid?
         end
       end
     end