decidim-budgets 0.26.5 → 0.27.0.rc1

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

@@ -8,7 +8,7 @@ module Decidim
       include NeedsCurrentOrder
       include Decidim::Budgets::Orderable
 
-      helper_method :projects, :project, :budget
+      helper_method :projects, :project, :budget, :all_geocoded_projects
 
       def index
         raise ActionController::RoutingError, "Not Found" unless budget
@@ -28,34 +28,34 @@ module Decidim
       def projects
         return @projects if @projects
 
-        @projects = reorder(search.results)
-        @projects = @projects.page(params[:page]).per(current_component.settings.projects_per_page)
+        @projects = search.result.page(params[:page]).per(current_component.settings.projects_per_page)
+        @projects = reorder(@projects)
+      end
+
+      def all_geocoded_projects
+        @all_geocoded_projects ||= projects.geocoded
       end
 
       def project
         @project ||= Project.find_by(id: params[:id])
       end
 
-      def search_klass
-        ProjectSearch
+      def search_collection
+        Project.where(budget: budget).includes([:scope, :component, :attachments, :category])
       end
 
       def default_filter_params
         {
-          search_text: "",
-          status: default_filter_status_params,
-          scope_id: default_filter_scope_params,
-          category_id: default_filter_category_params
+          search_text_cont: "",
+          with_any_status: default_filter_status_params,
+          with_any_scope: default_filter_scope_params,
+          with_any_category: default_filter_category_params
         }
       end
 
       def default_filter_status_params
         voting_finished? ? %w(selected) : %w(all)
       end
-
-      def context_params
-        { budget: budget, component: current_component, organization: current_organization }
-      end
     end
   end
 end

data/app/forms/decidim/budgets/admin/budget_form.rb

@@ -24,14 +24,14 @@ module Decidim
         #
         # Returns a Decidim::Scope
         def scope
-          @scope ||= @decidim_scope_id ? current_component.scopes.find_by(id: @decidim_scope_id) : current_component.scope
+          @scope ||= @attributes["decidim_scope_id"].value ? current_component.scopes.find_by(id: @attributes["decidim_scope_id"].value) : current_component.scope
         end
 
         # Scope identifier
         #
         # Returns the scope identifier related to the meeting
         def decidim_scope_id
-          @decidim_scope_id || scope&.id
+          super || scope&.id
         end
       end
     end

data/app/forms/decidim/budgets/admin/order_reminder_form.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Budgets
+    module Admin
+      class OrderReminderForm < Decidim::Form
+        def reminder_amount
+          @reminder_amount ||= if !voting_enabled? || voting_ends_soon?
+                                 0
+                               else
+                                 user_ids = []
+                                 unfinished_orders.each do |order|
+                                   reminder = Decidim::Reminder.find_by(component: current_component, user: order.user)
+                                   if !reminder || (reminder.deliveries.present? && reminder.deliveries.last.created_at < minimum_interval_between_reminders.ago)
+                                     user_ids << order.user.id
+                                   end
+                                 end
+                                 user_ids.uniq.count
+                               end
+        end
+
+        def voting_enabled?
+          current_component.current_settings.votes == "enabled"
+        end
+
+        def voting_ends_soon?
+          return false unless participatory_space.respond_to? :active_step
+          return false if participatory_space.active_step.blank?
+
+          time_zone = current_organization.time_zone
+          return false if time_zone.blank?
+
+          end_time = current_component.participatory_space.active_step[:end_date].in_time_zone(time_zone).end_of_day
+
+          6.hours.from_now >= end_time
+        end
+
+        def minimum_interval_between_reminders
+          24.hours
+        end
+
+        private
+
+        def minimum_time_before_first_reminder
+          @minimum_time_before_first_reminder ||= begin
+            reminder_manifest = Decidim.reminders_registry.for(:orders)
+            if reminder_manifest.blank?
+              minimum_interval_between_reminders
+            else
+              Array(reminder_manifest.settings.attributes[:reminder_times].default).first
+            end
+          end
+        end
+
+        def participatory_space
+          @participatory_space ||= current_component.participatory_space
+        end
+
+        def unfinished_orders
+          @unfinished_orders ||= Decidim::Budgets::Order.where(
+            budget: budgets,
+            checked_out_at: nil,
+            created_at: Time.zone.at(0)..minimum_time_before_first_reminder.ago
+          ).select do |order|
+            order.user.email.present?
+          end
+        end
+
+        def budgets
+          @budgets ||= Decidim::Budgets::Budget.where(component: current_component)
+        end
+      end
+    end
+  end
+end

