decidim-budgets 0.23.0 → 0.24.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 077d69766f3c2f74c8cfd5086383104ccdb406f05d58248ac11c4a93ea6bed0c
-  data.tar.gz: 957fb8550045fdf6acf9fe3453083698deedeb09632e2c7be628574446fd3a60
+  metadata.gz: 41710b06043e856a900ffaa5f04509ba3ac513e9e9bd0e3c95dfd6fa5cd6c9e3
+  data.tar.gz: d232449475a2e39087ce38fd9b265e7a689ef1e3b4c50860a304857df109b720
 SHA512:
-  metadata.gz: 328372626474416b447a01819af4236c6f23a2f87db34c93de38f874a9f753b0d328693a68bcdbad6e64a7f3a621e8b493aa040ba6096d128db6e94f607e7d3f
-  data.tar.gz: ae2d589d569d8e51355e6f928e9185d9cb0728f1667de5d34029e39bbf6a6465b8f77947a6d0314159a2edb36877aae5af3703786749075ad94de621c80ff913
+  metadata.gz: 38699120554e836883325bb833b07bea0471d8793271342f88a5c09bd8335ced004bb6c8f1428cfafc8b14ff078d3659e1639f5fd1cb6193488c9f27c475eed9
+  data.tar.gz: 96404bf36a1032fcc72cdebfddc5f90520a495bf8023ad595c44c456a15f9f4f89e556b31ed891952c251afcc9fccca6f1623e83ad8e3c5821dfd811a0b1278c

data/app/assets/javascripts/decidim/budgets/projects.js.es6

