decidim-accountability 0.31.5 → 0.32.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8282353918c8c05b403667bf847e95e351575e384fb49e96115616c5d8148631
-  data.tar.gz: 0660dc95b1448d03e60a629a5410c9013a123b41b61f421011a311fafc8c67a7
+  metadata.gz: 9eba04a15a624218351dd6c849696555c738519560465a3dbb9f0557f6fd20d3
+  data.tar.gz: 74ecda47916f43511aa2d3ac207ab72353c8670c03da7dec91e86cd6568c2037
 SHA512:
-  metadata.gz: e716ec5098729ca8960531254e7bef801cb104618292809ccd8e84108162c2a950271bf59ce62a3a4fa12ca11c240a4a4c704b452716e3f2caceb1a016b6938b
-  data.tar.gz: be075e82c621becda672e11bc92d7bd98497c48a082c057e7a30249c65c7cf3f53cb5c9e8a890a49505a06fe34d51f4d485715ebe5a48431364fb338e4c72f87
+  metadata.gz: 38c87c66c05c767564e3afafdb6e6a0ee398c8a38971c4c07a71e406d21e7452cc2df3dcecec0ab6de3cb7ff3e20431b5e05a55ba73167e44d21c0837931af6a
+  data.tar.gz: 23ac3bee5ac778cf0daf9c19c2663973aeaf4096df51eda0f484aa55ebf153f2b415876cf3af12760597b84ca9a078d0bf444d59db32a711944e8fd6e4ada0bf

data/README.md

@@ -1,29 +1,19 @@
-# Decidim::Accountability
+# decidim-accountability
 
-The Accountability module adds results to any participatory process. It adds a CRUD engine to the admin and public views scoped inside the participatory process. Accountability will link to related meetings and proposals and will be used to show the progress on the related proposals.
+The Accountability module adds results to any participatory space. It adds a CRUD engine to the admin and public views scoped inside the participatory space. Accountability will link to related meetings and proposals and will be used to show the progress on the related proposals.
 
 ## Usage
 
