decidim-stratified_sortitions 0.0.1

data/app/commands/decidim/stratified_sortitions/admin/update_stratified_sortition.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+module Decidim
+  module StratifiedSortitions
+    module Admin
+      # A command with all the business logic when a user updates a stratified sortition.
+      class UpdateStratifiedSortition < Decidim::Command
+        include ::Decidim::AttachmentAttributesMethods
+
+        # Public: Initializes the command.
+        #
+        # form         - A form object with the params.
+        # stratified_sortition - the stratified sortition to update.
+        def initialize(form, stratified_sortition)
+          super()
+          @form = form
+          @stratified_sortition = stratified_sortition
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid, together with the stratified_sortition.
+        # - :invalid if the form wasn't valid and we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          transaction do
+            update_stratified_sortition
+            update_strata(stratified_sortition) unless stratified_sortition.executed?
+          end
+
+          broadcast(:ok, stratified_sortition)
+        end
+
+        private
+
+        attr_reader :form, :stratified_sortition
+
+        def update_stratified_sortition
+          Decidim.traceability.update!(
+            stratified_sortition,
+            form.current_user,
+            attributes:
+          )
+        end
+
+        def attributes
+          parsed_title = Decidim::ContentProcessor.parse_with_processor(:hashtag, form.title, current_organization: form.current_organization).rewrite
+          parsed_description = Decidim::ContentProcessor.parse_with_processor(:hashtag, form.description, current_organization: form.current_organization).rewrite
+          parsed_selection_criteria = Decidim::ContentProcessor.parse_with_processor(:hashtag, form.selection_criteria, current_organization: form.current_organization).rewrite
+          parsed_selected_profiles_description = Decidim::ContentProcessor.parse_with_processor(:hashtag, form.selected_profiles_description,
+                                                                                                current_organization: form.current_organization).rewrite
+          {
+            title: parsed_title,
+            description: parsed_description,
+            selection_criteria: parsed_selection_criteria,
+            selected_profiles_description: parsed_selected_profiles_description,
+            component: form.current_component,
+            num_candidates: form.num_candidates,
+          }
+        end
+
+        def update_strata(stratified_sortition)
+          strata_ids_to_keep = form.strata_to_persist.pluck(:id).compact.map(&:to_i)
+
+          stratified_sortition.strata.each do |existing_stratum|
+            next if strata_ids_to_keep.include?(existing_stratum.id)
+
+            existing_stratum.substrata.each do |substratum|
+              Decidim::StratifiedSortitions::SampleParticipantStratum.where(
+                decidim_stratified_sortitions_substratum_id: substratum.id
+              ).destroy_all
+            end
+
+            existing_stratum.destroy!
+          end
+
+          form.strata_to_persist.each do |stratum_form|
+            if stratum_form.id.present?
+              stratum_object = Decidim::StratifiedSortitions::Stratum.find_by(
+                id: stratum_form.id,
+                decidim_stratified_sortition_id: stratified_sortition.id
+              )
+
+              if stratum_object
+                stratum_object.update!(
+                  name: stratum_form.name,
+                  kind: stratum_form.kind,
+                  position: stratum_form.position
+                )
+              else
+                stratum_object = create_stratum(stratified_sortition, stratum_form)
+              end
+              update_substrata(stratum_object, stratum_form)
+            else
+              stratum_object = create_stratum(stratified_sortition, stratum_form)
+              create_substrata(stratum_object, stratum_form)
+            end
+          end
+        end
+
+        def update_substrata(stratum, stratum_form)
+          updated_or_created_ids = []
+
+          stratum_form.substrata_to_persist.each do |substratum_form|
+            next if substratum_form.deleted
+
+            if substratum_form.id.present?
+              substratum = Decidim::StratifiedSortitions::Substratum.find_by(
+                id: substratum_form.id,
+                decidim_stratified_sortitions_stratum_id: stratum.id
+              )
+
+              if substratum
+                substratum.update!(
+                  name: substratum_form.name,
+                  value: substratum_form.value,
+                  range: substratum_form.range,
+                  max_quota_percentage: substratum_form.max_quota_percentage,
+                  position: substratum_form.position
+                )
+                updated_or_created_ids << substratum.id
+              else
+                new_substratum = create_substratum(stratum, substratum_form)
+                updated_or_created_ids << new_substratum.id
+              end
+            else
+              new_substratum = create_substratum(stratum, substratum_form)
+              updated_or_created_ids << new_substratum.id
+            end
+          end
+
+          stratum.substrata.reload.each do |existing_substratum|
+            next if updated_or_created_ids.include?(existing_substratum.id)
+
+            Decidim::StratifiedSortitions::SampleParticipantStratum.where(
+              decidim_stratified_sortitions_substratum_id: existing_substratum.id
+            ).destroy_all
+
+            existing_substratum.destroy!
+          end
+        end
+
+        def create_stratum(stratified_sortition, stratum_form)
+          Decidim::StratifiedSortitions::Stratum.create!(
+            stratified_sortition:,
+            name: stratum_form.name,
+            kind: stratum_form.kind,
+            position: stratum_form.position
+          )
+        end
+
+        def create_substrata(stratum, stratum_form)
+          stratum_form.substrata_to_persist.each do |substratum_form|
+            create_substratum(stratum, substratum_form)
+          end
+        end
+
+        def create_substratum(stratum, substratum_form)
+          Decidim::StratifiedSortitions::Substratum.create!(
+            stratum:,
+            name: substratum_form.name,
+            value: substratum_form.value,
+            range: substratum_form.range,
+            max_quota_percentage: substratum_form.max_quota_percentage,
+            position: substratum_form.position
+          )
+        end
+      end
+    end
+  end
+end

