decidim-action_delegator 0.5.0 → 0.7.0

data/app/models/decidim/action_delegator/participant.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ActionDelegator
+    class Participant < ApplicationRecord
+      self.table_name = "decidim_action_delegator_participants"
+
+      belongs_to :setting,
+                 foreign_key: "decidim_action_delegator_setting_id",
+                 class_name: "Decidim::ActionDelegator::Setting"
+
+      belongs_to :ponderation,
+                 foreign_key: "decidim_action_delegator_ponderation_id",
+                 class_name: "Decidim::ActionDelegator::Ponderation",
+                 optional: true
+
+      belongs_to :decidim_user,
+                 class_name: "Decidim::User",
+                 optional: true
+
+      delegate :consultation, to: :setting
+      delegate :organization, to: :setting
+
+      validates :setting, presence: true
+      validates :decidim_user, uniqueness: { scope: :setting }, if: -> { decidim_user.present? }
+      validates :email, uniqueness: { scope: :setting }, if: -> { email.present? }
+      validates :phone, uniqueness: { scope: :setting }, if: -> { phone.present? }
+
+      # sets the decidim user if found
+      before_save :set_decidim_user
+
+      # prevents destroy if has voted
+      before_destroy { |record| throw(:abort) if record.voted? }
+
+      def user
+        @user ||= decidim_user || user_from_metadata
+      end
+
+      def user_from_metadata
+        @user_from_metadata ||= if setting.email_required?
+                                  Decidim::User.find_by(email: email, organization: setting.organization)
+                                else
+                                  Decidim::Authorization.find_by(unique_id: uniq_ids)&.user
+                                end
+      end
+
+      def uniq_ids
+        @uniq_ids ||= Participant.verifier_ids(Participant.phone_combinations(["#{phone}-#{organization.id}"]))
+      end
+
+      def self.verifier_ids(seeds)
+        seeds.map { |seed| Digest::MD5.hexdigest("#{seed}-#{Digest::MD5.hexdigest(Rails.application.secrets.secret_key_base)}") }
+      end
+
+      def self.phone_combinations(phones)
+        phones.map do |phone|
+          phone_prefixes.map do |prefix|
+            [
+              "#{prefix}#{phone}",
+              phone.delete_prefix(prefix)
+            ]
+          end
+        end.flatten.uniq
+      end
+
+      def self.phone_prefixes
+        prefixes = [""]
+        prefixes += ActionDelegator.phone_prefixes if ActionDelegator.phone_prefixes.respond_to?(:map)
+        prefixes
+      end
+
+      def user_name
+        user&.name
+      end
+
+      def last_login
+        user&.last_sign_in_at
+      end
+
+      def ponderation_title
+        ponderation&.title
+      end
+
+      # checks if the user has voted in the setting's consultation
+      def voted?
+        return false if user.blank?
+
+        @voted ||= if Decidim::Consultations::Vote
+                      .joins(question: :consultation)
+                      .where(decidim_consultations_questions: {
+                               decidim_consultation_id: setting.consultation.id
+                             }, author: user).any?
+                     true
+                   else
+                     false
+                   end
+      end
+
+      private
+
+      def set_decidim_user
+        self.decidim_user = user_from_metadata if decidim_user.blank?
+      end
+    end
+  end
+end

data/app/models/decidim/action_delegator/ponderation.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ActionDelegator
+    class Ponderation < ApplicationRecord
+      self.table_name = "decidim_action_delegator_ponderations"
+
+      belongs_to :setting,
+                 foreign_key: "decidim_action_delegator_setting_id",
+                 class_name: "Decidim::ActionDelegator::Setting"
+
+      has_many :participants,
+               foreign_key: "decidim_action_delegator_ponderation_id",
+               class_name: "Decidim::ActionDelegator::Participant",
+               dependent: :restrict_with_error
+
+      delegate :consultation, to: :setting
+
+      def title
+        @title ||= "#{name} (x#{weight})"
+      end
+
+      def destroyable?
+        participants.empty?
+      end
+    end
+  end
+end

data/app/models/decidim/action_delegator/setting.rb

@@ -13,10 +13,59 @@ module Decidim
       has_many :delegations,
                inverse_of: :setting,
                foreign_key: "decidim_action_delegator_setting_id",
