decidim-budgets 0.20.1 → 0.23.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e9ce6f985c07de9ead8fe7abd959d3942245bdacf65a7fdd657c209be76c1c1
-  data.tar.gz: 9cdbba896b3130d27226c34a7939bea4b4ee6edb4576623b28e44e609b35cede
+  metadata.gz: 8d8202bc5b020026971f5e5aed7654f2b01492ad20f027fd31dc829301fc5cc8
+  data.tar.gz: 7e2694e4acf2474d34f8104ff546718e34e08eb967f645fa936fa3d04662a1bf
 SHA512:
-  metadata.gz: dd11bcea8e6b62bbf93e632b573bfb4de4225fc6e0395b101d8794af6bdd0284e58e1a539b74bd1c61b3fba11e0f4dc120f0571185f5c1f7ced50507d949b229
-  data.tar.gz: 96af9c618b53fd5d58110dd5af0a0738cb43d382fb51eaef54d961f7c9b8da5bdf3ab62b1c9ba1463211d9813af01a9a45f8b3e02b853e0a72c152059cb446e6
+  metadata.gz: 6cac8af76f499fd4aab8aa50b3e9d0b5290210503bb5ba0991f9f010cdacfd2165e5fd8de26f46e9cc268df0d6dccc0597e250128145d0f8b83efeb6f32b9f0e
+  data.tar.gz: fad58039edad5afc0c28ff1ef16c3cfa35651d241952a5c6eac87c174c0ce6c4fcac8a491bf2d2d920d76a1f295dea9bd57964bcab612e80d3b50eac99c37645

data/README.md

@@ -1,17 +1,25 @@
 # Decidim::Budgets
 
-The Budgets module adds projects to any participatory process. It adds a CRUD engine to the admin and public views scoped inside the participatory process. Projects will link to related proposals and have a budget. The users should be able to distribute a budget between these projects.
+The Budgets module adds budgets with projects related to them to any participatory process. It adds a CRUD engine to the admin and public views scoped inside the participatory space. Projects will link to related proposals and have a budget. The users should be able to distribute a budget between these projects.
 
 ## Usage
 
-Budgets will be available as a Component for a Participatory Process.
+Budgets will be available as a Component for a Participatory Space.
+
+This plugin provides:
+
+* A CRUD engine to manage budgets.
+* A CRUD engine to manage projects related to a budget.
+* Participant orders with the voted projects
+* Budgets workflow to add different rules for budget voting.
+* Public views for budgets and projects.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'decidim-budgets
+gem "decidim-budgets"
 ```
 
 And then execute:
@@ -20,6 +28,33 @@ And then execute:
 bundle
 ```
 
