decidim-budgets 0.20.1 → 0.23.1

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

@@ -0,0 +1,36 @@
+# 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
+          @budget = order.budget
+          @space = order.budget.participatory_space
+          @component = order.budget.component
+          @organization = order.budget.participatory_space.organization
+
+          subject = I18n.t(
+            "order_summary.subject",
+            scope: "decidim.budgets.order_summary_mailer",
+            budget_name: translated_attribute(@budget.title),
+            space_name: translated_attribute(@space.title)
+          )
+          mail(to: user.email, subject: subject)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Budgets
+    # The data store for a budget in the Decidim::Budgets component.
+    class Budget < ApplicationRecord
+      include Decidim::Resourceable
+      include Decidim::ScopableResource
+      include Decidim::HasComponent
+      include Decidim::Searchable
+      include Traceable
+      include Loggable
+
+      component_manifest_name "budgets"
+
+      has_many :projects, foreign_key: "decidim_budgets_budget_id", class_name: "Decidim::Budgets::Project", inverse_of: :budget, dependent: :destroy
+      has_many :orders, foreign_key: "decidim_budgets_budget_id", class_name: "Decidim::Budgets::Order", inverse_of: :budget, dependent: :destroy
+
+      delegate :participatory_space, :manifest, :settings, to: :component
+
+      searchable_fields({
+                          participatory_space: { component: :participatory_space },
+                          A: :title,
+                          D: [:description, :total_budget]
+                        },
+                        index_on_create: ->(budget) { budget.visible? },
+                        index_on_update: ->(budget) { budget.visible? })
+
+      def self.log_presenter_class_for(_log)
+        Decidim::Budgets::AdminLog::BudgetPresenter
+      end
+    end
+  end
+end

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

@@ -2,19 +2,19 @@
 
 module Decidim
   module Budgets
-    # The data store for a LineItem in the Decidim::Budgets component. It describes an
+    # The data store for a LineItem in the Budget resource. It describes an
     # association between an order and a project.
     class LineItem < Budgets::ApplicationRecord
       belongs_to :order, class_name: "Decidim::Budgets::Order", foreign_key: "decidim_order_id"
       belongs_to :project, class_name: "Decidim::Budgets::Project", foreign_key: "decidim_project_id"
 
       validates :order, uniqueness: { scope: :project }
-      validate :same_component
+      validate :same_budget
 
-      def same_component
+      def same_budget
         return unless order && project
 
-        errors.add(:order, :invalid) unless order.component == project.component
+        errors.add(:order, :invalid) unless order.budget == project.budget
       end
     end
   end

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

@@ -5,18 +5,17 @@ module Decidim
     # The data store for a Order in the Decidim::Budgets component. It is unique for each
     # user and component and contains a collection of projects
     class Order < Budgets::ApplicationRecord
-      include Decidim::HasComponent
       include Decidim::DataPortability
       include Decidim::NewsletterParticipant
 
-      component_manifest_name "budgets"
-
       belongs_to :user, class_name: "Decidim::User", foreign_key: "decidim_user_id"
-
+      belongs_to :budget, foreign_key: "decidim_budgets_budget_id", class_name: "Decidim::Budgets::Budget", inverse_of: :orders
+      has_one :component, through: :budget, foreign_key: "decidim_component_id", class_name: "Decidim::Component"
       has_many :line_items, class_name: "Decidim::Budgets::LineItem", foreign_key: "decidim_order_id", dependent: :destroy
       has_many :projects, through: :line_items, class_name: "Decidim::Budgets::Project", foreign_key: "decidim_project_id"
 
-      validates :user, uniqueness: { scope: :component }
+      validates :user, uniqueness: { scope: :budget }
+      validates :budget, presence: true
       validate :user_belongs_to_organization
 
       validates :total_budget, numericality: {
@@ -27,12 +26,14 @@ 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) }
 
       # Public: Returns the sum of project budgets
       def total_budget
-        projects.to_a.sum(&:budget)
+        projects.to_a.sum(&:budget_amount)
       end
 
       # Public: Returns true if the order has been checked out
@@ -42,26 +43,45 @@ 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
       def budget_percent
-        (total_budget.to_f / component.settings.total_budget.to_f) * 100
+        (total_budget.to_f / budget.total_budget.to_f) * 100
       end
 
       # Public: Returns the required minimum budget to checkout
       def minimum_budget
-        return 0 unless component
+        return 0 unless budget
+        return 0 if minimum_projects_rule?
 
