decidim-budgets 0.30.3 → 0.31.0.rc2

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

@@ -8,7 +8,7 @@ module Decidim
     # Note that it inherits from `Decidim::Components::BaseController`, which
     # override its layout and provide all kinds of useful methods.
     class ApplicationController < Decidim::Components::BaseController
-      helper_method :current_workflow, :voting_finished?, :voting_open?
+      helper_method :current_workflow, :voting_finished?, :voting_open?, :show_votes_count?
 
       def current_workflow
         @current_workflow ||= Decidim::Budgets.workflows[workflow_name].new(current_component, current_user)
@@ -22,11 +22,23 @@ module Decidim
         current_settings.votes == "finished"
       end
 
+      def show_votes_count?
+        current_settings.show_votes?
+      end
+
+      def resource_added?(project)
+        current_order && current_order.projects.include?(project)
+      end
+
       private
 
       def workflow_name
         @workflow_name ||= current_component.settings.workflow.to_sym
       end
+
+      def set_focus_mode_if_voting_open
+        @focus_mode = true if voting_open?
+      end
     end
   end
 end

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

@@ -9,9 +9,7 @@ module Decidim
       include Decidim::Budgets::Orderable
       include Decidim::TranslatableAttributes
 
-      def index
-        redirect_to budget_projects_path(current_workflow.single) if current_workflow.single?
-      end
+      def index; end
 
       def show
         raise ActionController::RoutingError, "Not Found" unless budget

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

@@ -8,6 +8,8 @@ module Decidim
 
       helper_method :budget, :project
 
+      before_action :set_focus_mode, :set_request_origin
+
       def create
         enforce_permission_to :vote, :project, project:, budget:, workflow: current_workflow
 
@@ -49,6 +51,23 @@ module Decidim
 
       private
 
+      def set_request_origin
+        return unless request.referer
+
+        path = URI(request.referer).path
+        @focus_mode_origin = if path.match?(%r{/budgets/\d+/projects/\d+$})
+                               "show"
+                             elsif path.match?(%r{/budgets/\d+/projects$})
+                               "index"
+                             else
+                               "unknown"
+                             end
+      end
+
+      def set_focus_mode
+        @focus_mode = true
+      end
+
       def project
         @project ||= budget&.projects&.find_by(id: params[:project_id])
       end

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

@@ -8,6 +8,8 @@ module Decidim
 
       helper_method :pending_to_vote_budgets
 
+      before_action :set_focus_mode_if_voting_open
+
       def checkout
         enforce_permission_to :vote, :project, order: current_order, budget:, workflow: current_workflow
 
@@ -41,12 +43,30 @@ module Decidim
         redirect_to redirect_path unless current_order.persisted?
       end
 
+      def export_pdf
+        enforce_permission_to :export_pdf, :order, order: current_order
+
+        pdf_export = Decidim::Budgets::OrderPDF.new(current_order).render
+
+        output = if pdf_signature_service
+                   pdf_signature_service.new(pdf: pdf_export.read).signed_pdf
+                 else
+                   pdf_export.read
+                 end
+
+        send_data output, filename: "order_#{current_order.id}.pdf", type: "application/pdf"
+      end
+
       private
 
       def budget
         @budget ||= Budget.find_by(id: params[:budget_id], component: current_component)
       end
 
+      def pdf_signature_service
+        @pdf_signature_service ||= Decidim.pdf_signature_service.to_s.safe_constantize
+      end
+
       def redirect_path
         if params[:return_to] == "budget"
           budget_path(budget)

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

@@ -9,7 +9,9 @@ module Decidim
       include Decidim::Budgets::Orderable
       include Decidim::IconHelper
 
-      helper_method :projects, :project, :budget, :all_geocoded_projects, :tabs, :panels
+      helper_method :projects, :project, :budget, :all_geocoded_projects, :tabs, :panels, :resource_added?
+
+      before_action :set_focus_mode_if_voting_open
 
       def index
         raise ActionController::RoutingError, "Not Found" unless budget

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

