decidim-budgets 0.22.0 → 0.23.0

data/db/migrate/20200717140012_add_scope_to_budgets.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddScopeToBudgets < ActiveRecord::Migration[5.2]
+  def change
+    add_reference :decidim_budgets_budgets, :decidim_scope, foreign_key: true, index: true
+  end
+end

data/db/migrate/20200728075039_add_selected_at_to_project.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddSelectedAtToProject < ActiveRecord::Migration[5.2]
+  def change
+    add_column :decidim_budgets_projects, :selected_at, :date, index: true
+  end
+end

data/db/migrate/20200804175222_votes_enabled_to_votes_choices.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+class VotesEnabledToVotesChoices < ActiveRecord::Migration[5.2]
+  class Component < ApplicationRecord
+    self.table_name = :decidim_components
+  end
+
+  def up
+    budget_components.each do |component|
+      steps = component["settings"] && component["settings"].dig("steps")
+      default_step = component["settings"] && component["settings"].dig("default_step")
+
+      if steps.present?
+        new_steps_settings = component["settings"]["steps"].each_with_object({}) do |(step, config), new_config|
+          votes_value = config.dig("votes_enabled") ? "enabled" : "disabled"
+
+          new_config[step] = config.merge("votes": votes_value).except("votes_enabled")
+          new_config
+        end
+        component["settings"]["steps"] = new_steps_settings
+        component.save!
+      elsif default_step.present?
+        votes_value = component["settings"]["default_step"].dig("votes_enabled") ? "enabled" : "disabled"
+
+        new_default_step_settings = component["settings"]["default_step"].merge("votes": votes_value).except("votes_enabled")
+        component["settings"]["default_step"] = new_default_step_settings
+        component.save!
+      end
+    end
+  end
+
+  def budget_components
+    @budget_components ||= Component.where(manifest_name: "budgets")
+  end
+end

data/db/migrate/20200827154129_add_commentable_counter_cache_to_projects.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class AddCommentableCounterCacheToProjects < ActiveRecord::Migration[5.2]
+  def change
+    add_column :decidim_budgets_projects, :comments_count, :integer, null: false, default: 0, index: true
+    Decidim::Budgets::Project.reset_column_information
+    Decidim::Budgets::Project.find_each(&:update_comments_count)
+  end
+end

data/lib/decidim/budgets.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "decidim/budgets/workflows"
 require "decidim/budgets/admin"
 require "decidim/budgets/engine"
 require "decidim/budgets/admin_engine"

data/lib/decidim/budgets/admin_engine.rb

@@ -12,17 +12,22 @@ module Decidim
       paths["lib/tasks"] = nil
 
       routes do
-        resources :projects do
+        resources :budgets do
+          resources :projects do
+            collection do
+              resource :proposals_import, only: [:new, :create]
+            end
+          end
+        end
+
+        resources :projects, exclude: [:index, :new, :create, :edit, :update, :destroy] do
           get :proposals_picker, on: :collection
 
           resources :attachment_collections
           resources :attachments
-          collection do
-            resource :proposals_import, only: [:new, :create]
-          end
         end
 
-        root to: "projects#index"
+        root to: "budgets#index"
       end
 
       def load_seed

data/lib/decidim/budgets/component.rb

@@ -19,7 +19,13 @@ Decidim.register_component(:budgets) do |component|
   component.actions = %(vote)
 
   component.on(:before_destroy) do |instance|
-    raise StandardError, "Can't remove this component" if Decidim::Budgets::Project.where(component: instance).any?
+    raise StandardError, "Can't remove this component" if Decidim::Budgets::Budget.where(component: instance).any?
+  end
+
+  component.register_resource(:budget) do |resource|
+    resource.model_class_name = "Decidim::Budgets::Budget"
+    resource.card = "decidim/budgets/budget"
+    resource.searchable = true
   end
 
   component.register_resource(:project) do |resource|
@@ -30,12 +36,17 @@ Decidim.register_component(:budgets) do |component|
     resource.searchable = true
   end
 
