decidim-elections 0.23.6 → 0.24.0.rc1

data/lib/decidim/elections/test/factories.rb

@@ -1,21 +1,38 @@
 # frozen_string_literal: true
 
 require "decidim/core/test/factories"
+require "decidim/forms/test/factories"
 
 FactoryBot.define do
+  sequence(:private_key) do
+    JWT::JWK.new(OpenSSL::PKey::RSA.new(4096))
+  end
+
   factory :elections_component, parent: :component do
     name { Decidim::Components::Namer.new(participatory_space.organization.available_locales, :elections).i18n_name }
     manifest_name { :elections }
-    participatory_space { create(:participatory_process, :with_steps) }
+    participatory_space { create(:participatory_process, :with_steps, organization: organization) }
   end
 
   factory :election, class: "Decidim::Elections::Election" do
+    transient do
+      organization { build(:organization) }
+    end
+
     upcoming
     title { generate_localized_title }
     description { Decidim::Faker::Localized.wrapped("<p>", "</p>") { generate_localized_title } }
     end_time { 3.days.from_now }
     published_at { nil }
-    component { create(:elections_component) }
+    blocked_at { nil }
+    bb_status { nil }
+    questionnaire
+    component { create(:elections_component, organization: organization) }
+
+    trait :bb_test do
+      bb_status { "key_ceremony" }
+      id { (10_000 + Decidim::Elections::Election.bb_statuses.keys.index(bb_status)) }
+    end
 
     trait :upcoming do
       start_time { 1.day.from_now }
@@ -32,6 +49,7 @@ FactoryBot.define do
     trait :finished do
       started
       end_time { 1.day.ago }
+      blocked_at { Time.current }
     end
 
     trait :published do
@@ -46,6 +64,97 @@ FactoryBot.define do
         election.questions << build(:question, :nota, election: election, weight: 4)
       end
     end
+
+    trait :ready_for_setup do
+      transient do
+        trustee_keys { 2.times.map { [Faker::Name.name, generate(:private_key).export.to_json] }.to_h }
+      end
+
+      upcoming
+      published
+      complete
+
+      after(:create) do |election, evaluator|
+        evaluator.trustee_keys.each do |name, key|
+          create(:trustee, :with_public_key, name: name, election: election, public_key: key)
+        end
+      end
+    end
+
+    trait :created do
+      ready_for_setup
+      blocked_at { start_time - 1.day }
+
+      start_time { 1.hour.from_now }
+      bb_status { "created" }
+
+      after(:create) do |election|
+        trustees_participatory_spaces = Decidim::Elections::TrusteesParticipatorySpace.where(participatory_space: election.component.participatory_space)
+        election.trustees << trustees_participatory_spaces.map(&:trustee)
+      end
+    end
+
+    trait :key_ceremony do
+      created
+      bb_status { "key_ceremony" }
+    end
+
+    trait :key_ceremony_ended do
+      key_ceremony
+      bb_status { "key_ceremony_ended" }
+    end
+
+    trait :vote do
+      key_ceremony_ended
+      ongoing
+      bb_status { "vote" }
+    end
+
+    trait :vote_ended do
+      key_ceremony_ended
+      ongoing
+      finished
+      bb_status { "vote_ended" }
+
+      after(:build) do |election|
+        election.questions.each do |question|
+          question.answers.each do |answer|
+            answer.votes_count = Faker::Number.number(digits: 1)
+          end
+        end
+      end
+    end
+
+    trait :tally do
+      vote_ended
+      bb_status { "tally" }
+    end
+
+    trait :tally_ended do
+      tally
+      bb_status { "tally_ended" }
+    end
+
+    trait :results_published do
+      tally_ended
+      bb_status { "results_published" }
+    end
+
+    trait :with_photos do
+      transient do
+        photos_number { 2 }
+      end
+
+      after :create do |election, evaluator|
+        evaluator.photos_number.times do
+          election.attachments << create(
+            :attachment,
+            :with_image,
+            attached_to: election
+          )
+        end
+      end
+    end
   end
 
   factory :question, class: "Decidim::Elections::Question" do
