decidim 0.0.2 → 0.0.3

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module Decidim
+  module Budgets
+    # Custom helpers, scoped to the budgets engine.
+    #
+    module ApplicationHelper
+      include PaginateHelper
+      include Decidim::Comments::CommentsHelper
+      include ProjectsHelper
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+module Decidim
+  module Budgets
+    # A helper to render order and budgets actions
+    module ProjectsHelper
+      # Render a budget as a currency
+      #
+      # budget - A integer to represent a budget
+      def budget_to_currency(budget)
+        number_to_currency budget, unit: Decidim.currency_unit, precision: 0
+      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
+      end
+
+      # Return true if the current order is checked out
+      def current_order_checked_out?
+        current_order&.checked_out?
+      end
+
+      # Return true if the user can continue to the checkout process
+      def current_order_can_be_checked_out?
+        current_order&.can_checkout?
+      end
+    end
+  end
+end

data/decidim-budgets/app/models/decidim/budgets/application_record.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+module Decidim
+  module Budgets
+    # Abstract class from which all models in this engine inherit.
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module Decidim
+  module Budgets
+    # The data store for a LineItem in the Decidim::Budgets component. It describes an
+    # association between an order and a project.
+    class LineItem < Budgets::ApplicationRecord
+      belongs_to :order, class_name: Decidim::Budgets::Order, foreign_key: "decidim_order_id"
+      belongs_to :project, class_name: Decidim::Budgets::Project, foreign_key: "decidim_project_id"
+
+      validates :order, presence: true, uniqueness: { scope: :project }
+      validates :project, presence: true
+      validate :same_feature
+
+      def same_feature
+        return unless order && project
+        errors.add(:order, :invalid) unless order.feature == project.feature
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+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
+    class Order < Budgets::ApplicationRecord
+      include Decidim::HasFeature
+
+      feature_manifest_name "budgets"
+
+      belongs_to :user, class_name: Decidim::User, foreign_key: "decidim_user_id"
+
+      has_many :projects, through: :line_items, class_name: Decidim::Budgets::Project, foreign_key: "decidim_project_id"
+      has_many :line_items, class_name: Decidim::Budgets::LineItem, foreign_key: "decidim_order_id", dependent: :destroy
+
+      validates :user, presence: true, uniqueness: { scope: :feature }
+      validate :user_belongs_to_organization
+
+      # Public: Returns the sum of project budgets
+      def total_budget
+        @total_budget ||= projects.sum(&:budget)
+      end
+
+      # Public: Returns true if the order has been checked out
+      def checked_out?
+        checked_out_at.present?
+      end
+
+      # Public: Check if the order total budget is enough to checkout
+      def can_checkout?
+        total_budget.to_f >= minimum_budget
+      end
+
+      # 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
+      end
+
+      # Public: Returns the required minimum budget to checkout
+      def minimum_budget
+        feature.settings.total_budget.to_f * (feature.settings.vote_threshold_percent.to_f / 100)
+      end
+
+      private
+
+      def user_belongs_to_organization
+        return if !user || !organization
+        errors.add(:user, :invalid) unless user.organization == organization
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module Decidim
+  module Budgets
+    # The data store for a Project in the Decidim::Budgets component. It stores a
+    # title, description and any other useful information to render a custom project.
+    class Project < Budgets::ApplicationRecord
+      include Decidim::Resourceable
+      include Decidim::HasFeature
+      include Decidim::HasScope
+      include Decidim::HasCategory
+
+      feature_manifest_name "budgets"
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+module Decidim
+  module Budgets
+    # This class handles search and filtering of projects. Needs a
+    # `current_feature` param with a `Decidim::Feature` in order to
+    # find the projects.
+    class ProjectSearch < ResourceSearch
+      # Public: Initializes the service.
+      # feature     - A Decidim::Feature to get the projects from.
+      def initialize(options = {})
+        super(Project.all, options)
+        @random_seed = options[:random_seed].to_f
+      end
+
+      # Handle the search_text filter
+      def search_search_text
+        query
+          .where(localized_search_text_in(:title), text: "%#{search_text}%")
+          .or(query.where(localized_search_text_in(:description), text: "%#{search_text}%"))
+          .or(query.where(localized_search_text_in(:short_description), text: "%#{search_text}%"))
+      end
+
+      # Handle the scope_id filter
+      def search_scope_id
+        query.where(decidim_scope_id: scope_id)
+      end
+
+      # Returns the random projects for the current page.
+      def results
+        @projects ||= Project.transaction do
+          Project.connection.execute("SELECT setseed(#{Project.connection.quote(random_seed)})")
+          super.reorder("RANDOM()").load
+        end
+      end
+
+      # Returns the random seed used to randomize the proposals.
+      def random_seed
+        @random_seed = (rand * 2 - 1) if @random_seed == 0.0 || @random_seed > 1 || @random_seed < -1
+        @random_seed
+      end
+
+      private
+
+      # Internal: builds the needed query to search for a text in the organization's
+      # available locales. Note that it is intended to be used as follows:
+      #
+      # Example:
+      #   Resource.where(localized_search_text_for(:title, text: "my_query"))
+      #
+      # The Hash with the `:text` key is required or it won't work.
+      def localized_search_text_in(field)
+        options[:organization].available_locales.map do |l|
+          "#{field} ->> '#{l}' ILIKE :text"
+        end.join(" OR ")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+<div class="field" >
+  <%= form.translated :text_field, :title, autofocus: true %>
+</div>
+
+<div class="field" >
+  <%= form.translated :editor, :short_description %>
+</div>
+
+<div class="field" >
+  <%= form.translated :editor, :description %>
+</div>
+
+<div class="field" >
+  <%= form.number_field :budget %>
+</div>
+
+<div class="field" >
+  <%= form.collection_select :decidim_scope_id, current_organization.scopes, :id, :name, include_blank: true %>
+</div>
+
+<div class="field" >
+  <%= form.categories_select :decidim_category_id, current_participatory_process.categories, include_blank: true, disable_parents: false %>
+</div>
+
+<% if @form.proposals %>
+  <%= form.select :proposal_ids,
+                  @form.proposals,
+                  {},
+                  { multiple: true, class: "chosen-select" }
+  %>
+<% end %>

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