data/app/forms/decidim/budgets/admin/project_form.rb

@@ -13,6 +13,9 @@ module Decidim
         translatable_attribute :title, String
         translatable_attribute :description, String
 
+        attribute :address, String
+        attribute :latitude, Float
+        attribute :longitude, Float
         attribute :budget_amount, Integer
         attribute :decidim_scope_id, Integer
         attribute :decidim_category_id, Integer
@@ -25,7 +28,7 @@ module Decidim
         validates :title, translatable_presence: true
         validates :description, translatable_presence: true
         validates :budget_amount, presence: true, numericality: { greater_than: 0 }
-
+        validates :address, geocoding: true, if: ->(form) { form.has_address? && !form.geocoded? }
         validates :category, presence: true, if: ->(form) { form.decidim_category_id.present? }
         validates :scope, presence: true, if: ->(form) { form.decidim_scope_id.present? }
         validates :decidim_scope_id, scope_belongs_to_component: true, if: ->(form) { form.decidim_scope_id.present? }
@@ -33,6 +36,7 @@ module Decidim
         validate :notify_missing_attachment_if_errored
 
         delegate :categories, to: :current_component
+        alias component current_component
 
         def map_model(model)
           self.proposal_ids = model.linked_resources(:proposals, "included_proposals").pluck(:id)
@@ -49,6 +53,18 @@ module Decidim
                          &.order(title: :asc)
         end
 
+        def geocoding_enabled?
+          Decidim::Map.available?(:geocoding) && current_component.settings.geocoding_enabled?
+        end
+
+        def has_address?
+          geocoding_enabled? && address.present?
+        end
+
+        def geocoded?
+          latitude.present? && longitude.present?
+        end
+
         # Finds the Budget from the decidim_budgets_budget_id.
         #
         # Returns a Decidim::Budgets:Budget
@@ -67,14 +83,14 @@ module Decidim
         #
         # Returns a Decidim::Scope
         def scope
-          @scope ||= @decidim_scope_id ? current_component.scopes.find_by(id: @decidim_scope_id) : current_component.scope
+          @scope ||= @attributes["decidim_scope_id"].value ? current_component.scopes.find_by(id: @attributes["decidim_scope_id"].value) : current_component.scope
         end
 
         # Scope identifier
         #
         # Returns the scope identifier related to the project
         def decidim_scope_id