@@ -59,7 +168,7 @@ FactoryBot.define do
     description { Decidim::Faker::Localized.wrapped("<p>", "</p>") { generate_localized_title } }
     min_selections { 1 }
     max_selections { 1 }
-    weight { Faker::Number.number(1) }
+    weight { Faker::Number.number(digits: 1) }
     random_answers_order { true }
 
     trait :complete do
@@ -94,12 +203,100 @@ FactoryBot.define do
       answers { 8 }
       min_selections { 0 }
     end
+
+    trait :with_votes do
+      after(:build) do |question, evaluator|
+        overrides = { question: question }
+        overrides[:description] = nil unless evaluator.more_information
+        question.answers = build_list(:election_answer, evaluator.answers, :with_votes, overrides)
+      end
+    end
   end
 
   factory :election_answer, class: "Decidim::Elections::Answer" do
     question
     title { generate_localized_title }
     description { Decidim::Faker::Localized.wrapped("<p>", "</p>") { generate_localized_title } }
-    weight { Faker::Number.number(1) }
+    weight { Faker::Number.number(digits: 1) }
+    selected { false }
+    votes_count { 0 }
+
+    trait :with_votes do
+      votes_count { Faker::Number.number(digits: 1) }
+    end
+
+    trait :with_photos do
+      transient do
+        photos_number { 2 }
+      end
+
+      after :create do |election, evaluator|
+        evaluator.photos_number.times do
+          election.attachments << create(
+            :attachment,
+            :with_image,
+            attached_to: election
+          )
+        end
+      end
+    end
+  end
+
+  factory :action, class: "Decidim::Elections::Action" do
+    election
+    message_id { "a.message+id" }
+    status { :pending }
+    action { :start_key_ceremony }
+  end
+
+  factory :trustee, class: "Decidim::Elections::Trustee" do
+    transient do
+      election { nil }
+      organization { election&.component&.participatory_space&.organization || create(:organization) }
+    end
+
+    public_key { nil }
+    user { build(:user, organization: organization) }
+
+    trait :considered do
+      after(:build) do |trustee, evaluator|
+        trustee.trustees_participatory_spaces << build(:trustees_participatory_space, trustee: trustee, election: evaluator.election, organization: evaluator.organization)
+      end
+    end
+
+    trait :with_elections do
+      after(:build) do |trustee, evaluator|
+        trustee.elections << build(:election, :upcoming, organization: evaluator.organization)
+      end
+    end
+
+    trait :with_public_key do
+      considered
+      name { Faker::Name.name }
+      public_key { generate(:private_key).export.to_json }
+    end
+  end
+
+  factory :trustees_participatory_space, class: "Decidim::Elections::TrusteesParticipatorySpace" do
+    transient do
+      organization { election&.component&.participatory_space&.organization || create(:organization) }
+      election { nil }
+    end
+    participatory_space { election&.component&.participatory_space || create(:participatory_process, organization: organization) }
+    considered { true }
+    trustee { create(:trustee, organization: organization) }
+
+    trait :trustee_ready do
+      association :trustee, :with_public_key
+    end
+  end
+
+  factory :vote, class: "Decidim::Elections::Vote" do
+    election { create(:election) }
+    sequence(:voter_id) { |n| "voter_#{n}" }
+    encrypted_vote_hash { "adf89asd0f89das7f" }
+    status { "pending" }
+    message_id { "decidim-test-authority.2.vote.cast+v.5826de088371d1b15b38f00c8203871caec07041ed0c8fb0c6fb875f0df763b6" }
+    user { build(:user) }
   end
 end

