decidim-budgets 0.22.0 → 0.23.3

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

@@ -7,14 +7,13 @@ require "decidim/core/test/factories"
 require "decidim/participatory_processes/test/factories"
 
 FactoryBot.define do
-  factory :budget_component, parent: :component 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_total_budget_and_vote_threshold_percent do
+    trait :with_vote_threshold_percent do
       transient do
-        total_budget { 100_000_000 }
         vote_rule_threshold_percent_enabled { true }
         vote_rule_minimum_budget_projects_enabled { false }
         vote_threshold_percent { 70 }
@@ -22,7 +21,6 @@ FactoryBot.define do
 
       settings do
         {
-          total_budget: total_budget,
           vote_rule_threshold_percent_enabled: vote_rule_threshold_percent_enabled,
           vote_rule_minimum_budget_projects_enabled: vote_rule_minimum_budget_projects_enabled,
           vote_threshold_percent: vote_threshold_percent
@@ -30,9 +28,8 @@ FactoryBot.define do
       end
     end
 
-    trait :with_total_budget_and_minimum_budget_projects do
+    trait :with_minimum_budget_projects do
       transient do
-        total_budget { 100_000_000 }
         vote_rule_threshold_percent_enabled { false }
         vote_rule_minimum_budget_projects_enabled { true }
         vote_minimum_budget_projects_number { 3 }
@@ -40,7 +37,6 @@ FactoryBot.define do
 
       settings do
         {
-          total_budget: total_budget,
           vote_rule_threshold_percent_enabled: vote_rule_threshold_percent_enabled,
           vote_rule_minimum_budget_projects_enabled: vote_rule_minimum_budget_projects_enabled,
           vote_minimum_budget_projects_number: vote_minimum_budget_projects_number
@@ -52,7 +48,7 @@ FactoryBot.define do
       step_settings do
         {
           participatory_space.active_step.id => {
-            votes_enabled: false
+            votes: :disabled
           }
         }
       end
@@ -72,7 +68,7 @@ FactoryBot.define do
       step_settings do
         {
           participatory_space.active_step.id => {
-            votes_enabled: false,
+            votes: :finished,
             show_votes: true
           }
         }
@@ -80,20 +76,53 @@ FactoryBot.define do
     end
   end
 
+  factory :budget, class: "Decidim::Budgets::Budget" 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::Budgets::Project" do
     title { generate_localized_title }
     description { Decidim::Faker::Localized.wrapped("<p>", "</p>") { generate_localized_title } }
-    budget { Faker::Number.number(8) }
-    component { create(:budget_component) }
+    budget_amount { Faker::Number.number(8) }
+    budget { create(:budget) }
+
+    trait :selected do
+      selected_at { Time.current }
+    end
   end
 
   factory :order, class: "Decidim::Budgets::Order" do
-    component { create(:budget_component) }
+    budget { create(:budget) }
     user { create(:user, 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::Budgets::LineItem" do
     order
-    project { create(:project, component: order.component) }
+    project { create(:project, budget: order.budget) }
   end
 end

data/lib/decidim/budgets/version.rb

@@ -4,7 +4,7 @@ module Decidim
   # This holds the decidim-budgets version.
   module Budgets
     def self.version
-      "0.22.0"
+      "0.23.3"
     end
   end
 end

data/lib/decidim/budgets/workflows.rb

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

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Decidim
+  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

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

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+module Decidim
+  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::Budgets::Budget.where(component: budgets_component).order(weight: :asc)
+        end
+
+        protected
+
+        def orders
+          @orders ||= Decidim::Budgets::Order.includes(:projects).where(decidim_user_id: user, decidim_budgets_budget_id: budgets).map do |order|
+            [order.decidim_budgets_budget_id, { order: order, status: order.checked_out? ? :voted : :progress }] if order.projects.any?
+          end.compact.to_h
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Decidim
+  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

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: decidim-budgets
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.23.3
 platform: ruby
 authors:
 - Josep Jaume Rey Peroy
 - Marc Riera Casals
 - Oriol Gual Oliva
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-01 00:00:00.000000000 Z
+date: 2021-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: decidim-comments
@@ -18,28 +18,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.22.0
+        version: 0.23.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.22.0
+        version: 0.23.3
 - !ruby/object:Gem::Dependency
   name: decidim-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.22.0
+        version: 0.23.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.22.0
+        version: 0.23.3
 - !ruby/object:Gem::Dependency
   name: kaminari
   requirement: !ruby/object:Gem::Requirement
@@ -80,42 +80,42 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.22.0
+        version: 0.23.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.22.0
+        version: 0.23.3
 - !ruby/object:Gem::Dependency
   name: decidim-dev
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.22.0
+        version: 0.23.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.22.0
+        version: 0.23.3
 - !ruby/object:Gem::Dependency
   name: decidim-proposals
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.22.0
+        version: 0.23.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.22.0
+        version: 0.23.3
 description: A budgets component for decidim's participatory spaces.
 email:
 - josepjaume@gmail.com
@@ -135,11 +135,26 @@ files:
 - app/assets/stylesheets/decidim/budgets/budget/_budget-list.scss
 - app/assets/stylesheets/decidim/budgets/budget/_budget-meter.scss
 - app/assets/stylesheets/decidim/budgets/budget/_progress.scss
+- app/cells/decidim/budgets/base_cell.rb
+- app/cells/decidim/budgets/budget_cell.rb
+- app/cells/decidim/budgets/budget_information_modal/show.erb
+- app/cells/decidim/budgets/budget_information_modal_cell.rb
+- app/cells/decidim/budgets/budget_list_item/show.erb
+- app/cells/decidim/budgets/budget_list_item_cell.rb
+- app/cells/decidim/budgets/budget_m/data.erb
+- app/cells/decidim/budgets/budget_m/footer.erb
+- app/cells/decidim/budgets/budget_m_cell.rb
+- app/cells/decidim/budgets/budgets_header/show.erb
+- app/cells/decidim/budgets/budgets_header_cell.rb
+- app/cells/decidim/budgets/budgets_list/card_list.erb
+- app/cells/decidim/budgets/budgets_list/highlighted.erb
+- app/cells/decidim/budgets/budgets_list/show.erb
+- app/cells/decidim/budgets/budgets_list/voted.erb
+- app/cells/decidim/budgets/budgets_list_cell.rb
+- app/cells/decidim/budgets/limit_announcement_cell.rb
 - app/cells/decidim/budgets/project_cell.rb
 - app/cells/decidim/budgets/project_list_item/project_data.erb
-- app/cells/decidim/budgets/project_list_item/project_data_number.erb
 - app/cells/decidim/budgets/project_list_item/project_data_vote_button.erb
-- app/cells/decidim/budgets/project_list_item/project_data_votes.erb
 - app/cells/decidim/budgets/project_list_item/project_image.erb
 - app/cells/decidim/budgets/project_list_item/project_text.erb
 - app/cells/decidim/budgets/project_list_item/show.erb
@@ -147,10 +162,18 @@ files:
 - app/cells/decidim/budgets/project_m/data.erb
 - app/cells/decidim/budgets/project_m/footer.erb
 - app/cells/decidim/budgets/project_m_cell.rb
+- app/cells/decidim/budgets/project_selected_status_cell.rb
+- app/cells/decidim/budgets/project_tags/show.erb
+- app/cells/decidim/budgets/project_tags_cell.rb
+- app/cells/decidim/budgets/project_voted_hint_cell.rb
+- app/cells/decidim/budgets/project_votes_count_cell.rb
 - app/commands/decidim/budgets/add_line_item.rb
+- app/commands/decidim/budgets/admin/create_budget.rb
 - app/commands/decidim/budgets/admin/create_project.rb
+- app/commands/decidim/budgets/admin/destroy_budget.rb
 - app/commands/decidim/budgets/admin/destroy_project.rb
 - app/commands/decidim/budgets/admin/import_proposals_to_budgets.rb
+- app/commands/decidim/budgets/admin/update_budget.rb
 - app/commands/decidim/budgets/admin/update_project.rb
 - app/commands/decidim/budgets/cancel_order.rb
 - app/commands/decidim/budgets/checkout.rb
@@ -160,39 +183,51 @@ files:
 - app/controllers/decidim/budgets/admin/application_controller.rb
 - app/controllers/decidim/budgets/admin/attachment_collections_controller.rb
 - app/controllers/decidim/budgets/admin/attachments_controller.rb
+- app/controllers/decidim/budgets/admin/budgets_controller.rb
 - app/controllers/decidim/budgets/admin/projects_controller.rb
 - app/controllers/decidim/budgets/admin/proposals_imports_controller.rb
 - app/controllers/decidim/budgets/application_controller.rb
+- app/controllers/decidim/budgets/budgets_controller.rb
 - app/controllers/decidim/budgets/line_items_controller.rb
 - app/controllers/decidim/budgets/orders_controller.rb
 - app/controllers/decidim/budgets/projects_controller.rb
+- app/forms/decidim/budgets/admin/budget_form.rb
 - app/forms/decidim/budgets/admin/component_form.rb
 - app/forms/decidim/budgets/admin/project_form.rb
 - app/forms/decidim/budgets/admin/project_import_proposals_form.rb
+- app/helpers/decidim/budgets/admin/application_helper.rb
 - app/helpers/decidim/budgets/application_helper.rb
 - app/helpers/decidim/budgets/projects_helper.rb
 - app/jobs/decidim/budgets/send_order_summary_job.rb
 - app/mailers/decidim/budgets/order_summary_mailer.rb
 - app/models/decidim/budgets/application_record.rb
+- app/models/decidim/budgets/budget.rb
 - app/models/decidim/budgets/line_item.rb
 - app/models/decidim/budgets/order.rb
 - app/models/decidim/budgets/project.rb
 - app/permissions/decidim/budgets/admin/permissions.rb
 - app/permissions/decidim/budgets/permissions.rb
+- app/presenters/decidim/budgets/admin_log/budget_presenter.rb
 - app/presenters/decidim/budgets/admin_log/project_presenter.rb
 - app/queries/decidim/budgets/filtered_projects.rb
 - app/queries/decidim/budgets/metrics/budget_followers_metric_measure.rb
 - app/queries/decidim/budgets/metrics/budget_participants_metric_measure.rb
 - app/serializers/decidim/budgets/data_portability_budgets_order_serializer.rb
 - app/services/decidim/budgets/project_search.rb
+- app/types/decidim/budgets/budget_type.rb
 - app/types/decidim/budgets/budgets_type.rb
 - app/types/decidim/budgets/project_type.rb
+- app/views/decidim/budgets/admin/budgets/_form.html.erb
+- app/views/decidim/budgets/admin/budgets/edit.html.erb
+- app/views/decidim/budgets/admin/budgets/index.html.erb
+- app/views/decidim/budgets/admin/budgets/new.html.erb
 - app/views/decidim/budgets/admin/projects/_form.html.erb
 - app/views/decidim/budgets/admin/projects/edit.html.erb
 - app/views/decidim/budgets/admin/projects/index.html.erb
 - app/views/decidim/budgets/admin/projects/new.html.erb
 - app/views/decidim/budgets/admin/projects/proposals_picker.html.erb
 - app/views/decidim/budgets/admin/proposals_imports/new.html.erb
+- app/views/decidim/budgets/budgets/index.html.erb
 - app/views/decidim/budgets/line_items/update_budget.js.erb
 - app/views/decidim/budgets/order_summary_mailer/order_summary.html.erb
 - app/views/decidim/budgets/projects/_budget_confirm.html.erb
@@ -211,22 +246,27 @@ files:
 - app/views/decidim/budgets/projects/index.html.erb
 - app/views/decidim/budgets/projects/index.js.erb
 - app/views/decidim/budgets/projects/show.html.erb
+- config/locales/am-ET.yml
 - config/locales/ar-SA.yml
 - config/locales/ar.yml
 - config/locales/bg-BG.yml
+- config/locales/bg.yml
 - config/locales/ca.yml
 - config/locales/cs-CZ.yml
 - config/locales/cs.yml
 - config/locales/da-DK.yml
+- config/locales/da.yml
 - config/locales/de.yml
 - config/locales/el-GR.yml
 - config/locales/el.yml
 - config/locales/en.yml
 - config/locales/eo-UY.yml
+- config/locales/eo.yml
 - config/locales/es-MX.yml
 - config/locales/es-PY.yml
 - config/locales/es.yml
 - config/locales/et-EE.yml
+- config/locales/et.yml
 - config/locales/eu.yml
 - config/locales/fi-pl.yml
 - config/locales/fi-plain.yml
@@ -236,28 +276,44 @@ files:
 - config/locales/ga-IE.yml
 - config/locales/gl.yml
 - config/locales/hr-HR.yml
+- config/locales/hr.yml
 - config/locales/hu.yml
 - config/locales/id-ID.yml
 - config/locales/is-IS.yml
+- config/locales/is.yml
 - config/locales/it.yml
 - config/locales/ja-JP.yml
+- config/locales/ja.yml
+- config/locales/ko-KR.yml
+- config/locales/ko.yml
 - config/locales/lt-LT.yml
-- config/locales/lv-LV.yml
+- config/locales/lt.yml
+- config/locales/lv.yml
 - config/locales/mt-MT.yml
+- config/locales/mt.yml
 - config/locales/nl.yml
 - config/locales/no.yml
+- config/locales/om-ET.yml
 - config/locales/pl.yml
 - config/locales/pt-BR.yml
 - config/locales/pt.yml
 - config/locales/ro-RO.yml
 - config/locales/ru.yml
+- config/locales/si-LK.yml
 - config/locales/sk-SK.yml
 - config/locales/sk.yml
 - config/locales/sl.yml
+- config/locales/so-SO.yml
 - config/locales/sr-CS.yml
 - config/locales/sv.yml
+- config/locales/sw-KE.yml
+- config/locales/ti-ER.yml
 - config/locales/tr-TR.yml
 - config/locales/uk.yml
+- config/locales/vi-VN.yml
+- config/locales/vi.yml
+- config/locales/zh-CN.yml
+- config/locales/zh-TW.yml
 - db/migrate/20170127114122_create_projects.rb
 - db/migrate/20170130095615_create_orders.rb
 - db/migrate/20170130101825_create_line_items.rb
@@ -267,6 +323,15 @@ files:
 - db/migrate/20170612101846_migrate_projects_category.rb
 - db/migrate/20180305133340_rename_features_to_components_at_budgets.rb
 - db/migrate/20181205141115_use_big_ints_for_budgets.rb
+- db/migrate/20200617105120_create_decidim_budgets.rb
+- db/migrate/20200629072626_rename_budget_to_budget_ammount.rb
+- db/migrate/20200629134013_add_budget_reference_to_project.rb
+- db/migrate/20200706142609_add_budget_reference_to_order.rb
+- db/migrate/20200714103519_move_budgets_to_own_model.rb
+- db/migrate/20200717140012_add_scope_to_budgets.rb
+- db/migrate/20200728075039_add_selected_at_to_project.rb
+- db/migrate/20200804175222_votes_enabled_to_votes_choices.rb
+- db/migrate/20200827154129_add_commentable_counter_cache_to_projects.rb
 - lib/decidim/budgets.rb
 - lib/decidim/budgets/admin.rb
 - lib/decidim/budgets/admin_engine.rb
@@ -276,11 +341,15 @@ files:
 - lib/decidim/budgets/seeds/city.jpeg
 - lib/decidim/budgets/test/factories.rb
 - lib/decidim/budgets/version.rb
+- lib/decidim/budgets/workflows.rb
+- lib/decidim/budgets/workflows/all.rb
+- lib/decidim/budgets/workflows/base.rb
+- lib/decidim/budgets/workflows/one.rb
 homepage: https://github.com/decidim/decidim
 licenses:
 - AGPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -288,15 +357,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Decidim budgets module
 test_files: []