@@ -7,42 +7,16 @@ module Decidim
       # to a participatory process from the admin panel.
       #
       class ComponentForm < Decidim::Admin::ComponentForm
-        validate :budget_voting_rule_enabled_setting,
-                 :budget_voting_rule_threshold_value_setting,
+        validate :budget_voting_rule_threshold_value_setting,
                  :budget_voting_rule_minimum_value_setting,
                  :budget_voting_rule_projects_value_setting
 
         private
 
-        # Validations on budget settings:
-        # - a voting rule must be enabled.
-        def budget_voting_rule_enabled_setting
-          return unless manifest&.name == :budgets
-
-          rule_settings = [
-            :vote_rule_threshold_percent_enabled,
-            :vote_rule_minimum_budget_projects_enabled,
-            :vote_rule_selected_projects_enabled
-          ]
-          active_rules = rule_settings.select { |key| settings.public_send(key) == true }
-          i18n_error_scope = "decidim.components.budgets.settings.global.form.errors"
-          if active_rules.blank?
-            rule_settings.each do |key|
-              settings.errors.add(key, I18n.t(:budget_voting_rule_required, scope: i18n_error_scope))
-            end
-          end
-
-          if active_rules.length > 1
-            rule_settings.each do |key|
-              settings.errors.add(key, I18n.t(:budget_voting_rule_only_one, scope: i18n_error_scope))
-            end
-          end
-        end
-
         # - the value must be a valid number
         def budget_voting_rule_threshold_value_setting
           return unless manifest&.name == :budgets
-          return unless settings.vote_rule_threshold_percent_enabled
+          return unless settings.voting_rule == "threshold_percent"
 
           invalid_percent_number = settings.vote_threshold_percent.blank? || settings.vote_threshold_percent.to_i.negative?
           settings.errors.add(:vote_threshold_percent) if invalid_percent_number
@@ -50,7 +24,7 @@ module Decidim
 
         def budget_voting_rule_minimum_value_setting
           return unless manifest&.name == :budgets
-          return unless settings.vote_rule_minimum_budget_projects_enabled
+          return unless settings.voting_rule == "minimum_projects"
 
           invalid_minimum_number = settings.vote_minimum_budget_projects_number.blank? || (settings.vote_minimum_budget_projects_number.to_i < 1)
           settings.errors.add(:vote_minimum_budget_projects_number) if invalid_minimum_number
@@ -58,7 +32,7 @@ module Decidim
 
         def budget_voting_rule_projects_value_setting
           return unless manifest&.name == :budgets
-          return unless settings.vote_rule_selected_projects_enabled
+          return unless settings.voting_rule == "selected_projects"
 
           budget_voting_projects_value_setting_min
           budget_voting_projects_value_setting_max

data/app/helpers/decidim/budgets/application_helper.rb

@@ -7,6 +7,7 @@ module Decidim
     module ApplicationHelper
       include PaginateHelper
       include Decidim::Comments::CommentsHelper
+      include Decidim::AnimationsHelper
       include ProjectsHelper
       include Decidim::CheckBoxesTreeHelper
 

data/app/helpers/decidim/budgets/projects_helper.rb

@@ -14,6 +14,13 @@ module Decidim
         number_to_currency budget, unit: Decidim.currency_unit, precision: 0
       end
 
+      # Render a budget as a currency with the HTML format
+      #
+      # budget - A integer to represent a budget
+      def budget_to_currency_with_html(budget)
+        number_to_currency(budget, unit: Decidim.currency_unit, precision: 0, format: t("number.currency.format.format_html"))
+      end
+
       # Return a percentage of the current order budget from the total budget
       def current_order_budget_percent
         current_order&.budget_percent.to_f.floor
@@ -56,13 +63,7 @@ module Decidim
       def current_rule_call_for_action_text
         return "" unless current_order
 