data/lib/decidim/elections/trustee_zone.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Elections
+    # This module contains all the domain logic associated to Decidim's Elections
+    # trustee zone.
+    module TrusteeZone
+    end
+  end
+end

data/lib/decidim/elections/trustee_zone_engine.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Elections
+    # This is the engine that runs on the public interface for trustees of `decidim-elections`.
+    # It mostly handles rendering the trustees frontend zone.
+    class TrusteeZoneEngine < ::Rails::Engine
+      isolate_namespace Decidim::Elections::TrusteeZone
+
+      paths["db/migrate"] = nil
+      paths["lib/tasks"] = nil
+
+      routes do
+        resource :trustee, path: "/", only: [:show, :update] do
+          resources :election, only: [] do
+            resource :elections, only: [:show, :update]
+          end
+        end
+      end
+
+      def load_seed
+        nil
+      end
+
+      initializer "decidim_elections.trustee_zone.menu" do
+        Decidim.menu :user_menu do |menu|
+          menu.item I18n.t("menu.trustee_zone", scope: "decidim.elections.trustee_zone"),
+                    decidim.decidim_elections_trustee_zone_path,
+                    active: :inclusive,
+                    if: Decidim::Elections::Trustee.trustee?(current_user)
+        end
+      end
+    end
+  end
+end

data/lib/decidim/elections/version.rb

@@ -4,7 +4,7 @@ module Decidim
   # This holds the decidim-meetings version.
   module Elections
     def self.version
-      "0.23.6"
+      "0.24.0.rc1"
     end
   end
 end

data/lib/decidim/elections.rb

@@ -1,18 +1,35 @@
 # frozen_string_literal: true
 
 require "decidim/elections/admin"
+require "decidim/elections/api"
+require "decidim/elections/trustee_zone"
 require "decidim/elections/engine"
 require "decidim/elections/admin_engine"
+require "decidim/elections/trustee_zone_engine"
 require "decidim/elections/component"
+require "decidim/bulletin_board"
+require "decidim/votings"
 
 module Decidim
   # This namespace holds the logic of the `Elections` component. This component
   # allows users to create elections in a participatory space.
   module Elections
-    autoload :BulletinBoardClient, "decidim/elections/bulletin_board_client"
+    autoload :AnswerSerializer, "decidim/elections/answer_serializer"
+
+    include ActiveSupport::Configurable
 
     def self.bulletin_board
-      @bulletin_board ||= BulletinBoardClient.new(Rails.application.secrets.bulletin_board || {})
+      @bulletin_board ||= Decidim::BulletinBoard::Client.new
+    end
+
+    # Public Setting that defines how many hours should the setup be run before the election starts
+    config_accessor :setup_minimum_hours_before_start do
+      3
+    end
+
+    # Public Setting that defines how many hours the ballot box can be opened before the election starts
+    config_accessor :start_vote_maximum_hours_before_start do
+      6
     end
   end
 end

data/lib/decidim/votings/admin.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Votings
+    # This module contains all the domain logic associated to Decidim's Votings
+    # space admin panel.
+    module Admin
+    end
+  end
+end

