decidim-elections 0.23.0 → 0.24.0.rc1

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/elections/admin_engine.rb

@@ -10,24 +10,65 @@ module Decidim
       paths["lib/tasks"] = nil
 
       routes do
+        get "/answer_options", to: "feedback_forms#answer_options", as: :answer_options_election_feedback, defaults: { format: "json" }
+
         resources :elections do
+          resources :steps, only: [:index, :update] do
+            get :stats
+          end
           member do
             put :publish
             put :unpublish
+            resource :feedback_form, only: [:edit, :update] do
+              collection do
+                get :answers, to: "feedback_forms#index"
+                get "/answer/:session_token", to: "feedback_forms#show", as: :answer
+                get "/answer/:session_token/export", to: "feedback_forms#export_response", as: :answer_export
+              end
+            end
           end
           resources :questions do
             resources :answers do
-              get :proposals_picker, on: :collection
               collection do
+                get :proposals_picker
                 resource :proposals_import, only: [:new, :create]
               end
+              member do
+                put :select
+                put :unselect
+              end
             end
           end
         end
 
+        resources :trustees, only: [:index, :new, :edit, :create, :destroy], controller: "trustees_participatory_spaces"
+
         root to: "elections#index"
       end
 
+      def self.participatory_space_endpoints
+        [:trustees]
+      end
+
+      initializer "decidim_admin_elections.view_hooks" do
+        Decidim::Admin.view_hooks.register(:admin_secondary_nav, priority: Decidim::ViewHooks::MEDIUM_PRIORITY) do |view_context|
+          component = view_context.current_participatory_space.components.find_by(manifest_name: :elections)
+          if component
+            view_context.render(
+              partial: "decidim/elections/admin/shared/trustees_secondary_nav",
+              locals: {
+                current_component: component,
+                engine_router: Decidim::EngineRouter.admin_proxy(component)
+              }
+            )
+          end
+        end
+      end
+
+      initializer "decidim_elections.assets" do |app|
+        app.config.assets.precompile += %w(decidim_elections_manifest.js decidim_elections_manifest.css)
+      end
+
       def load_seed
         nil
       end

data/lib/decidim/elections/answer_serializer.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Elections
+    # This class serializes an Answer so it can be exported to CSV, JSON or other
+    # formats.
+    class AnswerSerializer < Decidim::Exporters::Serializer
+      include Decidim::ApplicationHelper
+      include Decidim::ResourceHelper
+      include Decidim::TranslationsHelper
+
+      # Public: Initializes the serializer with an answer.
+      def initialize(answer)
+        @answer = answer
+      end
+
+      # Public: Exports a hash with the serialized data for this answer.
+      def serialize
+        {
+          participatory_space: {
+            id: election.participatory_space.id,
+            title: election.participatory_space.title
+          },
+          id: answer.id,
+          election_id: election.id,
+          election_title: election.title,
+          question_id: question.id,
+          question_title: question.title,
+          answer_id: answer.id,
+          answer_title: answer.title,
+          answer_votes: answer.votes_count
+        }
+      end
+
+      private
+
+      attr_reader :answer
+
+      def election
+        answer.question.election
+      end
+
+      def question
+        answer.question
+      end
+    end
+  end
+end

data/lib/decidim/elections/api.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Elections
+    autoload :ElectionAnswerType, "decidim/api/election_answer_type"
+    autoload :ElectionQuestionType, "decidim/api/election_question_type"
+    autoload :ElectionType, "decidim/api/election_type"
+    autoload :ElectionsType, "decidim/api/elections_type"
+    autoload :TrusteeType, "decidim/api/trustee_type"
+  end
+end

data/lib/decidim/elections/component.rb

@@ -9,9 +9,10 @@ Decidim.register_component(:elections) do |component|
   component.stylesheet = "decidim/elections/elections"
   component.permissions_class_name = "Decidim::Elections::Permissions"
   component.query_type = "Decidim::Elections::ElectionsType"
