decidim-accountability 0.19.0 → 0.22.0

data/app/jobs/application_job.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class ApplicationJob < ActiveJob::Base
+end

data/app/jobs/decidim/accountability/admin/import_results_csv_job.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Accountability
+    module Admin
+      class ImportResultsCSVJob < ApplicationJob
+        queue_as :default
+
+        def perform(current_user, current_component, csv_file)
+          importer = Decidim::Accountability::ResultsCSVImporter.new(current_component, csv_file, current_user)
+
+          errors = importer.import!
+
+          Decidim::Accountability::ImportMailer.import(current_user, errors).deliver_now
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Accountability
+    # This mailer sends a notification email containing the result of importing a
+    # CSV of results.
+    class ImportMailer < Decidim::ApplicationMailer
+      # Public: Sends a notification email with the result of a CSV import
+      # of results.
+      #
+      # user   - The user to be notified.
+      # errors - The list of errors generated by the import
+      #
+      # Returns nothing.
+      def import(user, errors)
+        @user = user
+        @organization = user.organization
+        @errors = errors
+
+        with_user(user) do
+          mail(to: "#{user.name} <#{user.email}>", subject: I18n.t("decidim.accountability.import_mailer.import.subject"))
+        end
+      end
+    end
+  end
+end

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

@@ -15,6 +15,7 @@ module Decidim
       include Decidim::Loggable
       include Decidim::DataPortability
       include Decidim::Randomable
+      include Decidim::Searchable
 
       component_manifest_name "accountability"
 
@@ -28,6 +29,14 @@ 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
+      )
+
       def self.log_presenter_class_for(_log)
         Decidim::Accountability::AdminLog::ResultPresenter
       end

data/app/queries/decidim/accountability/metrics/results_metric_manage.rb

@@ -9,9 +9,6 @@ module Decidim
         end
 
         def save
-          return @registry if @registry
-
-          @registry = []
           cumulative.each do |key, cumulative_value|
             next if cumulative_value.zero?
 
@@ -26,10 +23,8 @@ module Decidim
                                                            related_object_type: "Decidim::Component",
                                                            related_object_id: related_object_id)
             record.assign_attributes(cumulative: cumulative_value, quantity: quantity_value)
-            @registry << record
+            record.save!
           end
-          @registry.each(&:save!)
-          @registry
         end
 
         private
@@ -40,9 +35,8 @@ module Decidim
           spaces = Decidim.participatory_space_manifests.flat_map do |manifest|
             manifest.participatory_spaces.call(@organization).public_spaces
           end
-          components = Decidim::Component.where(participatory_space: spaces).published
           @query = Decidim::Accountability::Result.select(:decidim_component_id)
-                                                  .where(component: components)
+                                                  .where(component: visible_component_ids_from_spaces(spaces))
                                                   .joins(:component)
                                                   .left_outer_joins(:category)
           @query = @query.where("decidim_accountability_results.created_at <= ?", end_time)