-  component.register_stat :projects_count, primary: true, priority: Decidim::StatsRegistry::LOW_PRIORITY do |components, start_at, end_at|
+  component.register_stat :budgets_count, primary: true, priority: Decidim::StatsRegistry::LOW_PRIORITY do |components|
+    Decidim::Budgets::Budget.where(component: components).count
+  end
+
+  component.register_stat :projects_count, priority: Decidim::StatsRegistry::LOW_PRIORITY do |components, start_at, end_at|
     Decidim::Budgets::FilteredProjects.for(components, start_at, end_at).count
   end
 
   component.register_stat :orders_count do |components, start_at, end_at|
-    orders = Decidim::Budgets::Order.where(component: components)
+    budgets = Decidim::Budgets::Budget.where(component: components)
+    orders = Decidim::Budgets::Order.where(component: budgets)
     orders = orders.where("created_at >= ?", start_at) if start_at.present?
     orders = orders.where("created_at <= ?", end_at) if end_at.present?
     orders.count
@@ -43,7 +54,7 @@ Decidim.register_component(:budgets) do |component|
 
   component.register_stat :comments_count, tag: :comments do |components, start_at, end_at|
     projects = Decidim::Budgets::FilteredProjects.for(components, start_at, end_at)
-    Decidim::Comments::Comment.where(root_commentable: projects).count
+    projects.sum(:comments_count)
   end
 
   component.register_stat :followers_count, tag: :followers, priority: Decidim::StatsRegistry::LOW_PRIORITY do |components, start_at, end_at|
@@ -52,70 +63,104 @@ Decidim.register_component(:budgets) do |component|
   end
 
   component.settings(:global) do |settings|
+    settings.attribute :scopes_enabled, type: :boolean, default: false
+    settings.attribute :scope_id, type: :scope
+    settings.attribute :workflow, type: :enum, default: "one", choices: -> { Decidim::Budgets.workflows.keys.map(&:to_s) }
     settings.attribute :projects_per_page, type: :integer, default: 12
-    settings.attribute :total_budget, type: :integer, default: 100_000_000
     settings.attribute :vote_rule_threshold_percent_enabled, type: :boolean, default: true
     settings.attribute :vote_threshold_percent, type: :integer, default: 70
     settings.attribute :vote_rule_minimum_budget_projects_enabled, type: :boolean, default: false
     settings.attribute :vote_minimum_budget_projects_number, type: :integer, default: 1
     settings.attribute :comments_enabled, type: :boolean, default: true
+    settings.attribute :comments_max_length, type: :integer, required: false
     settings.attribute :resources_permissions_enabled, type: :boolean, default: true
     settings.attribute :announcement, type: :text, translated: true, editor: true
+
+    settings.attribute :landing_page_content, type: :text, translated: true, editor: true
+    settings.attribute :more_information_modal, type: :text, translated: true
   end
 
   component.settings(:step) do |settings|
     settings.attribute :comments_blocked, type: :boolean, default: false
-    settings.attribute :votes_enabled, type: :boolean, default: true
+    settings.attribute :votes, type: :enum, default: "enabled", choices: %w(disabled enabled finished)
     settings.attribute :show_votes, type: :boolean, default: false
     settings.attribute :announcement, type: :text, translated: true, editor: true
+
+    settings.attribute :landing_page_content, type: :text, translated: true, editor: true
+    settings.attribute :more_information_modal, type: :text, translated: true
+    settings.attribute :announcement, type: :text, translated: true, editor: true
   end
 
   component.seeds do |participatory_space|
+    landing_page_content = Decidim::Faker::Localized.localized do
+      "<h2>#{::Faker::Lorem.sentence}</h2>" \
+        "<p>#{::Faker::Lorem.paragraph}</p>" \
+        "<p>#{::Faker::Lorem.paragraph}</p>"
+    end
+
     component = Decidim::Component.create!(
       name: Decidim::Components::Namer.new(participatory_space.organization.available_locales, :budgets).i18n_name,
       manifest_name: :budgets,
       published_at: Time.current,
-      participatory_space: participatory_space
+      participatory_space: participatory_space,
+      settings: {
+        landing_page_content: landing_page_content,
+        more_information_modal: Decidim::Faker::Localized.paragraph(4),
+        workflow: %w(one random all).sample
+      }
     )
 
