decidim-budgets 0.20.0 → 0.23.1.rc1

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

@@ -8,6 +8,29 @@ module Decidim
     # Note that it inherits from `Decidim::Components::BaseController`, which
     # override its layout and provide all kinds of useful methods.
     class ApplicationController < Decidim::Components::BaseController
+      helper_method :current_workflow, :voting_finished?, :voting_open?
+
+      def current_workflow
+        @current_workflow ||= Decidim::Budgets.workflows[workflow_name].new(current_component, current_user)
+      end
+
+      def voting_open?
+        current_settings.votes == "enabled"
+      end
+
+      def voting_finished?
+        current_settings.votes == "finished"
+      end
+
+      def show_votes_count?
+        current_settings.show_votes?
+      end
+
+      private
+
+      def workflow_name
+        @workflow_name ||= current_component.settings.workflow.to_sym
+      end
     end
   end
 end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Budgets
+    # Exposes the budget resources so users can participate on them
+    class BudgetsController < Decidim::Budgets::ApplicationController
+      def index
+        redirect_to budget_projects_path(current_workflow.single) if current_workflow.single?
+      end
+
+      def show
+        raise ActionController::RoutingError, "Not Found" unless budget
+
+        redirect_to budget_projects_path(budget)
+      end
+
+      private
+
+      def budget
+        @budget ||= Budget.where(component: current_component).includes(:projects).find_by(id: params[:id])
+      end
+    end
+  end
+end

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

@@ -6,16 +6,16 @@ module Decidim
     class LineItemsController < Decidim::Budgets::ApplicationController
       include NeedsCurrentOrder
 
-      helper_method :project
+      helper_method :budget, :project
 
       def create
-        enforce_permission_to :vote, :project, project: project
+        enforce_permission_to :vote, :project, project: project, budget: budget, workflow: current_workflow
 
         respond_to do |format|
-          AddLineItem.call(current_order, project, current_user) do
+          AddLineItem.call(persisted_current_order, project, current_user) do
             on(:ok) do |order|
               self.current_order = order
-              format.html { redirect_to :back }
+              format.html { redirect_back(fallback_location: budget_path(budget)) }
               format.js { render "update_budget" }
             end
 
@@ -30,7 +30,7 @@ module Decidim
         respond_to do |format|
           RemoveLineItem.call(current_order, project) do
             on(:ok) do |_order|
-              format.html { redirect_to :back }
+              format.html { redirect_back(fallback_location: budget_path(budget)) }
               format.js { render "update_budget" }
             end
 
@@ -44,7 +44,11 @@ module Decidim
       private
 
       def project
-        @project ||= Project.find_by(id: params[:project_id], component: current_component)
+        @project ||= Project.includes(:budget).find_by(id: params[:project_id], decidim_budgets_budget_id: params[:budget_id])
+      end
+
+      def budget
+        @budget ||= project.budget
       end
     end
   end

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

@@ -7,17 +7,17 @@ module Decidim
       include NeedsCurrentOrder
 
       def checkout
-        enforce_permission_to :vote, :project, order: current_order
+        enforce_permission_to :vote, :project, order: current_order, budget: budget, workflow: current_workflow
 
-        Checkout.call(current_order, current_component) do
+        Checkout.call(current_order) do
           on(:ok) do
             flash[:notice] = I18n.t("orders.checkout.success", scope: "decidim")
-            redirect_to projects_path
+            redirect_to budgets_path
           end
 
           on(:invalid) do
             flash.now[:alert] = I18n.t("orders.checkout.error", scope: "decidim")
-            redirect_to projects_path
+            redirect_to budgets_path
           end
         end
       end
@@ -26,15 +26,29 @@ module Decidim
         CancelOrder.call(current_order) do
           on(:ok) do
             flash[:notice] = I18n.t("orders.destroy.success", scope: "decidim")
-            redirect_to projects_path
+            redirect_to redirect_path
           end
 
           on(:invalid) do
             flash.now[:alert] = I18n.t("orders.destroy.error", scope: "decidim")
-            redirect_to projects_path
+            redirect_to redirect_path
           end
         end
       end
+
+      private
+
+      def budget
+        @budget ||= Budget.find_by(id: params[:budget_id])
+      end
+
+      def redirect_path
+        if params.dig(:return_to) == "budget"
+          budget_path(budget)
+        else
+          budgets_path
+        end
+      end
     end
   end
 end

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

