decidim-lausanne-budgets 0.1.0

data/lib/decidim/lausanne/budgets/test/factories.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+require "decidim/faker/localized"
+require "decidim/dev"
+
+require "decidim/core/test/factories"
+require "decidim/participatory_processes/test/factories"
+
+FactoryBot.define do
+  factory :budgets_component, parent: :component do
+    name { Decidim::Components::Namer.new(participatory_space.organization.available_locales, :budgets).i18n_name }
+    manifest_name { :budgets }
+    participatory_space { create(:participatory_process, :with_steps, organization: organization) }
+
+    trait :with_vote_threshold_percent do
+      transient do
+        vote_rule_threshold_percent_enabled { true }
+        vote_rule_minimum_budget_projects_enabled { false }
+        vote_rule_projects_enabled { false }
+        vote_threshold_percent { 70 }
+      end
+
+      settings do
+        {
+          vote_rule_threshold_percent_enabled: vote_rule_threshold_percent_enabled,
+          vote_rule_minimum_budget_projects_enabled: vote_rule_minimum_budget_projects_enabled,
+          vote_rule_selected_projects_enabled: vote_rule_projects_enabled,
+          vote_threshold_percent: vote_threshold_percent
+        }
+      end
+    end
+
+    trait :with_minimum_budget_projects do
+      transient do
+        vote_rule_threshold_percent_enabled { false }
+        vote_rule_minimum_budget_projects_enabled { true }
+        vote_rule_projects_enabled { false }
+        vote_minimum_budget_projects_number { 3 }
+      end
+
+      settings do
+        {
+          vote_rule_threshold_percent_enabled: vote_rule_threshold_percent_enabled,
+          vote_rule_minimum_budget_projects_enabled: vote_rule_minimum_budget_projects_enabled,
+          vote_rule_selected_projects_enabled: vote_rule_projects_enabled,
+          vote_minimum_budget_projects_number: vote_minimum_budget_projects_number
+        }
+      end
+    end
+
+    trait :with_budget_projects_range do
+      transient do
+        vote_rule_threshold_percent_enabled { false }
+        vote_rule_minimum_budget_projects_enabled { false }
+        vote_rule_projects_enabled { true }
+        vote_minimum_budget_projects_number { 3 }
+        vote_maximum_budget_projects_number { 6 }
+      end
+
+      settings do
+        {
+          vote_rule_threshold_percent_enabled: vote_rule_threshold_percent_enabled,
+          vote_rule_minimum_budget_projects_enabled: vote_rule_minimum_budget_projects_enabled,
+          vote_rule_selected_projects_enabled: vote_rule_projects_enabled,
+          vote_selected_projects_minimum: vote_minimum_budget_projects_number,
+          vote_selected_projects_maximum: vote_maximum_budget_projects_number
+        }
+      end
+    end
+
+    trait :with_votes_disabled do
+      step_settings do
+        {
+          participatory_space.active_step.id => {
+            votes: :disabled
+          }
+        }
+      end
+    end
+
+    trait :with_show_votes_enabled do
+      step_settings do
+        {
+          participatory_space.active_step.id => {
+            show_votes: true
+          }
+        }
+      end
+    end
+
+    trait :with_voting_finished do
+      step_settings do
+        {
+          participatory_space.active_step.id => {
+            votes: :finished,
+            show_votes: true
+          }
+        }
+      end
+    end
+  end
+
+  factory :budget, class: "Decidim::Lausanne::Budgets::LausanneBudget" do
+    title { generate_localized_title }
+    description { Decidim::Faker::Localized.wrapped("<p>", "</p>") { generate_localized_title } }
+    total_budget { 100_000_000 }
+    component { create(:budgets_component) }
+
+    trait :with_projects do
+      transient do
+        projects_number { 2 }
+      end
+
+      after(:create) do |budget, evaluator|
+        create_list(:project, evaluator.projects_number, budget: budget)
+      end
+    end
+  end
+
+  factory :project, class: "Decidim::Lausanne::Budgets::Project" do
+    title { generate_localized_title }
+    description { Decidim::Faker::Localized.wrapped("<p>", "</p>") { generate_localized_title } }
+    budget_amount { Faker::Number.number(digits: 8) }
+    budget { create(:budget) }
+
+    trait :selected do
+      selected_at { Time.current }
+    end
+
+    trait :with_photos do
+      transient do
+        photos_number { 2 }
+      end
+
+      after :create do |project, evaluator|
+        project.attachments = create_list(:attachment, evaluator.photos_number, :with_image, attached_to: project)
+      end
+    end
+  end
+  factory :user_record, calss: "Decidim::Lausanne::Budgets::UserRecord" do
+    first_name { "John" }
+    last_name { "Doe" }
+    birthdate { "13/12/1995" }
+    trait :with_user do
+      user { create(:user, organization: budget.component.organization) }
+    end
+  end
+  factory :order, class: "Decidim::Lausanne::Budgets::Order" do
+    budget { create(:budget) }
+    user { create(:user_record, organization: component.organization) }
+
+    trait :with_projects do
+      transient do
+        projects_number { 2 }
+      end
+
+      after(:create) do |order, evaluator|
+        project_budget = (order.maximum_budget / evaluator.projects_number).to_i
+        order.projects << create_list(:project, evaluator.projects_number, budget_amount: project_budget, budget: order.budget)
+        order.save!
+      end
+    end
+  end
+
+  factory :line_item, class: "Decidim::Lausanne::Budgets::LineItem" do
+    order
+    project { create(:project, budget: order.budget) }
+  end
+end