data/app/services/decidim/accountability/results_csv_importer.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require "csv"
+
+module Decidim
+  module Accountability
+    # This class handles importing results from a CSV file.
+    # Needs a `current_component` param with a `Decidim::component`
+    # in order to import the results in that component.
+    class ResultsCSVImporter
+      include Decidim::FormFactory
+
+      # Public: Initializes the service.
+      # component     - A Decidim::component to import the results into.
+      # csv_file      - The contents of the CSV to read.
+      def initialize(component, csv_file, current_user)
+        @component = component
+        @csv_file = csv_file
+
+        @extra_context = {
+          current_component: component,
+          current_organization: component.organization,
+          current_user: current_user,
+          current_participatory_space: component.participatory_space
+        }
+        @matches_ids = []
+      end
+
+      def import!
+        errors = []
+
+        ActiveRecord::Base.transaction do
+          i = 1
+          csv = CSV.new(@csv_file, headers: true, col_sep: ";")
+          while (row = csv.shift).present?
+            i += 1
+            next if row.empty?
+
+            params = set_params_for_import_result_form(row, @component)
+            existing_result = Decidim::Accountability::Result.find_by(id: row["id"], component: @component) if row["id"].present?
+            params["result"].merge!(parse_date_params(row, "start_date"))
+            params["result"].merge!(parse_date_params(row, "end_date"))
+            @form = form(Decidim::Accountability::Admin::ResultForm).from_params(params, @extra_context)
+            errors << [i, @form.errors.full_messages] if @form.errors.any?
+
+            if existing_result.present?
+              Decidim::Accountability::Admin::UpdateImportedResult.call(@form, existing_result, params["result"]["parent/id"]) do
+                on(:invalid) do
+                  errors << [i, @form.errors.full_messages]
+                end
+              end
+            else
+              Decidim::Accountability::Admin::CreateImportedResult.call(@form, params["result"]["parent/id"]) do
+                on(:invalid) do
+                  errors << [i, @form.errors.full_messages]
+                end
+              end
+              add_match_id(row["id"])
+            end
+
+          end
+
+          raise ActiveRecord::Rollback if errors.any?
+
+          update_parents
+          remove_invalid_results
+
+          Rails.logger.info "Processed: #{i}"
+        end
+
+        errors
+      end
+
+      private
+
+      def set_params_for_import_result_form(row, component)
+        params = {}
+        params["result"] = row.to_hash
+        default_locale = component.participatory_space.organization.default_locale
+        available_locales = component.participatory_space.organization.available_locales
+        params["result"].merge!(get_locale_attributes(default_locale, available_locales, :title, row))
+        params["result"].merge!(get_locale_attributes(default_locale, available_locales, :description, row))
+        params["result"]["decidim_category_id"] = row["category/id"] if row["category/id"].present?
+        params["result"]["decidim_accountability_status_id"] = row["status/id"] if row["status/id"].present?
+        params["result"].merge!(get_proposal_ids(row["proposal_urls"]))
+        params
+      end
+
+      def get_locale_attributes(default_locale, available_locales, field, row)
+        array_field_localized = available_locales.map do |locale|
+          if row["#{field}/#{locale}"].present?
+            ["#{field}_#{locale}", row["#{field}/#{locale}"]]
+          else
+            ["#{field}_#{locale}", row["#{field}/#{default_locale}"]]
+          end
+        end
+
+        Hash[*array_field_localized.flatten]
+      end
+
+      def parse_date_params(row, field)
+        begin
+          return { field => Date.parse(row[field]) } if row[field].present?
+        rescue ArgumentError
+          @form.errors.add(field.to_sym, :invalid_date)
+        end
+        {}
+      end
+
+      def get_proposal_ids(proposal_urls)
+        if proposal_urls.present?
+          proposal_urls = proposal_urls.split(";")
+          { "proposal_ids" => proposal_urls.map { |proposal_url| proposal_url.scan(/\d$/).first.to_i } }
+        else
+          {}
+        end
+      end
+
+      def add_match_id(id)
+        last_created_result = Decidim::Accountability::Result.last
+        @matches_ids << [id, Decidim::Accountability::Result.last.id] if id.present? && last_created_result.present?
+      end
+
+      def update_parents
+        @matches_ids.each do |match|
+          Decidim::Accountability::Result.where(component: @component, parent_id: match.first).find_each { |result| result.update(parent_id: match.last) }
+        end
+      end
+
+      def remove_invalid_results
+        Decidim::Accountability::Result.includes(:parent).references(:parent)
+                                       .where(parents_decidim_accountability_results: { id: nil })
+                                       .where.not(parent_id: nil).each do |result|
+          DestroyResult.call(result, @extra_context[:current_user])
+        end
+      end
+    end
+  end
+end

data/app/types/decidim/accountability/accountability_type.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Accountability
+    AccountabilityType = GraphQL::ObjectType.define do
+      interfaces [-> { Decidim::Core::ComponentInterface }]
+
+      name "Accountability"
+      description "An accountability component of a participatory space."
+
+      connection :results, ResultType.connection_type do
+        resolve ->(component, _args, _ctx) {
+                  ResultTypeHelper.base_scope(component).includes(:component)
+                }
+      end
+
+      field(:result, ResultType) do
+        argument :id, !types.ID
+
+        resolve ->(component, args, _ctx) {
+          ResultTypeHelper.base_scope(component).find_by(id: args[:id])
+        }
+      end
+    end
+
+    module ResultTypeHelper
+      def self.base_scope(component)
+        Result.where(component: component)
+      end
+    end
+  end
+end