-               dependent: :destroy
+               class_name: "Decidim::ActionDelegator::Delegation",
+               dependent: :restrict_with_error
+      has_many :ponderations,
+               inverse_of: :setting,
+               foreign_key: "decidim_action_delegator_setting_id",
+               class_name: "Decidim::ActionDelegator::Ponderation",
+               dependent: :restrict_with_error
+      has_many :participants,
+               inverse_of: :setting,
+               foreign_key: "decidim_action_delegator_setting_id",
+               class_name: "Decidim::ActionDelegator::Participant",
+               dependent: :restrict_with_error
 
       validates :max_grants, presence: true
       validates :max_grants, numericality: { greater_than: 0 }
+      validates :consultation, uniqueness: true
+
+      enum authorization_method: { phone: 0, email: 1, both: 2 }, _prefix: :verify_with
+
+      delegate :title, to: :consultation
+      delegate :organization, to: :consultation
+
+      default_scope { order(created_at: :desc) }
+
+      def state
+        @state ||= if consultation.end_voting_date < Time.zone.now
+                     :closed
+                   elsif consultation.start_voting_date <= Time.zone.now
+                     :ongoing
+                   else
+                     :pending
+                   end
+      end
+
+      def ongoing?
+        state == :ongoing
+      end
+
+      def editable?
+        state != :closed
+      end
+
+      def destroyable?
+        participants.empty? && ponderations.empty? && delegations.empty?
+      end
+
+      def phone_required?
+        verify_with_phone? || verify_with_both?
+      end
+
+      def email_required?
+        verify_with_email? || verify_with_both?
+      end
     end
   end
 end

data/app/overrides/decidim/consultations/consultations/_question/add_delegation_link.html.erb.deface

@@ -0,0 +1,3 @@
+<!-- insert_after "erb[loud]:contains('display_take_part_button_for(question)')" -->
+
+<%= render partial: "decidim/action_delegator/consultations/link_to_question", locals: { question: question } %>

data/app/overrides/decidim/consultations/consultations/_regular_questions/remove_highlighted_scopes.html.erb.deface

@@ -0,0 +1,4 @@
+<!-- replace 'h3.heading6' -->
+
+<% next if current_consultation.highlighted_scope == questions.first.scope %>
+<h3 class="heading6"><%= translated_attribute questions&.first&.scope&.name %></h3>

data/app/overrides/decidim/consultations/question_multiple_votes/_form/add_delegation_notice.html.erb.deface

@@ -0,0 +1,8 @@
+<!-- insert_before ".card__content.multiple_votes_form" -->
+
+<% if delegation %>
+  <div class="delegation-callout callout warning">
+    <p><%= t "action_delegator.delegations_modal.callout", scope: "decidim" %> <strong><%= delegation.granter.name %></strong></p>
+  </div>
+  <%= hidden_field_tag :decidim_consultations_delegation_id, delegation.id %>
+<% end %>

data/app/overrides/decidim/consultations/questions/_vote_button/add_delegations_link.html.erb.deface

@@ -0,0 +1,3 @@
+<!-- insert_before "erb[silent]:contains('elsif question.consultation.active?')" -->
+
+<%= render partial: "decidim/action_delegator/consultations/questions/link_to_delegations", locals: { question: question } %>

data/app/overrides/decidim/consultations/questions/_vote_button/add_modal.html.erb.deface

@@ -0,0 +1,3 @@
+<!-- insert_before "erb[loud]:contains('javascript_pack_tag')" -->
+
+<%= render partial: "decidim/action_delegator/consultations/questions/delegations_modal", locals: { question: question } %>

data/app/overrides/decidim/consultations/questions/_vote_button/replace_delegation_to_multivote_link.html.erb.deface

@@ -0,0 +1,8 @@
+<!-- replace_contents "erb[silent]:contains('if question.multiple?')" 
+     closing_selector "erb[silent]:contains('else')" -->
+
+<%= link_to decidim_consultations.question_question_multiple_votes_path(question, delegation: 0),
+      class: "card__button button expanded",
+      id: "multivote_button" do %>
+  <div class="vote-button-caption"><%= t "questions.vote_button.vote", scope: "decidim" %></div>
+<% end %>

data/app/overrides/decidim/consultations/questions/_vote_modal/add_delegation_callout.html.erb.deface

@@ -0,0 +1,3 @@
+<!-- insert_after ".reveal__header" -->
+
+<%= render partial: "decidim/action_delegator/consultations/questions/callout", locals: { consultation: question.consultation } %>

data/app/overrides/decidim/consultations/questions/_vote_modal_confirm/add_delegation_callout.html.erb.deface

