decidim-accountability 0.1.0

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Accountability
+    module Admin
+      # This controller allows an admin to manage template texts per Accountability feature
+      class TemplateTextsController < Admin::ApplicationController
+        helper_method :template_texts
+
+        def edit
+          @form = form(TemplateTextsForm).from_model(template_texts)
+        end
+
+        def update
+          @form = form(TemplateTextsForm).from_params(params)
+
+          UpdateTemplateTexts.call(@form, template_texts) do
+            on(:ok) do
+              flash[:notice] = I18n.t("template_texts.update.success", scope: "decidim.accountability.admin")
+              redirect_to edit_template_texts_path
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("template_texts.update.invalid", scope: "decidim.accountability.admin")
+              render action: "edit"
+            end
+          end
+        end
+
+        private
+
+        def template_texts
+          @template_texts ||= TemplateTexts.for(current_feature)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Accountability
+    module Admin
+      # This controller allows an admin to manage timeline entries for a Result
+      class TimelineEntriesController < Admin::ApplicationController
+        helper_method :result, :timeline_entries
+
+        def new
+          @form = form(TimelineEntryForm).instance
+        end
+
+        def create
+          @form = form(TimelineEntryForm).from_params(params)
+          @form.decidim_accountability_result_id = params[:result_id]
+
+          CreateTimelineEntry.call(@form) do
+            on(:ok) do
+              flash[:notice] = I18n.t("timeline_entries.create.success", scope: "decidim.accountability.admin")
+              redirect_to result_timeline_entries_path(params[:result_id])
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("timeline_entries.create.invalid", scope: "decidim.accountability.admin")
+              render action: "new"
+            end
+          end
+        end
+
+        def edit
+          @form = form(TimelineEntryForm).from_model(timeline_entry)
+        end
+
+        def update
+          @form = form(TimelineEntryForm).from_params(params)
+
+          UpdateTimelineEntry.call(@form, timeline_entry) do
+            on(:ok) do
+              flash[:notice] = I18n.t("timeline_entries.update.success", scope: "decidim.accountability.admin")
+              redirect_to result_timeline_entries_path(params[:result_id])
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("timeline_entries.update.invalid", scope: "decidim.accountability.admin")
+              render action: "edit"
+            end
+          end
+        end
+
+        def destroy
+          timeline_entry.destroy!
+
+          flash[:notice] = I18n.t("timeline_entries.destroy.success", scope: "decidim.accountability.admin")
+
+          redirect_to result_timeline_entries_path(params[:result_id])
+        end
+
+        private
+
+        def timeline_entries
+          @timeline_entries ||= result.timeline_entries.page(params[:page]).per(15)
+        end
+
+        def timeline_entry
+          @timeline_entry ||= timeline_entries.find(params[:id])
+        end
+
+        def result
+          @result ||= Result.where(feature: current_feature).find(params[:result_id])
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Accountability
+    # This controller is the abstract class from which all other controllers of
+    # this engine inherit.
+    #
+    # Note that it inherits from `Decidim::Components::BaseController`, which
+    # override its layout and provide all kinds of useful methods.
+    class ApplicationController < Decidim::Features::BaseController
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Accountability
+    class ResultWidgetsController < Decidim::WidgetsController
+      helper_method :model
+
+      private
+
+      def model
+        @model ||= Result.where(feature: params[:feature_id]).find(params[:result_id])
+      end
+
+      def iframe_url
+        @iframe_url ||= result_result_widget_url(model)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Accountability
+    # Exposes the result resource so users can view them
+    class ResultsController < Decidim::Accountability::ApplicationController
+      include FilterResource
+      helper Decidim::WidgetUrlsHelper
+
+      helper_method :results, :result, :stats_calculator, :first_class_categories, :category, :progress_calculator, :count_calculator, :current_scope, :template_texts
+
+      def home
+      end
+
+      def csv
+        send_data CSVExporter.new(current_feature).export, filename: "results.csv", disposition: "attachment"
+      end
+
+      private
+
+      def results
+        parent_id = params[:parent_id].presence
+        @results ||= search.results.where(parent_id: parent_id).page(params[:page]).per(12)
+      end
+
+      def result
+        @result ||= Result.includes(:timeline_entries).where(feature: current_feature).find(params[:id])
+      end
+
+      def stats_calculator
+        @stats_calculator ||= ResultStatsCalculator.new(result)
+      end
+
+      def search_klass
+        ResultSearch
+      end
+
+      def default_filter_params
+        {
+          search_text: "",
+          scope_id: "",
+          category_id: ""
+        }
+      end
+
+      def context_params
+        { feature: current_feature, organization: current_organization }
+      end
+
+      def first_class_categories
+        @first_class_categories ||= current_participatory_process.categories.first_class
+      end
+
+      def category
+        if params[:filter] && params[:filter][:category_id].present?
+          current_participatory_process.categories.find(params[:filter][:category_id])
+        end
+      end
+
+      def progress_calculator(scope_id, category_id)
+        Decidim::Accountability::ResultsCalculator.new(current_feature, scope_id, category_id).progress
+      end
+
+      def count_calculator(scope_id, category_id)
+        Decidim::Accountability::ResultsCalculator.new(current_feature, scope_id, category_id).count
+      end
+
+      def current_scope
+        params[:filter][:scope_id] if params[:filter]
+      end
+
+      def template_texts
+        Decidim::Accountability::TemplateTexts.for(current_feature)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Accountability
+    module Admin
+      # This class holds a Form to create/update results from Decidim's admin panel.
+      class ResultForm < Decidim::Form
+        include TranslatableAttributes
+        include TranslationsHelper
+
+        translatable_attribute :title, String
+        translatable_attribute :description, String
+
+        attribute :decidim_scope_id, Integer
+        attribute :decidim_category_id, Integer
+        attribute :proposal_ids, Array[Integer]
+        attribute :start_date, Date
+        attribute :end_date, Date
+        attribute :progress, Float
+        attribute :external_id, String
+        attribute :decidim_accountability_status_id, Integer
+        attribute :parent_id, Integer
+
+        validates :title, translatable_presence: true
+        validates :description, translatable_presence: true
+
+        validates :scope, presence: 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 :external_id_uniqueness
+
+        def map_model(model)
+          self.proposal_ids = model.linked_resources(:proposals, "included_proposals").pluck(:id)
+          self.decidim_category_id = model.category.try(:id)
+        end
+
+        def proposals
+          @proposals ||= Decidim.find_resource_manifest(:proposals).try(:resource_scope, context.current_feature)&.order(title: :asc)&.pluck(:title, :id)
+        end
+
+        def organization_scopes
+          current_organization.scopes
+        end
+
+        def scope
+          @scope ||= organization_scopes.where(id: decidim_scope_id).first
+        end
+
+        def category
+          @category ||= context.current_feature.categories.where(id: decidim_category_id).first
+        end
+
+        def parent
+          @parent ||= Decidim::Accountability::Result.where(feature: current_feature, id: parent_id).first
+        end
+
+        def status
+          @status ||= Decidim::Accountability::Status.where(feature: current_feature, id: decidim_accountability_status_id).first
+        end
+
+        private
+
+        def external_id_uniqueness
+          return if external_id.blank?
+          existing_with_external_id = Decidim::Accountability::Result.find_by(feature: current_feature, external_id: external_id)
+          errors.add(:external_id, :taken) if existing_with_external_id && existing_with_external_id.id != id
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Accountability
+    module Admin
+      # This class holds a Form to create/update statuses from Decidim's admin panel.
+      class StatusForm < Decidim::Form
+        include TranslatableAttributes
+        include TranslationsHelper
+
+        attribute :key, String
+        translatable_attribute :name, String
+        translatable_attribute :description, String
+        attribute :progress, Integer
+
+        validates :key, presence: true
+        validates :name, translatable_presence: true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Accountability
+    module Admin
+      # This class holds a Form to create/update template texts from Decidim's admin panel.
+      class TemplateTextsForm < Decidim::Form
+        include TranslatableAttributes
+        include TranslationsHelper
+
+        translatable_attribute :intro, String
+        translatable_attribute :categories_label, String
+        translatable_attribute :subcategories_label, String
+        translatable_attribute :heading_parent_level_results, String
+        translatable_attribute :heading_leaf_level_results, String
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Accountability
+    module Admin
+      # This class holds a Form to create/update timeline_entries from Decidim's admin panel.
+      class TimelineEntryForm < Decidim::Form
+        include TranslatableAttributes
+        include TranslationsHelper
+
+        attribute :decidim_accountability_result_id, Integer
+        attribute :entry_date, Date
+        translatable_attribute :description, String
+
+        validates :entry_date, presence: true
+        validates :description, translatable_presence: true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Accountability
+    # Custom helpers, scoped to the meetings engine.
+    #
+    module ApplicationHelper
+      include PaginateHelper
+      include Decidim::Comments::CommentsHelper
+
+      def display_percentage(number)
+        return unless number.present?
+
+        number_to_percentage(number, precision: 1, strip_insignificant_zeros: true, locale: I18n.locale)
+      end
+
+      def display_count(count)
+        heading_leaf_level_results(count)
+      end
+
+      def active_class_if_current(scope)
+        %Q{class=active} if scope.to_s == current_scope.to_s
+      end
+
+      def categories_label
+        translated_attribute(template_texts.categories_label).presence || t("results.home.categories_label", scope: "decidim.accountability")
+      end
+
+      def subcategories_label
+        translated_attribute(template_texts.subcategories_label).presence || t("results.home.subcategories_label", scope: "decidim.accountability")
+      end
+
+      def heading_parent_level_results(count)
+        if text = translated_attribute(template_texts.heading_parent_level_results).presence
+          "#{count} #{text}"
+        else
+          t("results.count.results_count", scope: "decidim.accountability", count: count)
+        end
+      end
+
+      def heading_leaf_level_results(count)
+        if text = translated_attribute(template_texts.heading_leaf_level_results).presence
+          "#{count} #{text}"
+        else
+          t("results.count.results_count", scope: "decidim.accountability", count: count)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Accountability
+    # Abstract class from which all models in this engine inherit.
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# 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 Result < Accountability::ApplicationRecord
+      include Decidim::Resourceable
+      include Decidim::HasFeature
+      include Decidim::HasScope
+      include Decidim::HasCategory
+      include Decidim::HasReference
+      include Decidim::Comments::Commentable
+
+      feature_manifest_name "accountability"
+
+      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
+
+      belongs_to :status, foreign_key: "decidim_accountability_status_id", class_name: "Decidim::Accountability::Status", inverse_of: :results, optional: true
+
+      has_many :timeline_entries, -> { order(:entry_date) }, foreign_key: "decidim_accountability_result_id", class_name: "Decidim::Accountability::TimelineEntry", inverse_of: :result, dependent: :destroy
+
+      before_validation :remove_blank_values
+
+      after_save :update_parent_progress, if: -> { parent_id.present? }
+
+      def update_parent_progress
+        return unless parent.present?
+
+        parent.update_progress!
+      end
+
+      def update_progress!
+        self.progress = children.average(:progress)
+        save!
+      end
+
+      # Public: Overrides the `commentable?` Commentable concern method.
+      def commentable?
+        feature.settings.comments_enabled?
+      end
+
+      # Public: Overrides the `accepts_new_comments?` Commentable concern method.
+      def accepts_new_comments?
+        commentable? && !feature.current_settings.comments_blocked
+      end
+
+      # Public: Overrides the `comments_have_alignment?` Commentable concern method.
+      def comments_have_alignment?
+        true
+      end
+
+      # Public: Overrides the `comments_have_votes?` Commentable concern method.
+      def comments_have_votes?
+        true
+      end
+
+      private
+
+      def remove_blank_values
+        self.external_id = nil if external_id.blank?
+      end
+    end
+  end
+end