decidim-budgets 0.10.1 → 0.11.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e0f6a36867eb268b99f20d0ea714cb30da8debcfc8e652c7a167f79de04d0dc
-  data.tar.gz: fc29502e66b2dd3aebc2266f87d62fb6988402d59e3082f2f9d3700fc5bd3b4d
+  metadata.gz: 0cd0751b67b4aabebe67fe6bf0987e8ecd3b0e850990747c829a79394f6d3ffb
+  data.tar.gz: '09bef5af8fd5d261512113760f32f1c224bf3b1738c385f23840b27c82a403e2'
 SHA512:
-  metadata.gz: d575f70e3af158b1d2626e05605d64d59eb67a5d068ae418f02f293cf20248b4c2d0159c88bfc651d26215d6fc8faabe61ab0f0b74ae5641753205e01b38b5eb
-  data.tar.gz: faf33f349bae47edb2f5ab704d0506ffc538c3879fa50baa2f239c3e1218c40f0fb76accec5143051edc759b48640f8df72929f3170819ed4fe4c91df3f79767
+  metadata.gz: 192158943da4f666a91adf4d5254a8076f1aeec3a8919509f827f89480c858dc3e652e42a4de77ed838b3af02162df69daae873ef2af610d875f63a7c10e8cae
+  data.tar.gz: 37b2f1864b2e96720ed8e17da6ce41677b70b644e67649ae7a83a1cd399ca0b0125471bc296b20b900d32342b32de6d4bed81f120cd85237614e77933fe6a7d3

data/README.md

@@ -4,7 +4,7 @@ The Budgets module adds projects to any participatory process. It adds a CRUD en
 
 ## Usage
 
-Budgets will be available as a Feature for a Participatory Process.
+Budgets will be available as a Component for a Participatory Process.
 
 ## Installation
 

data/app/assets/javascripts/decidim/budgets/projects.js.es6