data/lib/decidim/votings/admin_engine.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Votings
+    # Decidim's Votings Rails Admin Engine.
+    class AdminEngine < ::Rails::Engine
+      isolate_namespace Decidim::Votings::Admin
+
+      paths["db/migrate"] = nil
+      paths["lib/tasks"] = nil
+
+      routes do
+        resources :votings, param: :slug do
+          member do
+            put :publish
+            put :unpublish
+            get :available_polling_officers
+            get :polling_officers_picker
+          end
+
+          resource :landing_page, only: [:edit, :update], controller: "votings_landing_page" do
+            resources :content_blocks, only: [:edit, :update], controller: "votings_landing_page_content_blocks"
+          end
+
+          resources :polling_stations
+          resources :polling_officers, only: [:new, :create, :destroy, :index]
+          resources :monitoring_committee_members, only: [:new, :create, :destroy, :index]
+          resources :attachments, controller: "voting_attachments"
+          resources :attachment_collections, controller: "voting_attachment_collections"
+        end
+
+        scope "/votings/:voting_slug" do
+          resources :components do
+            resource :permissions, controller: "component_permissions"
+            member do
+              put :publish
+              put :unpublish
+              get :share
+            end
+            resources :exports, only: :create
+          end
+        end
+
+        scope "/votings/:voting_slug/components/:component_id/manage" do
+          Decidim.component_manifests.each do |manifest|
+            next unless manifest.admin_engine
+
+            constraints CurrentComponent.new(manifest) do
+              mount manifest.admin_engine, at: "/", as: "decidim_admin_voting_#{manifest.name}"
+            end
+          end
+        end
+      end
+
+      initializer "decidim_votings.admin_menu" do
+        Decidim.menu :admin_menu do |menu|
+          menu.item I18n.t("menu.votings", scope: "decidim.votings.admin"),
+                    decidim_admin_votings.votings_path,
+                    icon_name: "comment-square",
+                    position: 2.6,
+                    active: :inclusive,
+                    if: allowed_to?(:enter, :space_area, space_name: :votings)
+        end
+      end
+
+      initializer "decidim_votings.admin_assets" do |app|
+        app.config.assets.precompile += %w(admin/decidim_votings_manifest.js admin/decidim_votings_manifest.css)
+      end
+    end
+  end
+end

data/lib/decidim/votings/api.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Votings
+    autoload :VotingType, "decidim/api/voting_type"
+  end
+end