@@ -0,0 +1,9 @@
+<h3><%= t ".title" %></h3>
+
+<%= form_for(@form) do |f| %>
+  <%= render partial: 'form', object: f %>
+
+  <div class="actions">
+    <%= f.submit t(".update") %>
+  </div>
+<% end %>

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

@@ -0,0 +1,27 @@
+<h2><%= t(".title") %></h2>
+
+<div class="actions title">
+  <%= link_to t("actions.new", scope: "decidim.budgets", name: t("models.project.name", scope: "decidim.budgets.admin")), new_project_path, class: 'new' if can? :manage, current_feature %>
+</div>
+
+<table class="stack">
+  <thead>
+    <tr>
+      <th><%= t("models.project.fields.title", scope: "decidim.budgets") %></th>
+      <th class="actions"><%= t("actions.title", scope: "decidim.budgets") %></th>
+    </tr>
+  </thead>
+  <tbody>
+    <% projects.each do |project| %>
+      <tr data-id="<%= project.id %>">
+        <td>
+          <%= link_to translated_attribute(project.title), decidim_budgets.project_path(id: project, feature_id: current_feature, participatory_process_id: current_participatory_process), target: :blank %><br />
+        </td>
+        <td class="actions">
+          <%= link_to t("actions.edit", scope: "decidim.budgets"), edit_project_path(project) if can? :update, current_feature %>
+          <%= link_to t("actions.destroy", scope: "decidim.budgets"), project_path(project), method: :delete, class: "small alert button", data: { confirm: t("actions.confirm_destroy", scope: "decidim.budgets") } if can? :destroy, current_feature %>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/decidim-budgets/app/views/decidim/budgets/line_items/update_budget.js.erb

@@ -0,0 +1,21 @@
+var $orderTotalBudget = $('#order-total-budget');
+var $orderSelectedProjects = $('#order-selected-projects');
+var $orderProgress = $('#order-progress');
+var $projectItem = $('#project-<%= project.id %>-item');
+var $projectBudgetButton = $('#project-<%= project.id %>-budget-button');
+var $budgetConfirm = $('#budget-confirm');
+
+$orderTotalBudget.html('<%= j(render partial: 'decidim/budgets/projects/order_total_budget') %>');
+$orderSelectedProjects.html('<%= j(render partial: 'decidim/budgets/projects/order_selected_projects') %>');
+$orderProgress.html('<%= j(render partial: 'decidim/budgets/projects/order_progress') %>');
+$budgetConfirm.html('<%= j(render partial: 'decidim/budgets/projects/budget_confirm') %>')
+
+$(document).foundation();
+
+if ($projectItem.length > 0) {
+  $projectItem.html('<%= j(render partial: 'decidim/budgets/projects/project', locals: { project: project }) %>');
+}
+
+if ($projectBudgetButton.length > 0) {
+  $projectBudgetButton.html('<%= j(render partial: 'decidim/budgets/projects/project_budget_button', locals: { project: project }) %>');
+}

