decidim-action_delegator 0.8.1 → 0.9.0

data/lib/decidim/action_delegator/engine.rb

@@ -3,7 +3,7 @@
 require "savon"
 require "rails"
 require "decidim/core"
-require "decidim/consultations"
+require "decidim/elections"
 require "deface"
 
 module Decidim
@@ -12,33 +12,33 @@ module Decidim
     # Handles all the logic related to delegation except verifications
     class Engine < ::Rails::Engine
       isolate_namespace Decidim::ActionDelegator
+      include Decidim::TranslatableAttributes
 
       routes do
-        # Add engine routes here
+        namespace :elections do
+          get ":id/sum_of_weights", to: "results#sum_of_weights", as: :results_sum_of_weights
+          namespace :admin do
+            get ":id/by_type_and_weight", to: "results#by_type_and_weight", as: :results_by_type_and_weight
+            get ":id/sum_of_weights", to: "results#sum_of_weights", as: :results_sum_of_weights
+            get ":id/totals", to: "results#totals", as: :results_totals
+          end
+        end
+
         authenticate(:user) do
-          resources :user_delegations, controller: :user_delegations
+          resources :user_delegations, controller: :user_delegations, only: [:index]
           root to: "user_delegations#index"
         end
       end
 
-      config.to_prepare do
-        # override votes questions
-        Decidim::Consultations::Question.include(Decidim::ActionDelegator::Consultations::QuestionOverride)
-        Decidim::Consultations::VoteQuestion.include(Decidim::ActionDelegator::Consultations::VoteQuestionOverride)
-        Decidim::Consultations::MultipleVoteQuestion.include(Decidim::ActionDelegator::Consultations::MultipleVoteQuestionOverride)
-        Decidim::Consultations::VoteForm.include(Decidim::ActionDelegator::Consultations::VoteFormOverride)
-        Decidim::Consultations::MultiVoteForm.include(Decidim::ActionDelegator::Consultations::VoteFormOverride)
-        Decidim::Consultations::Vote.include(Decidim::ActionDelegator::Consultations::VoteOverride)
-        Decidim::Consultations::Permissions.include(Decidim::ActionDelegator::Consultations::PermissionsOverride)
-      end
-
       initializer "decidim_action_delegator.overrides", after: "decidim.action_controller" do
         config.to_prepare do
           Decidim::Devise::SessionsController.include(Decidim::ActionDelegator::Devise::SessionsControllerOverride)
-          Decidim::Consultations::QuestionVotesController.include(Decidim::ActionDelegator::Consultations::QuestionVotesControllerOverride)
-          Decidim::Consultations::QuestionsController.include(Decidim::ActionDelegator::Consultations::QuestionsControllerOverride)
-          Decidim::Consultations::ConsultationsController.include(Decidim::ActionDelegator::Consultations::ConsultationsControllerOverride)
-          Decidim::Consultations::QuestionMultipleVotesController.include(Decidim::ActionDelegator::Consultations::QuestionMultipleVotesControllerOverride)
+          if Decidim.module_installed?(:elections)
+            Decidim::Elections::VotesController.include(Decidim::ActionDelegator::ElectionVotesControllerOverride)
+            Decidim::Elections::PerQuestionVotesController.include(Decidim::ActionDelegator::ElectionPerQuestionVotesControllerOverride)
+            Decidim::Elections::ElectionsController.helper(SettingsHelper)
+            Decidim::Elections::Admin::ElectionsController.helper(SettingsHelper)
+          end
         end
       end
 
@@ -50,6 +50,13 @@ module Decidim
           workflow.engine = Decidim::ActionDelegator::Verifications::DelegationsVerifier::Engine
           workflow.expires_in = Decidim::ActionDelegator.authorization_expiration_time
           workflow.time_between_renewals = 1.minute
+          workflow.options do |options|
+            options.attribute :setting, type: :select, raw_choices: true, choices: lambda { |context|
+              Decidim::ActionDelegator::Setting.where(organization: context[:component]&.organization).active.map do |setting|
+                [translated_attribute(setting.title), setting.id]
+              end
+            }
+          end
         end
       end
 
@@ -57,7 +64,7 @@ module Decidim
         Decidim.register_assets_path File.expand_path("app/packs", root)
       end
 
-      initializer "decidim.user_menu" do
+      initializer "decidim_action_delegator.user_menu" do
         Decidim.menu :user_menu do |menu|
           menu.add_item :vote_delegations,
                         t("vote_delegations", scope: "layouts.decidim.user_profile"),
