decidim-accountability 0.1.0

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Accountability
+    # The data store for a Status in the Decidim::Accountability component. It stores a
+    # key, a localized name, a localized description and and associated progress number.
+    class Status < Accountability::ApplicationRecord
+      include Decidim::HasFeature
+
+      feature_manifest_name "accountability"
+
+      has_many :results, foreign_key: "decidim_accountability_status_id", class_name: "Decidim::Accountability::Result", inverse_of: :status
+
+      validates :key, presence: true, uniqueness: { scope: :decidim_feature_id }
+      validates :name, presence: true
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Accountability
+    # The data store for a Result in the Decidim::Accountability component. It stores a
+    # title, description and any other useful information to render a custom result.
+    class TemplateTexts < Accountability::ApplicationRecord
+      include Decidim::HasFeature
+
+      feature_manifest_name "accountability"
+
+      def self.for(current_feature)
+        self.where(feature: current_feature).first || self.create!(feature: current_feature)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Accountability
+    # 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
+      belongs_to :result, foreign_key: "decidim_accountability_result_id", class_name: "Decidim::Accountability::Result", inverse_of: :timeline_entries
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+require "csv"
+
+module Decidim
+  module Accountability
+    # This class handles exporting results to a CSV file.
+    # Needs a `current_feature` param with a `Decidim::Feature`
+    class CSVExporter
+
+      # Public: Initializes the service.
+      # feature       - A Decidim::Feature to import the results into.
+      def initialize(feature)
+        @feature = feature
+      end
+
+      def export
+        results = Decidim::Accountability::Result.where(feature: @feature).order(:id)
+
+        generated_csv = CSV.generate(headers: true) do |csv|
+          headers = [
+            "result_id",
+            "decidim_category_id",
+            "decidim_scope_id",
+            "parent_id",
+            "external_id",
+            "start_date",
+            "end_date",
+            "decidim_accountability_status_id",
+            "progress",
+            "proposal_ids"
+          ]
+
+          available_locales = @feature.participatory_space.organization.available_locales
+          available_locales.each do |locale|
+            headers << "title_#{locale}"
+            headers << "description_#{locale}"
+          end
+
+          csv << headers
+
+          results.find_each do |result|
+            row = Rails.cache.fetch("#{result.cache_key}/csv") do
+              row_for_result(result, available_locales)
+            end
+
+            csv << row
+          end
+        end
+
+        generated_csv
+      end
+
+      private
+
+      def row_for_result(result, available_locales)
+        row = [
+          result.id,
+          result.category.try(:id),
+          result.decidim_scope_id,
+          result.parent_id,
+          result.external_id,
+          result.start_date,
+          result.end_date,
+          result.decidim_accountability_status_id,
+          result.progress,
+          result.linked_resources(:proposals, "included_proposals").pluck(:id).sort.join(";"),
+        ]
+        available_locales.each do |locale|
+          row << result.title[locale]
+          row << result.description[locale]
+        end
+
+        row
+      end
+    end
+  end
+end

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

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+require "csv"
+
+module Decidim
+  module Accountability
+    # This class handles importing results from a CSV file.
+    # Needs a `current_feature` param with a `Decidim::Feature`
+    # in order to import the results in that feature.
+    class CSVImporter
+      include Decidim::FormFactory
+
+      # Public: Initializes the service.
+      # feature       - A Decidim::Feature to import the results into.
+      # csv_file_path - The path to the csv file.
+      def initialize(feature, csv_file_path)
+        @feature = feature
+        @csv_file_path = csv_file_path
+        @extra_context = { current_feature: feature, current_organization: feature.organization}
+      end
+
+      def import!
+        errors = []
+
+        ActiveRecord::Base.transaction do
+          i = 1
+          CSV.foreach(@csv_file_path, headers: true) do |row|
+            i += 1
+            next if row.empty?
+
+            params = {}
+            params["result"] = row.to_hash
+
+            if row["result_id"].present?
+              existing_result = Decidim::Accountability::Result.find_by(id: row['result_id'].to_i)
+              unless existing_result.present?
+                errors << [i, [I18n.t("imports.create.not_found", scope: "decidim.accountability.admin", result_id: row["result_id"])]]
+                next
+              end
+            elsif row["external_id"].present?
+              existing_result = Decidim::Accountability::Result.find_by(external_id: row["external_id"])
+              params["result"]["id"] = existing_result.id if existing_result
+            end
+
+            if row["parent_id"].blank? && row["parent_external_id"].present?
+              if parent = Decidim::Accountability::Result.find_by(external_id: row["parent_external_id"])
+                params["result"]["parent_id"] = parent.id
+              end
+            end
+
+            if row["decidim_accountability_status_id"].present? && status = Decidim::Accountability::Status.find_by(id: row["decidim_accountability_status_id"])
+              params["result"]["progress"] = status.progress if status.progress.present?
+            end
+
+            default_locale = @feature.participatory_space.organization.default_locale
+            available_locales = @feature.participatory_space.organization.available_locales
+
+            available_locales.each do |locale|
+              params["result"]["title_#{locale}"] = params["result"]["title_#{default_locale}"] if params["result"]["title_#{locale}"].blank?
+              params["result"]["description_#{locale}"] = params["result"]["description_#{default_locale}"] if params["result"]["description_#{locale}"].blank?
+            end
+
+            if params["result"]["proposal_ids"].presence
+              proposal_ids = params["result"]["proposal_ids"].split(";")
+              params["result"]["proposal_ids"] = proposal_ids
+            end
+
+            @form = form(Decidim::Accountability::Admin::ResultForm).from_params(params, @extra_context)
+
+            begin
+              start_date = Date.parse(row["start_date"]) if row["start_date"].present?
+            rescue ArgumentError
+              @form.errors.add(:start_date, :invalid_date)
+            end
+
+            begin
+              end_date = Date.parse(row["end_date"]) if row["end_date"].present?
+            rescue ArgumentError
+              @form.errors.add(:end_date, :invalid_date)
+            end
+
+            # add form errors now because when calling valid on the form in UpdateResult/CreateResult will clear the errors
+            errors << [i, @form.errors.full_messages] if @form.errors.any?
+
+            if existing_result #update existing result
+              Decidim::Accountability::Admin::UpdateResult.call(@form, existing_result) do
+                on(:invalid) do
+                  errors << [i, @form.errors.full_messages]
+                end
+              end
+            else #create new result
+              Decidim::Accountability::Admin::CreateResult.call(@form) do
+                on(:invalid) do
+                  errors << [i, @form.errors.full_messages]
+                end
+              end
+            end
+          end
+
+          raise ActiveRecord::Rollback if errors.any?
+        end
+
+        errors
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Accountability
+    # This class handles search and filtering of results. Needs a
+    # `current_feature` param with a `Decidim::Feature` in order to
+    # find the results.
+    class ResultSearch < ResourceSearch
+      # Public: Initializes the service.
+      # feature     - A Decidim::Feature to get the results from.
+      # page        - The page number to paginate the results.
+      # per_page    - The number of proposals to return per page.
+      def initialize(options = {})
+        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
+
+      private
+
+      # 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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Accountability
+    # This class handles statistics of results. Needs a `result` in
+    # order to find the stats.
+    class ResultStatsCalculator
+      # Public: Initializes the service.
+      # result - The result from which to calculate the stats.
+      def initialize(result)
+        @result = result
+      end
+
+      def proposals_count
+        proposals.count
+      end
+
+      def votes_count
+        return 0 unless proposals
+        proposals.sum { |proposal| proposal.votes.size }
+      end
+
+      def comments_count
+        Decidim::Comments::Comment.where(commentable: proposals).count
+      end
+
+      def attendees_count
+        meetings.where("attendees_count > 0").sum(:attendees_count)
+      end
+
+      def contributions_count
+        meetings.where("contributions_count > 0").sum(:contributions_count)
+      end
+
+      def meetings_count
+        meetings.count
+      end
+
+      private
+
+      attr_reader :result
+
+      def proposals
+        @proposals ||= result.linked_resources(:proposals, "included_proposals")
+      end
+
+      def meetings
+        @meetings ||= result.linked_resources(:meetings, "meetings_through_proposals")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Accountability
+    # This class handles the calculation of progress for a set of results
+    class ResultsCalculator
+      # Public: Initializes the service.
+      def initialize(feature, scope_id, category_id)
+        @feature = feature
+        @scope_id = scope_id
+        @category_id = category_id
+      end
+
+      def progress
+        results.average(:progress)
+      end
+
+      def count
+        # if there are children return the total number of children results
+        # if not return the count of results (they are leafs)
+        children = results.sum(:children_count)
+        children > 0 ? children : results.count
+      end
+
+      private
+
+      attr_reader :feature, :scope_id, :category_id
+
+      def results
+        @results ||= ResultSearch.new(feature: feature, scope_id: scope_id, category_id: category_id, parent_id: nil).results
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+<%= form_tag({:action => :create}, multipart: true, class: "form new_import") do %>
+  <div class="card">
+    <div class="card-divider">
+      <h2 class="card-title">
+        <%= t(".title") %>
+        <%= render partial: "decidim/accountability/admin/shared/subnav" %>
+      </h2>
+    </div>
+
+    <% unless @errors.empty? %>
+      <div class="card-section">
+        <div class="row column">
+          <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>
+        </div>
+      </div>
+    <% end %>
+
+    <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>
+<% end %>

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

