decidim-budgets 0.22.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a52564133c108bcd32c5b1f4729eb4e8430708fbc59dab774f90f07c517f5a01
-  data.tar.gz: e3cc8184fdba7e909b34b89e1ad94955a99134521aed3e4222096b8d10f8f934
+  metadata.gz: 077d69766f3c2f74c8cfd5086383104ccdb406f05d58248ac11c4a93ea6bed0c
+  data.tar.gz: 957fb8550045fdf6acf9fe3453083698deedeb09632e2c7be628574446fd3a60
 SHA512:
-  metadata.gz: f3711ec5978d688a91da72965fa96141cd3ae37a15a709e9529bd7d7a15416313339ebbdfbbf3524fa1a4ee4f734b4a8ac82460ea5bc96732bd92ffea3cfe63c
-  data.tar.gz: ee3b9d5b2ca5ab49f195c3ebc76dc7579ce85d2dfed11e591a5ad1ca56fe4e16e9fa77dd19479e1c0af016aed5b5dbcbf4a8789b6be64bc9ddef975573c10e73
+  metadata.gz: 328372626474416b447a01819af4236c6f23a2f87db34c93de38f874a9f753b0d328693a68bcdbad6e64a7f3a621e8b493aa040ba6096d128db6e94f607e7d3f
+  data.tar.gz: ae2d589d569d8e51355e6f928e9185d9cb0728f1667de5d34029e39bbf6a6465b8f77947a6d0314159a2edb36877aae5af3703786749075ad94de621c80ff913

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/stylesheets/decidim/budgets/budget/_budget-list.scss

@@ -55,6 +55,10 @@
       display: flex;
       align-items: center;
     }
+
+    .card__text--status{
+      display: block;
+    }
   }
 
   &__data{
@@ -102,6 +106,7 @@
     @extend .card-data__item__number;
 
     font-size: 1.5rem;
+    line-height: 1.2;
   }
 
   &__data__votes{

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>

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Budgets
+    # This cell renders the budget item list in the budgets list
+    class BudgetListItemCell < BaseCell
+      delegate :voting_finished?, to: :controller
+
+      property :title
+      alias budget model
+
+      private
+
+      def card_class
+        ["card--list__item"].tap do |list|
+          unless voting_finished?
+            list << "card--list__data-added" if voted?
+            list << "card--list__data-progress" if progress?
+          end
+        end.join(" ")
+      end
+
+      def link_class
+        "card__link card--list__heading"
+      end
+
+      def voted?
+        current_user && status == :voted
+      end
+
+      def progress?
+        current_user && status == :progress
+      end
+
+      def status
+        @status ||= current_workflow.status(budget)
+      end
+    end
+  end
+end

data/app/cells/decidim/budgets/budget_m/data.erb

@@ -0,0 +1,12 @@
+<div class="card__icondata">
+  <ul class="card-data">
+    <li class="card-data__item">
+      <%= icon "euro-outline", class: "icon--big", role: "img", "aria-hidden": true %>
+    </li>
+    <li class="card-data__item">
+      <div class="text-left">
+        <strong class="heading4"><%= budget_to_currency model.total_budget %></strong>
+      </div>
+    </li>
+  </ul>
+</div>

data/app/cells/decidim/budgets/budget_m/footer.erb

@@ -0,0 +1,5 @@
+<div class="card__footer">
+  <div class="card__support">
+    <%= link_to t("view", scope: "decidim.budgets.budget"), resource_path, class: "card__button button button--sc small" %>
+  </div>
+</div>

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Budgets
+    # This cell renders the Medium (:m) budget card
+    # for an given instance of a Decidim::Budgets::Budget
+    class BudgetMCell < Decidim::CardMCell
+      include ActiveSupport::NumberHelper
+      include Decidim::Budgets::ProjectsHelper
+
+      def statuses
+        []
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Budgets
+    # This cell renders the Budgets component header
+    class BudgetsHeaderCell < BaseCell
+      private
+
+      def landing_page_content
+        translated_attribute(current_settings.landing_page_content).presence || translated_attribute(settings.landing_page_content)
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,11 @@
+<% if highlighted? %>
+  <p id="highlighted-budget">
+    <% highlighted.each do |budget| %>
+      <%= link_to(
+            t("highlighted_cta", scope: i18n_scope,
+            name: translated_attribute(budget.title)),
+            resource_locator(budget).path,
+            class: :button ) %>
+    <% end %>
+  </p>
+<% end %>

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

@@ -0,0 +1,20 @@
+<div class="row">
+  <div class="columns medium-7 mediumlarge-8">
+    <% if !voting_finished? && (highlighted? || 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">
+        <%= render :card_list %>
+      </div>
+    </div>
+  </div>
+</div>

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

@@ -0,0 +1,43 @@
+<% if voted? %>
+  <div id="voted-budgets">
+    <p class="lead">
+      <%= t(:voted_on, scope: i18n_scope, links: budgets_link_list(voted)) %>
+    </p>
+
+    <% if finished? %>
+      <p class="lead">
+        <%= t(:finished_message, scope: i18n_scope) %>
+      </p>
+    <% end %>
+
+    <% if voting_open? %>
+      <div>
+        <p>
+          <%= t(:if_change_opinion, scope: i18n_scope) %>
+          <%= link_to(
+          t("cancel_order.only_one", scope: i18n_scope),
+          budget_order_path(voted.first),
+          method: :delete,
+          data: { confirm: t("projects.budget_summary.are_you_sure", scope: "decidim.budgets") }) if voted.one? %>
+        </p>
+
+        <% if !voted.one? && voted.any? %>
+          <ul>
+            <% voted.each do |budget| %>
+              <li>
+                <%= link_to(
+                            t("cancel_order.more_than_one", scope: i18n_scope, name: translated_attribute(budget.title)),
+                            budget_order_path(budget),
+                            method: :delete,
+                            class: "cancel-order",
+                            data: {
+                              confirm: t("projects.budget_summary.are_you_sure", scope: "decidim.budgets")
+                            }) %>
+              </li>
+            <% end %>
+          </ul>
+        <% end %>
+      </div>
+    <% end %>
+  </div>
+<% end %>

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Budgets
+    # This cell renders the budgets list of a Budget component
+    class BudgetsListCell < BaseCell
+      alias current_workflow model
+
+      delegate :allowed, :budgets, :highlighted, :voted, to: :current_workflow
+      delegate :voting_open?, :voting_finished?, to: :controller
+
+      def show
+        return unless budgets
+
+        render
+      end
+
+      private
+
+      def highlighted?
+        current_user && highlighted.any?
+      end
+
+      def voted?
+        current_user && voted.any?
+      end
+
+      def finished?
+        return unless budgets.any?
+
+        current_user && (allowed - voted).none?
+      end
+
+      def i18n_scope
+        "decidim.budgets.budgets_list"
+      end
+    end
+  end
+end