data/app/types/decidim/accountability/result_type.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Accountability
+    ResultType = GraphQL::ObjectType.define do
+      interfaces [
+        -> { Decidim::Core::ComponentInterface },
+        -> { Decidim::Core::CategorizableInterface },
+        -> { Decidim::Comments::CommentableInterface },
+        -> { Decidim::Core::ScopableInterface }
+      ]
+
+      name "Result"
+      description "A result"
+
+      field :id, !types.ID, "The internal ID for this result"
+      field :title, Decidim::Core::TranslatedFieldType, "The title for this result"
+      field :description, Decidim::Core::TranslatedFieldType, "The description for this result"
+      field :reference, types.String, "The reference for this result"
+      field :startDate, Decidim::Core::DateType, "The start date for this result", property: :start_date
+      field :endDate, Decidim::Core::DateType, "The end date for this result", property: :end_date
+      field :progress, types.Float, "The progress for this result"
+      field :createdAt, Decidim::Core::DateTimeType, "When this result was created", property: :created_at
+      field :updatedAt, Decidim::Core::DateTimeType, "When this result was updated", property: :updated_at
+      field :childrenCount, types.Int, "The number of children results", property: :children_count
+      field :weight, !types.Int, "The order of this result"
+      field :externalId, types.String, "The external ID for this result", property: :external_id
+
+      field :children, types[Decidim::Accountability::ResultType], "The childrens results"
+      field :parent, Decidim::Accountability::ResultType, "The parent result"
+      field :status, Decidim::Accountability::StatusType, "The status for this result"
+      field :timelineEntries, types[Decidim::Accountability::TimelineEntryType], "The timeline entries for this result", property: :timeline_entries
+    end
+  end
+end

data/app/types/decidim/accountability/status_type.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Accountability
+    StatusType = GraphQL::ObjectType.define do
+      name "Status"
+      description "A status"
+
+      field :id, !types.ID, "The internal ID for this status"
+      field :key, types.String, "The key for this status"
+      field :name, Decidim::Core::TranslatedFieldType, "The name for this status"
+      field :createdAt, Decidim::Core::DateType, "When this status was created", property: :created_at
+      field :updatedAt, Decidim::Core::DateType, "When this status was updated", property: :updated_at
+      field :description, Decidim::Core::TranslatedFieldType, "The description for this status"
+      field :progress, types.Int, "The progress for this status"
+
+      field :results, types[Decidim::Accountability::ResultType], "The results for this status"
+    end
+  end
+end

data/app/types/decidim/accountability/timeline_entry_type.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Accountability
+    TimelineEntryType = GraphQL::ObjectType.define do
+      name "TimelineEntry"
+      description "A Timeline Entry"
+
+      field :id, !types.ID, "The internal ID for this timeline entry"
+      field :entryDate, Decidim::Core::DateType, "The entry date for this timeline entry", property: :entry_date
+      field :description, Decidim::Core::TranslatedFieldType, "The description for this timeline entry"
+      field :createdAt, Decidim::Core::DateTimeType, "When this timeline entry was created", property: :created_at
+      field :updatedAt, Decidim::Core::DateTimeType, "When this timeline entry was updated", property: :updated_at
+
+      field :result, Decidim::Accountability::ResultType, "The result for this timeline entry"
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+<%= form_tag(import_results_path, multipart: true, class: "form new_import") do %>
+  <div class="card">
+    <div class="card-divider">
+      <h2 class="card-title">
+        <%= t(".title") %>
+      </h2>
+    </div>
+
+    <div class="card-section">
+      <div class="row column">
+        <%= file_field_tag :csv_file %>
+      </div>
+    </div>
+  </div>
+
+  <div class="button--double form-general-submit">
+    <%= submit_tag t(".import"), class: "button" %>
+  </div>
+  <div class="import-process-info">
+    <%= t(".info", link_new_status: new_status_path, link_new_result: new_result_path, link_export_csv: link_to(t(".link"), exports_path(@current_component, id: "results", format: "CSV"), method: :post)).try("html_safe") %>
+  </div>
+<% end %>

