decidim-stratified_sortitions 0.0.1

data/app/controllers/decidim/stratified_sortitions/admin/stratified_sortitions_controller.rb

@@ -0,0 +1,235 @@
+# frozen_string_literal: true
+
+module Decidim
+  module StratifiedSortitions
+    module Admin
+      # Controller that allows managing admin stratified sortitions.
+      #
+      class StratifiedSortitionsController < Decidim::StratifiedSortitions::Admin::ApplicationController
+        include Decidim::ApplicationHelper
+        include StrataChartsData
+
+        helper StratifiedSortitions::ApplicationHelper
+        helper Decidim::PaginateHelper
+
+        helper_method :stratified_sortitions, :stratified_sortition, :form_presenter, :blank_stratum
+
+        def index
+          enforce_permission_to :read, :stratified_sortitions
+          @stratified_sortitions = stratified_sortitions
+        end
+
+        def new
+          enforce_permission_to :create, :stratified_sortition
+          @form = form(Decidim::StratifiedSortitions::Admin::StratifiedSortitionsForm).instance
+        end
+
+        def edit
+          enforce_permission_to(:edit, :stratified_sortition, stratified_sortition:)
+          @form = form(Decidim::StratifiedSortitions::Admin::StratifiedSortitionsForm).from_model(stratified_sortition)
+        end
+
+        def create
+          enforce_permission_to :create, :stratified_sortition
+          @form = form(Decidim::StratifiedSortitions::Admin::StratifiedSortitionsForm).from_params(params)
+
+          Decidim::StratifiedSortitions::Admin::CreateStratifiedSortition.call(@form) do
+            on(:ok) do |created_sortition|
+              flash[:notice] = I18n.t("stratified_sortitions.create.success", scope: "decidim.stratified_sortitions.admin")
+              redirect_to edit_stratified_sortition_path(created_sortition)
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("stratified_sortitions.create.error", scope: "decidim.stratified_sortitions.admin")
+              render action: "new"
+            end
+          end
+        end
+
+        def update
+          enforce_permission_to(:edit, :stratified_sortition, stratified_sortition:)
+          @form = form(Decidim::StratifiedSortitions::Admin::StratifiedSortitionsForm).from_params(params)
+
+          Decidim::StratifiedSortitions::Admin::UpdateStratifiedSortition.call(@form, stratified_sortition) do
+            on(:ok) do |_stratified_sortition|
+              flash[:notice] = t("stratified_sortitions.update.success", scope: "decidim.stratified_sortitions.admin")
+              redirect_to edit_stratified_sortition_path(stratified_sortition)
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = t("stratified_sortitions.update.error", scope: "decidim.stratified_sortitions.admin")
+              render :edit
+            end
+          end
+        end
+
+        def duplicate
+          enforce_permission_to(:duplicate, :stratified_sortition, stratified_sortition:)
+
+          Decidim::StratifiedSortitions::Admin::DuplicateStratifiedSortition.call(stratified_sortition, current_user) do
+            on(:ok) do |_new_stratified_sortition|
+              flash[:notice] = I18n.t("stratified_sortitions.duplicate.success", scope: "decidim.stratified_sortitions.admin")
+              redirect_to stratified_sortitions_path(assembly_slug: -1, component_id: -1)
+            end
+
+            on(:invalid) do
+              flash[:alert] = I18n.t("stratified_sortitions.duplicate.error", scope: "decidim.stratified_sortitions.admin")
+              redirect_to stratified_sortitions_path(assembly_slug: -1, component_id: -1)
+            end
+          end
+        end
+
+        def destroy
+          enforce_permission_to(:destroy, :stratified_sortition, stratified_sortition:)
+
+          Decidim::StratifiedSortitions::Admin::DestroyStratifiedSortition.call(stratified_sortition, current_user) do
+            on(:ok) do
+              flash[:notice] = I18n.t("stratified_sortitions.destroy.success", scope: "decidim.stratified_sortitions.admin")
+              redirect_to stratified_sortitions_path(assembly_slug: -1, component_id: -1)
+            end
+
+            on(:has_problems) do
+              redirect_to stratified_sortitions_path, flash: { error: t("stratified_sortitions.destroy.has_problems", scope: "decidim.stratified_sortitions.admin") }
+            end
+
+            on(:invalid) do
+              redirect_to stratified_sortitions_path, flash: { error: t("stratified_sortitions.destroy.error", scope: "decidim.stratified_sortitions.admin") }
+            end
+          end
+        end
+
+        def upload_sample
+          enforce_permission_to :upload_sample, :stratified_sortition
+          if stratified_sortition.strata_and_substrata_configured?
+            @stratified_sortition = stratified_sortition
+            @form = SampleUploadForm.new
+            @sample_participants_count = @stratified_sortition.sample_participants.count
+            @last_sample = SampleImport.where(stratified_sortition: @stratified_sortition).order(created_at: :desc).first
+            @samples = SampleImport.where(stratified_sortition: @stratified_sortition).order(created_at: :asc)
+            @strata_data = strata_data(@stratified_sortition)
+            @candidates_data = candidates_data(@stratified_sortition)
+          else
+            redirect_to edit_stratified_sortition_path(stratified_sortition),
+                        flash: { warning: t("stratified_sortitions.upload_sample.strata_not_configured", scope: "decidim.stratified_sortitions.admin") }
+          end
+        end
+
+        def execute
+          unless stratified_sortition.can_execute? || stratified_sortition.executing? || stratified_sortition.executed? || stratified_sortition.failed?
+            redirect_to edit_stratified_sortition_path(stratified_sortition),
+                        flash: { warning: t("stratified_sortitions.execute.empty_sample_participants", scope: "decidim.stratified_sortitions.admin") }
+            return
+          end
+
+          @stratified_sortition = stratified_sortition
+          @portfolio = @stratified_sortition.panel_portfolio
+          @strata = @stratified_sortition.strata.order(:position)
+          @selected_participants = if @portfolio&.sampled?
+                                     SampleParticipant
+                                       .where(id: @portfolio.selected_panel)
+                                       .includes(sample_participant_strata: [:decidim_stratified_sortitions_stratum, :decidim_stratified_sortitions_substratum])
+                                       .order(:id)
+                                       .to_a
+                                   else
+                                     []
+                                   end
+          @strata_data = strata_data(@stratified_sortition)
+          @candidates_data = candidates_data(@stratified_sortition)
+          @results_data = results_data(@stratified_sortition)
+        end
+
+        def execute_stratified_sortition
+          unless stratified_sortition.can_execute?
+            redirect_to execute_stratified_sortition_path(stratified_sortition)
+            return
+          end
+
+          stratified_sortition.update!(status: "executing")
+          ExecuteSortitionJob.perform_later(stratified_sortition, current_user)
+          flash[:notice] = I18n.t("stratified_sortitions.execute.executing", scope: "decidim.stratified_sortitions.admin")
+          redirect_to execute_stratified_sortition_path(stratified_sortition)
+        end
+
+        def export_charts_pdf
+          portfolio = stratified_sortition.panel_portfolio
+
+          unless portfolio&.sampled?
+            flash[:error] = I18n.t("stratified_sortitions.export_results.no_results", scope: "decidim.stratified_sortitions.admin")
+            redirect_to execute_stratified_sortition_path(stratified_sortition)
+            return
+          end
+
+          generator = ChartsPdfGenerator.new(
+            stratified_sortition,
+            strata_data(stratified_sortition),
+            candidates_data(stratified_sortition),
+            results_data(stratified_sortition),
+            locale: I18n.locale
+          )
+
+          filename = "sortition_charts_#{stratified_sortition.id}_#{Time.current.strftime("%Y%m%d_%H%M%S")}.pdf"
+          send_data generator.generate,
+                    filename:,
+                    type: "application/pdf",
+                    disposition: "attachment"
+        end
+
+        def export_results
+          format = params[:format]&.downcase || "csv"
+          portfolio = stratified_sortition.panel_portfolio
+
+          unless portfolio&.sampled?
+            flash[:error] = I18n.t("stratified_sortitions.export_results.no_results", scope: "decidim.stratified_sortitions.admin")
+            redirect_to execute_stratified_sortition_path(stratified_sortition)
+            return
+          end
+
+          SortitionResultsExportJob.perform_later(current_user, stratified_sortition, format)
+
+          Decidim.traceability.perform_action!("export_results", stratified_sortition, current_user, visibility: "all")
+          flash[:notice] = I18n.t("decidim.admin.exports.notice")
+          redirect_to execute_stratified_sortition_path(stratified_sortition)
+        end
+
+        def log_view_participants
+          portfolio = stratified_sortition.panel_portfolio
+
+          unless portfolio&.sampled?
+            head :unprocessable_entity
+            return
+          end
+
+          Decidim.traceability.perform_action!("view_participants", stratified_sortition, current_user, visibility: "all")
+
+          head :ok
+        end
+
+        private
+
+        def collection
+          @collection ||= StratifiedSortition.where(component: current_component)
+        end
+
+        def stratified_sortitions
+          @stratified_sortitions ||= collection.page(params[:page]).per(10)
+        end
+
+        def stratified_sortition
+          @stratified_sortition ||= collection.find_by(id: params[:id])
+        end
+
+        def form_presenter
+          @form_presenter ||= present(@form, presenter_class: Decidim::StratifiedSortitions::StratifiedSortitionPresenter)
+        end
+
+        def blank_stratum
+          @blank_stratum ||= Decidim::StratifiedSortitions::Admin::StratumForm.new
+        end
+
+        def blank_substratum(stratum_form)
+          Decidim::StratifiedSortitions::Admin::SubstratumForm.new(stratum: stratum_form.model)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module StratifiedSortitions
+    # 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::Components::BaseController
+    end
+  end
+end

