decidim-budgets 0.25.2 → 0.26.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 962bc802aefb2f454ad4737af4062ded5b34c49a55f89cad22cdd97bc7fb60be
-  data.tar.gz: 81321d312849f1f2223a47a8eca5bdb1a6a5f846cce4e23ea01784fef415cb3e
+  metadata.gz: 5faa45ba2c53c8c620e02d864b28790d7a776a82aa4650fdf6e5bfa36353adb3
+  data.tar.gz: d4698f56fef1acacb46f2f37f0eea903c543814d063b6473e7ebfa5677113fac
 SHA512:
-  metadata.gz: 56952ca141f9df95aa2cf01af89542a968277729eb2b8214bf4f714cf0c9957f7e414dd21cf809a20c158ee75c9b7a410cfea4b0e1a12dd497737a3ca2bc37b0
-  data.tar.gz: 9df57bd7064cae9ae426208e79677475cb8a0fdcf28f30212027eb28cdb6e50031b88618e8d50ee9d32b61ee5a4435af15d21c92813a03f0322b41db11de6578
+  metadata.gz: a19091bcad973926f835062473591c953166beda0fce9f7529cc1902569c40aa0fb9526fa4f25d8810ca62a9e1d2fb9d93a3e32845f3e9f5f8cc2f0966e432e5
+  data.tar.gz: 9f10d173bdf303db02468bd2bf3fcb78d9f18a052d148e955d934d7bdb1df78150bd90136442d63eb7627e9cc03af1c584ddcbd417aba49188712ab07eb349c8

data/app/assets/stylesheets/decidim/budgets/budget/_budget-vote-button.scss

@@ -0,0 +1,22 @@
+.budget-vote-button.expanded{
+  display: flex;
+  text-align: left;
+  justify-content: space-between;
+  align-items: center;
+
+  span{
+    font-size: 1rem;
+  }
+
+  &.added{
+    background-color: tint($success, 80%);
+    color: $body-font-color;
+  }
+
+  &:not(.added){
+    .budget-list__action{
+      border-color: white;
+      color: white;
+    }
+  }
+}

data/app/cells/decidim/budgets/budget_information_modal/show.erb

@@ -1,10 +1,10 @@
-<button class="link" data-open="budget-modal-info" aria-controls="budget-modal-info" aria-haspopup="true" tabindex="0">
+<button class="link" data-open="budget-modal-info" aria-controls="budget-modal-info" aria-haspopup="dialog" tabindex="0">
   <%= t(:more_information, scope: i18n_scope) %>
 </button>
 
-<div class="reveal" data-reveal id="budget-modal-info">
+<div class="reveal" data-reveal id="budget-modal-info" aria-modal="true" aria-labelledby="budget-modal-info-label">
   <div class="reveal__header">
-    <h3 class="reveal__title"><%= decidim_sanitize(component_name) %></h3>
+    <h3 id="budget-modal-info-label" class="reveal__title"><%= decidim_sanitize(component_name) %></h3>
     <button class="close-button" data-close aria-label="<%= t(:close_modal, scope: i18n_scope) %>" type="button">
       <span aria-hidden="true">×</span>
     </button>

data/app/cells/decidim/budgets/budget_list_item/show.erb

@@ -1,22 +1,38 @@
-<div class="<%= card_class %>">
-  <div class="card--list__text">
+<div class="<%= card_class %> budget-list__item budget-list__item-cell">
+  <div class="budget-list__text flex-horizontal">
     <%= link_to budget_path(budget), class: link_class do %>
-      <% if voted? && !voting_finished? %>
-        <strong>
-          <%= translated_attribute(title) %>
-        </strong>
-        <span class="button tiny success card--list__check card--list__check--disabled">
-          <%= icon "check", class: "icon--small", role: "img", aria_label: t("decidim.budgets.budget_list_item.voting_finished") %>
-        </span>
-      <% else %>
+      <h5 class="card--list__heading">
         <%= translated_attribute(title) %>
+      </h5>
+    <% end %>
+
+    <h5>
+      <strong>
+        <%= budget_to_currency(total_budget) %>
+      </strong>
+    </h5>
+
+    <%= decidim_sanitize html_truncate(translated_attribute(description), length: 140) %>
+  </div>
 