data/lib/decidim/votings/engine.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+require "decidim/votings/query_extensions"
+
+module Decidim
+  module Votings
+    # This is the engine that runs on the public interface for Votings of `decidim-elections`.
+    class Engine < ::Rails::Engine
+      isolate_namespace Decidim::Votings
+
+      paths["db/migrate"] = nil
+      paths["lib/tasks"] = nil
+
+      routes do
+        resources :votings, param: :slug, only: [:index, :show, :update]
+
+        get "votings/:voting_id", to: redirect { |params, _request|
+          voting = Decidim::Votings::Voting.find(params[:voting_id])
+          voting ? "/votings/#{voting.slug}" : "/404"
+        }, constraints: { voting_id: /[0-9]+/ }
+
+        get "/votings/:voting_id/f/:component_id", to: redirect { |params, _request|
+          voting = Decidim::Votings::Voting.find(params[:voting_id])
+          voting ? "/votings/#{voting.slug}/f/#{params[:component_id]}" : "/404"
+        }, constraints: { voting_id: /[0-9]+/ }
+
+        scope "/votings/:voting_slug/f/:component_id" do
+          Decidim.component_manifests.each do |manifest|
+            next unless manifest.engine
+
+            constraints CurrentComponent.new(manifest) do
+              mount manifest.engine, at: "/", as: "decidim_voting_#{manifest.name}"
+            end
+          end
+        end
+      end
+
+      initializer "decidim_votings.assets" do |app|
+        app.config.assets.precompile += %w(
+          decidim_votings_manifest.js
+          decidim_votings_manifest.css
+        )
+      end
+
+      initializer "decidim.stats" do
+        Decidim.stats.register :votings_count, priority: StatsRegistry::HIGH_PRIORITY do |organization, _start_at, _end_at|
+          Decidim::Votings::Voting.where(organization: organization).published.count
+        end
+      end
+
+      initializer "decidim_votings.add_cells_view_paths" do
+        Cell::ViewModel.view_paths << File.expand_path("#{Decidim::Votings::Engine.root}/app/cells")
+        Cell::ViewModel.view_paths << File.expand_path("#{Decidim::Votings::Engine.root}/app/views") # for partials
+      end
+
+      initializer "decidim_votings.menu" do
+        Decidim.menu :menu do |menu|
+          menu.item I18n.t("menu.votings", scope: "decidim"),
+                    decidim_votings.votings_path,
+                    position: 2.6,
+                    if: Decidim::Votings::Voting.where(organization: current_organization).published.any?,
+                    active: :inclusive
+        end
+      end
+
+      initializer "decidim_votings.content_blocks" do
+        Decidim.content_blocks.register(:homepage, :highlighted_votings) do |content_block|
+          content_block.cell = "decidim/votings/content_blocks/highlighted_votings"
+          content_block.public_name_key = "decidim.votings.content_blocks.highlighted_votings.name"
+          content_block.settings_form_cell = "decidim/votings/content_blocks/highlighted_votings_settings_form"
+
+          content_block.settings do |settings|
+            settings.attribute :max_results, type: :integer, default: 4
+          end
+        end
+
+        Decidim.content_blocks.register(:voting_landing_page, :header) do |content_block|
+          content_block.cell = "decidim/votings/content_blocks/landing_page/header"
+          content_block.public_name_key = "decidim.votings.admin.content_blocks.landing_page.header.name"
+          content_block.default!
+        end
+
+        Decidim.content_blocks.register(:voting_landing_page, :description) do |content_block|
+          content_block.cell = "decidim/votings/content_blocks/landing_page/description"
+          content_block.public_name_key = "decidim.votings.admin.content_blocks.landing_page.description.name"
+          content_block.default!
+        end
+
+        Decidim.content_blocks.register(:voting_landing_page, :elections) do |content_block|
+          content_block.cell = "decidim/votings/content_blocks/landing_page/elections"
+          content_block.public_name_key = "decidim.votings.admin.content_blocks.landing_page.elections.name"
+          content_block.default!
+        end
+
+        Decidim.content_blocks.register(:voting_landing_page, :polling_stations) do |content_block|
+          content_block.cell = "decidim/votings/content_blocks/landing_page/polling_stations"
+          content_block.public_name_key = "decidim.votings.admin.content_blocks.landing_page.polling_stations.name"
+          content_block.default!
+        end
+
+        Decidim.content_blocks.register(:voting_landing_page, :attachments_and_folders) do |content_block|
+          content_block.cell = "decidim/votings/content_blocks/landing_page/attachments_and_folders"
+          content_block.public_name_key = "decidim.votings.admin.content_blocks.landing_page.attachments_and_folders.name"
+          content_block.default!
+        end
+
+        Decidim.content_blocks.register(:voting_landing_page, :stats) do |content_block|
+          content_block.cell = "decidim/votings/content_blocks/landing_page/stats"
+          content_block.public_name_key = "decidim.votings.admin.content_blocks.landing_page.stats.name"
+          content_block.default!
+        end
+
+        Decidim.content_blocks.register(:voting_landing_page, :metrics) do |content_block|
+          content_block.cell = "decidim/votings/content_blocks/landing_page/metrics"
+          content_block.public_name_key = "decidim.votings.admin.content_blocks.landing_page.metrics.name"
+          content_block.default!
+        end
+
+        Decidim.content_blocks.register(:voting_landing_page, :timeline) do |content_block|
+          content_block.cell = "decidim/votings/content_blocks/landing_page/timeline"
+          content_block.public_name_key = "decidim.votings.admin.content_blocks.landing_page.timeline.name"
+          content_block.default!
+        end
+
+        1.upto(3) do |i|
+          Decidim.content_blocks.register(:voting_landing_page, "html_block_#{i}".to_sym) do |content_block|
+            content_block.cell = "decidim/content_blocks/html"
+            content_block.public_name_key = "decidim.votings.admin.content_blocks.landing_page.html_block_#{i}.name"
+            content_block.settings_form_cell = "decidim/content_blocks/html_settings_form"
+
+            content_block.settings do |settings|
+              settings.attribute :html_content, type: :text, translated: true
+            end
+          end
+        end
+      end
+
+      initializer "decidim_votings.query_extensions" do
+        Decidim::Api::QueryType.include Decidim::Votings::QueryExtensions
+      end
+
+      def load_seed
+        nil
+      end
+    end
+  end
+end