-        component.settings.total_budget.to_f * (component.settings.vote_threshold_percent.to_f / 100)
+        budget.total_budget.to_f * (budget.settings.vote_threshold_percent.to_f / 100)
       end
 
       # Public: Returns the required maximum budget to checkout
       def maximum_budget
-        return 0 unless component
+        return 0 unless budget
+
+        budget.total_budget.to_f
+      end
+
+      # Public: Returns if it is required a minimum projects limit to checkout
+      def minimum_projects_rule?
+        return unless budget
 
-        component.settings.total_budget.to_f
+        budget.settings.vote_rule_minimum_budget_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
       end
 
       def self.user_collection(user)
@@ -73,20 +93,30 @@ module Decidim
       end
 
       def self.newsletter_participant_ids(component)
-        Decidim::Budgets::Order.where(component: component).joins(:component)
-                               .finished
-                               .pluck(:decidim_user_id).flatten.compact.uniq
+        Decidim::Budgets::Order.finished
+                               .joins(budget: [:component])
+                               .where(budget: {
+                                        decidim_components: { id: component.id }
+                                      })
+                               .pluck(:decidim_user_id)
+                               .flatten.compact.uniq
       end
 
       private
 
       def user_belongs_to_organization
-        organization = component&.organization
+        organization = budget.try(:component).try(:organization)
 
         return if !user || !organization
 
         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

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

@@ -6,8 +6,7 @@ module Decidim
     # title, description and any other useful information to render a custom project.
     class Project < Budgets::ApplicationRecord
       include Decidim::Resourceable
-      include Decidim::HasComponent
-      include Decidim::ScopableComponent
+      include Decidim::ScopableResource
       include Decidim::HasCategory
       include Decidim::HasAttachments
       include Decidim::HasAttachmentCollections
@@ -18,11 +17,17 @@ module Decidim
       include Decidim::Loggable
       include Decidim::Randomable
       include Decidim::Searchable
+      include Decidim::TranslatableResource
 
-      component_manifest_name "budgets"
+      translatable_fields :title, :description
+
+      belongs_to :budget, foreign_key: "decidim_budgets_budget_id", class_name: "Decidim::Budgets::Budget", inverse_of: :projects
+      has_one :component, through: :budget, foreign_key: "decidim_component_id", class_name: "Decidim::Component"
       has_many :line_items, class_name: "Decidim::Budgets::LineItem", foreign_key: "decidim_project_id", dependent: :destroy
       has_many :orders, through: :line_items, foreign_key: "decidim_project_id", class_name: "Decidim::Budgets::Order"
 
+      delegate :organization, :participatory_space, to: :component
+
       searchable_fields(
         scope_id: :decidim_scope_id,
         participatory_space: { component: :participatory_space },
@@ -31,10 +36,26 @@ module Decidim
         datetime: :created_at
       )
 
+      def self.ordered_ids(ids)
+        # Make sure each ID in the matching text has a "," character as their
+        # delimiter. Otherwise e.g. ID 2 would match ID "26" in the original
+        # array. This is why we search for match ",2," instead to get the actual
+        # position for ID 2.
+        order(Arel.sql("position(concat(',', id::text, ',') in ',#{ids.join(",")},')"))
+      end
+
       def self.log_presenter_class_for(_log)
         Decidim::Budgets::AdminLog::ProjectPresenter
       end
 
+      def polymorphic_resource_path(url_params)
+        ::Decidim::ResourceLocatorPresenter.new([budget, self]).path(url_params)
+      end
+
+      def polymorphic_resource_url(url_params)
+        ::Decidim::ResourceLocatorPresenter.new([budget, self]).url(url_params)
+      end
+
       # Public: Overrides the `commentable?` Commentable concern method.
       def commentable?
         component.settings.comments_enabled?
@@ -67,7 +88,19 @@ module Decidim
 
       # Public: Whether the object can have new comments or not.
       def user_allowed_to_comment?(user)
-        can_participate_in_space?(user)
+        component.can_participate_in_space?(user)
+      end
+
+      # Public: Checks if the project has been selected or not.
+      #
+      # Returns Boolean.
+      def selected?
+        selected_at.present?
+      end
+
+      # Public: Returns the attachment context for this record.
+      def attachment_context
+        :admin
       end
     end
   end

data/app/permissions/decidim/budgets/admin/permissions.rb