-        if current_order_minimum_reached?
-          t("minimum_reached", scope: "decidim.budgets.projects.order_progress.dynamic_help")
-        elsif current_order.projects.empty?
-          t("start_adding_projects", scope: "decidim.budgets.projects.order_progress.dynamic_help")
-        else
-          t("keep_adding_projects", scope: "decidim.budgets.projects.order_progress.dynamic_help")
-        end
+        t("minimum_reached", scope: "decidim.budgets.projects.order_progress.dynamic_help") if current_order_minimum_reached?
       end
 
       def current_rule_description
@@ -98,6 +99,9 @@ module Decidim
                         minimum_budget: budget_to_currency(current_order.minimum_budget)
                       )
                     end
+
+        return rule_text.html_safe if current_rule_call_for_action_text.nil?
+
         %(<strong>#{current_rule_call_for_action_text}</strong>. #{rule_text}).html_safe
       end
 

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

@@ -132,14 +132,14 @@ module Decidim
       def minimum_projects_rule?
         return unless budget
 
-        budget.settings.vote_rule_minimum_budget_projects_enabled
+        budget.settings.voting_rule == "minimum_projects"
       end
 
       # Public: Returns true if the project voting rule is enabled
       def projects_rule?
         return unless budget
 
-        budget.settings.vote_rule_selected_projects_enabled
+        budget.settings.voting_rule == "selected_projects"
       end
 
       # Public: Returns the required minimum projects to checkout

data/app/packs/entrypoints/decidim_budgets.js

@@ -1,6 +1,7 @@
 import "src/decidim/budgets/projects"
 import "src/decidim/budgets/progressFixed"
 import "src/decidim/budgets/exit_handler"
+import "src/decidim/budgets/budgetSummaryBackdrop"
 
 // Images
 require.context("../images", true)

data/app/packs/src/decidim/budgets/admin/projects.js

@@ -1,5 +1,5 @@
 /* eslint-disable no-invalid-this */
-$(() => {
+document.addEventListener("turbo:load", () => {
   const selectedResourcesCount = () => {
     return $(".table-list .js-check-all-resources:checked").length
   }
@@ -72,7 +72,7 @@ $(() => {
     hideBulkActionForms();
     $("#js-bulk-actions-button").addClass("hide");
 
-    $("#js-bulk-actions-dropdown ul li button").on("click", (event) => {
+    $("#js-bulk-actions-dropdown li button").on("click", (event) => {
       event.preventDefault();
       let action = $(event.target).data("action");
 

data/app/packs/src/decidim/budgets/budgetSummaryBackdrop.js

@@ -0,0 +1,41 @@
+document.addEventListener("turbo:load", () => {
+  const toggleBackdrop = () => {
+    const progressSummaryButton = document.getElementById("progress-summary-button");
+    const backdrop = document.getElementById("progress-summary-backdrop");
+
+    if (!progressSummaryButton || !backdrop) {
+      return;
+    }
+
+    const isOpen = progressSummaryButton.getAttribute("aria-expanded") === "true";
+
+    backdrop.classList.toggle("hidden", !isOpen);
+  }
+
+  const setupBackdrop = () => {
+    const progressSummaryButton = document.getElementById("progress-summary-button");
+    const backdrop = document.getElementById("progress-summary-backdrop");
+
+    if (!progressSummaryButton || !backdrop) {
+      return;
+    }
+
+    progressSummaryButton.addEventListener("click", toggleBackdrop);
+    backdrop.addEventListener("click", () => {
+      backdrop.classList.add("hidden");
+    });
+  }
+
+  const removeStartVotingParam = () => {
+    const url = new URL(window.location.href);
+
+    url.searchParams.delete("start_voting");
+    window.history.replaceState({}, "", url);
+  }
+
+  toggleBackdrop();
+  setupBackdrop();
+  removeStartVotingParam();
+
+  window.DecidimBudgets.toggleBackdrop = toggleBackdrop;
+});

data/app/packs/src/decidim/budgets/exit_handler.js

@@ -47,7 +47,7 @@ const allowExitFrom = ($el) => {
   return false;
 }
 
-$(() => {
+document.addEventListener("turbo:load", () => {
   const $exitNotification = $("#exit-notification");
   const $exitLink = $("#exit-notification-link");
   const defaultExitUrl = $exitLink.attr("href");
@@ -90,7 +90,12 @@ $(() => {
     event.stopPropagation();
 
     const $link = $(event.currentTarget);
-    exitLinkText = $link.text();
+    const linkText = $link.text();
+
+    if (linkText.length > 0) {
+      exitLinkText = linkText;
+    }
+
     openExitNotification($link.attr("href"), $link.data("method"));
   });
   // Custom handling for the exit link which needs to change the exit link

data/app/packs/src/decidim/budgets/progressFixed.js

@@ -1,4 +1,4 @@
-$(() => {
+document.addEventListener("turbo:load", () => {
   const checkProgressPosition = () => {
 
     const progressRef = document.querySelectorAll("[data-progress-reference]");

data/app/packs/src/decidim/budgets/projects.js

@@ -1,4 +1,4 @@
-$(() => {
+document.addEventListener("turbo:load", () => {
   const $projects = $("#projects, #project-item");
   const $budgetSummaryTotal = $(".budget-summary__progressbar-marks_right");
   const selectBudgetSummaryTotal = $budgetSummaryTotal.data("totalAllocation");

data/app/packs/stylesheets/budgets.scss

@@ -1,11 +1,11 @@
 .budget {
   &-list__map {
-    @apply md:-ml-16 -mt-6 md:-mt-12 mb-6 aspect-square md:aspect-[21/9] [&>*]:h-full [&+*]:mt-6 md:[&+*]:mt-12;
+    @apply lg:-ml-16 -mt-6 lg:-mt-12 mb-6 aspect-square lg:aspect-[21/9] [&>*]:h-full [&+*]:mt-6 lg:[&+*]:mt-12;
   }
 
   &-summary {
     &__content {
-      @apply bg-tertiary p-4 md:h-full md:p-0;
+      @apply bg-tertiary p-4 lg:h-full lg:p-0;
     }
 
     &__container {
@@ -33,7 +33,7 @@
     }
 
     &__progressbar {
-      @apply my-0 lg:my-4 relative;
+      @apply my-0 xl:my-4 relative;
 
       .budget-progress {
         @apply bg-white rounded h-2;
@@ -57,48 +57,60 @@
     }
 
     &__progressbar-marks_right {
-      @apply justify-self-end text-left md:text-right;
+      @apply justify-self-end text-left lg:text-right;
     }
 
     &__progressbar-legend {
-      @apply text-xs md:text-sm block;
+      @apply text-xs lg:text-sm block;
     }
 
     &__progressbar-legend-strong {
-      @apply font-semibold block text-[10px] md:text-sm text-nowrap;
+      @apply font-semibold block text-[10px] lg:text-sm text-nowrap;
     }
   }
 
-  &__projects__container {
-    @apply -mt-12 sm:mt-0;
+  &__card__list-budget--highlighted {
+    @apply ring-warning;
+  }
+
+  &__card__list-budget--progress {
+    @apply ring-warning;
+  }
+
+  &__card__list-budget--voted {
+    @apply ring-success;
   }
 
   &__card__list-project {
-    @apply ml-auto rounded py-3 px-4 bg-background w-[30%] min-w-[120px] flex flex-col justify-center items-center lg:flex-row lg:justify-around lg:place-items-center;
+    @apply ml-auto rounded py-3 px-4 bg-background w-64 md:w-96 flex flex-col justify-center items-center xl:flex-row xl:justify-between xl:place-items-center;
   }
 
   &__card__list-project__amount {
-    @apply font-semibold text-gray-2 text-xl inline-block text-center mb-2 md:mb-0;
+    @apply font-semibold text-gray-2 text-xl inline-block m-auto;
+
+    span {
+      @apply text-md;
+    }
   }
 
   &__card__highlight-vote {
-    @apply justify-center flex flex-col w-full md:w-1/4 bg-background p-4 bg-background font-bold text-gray-2 ml-auto;
+    @apply justify-center flex w-full xl:w-2/5 items-center bg-background p-4 bg-background font-bold text-gray-2 ml-auto;
   }
 
   &__card__highlight-vote__header {
-    @apply place-items-start pb-2;
-  }
-
-  &__card__highlight-vote__text {
-    @apply block text-sm text-gray-2 font-normal;
+    @apply place-items-start w-1/3;
   }
 
   &__card__highlight-vote__number {
     @apply text-xl font-semibold;
+
+    span {
+      @apply text-sm;
+    }
   }
 
   &__card__highlight-vote__button {
-    @apply mt-auto text-left mt-2;
+    @apply mt-auto text-left;
 
     &.button__secondary:hover {
       @apply text-white #{!important};
@@ -118,11 +130,15 @@
   }
 
   &__definition-data__title {
-    @apply text-sm text-gray-2 mt-6 mb-2 block;
+    @apply text-sm text-gray-2 mb-2 block;
   }
 
   &__definition-data__number {
     @apply text-gray-2 font-bold text-3xl bg-background text-center p-2 rounded;
+
+    span {
+      @apply text-2xl;
+    }
   }
 
   &__filter-title {
@@ -134,7 +150,7 @@
   }
 
   &__list--header {
-    @apply flex items-center justify-between -ml-2 md:ml-0;
+    @apply flex items-center justify-between;
   }
 
   &-list {
@@ -159,6 +175,10 @@
 
       .card__list {
         @apply inline-block w-[65%];
+
+        &-metadata span {
+          @apply text-xs;
+        }
       }
 
       + .project-item {
@@ -170,7 +190,7 @@
 
 #budgets-to-vote {
   .card__highlight-text {
-    @apply w-full md:w-[70%] p-0;
+    @apply w-full lg:w-[70%] p-0;
   }
 
   .order-by {
@@ -179,7 +199,7 @@
 }
 
 .verification-modal .card__list .budget__card__list-project {
-  @apply inline-block w-[25%] text-center;
+  @apply inline-block w-80 sm:w-48 text-center;
 }
 
 #budgets.card__highlight-container {
@@ -187,7 +207,7 @@
 }
 
 .progressbox-fixed-wrapper {
-  @apply bg-tertiary fixed hidden inset-x-0 inset-y-0 h-max z-20;
+  @apply bg-tertiary fixed hidden inset-x-0 inset-y-0 h-max z-40;
 
   box-shadow: 0 4px 6px 0 rgba(211, 211, 211, 0.25);
 }
@@ -209,27 +229,27 @@
 }
 
 .budget-summary__progressbox--checked_out {
-  @apply hidden md:block;
+  @apply hidden lg:block;
 }
 
 .budget-summary__content {
-  @apply md:grid md:grid-cols-12 md:items-center md:px-16 pt-4 px-4;
+  @apply lg:grid lg:grid-cols-12 lg:items-center lg:px-16 pt-4 px-4;
 }
 
 .budget-summary__progressbox {
-  @apply md:col-span-8;
+  @apply lg:col-span-8;
 }
 
 .budget-summary__progressbox-buttons {
-  @apply md:col-span-3 md:col-start-10;
+  @apply lg:col-span-3 lg:col-start-10;
 }
 
 .budget-summary__button-modal {
-  @apply hidden lg:text-secondary lg:block lg:col-span-12 lg:mb-4 lg:pb-4;
+  @apply hidden xl:text-secondary xl:block xl:col-span-12 xl:mb-4 xl:pb-4;
 }
 
 .budget-summary__button-dropdown {
-  @apply col-span-12 text-secondary lg:hidden;
+  @apply col-span-12 text-secondary xl:hidden;
 
   &_text {
     @apply flex gap-4 justify-start;
@@ -246,42 +266,42 @@
 
 .progressbox-fixed-wrapper {
   .budget-summary__progressbar {
-    @apply md:pl-32 md:pr-8;
+    @apply lg:pl-32 lg:pr-8;
   }
 
   .budget-summary__progressbox {
-    @apply md:col-span-5 md:col-start-4;
+    @apply lg:col-span-5 lg:col-start-4;
   }
 
   .budget-summary__progressbox-buttons {
-    @apply md:col-start-10 md:col-span-2;
+    @apply lg:col-start-10 lg:col-span-2;
   }
 }
 
 #project-item {
   .budget-summary__content {
-    @apply py-4 md:py-4 md:container md:grid grid-cols-1 md:grid-cols-12 md:items-center;
+    @apply py-4 lg:py-4 lg:container lg:grid grid-cols-1 lg:grid-cols-12 lg:items-center;
   }
 
   .budget-summary__progressbox {
-    @apply md:col-start-2 md:col-span-7 relative;
+    @apply lg:col-start-2 lg:col-span-7 relative;
   }
 
   .budget-summary__progressbox-buttons {
-    @apply md:col-start-10 md:col-span-2;
+    @apply lg:col-start-10 lg:col-span-2;
   }
 
   .budget-summary__button-modal {
-    @apply hidden lg:text-secondary lg:block lg:col-span-10 lg:col-start-2 lg:justify-start;
+    @apply hidden xl:text-secondary xl:block xl:col-span-10 xl:col-start-2 xl:justify-start;
   }
 
   .budget-summary__button-dropdown {
-    @apply block text-secondary col-span-10 col-start-2 justify-start lg:hidden;
+    @apply block text-secondary col-span-10 col-start-2 justify-start xl:hidden;
   }
 
   .progressbox-fixed-wrapper {
     .budget-summary__progressbar {
-      @apply md:col-start-1 md:col-span-7;
+      @apply lg:col-start-1 lg:col-span-7;
     }
   }
 }

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

@@ -10,21 +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 unless [:project, :order].include? permission_action.subject
-
-        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!
-          when :read
-            toggle_allow(project.visible?)
-          end
+        case [permission_action.action, permission_action.subject]
+        when [:vote, :project]
+          can_vote?(false) if can_vote_project?(project || order&.projects&.first)
+        when [:report, :project]
+          permission_action.allow!
+        when [:read, :project]
+          toggle_allow(project.visible?)
+        when [:create, :order]
+          can_vote?(true)
+        when [:export_pdf, :order]
+          can_export_pdf?
         end
 
-        can_vote?(true) if permission_action.action == :create && permission_action.subject == :order
-
         permission_action
       end
 
@@ -61,6 +59,12 @@ module Decidim
 
         toggle_allow(is_allowed)
       end
+
+      def can_export_pdf?
+        is_allowed = order.user == user
+
+        toggle_allow(is_allowed)
+      end
     end
   end
 end

data/app/presenters/decidim/budgets/project_presenter.rb

@@ -5,15 +5,13 @@ module Decidim
     class ProjectPresenter < Decidim::ResourcePresenter
       # Renders the title of the project
       #
-      # @param links [Boolean] Should hashtags in the title be rendered as links? Default is +false+.
-      # @param extras [Boolean] Should extra hashtags be included? Default is +true+.
       # @param html_escape [Boolean] Should HTML entities within the title be escaped? Default is +false+.
       # @param all_locales [Boolean] Should the title be returned for all locales? Default is +false+.
       # @return [String] The title of the project.
-      def title(links: false, extras: true, html_escape: false, all_locales: false)
+      def title(html_escape: false, all_locales: false)
         return unless project
 
-        super(project.title, links, html_escape, all_locales, extras:)
+        super(project.title, html_escape, all_locales)
       end
 
       delegate_missing_to :project