data/lib/decidim/votings/participatory_space.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+Decidim.register_participatory_space(:votings) do |participatory_space|
+  participatory_space.icon = "decidim/votings/icon.svg"
+  participatory_space.model_class_name = "Decidim::Votings::Voting"
+  participatory_space.permissions_class_name = "Decidim::Votings::Permissions"
+  participatory_space.stylesheet = "decidim/votings/votings"
+  participatory_space.query_type = "Decidim::Votings::VotingType"
+
+  participatory_space.participatory_spaces do |organization|
+    Decidim::Votings::Voting.where(organization: organization)
+  end
+
+  participatory_space.register_resource(:voting) do |resource|
+    resource.model_class_name = "Decidim::Votings::Voting"
+    resource.card = "decidim/votings/voting"
+    resource.searchable = true
+  end
+
+  participatory_space.context(:public) do |context|
+    context.engine = Decidim::Votings::Engine
+    context.layout = "layouts/decidim/votings"
+    context.helper = "Decidim::Votings::ApplicationHelper"
+  end
+
+  participatory_space.context(:admin) do |context|
+    context.engine = Decidim::Votings::AdminEngine
+    context.layout = "layouts/decidim/admin/voting"
+  end
+
+  participatory_space.exports :votings do |export|
+    export.collection do |voting|
+      Decidim::Votings::Voting.where(id: voting.id)
+    end
+
+    export.include_in_open_data = true
+
+    export.serializer Decidim::Votings::VotingSerializer
+  end
+
+  participatory_space.seeds do
+    organization = Decidim::Organization.first
+    seeds_root = File.join(__dir__, "..", "..", "..", "db", "seeds")
+
+    3.times do |n|
+      params = {
+        organization: organization,
+        title: Decidim::Faker::Localized.sentence(word_count: 5),
+        slug: Decidim::Faker::Internet.unique.slug(words: nil, glue: "-"),
+        description: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
+          Decidim::Faker::Localized.paragraph(sentence_count: 3)
+        end,
+        scope: n.positive? ? nil : Decidim::Scope.reorder(Arel.sql("RANDOM()")).first,
+        banner_image: File.new(File.join(seeds_root, "city.jpeg")),
+        published_at: 2.weeks.ago,
+        start_time: n.weeks.from_now,
+        end_time: (n + 1).weeks.from_now + 4.hours,
+        voting_type: Decidim::Votings::Voting.voting_types.values.sample,
+        promoted: n.odd?
+      }
+
+      voting = Decidim.traceability.perform_action!(
+        "publish",
+        Decidim::Votings::Voting,
+        organization.users.first,
+        visibility: "all"
+      ) do
+        Decidim::Votings::Voting.create!(params)
+      end
+      voting.add_to_index_as_search_resource
+
+      landing_page_content_blocks = [:header, :description, :elections, :polling_stations, :attachments_and_folders, :stats, :metrics]
+
+      landing_page_content_blocks.each.with_index(1) do |manifest_name, index|
+        Decidim::ContentBlock.create(
+          organization: organization,
+          scope_name: :voting_landing_page,
+          manifest_name: manifest_name,
+          weight: index,
+          scoped_resource_id: voting.id,
+          published_at: Time.current
+        )
+      end
+    end
+  end
+end
+
+Decidim.register_global_engine(
+  :decidim_votings_polling_officer_zone,
+  Decidim::Votings::PollingOfficerZoneEngine,
+  at: "/polling_officers"
+)

data/lib/decidim/votings/polling_officer_zone.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Votings
+    # This module contains all the domain logic associated to Decidim's Votings
+    # polling officer zone.
+    module PollingOfficerZone
+    end
+  end
+end