-    2.times do
-      project = Decidim::Budgets::Project.create!(
+    rand(1...3).times do
+      Decidim::Budgets::Budget.create!(
         component: component,
-        scope: participatory_space.organization.scopes.sample,
-        category: participatory_space.categories.sample,
         title: Decidim::Faker::Localized.sentence(2),
         description: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
           Decidim::Faker::Localized.paragraph(3)
         end,
-        budget: Faker::Number.number(8)
-      )
-
-      attachment_collection = Decidim::AttachmentCollection.create!(
-        name: Decidim::Faker::Localized.word,
-        description: Decidim::Faker::Localized.sentence(5),
-        collection_for: project
+        total_budget: Faker::Number.number(8)
       )
+    end
 
-      Decidim::Attachment.create!(
-        title: Decidim::Faker::Localized.sentence(2),
-        description: Decidim::Faker::Localized.sentence(5),
-        file: File.new(File.join(__dir__, "seeds", "Exampledocument.pdf")),
-        attachment_collection: attachment_collection,
-        attached_to: project
-      )
-      Decidim::Attachment.create!(
-        title: Decidim::Faker::Localized.sentence(2),
-        description: Decidim::Faker::Localized.sentence(5),
-        file: File.new(File.join(__dir__, "seeds", "city.jpeg")),
-        attached_to: project
-      )
-      Decidim::Attachment.create!(
-        title: Decidim::Faker::Localized.sentence(2),
-        description: Decidim::Faker::Localized.sentence(5),
-        file: File.new(File.join(__dir__, "seeds", "Exampledocument.pdf")),
-        attached_to: project
-      )
-      Decidim::Comments::Seed.comments_for(project)
+    Decidim::Budgets::Budget.where(component: component).each do |budget|
+      rand(2...4).times do
+        project = Decidim::Budgets::Project.create!(
+          budget: budget,
+          scope: participatory_space.organization.scopes.sample,
+          category: participatory_space.categories.sample,
+          title: Decidim::Faker::Localized.sentence(2),
+          description: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
+            Decidim::Faker::Localized.paragraph(3)
+          end,
+          budget_amount: Faker::Number.number(8)
+        )
+
+        attachment_collection = Decidim::AttachmentCollection.create!(
+          name: Decidim::Faker::Localized.word,
+          description: Decidim::Faker::Localized.sentence(5),
+          collection_for: project
+        )
+
+        Decidim::Attachment.create!(
+          title: Decidim::Faker::Localized.sentence(2),
+          description: Decidim::Faker::Localized.sentence(5),
+          attachment_collection: attachment_collection,
+          attached_to: project,
+          file: File.new(File.join(__dir__, "seeds", "Exampledocument.pdf"))
+        )
+        Decidim::Attachment.create!(
+          title: Decidim::Faker::Localized.sentence(2),
+          description: Decidim::Faker::Localized.sentence(5),
+          attached_to: project,
+          file: File.new(File.join(__dir__, "seeds", "city.jpeg"))
+        )
+        Decidim::Attachment.create!(
+          title: Decidim::Faker::Localized.sentence(2),
+          description: Decidim::Faker::Localized.sentence(5),
+          attached_to: project,
+          file: File.new(File.join(__dir__, "seeds", "Exampledocument.pdf"))
+        )
+        Decidim::Comments::Seed.comments_for(project)
+      end
     end
   end
 end

data/lib/decidim/budgets/engine.rb

@@ -12,15 +12,17 @@ module Decidim
       isolate_namespace Decidim::Budgets
 
       routes do
-        resources :projects, only: [:index, :show]
-        resource :order, only: [:destroy] do
-          member do
-            post :checkout
+        resources :budgets, only: [:index, :show] do
+          resources :projects, only: [:index, :show]
+          resource :order, only: [:destroy] do
+            member do
+              post :checkout
+            end
+            resource :line_item, only: [:create, :destroy]
           end
-          resource :line_item, only: [:create, :destroy]
         end
 
-        root to: "projects#index"
+        root to: "budgets#index"
       end
 
       initializer "decidim_budgets.assets" do |app|

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.0"
     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