@@ -5,18 +5,27 @@ module Decidim
     module Admin
       class Permissions < Decidim::DefaultPermissions
         def permissions
-          # The public part needs to be implemented yet
           return permission_action if permission_action.scope != :admin
 
-          return permission_action unless [:project, :projects].include?(permission_action.subject)
-
-          case permission_action.action
-          when :create
-            permission_action.allow!
-          when :import_proposals
-            permission_action.allow!
-          when :update, :destroy
-            permission_action.allow! if project.present?
+          case permission_action.subject
+          when :budget
+            case permission_action.action
+            when :create, :read
+              allow!
+            when :update
+              toggle_allow(budget)
+            when :delete, :publish, :unpublish
+              toggle_allow(budget && budget.projects.empty?)
+            end
+          when :project, :projects
+            case permission_action.action
+            when :create
+              permission_action.allow!
+            when :import_proposals
+              permission_action.allow!
+            when :update, :destroy
+              permission_action.allow! if project.present?
+            end
           end
 
           permission_action
@@ -24,6 +33,10 @@ module Decidim
 
         private
 
+        def budget
+          @budget ||= context.fetch(:budget, nil)
+        end
+
         def project
           @project ||= context.fetch(:project, nil)
         end

data/app/permissions/decidim/budgets/permissions.rb

@@ -10,15 +10,19 @@ module Decidim
         return Decidim::Budgets::Admin::Permissions.new(user, permission_action, context).permissions if permission_action.scope == :admin
         return permission_action if permission_action.scope != :public
 
-        return permission_action if permission_action.subject != :project
+        return permission_action unless [:project, :order].include? permission_action.subject
 
-        case permission_action.action
-        when :vote
-          can_vote_project?(project || order&.projects&.first)
-        when :report
-          permission_action.allow!
+        if permission_action.subject == :project
+          case permission_action.action
+          when :vote
+            can_vote?(false) if can_vote_project?(project || order&.projects&.first)
+          when :report
+            permission_action.allow!
+          end
         end
 
+        can_vote?(true) if permission_action.action == :create && permission_action.subject == :order
+
         permission_action
       end
 
@@ -32,6 +36,24 @@ module Decidim
         @order ||= context.fetch(:order, nil)
       end
 
+      def budget
+        @budget ||= context.fetch(:budget, nil)
+      end
+
+      def workflow
+        @workflow ||= context.fetch(:workflow, nil)
+      end
+
+      def can_vote?(active_allow)
+        is_allowed = workflow.vote_allowed?(budget)
+
+        if !is_allowed
+          disallow!
+        elsif active_allow
+          allow!
+        end
+      end
+
       def can_vote_project?(a_project)
         is_allowed = a_project && authorized?(:vote, resource: project)
 

data/app/presenters/decidim/budgets/admin_log/budget_presenter.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Budgets
+    module AdminLog
+      # This class holds the logic to present a `Decidim::Budgets::Budget`
+      # for the `AdminLog` log.
+      #
+      # Usage should be automatic and you shouldn't need to call this class
+      # directly, but here's an example:
+      #
+      #    action_log = Decidim::ActionLog.last
+      #    view_helpers # => this comes from the views
+      #    BudgetPresenter.new(action_log, view_helpers).present
+      class BudgetPresenter < Decidim::Log::BasePresenter
+        private
+
+        def action_string
+          case action
+          when "create", "delete", "update"
+            "decidim.budgets.admin_log.budget.#{action}"
+          else
+            super
+          end
+        end
+
+        def diff_fields_mapping
+          {
+            title: :i18n,
+            weight: :integer,
+            description: :i18n,
+            total_budget: :currency
+          }
+        end
+
+        def i18n_labels_scope
+          "activemodel.attributes.budget"
+        end
+      end
+    end
+  end
+end

data/app/queries/decidim/budgets/filtered_projects.rb

@@ -27,11 +27,19 @@ module Decidim
       # Finds the Projects scoped to an array of components and filtered
       # by a range of dates.
       def query
-        projects = Decidim::Budgets::Project.where(component: @components)
+        projects = Decidim::Budgets::Project.where(budget: budgets)
         projects = projects.where("created_at >= ?", @start_at) if @start_at.present?
         projects = projects.where("created_at <= ?", @end_at) if @end_at.present?
         projects
       end
+
+      private
+
+      attr_reader :components
+
+      def budgets
+        @budgets ||= Decidim::Budgets::Budget.where(component: components).order(weight: :asc)
+      end
     end
   end
 end