@@ -6,22 +6,31 @@ $(() => {
   const $budgetSummaryTotal = $(".budget-summary__total");
   const $budgetExceedModal = $("#budget-excess");
   const $budgetSummary = $(".budget-summary__progressbox");
-  const totalBudget = parseInt($budgetSummaryTotal.attr("data-total-budget"), 10);
+  const totalAllocation = parseInt($budgetSummaryTotal.attr("data-total-allocation"), 10);
 
   const cancelEvent = (event) => {
     event.stopPropagation();
     event.preventDefault();
   };
 
+  const allowExitFrom = ($el) => {
+    if ($el.parents("#loginModal").length > 0) {
+      return true;
+    } else if ($el.parents("#authorizationModal").length > 0) {
+      return true;
+    }
+
+    return false;
+  }
+
   $projects.on("click", ".budget-list__action", (event) => {
-    const currentBudget = parseInt($budgetSummary.attr("data-current-budget"), 10);
+    const currentAllocation = parseInt($budgetSummary.attr("data-current-allocation"), 10);
     const $currentTarget = $(event.currentTarget);
-    const projectBudget = parseInt($currentTarget.attr("data-budget"), 10);
+    const projectAllocation = parseInt($currentTarget.attr("data-allocation"), 10);
 
     if ($currentTarget.attr("disabled")) {
       cancelEvent(event);
-
-    } else if (($currentTarget.attr("data-add") === "true") && ((currentBudget + projectBudget) > totalBudget)) {
+    } else if (($currentTarget.attr("data-add") === "true") && ((currentAllocation + projectAllocation) > totalAllocation)) {
       $budgetExceedModal.foundation("toggle");
       cancelEvent(event);
     }
@@ -30,22 +39,30 @@ $(() => {
   if ($("#order-progress [data-toggle=budget-confirm]").length > 0) {
     const safeUrl = $(".budget-summary").attr("data-safe-url").split("?")[0];
     $(document).on("click", "a", (event) => {
-      window.exitUrl = event.currentTarget.href;
+      if (allowExitFrom($(event.currentTarget))) {
+        window.exitUrl = null;
+      } else {
+        window.exitUrl = event.currentTarget.href;
+      }
     });
     $(document).on("submit", "form", (event) => {
-      window.exitUrl = event.currentTarget.action;
+      if (allowExitFrom($(event.currentTarget))) {
+        window.exitUrl = null;
+      } else {
+        window.exitUrl = event.currentTarget.action;
+      }
     });
 
-    window.onbeforeunload = () => {
-      const currentBudget = parseInt($budgetSummary.attr("data-current-budget"), 10);
+    window.addEventListener("beforeunload", (event) => {
+      const currentAllocation = parseInt($budgetSummary.attr("data-current-allocation"), 10);
       const exitUrl = window.exitUrl;
       window.exitUrl = null;
 
-      if (currentBudget === 0 || (exitUrl && exitUrl.startsWith(safeUrl))) {
-        return null;
+      if (currentAllocation === 0 || (exitUrl && exitUrl.startsWith(safeUrl))) {
+        return;
       }
 
-      return "";
-    }
+      event.returnValue = true;
+    });
   }
 });

data/app/cells/decidim/budgets/limit_announcement_cell.rb

@@ -20,7 +20,7 @@ module Decidim
         return if vote_allowed?(budget)
         return if voted?(budget)
 
-        discardable.any? || !vote_allowed?(budget, false)
+        discardable.any? || !vote_allowed?(budget, consider_progress: false)
       end
 
       def announcement_args

data/app/cells/decidim/budgets/project_list_item/project_data_vote_button.erb

@@ -7,6 +7,7 @@
         add: !resource_added?,
         disable: true,
         budget: model.budget_amount,
+        allocation: resource_allocation,
         "redirect-url": resource_path
       },
       disabled: vote_button_disabled?,

data/app/cells/decidim/budgets/project_list_item_cell.rb

@@ -28,6 +28,10 @@ module Decidim
         current_order && current_order.projects.include?(model)
       end
 
+      def resource_allocation
+        current_order.allocation_for(model)
+      end
+
       def data_class
         [].tap do |list|
           list << "budget-list__data--added" if can_have_order? && resource_added?

data/app/commands/decidim/budgets/admin/import_proposals_to_budgets.rb

@@ -60,7 +60,14 @@ module Decidim
         end
 
         def proposals
-          Decidim::Proposals::Proposal.where(component: origin_component).where(state: "accepted")
+          return all_proposals if form.scope_id.blank?
+
+          all_proposals.where(decidim_scope_id: form.scope_id)
+        end
+
+        def all_proposals
+          Decidim::Proposals::Proposal.where(component: origin_component)
+                                      .where(state: :accepted)
         end
 
         def origin_component

data/app/controllers/decidim/budgets/admin/budgets_controller.rb

@@ -5,7 +5,8 @@ module Decidim
     module Admin
       # This controller allows the create or update a budget.
       class BudgetsController < Admin::ApplicationController
-        helper_method :budgets, :budget
+        helper_method :budgets, :budget, :finished_orders, :pending_orders,
+                      :users_with_pending_orders, :users_with_finished_orders
 
         def new
           enforce_permission_to :create, :budget
@@ -76,6 +77,26 @@ module Decidim
         def budget
           @budget ||= budgets.find_by(id: params[:id])
         end
+
+        def orders
+          @orders ||= Order.where(decidim_budgets_budget_id: budgets)
+        end
+
+        def pending_orders
+          orders.pending
+        end
+
+        def finished_orders
+          orders.finished
+        end
+
+        def users_with_pending_orders
+          orders.pending.pluck(:decidim_user_id).uniq
+        end
+
+        def users_with_finished_orders
+          orders.finished.pluck(:decidim_user_id).uniq
+        end
       end
     end
   end

data/app/controllers/decidim/budgets/orders_controller.rb

@@ -43,7 +43,7 @@ module Decidim
       end
 
       def redirect_path
-        if params.dig(:return_to) == "budget"
+        if params[:return_to] == "budget"
           budget_path(budget)
         else
           budgets_path

data/app/forms/decidim/budgets/admin/component_form.rb

@@ -7,7 +7,10 @@ module Decidim
       # to a participatory process from the admin panel.
       #
       class ComponentForm < Decidim::Admin::ComponentForm
-        validate :budget_voting_rule_enabled_setting, :budget_voting_rule_value_setting
+        validate :budget_voting_rule_enabled_setting,
+                 :budget_voting_rule_threshold_value_setting,
+                 :budget_voting_rule_minimum_value_setting,
+                 :budget_voting_rule_projects_value_setting
 
         private
 
@@ -16,27 +19,71 @@ module Decidim
         def budget_voting_rule_enabled_setting
           return unless manifest&.name == :budgets
 
+          rule_settings = [
+            :vote_rule_threshold_percent_enabled,
+            :vote_rule_minimum_budget_projects_enabled,
+            :vote_rule_selected_projects_enabled
+          ]
+          active_rules = rule_settings.select { |key| settings.public_send(key) == true }
           i18n_error_scope = "decidim.components.budgets.settings.global.form.errors"
-          if settings.vote_rule_threshold_percent_enabled.blank? && settings.vote_rule_minimum_budget_projects_enabled.blank?
-            settings.errors.add(:vote_rule_threshold_percent_enabled, I18n.t(:budget_voting_rule_required, scope: i18n_error_scope))
-            settings.errors.add(:vote_rule_minimum_budget_projects_enabled, I18n.t(:budget_voting_rule_required, scope: i18n_error_scope))
+          if active_rules.blank?
+            rule_settings.each do |key|
+              settings.errors.add(key, I18n.t(:budget_voting_rule_required, scope: i18n_error_scope))
+            end
           end
 
-          if settings.vote_rule_threshold_percent_enabled && settings.vote_rule_minimum_budget_projects_enabled
-            settings.errors.add(:vote_rule_threshold_percent_enabled, I18n.t(:budget_voting_rule_only_one, scope: i18n_error_scope))
-            settings.errors.add(:vote_rule_minimum_budget_projects_enabled, I18n.t(:budget_voting_rule_only_one, scope: i18n_error_scope))
+          if active_rules.length > 1
+            rule_settings.each do |key|
+              settings.errors.add(key, I18n.t(:budget_voting_rule_only_one, scope: i18n_error_scope))
+            end
           end
         end
 
         # - the value must be a valid number
-        def budget_voting_rule_value_setting
+        def budget_voting_rule_threshold_value_setting
           return unless manifest&.name == :budgets
+          return unless settings.vote_rule_threshold_percent_enabled
 
           invalid_percent_number = settings.vote_threshold_percent.blank? || settings.vote_threshold_percent.to_i.negative?
-          settings.errors.add(:vote_threshold_percent) if settings.vote_rule_threshold_percent_enabled && invalid_percent_number
+          settings.errors.add(:vote_threshold_percent) if invalid_percent_number
+        end
+
+        def budget_voting_rule_minimum_value_setting
+          return unless manifest&.name == :budgets
+          return unless settings.vote_rule_minimum_budget_projects_enabled
 
           invalid_minimum_number = settings.vote_minimum_budget_projects_number.blank? || (settings.vote_minimum_budget_projects_number.to_i < 1)
-          settings.errors.add(:vote_minimum_budget_projects_number) if settings.vote_rule_minimum_budget_projects_enabled && invalid_minimum_number
+          settings.errors.add(:vote_minimum_budget_projects_number) if invalid_minimum_number
+        end
+
+        def budget_voting_rule_projects_value_setting
+          return unless manifest&.name == :budgets
+          return unless settings.vote_rule_selected_projects_enabled
+
+          budget_voting_projects_value_setting_min
+          budget_voting_projects_value_setting_max
+          budget_voting_projects_value_setting_both
+        end
+
+        def budget_voting_projects_value_setting_min
+          return if settings.vote_selected_projects_minimum.present? && settings.vote_selected_projects_minimum.to_i >= 0
+
+          settings.errors.add(:vote_selected_projects_minimum)
+        end
+
+        def budget_voting_projects_value_setting_max
+          return if settings.vote_selected_projects_maximum.present? && settings.vote_selected_projects_maximum.to_i.positive?
+
+          settings.errors.add(:vote_selected_projects_maximum)
+        end
+
+        def budget_voting_projects_value_setting_both
+          return if settings.errors[:vote_selected_projects_minimum].present?
+          return if settings.errors[:vote_selected_projects_maximum].present?
+          return if settings.vote_selected_projects_maximum >= settings.vote_selected_projects_minimum
+
+          settings.errors.add(:vote_selected_projects_minimum)
+          settings.errors.add(:vote_selected_projects_maximum)
         end
       end
     end

data/app/forms/decidim/budgets/admin/project_form.rb

@@ -6,6 +6,7 @@ module Decidim
       # This class holds a Form to create/update projects from Decidim's admin panel.
       class ProjectForm < Decidim::Form
         include TranslatableAttributes
+        include AttachmentAttributes
         include TranslationsHelper
         include Decidim::ApplicationHelper
 
@@ -17,10 +18,10 @@ module Decidim
         attribute :decidim_category_id, Integer
         attribute :proposal_ids, Array[Integer]
         attribute :attachment, AttachmentForm
-        attribute :photos, Array[String]
-        attribute :add_photos, Array
         attribute :selected, Boolean
 
+        attachments_attribute :photos
+
         validates :title, translatable_presence: true
         validates :description, translatable_presence: true
         validates :budget_amount, presence: true, numericality: { greater_than: 0 }

data/app/forms/decidim/budgets/admin/project_import_proposals_form.rb

@@ -9,12 +9,15 @@ module Decidim
         mimic :proposals_import
 
         attribute :origin_component_id, Integer
+        attribute :scope_id, Integer
         attribute :default_budget, Integer
         attribute :import_all_accepted_proposals, Boolean
 
         validates :origin_component_id, :origin_component, :current_component, presence: true
         validates :import_all_accepted_proposals, allow_nil: false, acceptance: true
         validates :default_budget, presence: true, numericality: { greater_than: 0 }
+        validates :scope, presence: true, if: ->(form) { form.scope_id.present? }
+        validates :scope_id, scope_belongs_to_component: true, if: ->(form) { form.scope_id.present? }
 
         def origin_component
           @origin_component ||= origin_components.find_by(id: origin_component_id)
@@ -30,6 +33,14 @@ module Decidim
           end
         end
 
+        def scope
+          @scope ||= @scope_id ? current_component.scopes.find_by(id: @scope_id) : current_component.scope
+        end
+
+        def scope_id
+          @scope_id || scope&.id
+        end
+
         def budget
           @budget ||= context[:budget]
         end

data/app/helpers/decidim/budgets/projects_helper.rb

@@ -20,7 +20,11 @@ module Decidim
       def current_order_budget_percent_minimum
         return 0 if current_order.minimum_projects_rule?
 
-        component_settings.vote_threshold_percent
+        if current_order.projects_rule?
+          (current_order.minimum_projects.to_f / current_order.maximum_projects)
+        else
+          component_settings.vote_threshold_percent
+        end
       end
 
       def budget_confirm_disabled_attr
@@ -36,6 +40,46 @@ module Decidim
       def current_order_can_be_checked_out?
         current_order&.can_checkout?
       end
+
+      def current_rule_explanation
+        return unless current_order
+
+        if current_order.projects_rule?
+          if current_order.minimum_projects.positive? && current_order.minimum_projects < current_order.maximum_projects
+            t(
+              ".projects_rule.instruction",
+              minimum_number: current_order.minimum_projects,
+              maximum_number: current_order.maximum_projects
+            )
+          else
+            t(".projects_rule_maximum_only.instruction", maximum_number: current_order.maximum_projects)
+          end
+        elsif current_order.minimum_projects_rule?
+          t(".minimum_projects_rule.instruction", minimum_number: current_order.minimum_projects)
+        else
+          t(".vote_threshold_percent_rule.instruction", minimum_budget: budget_to_currency(current_order.minimum_budget))
+        end
+      end
+
+      def current_rule_description
+        return unless current_order
+
+        if current_order.projects_rule?
+          if current_order.minimum_projects.positive? && current_order.minimum_projects < current_order.maximum_projects
+            t(
+              ".projects_rule.description",
+              minimum_number: current_order.minimum_projects,
+              maximum_number: current_order.maximum_projects
+            )
+          else
+            t(".projects_rule_maximum_only.description", maximum_number: current_order.maximum_projects)
+          end
+        elsif current_order.minimum_projects_rule?
+          t(".minimum_projects_rule.description", minimum_number: current_order.minimum_projects)
+        else
+          t(".vote_threshold_percent_rule.description", minimum_budget: budget_to_currency(current_order.minimum_budget))
+        end
+      end
     end
   end
 end

data/app/models/decidim/budgets/order.rb

@@ -18,24 +18,76 @@ module Decidim
       validates :budget, presence: true
       validate :user_belongs_to_organization
 
-      validates :total_budget, numericality: {
-        greater_than_or_equal_to: :minimum_budget
-      }, if: :checked_out?
+      # Rules active for the budget threshold and minimum budgets rules.
+      with_options if: -> { !projects_rule? && checked_out? } do
+        validates :total_budget, numericality: {
+          greater_than_or_equal_to: :minimum_budget
+        }
+      end
+      with_options unless: :projects_rule? do
+        validates :total_budget, numericality: {
+          less_than_or_equal_to: :maximum_budget
+        }
+      end
 
-      validates :total_budget, numericality: {
-        less_than_or_equal_to: :maximum_budget
-      }
+      # Rules active for the minimum projects rule.
+      with_options if: -> { minimum_projects_rule? && checked_out? } do
+        validates :total_projects, numericality: {
+          greater_than_or_equal_to: :minimum_projects
+        }
+      end
 
-      validate :reach_minimum_projects, if: :checked_out?
+      # Rules active for the projects rule.
+      with_options if: -> { projects_rule? && checked_out? } do
+        validates :total_projects, numericality: {
+          greater_than_or_equal_to: :minimum_projects
+        }
+
+        validates :total_projects, numericality: {
+          less_than_or_equal_to: :maximum_projects
+        }
+      end
 
       scope :finished, -> { where.not(checked_out_at: nil) }
       scope :pending, -> { where(checked_out_at: nil) }
 
+      # Public: Returns the available budget allocation the user is able to
+      # allocate to this order or the maximum amount of projects to be selected
+      # in case the project selection voting is enabled.
+      def available_allocation
+        return maximum_projects if projects_rule?
+
+        maximum_budget
+      end
+
+      # Public: Returns the numeric amount the given project should allocate
+      # from the total available allocation when it is added to the order. The
+      # allocation is normally the project's budget but for project selection
+      # voting, the allocation is one.
+      def allocation_for(project)
+        return 1 if projects_rule?
+
+        project.budget_amount
+      end
+
       # Public: Returns the sum of project budgets
       def total_budget
         projects.to_a.sum(&:budget_amount)
       end
 
+      # Public: Returns the count of projects
+      def total_projects
+        projects.count
+      end
+
+      # Public: For budget voting returns the total budget and for project
+      # selection voting, returns the amount of selected projects.
+      def total
+        return total_projects if projects_rule?
+
+        total_budget
+      end
+
       # Public: Returns true if the order has been checked out
       def checked_out?
         checked_out_at.present?
@@ -43,22 +95,28 @@ module Decidim
 
       # Public: Check if the order total budget is enough to checkout
       def can_checkout?
-        if minimum_projects_rule?
-          projects.count >= minimum_projects
+        if projects_rule?
+          total_projects >= minimum_projects && total_projects <= maximum_projects
+        elsif minimum_projects_rule?
+          total_projects >= minimum_projects
         else
           total_budget.to_f >= minimum_budget
         end
       end
 
       # Public: Returns the order budget percent from the settings total budget
+      # or the progress for selected projects if the selected project rule is
+      # enabled
       def budget_percent
-        (total_budget.to_f / budget.total_budget.to_f) * 100
+        return (total_projects.to_f / maximum_projects) * 100 if projects_rule?
+
+        (total_budget.to_f / budget.total_budget) * 100
       end
 
       # Public: Returns the required minimum budget to checkout
       def minimum_budget
         return 0 unless budget
-        return 0 if minimum_projects_rule?
+        return 0 if minimum_projects_rule? || projects_rule?
 
         budget.total_budget.to_f * (budget.settings.vote_threshold_percent.to_f / 100)
       end
@@ -77,11 +135,35 @@ module Decidim
         budget.settings.vote_rule_minimum_budget_projects_enabled
       end
 
+      # Public: Returns true if the project voting rule is enabled
+      def projects_rule?
+        return unless budget
+
+        budget.settings.vote_rule_selected_projects_enabled
+      end
+
       # Public: Returns the required minimum projects to checkout
       def minimum_projects
         return 0 unless budget
 
-        budget.settings.vote_minimum_budget_projects_number
+        if minimum_projects_rule?
+          budget.settings.vote_minimum_budget_projects_number
+        elsif projects_rule?
+          budget.settings.vote_selected_projects_minimum
+        else
+          0
+        end
+      end
+
+      # Public: Returns the required maximum projects to checkout
+      def maximum_projects
+        return nil unless budget
+
+        if projects_rule?
+          budget.settings.vote_selected_projects_maximum
+        else
+          0
+        end
       end
 
       def self.user_collection(user)
@@ -98,8 +180,9 @@ module Decidim
                                .where(budget: {
                                         decidim_components: { id: component.id }
                                       })
+                               .group(:decidim_user_id)
                                .pluck(:decidim_user_id)
-                               .flatten.compact.uniq
+                               .flatten.compact
       end
 
       private
@@ -111,12 +194,6 @@ module Decidim
 
         errors.add(:user, :invalid) unless user.organization == organization
       end
-
-      def reach_minimum_projects
-        return unless minimum_projects_rule?
-
-        errors.add(:projects, :invalid) if minimum_projects > projects.count
-      end
     end
   end
 end