@@ -66,6 +73,29 @@ module Decidim
                         active: :exact
         end
       end
+
+      initializer "decidim_action_delegator.census_registry" do
+        next unless Decidim.module_installed?(:elections)
+
+        Decidim::Elections.census_registry.register(:action_delegator_census) do |manifest|
+          manifest.admin_form = "Decidim::ActionDelegator::Admin::ActionDelegatorCensusForm"
+          manifest.admin_form_partial = "decidim/action_delegator/admin/censuses/action_delegator_census_form"
+          manifest.voter_form = "Decidim::ActionDelegator::Censuses::InternalUsersForm"
+          manifest.voter_form_partial = "decidim/action_delegator/censuses/internal_users_form"
+
+          manifest.user_query do |election|
+            Decidim::ActionDelegator::ActionDelegatorCensusUsers.new(election).query
+          end
+
+          manifest.census_ready_validator { |election| election.census_settings["setting_id"].present? }
+        end
+      end
+
+      initializer "decidim_action_delegator.icons" do
+        Decidim.icons.register(name: "weight-line", icon: "weight-line", category: "system", description: "", engine: :action_delegator)
+        Decidim.icons.register(name: "user-shared-line", icon: "user-shared-line", category: "system", description: "", engine: :action_delegator)
+        Decidim.icons.register(name: "arrow-go-forward-line", icon: "arrow-go-forward-line", category: "system", description: "", engine: :action_delegator)
+      end
     end
   end
 end