@@ -0,0 +1,70 @@
+<div class="card">
+  <div class="card-divider">
+    <h2 class="card-title"><%= title %></h2>
+  </div>
+
+  <div class="card-section">
+    <div class="row column">
+      <%= form.translated :text_field, :title, autofocus: true %>
+    </div>
+
+    <div class="row column">
+      <%= form.translated :editor, :description %>
+    </div>
+
+    <% if @form.parent_id %>
+
+      <div class="row column">
+        <%= form.select :parent_id, parent_results.map{|result| [translated_attribute(result.title), result.id] }, include_blank: true %>
+      </div>
+
+    <% else %>
+
+      <% if current_participatory_space.has_subscopes? %>
+        <div class="row column">
+          <%= form.scopes_select :decidim_scope_id, prompt: I18n.t("decidim.scopes.global"), remote_path: decidim.scopes_search_path(root: current_participatory_space.scope) %>
+        </div>
+      <% end %>
+
+      <div class="row column">
+        <%= form.categories_select :decidim_category_id, current_participatory_process.categories, include_blank: true, disable_parents: false %>
+      </div>
+
+    <% end %>
+
+    <div class="row">
+      <div class="columns xlarge-6">
+        <%= form.date_field :start_date %>
+      </div>
+
+      <div class="columns xlarge-6">
+        <%= form.date_field :end_date %>
+      </div>
+    </div>
+
+    <div class="row">
+      <div class="columns xlarge-6">
+        <%= form.select :decidim_accountability_status_id, statuses.map{|status| [translated_attribute(status.name), status.id, { 'data-progress' => status.progress }] }, include_blank: true %>
+      </div>
+
+      <div class="columns xlarge-6">
+        <%= form.number_field :progress %>
+      </div>
+    </div>
+
+    <div class="columns">
+      <%= form.text_field :external_id %>
+    </div>
+
+    <div class="row column">
+      <% if @form.proposals %>
+        <%= form.select :proposal_ids,
+                        @form.proposals,
+                        {},
+                        { multiple: true, class: "chosen-select" }
+        %>
+      <% end %>
+    </div>
+
+  </div>
+</div>