decidim-accountability 0.20.0 → 0.23.1.rc1

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

@@ -5,20 +5,19 @@ module Decidim
     # Exposes result versions so users can see how a result
     # has been updated through time.
     class VersionsController < Decidim::Accountability::ApplicationController
-      helper Decidim::TraceabilityHelper
       helper Decidim::Accountability::BreadcrumbHelper
-      helper_method :current_version, :result
+      helper_method :result
 
-      private
+      include Decidim::ResourceVersionsConcern
 
-      def result
-        @result ||= Result.includes(:timeline_entries).where(component: current_component).find(params[:result_id])
+      def versioned_resource
+        result
       end
 
-      def current_version
-        return nil if params[:id].to_i < 1
+      private
 
-        @current_version ||= result.versions[params[:id].to_i - 1]
+      def result
+        @result ||= Result.includes(:timeline_entries).where(component: current_component).find(params[:result_id])
       end
     end
   end

data/app/forms/decidim/accountability/admin/result_form.rb

@@ -28,13 +28,13 @@ module Decidim
         validates :progress, numericality: { greater_than_or_equal_to: 0, less_than_or_equal_to: 100 }, if: ->(form) { form.progress.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? }
+
         validates :category, presence: true, if: ->(form) { form.decidim_category_id.present? }
 
         validates :parent, presence: true, if: ->(form) { form.parent_id.present? }
         validates :status, presence: true, if: ->(form) { form.decidim_accountability_status_id.present? }
 
-        validate :scope_belongs_to_participatory_space_scope
-
         delegate :categories, to: :current_component
 
         def map_model(model)
@@ -59,7 +59,7 @@ module Decidim
         #
         # Returns a Decidim::Scope
         def scope
-          @scope ||= @decidim_scope_id ? current_participatory_space.scopes.find_by(id: @decidim_scope_id) : current_participatory_space.scope
+          @scope ||= @decidim_scope_id ? current_component.scopes.find_by(id: @decidim_scope_id) : current_component.scope
         end
 
         # Scope identifier
@@ -80,12 +80,6 @@ module Decidim
         def status
           @status ||= Decidim::Accountability::Status.find_by(component: current_component, id: decidim_accountability_status_id)
         end
-
-        private
-
-        def scope_belongs_to_participatory_space_scope
-          errors.add(:decidim_scope_id, :invalid) if current_participatory_space.out_of_scope?(scope)
-        end
       end
     end
   end

data/app/helpers/decidim/accountability/admin/application_helper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Accountability
+    module Admin
+      # Custom helpers, scoped to the accountability admin engine.
+      #
+      module ApplicationHelper
+        include Decidim::Admin::ResourceScopeHelper
+      end
+    end
+  end
+end

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

@@ -2,7 +2,7 @@
 
 module Decidim
   module Accountability
-    # Custom helpers, scoped to the meetings engine.
+    # Custom helpers, scoped to the accountability engine.
     #
     module ApplicationHelper
       include PaginateHelper

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

@@ -7,7 +7,7 @@ module Decidim
     class Result < Accountability::ApplicationRecord
       include Decidim::Resourceable
       include Decidim::HasComponent
-      include Decidim::ScopableComponent
+      include Decidim::ScopableResource
       include Decidim::HasCategory
       include Decidim::HasReference
       include Decidim::Comments::Commentable
@@ -16,9 +16,12 @@ module Decidim
       include Decidim::DataPortability
       include Decidim::Randomable
       include Decidim::Searchable
+      include Decidim::TranslatableResource
 
       component_manifest_name "accountability"
 
+      translatable_fields :title, :description
+
       has_many :children, foreign_key: "parent_id", class_name: "Decidim::Accountability::Result", inverse_of: :parent, dependent: :destroy
       belongs_to :parent, foreign_key: "parent_id", class_name: "Decidim::Accountability::Result", inverse_of: :children, optional: true, counter_cache: :children_count
 

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

@@ -6,9 +6,12 @@ module Decidim
     # key, a localized name, a localized description and and associated progress number.
     class Status < Accountability::ApplicationRecord
       include Decidim::HasComponent
+      include Decidim::TranslatableResource
 
       component_manifest_name "accountability"
 
+      translatable_fields :name, :description
+
       has_many :results, foreign_key: "decidim_accountability_status_id", class_name: "Decidim::Accountability::Result", inverse_of: :status, dependent: :nullify
 
       validates :key, presence: true, uniqueness: { scope: :decidim_component_id }

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

@@ -5,6 +5,9 @@ module Decidim
     # The data store for a TimelineEntry for a Result in the Decidim::Accountability component.
     # It stores a date, and localized description.
     class TimelineEntry < Accountability::ApplicationRecord
+      include Decidim::TranslatableResource
+
+      translatable_fields :description
       belongs_to :result, foreign_key: "decidim_accountability_result_id", class_name: "Decidim::Accountability::Result", inverse_of: :timeline_entries
     end
   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/result_search.rb

@@ -6,6 +6,8 @@ module Decidim
     # `current_component` param with a `Decidim::Component` in order to
     # find the results.
     class ResultSearch < ResourceSearch
+      text_search_fields :title, :description
+
       # Public: Initializes the service.
       #
       # options - A hash of options to modify the search. These options will be
@@ -24,13 +26,6 @@ module Decidim
         super(Result.all, options)
       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}%"))
-      end
-
       # Handle parent_id filter
       def search_parent_id
         parent_id = options[:parent_id]
@@ -48,19 +43,6 @@ module Decidim
       def children_ids(parent_id)
         Result.where(parent_id: parent_id).pluck(:id)
       end
-
-      # 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/app/services/decidim/accountability/result_stats_calculator.rb

@@ -20,7 +20,7 @@ module Decidim
       end
 
       def comments_count
-        Decidim::Comments::Comment.where(commentable: proposals.to_a).count
+        proposals.sum(:comments_count)
       end
 
       def attendees_count

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