decidim-budgets 0.19.0 → 0.22.0

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

@@ -6,6 +6,9 @@ module Decidim
       # This command is executed when the user changes a Project from the admin
       # panel.
       class UpdateProject < Rectify::Command
+        include ::Decidim::AttachmentMethods
+        include ::Decidim::GalleryMethods
+
         # Initializes an UpdateProject Command.
         #
         # form - The form from which to get the data.
@@ -13,6 +16,7 @@ module Decidim
         def initialize(form, project)
           @form = form
           @project = project
+          @attached_to = project
         end
 
         # Updates the project if valid.
@@ -21,9 +25,16 @@ module Decidim
         def call
           return broadcast(:invalid) if form.invalid?
 
+          if process_gallery?
+            build_gallery
+            return broadcast(:invalid) if gallery_invalid?
+          end
+
           transaction do
             update_project
             link_proposals
+            create_gallery if process_gallery?
+            photo_cleanup!
           end
 
           broadcast(:ok)
@@ -31,7 +42,7 @@ module Decidim
 
         private
 
-        attr_reader :project, :form
+        attr_reader :project, :form, :gallery
 
         def update_project
           Decidim.traceability.update!(

data/app/commands/decidim/budgets/checkout.rb

@@ -28,9 +28,10 @@ module Decidim
       private
 
       def checkout!
-        return unless @order
+        return unless @order && @order.valid?
 
         @order.with_lock do
+          SendOrderSummaryJob.perform_later(@order)
           @order.checked_out_at = Time.current
           @order.save
         end

data/app/controllers/concerns/decidim/budgets/needs_current_order.rb

@@ -15,12 +15,16 @@ module Decidim
         #
         # Returns an Order.
         def current_order
-          @current_order ||= Order.includes(:projects).find_by(user: current_user, component: current_component)
+          @current_order ||= Order.includes(:projects).find_or_initialize_by(user: current_user, component: current_component)
         end
 
         def current_order=(order)
           @current_order = order
         end
+
+        def persisted_current_order
+          current_order if current_order&.persisted?
+        end
       end
     end
   end

data/app/controllers/concerns/decidim/budgets/orderable.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  module Budgets
+    # Common logic to sorting resources
+    module Orderable
+      extend ActiveSupport::Concern
+
+      included do
+        include Decidim::Orderable
+
+        private
+
+        # Available orders based on enabled settings
+        def available_orders
+          @available_orders ||= begin
+            available_orders = []
+            available_orders << "random" if voting_is_open? || !votes_are_visible?
+            available_orders << "most_voted" if votes_are_visible?
+            available_orders += %w(highest_cost lowest_cost)
+            available_orders
+          end
+        end
+
+        def default_order
+          available_orders.first
+        end
+
+        def voting_is_open?
+          current_settings.votes_enabled?
+        end
+
+        def votes_are_visible?
+          current_settings.show_votes?
+        end
+
+        def reorder(projects)
+          case order
+          when "highest_cost"
+            projects.order(budget: :desc)
+          when "lowest_cost"
+            projects.order(budget: :asc)
+          when "most_voted"
+            if votes_are_visible?
+              ids = projects.sort_by(&:confirmed_orders_count).map(&:id).reverse
+              projects.ordered_ids(ids)
+            else
+              projects
+            end
+          when "random"
+            projects.order_randomly(random_seed)
+          else
+            projects
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -5,12 +5,16 @@ module Decidim
     module Admin
       # This controller allows an admin to manage projects from a Participatory Process
       class ProjectsController < Admin::ApplicationController
-        helper_method :projects, :finished_orders, :pending_orders
+        include Decidim::ApplicationHelper
+        include Decidim::Proposals::Admin::Picker
+
+        helper_method :projects, :finished_orders, :pending_orders, :present
 
         def new
           enforce_permission_to :create, :project
-
-          @form = form(ProjectForm).instance
+          @form = form(ProjectForm).from_params(
+            attachment: form(AttachmentForm).instance
+          )
         end
 
         def create
@@ -33,13 +37,12 @@ module Decidim
 
         def edit
           enforce_permission_to :update, :project, project: project
-
           @form = form(ProjectForm).from_model(project)
+          @form.attachment = form(AttachmentForm).instance
         end
 
         def update
           enforce_permission_to :update, :project, project: project
-
           @form = form(ProjectForm).from_params(params)
 
           UpdateProject.call(@form, project) do

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

@@ -12,7 +12,7 @@ module Decidim
         enforce_permission_to :vote, :project, project: project
 
         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 }

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

@@ -7,13 +7,17 @@ module Decidim
       include FilterResource
       include NeedsCurrentOrder
       include Orderable
+      include Decidim::Budgets::Orderable
 
       helper_method :projects, :project
 
       private
 
       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