data/app/controllers/concerns/decidim/stratified_sortitions/orderable_stratified_sortitions.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  module StratifiedSortitions
+    # Common logic to sorting resources
+    module OrderableStratifiedSortitions
+      extend ActiveSupport::Concern
+
+      included do
+        include Decidim::Orderable
+
+        private
+
+        def available_orders
+          @available_orders ||= %w(random recent)
+        end
+
+        def default_order
+          "random"
+        end
+
+        def reorder(stratified_sortitions)
+          case order
+          when "recent"
+            stratified_sortitions.order("created_at DESC")
+          when "random"
+            stratified_sortitions.order_randomly(random_seed)
+          else
+            stratified_sortitions
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/concerns/decidim/stratified_sortitions/strata_charts_data.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  module StratifiedSortitions
+    # Shared logic for computing strata and candidates chart data.
+    # Used by both admin and public controllers to avoid duplication.
+    module StrataChartsData
+      extend ActiveSupport::Concern
+
+      private
+
+      def strata_data(stratified_sortition)
+        stratified_sortition.strata.order(:position).map do |stratum|
+          chart_data = stratum.substrata.order(:position).map do |substratum|
+            quota_value = substratum.max_quota_percentage.present? ? substratum.max_quota_percentage.to_f : 0.0
+            label_with_percentage = "#{translated_attribute(substratum.name)} (#{quota_value}%)"
+            [label_with_percentage, quota_value]
+          end
+          chart_data = chart_data.reject { |_name, value| value.zero? }
+          {
+            stratum:,
+            chart_data:,
+          }
+        end
+      end
+
+      def candidates_data(stratified_sortition)
+        participant_ids = stratified_sortition.sample_participants.pluck(:id)
+        participants_distribution_data(stratified_sortition, participant_ids)
+      end
+
+      def results_data(stratified_sortition)
+        return stratified_sortition.strata.order(:position).map { |stratum| { stratum:, chart_data: [] } } unless stratified_sortition.panel_portfolio&.sampled?
+
+        selected_ids = stratified_sortition.panel_portfolio.selected_panel
+        participants_distribution_data(stratified_sortition, selected_ids)
+      end
+
+      def participants_distribution_data(stratified_sortition, participant_ids)
+        sample_candidates_stratum = fetch_sample_candidates_stratum(participant_ids)
+        by_stratum = group_by_stratum(sample_candidates_stratum)
+        by_stratum_and_substratum = group_by_stratum_and_substratum(sample_candidates_stratum)
+
+        stratified_sortition.strata.order(:position).map do |stratum|
+          build_stratum_chart(stratum, by_stratum, by_stratum_and_substratum)
+        end
+      end
+
+      def fetch_sample_candidates_stratum(sample_candidates_ids)
+        Decidim::StratifiedSortitions::SampleParticipantStratum
+          .where(decidim_stratified_sortitions_sample_participant_id: sample_candidates_ids)
+          .select(:decidim_stratified_sortitions_sample_participant_id,
+                  :decidim_stratified_sortitions_stratum_id,
+                  :decidim_stratified_sortitions_substratum_id)
+          .distinct
+          .to_a
+      end
+
+      def group_by_stratum(sample_candidates_stratum)
+        sample_candidates_stratum.group_by(&:decidim_stratified_sortitions_stratum_id)
+      end
+
+      def group_by_stratum_and_substratum(sample_candidates_stratum)
+        sample_candidates_stratum.group_by do |s|
+          [s.decidim_stratified_sortitions_stratum_id, s.decidim_stratified_sortitions_substratum_id]
+        end
+      end
+
+      def build_stratum_chart(stratum, by_stratum, by_stratum_and_substratum)
+        substrata = stratum.substrata.order(:position)
+        total = by_stratum[stratum.id]&.map(&:decidim_stratified_sortitions_sample_participant_id)&.uniq&.count || 0
+        chart_data = substrata.map do |substratum|
+          build_substratum_chart_row(stratum, substratum, by_stratum_and_substratum, total)
+        end
+        chart_data = chart_data.reject { |_name, value| value.zero? }
+        { stratum:, chart_data: }
+      end
+
+      def build_substratum_chart_row(stratum, substratum, by_stratum_and_substratum, total)
+        ids = (by_stratum_and_substratum[[stratum.id, substratum.id]] || [])
+              .map(&:decidim_stratified_sortitions_sample_participant_id).uniq
+        count = ids.count
+        percentage = total.positive? ? ((count.to_f / total) * 100).round(1) : 0.0
+        label = "#{translated_attribute(substratum.name)} (#{percentage}%)"
+        [label, count]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Decidim
+  module StratifiedSortitions
+    module Admin
+      # This controller is the abstract class from which all other controllers of
+      # this engine inherit.
+      #
+      # Note that it inherits from `Decidim::Admin::Components::BaseController`, which
+      # override its layout and provide all kinds of useful methods.
+      class ApplicationController < Decidim::Admin::Components::BaseController
+        def index
+          enforce_permission_to :read, :stratified_sortitions
+          @stratified_sortitions = stratified_sortitions
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+require "rubyXL"
+require "rubyXL/convenience_methods/cell"
+require "rubyXL/convenience_methods/font"
+require "rubyXL/convenience_methods/workbook"
+require "rubyXL/convenience_methods/worksheet"
+
+module Decidim
+  module StratifiedSortitions
+    module Admin
+      # Controller that allows managing samples for stratified sortitions.
+      #
+      class SamplesController < Decidim::StratifiedSortitions::Admin::ApplicationController
+        include Decidim::TranslatableAttributes
+
+        before_action :ensure_strata_configured, only: [:create, :remove_multiple]
+        before_action :ensure_stratified_sortition_is_pending, only: [:create, :remove_multiple]
+
+        include Decidim::ApplicationHelper
+
+        helper StratifiedSortitions::ApplicationHelper
+        helper Decidim::PaginateHelper
+
+        helper_method :stratified_sortitions, :stratified_sortition, :form_presenter, :blank_stratum, :blank_substratum
+
+        def download_template
+          if params[:format] == "xlsx"
+            send_data generate_template_sample_xlsx,
+                      filename: "sample_importation_template.xlsx",
+                      type: "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
+          else
+            send_data generate_template_sample_csv,
+                      filename: "sample_importation_template.csv",
+                      type: "text/csv"
+          end
+        end
+
+        def create
+          enforce_permission_to :upload_sample, :stratified_sortition
+
+          @form = form(SampleUploadForm).from_params(params)
+
+          Decidim::StratifiedSortitions::Admin::ImportSample.call(@form, stratified_sortition, current_user) do
+            on(:ok) do
+              Decidim.traceability.perform_action!("import_sample", stratified_sortition, current_user, visibility: "all")
+              flash[:notice] = I18n.t("sample_imports.create.success", scope: "decidim.stratified_sortitions.admin")
+              redirect_to upload_sample_stratified_sortition_path(stratified_sortition)
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("sample_imports.create.invalid", scope: "decidim.stratified_sortitions.admin")
+              redirect_to upload_sample_stratified_sortition_path(stratified_sortition)
+            end
+          end
+        end
+
+        def remove_multiple
+          enforce_permission_to :upload_sample, :stratified_sortition
+
+          Decidim::StratifiedSortitions::Admin::RemoveSamplesJob.perform_later(stratified_sortition, current_user)
+          flash[:notice] = I18n.t("sample_imports.remove_uploaded_samples.enqueued", scope: "decidim.stratified_sortitions.admin")
+          redirect_to upload_sample_stratified_sortition_path(stratified_sortition)
+        end
+
+        private
+
+        def ensure_strata_configured
+          unless stratified_sortition.strata_and_substrata_configured?
+            flash[:alert] = t("decidim.stratified_sortitions.admin.samples.errors.no_strata")
+            redirect_to upload_sample_stratified_sortition_path(stratified_sortition)
+          end
+        end
+
+        def ensure_stratified_sortition_is_pending
+          unless stratified_sortition.status == "pending"
+            flash[:alert] = t("decidim.stratified_sortitions.admin.samples.errors.pending")
+            redirect_to upload_sample_stratified_sortition_path(stratified_sortition)
+          end
+        end
+
+        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(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
+          @blank_substratum ||= Decidim::StratifiedSortitions::Admin::SubstratumForm.new
+        end
+
+        def template_sample_headers
+          personal_headers = [
+            I18n.t("decidim.stratified_sortitions.admin.samples.template.personal_data_1"),
+            I18n.t("decidim.stratified_sortitions.admin.samples.template.personal_data_2"),
+            I18n.t("decidim.stratified_sortitions.admin.samples.template.personal_data_3"),
+            I18n.t("decidim.stratified_sortitions.admin.samples.template.personal_data_4"),
+          ]
+          strata = stratified_sortition.strata.order(:position)
+          strata_headers = strata.map do |stratum|
+            translated_attribute(stratum.name)
+          end
+
+          personal_headers + strata_headers
+        end
+
+        def generate_template_sample_csv
+          headers = template_sample_headers
+          CSV.generate(col_sep: ",") do |csv|
+            csv << headers
+          end
+        end
+
+        def generate_template_sample_xlsx
+          headers = template_sample_headers
+          workbook = RubyXL::Workbook.new
+          worksheet = workbook[0]
+
+          headers.each_with_index do |header, col|
+            worksheet.add_cell(0, col, header)
+            worksheet.change_column_width(col, 20)
+          end
+
+          workbook.stream.string
+        end
+      end
+    end
+  end
+end