data/lib/decidim/action_delegator/test/delegation_examples.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+shared_examples "voting in a per question election" do
+  it "shows delegation and allows the user vote for himself and the granter" do
+    expect(page).to have_css(".election__aside-voted")
+    expect(page).to have_content("You have delegated votes.")
+    expect(page).to have_content("You can vote on behalf of the following participants in this election:")
+
+    within ".election__aside-voted" do
+      expect(page).to have_content(user.name.to_s)
+    end
+
+    click_on "Vote"
+    expect(page).to have_content("You are voting for yourself (#{delegate_user.name})")
+
+    first("input[value=\"#{response_option1.id}\"]").click
+    click_on "Cast vote"
+
+    expect(page).to have_content("Waiting for the next question")
+
+    expect(page).to have_css(".waiting-buttons")
+    expect(page).to have_content("You have delegated votes.")
+    expect(page).to have_link(
+      "Continue voting on behalf of #{user.name}",
+      href: election_per_question_vote_path(current_question.id, delegation.id)
+    )
+    click_on "Continue voting on behalf of #{user.name}"
+    expect(page).to have_content("You are voting on behalf of #{user.name}")
+
+    first("input[value=\"#{response_option2.id}\"]").click
+    click_on "Cast vote"
+
+    expect(page).to have_content("Your vote has been successfully cast")
+    expect(page).to have_link("Edit your vote", href: election_per_question_vote_path(current_question))
+    expect(page).to have_link("Edit vote for #{user.name}", href: election_per_question_vote_path(current_question) + "?delegation=#{delegation.id}")
+
+    expect(last_vote(delegate_user).response_option).to eq(response_option1)
+    expect(last_vote(user).response_option).to eq(response_option2)
+
+    click_on "Edit vote for #{user.name}"
+    first("input[value=\"#{response_option1.id}\"]").click
+    click_on "Cast vote"
+
+    expect(page).to have_content("Your vote has been successfully cast")
+    expect(last_vote(user).response_option.reload).to eq(response_option1)
+
+    click_on "Edit your vote"
+    first("input[value=\"#{response_option2.id}\"]").click
+    click_on "Cast vote"
+
+    sleep 0.1 # Wait for the versioning to be saved
+    expect(last_vote(delegate_user).response_option.reload).to eq(response_option2)
+    expect(last_vote(delegate_user).versions.first.whodunnit).to eq(delegate_user.id.to_s)
+    expect(last_vote(delegate_user).versions.first.decidim_action_delegator_delegation_id).to be_blank
+    expect(last_vote(user).versions.first.whodunnit).to eq(delegate_user.id.to_s)
+    expect(last_vote(user).versions.first.decidim_action_delegator_delegation_id).to eq(delegation.id)
+  end
+
+  context "when delegate has voted for delegated user" do
+    let!(:next_question) { create(:election_question, :voting_enabled, :with_response_options, election:) }
+    let!(:vote1) { create(:election_vote, question: current_question, response_option: current_question.response_options.first, voter_uid: user.to_global_id.to_s) }
+    let!(:vote2) { create(:election_vote, question: next_question, response_option: next_question.response_options.first, voter_uid: user.to_global_id.to_s) }
+
+    it "shows voted status on election page" do
+      visit election_path
+      expect(page).to have_content("You have delegated votes.")
+      expect(page).to have_content("You can vote on behalf of the following participants in this election:")
+
+      within all(".election__aside-voted").last do
+        expect(page).to have_content("✔ #{user.name}")
+      end
+    end
+  end
+end
+
+shared_examples "voting in a normal election" do
+  it "shows delegation and allows the user vote for himself and the granter" do
+    expect(page).to have_css(".election__aside-voted")
+    expect(page).to have_content("You have delegated votes.")
+    expect(page).to have_content("Vote on behalf of #{user.name}")
+
+    click_on "Vote"
+
+    first("input[value=\"#{response_option1.id}\"]").click
+    click_on "Next"
+    sleep 0.1
+    first('input[type="radio"], input[type="checkbox"]').click
+    click_on "Next"
+    click_on "Cast vote"
+
+    expect(page).to have_content("Your vote has been successfully cast")
+    click_on "Exit the voting booth"
+
+    expect(page).to have_content("You have already voted.")
+    expect(last_vote(delegate_user).response_option).to eq(response_option1)
+
+    click_on "Vote on behalf of #{user.name}"
+    expect(page).to have_content("You are voting on behalf of #{user.name}")
+
+    first("input[value=\"#{response_option2.id}\"]").click
+    click_on "Next"
+    sleep 0.1
+    first('input[type="radio"], input[type="checkbox"]').click
+    click_on "Next"
+    click_on "Cast vote"
+
+    expect(page).to have_content("Your vote has been successfully cast")
+    click_on "Exit the voting booth"
+    expect(page).to have_content("You have already voted.")
+
+    expect(last_vote(user).response_option.reload).to eq(response_option2)
+
+    click_on "Vote"
+    first("input[value=\"#{response_option2.id}\"]").click
+    click_on "Next"
+    sleep 0.1
+    click_on "Next"
+    click_on "Cast vote"
+    click_on "Exit the voting booth"
+
+    expect(last_vote(delegate_user).reload.response_option).to eq(response_option2)
+
+    click_on "Vote on behalf of #{user.name}"
+    first("input[value=\"#{response_option1.id}\"]").click
+    click_on "Next"
+    sleep 0.1
+    click_on "Next"
+    click_on "Cast vote"
+    click_on "Exit the voting booth"
+
+    expect(last_vote(user).reload.response_option).to eq(response_option1)
+    expect(last_vote(delegate_user).versions.first.whodunnit).to eq(delegate_user.id.to_s)
+    expect(last_vote(delegate_user).versions.first.decidim_action_delegator_delegation_id).to be_blank
+    expect(last_vote(user).versions.first.whodunnit).to eq(delegate_user.id.to_s)
+    expect(last_vote(user).versions.first.decidim_action_delegator_delegation_id).to eq(delegation.id)
+  end
+end
+
+shared_examples "no delegations available" do
+  it "does not show delegation buttons" do
+    expect(page).to have_no_css(".election__aside-voted")
+    expect(page).to have_no_content("You have delegated votes.")
+  end
+end

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

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
 
-require "decidim/core/test/factories"
-require "decidim/consultations/test/factories"
-
 FactoryBot.define do
   factory :delegation, class: "Decidim::ActionDelegator::Delegation" do
     setting
-    granter { association :user, organization: setting.consultation.organization }
-    grantee { association :user, organization: setting.consultation.organization }
+    granter { association :user, organization: setting.organization }
+    grantee { association :user, organization: setting.organization }
   end
 
   factory :ponderation, class: "Decidim::ActionDelegator::Ponderation" do
@@ -24,13 +21,21 @@ FactoryBot.define do
   end
 
   factory :setting, class: "Decidim::ActionDelegator::Setting" do
+    organization { create(:organization) }
+    transient do
+      skip_injection { false }
+    end
+
+    title { generate_localized_title(:title, skip_injection:) }
+    description { generate_localized_description(:description, skip_injection:) }
     max_grants { 3 }
-    consultation
+
     trait :with_ponderations do
       after(:create) do |setting|
         create_list(:ponderation, 3, setting: setting)
       end
     end
+
     trait :with_participants do
       after(:create) do |setting|
         create_list(:participant, 3, setting: setting)

data/lib/decidim/action_delegator/verifications/delegations_authorizer.rb