-        <% if progress? && !voting_finished? %>
-          <span class="button tiny hollow secondary card--list__check card--list__check--disabled">
-            <%= icon "bookmark", class: "icon--small", role: "img", aria_label: t("decidim.budgets.budget_list_item.voting_started") %>
-          </span>
-        <% end %>
+  <% if !voting_finished? %>
+    <div class="budget-list__icon mr-s">
+      <% if voted? %>
+        <span class="button tiny success card--list__check card--list__check--disabled card--list__check--inline">
+          <%= icon "check", class: "icon--small", role: "img", aria_label: t("decidim.budgets.budget_list_item.voting_finished") %>
+        </span>
+      <% elsif progress? %>
+        <span class="button tiny warning card--list__check card--list__check--disabled card--list__check--inline">
+          <%= icon "bookmark", class: "icon--small", role: "img", aria_label: t("decidim.budgets.budget_list_item.voting_started") %>
+        </span>
       <% end %>
+    </div>
+  <% end %>
+
+  <div class="budget-list__data">
+    <%= link_to budget_path(budget), class: "button button--sc expanded #{button_class} mb-none" do %>
+      <span><%= button_text %></span>
+      <%= icon "chevron-right", class: "icon--small", role: "img" %>
     <% end %>
   </div>
 </div>

data/app/cells/decidim/budgets/budget_list_item_cell.rb

@@ -4,9 +4,15 @@ module Decidim
   module Budgets
     # This cell renders the budget item list in the budgets list
     class BudgetListItemCell < BaseCell
+      include Decidim::SanitizeHelper
+      include Decidim::ApplicationHelper
+      include ActiveSupport::NumberHelper
+      include Decidim::Budgets::ProjectsHelper
+
       delegate :voting_finished?, to: :controller
+      delegate :highlighted, to: :current_workflow
 
-      property :title
+      property :title, :description, :total_budget
       alias budget model
 
       private
@@ -17,6 +23,7 @@ module Decidim
             list << "card--list__data-added" if voted?
             list << "card--list__data-progress" if progress?
           end
+          list << "budget--highlighted" if highlighted?
         end.join(" ")
       end
 
@@ -32,9 +39,31 @@ module Decidim
         current_user && status == :progress
       end
 
+      def highlighted?
+        highlighted.include?(budget)
+      end
+
       def status
         @status ||= current_workflow.status(budget)
       end
+
+      def button_class
+        "hollow" if voted? || !highlighted?
+      end
+
+      def button_text
+        key = if current_workflow.vote_allowed?(budget) && !voted?
+                progress? ? :progress : :vote
+              else
+                :show
+              end
+
+        t(key, scope: i18n_scope)
+      end
+
+      def i18n_scope
+        "decidim.budgets.budgets_list"
+      end
     end
   end
 end

data/app/cells/decidim/budgets/budgets_header/show.erb

@@ -1,7 +1,7 @@
 <div class="row">
   <div class="columns medium-7 mediumlarge-8">
     <div class="section">
-      <%= decidim_sanitize(landing_page_content) %>
+      <%= decidim_sanitize_editor(landing_page_content) %>
     </div>
   </div>
 </div>

data/app/cells/decidim/budgets/budgets_list/card_list.erb

@@ -1,7 +1,18 @@
-<div id="budgets" class="card card--list card--list--mini">
-  <% budgets.each do |budget| %>
-    <% next if highlighted.include?(budget) && !voting_finished? %>
+<%# show highlighted budgets first %>
+<% if highlighted.any? %>
+  <div id="highlighted-budgets" class="card card--list budget-list">
+    <% highlighted.each do |budget| %>
+      <%= cell("decidim/budgets/budget_list_item", budget) %>
+    <% end %>
+  </div>
+<% end %>
 
-    <%= cell("decidim/budgets/budget_list_item", budget) %>
-  <% end %>
-</div>
+<% non_highlighted = (budgets - highlighted - voted) %>
+
+<% if non_highlighted.any? %>
+  <div id="budgets" class="card card--list budget-list">
+    <% non_highlighted.each do |budget| %>
+      <%= cell("decidim/budgets/budget_list_item", budget) %>
+    <% end %>
+  </div>
+<% end %>

data/app/cells/decidim/budgets/budgets_list/show.erb

@@ -1,18 +1,17 @@
 <div class="row">
   <div class="columns medium-7 mediumlarge-8">
-    <% if !voting_finished? && (highlighted? || voted?) %>
+    <% if !voting_finished? && (voted?) %>
       <div class="section">
         <h3 class="section-heading">
           <%= t(:my_budgets, scope: i18n_scope) %>
         </h3>
 
-        <%= render :highlighted %>
         <%= render :voted %>
       </div>
     <% end %>
 
     <div class="row">