@@ -0,0 +1,3 @@
+<!-- insert_after ".reveal__header" -->
+
+<%= render partial: "decidim/action_delegator/consultations/questions/callout", locals: { consultation: question.consultation } %>

data/app/overrides/decidim/consultations/questions/_vote_modal_confirm/add_hidden_field.html.erb.deface

@@ -0,0 +1,3 @@
+<!-- insert_after "erb[loud]:contains('form.hidden_field :decidim_consultations_response_id')" -->
+
+<%= hidden_field_tag :decidim_consultations_delegation_id, nil, id: "decidim_consultations_delegation_id" %>

data/app/overrides/layouts/decidim/admin/remove_deprecation.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+Deface::Override.new(virtual_path: "layouts/decidim/admin/consultations",
+                     name: "remove_deprecation_warning",
+                     remove: ".callout.warning",
+                     disabled: !Decidim::ActionDelegator.remove_consultation_deprecation_warning)
+Deface::Override.new(virtual_path: "layouts/decidim/admin/consultation",
+                     name: "remove_deprecation_warning",
+                     remove: ".callout.warning",
+                     disabled: !Decidim::ActionDelegator.remove_consultation_deprecation_warning)

data/app/packs/entrypoints/decidim_action_delegator_questions.js

@@ -1,3 +1,5 @@
+import "src/decidim/action_delegator/questions.js";
+
 require.context("../images", true)
 
 import "entrypoints/decidim_action_delegator.scss";

data/app/packs/src/decidim/action_delegator/questions.js

@@ -0,0 +1,27 @@
+$(() => {
+  const 
+      delegationCallouts = $(".delegation-callout"),
+      delegationCalloutsMessage = $(".delegation-callout-message"),
+      delegationDialog = $("#delegations-modal"),
+      delegationField = $("#decidim_consultations_delegation_id"),
+      delegationVoteButtons = $(".delegation-vote-button"),
+      delegationsButton = $("#delegations-button"),
+      voteButton = $("#vote_button"),
+      voteDialog = $("#question-vote-modal");
+
+  delegationsButton.click(() => {
+    delegationDialog.foundation("open");
+  });
+
+  delegationVoteButtons.click((evt) => {
+    delegationDialog.foundation("close");
+    voteDialog.foundation("open");
+    delegationField.val($(evt.currentTarget).data("delegation-id"));
+    delegationCalloutsMessage.text($(evt.currentTarget).data("delegation-granter-name"));
+    delegationCallouts.removeClass("is-hidden");
+  });
+
+  voteButton.click(() => {
+    delegationCallouts.addClass("is-hidden");
+  });
+});

data/app/packs/stylesheets/decidim/action_delegator/questions.scss

@@ -1,10 +1,11 @@
 .delegations-notice {
   a {
+    display: block;
     color: white;
-    background:rgba(0,0,0,0.5);
+    background: rgba(0, 0, 0, .5);
     line-height: 1;
     text-align: center;
-    padding: 0.5em;
+    padding: .5em;
   }
 }
 
@@ -13,7 +14,7 @@
     a {
       color: var(--secondary);
       font-weight: 600;
-      background:transparent;
+      background: transparent;
     }
   }
 }

data/app/permissions/concerns/decidim/action_delegator/consultations/permissions_override.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ActionDelegator
+    module Consultations
+      module PermissionsOverride
+        extend ActiveSupport::Concern
+
+        included do
+          private
+
+          # Overrides Decidim::Consultations::Permissions to account for delegation votes
+          def allowed_public_action?
+            return unless permission_action.scope == :public
+            return unless permission_action.subject == :question
+
+            # check if question has been limited by admins first
+            return unless authorized? :vote
+
+            case permission_action.action
+            when :vote
+              toggle_allow(question.can_be_voted_by?(user) || can_be_delegated?(user))
+            when :unvote
+              toggle_allow(question.can_be_unvoted_by?(user))
+            end
+          end
+
+          def can_be_delegated?(user)
+            Delegation.granted_to?(user, question.consultation)
+          end
+        end
+      end
+    end
+  end
+end

data/app/permissions/decidim/action_delegator/permissions.rb

@@ -3,12 +3,12 @@
 module Decidim
   module ActionDelegator
     class Permissions < Decidim::DefaultPermissions