@@ -2,27 +2,27 @@
 // = require_self
 
 $(() => {
-  const $projects = $('#projects, #project');
-  const $budgetSummaryTotal = $('.budget-summary__total');
-  const $budgetExceedModal = $('#budget-excess');
+  const $projects = $("#projects, #project");
+  const $budgetSummaryTotal = $(".budget-summary__total");
+  const $budgetExceedModal = $("#budget-excess");
 
-  const totalBudget = parseInt($budgetSummaryTotal.attr('data-total-budget'), 10);
+  const totalBudget = parseInt($budgetSummaryTotal.attr("data-total-budget"), 10);
 
   const cancelEvent = (event) => {
     event.stopPropagation();
     event.preventDefault();
   };
 
-  $projects.on('click', '.budget--list__action', (event) => {
-    const currentBudget = parseInt($('.budget-summary__progressbox').attr('data-current-budget'), 10);
+  $projects.on("click", ".budget--list__action", (event) => {
+    const currentBudget = parseInt($(".budget-summary__progressbox").attr("data-current-budget"), 10);
     const $currentTarget = $(event.currentTarget);
-    const projectBudget = parseInt($currentTarget.attr('data-budget'), 10);
+    const projectBudget = parseInt($currentTarget.attr("data-budget"), 10);
 
-    if ($currentTarget.attr('disabled')) {
+    if ($currentTarget.attr("disabled")) {
       cancelEvent(event);
 
-    } else if ($currentTarget.attr('data-add') && ((currentBudget + projectBudget) > totalBudget)) {
-      $budgetExceedModal.foundation('toggle');
+    } else if ($currentTarget.attr("data-add") && ((currentBudget + projectBudget) > totalBudget)) {
+      $budgetExceedModal.foundation("toggle");
       cancelEvent(event);
     }
   });

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

@@ -32,7 +32,7 @@ module Decidim
       private
 
       def order
-        @order ||= Order.create!(user: @current_user, feature: @project.feature)
+        @order ||= Order.create!(user: @current_user, component: @project.component)
       end
 
       def add_line_item
@@ -42,12 +42,12 @@ module Decidim
         end
       end
 
-      def feature
-        @project.feature
+      def component
+        @project.component
       end
 
       def votes_disabled?
-        !feature.current_settings.votes_enabled?
+        !component.current_settings.votes_enabled?
       end
     end
   end

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

@@ -29,10 +29,12 @@ module Decidim
         attr_reader :project
 
         def create_project
-          @project = Project.create!(
+          @project = Decidim.traceability.create!(
+            Project,
+            @form.current_user,
             scope: @form.scope,
             category: @form.category,
-            feature: @form.current_feature,
+            component: @form.current_component,
             title: @form.title,
             description: @form.description,
             budget: @form.budget

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Budgets
+    module Admin
+      # This command is executed when the user deletes a Project from the admin
+      # panel.
+      class DestroyProject < Rectify::Command
+        # Initializes an UpdateProject Command.
+        #
+        # project - The current instance of the project to be destroyed.
+        # current_user - the user that performs the action
+        def initialize(project, current_user)
+          @project = project
+          @current_user = current_user
+        end
+
+        # Performs the action.
+        #
+        # Broadcasts :ok if successful, :invalid otherwise.
+        def call
+          destroy_project
+          broadcast(:ok)
+        end
+
+        private
+
+        attr_reader :project, :current_user
+
+        def destroy_project
+          Decidim.traceability.perform_action!(
+            :delete,
+            project,
+            current_user
+          ) do
+            project.destroy!
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -34,7 +34,9 @@ module Decidim
         attr_reader :project, :form
 
         def update_project
-          project.update!(
+          Decidim.traceability.update!(
+            project,
+            form.current_user,
             scope: form.scope,
             category: form.category,
             title: form.title,

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

@@ -7,10 +7,10 @@ module Decidim
       # Public: Initializes the command.
       #
       # order - The current order for the user.
-      # feature - The current feature.
-      def initialize(order, feature)
+      # component - The current component.
+      def initialize(order, component)
         @order = order
-        @feature = feature
+        @component = component
       end
 
       # Executes the command. Broadcasts these events:

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

@@ -15,7 +15,7 @@ module Decidim
         #
         # Returns an Order.
         def current_order
-          @current_order ||= Order.includes(:projects).find_by(user: current_user, feature: current_feature)
+          @current_order ||= Order.includes(:projects).find_by(user: current_user, component: current_component)
         end
 
         def current_order=(order)

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

@@ -6,13 +6,13 @@ module Decidim
       # This controller is the abstract class from which all other controllers of
       # this engine inherit.
       #
-      # Note that it inherits from `Decidim::Features::BaseController`, which
+      # Note that it inherits from `Decidim::Components::BaseController`, which
       # override its layout and provide all kinds of useful methods.
-      class ApplicationController < Decidim::Admin::Features::BaseController
+      class ApplicationController < Decidim::Admin::Components::BaseController
         helper_method :projects, :project
 
         def projects
-          @projects ||= Project.where(feature: current_feature)
+          @projects ||= Project.where(component: current_component)
         end
 
         def project

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

@@ -9,7 +9,7 @@ module Decidim
         include Decidim::Admin::Concerns::HasAttachmentCollections
 
         def after_destroy_path
-          project_attachment_collections_path(project, project.feature, current_participatory_space)
+          project_attachment_collections_path(project, project.component, current_participatory_space)
         end
 
         def collection_for
@@ -21,7 +21,7 @@ module Decidim
         end
 
         def authorization_object
-          project.feature
+          project.component
         end
       end
     end

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

@@ -22,7 +22,7 @@ module Decidim
         end
 
         def authorization_object
-          project.feature
+          project.component
         end
       end
     end

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

@@ -48,21 +48,22 @@ module Decidim
         end
 
         def destroy
-          project.destroy!
-
-          flash[:notice] = I18n.t("projects.destroy.success", scope: "decidim.budgets.admin")
-
-          redirect_to projects_path
+          DestroyProject.call(project, current_user) do
+            on(:ok) do
+              flash[:notice] = I18n.t("projects.destroy.success", scope: "decidim.budgets.admin")
+              redirect_to projects_path
+            end
+          end
         end
 
         private
 
         def projects
-          @projects ||= Project.where(feature: current_feature).page(params[:page]).per(15)
+          @projects ||= Project.where(component: current_component).page(params[:page]).per(15)
         end
 
         def orders
-          @orders ||= Order.where(feature: current_feature)
+          @orders ||= Order.where(component: current_component)
         end
 
         def pending_orders

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

@@ -5,9 +5,9 @@ module Decidim
     # This controller is the abstract class from which all other controllers of
     # this engine inherit.
     #
-    # Note that it inherits from `Decidim::Features::BaseController`, which
+    # Note that it inherits from `Decidim::Components::BaseController`, which
     # override its layout and provide all kinds of useful methods.
-    class ApplicationController < Decidim::Features::BaseController
+    class ApplicationController < Decidim::Components::BaseController
     end
   end
 end

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

@@ -44,7 +44,7 @@ module Decidim
       private
 
       def project
-        @project ||= Project.where(id: params[:project_id], feature: current_feature).first
+        @project ||= Project.find_by(id: params[:project_id], component: current_component)
       end
     end
   end

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

@@ -9,7 +9,7 @@ module Decidim
       def checkout
         authorize_action! "vote"
 
-        Checkout.call(current_order, current_feature) do
+        Checkout.call(current_order, current_component) do
           on(:ok) do
             flash[:notice] = I18n.t("orders.checkout.success", scope: "decidim")
             redirect_to projects_path

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

@@ -12,7 +12,7 @@ module Decidim
       private
 
       def projects
-        @projects ||= search.results.page(params[:page]).per(12)
+        @projects ||= search.results.page(params[:page]).per(current_component.settings.projects_per_page)
       end
 
       def random_seed
@@ -37,7 +37,7 @@ module Decidim
       end
 
       def context_params
-        { feature: current_feature, organization: current_organization }
+        { component: current_component, organization: current_organization }
       end
     end
   end

data/app/forms/decidim/budgets/admin/project_form.rb

@@ -25,7 +25,7 @@ module Decidim
 
         validate :scope_belongs_to_participatory_space_scope
 
-        delegate :categories, to: :current_feature
+        delegate :categories, to: :current_component
 
         def map_model(model)
           self.proposal_ids = model.linked_resources(:proposals, "included_proposals").pluck(:id)
@@ -36,7 +36,7 @@ module Decidim
         end
 
         def proposals
-          @proposals ||= Decidim.find_resource_manifest(:proposals).try(:resource_scope, current_feature)&.order(title: :asc)&.pluck(:title, :id)
+          @proposals ||= Decidim.find_resource_manifest(:proposals).try(:resource_scope, current_component)&.order(title: :asc)&.pluck(:title, :id)
         end
 
         # Finds the Category from the decidim_category_id.

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

@@ -9,11 +9,11 @@ module Decidim
       belongs_to :project, class_name: "Decidim::Budgets::Project", foreign_key: "decidim_project_id"
 
       validates :order, uniqueness: { scope: :project }
-      validate :same_feature
+      validate :same_component
 
-      def same_feature
+      def same_component
         return unless order && project
-        errors.add(:order, :invalid) unless order.feature == project.feature
+        errors.add(:order, :invalid) unless order.component == project.component
       end
     end
   end

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

@@ -3,18 +3,18 @@
 module Decidim
   module Budgets
     # The data store for a Order in the Decidim::Budgets component. It is unique for each
-    # user and feature and contains a collection of projects
+    # user and component and contains a collection of projects
     class Order < Budgets::ApplicationRecord
-      include Decidim::HasFeature
+      include Decidim::HasComponent
 
-      feature_manifest_name "budgets"
+      component_manifest_name "budgets"
 
       belongs_to :user, class_name: "Decidim::User", foreign_key: "decidim_user_id"
 
       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: :feature }
+      validates :user, uniqueness: { scope: :component }
       validate :user_belongs_to_organization
 
       validates :total_budget, numericality: {
@@ -45,25 +45,25 @@ module Decidim
 
       # Public: Returns the order budget percent from the settings total budget
       def budget_percent
-        (total_budget.to_f / feature.settings.total_budget.to_f) * 100
+        (total_budget.to_f / component.settings.total_budget.to_f) * 100
       end
 
       # Public: Returns the required minimum budget to checkout
       def minimum_budget
-        return 0 unless feature
-        feature.settings.total_budget.to_f * (feature.settings.vote_threshold_percent.to_f / 100)
+        return 0 unless component
+        component.settings.total_budget.to_f * (component.settings.vote_threshold_percent.to_f / 100)
       end
 
       # Public: Returns the required maximum budget to checkout
       def maximum_budget
-        return 0 unless feature
-        feature.settings.total_budget.to_f
+        return 0 unless component
+        component.settings.total_budget.to_f
       end
 
       private
 
       def user_belongs_to_organization
-        organization = feature&.organization
+        organization = component&.organization
 
         return if !user || !organization
         errors.add(:user, :invalid) unless user.organization == organization

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

@@ -6,27 +6,33 @@ module Decidim
     # title, description and any other useful information to render a custom project.
     class Project < Budgets::ApplicationRecord
       include Decidim::Resourceable
-      include Decidim::HasFeature
-      include Decidim::ScopableFeature
+      include Decidim::HasComponent
+      include Decidim::ScopableComponent
       include Decidim::HasCategory
       include Decidim::HasAttachments
       include Decidim::HasAttachmentCollections
       include Decidim::HasReference
       include Decidim::Followable
       include Decidim::Comments::Commentable
+      include Decidim::Traceable
+      include Decidim::Loggable
 
-      feature_manifest_name "budgets"
+      component_manifest_name "budgets"
       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"
 
+      def self.log_presenter_class_for(_log)
+        Decidim::Budgets::AdminLog::ProjectPresenter
+      end
+
       # Public: Overrides the `commentable?` Commentable concern method.
       def commentable?
-        feature.settings.comments_enabled?
+        component.settings.comments_enabled?
       end
 
       # Public: Overrides the `accepts_new_comments?` Commentable concern method.
       def accepts_new_comments?
-        commentable? && !feature.current_settings.comments_blocked
+        commentable? && !component.current_settings.comments_blocked
       end
 
       # Public: Overrides the `comments_have_votes?` Commentable concern method.

data/app/presenters/decidim/budgets/admin_log/project_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::Project``
+      # 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
+      #    ProjectPresenter.new(action_log, view_helpers).present
+      class ProjectPresenter < Decidim::Log::BasePresenter
+        private
+
+        def action_string
+          case action
+          when "create", "delete", "update"
+            "decidim.budgets.admin_log.project.#{action}"
+          else
+            super
+          end
+        end
+
+        def diff_fields_mapping
+          {
+            budget: :currency,
+            description: :i18n,
+            title: :i18n,
+            decidim_scope_id: :scope
+          }
+        end
+
+        def i18n_labels_scope
+          "activemodel.attributes.project"
+        end
+      end
+    end
+  end
+end

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

@@ -2,32 +2,32 @@
 
 module Decidim
   module Budgets
-    # A class used to find projects filtered by features and a date range
+    # A class used to find projects filtered by components and a date range
     class FilteredProjects < Rectify::Query
       # Syntactic sugar to initialize the class and return the queried objects.
       #
-      # features - An array of Decidim::Feature
+      # components - An array of Decidim::Component
       # start_at - A date to filter resources created after it
       # end_at - A date to filter resources created before it.
-      def self.for(features, start_at = nil, end_at = nil)
-        new(features, start_at, end_at).query
+      def self.for(components, start_at = nil, end_at = nil)
+        new(components, start_at, end_at).query
       end
 
       # Initializes the class.
       #
-      # features - An array of Decidim::Feature
+      # components - An array of Decidim::Component
       # start_at - A date to filter resources created after it
       # end_at - A date to filter resources created before it.
-      def initialize(features, start_at = nil, end_at = nil)
-        @features = features
+      def initialize(components, start_at = nil, end_at = nil)
+        @components = components
         @start_at = start_at
         @end_at = end_at
       end
 
-      # Finds the Projects scoped to an array of features and filtered
+      # Finds the Projects scoped to an array of components and filtered
       # by a range of dates.
       def query
-        projects = Decidim::Budgets::Project.where(feature: @features)
+        projects = Decidim::Budgets::Project.where(component: @components)
         projects = projects.where("created_at >= ?", @start_at) if @start_at.present?
         projects = projects.where("created_at <= ?", @end_at) if @end_at.present?
         projects

data/app/services/decidim/budgets/project_search.rb

@@ -3,11 +3,11 @@
 module Decidim
   module Budgets
     # This class handles search and filtering of projects. Needs a
-    # `current_feature` param with a `Decidim::Feature` in order to
+    # `current_component` param with a `Decidim::Component` in order to
     # find the projects.
     class ProjectSearch < ResourceSearch
       # Public: Initializes the service.
-      # feature     - A Decidim::Feature to get the projects from.
+      # component     - A Decidim::Component to get the projects from.
       def initialize(options = {})
         super(Project.all, options)
         @random_seed = options[:random_seed].to_f

data/app/views/decidim/budgets/admin/projects/_form.html.erb

@@ -4,25 +4,25 @@
   </div>
 
   <div class="card-section">
-    <div class="row column" >
+    <div class="row column">
       <%= form.translated :text_field, :title, autofocus: true %>
     </div>
 
-    <div class="row column" >
+    <div class="row column">
       <%= form.translated :editor, :description %>
     </div>
 
-    <div class="row column" >
+    <div class="row column">
       <%= form.number_field :budget %>
     </div>
 
     <% if current_participatory_space.has_subscopes? %>
-      <div class="row column" >
+      <div class="row column">
         <%= scopes_picker_field form, :decidim_scope_id %>
       </div>
     <% end %>
 
-    <div class="row column" >
+    <div class="row column">
       <%= form.categories_select :decidim_category_id, current_participatory_space.categories, include_blank: true, disable_parents: false %>
     </div>
 
@@ -31,8 +31,7 @@
         <%= form.select :proposal_ids,
                         @form.proposals,
                         {},
-                        { multiple: true, class: "chosen-select" }
-        %>
+                        { multiple: true, class: "chosen-select" } %>
       <% end %>
     </div>
   </div>

data/app/views/decidim/budgets/admin/projects/edit.html.erb

@@ -1,5 +1,5 @@
-<%=  decidim_form_for(@form, html: { class: "form edit_project" })  do |f| %>
-  <%= render partial: 'form', object: f, locals: { title: t('.title') } %>
+<%= decidim_form_for(@form, html: { class: "form edit_project" })  do |f| %>
+  <%= render partial: "form", object: f, locals: { title: t(".title") } %>
 
   <div class="button--double form-general-submit">
     <%= f.submit t(".update") %>

data/app/views/decidim/budgets/admin/projects/index.html.erb

@@ -2,7 +2,7 @@
   <div class="card-divider">
     <h2 class="card-title">
       <%= t(".title") %>
-      <%= link_to t("actions.new", scope: "decidim.budgets", name: t("models.project.name", scope: "decidim.budgets.admin")), new_project_path, class: 'button tiny button--title' if can? :manage, current_feature %>
+      <%= link_to t("actions.new", scope: "decidim.budgets", name: t("models.project.name", scope: "decidim.budgets.admin")), new_project_path, class: "button tiny button--title" if can? :manage, current_component %>
     </h2>
   </div>
 
@@ -28,19 +28,19 @@
               <td class="table-list__actions">
                 <%= icon_link_to "eye", resource_locator(project).path, t("actions.preview", scope: "decidim.budgets"), target: :blank, class: "action-icon--preview" %>
 
-                <% if can? :update, current_feature %>
+                <% if can? :update, current_component %>
                   <%= icon_link_to "pencil", edit_project_path(project), t("actions.edit", scope: "decidim.budgets"), class: "action-icon--edit" %>
                 <% end %>
 
-                <% if can? :update, current_feature %>
+                <% if can? :update, current_component %>
                     <%= icon_link_to "folder", project_attachment_collections_path(project), t("actions.attachment_collections", scope: "decidim.budgets"), class: "action-icon--attachment_collections" %>
                 <% end %>
 
-                <% if can? :update, current_feature %>
+                <% if can? :update, current_component %>
                   <%= icon_link_to "paperclip", project_attachments_path(project), t("actions.attachments", scope: "decidim.budgets"), class: "action-icon--attachments" %>
                 <% end %>
 
-                <% if can? :destroy, current_feature %>
+                <% if can? :destroy, current_component %>
                   <%= icon_link_to "circle-x", project_path(project), t("actions.destroy", scope: "decidim.budgets"), method: :delete, class: "action-icon--remove", data: { confirm: t("actions.confirm_destroy", scope: "decidim.budgets") } %>
                 <% end %>
               </td>

data/app/views/decidim/budgets/admin/projects/new.html.erb

@@ -1,8 +1,7 @@
-<%=  decidim_form_for(@form, html: { class: "form new_project" }) do |f| %>
-  <%= render partial: 'form', object: f, locals: { title: t('.title') }  %>
+<%= decidim_form_for(@form, html: { class: "form new_project" }) do |f| %>
+  <%= render partial: "form", object: f, locals: { title: t(".title") } %>
 
   <div class="button--double form-general-submit">
     <%= f.submit t(".create") %>
   </div>
 <% end %>
-