decidim-sortitions 0.9.0

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

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

data/app/controllers/decidim/sortitions/sortition_widgets_controller.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Sortitions
+    class SortitionWidgetsController < Decidim::WidgetsController
+      helper Decidim::SanitizeHelper
+      helper Sortitions::SortitionsHelper
+
+      private
+
+      def model
+        @model ||= Sortition.where(feature: params[:feature_id]).find(params[:sortition_id])
+      end
+
+      def iframe_url
+        @iframe_url ||= sortition_sortition_widget_url(model)
+      end
+    end
+  end
+end

data/app/controllers/decidim/sortitions/sortitions_controller.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Sortitions
+    # Exposes the sortition resource so users can view them
+    class SortitionsController < Decidim::Sortitions::ApplicationController
+      helper Decidim::WidgetUrlsHelper
+      include FilterResource
+      include Orderable
+      include Paginable
+
+      helper_method :sortition
+
+      helper Decidim::Proposals::ApplicationHelper
+
+      def index
+        @sortitions = search
+                      .results
+                      .includes(:author)
+                      .includes(:category)
+
+        @sortitions = paginate(@sortitions)
+        @sortitions = reorder(@sortitions)
+      end
+
+      private
+
+      def sortition
+        Sortition.find(params[:id])
+      end
+
+      def search_klass
+        SortitionSearch
+      end
+
+      def default_filter_params
+        {
+          search_text: "",
+          category_id: "",
+          state: "active"
+        }
+      end
+    end
+  end
+end

data/app/events/decidim/sortitions/create_sortition_event.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Sortitions
+    class CreateSortitionEvent < Decidim::Events::SimpleEvent
+    end
+  end
+end

data/app/forms/decidim/sortitions/admin/destroy_sortition_form.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Sortitions
+    module Admin
+      class DestroySortitionForm < Form
+        include TranslatableAttributes
+
+        mimic :sortition
+
+        translatable_attribute :cancel_reason, String
+
+        validates :cancel_reason, translatable_presence: true
+
+        delegate :current_participatory_space, to: :context
+        delegate :current_feature, to: :context
+      end
+    end
+  end
+end

data/app/forms/decidim/sortitions/admin/edit_sortition_form.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Sortitions
+    module Admin
+      class EditSortitionForm < Form
+        include TranslatableAttributes
+
+        mimic :sortition
+
+        translatable_attribute :title, String
+        translatable_attribute :additional_info, String
+
+        validates :title, translatable_presence: true
+        validates :additional_info, translatable_presence: true
+
+        delegate :current_participatory_space, to: :context
+        delegate :current_feature, to: :context
+      end
+    end
+  end
+end

data/app/forms/decidim/sortitions/admin/sortition_form.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Sortitions
+    module Admin
+      class SortitionForm < Form
+        include TranslatableAttributes
+
+        mimic :sortition
+
+        translatable_attribute :title, String
+        attribute :decidim_proposals_feature_id, Integer
+        attribute :decidim_category_id, Integer
+        attribute :dice, Integer
+        attribute :target_items, Integer
+        translatable_attribute :witnesses, String
+        translatable_attribute :additional_info, String
+
+        validates :title, translatable_presence: true
+        validates :decidim_proposals_feature_id, presence: true
+        validates :witnesses, translatable_presence: true
+        validates :additional_info, translatable_presence: true
+        validates :dice,
+                  presence: true,
+                  numericality: {
+                    only_integer: true,
+                    greater_than_or_equal_to: 1,
+                    less_than_or_equal_to: 6
+                  }
+
+        validates :target_items,
+                  presence: true,
+                  numericality: {
+                    only_integer: true,
+                    greater_than_or_equal_to: 1
+                  }
+
+        delegate :categories, to: :current_participatory_space
+        delegate :current_participatory_space, to: :context
+        delegate :current_feature, to: :context
+      end
+    end
+  end
+end

data/app/helpers/decidim/sortitions/admin/sortitions_helper.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Sortitions
+    module Admin
+      module SortitionsHelper
+        include Decidim::TranslationsHelper
+
+        # Converst a list of features into a list of selectable options
+        def features_options(features)
+          features.map do |f|
+            [translated_attribute(f.name), f.id]
+          end
+        end
+
+        def sortition_category(sortition)
+          return translated_attribute sortition.category&.name if sortition.category
+
+          I18n.t("sortitions.form.all_categories", scope: "decidim.sortitions.admin")
+        end
+      end
+    end
+  end
+end