-      SUBJECTS_WHITELIST = [:delegation, :setting, :consultation].freeze
+      SUBJECTS_WHITELIST = [:delegation, :ponderation, :participant, :setting, :consultation].freeze
 
       def permissions
         allowed_delegation_action?
 
-        return permission_action unless user.admin?
+        return permission_action unless user && user.admin?
         return permission_action unless permission_action.scope == :admin
         return permission_action unless action_delegator_subject?
 
@@ -46,6 +46,10 @@ module Decidim
         @delegation ||= context.fetch(:delegation, nil)
       end
 
+      def ponderation
+        @ponderation ||= context.fetch(:ponderation, nil)
+      end
+
       def consultation_results_exports_action?
         permission_action.subject == :consultation && permission_action.action == :export_results
       end

data/app/queries/decidim/action_delegator/delegated_votes_versions.rb

@@ -10,17 +10,11 @@ module Decidim
       end
 
       def query
-        statement = <<-SQL.squish
-          SELECT *
-          FROM versions
-          INNER JOIN decidim_action_delegator_delegations
-            ON decidim_action_delegator_delegations.id = versions.decidim_action_delegator_delegation_id
-          INNER JOIN decidim_action_delegator_settings
-            ON decidim_action_delegator_settings.id = decidim_action_delegator_delegations.decidim_action_delegator_setting_id
-          WHERE decidim_action_delegator_settings.decidim_consultation_id = #{consultation.id}
-        SQL
-
-        ActiveRecord::Base.connection.execute(statement).to_a
+        PaperTrail::Version
+          .joins("INNER JOIN decidim_action_delegator_delegations ON decidim_action_delegator_delegations.id = versions.decidim_action_delegator_delegation_id")
+          .joins("INNER JOIN decidim_action_delegator_settings ON decidim_action_delegator_settings.id = decidim_action_delegator_delegations.decidim_action_delegator_setting_id")
+          .where(decidim_action_delegator_settings: { decidim_consultation_id: consultation.id })
+          .order("versions.created_at ASC")
       end
 
       private

data/app/queries/decidim/action_delegator/organization_settings.rb

@@ -13,6 +13,12 @@ module Decidim
           .merge(organization_consultations)
       end
 
+      def active
+        Setting
+          .joins(:consultation)
+          .merge(organization_consultations.active)
+      end
+
       private
 
       attr_reader :organization

data/app/queries/decidim/action_delegator/responses_by_membership.rb

@@ -3,14 +3,6 @@
 module Decidim
   module ActionDelegator
     # Returns total votes of each response by memberships' type and weight.
-    #
-    # This query completely relies on the schema of the `metadata` of the relevant
-    # `decidim_authorizations` records, which is expected to be like:
-    #
-    #   "{ membership_type: '',   membership_weight: '' }"
-    #
-    # Note that although we assume `membership_type` to be a string and `membership_weight` to be an
-    # integer, there are no implications in the code for their actual data types.
     class ResponsesByMembership < Rectify::Query
       DEFAULT_METADATA = I18n.t("decidim.admin.consultations.results.default_metadata")
 