data/lib/decidim/lausanne/budgets/version.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Lausanne
+    module Budgets
+      def self.version
+        "0.1.0"
+      end
+
+      def self.decidim_version
+        [">= 0.26","<0.28"].freeze
+      end
+    end
+  end
+end

data/lib/decidim/lausanne/budgets/workflows/all.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Lausanne
+    module Budgets
+      module Workflows
+        # This Workflow allows users to vote in all budgets.
+        class All < Base
+          # No budget is highlighted for this workflow.
+          def highlighted?(_resource)
+            false
+          end
+
+          # Users can vote in all budgets with this workflow.
+          def vote_allowed?(resource, _consider_progress: true)
+            !voted?(resource)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/decidim/lausanne/budgets/workflows/base.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Lausanne
+    module Budgets
+      module Workflows
+        # This is the base Workflow class.
+        class Base
+          def initialize(budgets_component, user)
+            @budgets_component = budgets_component
+            @user = user
+          end
+
+          # Public: Checks if the component has only one budget resource.
+          #
+          # Returns Boolean.
+          def single?
+            budgets.one?
+          end
+
+          # Public: Return the lonenly budget resource of the component
+          #
+          # Returns an ActiveRecord.
+          def single
+            budgets.first if single?
+          end
+
+          # Public: Decides if the given resource should be highlighted.
+          # This method must be overwritten for each Workflow class.
+          # - resource: the budget resource to consider
+          #
+          # Returns Boolean.
+          def highlighted?(_resource)
+            raise StandardError, "Not implemented"
+          end
+
+          # Public: Decides if the given user should be allowed to vote in the given resource.
+          # This method must be overwritten for each Workflow class.
+          # - resource: the budget resource to consider
+          # - consider_progress: should consider user orders in progress?
+          #                      Using `false` allow UI to offer users to discard votes in progress to start voting in another resource.
+          #
+          # Returns Boolean.
+          def vote_allowed?(_resource, _consider_progress: true)
+            raise StandardError, "Not implemented"
+          end
+
+          attr_accessor :budgets_component, :user
+
+          # Public: Return the list of budget resources that are highlighted for the user.
+          #
+          # Returns Array.
+          def highlighted
+            @highlighted ||= budgets.select { |resource| highlighted?(resource) }
+          end
+
+          # Public: Return the list of budgets where the user is allowed to vote.
+          #
+          # Returns Array.
+          def allowed
+            @allowed ||= budgets.select { |resource| vote_allowed?(resource) }
+          end
+
+          # Public: Return the list of budget resources where the user has voted.
+          #
+          # Returns Array.
+          def voted
+            @voted ||= orders.values.map { |order_info| order_info[:order].budget if order_info[:status] == :voted }.compact
+          end
+
+          # Public: Return the list of budget resources where the user has orders in progress.
+          #
+          # Returns Array.
+          def progress
+            @progress ||= orders.values.map { |order_info| order_info[:order].budget if order_info[:status] == :progress }.compact
+          end
+
+          # Public: Return the list of budget resources where the user could discard their order to vote in other components.
+          #
+          # Returns Array.
+          def discardable
+            progress
+          end
+
+          # Public: Return the status for the given budget resource and the user
+          # - resource: the budget resource to consider
+          #
+          # Returns Boolean.
+          def status(resource)
+            orders.dig(resource.id, :status) || (vote_allowed?(resource) ? :allowed : :not_allowed)
+          end
+
+          # Public: Return if the user can vote in the given budget resource
+          # - resource: the budgets resource to consider
+          #
+          # Returns Boolean.
+          def voted?(resource)
+            orders.dig(resource.id, :status) == :voted
+          end
+
+          # Public: Return if the user has a pending order in the given budget resource
+          # - resource: the budgets resource to consider
+          #
+          # Returns Boolean.
+          def progress?(resource)
+            orders.dig(resource.id, :status) == :progress
+          end
+
+          # Public: Return if the user has reached the voting limit on budgets
+          #
+          # Returns Boolean.
+          def limit_reached?
+            (allowed - progress).none?
+          end
+
+          # Public: Return all the budgets resources that should be taken into account for the budgets component
+          #
+          # Returns an ActiveRecord::Relation.
+          def budgets
+            @budgets ||= Decidim::Lausanne::Budgets::LausanneBudget.where(component: budgets_component).order(weight: :asc)
+          end
+
+          protected
+
+            def orders
+              if Decidim.version.to_f >= 0.27
+                @orders ||= Decidim::Lausanne::Budgets::Order.includes(:projects).joins(:user_record).where(decidim_lausanne_user_records: {user: user}, loz_budgets_budget_id: budgets).map do |order|
+                  [order.loz_budgets_budget_id, { order: order, status: order.checked_out? ? :voted : :progress }] if order.projects.any?
+                end.compact.to_h
+              else
+                @orders ||= Decidim::Lausanne::Budgets::Order.includes(:projects).where(user: user, loz_budgets_budget_id: budgets).map do |order|
+                  [order.loz_budgets_budget_id, { order: order, status: order.checked_out? ? :voted : :progress }] if order.projects.any?
+                end.compact.to_h
+              end
+            end
+        end
+      end
+    end
+  end
+end

