decidim-stratified_sortitions 0.0.1

data/db/migrate/20260616000000_add_execution_error_to_stratified_sortitions.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class AddExecutionErrorToStratifiedSortitions < ActiveRecord::Migration[7.0]
+  def up
+    add_column :decidim_stratified_sortitions_stratified_sortitions, :execution_error, :text
+  end
+
+  def down
+    remove_column :decidim_stratified_sortitions_stratified_sortitions, :execution_error
+  end
+end

data/lib/decidim/stratified_sortitions/admin.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module StratifiedSortitions
+    # This module contains all the domain logic associated to Decidim's StratifiedSortitions
+    # component admin panel.
+    module Admin
+    end
+  end
+end

data/lib/decidim/stratified_sortitions/admin_engine.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "chartkick"
+
+module Decidim
+  module StratifiedSortitions
+    # This is the engine that runs on the administration interface of `decidim_stratified_sortitions`.
+    # It mostly handles rendering the created projects associated to a participatory
+    # process.
+    class AdminEngine < ::Rails::Engine
+      isolate_namespace Decidim::StratifiedSortitions::Admin
+
+      paths["db/migrate"] = nil
+      paths["lib/tasks"] = nil
+
+      routes do
+        resources :stratified_sortitions do
+          post :duplicate, on: :member
+          get :upload_sample, on: :member
+          post :process_sample, on: :member
+          get :execute, on: :member
+          post :execute_stratified_sortition, on: :member
+          post :export_results, on: :member
+          post :export_charts_pdf, on: :member
+          post :log_view_participants, on: :member
+        end
+
+        resources :samples, only: [:show, :create] do
+          collection do
+            get :download_template
+            delete :remove_multiple
+          end
+        end
+
+        root to: "stratified_sortitions#index"
+      end
+
+      initializer "decidim_sstratified_sortitions_admin.mount_routes" do |_app|
+        Decidim::Core::Engine.routes do
+          mount Decidim::StratifiedSortitions::AdminEngine, at: "/admin", as: "decidim_admin_stratified_sortitions"
+        end
+      end
+
+      def load_seed
+        nil
+      end
+    end
+  end
+end

data/lib/decidim/stratified_sortitions/component.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_dependency "decidim/components/namer"
+require "decidim/stratified_sortitions/admin"
+require "decidim/stratified_sortitions/engine"
+require "decidim/stratified_sortitions/admin_engine"
+
+Decidim.register_component(:stratified_sortitions) do |component|
+  component.engine = Decidim::StratifiedSortitions::Engine
+  component.stylesheet = "decidim/stratified_sortitions/stratified_sortitions"
+  component.admin_engine = Decidim::StratifiedSortitions::AdminEngine
+  component.icon = "media/images/decidim_stratified_sortitions.svg"
+
+  component.on(:before_destroy) do |instance|
+    Decidim::StratifiedSortitions::StratifiedSortition.where(decidim_component_id: instance.id).find_each(&:destroy!)
+  end
+
+  component.permissions_class_name = "Decidim::StratifiedSortitions::Permissions"
+
+  # These actions permissions can be configured in the admin panel
+  # component.actions = %w()
+
+  component.settings(:global) do |settings|
+    settings.attribute :publish_sortitions, type: :boolean, default: true
+  end
+
+  component.settings(:step) do |settings|
+    settings.attribute :announcement, type: :text, translated: true, editor: true
+  end
+
+  component.register_resource(:stratified_sortition) do |resource|
+    # Register a optional resource that can be references from other resources.
+    resource.model_class_name = "Decidim::StratifiedSortitions::StratifiedSortition"
+    resource.card = "decidim/stratified_sortitions/stratified_sortition"
+    resource.searchable = true
+  end
+
+  component.register_stat :sortitions_count, primary: true, priority: Decidim::StatsRegistry::HIGH_PRIORITY do |components, start_at, end_at|
+    Decidim::StratifiedSortitions::FilteredStratifiedSortitions.for(components, start_at, end_at).count
+  end
+end