@@ -23,8 +15,8 @@ module Decidim
           .select(
             responses[:decidim_consultations_questions_id],
             responses[:title],
-            membership(:type),
-            membership(:weight),
+            coalesce(Ponderation.arel_table[:name], default_metadata).as("membership_type"),
+            coalesce(Ponderation.arel_table[:weight], 1).as("membership_weight"),
             votes_count
           )
           .group(
@@ -40,17 +32,8 @@ module Decidim
 
       attr_reader :relation
 
-      def membership(field)
-        full_field = "membership_#{field}"
-        coalesce(sql(full_field), default_metadata).as(full_field)
-      end
-
-      def memberships
-        Arel::Table.new(:memberships)
-      end
-
       def default_metadata
-        sql("'#{DEFAULT_METADATA}'")
+        sql(ActiveRecord::Base.sanitize_sql(["?", DEFAULT_METADATA]))
       end
 
       def votes_count

data/app/queries/decidim/action_delegator/sum_of_membership_weight.rb

@@ -35,12 +35,8 @@ module Decidim
         Decidim::Consultations::Response.arel_table
       end
 
-      def authorizations
-        Decidim::Authorization.arel_table
-      end
-
       def votes_count
-        field = Arel.sql("membership_weight")
+        field = Ponderation.arel_table[:weight]
         VotesCountAggregation.new(field, "votes_count").to_sql
       end
     end

data/app/queries/decidim/action_delegator/sum_of_weights.rb

@@ -16,7 +16,7 @@ module Decidim
       attr_reader :consultation
 
       def published_questions_responses
-        VotedWithDirectVerification.new(
+        VotedWithPonderations.new(
           PublishedResponses.new(consultation).query
         ).query
       end

data/app/queries/decidim/action_delegator/type_and_weight.rb

@@ -8,7 +8,7 @@ module Decidim
       end
 
       def query
-        relation = VotedWithDirectVerification.new(published_questions_responses).query
+        relation = VotedWithPonderations.new(published_questions_responses).query
         ResponsesByMembership.new(relation).query
       end
 

data/app/queries/decidim/action_delegator/voted_with_ponderations.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ActionDelegator
+    class VotedWithPonderations < Rectify::Query
+      def initialize(relation)
+        @relation = relation
+      end
+
+      def query
+        relation
+          .joins(:votes)
+          .joins(ponderation_sql)
+      end
+
+      private
+
+      attr_reader :relation
+
+      def ponderation_sql
+        <<~SQL.squish
+          LEFT OUTER JOIN "decidim_action_delegator_settings" ON "decidim_action_delegator_settings"."decidim_consultation_id" = "decidim_consultations_questions"."decidim_consultation_id"
+          LEFT OUTER JOIN "decidim_action_delegator_participants"  ON "decidim_action_delegator_participants"."decidim_action_delegator_setting_id" = "decidim_action_delegator_settings"."id"
+                                                                  AND "decidim_action_delegator_participants"."decidim_user_id" = "decidim_consultations_votes"."decidim_author_id"
+          LEFT OUTER JOIN "decidim_action_delegator_ponderations"  ON "decidim_action_delegator_ponderations"."id" = "decidim_action_delegator_participants"."decidim_action_delegator_ponderation_id"
+        SQL
+      end
+    end
+  end
+end

data/app/services/decidim/action_delegator/csv_importer.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ActionDelegator
+    class CsvImporter
+      include Decidim::FormFactory
+
+      def initialize(csv_file, current_user, current_setting)
+        @csv_file = csv_file
+        @current_user = current_user
+        @current_setting = current_setting
+      end
+
+      def import!
+        import_summary = {
+          total_rows: 0,
+          imported_rows: 0,
+          error_rows: [],
+          skipped_rows: [],
+          details_csv_path: nil
+        }
+
+        details_csv_file = File.join(File.dirname(@csv_file), "details.csv")
+
+        i = 1
+        csv = CSV.new(@csv_file, headers: true, col_sep: ",")
+
+        CSV.open(details_csv_file, "wb") do |details_csv|
+          while (row = csv.shift).present?
+            i += 1
+
+            params = extract_params(row)
+
+            next if row&.empty?
+
+            handle_form_validity(row, details_csv, import_summary, i) if process(row, params, details_csv, import_summary, i)
+          end
+        end
+
+        import_summary[:total_rows] = i - 1
+        import_summary[:details_csv_path] = details_csv_file
+
+        import_summary
+      end
+
+      def handle_skipped_row(row, details_csv, import_summary, row_number, reason)
+        import_summary[:skipped_rows] << { row_number: row_number - 1 }
+        row["reason"] = reason
+        details_csv << row
+      end
+
+      def handle_import_error(row, details_csv, import_summary, row_number, error_messages)
+        import_summary[:error_rows] << { row_number: row_number - 1, error_messages: error_messages }
+        row["reason"] = error_messages
+        details_csv << row
+      end
+
+      def handle_form_validity(row, details_csv, import_summary, row_number)
+        raise NotImplementedError
+      end
+
+      def generate_info_message(mismatch_fields)
+        with_mismatched_fields = mismatch_fields.present? ? I18n.t("decidim.action_delegator.participants_csv_importer.import.with_mismatched_fields", fields: mismatch_fields) : ""
+        I18n.t("decidim.action_delegator.participants_csv_importer.import.skip_import_info", with_mismatched_fields: with_mismatched_fields)
+      end
+
+      def headers(csv, details_csv)
+        headers = csv.first.headers
+        headers << I18n.t("decidim.action_delegator.participants_csv_importer.import.error_field")
+        details_csv << headers
+      end
+
+      def invalid_email?(email)
+        email.blank? || !email.match?(::Devise.email_regexp)
+      end
+
+      def process(row)
+        raise NotImplementedError
+      end
+
+      def extract_params
+        raise NotImplementedError
+      end
+    end
+  end
+end