data/app/helpers/decidim/sortitions/sortitions_helper.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Sortitions
+    module SortitionsHelper
+      include Decidim::TranslationsHelper
+
+      def proposal_path(proposal)
+        EngineRouter.main_proxy(proposal.feature).proposal_path(proposal)
+      end
+
+      # Generates the sortition category label
+      def sortition_category_label(sortition)
+        if sortition.category.present?
+          return I18n.t("show.category",
+                        scope: "decidim.sortitions.sortitions",
+                        category: translated_attribute(sortition.category.name))
+        end
+
+        I18n.t("show.any_category", scope: "decidim.sortitions.sortitions")
+      end
+
+      # Show list of candidate proposals for a sortition. Selected sortition ids will appear with bold font.
+      def sortition_proposal_candidate_ids(sortition)
+        result = []
+        sortition.candidate_proposals.each do |proposal_id|
+          result << if sortition.selected_proposals.include? proposal_id
+                      "<b>#{proposal_id}</b>"
+                    else
+                      proposal_id.to_s
+                    end
+        end
+
+        result.join(", ").html_safe
+      end
+    end
+  end
+end

data/app/models/decidim/sortitions/abilities/admin/admin_ability.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Sortitions
+    module Abilities
+      module Admin
+        # Defines the abilities for a user in the admin section. Intended to be
+        # used with `cancancan`.
+        class AdminAbility < Decidim::Abilities::AdminAbility
+          def define_abilities
+            super
+
+            can :manage, Sortition
+            cannot :destroy, Sortition
+            can :destroy, Sortition do |sortition|
+              !sortition.cancelled?
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/decidim/sortitions/abilities/admin/process_admin_ability.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Sortitions
+    module Abilities
+      module Admin
+        class ProcessAdminAbility
+          include CanCan::Ability
+
+          attr_reader :user, :context
+
+          def initialize(user, context)
+            return unless user
+            return if user.admin?
+
+            @user = user
+            @context = context
+
+            return unless process_administrator?
+
+            can :manage, Sortition
+            cannot :destroy, Sortition
+            can :destroy, Sortition do |sortition|
+              !sortition.cancelled?
+            end
+          end
+
+          private
+
+          def process_administrator?
+            return false unless current_participatory_space.is_a? Decidim::ParticipatoryProcess
+
+            Decidim::ParticipatoryProcesses::Admin::AdminUsers
+              .for(current_participatory_space)
+              .where(id: user.id)
+              .any?
+          end
+
+          def current_participatory_space
+            @current_participatory_space ||= @context[:current_participatory_space]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Sortitions
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

data/app/models/decidim/sortitions/sortition.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Sortitions
+    # Model that encapsulates the parameters of a sortion
+    class Sortition < ApplicationRecord
+      include Decidim::Resourceable
+      include Decidim::HasCategory
+      include Decidim::Authorable
+      include Decidim::HasFeature
+      include Decidim::HasReference
+      include Decidim::Comments::Commentable
+
+      feature_manifest_name "sortitions"
+
+      belongs_to :decidim_proposals_feature,
+                 foreign_key: "decidim_proposals_feature_id",
+                 class_name: "Decidim::Feature"
+
+      belongs_to :cancelled_by_user,
+                 foreign_key: "cancelled_by_user_id",
+                 class_name: "Decidim::User",
+                 optional: true
+
+      scope :categorized_as, lambda { |category_id|
+        includes(:categorization)
+          .where("decidim_categorizations.decidim_category_id" => category_id)
+      }
+
+      scope :active, -> { where(cancelled_on: nil) }
+      scope :cancelled, -> { where.not(cancelled_on: nil) }
+
+      def proposals
+        Decidim::Proposals::Proposal.where(id: selected_proposals)
+      end
+
+      def similar_count
+        Sortition.where(feature: feature)
+                 .where(decidim_proposals_feature: decidim_proposals_feature)
+                 .categorized_as(category&.id)
+                 .where(target_items: target_items)
+                 .count
+      end
+
+      def seed
+        request_timestamp.to_i * dice
+      end
+
+      def cancelled?
+        cancelled_on.present?
+      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?
+      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
+
+      def self.order_randomly(seed)
+        transaction do
+          connection.execute("SELECT setseed(#{connection.quote(seed)})")
+          order("RANDOM()").load
+        end
+      end
+    end
+  end
+end

data/app/queries/decidim/sortitions/admin/participatory_space_proposal_features.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Sortitions
+    module Admin
+      # Query that retrieves a list of proposal features
+      class ParticipatorySpaceProposalFeatures < Rectify::Query
+        attr_reader :participatory_space
+
+        # Sugar syntax. Allow retrieving all proposal features for the
+        # given participatory space.
+        def self.for(participatory_space)
+          new(participatory_space).query
+        end
+
+        # Initializes the query
+        def initialize(participatory_space)
+          @participatory_space = participatory_space
+        end
+
+        def query
+          Feature
+            .where(participatory_space: participatory_space, manifest_name: "proposals")
+            .published
+        end
+      end
+    end
+  end
+end