-      <div class="columns mediumlarge-6">
+      <div class="columns mediumlarge-12">
         <%= render :card_list %>
       </div>
     </div>

data/app/cells/decidim/budgets/budgets_list/voted.erb

@@ -4,6 +4,12 @@
       <%= t(:voted_on, scope: i18n_scope, links: budgets_link_list(voted)) %>
     </p>
 
+    <div id="voted-budgets" class="card card--list budget-list">
+      <% voted.each do |budget| %>
+        <%= cell("decidim/budgets/budget_list_item", budget) %>
+      <% end %>
+    </div>
+
     <% if finished? %>
       <p class="lead">
         <%= t(:finished_message, scope: i18n_scope) %>

data/app/cells/decidim/budgets/project_list_item/project_data.erb

@@ -14,6 +14,6 @@
       <%= cell("decidim/budgets/project_voted_hint", model, class: "display-block margin-top-1") if current_order_checked_out? && resource_added? %>
     </span>
 
-    <%= render :project_data_vote_button if !current_order_checked_out? && voting_open? %>
+    <%= cell("decidim/budgets/project_vote_button", model) if !current_order_checked_out? && voting_open? %>
   <% end %>
 </div>

data/app/cells/decidim/budgets/{project_list_item/project_data_vote_button.erb → project_vote_button/show.erb}

@@ -3,6 +3,7 @@
       method: vote_button_method,
       remote: true,
       class: "button tiny budget-list__action #{vote_button_class}",