-Accountability will be available as a Component for a Participatory Process.
+Accountability will be available as a Component for a Participatory Space.
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'decidim-accountability'
-```
-
-And then execute:
-
-```bash
-bundle
-```
+This is on the default Decidim installation so you should not change anything to use this component.
 
 ## Contributing
 
-See [Decidim](https://github.com/AjuntamentdeBarcelona/decidim).
+See [Decidim](https://github.com/decidim/decidim).
 
 ## License
 
-See [Decidim](https://github.com/AjuntamentdeBarcelona/decidim).
+See [Decidim](https://github.com/decidim/decidim).

data/app/cells/decidim/accountability/result_metadata/{project_aside.erb → result_aside.erb}

@@ -1,5 +1,5 @@
 <% items.each do |item| %>
-  <div class="accountability__project-aside-item">
+  <div class="accountability__result-aside-item">
     <div><%= icon item[:icon], class: "w-3.5 h-3.5 fill-current text-gray" %><%= item[:text] %></div>
     <div><%= item[:value] %></div>
   </div>

data/app/cells/decidim/accountability/result_metadata_cell.rb

@@ -23,7 +23,7 @@ module Decidim
       private
 
       def result_items
-        return [dates_item, status_item, status_description] if template == :project_aside
+        return [dates_item, status_item, status_description] if template == :result_aside
         return [reference, versions] if template == :show_footer
 
         [dates_item_compact, status_item_compact] + taxonomy_items

data/app/cells/decidim/accountability/{project → result_show}/milestones.erb

@@ -1,10 +1,10 @@
-<ol class="accountability__project-milestones">
+<ol class="accountability__result-milestones">
   <% milestones.each_with_index do |milestone, i| %>
-    <li class="accountability__project-milestones-milestone">
-      <div class="accountability__project-milestones-milestone-number">
+    <li class="accountability__result-milestones-milestone">
+      <div class="accountability__result-milestones-milestone-number">
         <span><%= i + 1 %></span>
       </div>
-      <div class="accountability__project-milestones-milestone-attributes">
+      <div class="accountability__result-milestones-milestone-attributes">
         <h3>
           <%= decidim_sanitize_translated milestone.title %>
         </h3>

data/app/cells/decidim/accountability/{project_cell.rb → result_show_cell.rb}

@@ -4,10 +4,11 @@ require "cell/partial"
 
 module Decidim
   module Accountability
-    # This cell renders a project
-    class ProjectCell < Decidim::ViewModel
+    # This cell renders a result
+    class ResultShowCell < Decidim::ViewModel
       include Decidim::Accountability::ApplicationHelper
       include Cell::ViewModel::Partial
+
       delegate :children, :milestones, to: :model
 
       alias result model
@@ -24,7 +25,7 @@ module Decidim
             text: t("decidim.accountability.results.milestones.title"),
             icon: "route-line",
             method: :cell,
-            args: ["decidim/accountability/project", result, { template: :milestones }]
+            args: ["decidim/accountability/result_show", result, { template: :milestones }]
           },
           {
             enabled: ResultHistoryCell.new(result).render?,

data/app/cells/decidim/accountability/status_cell.rb

@@ -7,7 +7,7 @@ module Decidim
     # This cell renders the status of a taxonomy or a result.
     class StatusCell < Decidim::ViewModel
       include Decidim::Accountability::ApplicationHelper
-      include Decidim::Accountability::BreadcrumbHelper
+      include Decidim::Accountability::CalculatorHelper
       include ActionView::Helpers::NumberHelper
 
       def show
@@ -80,10 +80,6 @@ module Decidim
         options[:render_count]
       end
 
-      def count_calculator(taxonomy_id)
-        Decidim::Accountability::ResultsCalculator.new(current_component, taxonomy_id).count
-      end
-
       def decidim
         Decidim::Accountability::Engine.routes.url_helpers
       end

data/app/commands/decidim/accountability/admin/import_component_to_accountability.rb

@@ -3,7 +3,7 @@
 module Decidim
   module Accountability
     module Admin
-      # A command with all the business logic when an admin imports projects from
+      # A command with all the business logic when an admin imports results from
       # one component to accountability.
       class ImportComponentToAccountability < Decidim::Command
         attr_reader :form

data/app/controllers/concerns/decidim/accountability/admin/filterable.rb

@@ -23,10 +23,6 @@ module Decidim
             collection.includes(:taxonomies).joins(:taxonomies)
           end
 
-          def search_field_predicate
-            :id_string_or_title_cont
-          end
-
           def filters
             [
               :taxonomies_part_of_contains,
@@ -48,7 +44,7 @@ module Decidim
           end
 
           def status_ids_hash(statuses)
-            statuses.each_with_object({}) { |status, hash| hash[status.id] = status.id }
+            statuses.to_h { |status| [status.id, status.id] }
           end
 
           def translated_status_id_eq(id)

data/app/controllers/decidim/accountability/admin/import_components_controller.rb

@@ -15,14 +15,14 @@ module Decidim
           @form = form(Admin::ImportComponentForm).from_params(params, accountability_component: current_component)
 
           ImportComponentToAccountability.call(@form) do
-            on(:ok) do |projects|
-              flash[:notice] = I18n.t("import_components.new.success", scope: "decidim.accountability.admin", count: projects)
+            on(:ok) do |results|
+              flash[:notice] = I18n.t("import_components.new.success", scope: "decidim.accountability.admin", count: results)
               redirect_to results_path
             end
 
             on(:invalid) do
               flash[:alert] = I18n.t("import_components.create.invalid", scope: "decidim.accountability.admin")
-              render action: "new", status: :unprocessable_entity
+              render action: "new", status: :unprocessable_content
             end
           end
         end

data/app/controllers/decidim/accountability/admin/import_results_controller.rb

@@ -21,7 +21,7 @@ module Decidim
             redirect_to import_results_path(current_participatory_space, current_component)
           else
             flash[:alert] = I18n.t("imports.create.invalid", scope: "decidim.accountability.admin")
-            render action: "new", status: :unprocessable_entity
+            render action: "new", status: :unprocessable_content
           end
         end
 

data/app/controllers/decidim/accountability/admin/milestones_controller.rb

@@ -27,7 +27,7 @@ module Decidim
 
             on(:invalid) do
               flash.now[:alert] = I18n.t("milestones.create.invalid", scope: "decidim.accountability.admin")
-              render action: "new", status: :unprocessable_entity
+              render action: "new", status: :unprocessable_content
             end
           end
         end
@@ -51,7 +51,7 @@ module Decidim
 
             on(:invalid) do
               flash.now[:alert] = I18n.t("milestones.update.invalid", scope: "decidim.accountability.admin")
-              render action: "edit", status: :unprocessable_entity
+              render action: "edit", status: :unprocessable_content
             end
           end
         end

data/app/controllers/decidim/accountability/admin/results_bulk_actions_controller.rb

@@ -88,12 +88,12 @@ module Decidim
         end
 
         def result_params
-          @result_params ||= params.require(:result_bulk_actions).permit(
-            :decidim_accountability_status_id,
-            :start_date,
-            :end_date,
-            result_ids: [],
-            taxonomies: []
+          @result_params ||= params.expect(
+            result_bulk_actions: [:decidim_accountability_status_id,
+                                  :start_date,
+                                  :end_date,
+                                  { result_ids: [],
+                                    taxonomies: [] }]
           )
         end
       end

data/app/controllers/decidim/accountability/admin/results_controller.rb

@@ -38,7 +38,7 @@ module Decidim
 
             on(:invalid) do
               flash.now[:alert] = I18n.t("results.create.invalid", scope: "decidim.accountability.admin")
-              render action: "new", status: :unprocessable_entity
+              render action: "new", status: :unprocessable_content
             end
           end
         end
@@ -62,7 +62,7 @@ module Decidim
 
             on(:invalid) do
               flash.now[:alert] = I18n.t("results.update.invalid", scope: "decidim.accountability.admin")
-              render action: "edit", status: :unprocessable_entity
+              render action: "edit", status: :unprocessable_content
             end
           end
         end

data/app/controllers/decidim/accountability/admin/statuses_controller.rb

@@ -5,6 +5,8 @@ module Decidim
     module Admin
       # This controller allows an admin to manage results from a Participatory Process
       class StatusesController < Admin::ApplicationController
+        include Decidim::Accountability::Admin::Filterable
+
         helper_method :statuses
 
         def new
@@ -26,7 +28,7 @@ module Decidim
 
             on(:invalid) do
               flash.now[:alert] = I18n.t("statuses.create.invalid", scope: "decidim.accountability.admin")
-              render action: "new", status: :unprocessable_entity
+              render action: "new", status: :unprocessable_content
             end
           end
         end
@@ -50,7 +52,7 @@ module Decidim
 
             on(:invalid) do
               flash.now[:alert] = I18n.t("statuses.update.invalid", scope: "decidim.accountability.admin")
-              render action: "edit", status: :unprocessable_entity
+              render action: "edit", status: :unprocessable_content
             end
           end
         end
@@ -68,8 +70,18 @@ module Decidim
 
         private
 
+        def base_query
+          Status.where(component: current_component)
+        end
+
+        def filtered_collection
+          query.sorts = ["progress asc", "key asc"] if query.sorts.empty?
+
+          paginate(query.result)
+        end
+
         def statuses
-          @statuses ||= Status.where(component: current_component).page(params[:page]).per(15)
+          @statuses ||= filtered_collection
         end
 
         def status

data/app/controllers/decidim/accountability/results_controller.rb

@@ -5,12 +5,12 @@ module Decidim
     # Exposes the result resource so users can view them
     class ResultsController < Decidim::Accountability::ApplicationController
       include FilterResource
+
       helper Decidim::TraceabilityHelper
       helper Decidim::Accountability::BreadcrumbHelper
+      helper Decidim::Accountability::CalculatorHelper
 
-      helper_method :results, :result, :count_calculator, :selected_root_taxonomy, :selected_taxonomy_children, :selected_taxonomy_grandchildren?
-
-      before_action :set_controller_breadcrumb
+      helper_method :results, :result, :selected_root_taxonomy, :selected_taxonomy_children, :selected_taxonomy_grandchildren?
 
       def show
         raise ActionController::RoutingError, "Not Found" unless result
@@ -66,27 +66,25 @@ module Decidim
                                     end
       end
 
-      def count_calculator(taxonomy_id)
-        Decidim::Accountability::ResultsCalculator.new(current_component, taxonomy_id).count
-      end
-
-      def controller_breadcrumb_items
-        @controller_breadcrumb_items ||= []
-      end
-
-      def set_controller_breadcrumb
-        controller_breadcrumb_items << breadcrumb_item
-      end
-
-      def breadcrumb_item
+      def add_parent_breadcrumb_item
         return {} if result&.parent.blank?
 
         {
           label: translated_attribute(result.parent.title),
-          url: result_path(result.parent),
+          url: Decidim::EngineRouter.main_proxy(current_component).result_path(result.parent),
           active: true
         }
       end
+
+      def add_breadcrumb_item
+        return {} if result.blank?
+
+        {
+          label: translated_attribute(result.title),
+          url: Decidim::EngineRouter.main_proxy(current_component).result_path(result),
+          active: false
+        }
+      end
     end
   end
 end

data/app/controllers/decidim/accountability/versions_controller.rb

@@ -19,6 +19,16 @@ module Decidim
       def result
         @result ||= Result.includes(:milestones).where(component: current_component).find(params[:result_id])
       end
+
+      def add_breadcrumb_item
+        return {} if result.blank?
+
+        {
+          label: translated_attribute(result.title),
+          url: Decidim::EngineRouter.main_proxy(current_component).result_path(result),
+          active: false
+        }
+      end
     end
   end
 end

data/app/helpers/decidim/accountability/breadcrumb_helper.rb

@@ -5,10 +5,6 @@ module Decidim
     # Helpers needed to render the navigation breadcrumbs in results.
     #
     module BreadcrumbHelper
-      def progress_calculator(taxonomy_id)
-        Decidim::Accountability::ResultsCalculator.new(current_component, taxonomy_id).progress
-      end
-
       def taxonomy
         return if (taxonomy_id = params.dig(:filter, :taxonomies_part_of_contains)).blank?
 

data/app/helpers/decidim/accountability/calculator_helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Accountability
+    # Helpers for calculating results progress and count
+    module CalculatorHelper
+      def progress_calculator(taxonomy_id)
+        ResultsCalculator.new(current_component, taxonomy_id).progress
+      end
+
+      def count_calculator(taxonomy_id)
+        ResultsCalculator.new(current_component, taxonomy_id).count
+      end
+    end
+  end
+end

data/app/mailers/decidim/accountability/import_projects_mailer.rb

@@ -3,12 +3,13 @@
 module Decidim
   module Accountability
     # This mailer sends a notification email containing the result of importing
-    # Cprojects to the results.
+    # projects from one budget component to accountability.
     class ImportProjectsMailer < Decidim::ApplicationMailer
       include Decidim::TranslatableAttributes
+
       helper Decidim::TranslationsHelper
 
-      # Public: Sends a notification email with the result of projects import selected projects to Accountability
+      # Public: Sends a notification email with the result of importing projects
       #
       # user   - The user to be notified.
       #

data/app/mailers/decidim/accountability/import_proposals_mailer.rb

@@ -6,6 +6,7 @@ module Decidim
     # proposals to the results.
     class ImportProposalsMailer < Decidim::ApplicationMailer
       include Decidim::TranslatableAttributes
+
       helper Decidim::TranslationsHelper
 
       # Public: Sends a notification email with the result of proposals import selected proposals to Accountability

data/app/models/decidim/accountability/result.rb

@@ -39,13 +39,15 @@ module Decidim
 
       after_save :update_parent_progress, if: -> { parent_id.present? }
 
-      searchable_fields(
-        scope_id: :decidim_scope_id,
-        participatory_space: { component: :participatory_space },
-        A: :title,
-        D: :description,
-        datetime: :start_date
-      )
+      searchable_fields({
+                          scope_id: :decidim_scope_id,
+                          participatory_space: { component: :participatory_space },
+                          A: :title,
+                          D: :description,
+                          datetime: :start_date
+                        },
+                        index_on_create: ->(result) { result.visible? },
+                        index_on_update: ->(result) { result.visible? })
 
       geocoded_by :address
 

data/app/models/decidim/accountability/status.rb

@@ -22,8 +22,11 @@ module Decidim
       # Allow ransacker to search for a key in a hstore column (`name`.`en`)
       ransacker_i18n :name
 
-      def self.ransackable_attributes(_auth_object = nil)
-        %w(id name)
+      def self.ransackable_attributes(auth_object = nil)
+        base = %w(id name)
+        return base unless auth_object&.admin?
+
+        base + %w(key progress)
       end
 
       def self.log_presenter_class_for(_log)

data/app/packs/stylesheets/accountability.scss

@@ -91,7 +91,7 @@
       @apply text-3xl;
     }
 
-    &__project &-title {
+    &__result &-title {
       @apply text-gray-2 text-md font-normal;
     }
   }
@@ -132,7 +132,7 @@
     @apply ml-auto rounded px-3 md:px-6 py-4 bg-background font-bold text-gray-2 text-xl w-full md:w-auto min-w-[120px] grid place-items-center;
   }
 
-  &__project {
+  &__result {
     &-aside {
       @apply bg-background p-4 rounded divide-y divide-gray-3 [&>*]:py-4 first:[&>*]:pt-0 last:[&>*]:pb-0;
 

data/app/permissions/decidim/accountability/permissions.rb

@@ -4,6 +4,7 @@ module Decidim
   module Accountability
     class Permissions < Decidim::DefaultPermissions
       def permissions
+        return permission_action if permission_action.scope == :public && public_read_result_action?
         return permission_action unless user
 
         # Delegate the admin permission checks to the admin permissions class
@@ -11,6 +12,18 @@ module Decidim
 
         permission_action
       end
+
+      private
+
+      def public_read_result_action?
+        return unless permission_action.action == :read && permission_action.subject == :result
+
+        toggle_allow(result && !result.deleted?)
+      end
+
+      def result
+        @result ||= context.fetch(:result, nil)
+      end
     end
   end
 end

data/app/views/decidim/accountability/admin/import_components/new.html.erb

@@ -7,7 +7,7 @@
 
 <div class="item__edit item__edit-1col">
   <div class="item__edit-form">
-    <%= render "form" %>
+    <%= render "decidim/accountability/admin/import_components/form" %>
   </div>
 </div>
 

data/app/views/decidim/accountability/admin/import_results/new.html.erb

@@ -6,7 +6,7 @@
 </div>
 <div class="item__edit item__edit-1col">
   <div class="item__edit-form">
-    <%= decidim_form_for(@form, url: import_results_path, html: { class: "form form-defaults import_projects" }) do |form| %>
+    <%= decidim_form_for(@form, url: import_results_path, html: { class: "form form-defaults import_results" }) do |form| %>
       <div class="card py-4">
         <div class="card-section space-y-4 prose max-w-full">
           <div class="row column">

data/app/views/decidim/accountability/admin/results/_result-tr.html.erb

@@ -2,9 +2,6 @@
   <td>
     <%= check_box_tag "result_ids_s[]", result.id, false, data: { result_id: result.id, result_checkbox: true } %><br>
   </td>
-  <td data-label="<%= t("models.result.fields.id", scope: "decidim.accountability") %>">
-    <%= result.id %><br>
-  </td>
   <td class="!text-left" data-label="<%= t("models.result.fields.title", scope: "decidim.accountability") %>">
     <% if result.parent_id.nil? %>
       <%= link_to translated_attribute(result.title), results_path(parent_id: result.id) %><br>
@@ -21,7 +18,7 @@
     <% end %>
   </td>
   <td data-label="<%= t("models.result.fields.progress", scope: "decidim.accountability") %>">
-    <%= result.progress&.to_i %>
+    <%= result.progress.nil? ? 0 : result.progress&.to_i %>%
   </td>
   <td data-label="<%= t("models.result.fields.created_at", scope: "decidim.accountability") %>">
     <%= l result.created_at, format: :decidim_short %>

data/app/views/decidim/accountability/admin/results/_results-thead.html.erb

@@ -3,9 +3,6 @@
   <th>
     <%= check_box_tag "results_bulk", "all", false, data: { "select-all" => true } %>
   </th>
-  <th>
-    <%= sort_link(query, :id, t("models.result.fields.id", scope: "decidim.accountability"), default_order: :desc ) %>
-  </th>
   <th class="!text-left">
     <%= sort_link(query, :title, t("models.result.fields.title", scope: "decidim.accountability")) %>
   </th>

data/app/views/decidim/accountability/admin/statuses/index.html.erb

@@ -10,10 +10,10 @@
     <table class="table-list">
       <thead>
         <tr>
-          <th><%= t("models.status.fields.key", scope: "decidim.accountability") %></th>
-          <th><%= t("models.status.fields.name", scope: "decidim.accountability") %></th>
+          <th><%= sort_link(query, :key, t("models.status.fields.key", scope: "decidim.accountability")) %></th>
+          <th><%= sort_link(query, :name, t("models.status.fields.name", scope: "decidim.accountability")) %></th>
           <th><%= t("models.status.fields.description", scope: "decidim.accountability") %></th>
-          <th><%= t("models.status.fields.progress", scope: "decidim.accountability") %></th>
+          <th><%= sort_link(query, :progress, t("models.status.fields.progress", scope: "decidim.accountability")) %></th>
           <th><%= t("actions.title", scope: "decidim.accountability") %></th>
         </tr>
       </thead>

data/app/views/decidim/accountability/results/_home_taxonomies.html.erb

@@ -3,7 +3,7 @@
 </h3>
 
 <% if selected_taxonomy_grandchildren? %>
-  <%= render "two_levels_taxonomies" %>
+  <%= render "decidim/accountability/results/two_levels_taxonomies" %>
 <% else %>
-  <%= render "one_level_taxonomies" %>
+  <%= render "decidim/accountability/results/one_level_taxonomies" %>
 <% end %>

data/app/views/decidim/accountability/results/{_project.html.erb → _result.html.erb}

@@ -1,5 +1,5 @@
 <%= render layout: "layouts/decidim/shared/layout_item" do %>
-  <%= cell("decidim/accountability/project", result) %>
+  <%= cell("decidim/accountability/result_show", result) %>
   <%= cell("decidim/tags", result) %>
 
   <section class="layout-main__section layout-main__buttons" data-buttons>
@@ -7,17 +7,17 @@
   </section>
 
   <% content_for :aside do %>
-    <section class="layout-aside__section layout-aside__buttons accountability__project-aside">
+    <section class="layout-aside__section layout-aside__buttons accountability__result-aside">
       <% if component_settings.display_progress_enabled? %>
         <%= cell(
           "decidim/accountability/status",
           result,
           title: t("models.result.fields.progress", scope: "decidim.accountability"),
-          extra_classes: "accountability__status__project"
+          extra_classes: "accountability__status__result"
         ) %>
       <% end %>
 
-    <%= cell("decidim/accountability/result_metadata", result, template: :project_aside) %>
+    <%= cell("decidim/accountability/result_metadata", result, template: :result_aside) %>
     </section>
   <% end %>
   <% content_for :item_footer do %>

data/app/views/decidim/accountability/results/index.html.erb

@@ -8,7 +8,7 @@
 <%= append_stylesheet_pack_tag "decidim_accountability" %>
 
 <% content_for :aside do %>
-  <%= render partial: "projects_aside", locals: { main_action: true } %>
+  <%= render partial: "results_aside", locals: { main_action: true } %>
 <% end %>
 
 <%= render layout: "layouts/decidim/shared/layout_two_col" do %>

data/app/views/decidim/accountability/results/show.html.erb

@@ -16,4 +16,4 @@ edit_link(
 <%= append_javascript_pack_tag "decidim_accountability" %>
 <%= append_stylesheet_pack_tag "decidim_accountability" %>
 
-<%= render partial: "project", locals: { result: } %>
+<%= render partial: "result", locals: { result: } %>

data/config/locales/ar.yml

@@ -183,7 +183,6 @@ ar:
           fields:
             created_at: تم الإنشاء
             end_date: تاريخ الانتهاء
-            id: المعرف ID
             progress: تقدم
             start_date: تاريخ البدء
             status: الحالة