data/lib/decidim/stratified_sortitions/engine.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "rails"
+require "active_support/all"
+require "chartkick"
+
+require "decidim/core"
+
+module Decidim
+  module StratifiedSortitions
+    # Decidim's StratifiedSortitions Rails Engine.
+    class Engine < ::Rails::Engine
+      isolate_namespace Decidim::StratifiedSortitions
+
+      routes do
+        resources :stratified_sortitions, only: [:index, :show]
+        scope "/stratified_sortitions" do
+          root to: "stratified_sortitions#index"
+        end
+        get "/", to: redirect("stratified_sortitions", status: 301)
+      end
+
+      initializer "decidim_stratified_sortitions.register_icons" do
+        Decidim.icons.register(name: "seedling-line", icon: "seedling-line", category: "system", description: "", engine: :stratified_sortitions)
+        Decidim.icons.register(name: "bar-chart-box-line", icon: "bar-chart-box-line", category: "system", description: "", engine: :stratified_sortitions)
+        Decidim.icons.register(name: "group-line", icon: "group-line", category: "system", description: "", engine: :stratified_sortitions)
+      end
+
+      initializer "StratifiedSortitions.webpacker.assets_path" do
+        Decidim.register_assets_path File.expand_path("app/packs", root)
+      end
+    end
+  end
+end

data/lib/decidim/stratified_sortitions/seeds.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "decidim/components/namer"
+
+module Decidim
+  module StratifiedSortitions
+    class Seeds
+      attr_reader :participatory_space
+
+      def initialize(participatory_space:)
+        @participatory_space = participatory_space
+      end
+
+      def call
+        Decidim::Component.create!(
+          name: Decidim::Components::Namer.new(participatory_space.organization.available_locales, :stratified_sortitions).i18n_name,
+          manifest_name: :stratified_sortitions,
+          published_at: Time.current,
+          participatory_space:
+        )
+      end
+    end
+  end
+end

data/lib/decidim/stratified_sortitions/test/factories.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require "decidim/components/namer"
+require "decidim/faker/localized"
+require "decidim/core/test/factories"
+
+FactoryBot.define do
+  # Singular alias factory expected by specs (some tests call :stratified_sortition_component)
+  factory :stratified_sortition_component, parent: :component do
+    name { Decidim::Components::Namer.new(participatory_space.organization.available_locales, :stratified_sortitions).i18n_name }
+    manifest_name { :stratified_sortitions }
+    participatory_space { association(:participatory_process, :with_steps) }
+  end
+
+  factory :stratified_sortition, class: "Decidim::StratifiedSortitions::StratifiedSortition" do
+    title { generate_localized_title }
+    description { Decidim::Faker::Localized.wrapped("<p>", "</p>") { generate_localized_title } }
+    selection_criteria { Decidim::Faker::Localized.wrapped("<p>", "</p>") { Decidim::Faker::Localized.sentence(word_count: 4) } }
+    selected_profiles_description { Decidim::Faker::Localized.wrapped("<p>", "</p>") { Decidim::Faker::Localized.sentence(word_count: 4) } }
+    num_candidates { rand(1..10) }
+    component { association(:stratified_sortition_component) }
+  end
+
+  factory :stratum, class: "Decidim::StratifiedSortitions::Stratum" do
+    sequence(:name) { |n| { en: "Stratum #{n}" } }
+    kind { "value" }
+    stratified_sortition { association(:stratified_sortition) }
+  end
+
+  factory :substratum, class: "Decidim::StratifiedSortitions::Substratum" do
+    sequence(:name) { |n| { en: "Substratum #{n}" } }
+    value { "A" }
+    range { "0-10" }
+    max_quota_percentage { "10" }
+    stratum { association(:stratum) }
+  end
+
+  factory :sample_import, class: "Decidim::StratifiedSortitions::SampleImport" do
+    stratified_sortition { association(:stratified_sortition) }
+    filename { "sample.csv" }
+    status { :processing }
+    total_rows { 0 }
+    imported_rows { 0 }
+    failed_rows { 0 }
+    import_errors { {} }
+  end
+
+  factory :sample_participant, class: "Decidim::StratifiedSortitions::SampleParticipant" do
+    sequence(:personal_data_1) { |n| "ID#{n}" }
+    personal_data_2 { "Data 2" }
+    personal_data_3 { "Data 3" }
+    personal_data_4 { "Data 4" }
+    decidim_stratified_sortition { association(:stratified_sortition) }
+    decidim_stratified_sortitions_sample_import { association(:sample_import) }
+  end
+
+  factory :sample_participant_stratum, class: "Decidim::StratifiedSortitions::SampleParticipantStratum" do
+    decidim_stratified_sortitions_sample_participant { association(:sample_participant) }
+    decidim_stratified_sortitions_stratum { association(:stratum) }
+    decidim_stratified_sortitions_substratum { association(:substratum) }
+  end
+
+  factory :panel_portfolio, class: "Decidim::StratifiedSortitions::PanelPortfolio" do
+    stratified_sortition { association(:stratified_sortition) }
+    panels { [[1, 2, 3], [4, 5, 6]] }
+    probabilities { [0.6, 0.4] }
+    selection_probabilities { { 1 => 0.6, 2 => 0.6, 3 => 0.6, 4 => 0.4, 5 => 0.4, 6 => 0.4 } }
+    generated_at { Time.current }
+    generation_time_seconds { 1.5 }
+    num_iterations { 10 }
+    convergence_achieved { true }
+
+    trait :sampled do
+      selected_panel_index { 0 }
+      selected_at { Time.current }
+      verification_seed { "test_seed" }
+      random_value_used { 0.3 }
+    end
+  end
+end