+      id: "project-vote-button-#{model.id}",
       data: {
         add: !resource_added?,
         disable: true,

data/app/cells/decidim/budgets/project_vote_button_cell.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Budgets
+    # This cell renders an authorized_action button
+    # to vote a given instance of a Project in a budget list
+    class ProjectVoteButtonCell < ProjectListItemCell
+    end
+  end
+end

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

@@ -23,7 +23,7 @@ module Decidim
       # Returns nothing.
       def call
         transaction do
-          return broadcast(:invalid) if voting_not_enabled? || order.checked_out?
+          return broadcast(:invalid) if voting_not_enabled? || order.checked_out? || exceeds_budget?
 
           add_line_item
           broadcast(:ok, order)
@@ -44,6 +44,10 @@ module Decidim
         end
       end
 
+      def exceeds_budget?
+        order.allocation_for(project) + order.total > order.available_allocation
+      end
+
       def voting_not_enabled?
         project.component.current_settings.votes != "enabled"
       end

data/app/controllers/concerns/decidim/budgets/admin/filterable.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  module Budgets
+    module Admin
+      module Filterable
+        extend ActiveSupport::Concern
+
+        included do
+          include Decidim::Admin::Filterable
+
+          helper Decidim::Budgets::Admin::FilterableHelper
+
+          private
+
+          def base_query
+            collection
+          end
+
+          def search_field_predicate
+            :id_string_or_title_cont
+          end
+
+          def filters
+            [
+              :scope_id_eq,
+              :category_id_eq,
+              :selected_at_null
+            ]
+          end
+
+          def filters_with_values
+            {
+              scope_id_eq: scope_ids_hash(scopes.top_level),
+              category_id_eq: category_ids_hash(categories.first_class),
+              selected_at_null: [true, false]
+            }
+          end
+
+          # Can't user `super` here, because it does not belong to a superclass
+          # but to a concern.
+          def dynamically_translated_filters
+            [:scope_id_eq, :category_id_eq]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -7,9 +7,14 @@ module Decidim
       class ProjectsController < Admin::ApplicationController
         include Decidim::ApplicationHelper
         include Decidim::Proposals::Admin::Picker if Decidim::Budgets.enable_proposal_linking
+        include Decidim::Budgets::Admin::Filterable
 
         helper_method :projects, :finished_orders, :pending_orders, :present
 
+        def collection
+          @collection ||= budget.projects.page(params[:page]).per(15)
+        end
+
         def new
           enforce_permission_to :create, :project
           @form = form(ProjectForm).from_params(
@@ -72,7 +77,7 @@ module Decidim
         private
 
         def projects
-          @projects ||= budget.projects.page(params[:page]).per(15)
+          @projects ||= filtered_collection
         end
 
         def orders

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

@@ -20,7 +20,7 @@ module Decidim
             end
 
             on(:invalid) do
-              render nothing: true, status: :unprocessable_entity
+              format.js { render "update_budget", status: :unprocessable_entity }
             end
           end
         end
@@ -35,7 +35,7 @@ module Decidim
             end
 
             on(:invalid) do
-              render nothing: true, status: :unprocessable_entity
+              format.js { render "update_budget", status: :unprocessable_entity }
             end
           end
         end

data/app/helpers/decidim/budgets/admin/filterable_helper.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Budgets
+    module Admin
+      module FilterableHelper
+      end
+    end
+  end
+end

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

@@ -46,7 +46,8 @@ module Decidim
         # delimiter. Otherwise e.g. ID 2 would match ID "26" in the original
         # array. This is why we search for match ",2," instead to get the actual
         # position for ID 2.
-        order(Arel.sql("position(concat(',', id::text, ',') in ',#{ids.join(",")},')"))
+        concat_ids = connection.quote(",#{ids.join(",")},")
+        order(Arel.sql("position(concat(',', id::text, ',') in #{concat_ids})"))
       end
 
       def self.log_presenter_class_for(_log)
@@ -92,6 +93,32 @@ module Decidim
       def attachment_context
         :admin
       end
+
+      ransacker :id_string do
+        Arel.sql(%{cast("decidim_budgets_projects"."id" as text)})
+      end
+
+      # Allow ransacker to search for a key in a hstore column (`title`.`en`)
+      ransacker :title do |parent|
+        Arel::Nodes::InfixOperation.new("->>", parent.table[:title], Arel::Nodes.build_quoted(I18n.locale.to_s))
+      end
+
+      ransacker :selected do
+        Arel.sql(%{("decidim_budgets_projects"."selected_at")::text})
+      end
+
+      ransacker :confirmed_orders_count do
+        query = <<-SQL.squish
+        (
+            SELECT COUNT(decidim_budgets_line_items.decidim_order_id)
+            FROM decidim_budgets_line_items
+            LEFT JOIN decidim_budgets_orders ON decidim_budgets_orders.id = decidim_budgets_line_items.decidim_order_id
+            WHERE decidim_budgets_orders.checked_out_at IS NOT NULL
+            AND decidim_budgets_projects.id = decidim_budgets_line_items.decidim_project_id
+        )
+        SQL
+        Arel.sql(query)
+      end
     end
   end
 end

data/app/packs/entrypoints/decidim_budgets.js

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

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

@@ -0,0 +1,131 @@
+const currentAllocationZero = () => {
+  const $budgetSummary = $(".budget-summary__progressbox");
+  return parseInt($budgetSummary.attr("data-current-allocation"), 10) === 0;
+}
+
+const isSafeUrl = (exitUrl) => {
+  if (!exitUrl) {
+    return false
+  }
+
+  const safeUrls = [
+    $(".budget-summary").attr("data-safe-url").split("?")[0],
+    `${location.pathname}#`,
+    `${location.href}#`,
+    "#"
+  ];
+
+  let safe = false;
+  safeUrls.forEach((url) => {
+    if (exitUrl.startsWith(url)) {
+      safe =  true
+    }
+  });
+
+  return safe;
+}
+
+const allowExitFrom = ($el) => {
+  if (currentAllocationZero()) {
+    return true
+  } else if ($el.attr("target") === "_blank") {
+    return true;
+  } else if ($el.parents("#loginModal").length > 0) {
+    return true;
+  } else if ($el.parents("#authorizationModal").length > 0) {
+    return true;
+  } else if ($el.attr("id") === "exit-notification-link") {
+    return true;
+  } else if ($el.parents(".voting-wrapper").length > 0) {
+    return true;
+  } else if (isSafeUrl($el.attr("href"))) {
+    return true
+  }
+
+  return false;
+}
+
+// Don't show browser's default confirmation panel when visit current_path is called in tests.
+const testReload = (initialLocation) => {
+  if (navigator && navigator.webdriver && initialLocation === location.href) {
+    return true;
+  }
+
+  return false;
+}
+
+$(() => {
+  const $exitNotification = $("#exit-notification");
+  const $exitLink = $("#exit-notification-link");
+  const defaultExitUrl = $exitLink.attr("href");
+  const defaultExitLinkText = $exitLink.text();
+  let exitLinkText = defaultExitLinkText;
+  const initialLocation = location.href;
+
+  if ($exitNotification.length < 1) {
+    // Do not apply when not inside the voting pipeline
+    return;
+  }
+
+  const openExitNotification = (url, method = null) => {
+    if (method && method !== "get") {
+      $exitLink.attr("data-method", method);
+    } else {
+      $exitLink.removeAttr("data-method");
+    }
+
+    $exitLink.attr("href", url);
+    $exitLink.html(exitLinkText);
+    $exitNotification.foundation("open");
+  };
+
+  // Handle "beforeunload"
+  window.allowExit = false;
+  $(document).on("click", "a", (event) => {
+    exitLinkText = defaultExitLinkText;
+    window.allowExit = false;
+
+    const $link = $(event.currentTarget);
+    if (allowExitFrom($link)) {
+      window.allowExit = true;
+    } else {
+      event.preventDefault();
+      openExitNotification($link.attr("href"), $link.data("method"));
+    }
+  });
+  // Custom handling for the header sign out so that it won't trigger the
+  // logout form submit and so that it changes the exit link text. This does
+  // not trigger the document link click listener because it has the
+  // data-method attribute to trigger a form submit event.
+  $(".header a.sign-out-link").on("click", (event) => {
+    event.preventDefault();
+    event.stopPropagation();
+
+    const $link = $(event.currentTarget);
+    exitLinkText = $link.text();
+    openExitNotification($link.attr("href"), $link.data("method"));
+  });
+  // Custom handling for the exit link which needs to change the exit link
+  // text to the default text as this is not handled by the document click
+  // listener.
+  $("a[data-open='exit-notification']").on("click", () => {
+    exitLinkText = defaultExitLinkText;
+    openExitNotification(defaultExitUrl);
+  });
+  // Allow all form submits on the page, including language change and sign
+  // out form (when triggered by the exit link click).
+  $(document).on("submit", "form", () => {
+    window.allowExit = true;
+  });
+
+  window.addEventListener("beforeunload", (event) => {
+    const allowExit = window.allowExit;
+    window.allowExit = false;
+
+    if (allowExit || testReload(initialLocation)) {
+      return;
+    }
+
+    event.returnValue = true;
+  });
+});

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

@@ -3,28 +3,28 @@ $(() => {
   const $budgetSummaryTotal = $(".budget-summary__total");
   const $budgetExceedModal = $("#budget-excess");
   const $budgetSummary = $(".budget-summary__progressbox");
+  const $voteButton = $(".budget-vote-button");
   const totalAllocation = parseInt($budgetSummaryTotal.attr("data-total-allocation"), 10);
 
   const cancelEvent = (event) => {
+    $(event.currentTarget).removeClass("loading-spinner");
     event.stopPropagation();
     event.preventDefault();
   };
 
-  const allowExitFrom = ($el) => {
-    if ($el.parents("#loginModal").length > 0) {
-      return true;
-    } else if ($el.parents("#authorizationModal").length > 0) {
-      return true;
-    }
-
-    return false;
-  }
+  $voteButton.on("click", "span", () => {
+    $(".budget-list__action").click();
+  });
 
   $projects.on("click", ".budget-list__action", (event) => {
     const currentAllocation = parseInt($budgetSummary.attr("data-current-allocation"), 10);
     const $currentTarget = $(event.currentTarget);
     const projectAllocation = parseInt($currentTarget.attr("data-allocation"), 10);
 
+    if (!$currentTarget.attr("data-open")) {
+      $currentTarget.addClass("loading-spinner");
+    }
+
     if ($currentTarget.attr("disabled")) {
       cancelEvent(event);
     } else if (($currentTarget.attr("data-add") === "true") && ((currentAllocation + projectAllocation) > totalAllocation)) {
@@ -32,34 +32,4 @@ $(() => {
       cancelEvent(event);
     }
   });
-
-  if ($("#order-progress [data-toggle=budget-confirm]").length > 0) {
-    const safeUrl = $(".budget-summary").attr("data-safe-url").split("?")[0];
-    $(document).on("click", "a", (event) => {
-      if (allowExitFrom($(event.currentTarget))) {
-        window.exitUrl = null;
-      } else {
-        window.exitUrl = event.currentTarget.href;
-      }
-    });
-    $(document).on("submit", "form", (event) => {
-      if (allowExitFrom($(event.currentTarget))) {
-        window.exitUrl = null;
-      } else {
-        window.exitUrl = event.currentTarget.action;
-      }
-    });
-
-    window.addEventListener("beforeunload", (event) => {
-      const currentAllocation = parseInt($budgetSummary.attr("data-current-allocation"), 10);
-      const exitUrl = window.exitUrl;
-      window.exitUrl = null;
-
-      if (currentAllocation === 0 || (exitUrl && exitUrl.startsWith(safeUrl))) {
-        return;
-      }
-
-      event.returnValue = true;
-    });
-  }
 });