data/app/controllers/decidim/stratified_sortitions/charts_pdf_controller_helper.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Decidim
+  module StratifiedSortitions
+    # A dummy controller used to render PDF views outside the request cycle.
+    # Following the same pattern as Decidim core (decidim-forms).
+    # rubocop:disable Rails/ApplicationController
+    class ChartsPdfControllerHelper < ActionController::Base
+      # rubocop:enable Rails/ApplicationController
+      helper Decidim::TranslationsHelper
+      helper Decidim::StratifiedSortitions::ChartsPdfHelper
+
+      # Ensure the engine's views (templates + layouts) are found.
+      append_view_path Decidim::StratifiedSortitions::Engine.root.join("app", "views")
+    end
+  end
+end

data/app/controllers/decidim/stratified_sortitions/stratified_sortitions_controller.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Decidim
+  module StratifiedSortitions
+    # Controller that allows browsing stratified sortitions.
+    #
+    class StratifiedSortitionsController < Decidim::StratifiedSortitions::ApplicationController
+      include Decidim::ApplicationHelper
+      include FilterResource
+      include Paginable
+      include OrderableStratifiedSortitions
+      include StrataChartsData
+
+      helper Decidim::CheckBoxesTreeHelper
+      helper Decidim::PaginateHelper
+
+      helper_method :stratified_sortitions, :stratified_sortition
+
+      def index
+        @stratified_sortitions = search.result
+        @stratified_sortitions = reorder(@stratified_sortitions)
+        @stratified_sortitions = paginate(@stratified_sortitions)
+      end
+
+      def show
+        raise ActionController::RoutingError, "Not Found" unless stratified_sortition
+
+        if current_component.settings.publish_sortitions
+          @strata_data = strata_data(stratified_sortition) if stratified_sortition.strata_and_substrata_configured?
+          @candidates_data = candidates_data(stratified_sortition) if stratified_sortition.can_execute?
+          @results_data = results_data(stratified_sortition) if stratified_sortition.panel_portfolio&.sampled?
+        end
+      end
+
+      private
+
+      def stratified_sortition
+        @stratified_sortition ||= search_collection.find_by(id: params[:id])
+      end
+
+      def stratified_sortition_scope
+        @stratified_sortition_scope ||= current_organization.scopes.find_by(id: stratified_sortition&.decidim_scope_id)
+      end
+
+      def stratified_sortitions
+        @stratified_sortitions ||= reorder(paginate(search.result))
+      end
+
+      def search_collection
+        ::Decidim::StratifiedSortitions::StratifiedSortition.where(component: current_component)
+      end
+
+      def default_filter_params
+        {
+          search_text_cont: "",
+          with_any_state: "all",
+        }
+      end
+    end
+  end
+end