@@ -6,18 +6,34 @@ module Decidim
     class ProjectsController < Decidim::Budgets::ApplicationController
       include FilterResource
       include NeedsCurrentOrder
-      include Orderable
+      include Decidim::Budgets::Orderable
 
-      helper_method :projects, :project
+      helper_method :projects, :project, :budget
+
+      def index
+        raise ActionController::RoutingError, "Not Found" unless budget
+      end
+
+      def show
+        raise ActionController::RoutingError, "Not Found" unless budget
+        raise ActionController::RoutingError, "Not Found" unless project
+      end
 
       private
 
+      def budget
+        @budget ||= Budget.where(component: current_component).includes(:projects).find_by(id: params[:budget_id])
+      end
+
       def projects
-        @projects ||= search.results.order_randomly(random_seed).page(params[:page]).per(current_component.settings.projects_per_page)
+        return @projects if @projects
+
+        @projects = search.results.page(params[:page]).per(current_component.settings.projects_per_page)
+        @projects = reorder(@projects)
       end
 
       def project
-        @project ||= search.results.find(params[:id])
+        @project ||= Project.find_by(id: params[:id])
       end
 
       def search_klass
@@ -27,13 +43,18 @@ module Decidim
       def default_filter_params
         {
           search_text: "",
-          scope_id: "",
-          category_id: ""
+          status: default_filter_status_params,
+          scope_id: default_filter_scope_params,
+          category_id: default_filter_category_params
         }
       end
 
+      def default_filter_status_params
+        voting_finished? ? %w(selected) : %w(all)
+      end
+
       def context_params
-        { component: current_component, organization: current_organization }
+        { budget: budget, component: current_component, organization: current_organization }
       end
     end
   end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Budgets
+    module Admin
+      # This class holds a Form to create/update budgets from Decidim's admin panel.
+      class BudgetForm < Decidim::Form
+        include TranslatableAttributes
+
+        mimic :budget
+
+        translatable_attribute :title, String
+        attribute :weight, Integer, default: 0
+        translatable_attribute :description, String
+        attribute :total_budget, Integer, default: 0
+        attribute :decidim_scope_id, Integer
+
+        validates :title, translatable_presence: true
+        validates :weight, :total_budget, numericality: { greater_than_or_equal_to: 0 }
+        validates :scope, presence: true, if: ->(form) { form.decidim_scope_id.present? }
+        validates :decidim_scope_id, scope_belongs_to_component: true, if: ->(form) { form.decidim_scope_id.present? }
+
+        # Finds the Scope from the given decidim_scope_id, uses the compoenent scope if missing.
+        #
+        # Returns a Decidim::Scope
+        def scope
+          @scope ||= @decidim_scope_id ? current_component.scopes.find_by(id: @decidim_scope_id) : current_component.scope
+        end
+
+        # Scope identifier
+        #
+        # Returns the scope identifier related to the meeting
+        def decidim_scope_id
+          @decidim_scope_id || scope&.id
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Budgets
+    module Admin
+      # A form object for the budgets component. Used to attach the component
+      # to a participatory process from the admin panel.
+      #
+      class ComponentForm < Decidim::Admin::ComponentForm
+        validate :budget_voting_rule_enabled_setting, :budget_voting_rule_value_setting
+
+        private
+
+        # Validations on budget settings:
+        # - a voting rule must be enabled.
+        def budget_voting_rule_enabled_setting
+          return unless manifest&.name == :budgets
+
+          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))
+          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))
+          end
+        end
+
+        # - the value must be a valid number
+        def budget_voting_rule_value_setting
+          return unless manifest&.name == :budgets
+
+          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
+
+          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
+        end
+      end
+    end
+  end
+end

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

@@ -12,24 +12,30 @@ module Decidim
         translatable_attribute :title, String
         translatable_attribute :description, String
 
-        attribute :budget, Integer
+        attribute :budget_amount, Integer
         attribute :decidim_scope_id, Integer
         attribute :decidim_category_id, Integer
         attribute :proposal_ids, Array[Integer]
+        attribute :attachment, AttachmentForm
+        attribute :photos, Array[String]
+        attribute :add_photos, Array
+        attribute :selected, Boolean
 
         validates :title, translatable_presence: true
         validates :description, translatable_presence: true
-        validates :budget, presence: true, numericality: { greater_than: 0 }
+        validates :budget_amount, presence: true, numericality: { greater_than: 0 }
 
         validates :category, presence: true, if: ->(form) { form.decidim_category_id.present? }
         validates :scope, presence: true, if: ->(form) { form.decidim_scope_id.present? }