data/app/views/decidim/accountability/admin/results/_form.html.erb

@@ -53,11 +53,7 @@
     </div>
 
     <div class="row column">
-      <% if @form.proposals %>
-        <% picker_options = { id: "decidim_accountability_proposals", class: "picker-multiple", name: "result[proposal_ids]", multiple: true }
-        prompt_params= { url: proposals_results_path(current_component, format: :html), text: t(".add_proposal") } %>
-        <%= form.data_picker(:proposals, picker_options, prompt_params) {|item| { url:proposals_results_path(current_component, format: :json), text: "##{item.id}- #{present(item).title}" }} %>
-      <% end %>
+      <%= proposals_picker(form, :proposals, proposals_picker_results_path) %>
     </div>
 
     <div class="row column">

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

@@ -7,6 +7,7 @@
         <%= link_to t("actions.new", scope: "decidim.accountability", name: t("models.result.name", scope: "decidim.accountability.admin")), new_result_path(parent_id: parent_result), class: "button tiny button--simple" if allowed_to? :create, :result %>
         <%= render partial: "decidim/accountability/admin/shared/subnav" unless parent_result %>
         <%= export_dropdown %>
+        <%= link_to t("actions.import_csv", scope: "decidim.accountability"), import_results_path, class: "button tiny button--simple" if allowed_to? :create, :result %>
       </div>
     </h2>
   </div>

data/app/views/decidim/accountability/admin/results/proposals_picker.html.erb

@@ -0,0 +1 @@
+<%= cell "decidim/proposals/proposals_picker", current_component %>

data/app/views/decidim/accountability/import_mailer/import.html.erb

@@ -0,0 +1,25 @@
+<% if @errors.empty? %>
+  <p><%= t(".success") %></p>
+<% else %>
+  <p><%= t(".errors_present") %>:</p>
+  <table>
+    <thead>
+      <tr>
+        <th><%= t(".row_number") %></th>
+        <th><%= t(".errors") %></th>
+      </tr>
+    </thead>
+    <% @errors.each do |error| %>
+      <tr>
+        <td><%= error.first %></td>
+        <td>
+          <ul>
+            <% error.last.each do |error_message| %>
+              <li><%= error_message %></li>
+            <% end %>
+          </ul>
+        </td>
+      </tr>
+    <% end %>
+  </table>
+<% end %>

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

@@ -1,7 +1,7 @@
 <div class="card card--action card--list">
   <% resources.each do |result| %>
     <div class="card--list__item">
-      <%= icon "actions", class: "card--list__icon", remove_icon_class: true %>
+      <%= icon "actions", class: "card--list__icon", role: "img", "aria-hidden": true, remove_icon_class: true %>
       <%= link_to resource_locator(result).path, class: "card--list__text card__link card__link--block" do %>
         <h5 class="card--list__heading">
           <%= translated_attribute(result.title) %>

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

@@ -1,7 +1,7 @@
 <div class="title-action">
-  <h2 id="results-count" class="title-action__title section-heading">
+  <h3 id="results-count" class="title-action__title section-heading">
     <%= heading_leaf_level_results(total_count) %>
-  </h2>
+  </h3>
 </div>
 
 <div class="row">
@@ -9,12 +9,12 @@
     <div class="card card--action card--list">
       <% results.each do |result| %>
         <div class="card--list__item">
-          <%= icon "actions", class: "card--list__icon", remove_icon_class: true %>
+          <%= icon "actions", class: "card--list__icon", role: "img", "aria-hidden": true, remove_icon_class: true %>
 
           <%= link_to result_path(result), class: "card--list__text card__link card__link--block" do %>
-            <h5 class="card--list__heading">
+            <h4 class="card--list__heading">
               <%= translated_attribute(result.title) %>
-            </h5>
+            </h4>
 
             <div class="text-small card--meta">
               <% if result.start_date %>