data/app/forms/decidim/stratified_sortitions/admin/sample_upload_form.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Decidim
+  module StratifiedSortitions
+    module Admin
+      class SampleUploadForm < Decidim::Form
+        include Decidim::HasUploadValidations
+
+        attribute :file, Decidim::Attributes::Blob
+
+        validates :file, presence: true
+      end
+    end
+  end
+end

data/app/forms/decidim/stratified_sortitions/admin/stratified_sortitions_form.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+module Decidim
+  module StratifiedSortitions
+    module Admin
+      # A form object used to create stratified sortitions from the admin dashboard.
+      #
+      class StratifiedSortitionsForm < Decidim::Form
+        include TranslatableAttributes
+        include TranslationsHelper
+        include Decidim::HasUploadValidations
+        include ApplicationHelper
+
+        mimic :stratified_sortition
+
+        translatable_attribute :title, String do |field, _locale|
+          validates field, length: { in: 5..150 }, if: proc { |resource| resource.send(field).present? }
+        end
+        translatable_attribute :description, String
+        translatable_attribute :selection_criteria, String
+        translatable_attribute :selected_profiles_description, String
+
+        attribute :id, Integer
+        attribute :decidim_component_id, Integer
+        attribute :num_candidates, Integer
+        attribute :strata, [StratumForm]
+
+        validates :title, :description, translatable_presence: true
+        validates :num_candidates,
+                  presence: true,
+                  numericality: {
+                    only_integer: true,
+                    greater_than_or_equal_to: 1,
+                  }
+
+        alias organization current_organization
+
+        def map_model(model)
+          super
+          self.strata = model.strata.order(:position).map do |stratum|
+            Decidim::StratifiedSortitions::Admin::StratumForm.from_model(stratum)
+          end
+        end
+
+        def strata_to_persist
+          strata.reject(&:deleted)
+        end
+
+        validate :strata_immutable_when_sample_participants_exist
+        validate :num_candidates_immutable_when_executed
+
+        private
+
+        def num_candidates_immutable_when_executed
+          return unless stratified_sortition&.executed?
+          return if stratified_sortition.num_candidates == num_candidates
+
+          errors.add(:num_candidates, :cannot_change_num_candidates_when_executed)
+        end
+
+        def strata_immutable_when_sample_participants_exist
+          return unless stratified_sortition&.sample_participants&.any?
+          return if stratified_sortition.executed?
+
+          validate_strata_count
+          validate_strata_attributes
+          validate_substrata_changes
+        end
+
+        def validate_strata_count
+          existing_strata_ids = stratified_sortition.strata.pluck(:id)
+          form_strata_ids = strata_to_persist.map { |s| s.id.to_i }.reject(&:zero?)
+
+          new_strata = strata_to_persist.select { |s| s.id.blank? }
+          errors.add(:strata, :cannot_add_strata_with_sample_participants) if new_strata.any?
+
+          errors.add(:strata, :cannot_delete_strata_with_sample_participants) if (existing_strata_ids - form_strata_ids).any?
+        end
+
+        def validate_strata_attributes
+          strata_to_persist.each do |stratum_form|
+            next if stratum_form.id.blank?
+
+            existing_stratum = stratified_sortition.strata.find_by(id: stratum_form.id)
+            next unless existing_stratum
+
+            errors.add(:strata, :cannot_change_stratum_name_with_sample_participants) unless same_translated_attribute?(existing_stratum.name, stratum_form.name)
+
+            errors.add(:strata, :cannot_change_stratum_kind_with_sample_participants) if existing_stratum.kind != stratum_form.kind
+          end
+        end
+
+        def validate_substrata_changes
+          strata_to_persist.each do |stratum_form|
+            next if stratum_form.id.blank?
+
+            existing_stratum = stratified_sortition.strata.find_by(id: stratum_form.id)
+            next unless existing_stratum
+
+            existing_substrata_ids = existing_stratum.substrata.pluck(:id)
+            form_substrata_ids = stratum_form.substrata_to_persist.map { |s| s.id.to_i }.reject(&:zero?)
+
+            new_substrata = stratum_form.substrata_to_persist.select { |s| s.id.blank? }
+            errors.add(:strata, :cannot_add_substrata_with_sample_participants) if new_substrata.any?
+
+            errors.add(:strata, :cannot_delete_substrata_with_sample_participants) if (existing_substrata_ids - form_substrata_ids).any?
+
+            validate_substrata_attributes(existing_stratum, stratum_form)
+          end
+        end
+
+        def validate_substrata_attributes(existing_stratum, stratum_form)
+          stratum_form.substrata_to_persist.each do |substratum_form|
+            next if substratum_form.id.blank?
+
+            existing_substratum = existing_stratum.substrata.find_by(id: substratum_form.id)
+            next unless existing_substratum
+
+            errors.add(:strata, :cannot_change_substratum_name_with_sample_participants) unless same_translated_attribute?(existing_substratum.name, substratum_form.name)
+
+            unless normalize_blank(existing_substratum.value) == normalize_blank(substratum_form.value)
+              errors.add(:strata, :cannot_change_substratum_value_with_sample_participants)
+            end
+
+            unless normalize_blank(existing_substratum.range) == normalize_blank(substratum_form.range)
+              errors.add(:strata, :cannot_change_substratum_range_with_sample_participants)
+            end
+          end
+        end
+
+        def normalize_blank(value)
+          value.presence
+        end
+
+        def same_translated_attribute?(existing_value, form_value)
+          existing_hash = normalize_translated_hash(existing_value)
+          form_hash = normalize_translated_hash(form_value)
+
+          locales = (existing_hash.keys + form_hash.keys).uniq
+          locales.all? { |locale| existing_hash[locale] == form_hash[locale] }
+        end
+
+        def normalize_translated_hash(value)
+          hash = value.is_a?(Hash) ? value.stringify_keys : {}
+          hash = hash.except("machine_translations")
+          hash.transform_values { |v| v.to_s.strip.presence }.compact
+        end
+
+        def stratified_sortition
+          @stratified_sortition ||= Decidim::StratifiedSortitions::StratifiedSortition.find_by(id:)
+        end
+      end
+    end
+  end
+end