@@ -5,77 +5,110 @@ module Decidim
     module Verifications
       class DelegationsAuthorizer < Decidim::Verifications::DefaultActionAuthorizer
         def authorize
-          status = super
-          return status unless status == [:ok, {}]
+          if !authorization
+            [:missing, { action: :authorize }]
+          elsif authorization_expired?
+            [:expired, { action: :authorize }]
+          elsif !authorization.granted?
+            [:pending, { action: :resume }]
+          elsif invalid_setting?
+            return [:unauthorized, { extra_explanation: extra_explanations }]
+          else
+            [:ok, {}]
+          end
+        end
 
-          # if used outside a consultation, allow all
-          return [:ok, {}] if consultation.blank?
-          return [:ok, {}] if belongs_to_consultation? && user_in_census?
+        def invalid_setting?
+          return true unless setting
+          return true unless user_is_a_participant?
 
-          [:unauthorized, { extra_explanation: extra_explanations }]
+          false
         end
 
         private
 
-        def belongs_to_consultation?
-          return unless setting&.consultation
+        def user_is_a_participant?
+          return false unless setting && setting.active?
 
-          setting.consultation == consultation
+          setting.participants.exists?(participant_params(setting))
         end
 
-        def user_in_census?
-          return unless setting&.participants
-
-          setting.participants.exists?(decidim_user: authorization.user) || setting.participants.exists?(census_params)
+        def participant_params(setting)
+          params = {}
+          params[:email] = authorization.user.email if setting.email_required?
+          params[:phone] = authorization.metadata["phone"] if setting.phone_required?
+          params
         end
 
-        def census_params
-          return @census_params if @census_params
-
-          @census_params = { email: authorization.user.email }
-          @census_params[:phone] = authorization.metadata["phone"] if setting.phone_required?
-          @census_params
+        def authorizations_path
+          Decidim::Verifications::Engine.routes.url_helpers.authorizations_path
         end
 
         def extra_explanations
           return @extra_explanations if @extra_explanations
 
-          unless setting
-            return [{
-              key: "no_setting",
-              params: { scope: "decidim.action_delegator.delegations_authorizer" }
-            }]
-          end
-
-          @extra_explanations = [{
-            key: "not_in_census",
-            params: { scope: "decidim.action_delegator.delegations_authorizer" }
-          }]
-
-          @extra_explanations << {
-            key: "email",
-            params: { scope: "decidim.action_delegator.delegations_authorizer", email: authorization.user.email }
-          }
-
-          if setting.phone_required?
+          @extra_explanations = []
+
+          if setting
+            if setting.active?
+              @extra_explanations << {
+                key: "not_in_census_html",
+                params: {
+                  scope: "decidim.action_delegator.delegations_authorizer",
+                  census: translated_attribute(setting.title),
+                  renew_path: authorizations_path
+                }
+              }
+              if setting.email_required?
+                @extra_explanations << {
+                  key: "email",
+                  params: { scope: "decidim.action_delegator.delegations_authorizer", email: authorization.user.email }
+                }
+              end
+              if setting.phone_required?
+                @extra_explanations << {
+                  key: "phone",
+                  params: { scope: "decidim.action_delegator.delegations_authorizer", phone: authorization.metadata["phone"] || "---" }
+                }
+              end
+            else
+              @extra_explanations << {
+                key: "inactive_setting_html",
+                params: {
+                  scope: "decidim.action_delegator.delegations_authorizer",
+                  census: translated_attribute(setting.title),
+                  renew_path: authorizations_path
+                }
+              }
+            end
+          else
             @extra_explanations << {
-              key: "phone",
-              params: { scope: "decidim.action_delegator.delegations_authorizer", phone: authorization.metadata["phone"] || "---" }
+              key: "no_setting_html",
+              params: {
+                scope: "decidim.action_delegator.delegations_authorizer",
+                renew_path: authorizations_path
+              }
             }
           end
-          @extra_explanations
-        end
 
-        def setting
-          @setting ||= Decidim::ActionDelegator::Setting.find_by(consultation: consultation)
+          @extra_explanations
         end
 
-        def consultation
-          @consultation ||= (component.participatory_space if component&.participatory_space.is_a?(Decidim::Consultation))
+        # Obtain the setting from the resource (in case is an election) or from the standard options (coming from the component/resource permissions hash) otherwise
+        def setting_id
+          @setting_id ||= if resource && resource.respond_to?(:census_settings) && resource.respond_to?(:census_manifest)
+                            if resource.census_manifest == "action_delegator_census"
+                              resource.census_settings["setting_id"]
+                            else
+                              resource.census_settings.dig("authorization_handlers", "delegations_verifier", "options", "setting")
+                            end
+                          else
+                            options["setting"]
+                          end
         end
 