data/decidim-budgets/app/views/decidim/budgets/projects/_budget_confirm.html.erb

@@ -0,0 +1,30 @@
+<% if current_order.present? %>
+  <div class="reveal__header">
+    <h3 class="reveal__title"><%= t('.title') %></h3>
+    <button class="close-button" data-close aria-label="<%= t('.cancel') %>" type="button">
+      <span aria-hidden="true">&times;</span>
+    </button>
+  </div>
+  <p><%= t('.description') %></p>
+  <div class="card card--secondary">
+    <ul class="card__content">
+      <% current_order.projects.each do |project| %>
+        <li class="budget-summary__selected-item">
+          <%= link_to translated_attribute(project.title), project %>
+          <strong class="budget-summary__selected-number">
+            <%= budget_to_currency project.budget %>
+          </strong>
+        </li>
+      <% end %>
+    </ul>
+  </div>
+  <p class="text-center"><%= t('.are_you_sure') %></p>
+    <div class="row">
+      <div class="columns medium-8 medium-offset-2">
+        <%= button_to t('.confirm'), checkout_order_path, class: "button expanded" %>
+      </div>
+    </div>
+  <div class="text-center">
+    <button class="link" data-close><%= t('.cancel') %></button>
+  </div>
+<% end %>

data/decidim-budgets/app/views/decidim/budgets/projects/_budget_excess.html.erb

@@ -0,0 +1,14 @@
+<div class="reveal" data-reveal id="budget-excess">
+  <div class="reveal__header">
+    <h3 class="reveal__title"><%= t('.title') %></h3>
+    <button class="close-button" data-close aria-label="<%= t('.close') %>" type="button">
+      <span aria-hidden="true">&times;</span>
+    </button>
+  </div>
+  <p><%= t('.description') %></p>
+  <div class="row">
+    <div class="columns medium-8 medium-offset-2">
+      <button data-close class="button expanded"><%= t('.ok') %></button>
+    </div>
+  </div>
+</div>

data/decidim-budgets/app/views/decidim/budgets/projects/_budget_summary.html.erb

@@ -0,0 +1,46 @@
+<div class="card budget-summary" data-progress-reference>
+  <div class="card__content">
+    <% if include_heading %>
+      <% if current_order_checked_out? %>
+        <h3 class="heading3"><%= t('.checked_out.title') %></h3>
+        <p>
+          <%= raw t('.checked_out.description', cancel_link: link_to(t('.cancel_order'), order_path, method: :delete, class: 'cancel-order', data: { confirm: t('.are_you_sure') })) %>
+        </p>
+      <% else %>
+        <h3 class="heading3"><%= t('.title') %></h3>
+        <p><%= t('.description', minimum_budget: budget_to_currency(current_order&.minimum_budget)) %></p>
+      <% end %>
+    <% end %>
+
+    <div class="budget-summary__total" data-total-budget="<%= feature_settings.total_budget %>">
+      <span class="mini-title"><%= t('total_budget') %>
+        <strong class="mini-title__strong mini-title__strong--highlight">
+          <%= budget_to_currency(feature_settings.total_budget) %>
+        </strong>
+      </span>
+    </div>
+
+    <div id="order-progress">
+      <%= render partial: 'order_progress' %>
+    </div>
+
+    <div>
+      <span class="mini-title">
+        <%= t('.assigned') %>
+        <strong id="order-total-budget" class="mini-title__strong">
+          <%= render partial: 'order_total_budget' %>
+        </strong>
+      </span>
+    </div>
+  </div>
+
+  <div id="order-selected-projects">
+    <%= render partial: 'order_selected_projects' %>
+  </div>
+</div>
+
+<%= render partial: "budget_excess" %>
+
+<div class="reveal" data-reveal id="budget-confirm">
+  <%= render partial: "budget_confirm" %>
+</div>

data/decidim-budgets/app/views/decidim/budgets/projects/_count.html.erb