data/lib/decidim/lausanne/budgets/workflows/one.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Lausanne
+    module Budgets
+      module Workflows
+        # This Workflow allows users to vote in any budget, but only in one.
+        class One < Base
+          # No budget resource is highlighted for this workflow.
+          def highlighted?(_resource)
+            false
+          end
+
+          # Users can vote in any budget with this workflow, but only in one.
+          def vote_allowed?(resource, consider_progress: true)
+            return false if voted.any?
+
+            if consider_progress
+              progress?(resource) || progress.none?
+            else
+              true
+            end
+          end
+
+          # Public: Returns a list of budgets where the user can discard their order to vote in another.
+          #
+          # Returns Array.
+          def discardable
+            progress + voted
+          end
+        end
+      end
+    end
+  end
+end

data/lib/decidim/lausanne/budgets/workflows.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "decidim/lausanne/budgets/workflows/base"
+require "decidim/lausanne/budgets/workflows/one"
+require "decidim/lausanne/budgets/workflows/all"
+
+module Decidim
+  module Lausanne
+    module Budgets
+      # Public: Stores the array of available workflows
+      def self.workflows
+        @workflows ||= {
+          one: Workflows::One,
+          all: Workflows::All
+        }
+      end
+    end
+  end
+end

data/lib/decidim/lausanne/budgets.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "decidim/lausanne/budgets/current_user_record_middleware"
+require "decidim/lausanne/budgets/workflows"
+require "decidim/lausanne/budgets/admin"
+require "decidim/lausanne/budgets/engine"
+require "decidim/lausanne/budgets/admin_engine"
+require "decidim/lausanne/budgets/component"
+
+module Decidim
+  module Lausanne
+    # Base module for this engine.
+    module Budgets
+      autoload :ProjectSerializer, "decidim/lausanne/budgets/project_serializer"
+    end
+  end
+end