decidim-budgets 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aa8f0db3125a7ddb93f9076d6e4fff7256cb1934
+  data.tar.gz: 109c2f3e91977e116a7d5baccf9fa142a78e100f
+SHA512:
+  metadata.gz: 673eb952dde2972556bdcb286255d7a456f9f738764901f0c832adea7b8ea3d606b248cf4f6a33fc166ef4ed21b95f53c71d4f112745be53228e445acb7f04fd
+  data.tar.gz: 4e22d0bb6a0acc9a3c8820ef305eefb3a273521063908895e84f0b6a2c65c9a692e05986047949c5faaa54e396e2c9c522642be4e331d869552cfd7e215a8779

data/README.md

@@ -0,0 +1,23 @@
+# 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.
+
+## Usage
+Budgets will be available as a Feature for a Participatory Process.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'decidim-budgets
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Contributing
+See [Decidim](https://github.com/AjuntamentdeBarcelona/decidim).
+
+## License
+See [Decidim](https://github.com/AjuntamentdeBarcelona/decidim).

data/Rakefile

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+require "decidim/dev/common_rake"

data/app/assets/config/decidim_budgets_manifest.js

@@ -0,0 +1 @@
+//= link decidim/budgets/projects.js

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

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="8" height="8" viewBox="0 0 8 8">
+  <path d="M2 0v1h-.75c-.68 0-1.25.57-1.25 1.25v.5c0 .68.44 1.24 1.09 1.41l2.56.66c.14.04.34.29.34.44v.5c0 .14-.11.25-.25.25h-2.5c-.12 0-.21-.04-.25-.06v-.94h-1v1c0 .34.2.63.44.78.23.16.52.22.81.22h.75v1h1v-1h.75c.69 0 1.25-.56 1.25-1.25v-.5c0-.68-.44-1.24-1.09-1.41l-2.56-.66c-.14-.04-.34-.29-.34-.44v-.5c0-.14.11-.25.25-.25h2.5c.11 0 .21.04.25.06v.94h1v-1c0-.34-.2-.63-.44-.78-.23-.16-.52-.22-.81-.22h-.75v-1h-1z"
+  transform="translate(1)" />
+</svg>

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

@@ -0,0 +1,28 @@
+// = require_self
+
+$(() => {
+  const $projects = $('#projects, #project');
+  const $budgetSummaryTotal = $('.budget-summary__total');
+  const $budgetExceedModal = $('#budget-excess');
+
+  const totalBudget = $budgetSummaryTotal.data('total-budget');
+
+  const cancelEvent = (event) => {
+    event.stopPropagation();
+    event.preventDefault();
+  };
+
+  $projects.on('click', '.budget--list__action', (event) => {
+    const currentBudget = $('.budget-summary__progressbox').data('current-budget');
+    const $currentTarget = $(event.currentTarget);
+    const projectBudget = $currentTarget.data('budget');
+
+    if ($currentTarget.attr('disabled')) {
+      cancelEvent(event);
+
+    } else if ($currentTarget.data('add') && ((currentBudget + projectBudget) > totalBudget)) {
+      $budgetExceedModal.foundation('toggle');
+      cancelEvent(event);
+    }
+  });
+});

data/app/assets/stylesheets/decidim/budgets/_budgets.scss

@@ -0,0 +1 @@
+@import "budget/*";

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

@@ -0,0 +1,32 @@
+.budget-list__title{
+  @include breakpoint(smallmedium down){
+    font-size: $global-font-size;
+  }
+}
+.budget-list__data{
+  flex-basis: 9rem;
+  @include breakpoint(medium){
+    flex-direction: row;
+    flex-basis: 16rem;
+  }
+}
+.budget-list__data--added{
+  background-color: mix(white, $success, 80%);
+}
+
+.budget-list__number{
+  @include breakpoint(medium down){
+    font-size: 1rem;
+  }
+  @include breakpoint(medium){
+    flex-grow: 1;
+    font-size: 1.5rem;
+    margin-right: 1rem;
+    margin-bottom: 0;
+    text-align: right;
+  }
+}
+
+.budget--list__action{
+  margin-bottom: 0;
+}

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

@@ -0,0 +1,78 @@
+.budget-summary__total{
+  margin-bottom: .5rem;
+}
+
+.budget-summary__progressbox{
+  align-items: stretch;
+  margin-bottom: .5rem;
+  @include breakpoint(smallmedium down){
+    text-align: center;
+  }
+  @include breakpoint(medium){
+    display: flex;
+  }
+  .button{
+    margin-bottom: 0;
+  }
+}
+
+.progressbox-fixed-wrapper{
+  position: fixed;
+  top: 0;
+  left: 0;
+  right: 0;
+  z-index: 2;
+  background: $white;
+  box-shadow: 0 2px 7px rgba(black,.1);
+  display: none;
+  &.is-progressbox-visible{
+    display: block;
+  }
+
+}
+
+.budget-summary__progressbox--fixed{
+  margin: auto;
+  max-width: $global-width;
+  padding: 1rem 2rem;
+  @include breakpoint(mediumlarge){
+    padding: 1rem 4rem;
+  }
+  display: flex;
+}
+
+.budget-progress{
+  flex-grow: 1;
+  margin-bottom: .5rem;
+  min-height: 1.5rem;
+  @include breakpoint(medium){
+    min-height: 2rem;
+    margin-bottom: 0;
+    margin-right: 1rem;
+  }
+}
+
+.budget-progress--fixed{
+  min-height: 2rem;
+  margin-bottom: 0;
+  margin-right: 1rem;
+}
+
+
+.budget-progress__meter{
+  min-width: 0.1%;
+}
+
+.budget-summary__selected{
+  border-top: $border;
+  padding-top: .5rem;
+  padding-bottom: .5rem;
+}
+
+.budget-summary__selected-list{
+  margin-top: 2rem;
+}
+
+.budget-summary__selected-number{
+  margin: 0 .5rem;
+}

data/app/assets/stylesheets/decidim/budgets/budget/_progress.scss

@@ -0,0 +1,17 @@
+//Foundation progress extension
+.progress{
+  position: relative;
+}
+.progress-meter--minimum{
+  background: repeating-linear-gradient(-55deg, rgba(white, 0.2), rgba(white, 0.2) 8px, rgba(black, 0.03) 8px, rgba(black, 0.03) 16px);
+  position: absolute;
+}
+
+.progress-meter-text--right{
+  left: auto;
+  min-width: 100%;
+  transform: translate(0, -50%);
+  text-align: right;
+  padding-left: 1rem;
+  padding-right: .5rem;
+}

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+module Decidim
+  module Budgets
+    # A command with all the business to add new line items to orders
+    class AddLineItem < Rectify::Command
+      # Public: Initializes the command.
+      #
+      # order - The current order for the user or nil if it is not created yet.
+      # project - The the project to include in the order
+      # current_user - The current user logged in
+      def initialize(current_order, project, current_user)
+        @order = current_order
+        @project = project
+        @current_user = current_user
+      end
+
+      # Executes the command. Broadcasts these events:
+      #
+      # - :ok when everything is valid.
+      # - :invalid if the there is an error.
+      #
+      # Returns nothing.
+      def call
+        transaction do
+          return broadcast(:invalid) if order.checked_out?
+          add_line_item
+          broadcast(:ok, order)
+        end
+      end
+
+      private
+
+      def order
+        @order ||= Order.create!(user: @current_user, feature: @project.feature)
+      end
+
+      def add_line_item
+        order.projects << @project
+        order.save!
+      end
+    end
+  end
+end

data/app/commands/decidim/budgets/admin/create_project.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+module Decidim
+  module Budgets
+    module Admin
+      # This command is executed when the user creates a Project from the admin
+      # panel.
+      class CreateProject < Rectify::Command
+        def initialize(form)
+          @form = form
+        end
+
+        # Creates the project if valid.
+        #
+        # Broadcasts :ok if successful, :invalid otherwise.
+        def call
+          return broadcast(:invalid) if @form.invalid?
+
+          transaction do
+            create_project
+            link_proposals
+          end
+
+          broadcast(:ok)
+        end
+
+        private
+
+        attr_reader :project
+
+        def create_project
+          @project = Project.create!(
+            scope: @form.scope,
+            category: @form.category,
+            feature: @form.current_feature,
+            title: @form.title,
+            short_description: @form.short_description,
+            description: @form.description,
+            budget: @form.budget
+          )
+        end
+
+        def proposals
+          @proposals ||= project.sibling_scope(:proposals).where(id: @form.proposal_ids)
+        end
+
+        def link_proposals
+          project.link_resources(proposals, "included_proposals")
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/budgets/admin/update_project.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+module Decidim
+  module Budgets
+    module Admin
+      # This command is executed when the user changes a Project from the admin
+      # panel.
+      class UpdateProject < Rectify::Command
+        # Initializes an UpdateProject Command.
+        #
+        # form - The form from which to get the data.
+        # project - The current instance of the project to be updated.
+        def initialize(form, project)
+          @form = form
+          @project = project
+        end
+
+        # Updates the project if valid.
+        #
+        # Broadcasts :ok if successful, :invalid otherwise.
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          transaction do
+            update_project
+            link_proposals
+          end
+
+          broadcast(:ok)
+        end
+
+        private
+
+        attr_reader :project, :form
+
+        def update_project
+          project.update_attributes!(
+            scope: form.scope,
+            category: form.category,
+            title: form.title,
+            short_description: form.short_description,
+            description: form.description,
+            budget: form.budget
+          )
+        end
+
+        def proposals
+          @proposals ||= project.sibling_scope(:proposals).where(id: form.proposal_ids)
+        end
+
+        def link_proposals
+          project.link_resources(proposals, "included_proposals")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+module Decidim
+  module Budgets
+    # A command with all the business to cancel an order.
+    class CancelOrder < Rectify::Command
+      # Public: Initializes the command.
+      #
+      # order - The current order for the user.
+      def initialize(order)
+        @order = order
+      end
+
+      # Executes the command. Broadcasts these events:
+      #
+      # - :ok when everything is valid.
+      # - :invalid if the there is an error.
+      #
+      # Returns nothing.
+      def call
+        return broadcast(:invalid) if invalid_order?
+        cancel_order!
+        broadcast(:ok, @order)
+      end
+
+      private
+
+      def invalid_order?
+        !@order&.checked_out?
+      end
+
+      def cancel_order!
+        @order.destroy!
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+module Decidim
+  module Budgets
+    # A command with all the business to checkout.
+    class Checkout < Rectify::Command
+      # Public: Initializes the command.
+      #
+      # order - The current order for the user.
+      # feature - The current feature.
+      def initialize(order, feature)
+        @order = order
+        @feature = feature
+      end
+
+      # Executes the command. Broadcasts these events:
+      #
+      # - :ok when everything is valid.
+      # - :invalid if the there is an error.
+      #
+      # Returns nothing.
+      def call
+        return broadcast(:invalid) unless @order&.can_checkout?
+        checkout!
+        broadcast(:ok, @order)
+      end
+
+      private
+
+      def checkout!
+        @order.update_attributes!(checked_out_at: Time.current)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+module Decidim
+  module Budgets
+    # A command with all the business to add remove line items from orders
+    class RemoveLineItem < Rectify::Command
+      # Public: Initializes the command.
+      #
+      # order - The current order for the user
+      # project - The the project to remove from the order
+      def initialize(order, project)
+        @order = order
+        @project = project
+      end
+
+      # Executes the command. Broadcasts these events:
+      #
+      # - :ok when everything is valid.
+      # - :invalid if the there is an error.
+      #
+      # Returns nothing.
+      def call
+        return broadcast(:invalid) if @order.checked_out?
+        remove_line_item
+        broadcast(:ok, @order)
+      end
+
+      private
+
+      def remove_line_item
+        @order.projects.destroy(@project)
+        @order.save!
+      end
+    end
+  end
+end

data/app/controllers/concerns/decidim/budgets/needs_current_order.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  module Budgets
+    # Shared behaviour for controllers that need the current order to be present.
+    module NeedsCurrentOrder
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :current_order
+
+        # The current order created by the user.
+        #
+        # Returns an Order.
+        def current_order
+          @current_order ||= Order.includes(:projects).find_by(user: current_user, feature: current_feature)
+        end
+
+        def current_order=(order)
+          @current_order = order
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module Decidim
+  module Budgets
+    module Admin
+      # This controller is the abstract class from which all other controllers of
+      # this engine inherit.
+      #
+      # Note that it inherits from `Decidim::Features::BaseController`, which
+      # override its layout and provide all kinds of useful methods.
+      class ApplicationController < Decidim::Admin::Features::BaseController
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+module Decidim
+  module Budgets
+    module Admin
+      # This controller allows an admin to manage projects from a Participatory Process
+      class ProjectsController < Admin::ApplicationController
+        helper_method :projects
+
+        def new
+          @form = form(ProjectForm).instance
+        end
+
+        def create
+          @form = form(ProjectForm).from_params(params)
+
+          CreateProject.call(@form) do
+            on(:ok) do
+              flash[:notice] = I18n.t("projects.create.success", scope: "decidim.budgets.admin")
+              redirect_to projects_path
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("projects.create.invalid", scope: "decidim.budgets.admin")
+              render action: "new"
+            end
+          end
+        end
+
+        def edit
+          @form = form(ProjectForm).from_model(project)
+        end
+
+        def update
+          @form = form(ProjectForm).from_params(params)
+
+          UpdateProject.call(@form, project) do
+            on(:ok) do
+              flash[:notice] = I18n.t("projects.update.success", scope: "decidim.budgets.admin")
+              redirect_to projects_path
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("projects.update.invalid", scope: "decidim.budgets.admin")
+              render action: "edit"
+            end
+          end
+        end
+
+        def destroy
+          project.destroy!
+
+          flash[:notice] = I18n.t("projects.destroy.success", scope: "decidim.budgets.admin")
+
+          redirect_to projects_path
+        end
+
+        private
+
+        def projects
+          @projects ||= Project.where(feature: current_feature)
+        end
+
+        def project
+          @project ||= projects.find(params[:id])
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Budgets
+    # This controller is the abstract class from which all other controllers of
+    # this engine inherit.
+    #
+    # Note that it inherits from `Decidim::Components::BaseController`, which
+    # override its layout and provide all kinds of useful methods.
+    class ApplicationController < Decidim::Features::BaseController
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Budgets
+    # Exposes the line items resource so users can create and remove from orders.
+    class LineItemsController < Decidim::Budgets::ApplicationController
+      include NeedsCurrentOrder
+
+      helper_method :project
+
+      def create
+        AddLineItem.call(current_order, project, current_user) do
+          on(:ok) do |order|
+            self.current_order = order
+            render "update_budget"
+          end
+
+          on(:invalid) do
+            render nothing: true, status: 422
+          end
+        end
+      end
+
+      def destroy
+        RemoveLineItem.call(current_order, project) do
+          on(:ok) do |_order|
+            render "update_budget"
+          end
+
+          on(:invalid) do
+            render nothing: true, status: 422
+          end
+        end
+      end
+
+      private
+
+      def project
+        @project ||= Project.where(id: params[:project_id], feature: current_feature).first
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Budgets
+    # Exposes the order resource so users can checkout it.
+    class OrdersController < Decidim::Budgets::ApplicationController
+      include NeedsCurrentOrder
+
+      def checkout
+        Checkout.call(current_order, current_feature) do
+          on(:ok) do
+            flash[:notice] = I18n.t("orders.checkout.success", scope: "decidim")
+            redirect_to projects_path
+          end
+
+          on(:invalid) do
+            flash.now[:alert] = I18n.t("orders.checkout.error", scope: "decidim")
+            redirect_to projects_path
+          end
+        end
+      end
+
+      def destroy
+        CancelOrder.call(current_order) do
+          on(:ok) do
+            flash[:notice] = I18n.t("orders.destroy.success", scope: "decidim")
+            redirect_to projects_path
+          end
+
+          on(:invalid) do
+            flash.now[:alert] = I18n.t("orders.destroy.error", scope: "decidim")
+            redirect_to projects_path
+          end
+        end
+      end
+    end
+  end
+end