-        def manifest
-          @manifest ||= Decidim::Verifications.find_workflow_manifest(authorization&.name)
+        def setting
+          @setting ||= Decidim::ActionDelegator::Setting.find_by(id: setting_id)
         end
       end
     end

data/lib/decidim/action_delegator/version.rb

@@ -3,8 +3,8 @@
 module Decidim
   # This holds the decidim-action_delegator version.
   module ActionDelegator
-    VERSION = "0.8.1"
-    DECIDIM_VERSION = "0.27.4"
-    COMPAT_DECIDIM_VERSION = [">= 0.27.0", "< 0.28"].freeze
+    VERSION = "0.9.0"
+    DECIDIM_VERSION = { github: "decidim/decidim", branch: "develop" }.freeze
+    COMPAT_DECIDIM_VERSION = [">= 0.31.0.dev", "< 0.32"].freeze
   end
 end

data/lib/decidim/action_delegator.rb

@@ -14,25 +14,25 @@ module Decidim
     # this is the SmsGateway provided by this module
     # Note that it will be ignored if you provide your own SmsGateway in Decidim.sms_gateway_service
     config_accessor :sms_gateway_service do
-      "Decidim::ActionDelegator::SmsGateway"
+      Decidim::Env.new("AD_SMS_GATEWAY_SERVICE", "Decidim::ActionDelegator::SmsGateway").to_s
     end
 
     # The default expiration time for the integrated authorization
     # if zero, the authorization won't be registered
     config_accessor :authorization_expiration_time do
-      3.months
+      Decidim::Env.new("AD_AUTHORIZATION_EXPIRATION_TIME").presence&.to_i || 3.months
     end
 
     # Put this to false if you don't want to allow administrators to invite users not registered
     # in the platform when uploading a census (inviting users without permission can be a GDPR offense).
     config_accessor :allow_to_invite_users do
-      true
+      Decidim::Env.new("AD_ALLOW_TO_INVITE_USERS", true).present?
     end
 
     # If true, tries to automatically authorize users when they log in with the "Corporate Governance Verifier"
     # Note that this is only possible when the verifier is configured to use only the email (if SMS is required, the user will have to do the standard verification process)
     config_accessor :authorize_on_login do
-      true
+      Decidim::Env.new("AD_AUTHORIZE_ON_LOGIN", true).present?
     end
 
     # used for comparing phone numbers from a census list and the ones introduced by the user
@@ -40,30 +40,12 @@ module Decidim
     # if you have a census list with  +34 666 666 666 and the user introduces 0034666666666 or 666666666, they will be considered the same
     # can be empty or null if yo don't want to check different combinations of prefixes
     config_accessor :phone_prefixes do
-      %w(+34 0034 34)
+      Decidim::Env.new("AD_PHONE_PREFIXES", "+34,0034,34").to_array
     end
 
     # The regex for validating phone numbers
     config_accessor :phone_regex do
-      /^\d{6,15}$/ # 6 to 15 digits
-    end
-
-    # Consultations has an annoying and totally useless deprecation warning
-    # This plugin removes it by default.
-    # If you want to keep it, you can set this config to false
-    config_accessor :remove_consultation_deprecation_warning do
-      true
-    end
-
-    # In a consultation the highlighted questions are duplicated in the list of regular questions
-    # this maintains the highlighted questions in the highlighted list and removes them from the regular list
-    config_accessor :remove_duplicated_highlighted_questions do
-      true
-    end
-
-    # If true, admins can view the result of a consultation even if the consultation is ongoing
-    config_accessor :admin_preview_results do
-      true
+      Decidim::Env.new("AD_PHONE_REGEX", '^\d{6,15}$').to_s # 6 to 15 digits
     end
   end
 end
@@ -74,7 +56,7 @@ end
 # manage their delegations
 Decidim.register_global_engine(
   :decidim_action_delegator, # this is the name of the global method to access engine routes
-  ::Decidim::ActionDelegator::Engine,
+  Decidim::ActionDelegator::Engine,
   at: "/action_delegator"
 )
 
@@ -82,6 +64,6 @@ Decidim.register_global_engine(
 # create their own
 Decidim.register_global_engine(
   :decidim_admin_action_delegator,
-  ::Decidim::ActionDelegator::AdminEngine,
+  Decidim::ActionDelegator::AdminEngine,
   at: "/admin/action_delegator"
 )