+        validates :decidim_scope_id, scope_belongs_to_component: true, if: ->(form) { form.decidim_scope_id.present? }
 
-        validate :scope_belongs_to_participatory_space_scope
+        validate :notify_missing_attachment_if_errored
 
         delegate :categories, to: :current_component
 
         def map_model(model)
           self.proposal_ids = model.linked_resources(:proposals, "included_proposals").pluck(:id)
+          self.selected = model.selected?
 
           return unless model.categorization
 
@@ -38,9 +44,15 @@ module Decidim
 
         def proposals
           @proposals ||= Decidim.find_resource_manifest(:proposals).try(:resource_scope, current_component)
-                         &.published
+                         &.where(id: proposal_ids)
                          &.order(title: :asc)
-                         &.map { |proposal| [present(proposal).title, proposal.id] }
+        end
+
+        # Finds the Budget from the decidim_budgets_budget_id.
+        #
+        # Returns a Decidim::Budgets:Budget
+        def budget
+          @budget ||= context[:budget]
         end
 
         # Finds the Category from the decidim_category_id.
@@ -50,11 +62,11 @@ module Decidim
           @category ||= categories.find_by(id: decidim_category_id)
         end
 
-        # Finds the Scope from the given decidim_scope_id, uses participatory space scope if missing.
+        # Finds the Scope from the given decidim_scope_id, uses the component scope if missing.
         #
         # Returns a Decidim::Scope
         def scope
-          @scope ||= @decidim_scope_id ? current_participatory_space.scopes.find_by(id: @decidim_scope_id) : current_participatory_space.scope
+          @scope ||= @decidim_scope_id ? current_component.scopes.find_by(id: @decidim_scope_id) : current_component.scope
         end
 
         # Scope identifier
@@ -66,8 +78,12 @@ module Decidim
 
         private
 
-        def scope_belongs_to_participatory_space_scope
-          errors.add(:decidim_scope_id, :invalid) if current_participatory_space.out_of_scope?(scope)
+        # This method will add an error to the `attachment` field only if there's
+        # any error in any other field. This is needed because when the form has
+        # an error, the attachment is lost, so we need a way to inform the user of
+        # this problem.
+        def notify_missing_attachment_if_errored
+          errors.add(:add_photos, :needs_to_be_reattached) if errors.any? && add_photos.present?
         end
       end
     end

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

@@ -29,6 +29,10 @@ module Decidim
             [component.name[I18n.locale.to_s], component.id]
           end
         end
+
+        def budget
+          @budget ||= context[:budget]
+        end
       end
     end
   end

data/app/helpers/decidim/budgets/admin/application_helper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Budgets
+    module Admin
+      # Custom helpers, scoped to the budgets admin engine.
+      #
+      module ApplicationHelper
+        include Decidim::Admin::ResourceScopeHelper
+      end
+    end
+  end
+end

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

@@ -8,6 +8,17 @@ module Decidim
       include PaginateHelper
       include Decidim::Comments::CommentsHelper
       include ProjectsHelper
+      include Decidim::CheckBoxesTreeHelper
+
+      def filter_status_values
+        TreeNode.new(
+          TreePoint.new("", t("decidim.budgets.projects.filters.status_values.all")),
+          [
+            TreePoint.new("selected", t("decidim.budgets.projects.filters.status_values.selected")),
+            TreePoint.new("not_selected", t("decidim.budgets.projects.filters.status_values.not_selected"))
+          ]
+        )
+      end
     end
   end
 end

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

@@ -16,6 +16,19 @@ module Decidim
         current_order&.budget_percent.to_f.floor
       end
 
+      # Return the minimum percentage of the current order budget from the total budget
+      def current_order_budget_percent_minimum
+        return 0 if current_order.minimum_projects_rule?
+
+        component_settings.vote_threshold_percent
+      end
+
+      def budget_confirm_disabled_attr
+        return if current_order_can_be_checked_out?
+
+        %( disabled="disabled" ).html_safe
+      end
+
       # Return true if the current order is checked out
       delegate :checked_out?, to: :current_order, prefix: true, allow_nil: true
 

data/app/jobs/decidim/budgets/send_order_summary_job.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Budgets
+    class SendOrderSummaryJob < ApplicationJob
+      queue_as :default
+
+      def perform(order)
+        return if order&.user&.email.blank?
+
+        OrderSummaryMailer.order_summary(order).deliver_now
+      end
+    end
+  end
+end