-  # component.on(:before_destroy) do |instance|
-  #   # Code executed before removing the component
-  # end
+
+  component.on(:before_destroy) do |instance|
+    raise StandardError, "Can't remove this component" if Decidim::Elections::Election.where(component: instance).any?
+  end
 
   # These actions permissions can be configured in the admin panel
   component.actions = %w(vote)
@@ -43,6 +44,26 @@ Decidim.register_component(:elections) do |component|
     resource.model_class_name = "Decidim::Elections::Answer"
   end
 
+  component.exports :feedback_form_answers do |exports|
+    exports.collection do |_component, _user, resource_id|
+      Decidim::Forms::QuestionnaireUserAnswers.for(resource_id)
+    end
+
+    exports.formats %w(CSV JSON Excel FormPDF)
+
+    exports.serializer Decidim::Forms::UserAnswersSerializer
+  end
+
+  component.exports :elections do |exports|
+    exports.collection do |component_instance|
+      Decidim::Elections::Question.where(election: Decidim::Elections::Election.where(component: component_instance).bb_results_published).collect(&:answers).flatten
+    end
+
+    exports.include_in_open_data = true
+
+    exports.serializer Decidim::Elections::AnswerSerializer
+  end
+
   component.seeds do |participatory_space|
     admin_user = Decidim::User.find_by(
       organization: participatory_space.organization,
@@ -65,64 +86,386 @@ Decidim.register_component(:elections) do |component|
       Decidim::Component.create!(params)
     end
 
-    3.times do
-      election = Decidim.traceability.create!(
+    # upcoming elections that may be published
+    2.times do
+      upcoming_election = Decidim.traceability.create!(
         Decidim::Elections::Election,
         admin_user,
         {
           component: component,
-          title: Decidim::Faker::Localized.sentence(2),
+          title: Decidim::Faker::Localized.sentence(word_count: 2),
           description: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
-            Decidim::Faker::Localized.paragraph(3)
+            Decidim::Faker::Localized.paragraph(sentence_count: 3)
           end,
           start_time: 3.weeks.from_now,
           end_time: 3.weeks.from_now + 4.hours,
-          published_at: Faker::Boolean.boolean(0.5) ? 1.week.ago : nil
+          published_at: Faker::Boolean.boolean(true_ratio: 0.5) ? 1.week.ago : nil
+        },
+        visibility: "all"
+      )
+
+      rand(1...4).times do
+        upcoming_question = Decidim.traceability.create!(
+          Decidim::Elections::Question,
+          admin_user,
+          {
+            election: upcoming_election,
+            title: Decidim::Faker::Localized.sentence(word_count: 2),
+            description: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
+              Decidim::Faker::Localized.paragraph(sentence_count: 3)
+            end,
+            max_selections: Faker::Number.between(from: 1, to: 3),
+            weight: Faker::Number.number(digits: 1),
+            random_answers_order: Faker::Boolean.boolean(true_ratio: 0.5),
+            min_selections: Faker::Number.between(from: 0, to: 1)
+          },
+          visibility: "all"
+        )
+
+        rand(upcoming_question.max_selections...5).times do
+          answer = Decidim.traceability.create!(
+            Decidim::Elections::Answer,
+            admin_user,
+            {
+              question: upcoming_question,
+              title: Decidim::Faker::Localized.sentence(word_count: 2),
+              description: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
+                Decidim::Faker::Localized.paragraph(sentence_count: 3)
+              end,
+              weight: Faker::Number.number(digits: 1),
+              selected: Faker::Boolean.boolean(true_ratio: 0.2), # false
+              votes_count: 0
+            },
+            visibility: "all"
+          )
+
+          Decidim::Attachment.create!(
+            title: Decidim::Faker::Localized.sentence(word_count: 2),
+            description: Decidim::Faker::Localized.sentence(word_count: 5),
+            attached_to: answer,
+            file: File.new(File.join(__dir__, "seeds", "city.jpeg")) # Keep after attached_to
+          )
+        end
+
+        questionnaire = Decidim::Forms::Questionnaire.create!(
+          title: Decidim::Faker::Localized.paragraph,
+          description: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
+            Decidim::Faker::Localized.paragraph(sentence_count: 3)
+          end,
+          tos: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
+            Decidim::Faker::Localized.paragraph(sentence_count: 2)
+          end,
+          questionnaire_for: upcoming_election
+        )
+
+        %w(short_answer long_answer).each do |text_question_type|
+          Decidim::Forms::Question.create!(
+            questionnaire: questionnaire,
+            body: Decidim::Faker::Localized.paragraph,
+            question_type: text_question_type
+          )
+        end
+
+        %w(single_option multiple_option).each do |multiple_choice_question_type|
+          question = Decidim::Forms::Question.create!(
+            questionnaire: questionnaire,
+            body: Decidim::Faker::Localized.paragraph,
+            question_type: multiple_choice_question_type
+          )
+
+          3.times do
+            question.answer_options.create!(body: Decidim::Faker::Localized.sentence)
+          end
+        end
+      end
+    end
+
+    # finished elections that may be published, with questionnaire
+    2.times do
+      finished_election = Decidim.traceability.create!(
+        Decidim::Elections::Election,
+        admin_user,
+        {
+          component: component,
+          title: Decidim::Faker::Localized.sentence(word_count: 2),
+          description: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
+            Decidim::Faker::Localized.paragraph(sentence_count: 3)
+          end,
+          start_time: 4.weeks.ago,
+          end_time: 3.weeks.ago,
+          published_at: 4.weeks.ago
+        },
+        visibility: "all"
+      )
+
+      rand(1...4).times do
+        finished_question = Decidim.traceability.create!(
+          Decidim::Elections::Question,
+          admin_user,
+          {
+            election: finished_election,
+            title: Decidim::Faker::Localized.sentence(word_count: 2),
+            description: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
+              Decidim::Faker::Localized.paragraph(sentence_count: 3)
+            end,
+            max_selections: 2,
+            weight: Faker::Number.number(digits: 1),
+            random_answers_order: Faker::Boolean.boolean(true_ratio: 0.5),
+            min_selections: Faker::Number.between(from: 0, to: 1)
+          },
+          visibility: "all"
+        )
+
+        rand(2...5).times do
+          answer = Decidim.traceability.create!(
+            Decidim::Elections::Answer,
+            admin_user,
+            {
+              question: finished_question,
+              title: Decidim::Faker::Localized.sentence(word_count: 2),
+              description: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
+                Decidim::Faker::Localized.paragraph(sentence_count: 3)
+              end,
+              weight: Faker::Number.number(digits: 1),
+              selected: Faker::Boolean.boolean(true_ratio: 0.2), # false
+              votes_count: 0
+            },
+            visibility: "all"
+          )
+
+          Decidim::Attachment.create!(
+            title: Decidim::Faker::Localized.sentence(word_count: 2),
+            description: Decidim::Faker::Localized.sentence(word_count: 5),
+            attached_to: answer,
+            file: File.new(File.join(__dir__, "seeds", "city.jpeg")) # Keep after attached_to
+          )
+        end
+
+        questionnaire = Decidim::Forms::Questionnaire.create!(
+          title: Decidim::Faker::Localized.paragraph,
+          description: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
+            Decidim::Faker::Localized.paragraph(sentence_count: 3)
+          end,
+          tos: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
+            Decidim::Faker::Localized.paragraph(sentence_count: 2)
+          end,
+          questionnaire_for: finished_election
+        )
+
+        %w(short_answer long_answer).each do |text_question_type|
+          Decidim::Forms::Question.create!(
+            questionnaire: questionnaire,
+            body: Decidim::Faker::Localized.paragraph,
+            question_type: text_question_type
+          )
+        end
+
+        %w(single_option multiple_option).each do |multiple_choice_question_type|
+          question = Decidim::Forms::Question.create!(
+            questionnaire: questionnaire,
+            body: Decidim::Faker::Localized.paragraph,
+            question_type: multiple_choice_question_type
+          )
+
+          3.times do
+            question.answer_options.create!(body: Decidim::Faker::Localized.sentence)
+          end
+        end
+      end
+    end
+
+    # finished, published elections with results and with questionnaire
+    2.times do
+      election_with_results = Decidim.traceability.create!(
+        Decidim::Elections::Election,
+        admin_user,
+        {
+          component: component,
+          title: Decidim::Faker::Localized.sentence(word_count: 2),
+          description: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
+            Decidim::Faker::Localized.paragraph(sentence_count: 3)
+          end,
+          start_time: 4.weeks.ago,
+          end_time: 3.weeks.ago,
+          published_at: 3.weeks.ago,
+          bb_status: "results_published"
+
         },
         visibility: "all"
       )
 
-      2.times do
-        question = Decidim.traceability.create!(
+      rand(1...4).times do
+        result_question = Decidim.traceability.create!(
           Decidim::Elections::Question,
           admin_user,
           {
-            election: election,
-            title: Decidim::Faker::Localized.sentence(2),
+            election: election_with_results,
+            title: Decidim::Faker::Localized.sentence(word_count: 2),
             description: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
-              Decidim::Faker::Localized.paragraph(3)
+              Decidim::Faker::Localized.paragraph(sentence_count: 3)
             end,
-            max_selections: Faker::Number.between(1, 5),
-            weight: Faker::Number.number(1),
-            random_answers_order: Faker::Boolean.boolean(0.5),
-            min_selections: Faker::Number.between(0, 1)
+            max_selections: 2,
+            weight: Faker::Number.number(digits: 1),
+            random_answers_order: Faker::Boolean.boolean(true_ratio: 0.5),
+            min_selections: Faker::Number.between(from: 0, to: 1)
           },
           visibility: "all"
         )
 
-        Faker::Number.between(2, 5).times do
+        rand(2...5).times do
           answer = Decidim.traceability.create!(
             Decidim::Elections::Answer,
             admin_user,
             {
-              question: question,
-              title: Decidim::Faker::Localized.sentence(2),
+              question: result_question,
+              title: Decidim::Faker::Localized.sentence(word_count: 2),
               description: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
-                Decidim::Faker::Localized.paragraph(3)
+                Decidim::Faker::Localized.paragraph(sentence_count: 3)
               end,
-              weight: Faker::Number.number(1)
+              weight: Faker::Number.number(digits: 1),
+              selected: Faker::Boolean.boolean(true_ratio: 0.5),
+              votes_count: Faker::Number.number(digits: 3)
             },
             visibility: "all"
           )
 
           Decidim::Attachment.create!(
-            title: Decidim::Faker::Localized.sentence(2),
-            description: Decidim::Faker::Localized.sentence(5),
+            title: Decidim::Faker::Localized.sentence(word_count: 2),
+            description: Decidim::Faker::Localized.sentence(word_count: 5),
             attached_to: answer,
             file: File.new(File.join(__dir__, "seeds", "city.jpeg")) # Keep after attached_to
           )
         end
+
+        questionnaire = Decidim::Forms::Questionnaire.create!(
+          title: Decidim::Faker::Localized.paragraph,
+          description: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
+            Decidim::Faker::Localized.paragraph(sentence_count: 3)
+          end,
+          tos: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
+            Decidim::Faker::Localized.paragraph(sentence_count: 2)
+          end,
+          questionnaire_for: election_with_results
+        )
+
+        %w(short_answer long_answer).each do |text_question_type|
+          Decidim::Forms::Question.create!(
+            questionnaire: questionnaire,
+            body: Decidim::Faker::Localized.paragraph,
+            question_type: text_question_type
+          )
+        end
+
+        %w(single_option multiple_option).each do |multiple_choice_question_type|
+          question = Decidim::Forms::Question.create!(
+            questionnaire: questionnaire,
+            body: Decidim::Faker::Localized.paragraph,
+            question_type: multiple_choice_question_type
+          )
+
+          3.times do
+            question.answer_options.create!(body: Decidim::Faker::Localized.sentence)
+          end
+        end
+      end
+    end
+
+    # ongoing election that is published
+    ongoing_election = Decidim.traceability.create!(
+      Decidim::Elections::Election,
+      admin_user,
+      {
+        component: component,
+        title: Decidim::Faker::Localized.sentence(word_count: 2),
+        description: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
+          Decidim::Faker::Localized.paragraph(sentence_count: 3)
+        end,
+        start_time: 2.weeks.ago,
+        end_time: 2.weeks.from_now + 4.hours,
+        published_at: 3.weeks.ago
+      },
+      visibility: "all"
+    )
+
+    rand(1...4).times do
+      ongoing_question = Decidim.traceability.create!(
+        Decidim::Elections::Question,
+        admin_user,
+        {
+          election: ongoing_election,
+          title: Decidim::Faker::Localized.sentence(word_count: 2),
+          description: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
+            Decidim::Faker::Localized.paragraph(sentence_count: 3)
+          end,
+          max_selections: 2,
+          weight: Faker::Number.number(digits: 1),
+          random_answers_order: Faker::Boolean.boolean(true_ratio: 0.5),
+          min_selections: Faker::Number.between(from: 0, to: 1)
+        },
+        visibility: "all"
+      )
+
+      rand(3...5).times do
+        answer = Decidim.traceability.create!(
+          Decidim::Elections::Answer,
+          admin_user,
+          {
+            question: ongoing_question,
+            title: Decidim::Faker::Localized.sentence(word_count: 2),
+            description: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
+              Decidim::Faker::Localized.paragraph(sentence_count: 3)
+            end,
+            weight: Faker::Number.number(digits: 1),
+            selected: Faker::Boolean.boolean(true_ratio: 0.2), # false
+            votes_count: 0
+          },
+          visibility: "all"
+        )
+
+        Decidim::Attachment.create!(
+          title: Decidim::Faker::Localized.sentence(word_count: 2),
+          description: Decidim::Faker::Localized.sentence(word_count: 5),
+          attached_to: answer,
+          file: File.new(File.join(__dir__, "seeds", "city.jpeg")) # Keep after attached_to
+        )
+      end
+    end
+
+    questionnaire = Decidim::Forms::Questionnaire.create!(
+      title: Decidim::Faker::Localized.paragraph,
+      description: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
+        Decidim::Faker::Localized.paragraph(sentence_count: 3)
+      end,
+      tos: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
+        Decidim::Faker::Localized.paragraph(sentence_count: 2)
+      end,
+      questionnaire_for: ongoing_election
+    )
+
+    %w(short_answer long_answer).each do |text_question_type|
+      Decidim::Forms::Question.create!(
+        questionnaire: questionnaire,
+        body: Decidim::Faker::Localized.paragraph,
+        question_type: text_question_type
+      )
+    end
+
+    %w(single_option multiple_option).each do |multiple_choice_question_type|
+      question = Decidim::Forms::Question.create!(
+        questionnaire: questionnaire,
+        body: Decidim::Faker::Localized.paragraph,
+        question_type: multiple_choice_question_type
+      )
+
+      3.times do
+        question.answer_options.create!(body: Decidim::Faker::Localized.sentence)
       end
     end
   end
 end
+
+Decidim.register_global_engine(
+  :decidim_elections_trustee_zone,
+  Decidim::Elections::TrusteeZoneEngine,
+  at: "/trustee"
+)