data/app/forms/decidim/stratified_sortitions/admin/stratum_form.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+# rubocop:disable Metrics/PerceivedComplexity
+# rubocop:disable  Lint/ReturnInVoidContext
+module Decidim
+  module StratifiedSortitions
+    module Admin
+      class StratumForm < Decidim::Form
+        include TranslatableAttributes
+
+        translatable_attribute :name, String
+        attribute :kind, String
+        attribute :deleted, Boolean, default: false
+        attribute :substrata, [SubstratumForm]
+        attribute :position, Integer
+
+        validates :name, translatable_presence: true, unless: :deleted
+        validates :position, numericality: { greater_than_or_equal_to: 0 }
+
+        def substrata
+          @substrata ||= []
+        end
+
+        def substrata=(value)
+          return @substrata = [] if value.blank?
+
+          if value.is_a?(Hash)
+            value = if value.values.first.is_a?(String)
+                      [value]
+                    else
+                      value.values
+                    end
+          end
+
+          @substrata = value.map do |substratum_data|
+            if substratum_data.is_a?(SubstratumForm)
+              substratum_data
+            elsif substratum_data.is_a?(Hash)
+              SubstratumForm.from_params(substratum_data)
+            elsif substratum_data.is_a?(Array) && substratum_data[1].is_a?(Hash)
+              SubstratumForm.from_params(substratum_data[1])
+            else
+              next
+            end
+          end.compact
+        end
+
+        def map_model(model)
+          super
+          self.substrata = model.substrata.order(:position).map do |substratum|
+            Decidim::StratifiedSortitions::Admin::SubstratumForm.from_model(substratum)
+          end
+        end
+
+        def substrata_to_persist
+          substrata.select { |s| s.is_a?(SubstratumForm) && !s.deleted }
+        end
+
+        def to_param
+          return id if id.present?
+
+          "stratified-sortition-stratum-id"
+        end
+      end
+    end
+  end
+end
+# rubocop:enable Metrics/PerceivedComplexity
+# rubocop:enable  Lint/ReturnInVoidContext

data/app/forms/decidim/stratified_sortitions/admin/substratum_form.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Decidim
+  module StratifiedSortitions
+    module Admin
+      class SubstratumForm < Decidim::Form
+        include TranslatableAttributes
+
+        translatable_attribute :name, String
+        attribute :value, String
+        attribute :range, String
+        attribute :max_quota_percentage, String
+        attribute :deleted, Boolean, default: false
+        attribute :position, Integer
+
+        validates :position, numericality: { greater_than_or_equal_to: 0 }
+
+        def to_param
+          return id if id.present?
+
+          "stratified-sortition-strata-substratum-id"
+        end
+      end
+    end
+  end
+end

data/app/helpers/decidim/stratified_sortitions/admin/stratified_sortitions_helper.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Decidim
+  module StratifiedSortitions
+    module Admin
+      module StratifiedSortitionsHelper
+        def stratified_sortition_state_css_class(stratified_sortition)
+          case stratified_sortition.status
+          when "executed" then "success"
+          when "executing", "failed" then "alert"
+          when "pending" then "warning"
+          else "info"
+          end
+        end
+      end
+    end
+  end
+end