@@ -27,11 +31,27 @@ module Decidim
       def default_filter_params
         {
           search_text: "",
-          scope_id: "",
-          category_id: ""
+          scope_id: default_filter_scope_params,
+          category_id: default_filter_category_params
         }
       end
 
+      def default_filter_category_params
+        return "all" unless current_component.participatory_space.categories.any?
+
+        ["all"] + current_component.participatory_space.categories.map { |category| category.id.to_s }
+      end
+
+      def default_filter_scope_params
+        return "all" unless current_component.participatory_space.scopes.any?
+
+        if current_component.participatory_space.scope
+          ["all", current_component.participatory_space.scope.id] + current_component.participatory_space.scope.children.map { |scope| scope.id.to_s }
+        else
+          %w(all global) + current_component.participatory_space.scopes.map { |scope| scope.id.to_s }
+        end
+      end
+
       def context_params
         { component: current_component, organization: current_organization }
       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

@@ -16,6 +16,9 @@ module Decidim
         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
 
         validates :title, translatable_presence: true
         validates :description, translatable_presence: true
@@ -26,6 +29,8 @@ module Decidim
 
         validate :scope_belongs_to_participatory_space_scope
 
+        validate :notify_missing_attachment_if_errored
+
         delegate :categories, to: :current_component
 
         def map_model(model)
@@ -38,9 +43,8 @@ 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 Category from the decidim_category_id.
@@ -69,6 +73,14 @@ module Decidim
         def scope_belongs_to_participatory_space_scope
           errors.add(:decidim_scope_id, :invalid) if current_participatory_space.out_of_scope?(scope)
         end
+
+        # 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
   end

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

@@ -8,6 +8,7 @@ module Decidim
       include PaginateHelper
       include Decidim::Comments::CommentsHelper
       include ProjectsHelper
+      include Decidim::CheckBoxesTreeHelper
     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
 
@@ -23,6 +36,10 @@ module Decidim
       def current_order_can_be_checked_out?
         current_order&.can_checkout?
       end
+
+      def projects_base_url
+        URI.parse(root_url).tap { |uri| uri.query = uri.fragment = nil } .to_s
+      end
     end
   end
 end

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

data/app/mailers/decidim/budgets/order_summary_mailer.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Budgets
+    class OrderSummaryMailer < Decidim::ApplicationMailer
+      include Decidim::TranslationsHelper
+      include Decidim::SanitizeHelper
+
+      helper Decidim::TranslationsHelper
+
+      # Send an email to an user with the summary of the order.
+      #
+      # order - the order that was just created
+      def order_summary(order)
+        user = order.user
+
+        with_user(user) do
+          @user = user
+          @order = order
+          @space = order.participatory_space
+          @component = order.component
+          @organization = order.participatory_space.organization
+
+          subject = I18n.t(
+            "order_summary.subject",
+            scope: "decidim.budgets.order_summary_mailer",
+            space_name: translated_attribute(@space.title)
+          )
+          mail(to: user.email, subject: subject)
+        end
+      end
+    end
+  end
+end

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

@@ -27,6 +27,8 @@ module Decidim
         less_than_or_equal_to: :maximum_budget
       }
 
+      validate :reach_minimum_projects, if: :checked_out?
+
       scope :finished, -> { where.not(checked_out_at: nil) }
       scope :pending, -> { where(checked_out_at: nil) }
 
@@ -42,7 +44,11 @@ module Decidim
 
       # Public: Check if the order total budget is enough to checkout
       def can_checkout?
-        total_budget.to_f >= minimum_budget
+        if minimum_projects_rule?
+          projects.count >= minimum_projects
+        else
+          total_budget.to_f >= minimum_budget
+        end
       end
 
       # Public: Returns the order budget percent from the settings total budget
@@ -53,6 +59,7 @@ module Decidim
       # Public: Returns the required minimum budget to checkout
       def minimum_budget
         return 0 unless component
+        return 0 if minimum_projects_rule?
 
         component.settings.total_budget.to_f * (component.settings.vote_threshold_percent.to_f / 100)
       end
@@ -64,6 +71,20 @@ module Decidim
         component.settings.total_budget.to_f
       end
 
+      # Public: Returns if it is required a minimum projects limit to checkout
+      def minimum_projects_rule?
+        return unless component
+
+        component.settings.vote_rule_minimum_budget_projects_enabled
+      end
+
+      # Public: Returns the required minimum projects to checkout
+      def minimum_projects
+        return 0 unless component
+
+        component.settings.vote_minimum_budget_projects_number
+      end
+
       def self.user_collection(user)
         where(decidim_user_id: user.id)
       end
@@ -87,6 +108,12 @@ 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