-          @decidim_scope_id || scope&.id
+          super || scope&.id
         end
 
         private

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Budgets
+    module Admin
+      module ProjectBulkActionsHelper
+        def bulk_selections
+          select(
+            :selected,
+            :value,
+            [
+              [t("projects.index.select_for_implementation", scope: "decidim.budgets.admin"), true],
+              [t("projects.index.deselect_implementation", scope: "decidim.budgets.admin"), false]
+            ]
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -4,6 +4,9 @@ module Decidim
   module Budgets
     # A helper to render order and budgets actions
     module ProjectsHelper
+      include Decidim::ApplicationHelper
+      include Decidim::MapHelper
+
       # Render a budget as a currency
       #
       # budget - A integer to represent a budget
@@ -80,6 +83,32 @@ module Decidim
           t(".vote_threshold_percent_rule.description", minimum_budget: budget_to_currency(current_order.minimum_budget))
         end
       end
+
+      # Serialize a collection of geocoded projects to be used by the dynamic map component
+      #
+      # geocoded_projects - A collection of geocoded projects
+      def projects_data_for_map(geocoded_projects)
+        geocoded_projects.map do |project|
+          project_data_for_map(project)
+        end
+      end
+
+      def project_data_for_map(project)
+        project
+          .slice(:latitude, :longitude, :address)
+          .merge(
+            title: decidim_html_escape(translated_attribute(project.title)),
+            description: html_truncate(decidim_sanitize_editor(translated_attribute(project.description)), length: 100),
+            icon: icon("project", width: 40, height: 70, remove_icon_class: true),
+            link: ::Decidim::ResourceLocatorPresenter.new([project.budget, project]).path
+          )
+      end
+
+      def has_position?(project)
+        return if project.address.blank?
+
+        project.latitude.present? && project.longitude.present?
+      end
     end
   end
 end

data/app/jobs/decidim/budgets/send_vote_reminder_job.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Budgets
+    class SendVoteReminderJob < ApplicationJob
+      queue_as :vote_reminder
+
+      def perform(reminder)
+        return if reminder.records.active.blank?
+
+        ::Decidim::ReminderDelivery.create(reminder: reminder)
+        ::Decidim::Budgets::VoteReminderMailer.vote_reminder(reminder).deliver_now
+      end
+    end
+  end
+end

data/app/mailers/decidim/budgets/vote_reminder_mailer.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Budgets
+    class VoteReminderMailer < Decidim::ApplicationMailer
+      include Decidim::TranslationsHelper
+      include Decidim::SanitizeHelper
+
+      helper Decidim::TranslationsHelper
+
+      helper_method :routes
+
+      # Send the user an email reminder to finish voting
+      #
+      # reminder - the reminder to send.
+      def vote_reminder(reminder)
+        @reminder = reminder
+        @user = reminder.user
+        with_user(@user) do
+          @orders = reminder.records.active.map(&:remindable)
+          @organization = @user.organization
+
+          subject = I18n.t(
+            "decidim.budgets.vote_reminder_mailer.vote_reminder.email_subject",
+            count: @orders.count
+          )
+
+          mail(to: @user.email, subject: subject)
+        end
+      end
+
+      private
+
+      def routes
+        @routes ||= Decidim::EngineRouter.main_proxy(@reminder.component)
+      end
+    end
+  end
+end

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

@@ -5,7 +5,7 @@ module Decidim
     # The data store for a Order in the Decidim::Budgets component. It is unique for each
     # user and component and contains a collection of projects
     class Order < Budgets::ApplicationRecord
-      include Decidim::DataPortability
+      include Decidim::DownloadYourData
       include Decidim::NewsletterParticipant
 
       belongs_to :user, class_name: "Decidim::User", foreign_key: "decidim_user_id"
@@ -15,7 +15,6 @@ module Decidim
       has_many :projects, through: :line_items, class_name: "Decidim::Budgets::Project", foreign_key: "decidim_project_id"
 
       validates :user, uniqueness: { scope: :budget }
-      validates :budget, presence: true
       validate :user_belongs_to_organization
 
       # Rules active for the budget threshold and minimum budgets rules.
@@ -171,7 +170,7 @@ module Decidim
       end
 
       def self.export_serializer
-        Decidim::Budgets::DataPortabilityBudgetsOrderSerializer
+        Decidim::Budgets::DownloadYourDataBudgetsOrderSerializer
       end
 
       def self.newsletter_participant_ids(component)

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

@@ -18,6 +18,7 @@ module Decidim
       include Decidim::Randomable
       include Decidim::Searchable
       include Decidim::TranslatableResource
+      include Decidim::FilterableResource
 
       translatable_fields :title, :description
 
@@ -33,6 +34,10 @@ module Decidim
       scope :selected, -> { where.not(selected_at: nil) }
       scope :not_selected, -> { where(selected_at: nil) }
 
+      geocoded_by :address
+
+      scope_search_multi :with_any_status, [:selected, :not_selected]
+
       searchable_fields(
         scope_id: :decidim_scope_id,
         participatory_space: { component: :participatory_space },
@@ -98,10 +103,9 @@ module Decidim
         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
+      # Create i18n ransackers for :title and :description.
+      # Create the :search_text ransacker alias for searching from both of these.
+      ransacker_i18n_multi :search_text, [:title, :description]
 
       ransacker :selected do
         Arel.sql(%{("decidim_budgets_projects"."selected_at")::text})
@@ -119,6 +123,10 @@ module Decidim
         SQL
         Arel.sql(query)
       end
+
+      def self.ransackable_scopes(_auth_object = nil)
+        [:with_any_status, :with_any_scope, :with_any_category]
+      end
     end
   end
 end

data/app/packs/entrypoints/decidim_budgets_admin.js

@@ -0,0 +1 @@
+import "src/decidim/budgets/admin/projects"

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

@@ -0,0 +1,143 @@
+/* eslint-disable no-invalid-this */
+$(() => {
+  const selectedResourcesCount = () => {
+    return $(".table-list .js-check-all-resources:checked").length
+  }
+
+  const selectedResourcesNotPublishedAnswerCount = () => {
+    return $(".table-list [data-published-state=false] .js-check-all-resources:checked").length
+  }
+
+  const selectedResourcesCountUpdate = () => {
+    const selectedResources = selectedResourcesCount();
+    const selectedResourcesNotPublishedAnswer = selectedResourcesNotPublishedAnswerCount();
+
+    if (selectedResources === 0) {
+      $("#js-selected-resources-count").text("")
+    } else {
+      $("#js-selected-resources-count").text(selectedResources);
+    }
+
+    if (selectedResources >= 2) {
+      $('button[data-action="merge-resources"]').parent().show();
+    } else {
+      $('button[data-action="merge-resources"]').parent().hide();
+    }
+
+    if (selectedResourcesNotPublishedAnswer > 0) {
+      $('button[data-action="publish-answers"]').parent().show();
+      $("#js-form-publish-answers-number").text(selectedResourcesNotPublishedAnswer);
+    } else {
+      $('button[data-action="publish-answers"]').parent().hide();
+    }
+  }
+
+  const showBulkActionsButton = () => {
+    if (selectedResourcesCount() > 0) {
+      $("#js-bulk-actions-button").removeClass("hide");
+    }
+  }
+
+  const hideBulkActionsButton = (force = false) => {
+    if (selectedResourcesCount() === 0 || force === true) {
+      $("#js-bulk-actions-button").addClass("hide");
+      $("#js-bulk-actions-dropdown").removeClass("is-open");
+    }
+  }
+
+  const showOtherActionsButtons = () => {
+    $("#js-other-actions-wrapper").removeClass("hide");
+  }
+
+  const hideOtherActionsButtons = () => {
+    $("#js-other-actions-wrapper").addClass("hide");
+  }
+
+  const hideBulkActionForms = () => {
+    $(".js-bulk-action-form").addClass("hide");
+  }
+
+  if ($("#js-bulk-actions-wrapper").length === 0) {
+    return;
+  }
+
+  // Expose functions to make them available in .js.erb templates
+  window.hideBulkActionForms = hideBulkActionForms;
+  window.hideBulkActionsButton = hideBulkActionsButton;
+  window.showOtherActionsButtons = showOtherActionsButtons;
+  window.selectedResourcesCountUpdate = selectedResourcesCountUpdate;
+
+
+  if ($(".js-bulk-action-form").length) {
+    hideBulkActionForms();
+    $("#js-bulk-actions-button").addClass("hide");
+
+    $("#js-bulk-actions-dropdown ul li button").on("click", (event) => {
+      event.preventDefault();
+      let action = $(event.target).data("action");
+
+      if (action) {
+        $(`#js-form-${action}`).on("submit", () => {
+          $(".layout-content > .callout-wrapper").html("");
+        })
+
+        $(`#js-${action}-actions`).removeClass("hide");
+        hideBulkActionsButton(true);
+        hideOtherActionsButtons();
+      }
+    })
+
+    // select all checkboxes
+    $(".js-check-all").on("change", function() {
+      $(".js-check-all-resources").prop("checked", $(this).prop("checked"));
+
+      if ($(this).prop("checked")) {
+        $(".js-check-all-resources").closest("tr").addClass("selected");
+        showBulkActionsButton();
+      } else {
+        $(".js-check-all-resources").closest("tr").removeClass("selected");
+        hideBulkActionsButton();
+      }
+
+      selectedResourcesCountUpdate();
+    });
+
+    // resource checkbox change
+    $(".table-list").on("change", ".js-check-all-resources", function() {
+      let resourceId = $(this).val()
+      let checked = $(this).prop("checked")
+
+      // uncheck "select all", if one of the listed checkbox item is unchecked
+      if ($(this).prop("checked") === false) {
+        $(".js-check-all").prop("checked", false);
+      }
+      // check "select all" if all checkbox resources are checked
+      if ($(".js-check-all-resources:checked").length === $(".js-check-all-resources").length) {
+        $(".js-check-all").prop("checked", true);
+        showBulkActionsButton();
+      }
+
+      if ($(this).prop("checked")) {
+        showBulkActionsButton();
+        $(this).closest("tr").addClass("selected");
+      } else {
+        hideBulkActionsButton();
+        $(this).closest("tr").removeClass("selected");
+      }
+
+      if ($(".js-check-all-resources:checked").length === 0) {
+        hideBulkActionsButton();
+      }
+
+      $(".js-bulk-action-form").find(`.js-resource-id-${resourceId}`).prop("checked", checked);
+      selectedResourcesCountUpdate();
+    });
+
+    $(".js-cancel-bulk-action").on("click", () => {
+      hideBulkActionForms()
+      showBulkActionsButton();
+      showOtherActionsButtons();
+    });
+  }
+});
+/* eslint-enable no-invalid-this */

data/app/permissions/decidim/budgets/admin/permissions.rb

@@ -19,13 +19,18 @@ module Decidim
             end
           when :project, :projects
             case permission_action.action
-            when :create
-              permission_action.allow!
-            when :import_proposals
+            when :create, :import_proposals, :project_category
               permission_action.allow!
             when :update, :destroy
               permission_action.allow! if project.present?
             end
+          when :order
+            case permission_action.action
+            when :remind
+              permission_action.allow!
+            end
+          when :project_category, :project_scope, :project_selected
+            permission_action.allow!
           end
 
           permission_action

data/app/queries/decidim/budgets/filtered_projects.rb

@@ -3,7 +3,7 @@
 module Decidim
   module Budgets
     # A class used to find projects filtered by components and a date range
-    class FilteredProjects < Rectify::Query
+    class FilteredProjects < Decidim::Query
       # Syntactic sugar to initialize the class and return the queried objects.
       #
       # components - An array of Decidim::Component

data/app/serializers/decidim/budgets/{data_portability_budgets_order_serializer.rb → download_your_data_budgets_order_serializer.rb}

@@ -2,13 +2,13 @@
 
 module Decidim
   module Budgets
-    class DataPortabilityBudgetsOrderSerializer < Decidim::Exporters::Serializer
+    class DownloadYourDataBudgetsOrderSerializer < Decidim::Exporters::Serializer
       # Public: Initializes the serializer with a conversation.
       def initialize(order)
         @order = order
       end
 
-      # Serializes a Debate for data portability
+      # Serializes a Debate for download your data
       def serialize
         {
           id: order.id,

data/app/services/decidim/budgets/order_reminder_generator.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Budgets
+    # This class is the generator class which creates and updates order related reminders,
+    # after reminder is generated it is send to user who have not checked out his/her/their vote.
+    class OrderReminderGenerator
+      attr_reader :reminder_jobs_queued
+
+      def initialize
+        @reminder_manifest = Decidim.reminders_registry.for(:orders)
+        @reminder_jobs_queued = 0
+      end
+
+      # Creates reminders and updates them if they already exists.
+      def generate
+        Decidim::Component.where(manifest_name: "budgets").each do |component|
+          next if component.current_settings.votes != "enabled"
+
+          send_reminders(component)
+        end
+      end
+
+      def generate_for(component, &block)
+        @alternative_refresh_state = block
+        send_reminders(component)
+      end
+
+      private
+
+      attr_reader :reminder_manifest
+
+      def send_reminders(component)
+        budgets = Decidim::Budgets::Budget.where(component: component)
+        pending_orders = Decidim::Budgets::Order.where(budget: budgets, checked_out_at: nil)
+        users = Decidim::User.where(id: pending_orders.pluck(:decidim_user_id).uniq)
+        users.each do |user|
+          reminder = Decidim::Reminder.find_or_create_by(user: user, component: component)
+          users_pending_orders = pending_orders.where(user: user)
+          update_reminder_records(reminder, users_pending_orders)
+          if reminder.records.active.any?
+            Decidim::Budgets::SendVoteReminderJob.perform_later(reminder)
+            @reminder_jobs_queued += 1
+          end
+        end
+      end
+
+      def update_reminder_records(reminder, users_pending_orders)
+        clean_checked_out_and_deleted_orders(reminder)
+        add_pending_orders(reminder, users_pending_orders)
+      end
+
+      def clean_checked_out_and_deleted_orders(reminder)
+        reminder.records.each do |record|
+          if record.remindable.nil?
+            record.update(state: "deleted")
+          elsif record.remindable.checked_out_at.present?
+            record.update(state: "completed")
+          end
+        end
+      end
+
+      def add_pending_orders(reminder, users_pending_orders)
+        reminder.records << users_pending_orders.map { |order| Decidim::ReminderRecord.find_or_create_by(reminder: reminder, remindable: order) }
+        return @alternative_refresh_state.call(reminder) if @alternative_refresh_state.present?
+
+        reminder.records.each do |record|
+          refresh_state(record, reminder.deliveries.length) if %w(active pending).include? record.state
+        end
+      end
+
+      def refresh_state(record, delivered_count)
+        intervals = Array(reminder_manifest.settings.attributes[:reminder_times].default)
+        return record.update(state: "pending") if delivered_count >= intervals.length
+
+        record.state = intervals[delivered_count].ago > record.remindable.created_at ? "active" : "pending"
+        record.save if record.changed?
+      end
+
+      def voting_enabled?(component)
+        component.current_settings.votes == "enabled"
+      end
+    end
+  end
+end