@@ -0,0 +1 @@
+<%= t(".projects_count", count: projects.total_count) %>

data/decidim-budgets/app/views/decidim/budgets/projects/_filters.html.erb

@@ -0,0 +1,24 @@
+<%= filter_form_for filter do |form| %>
+  <div class="filters__section">
+    <div class="filters__search">
+      <div class="input-group">
+        <%= form.search_field :search_text, label: false, class: "input-group-field", placeholder: t('.search') %>
+        <div class="input-group-button">
+          <button type="submit" class="button button--muted">
+            <%= icon "magnifying-glass", aria_label: t('.search') %>
+          </button>
+        </div>
+      </div>
+    </div>
+  </div>
+
+  <% if current_organization.scopes.any? %>
+    <%= form.collection_check_boxes :scope_id, current_organization.scopes, lambda {|scope| scope.id.to_s}, :name, legend_title: t('.scopes') %>
+  <% end %>
+
+  <% if current_feature.categories.any? %>
+    <%= form.categories_select :category_id, current_feature.categories, legend_title: t('.category'), disable_parents: false, label: false, include_blank: true %>
+  <% end %>
+
+  <%= form.hidden_field :random_seed %>
+<% end %>

data/decidim-budgets/app/views/decidim/budgets/projects/_linked_projects.html.erb

@@ -0,0 +1,12 @@
+<div class="card card--action card--list">
+  <% resources.each do |project| %>
+    <div class="card--list__item">
+      <%= icon "actions", class: "card--list__icon", remove_icon_class: true %>
+      <%= link_to decidim_resource_path(project), class: "card--list__text card__link card__link--block" do %>
+        <h5 class="card--list__heading">
+          <%= translated_attribute(project.title) %>
+        </h5>
+      <% end %>
+    </div>
+  <% end %>
+</div>

data/decidim-budgets/app/views/decidim/budgets/projects/_order_progress.html.erb

@@ -0,0 +1,34 @@
+<div class="budget-summary__progressbox" data-current-budget="<%= current_order ? current_order.total_budget : 0 %>">
+  <div class="progress budget-progress" role="progressbar" tabindex="0" aria-valuenow="<%= current_order_budget_percent %>" aria-valuemin="<%= feature_settings.vote_threshold_percent %>" aria-valuetext="<%= current_order_budget_percent %>%" aria-valuemax="100">
+    <div class="progress-meter progress-meter--minimum" style="width: <%= 100 - current_order_budget_percent %>%"></div>
+    <!--Change width and text dynamically.-->
+    <div class="progress-meter budget-progress__meter" style="width: <%= current_order_budget_percent %>%">
+      <p class="progress-meter-text progress-meter-text--right"><%= current_order_budget_percent %>%</p>
+    </div>
+  </div>
+  <% unless current_order_checked_out? %>
+    <% if current_order_can_be_checked_out? %>
+      <button class="button small button--sc" data-toggle="budget-confirm"><%= t('.vote') %></button>
+    <% else %>
+      <button class="button small button--sc" data-toggle="budget-confirm" disabled><%= t('.vote') %></button>
+    <% end %>
+  <% end %>
+</div>
+
+<div class="progressbox-fixed-wrapper" data-progressbox-fixed>
+  <div class="budget-summary__progressbox budget-summary__progressbox--fixed">
+    <div class="progress budget-progress budget-progress--fixed" role="progressbar" tabindex="0" aria-valuenow="<%= current_order_budget_percent %>" aria-valuemin="<%= feature_settings.vote_threshold_percent %>" aria-valuetext="<%= current_order_budget_percent %>%" aria-valuemax="100">
+      <div class="progress-meter progress-meter--minimum" style="width: <%= 100 - current_order_budget_percent %>%"></div>
+      <div class="progress-meter budget-progress__meter" style="width: <%= current_order_budget_percent %>%">
+        <p class="progress-meter-text progress-meter-text--right"><%= current_order_budget_percent %>%</p>
+      </div>
+    </div>
+    <% unless current_order_checked_out? %>
+      <% if current_order_can_be_checked_out? %>
+        <button class="button small button--sc" data-toggle="budget-confirm"><%= t('.vote') %></button>
+      <% else %>
+        <button class="button small button--sc" data-toggle="budget-confirm" disabled><%= t('.vote') %></button>
+      <% end %>
+    <% end %>
+  </div>
+</div>