data/lib/decidim/stratified_sortitions/version.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module StratifiedSortitions
+    def self.version
+      "0.0.1"
+    end
+
+    def self.decidim_version
+      "~> 0.29"
+    end
+  end
+end

data/lib/decidim/stratified_sortitions.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "decidim/stratified_sortitions/admin"
+require "decidim/stratified_sortitions/engine"
+require "decidim/stratified_sortitions/admin_engine"
+require "decidim/stratified_sortitions/component"
+
+module Decidim
+  # Base module for this engine.
+  module StratifiedSortitions
+    include ActiveSupport::Configurable
+
+    # Public setting that defines how many elements will be shown
+    # per page inside the administration view.
+    config_accessor :items_per_page do
+      15
+    end
+
+    config_accessor :leximin_algorithm do
+      "https://www.nature.com/articles/s41586-021-03788-6"
+    end
+
+    def self.derive_random_seed(seed)
+      return nil unless seed
+
+      Digest::SHA256.hexdigest(seed).to_i(16) % (2**31)
+    end
+  end
+end

metadata

@@ -0,0 +1,222 @@
+--- !ruby/object:Gem::Specification
+name: decidim-stratified_sortitions
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Oliver Valls
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chartkick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.2
+- !ruby/object:Gem::Dependency
+  name: decidim-admin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.29'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.29'
+- !ruby/object:Gem::Dependency
+  name: decidim-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.29'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.29'
+- !ruby/object:Gem::Dependency
+  name: ruby-cbc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.19
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.19
+description: To-Do
+email:
+- 199462+tramuntanal@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE-AGPLv3.txt
+- README.md
+- Rakefile
+- app/cells/decidim/stratified_sortitions/stratified_sortition_cell.rb
+- app/cells/decidim/stratified_sortitions/stratified_sortition_l_cell.rb
+- app/cells/decidim/stratified_sortitions/stratified_sortition_metadata_cell.rb
+- app/commands/decidim/stratified_sortitions/admin/create_stratified_sortition.rb
+- app/commands/decidim/stratified_sortitions/admin/destroy_stratified_sortition.rb
+- app/commands/decidim/stratified_sortitions/admin/duplicate_stratified_sortition.rb
+- app/commands/decidim/stratified_sortitions/admin/import_sample.rb
+- app/commands/decidim/stratified_sortitions/admin/remove_uploaded_samples.rb
+- app/commands/decidim/stratified_sortitions/admin/update_stratified_sortition.rb
+- app/controllers/concerns/decidim/stratified_sortitions/orderable_stratified_sortitions.rb
+- app/controllers/concerns/decidim/stratified_sortitions/strata_charts_data.rb
+- app/controllers/decidim/stratified_sortitions/admin/application_controller.rb
+- app/controllers/decidim/stratified_sortitions/admin/samples_controller.rb
+- app/controllers/decidim/stratified_sortitions/admin/stratified_sortitions_controller.rb
+- app/controllers/decidim/stratified_sortitions/application_controller.rb
+- app/controllers/decidim/stratified_sortitions/charts_pdf_controller_helper.rb
+- app/controllers/decidim/stratified_sortitions/stratified_sortitions_controller.rb
+- app/forms/decidim/stratified_sortitions/admin/sample_upload_form.rb
+- app/forms/decidim/stratified_sortitions/admin/stratified_sortitions_form.rb
+- app/forms/decidim/stratified_sortitions/admin/stratum_form.rb
+- app/forms/decidim/stratified_sortitions/admin/substratum_form.rb
+- app/helpers/decidim/stratified_sortitions/admin/stratified_sortitions_helper.rb
+- app/helpers/decidim/stratified_sortitions/application_helper.rb
+- app/helpers/decidim/stratified_sortitions/charts_pdf_helper.rb
+- app/helpers/decidim/stratified_sortitions/stratified_sortition_cells_helper.rb
+- app/javascript/channels/sample_import_progress.js
+- app/jobs/decidim/stratified_sortitions/admin/execute_sortition_job.rb
+- app/jobs/decidim/stratified_sortitions/admin/import_sample_job.rb
+- app/jobs/decidim/stratified_sortitions/admin/remove_samples_job.rb
+- app/jobs/decidim/stratified_sortitions/admin/sortition_results_export_job.rb
+- app/mailers/decidim/stratified_sortitions/admin/import_mailer.rb
+- app/models/decidim/stratified_sortitions/application_record.rb
+- app/models/decidim/stratified_sortitions/panel_portfolio.rb
+- app/models/decidim/stratified_sortitions/sample_import.rb
+- app/models/decidim/stratified_sortitions/sample_participant.rb
+- app/models/decidim/stratified_sortitions/sample_participant_stratum.rb
+- app/models/decidim/stratified_sortitions/stratified_sortition.rb
+- app/models/decidim/stratified_sortitions/stratum.rb
+- app/models/decidim/stratified_sortitions/substratum.rb
+- app/packs/entrypoints/decidim_stratified_sortitions.js
+- app/packs/entrypoints/decidim_stratified_sortitions_admin.js
+- app/packs/entrypoints/decidim_stratified_sortitions_admin.scss
+- app/packs/images/decidim/stratified_sortitions/icon.svg
+- app/packs/src/decidim/stratified_sortitions/application.js
+- app/packs/src/decidim/stratified_sortitions/results_tabs.js
+- app/packs/src/decidim/stratified_sortitions/stratum_fields.js
+- app/packs/src/decidim/stratified_sortitions/substratum_fields.js
+- app/packs/src/decidim/stratified_sortitions/upload_sample.js
+- app/packs/stylesheets/decidim/stratified_sortitions/admin/stratified_sortitions.scss
+- app/packs/stylesheets/decidim/stratified_sortitions/charts_pdf.scss
+- app/packs/stylesheets/stratified_sortitions.scss
+- app/permissions/decidim/stratified_sortitions/admin/permissions.rb
+- app/permissions/decidim/stratified_sortitions/permissions.rb
+- app/presenters/decidim/stratified_sortitions/admin_log/stratified_sortition_presenter.rb
+- app/queries/decidim/stratified_sortitions/filtered_stratified_sortitions.rb
+- app/serializers/decidim/stratified_sortitions/sortition_result_serializer.rb
+- app/services/decidim/stratified_sortitions/charts_pdf_generator.rb
+- app/services/decidim/stratified_sortitions/fair_sortition_service.rb
+- app/services/decidim/stratified_sortitions/leximin/constraint_builder.rb
+- app/services/decidim/stratified_sortitions/leximin/distribution_solver.rb
+- app/services/decidim/stratified_sortitions/leximin/feasibility_checker.rb
+- app/services/decidim/stratified_sortitions/leximin/panel_generator.rb
+- app/services/decidim/stratified_sortitions/leximin/panel_sampler.rb
+- app/services/decidim/stratified_sortitions/leximin_selector.rb
+- app/services/decidim/stratified_sortitions/sortition_results_exporter.rb
+- app/views/decidim/admin/components/index.html.erb
+- app/views/decidim/stratified_sortitions/admin/import_mailer/import.html.erb
+- app/views/decidim/stratified_sortitions/admin/stratified_sortitions/_confirm_execute_modal.html.erb
+- app/views/decidim/stratified_sortitions/admin/stratified_sortitions/_confirm_participants_modal.html.erb
+- app/views/decidim/stratified_sortitions/admin/stratified_sortitions/_form.html.erb
+- app/views/decidim/stratified_sortitions/admin/stratified_sortitions/_navigation_menu.html.erb
+- app/views/decidim/stratified_sortitions/admin/stratified_sortitions/_strata.html.erb
+- app/views/decidim/stratified_sortitions/admin/stratified_sortitions/_stratum.html.erb
+- app/views/decidim/stratified_sortitions/admin/stratified_sortitions/_substrata.html.erb
+- app/views/decidim/stratified_sortitions/admin/stratified_sortitions/_substratum.html.erb
+- app/views/decidim/stratified_sortitions/admin/stratified_sortitions/edit.html.erb
+- app/views/decidim/stratified_sortitions/admin/stratified_sortitions/execute.html.erb
+- app/views/decidim/stratified_sortitions/admin/stratified_sortitions/export_charts_pdf.html.erb
+- app/views/decidim/stratified_sortitions/admin/stratified_sortitions/index.html.erb
+- app/views/decidim/stratified_sortitions/admin/stratified_sortitions/new.html.erb
+- app/views/decidim/stratified_sortitions/admin/stratified_sortitions/upload_sample.html.erb
+- app/views/decidim/stratified_sortitions/shared/_strata_charts.html.erb
+- app/views/decidim/stratified_sortitions/stratified_sortitions/_results_count.html.erb
+- app/views/decidim/stratified_sortitions/stratified_sortitions/_stratified_sortition.html.erb
+- app/views/decidim/stratified_sortitions/stratified_sortitions/_stratified_sortitions.html.erb
+- app/views/decidim/stratified_sortitions/stratified_sortitions/_tags.html.erb
+- app/views/decidim/stratified_sortitions/stratified_sortitions/index.html.erb
+- app/views/decidim/stratified_sortitions/stratified_sortitions/index.js.erb
+- app/views/decidim/stratified_sortitions/stratified_sortitions/show.html.erb
+- app/views/layouts/decidim/admin/_sidebar_menu.html.erb
+- app/views/layouts/decidim/stratified_sortitions/charts_pdf.html.erb
+- config/assets.rb
+- config/locales/ca.yml
+- config/locales/en.yml
+- config/locales/es.yml
+- config/locales/oc.yml
+- config/routes.rb
+- db/migrate/20251023103900_create_decidim_stratified_sortitions_stratified_sortitions.rb
+- db/migrate/20251104120000_create_stratified_sortitions_strata_and_substrata.decidim_stratified_sortitions.rb
+- db/migrate/20251219120000_create_sample_imports.rb
+- db/migrate/20251219120100_create_sample_participants.rb
+- db/migrate/20251219120200_create_sample_participant_strata.rb
+- db/migrate/20251230130000_change_value_to_text_in_substrata.rb
+- db/migrate/20260102114744_add_status_to_stratified_sortitions.rb
+- db/migrate/20260109105643_allow_null_value_in_substrata.rb
+- db/migrate/20260113121726_add_position_to_strata_and_substrata.rb
+- db/migrate/20260127100000_rename_weighing_to_max_quota_percentage.rb
+- db/migrate/20260127120000_create_panel_portfolios.rb
+- db/migrate/20260518000000_add_foreign_key_to_stratified_sortitions_component.rb
+- db/migrate/20260521000000_add_cascade_to_stratified_sortitions_foreign_keys.rb
+- db/migrate/20260616000000_add_execution_error_to_stratified_sortitions.rb
+- lib/decidim/stratified_sortitions.rb
+- lib/decidim/stratified_sortitions/admin.rb
+- lib/decidim/stratified_sortitions/admin_engine.rb
+- lib/decidim/stratified_sortitions/component.rb
+- lib/decidim/stratified_sortitions/engine.rb
+- lib/decidim/stratified_sortitions/seeds.rb
+- lib/decidim/stratified_sortitions/test/factories.rb
+- lib/decidim/stratified_sortitions/version.rb
+homepage: https://github.com/gencat/decidim-module-stratified_sortitions
+licenses:
+- AGPL-3.0
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: A decidim stratified sortitions module
+test_files: []