+## Budget Workflows
+
+A budget workflow, let's an admin pick, at the component level, how a user can participate in it.
+By default there are two workflows included in this module, `:one` and `:all` that can be found in the `lib/decidim/budgets/workflows/` directory, any app can add its own workflow.
+
+### Adding a custom workflow
+
+To add a custom workflow, create a workflow that inherits from the `base`, such as:
+
+```rb
+# lib/budgets_workflow_random.rb
+class BudgetsWorkflowRandom < Decidim::Budgets::Workflows::Base
+  # your code here ...
+end
+```
+
+And then add it to the decidim initializer (`config/initializers/decidim_budgets.rb`):
+
+```rb
+require "budgets_workflow_random"
+Decidim::Budgets.workflows[:random] = BudgetsWorkflowRandom
+```
+
+Also remember to add the translated name for the `:random` workflow.
+
+As an example, the `BudgetsWorkflowRandom` (`decidim-generators/lib/decidim/generators/app_templates/budgets_workflow_random.rb`) workflow is added by the generator in the `development_app` and `test_app`.
+
 ## Contributing
 
 See [Decidim](https://github.com/decidim/decidim).

data/app/assets/images/decidim/budgets/icon.svg

@@ -1,11 +1 @@
-<svg xmlns="http://www.w3.org/2000/svg" x="0px" y="0px" viewBox="0 0 36 36" style="enable-background:new 0 0 36 36;" xml:space="preserve">
-  <g>
-    <path d="M18,36C8.1,36,0,27.9,0,18S8.1,0,18,0s18,8.1,18,18S27.9,36,18,36z M18,2C9.2,2,2,9.2,2,18s7.2,16,16,16s16-7.2,16-16 S26.8,2,18,2z"/>
-  </g>
-  <g>
-    <g>
-      <path d="M17.1,28.3c-5.3,0-9.9-4.4-9.9-9.8c0-5.5,4.9-9.5,9.3-9.5H18v9h9v0.9C27,23.2,22.7,28.3,17.1,28.3z M16,10.7 c-4,0.6-6.5,3.7-6.5,7.6c0,4.3,3.6,8,7.7,8c3.9,0,7-3.3,7.6-6.3H16V10.7z"/>
-    </g>
-    <path d="M30,16H20V6h0.6c4.5,0,9.4,4.4,9.4,8.9V16z M22,14h5.5C27,11,24,8.6,22,8V14z"/>
-  </g>
-</svg>
+<svg xmlns="http://www.w3.org/2000/svg" x="0" y="0" enable-background="new 0 0 36 36" viewBox="0 0 36 36" xml:space="preserve"><g><path d="M18,36C8.1,36,0,27.9,0,18S8.1,0,18,0s18,8.1,18,18S27.9,36,18,36z M18,2C9.2,2,2,9.2,2,18s7.2,16,16,16s16-7.2,16-16 S26.8,2,18,2z"/></g><g><g><path d="M17.1,28.3c-5.3,0-9.9-4.4-9.9-9.8c0-5.5,4.9-9.5,9.3-9.5H18v9h9v0.9C27,23.2,22.7,28.3,17.1,28.3z M16,10.7 c-4,0.6-6.5,3.7-6.5,7.6c0,4.3,3.6,8,7.7,8c3.9,0,7-3.3,7.6-6.3H16V10.7z"/></g><path d="M30,16H20V6h0.6c4.5,0,9.4,4.4,9.4,8.9V16z M22,14h5.5C27,11,24,8.6,22,8V14z"/></g></svg>

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

@@ -5,7 +5,7 @@ $(() => {
   const $projects = $("#projects, #project");
   const $budgetSummaryTotal = $(".budget-summary__total");
   const $budgetExceedModal = $("#budget-excess");
-
+  const $budgetSummary = $(".budget-summary__progressbox");
   const totalBudget = parseInt($budgetSummaryTotal.attr("data-total-budget"), 10);
 
   const cancelEvent = (event) => {
@@ -13,17 +13,39 @@ $(() => {
     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($budgetSummary.attr("data-current-budget"), 10);
     const $currentTarget = $(event.currentTarget);
     const projectBudget = parseInt($currentTarget.attr("data-budget"), 10);
 
     if ($currentTarget.attr("disabled")) {
       cancelEvent(event);
 
-    } else if ($currentTarget.attr("data-add") && ((currentBudget + projectBudget) > totalBudget)) {
+    } else if (($currentTarget.attr("data-add") === "true") && ((currentBudget + projectBudget) > totalBudget)) {
       $budgetExceedModal.foundation("toggle");
       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) => {
+      window.exitUrl = event.currentTarget.href;
+    });
+    $(document).on("submit", "form", (event) => {
+      window.exitUrl = event.currentTarget.action;
+    });
+
+    window.onbeforeunload = () => {
+      const currentBudget = parseInt($budgetSummary.attr("data-current-budget"), 10);
+      const exitUrl = window.exitUrl;
+      window.exitUrl = null;
+
+      if (currentBudget === 0 || (exitUrl && exitUrl.startsWith(safeUrl))) {
+        return null;
+      }
+
+      return "";
+    }
+  }
 });

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

@@ -1,36 +1,164 @@
-.budget-list__title{
-  @include breakpoint(smallmedium down){
-    font-size: $global-font-size;
-  }
-}
+.budget-list{
+  margin-bottom: 2rem;
 
-.budget-list__data{
-  flex-basis: 9rem;
+  &__item{
+    padding: 0;
+    background: $card-bg;
+    border: $border;
+    border-bottom: 0;
+    overflow: hidden;
+    display: flex;
 
-  @include breakpoint(medium){
-    flex-direction: row;
-    flex-basis: 16rem;
+    &:first-child{
+      border-top-left-radius: $card-border-radius;
+      border-top-right-radius: $card-border-radius;
+    }
+
+    &:last-child{
+      border-bottom-left-radius: $card-border-radius;
+      border-bottom-right-radius: $card-border-radius;
+      border-bottom: $border;
+    }
   }
-}
 
-.budget-list__data--added{
-  background-color: tint($success, 80%);
-}
+  &__image{
+    overflow: hidden;
+    width: 3.5em;
+    height: 3.5rem;
+    flex-shrink: 0;
+    margin-top: $card-padding-small * .7;
+    margin-bottom: $card-padding-small * .7;
+    margin-left: $card-padding-small / 2;
+
+    @include breakpoint(medium){
+      width: 6rem;
+      height: 4rem;
+      flex-shrink: 0;
+      margin: $card-padding;
+      margin-right: 0;
+    }
 
-.budget-list__number{
-  @include breakpoint(medium down){
-    font-size: 1rem;
+    img{
+      width: 100%;
+      height: 100%;
+      object-fit: cover;
+      object-position: center;
+    }
   }
 
-  @include breakpoint(medium){
+  &__text{
+    padding: $card-padding-small / 2;
     flex-grow: 1;
+
+    @include breakpoint(medium){
+      padding: $card-padding;
+      display: flex;
+      align-items: center;
+    }
+
+    .card__text--status{
+      display: block;
+    }
+  }
+
+  &__data{
+    flex-shrink: 0;
+    align-self: stretch;
+    display: flex;
+    flex-direction: column;
+    align-items: center;
+    justify-content: center;
+    text-align: center;
+    font-size: 85%;
+    line-height: 1;
+    color: $muted;
+    padding: $card-padding-small / 2;
+    background: $card-secondary-bg;
+
+    @include breakpoint(medium){
+      min-width: 7rem;
+      flex-direction: row;
+      justify-content: flex-end;
+      flex-basis: 12rem;
+      padding: 1rem $card-padding;
+    }
+
+    &:last-child{
+      margin-bottom: 0;
+    }
+  }
+
+  &__data__icon{
+    .icon{
+      width: 20px;
+      height: 20px;
+      fill: $muted;
+    }
+
+    &:hover{
+      .icon{
+        fill: $anchor-color;
+      }
+    }
+  }
+
+  &__data__number{
+    @extend .card-data__item__number;
+
     font-size: 1.5rem;
-    margin-right: 1rem;
-    margin-bottom: 0;
-    text-align: right;
+    line-height: 1.2;
   }
-}
 
-.budget--list__action{
-  margin-bottom: 0;
+  &__data__votes{
+    @extend .card-data__item__number;
+
+    @include breakpoint(medium){
+      flex-grow: 1;
+      font-size: 1.2rem;
+      margin-left: 1rem;
+      margin-right: 1rem;
+      margin-bottom: 0;
+      text-align: cemter;
+    }
+  }
+
+  &__data--added{
+    background-color: tint($success, 80%);
+  }
+
+  &__title{
+    font-size: $global-font-size;
+  }
+
+  &__number{
+    @include breakpoint(medium down){
+      font-size: 1rem;
+    }
+
+    @include breakpoint(medium){
+      flex-grow: 1;
+      font-size: 1.2rem;
+      margin-left: 1rem;
+      margin-right: 1rem;
+      margin-bottom: 0;
+      text-align: right;
+    }
+  }
+
+  &__action{
+    margin-bottom: 0;
+    border-radius: 50%;
+    align-self: center;
+    flex-shrink: 0;
+    width: 2em;
+    height: 2em;
+    padding: 0;
+    display: flex;
+    justify-content: center;
+    align-items: center;
+
+    &--disabled{
+      pointer-events: none;
+    }
+  }
 }

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Budgets
+    # This cell has the commons for the budgets cells
+    class BaseCell < Decidim::ViewModel
+      include Decidim::LayoutHelper
+      include Decidim::SanitizeHelper
+      include Decidim::ComponentPathHelper
+      include Decidim::Budgets::Engine.routes.url_helpers
+
+      delegate :current_user, :current_settings, :current_component, :current_workflow, to: :controller
+      delegate :settings, to: :current_component
+
+      def budgets_link_list(budgets)
+        budgets.map { |budget| link_to(translated_attribute(budget.title), resource_locator(budget).path) }
+               .to_sentence
+               .html_safe
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Budgets
+    # This cell renders the budget card for an instance of a budget
+    # the default size is the Medium Card (:m)
+    class BudgetCell < Decidim::ViewModel
+      include Cell::ViewModel::Partial
+
+      def show
+        cell card_size, model, options
+      end
+
+      private
+
+      def card_size
+        "decidim/budgets/budget_m"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+<button class="link" data-open="budget-modal-info" aria-controls="budget-modal-info" aria-haspopup="true" tabindex="0">
+  <%= t(:more_information, scope: i18n_scope) %>
+</button>
+
+<div class="reveal" data-reveal id="budget-modal-info">
+  <div class="reveal__header">
+    <h3 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>
+  </div>
+
+  <%= content_tag(:p, more_information) if more_information %>
+
+  <% unless current_workflow.single? %>
+    <p>
+      <%= link_to t(:back_to, scope: i18n_scope, component_name: component_name), budgets_path %>
+    </p>
+  <% end %>
+
+  <div class="row">
+    <div class="columns medium-8 medium-offset-2">
+      <button class="button expanded" data-close>
+        <%= t(:continue, scope: i18n_scope) %>
+      </button>
+    </div>
+  </div>
+</div>

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Budgets
+    # This cell renders the Budgets component "More information" modal dialog
+    class BudgetInformationModalCell < BaseCell
+      alias budget model
+
+      def more_information
+        translated_attribute(current_settings.more_information_modal).presence || translated_attribute(settings.more_information_modal)
+      end
+
+      def component_name
+        translated_attribute(current_component.name)
+      end
+
+      def i18n_scope
+        "decidim.budgets.budget_information_modal"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+<div class="<%= card_class %>">
+  <div class="card--list__text">
+    <%= 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" %>
+        </span>
+      <% else %>
+        <%= translated_attribute(title) %>
+
+        <% if progress? && !voting_finished? %>
+          <span class="button tiny hollow secondary card--list__check card--list__check--disabled">
+            <%= icon "bookmark", class: "icon--small", role: "img" %>
+          </span>
+        <% end %>
+      <% end %>
+    <% end %>
+  </div>
+</div>