decidim-sortitions 0.9.0

data/README.md

@@ -0,0 +1,31 @@
+# Decidim::Sortitions
+This module makes possible to select amont a set of proposal by sortition.
+
+## Usage
+Simply include it in your Decidim instance.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'decidim-sortitions'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install decidim-sortitions
+```
+
+## Import migrations
+
+After installing the gem you must import and execute the migrations bundled with the gem:
+
+```bash
+$ bundle exec rails decidim_sortitions:install:migrations
+$ bundle exec rails db:migrate
+```

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "decidim/dev/common_rake"

data/app/assets/config/decidim_sortitions_manifest.css

@@ -0,0 +1 @@
+/*= link decidim/sortitions/social_share.css.scss */

data/app/assets/config/decidim_sortitions_manifest.js

@@ -0,0 +1 @@
+//= link decidim/sortitions/social_share.js

data/app/assets/images/decidim/sortitions/icon.svg

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" version="1.1" width="8" height="8" data-icon="aperture" viewBox="0 0 8 8">
+  <path d="M4 0c-.69 0-1.336.19-1.906.5l3.219 2.344.719-2.25c-.59-.36-1.281-.594-2.031-.594zm-2.75 1.125c-.76.73-1.25 1.735-1.25 2.875 0 .25.022.489.063.719l3.094-2.219-1.906-1.375zm5.625.125l-1.219 3.75h2.219c.08-.32.125-.65.125-1 0-1.07-.435-2.03-1.125-2.75zm-4.719 3.188l-1.75 1.281c.55 1.13 1.595 1.989 2.875 2.219l-1.125-3.5zm1.563 1.563l.625 1.969c1.33-.11 2.454-.879 3.094-1.969h-3.719z"
+  />
+</svg>

data/app/assets/javascripts/decidim/sortitions/admin/sortitions.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/javascripts/decidim/sortitions/social_share.js

@@ -0,0 +1,2 @@
+// = require social-share-button
+// = require_self

data/app/assets/stylesheets/decidim/sortitions/_sortitions.scss

@@ -0,0 +1,45 @@
+#sortition-details {
+  margin-bottom: 1.5rem;
+}
+
+.sortition-details {
+  padding: 0;
+  display: flex;
+  flex-direction: row;
+  flex-wrap: wrap;
+  justify-content: flex-start;
+  align-items: stretch;
+  align-content: stretch;
+
+  .sortition-details-item {
+    width: 33.3%;
+    @include breakpoint(large down){
+      width: 33.3%;
+    }
+    @include breakpoint(medium down){
+      width: 49.9%;
+    }
+    @include breakpoint(smallmedium down){
+      width: 100%;
+    }
+    display: inline-block;
+    padding: 1em;
+    border: $border;
+    background: $white;
+    .sortition-details-title {
+      margin-right: 0.5rem;
+      font-weight: bolder;
+    }
+
+    .sortition-details-text{
+      text-transform: uppercase;
+      letter-spacing: 0.03em;
+      font-size: 90%;
+      color: #3D393C;
+      font-weight: 600;
+      line-height: 1;
+      vertical-align: middle;
+      height: 1.5em;
+    }
+  }
+}

data/app/assets/stylesheets/decidim/sortitions/social_share.css.scss

@@ -0,0 +1,18 @@
+/*= require social-share-button */
+$size: 45px;
+
+.share-link:hover {
+  text-decoration: underline;
+  cursor: pointer;
+}
+
+.social-share-button {
+  display: inline-block;
+  vertical-align: top;
+  .ssb-icon {
+    margin-right: 5px;
+    background-size: $size $size;
+    height: $size;
+    width: $size;
+  }
+}

data/app/commands/decidim/sortitions/admin/create_sortition.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Sortitions
+    module Admin
+      # Command that creates a sortition that selects proposals
+      class CreateSortition < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # form - A form object with the params.
+        def initialize(form)
+          @form = form
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if the form wasn't valid and we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          ActiveRecord::Base.transaction do
+            sortition = create_sortition
+            categorize(sortition) if form.decidim_category_id.present?
+            select_proposals_for(sortition)
+            send_notification(sortition)
+
+            broadcast(:ok, sortition)
+          end
+        end
+
+        private
+
+        attr_reader :form
+
+        def create_sortition
+          Sortition.create!(
+            feature: form.current_feature,
+            title: form.title,
+            decidim_proposals_feature_id: form.decidim_proposals_feature_id,
+            request_timestamp: Time.now.utc,
+            author: form.current_user,
+            dice: form.dice,
+            target_items: form.target_items,
+            witnesses: form.witnesses,
+            additional_info: form.additional_info,
+            selected_proposals: [],
+            candidate_proposals: []
+          )
+        end
+
+        def categorize(sortition)
+          Decidim::Categorization.create!(
+            decidim_category_id: form.decidim_category_id,
+            categorizable: sortition
+          )
+        end
+
+        def select_proposals_for(sortition)
+          draw = Draw.new(sortition)
+
+          sortition.update(
+            selected_proposals: draw.results,
+            candidate_proposals: draw.proposals.pluck(:id)
+          )
+        end
+
+        def send_notification(sortition)
+          Decidim::EventsManager.publish(
+            event: "decidim.events.sortitions.sortition_created",
+            event_class: Decidim::Sortitions::CreateSortitionEvent,
+            resource: sortition,
+            recipient_ids: sortition.participatory_space.followers.pluck(:id)
+          )
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/sortitions/admin/destroy_sortition.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Sortitions
+    module Admin
+      # Command that cancels a sortition
+      class DestroySortition < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # form - A form object with the params.
+        def initialize(form)
+          @form = form
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if the form wasn't valid and we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) if form.invalid?
+          destroy_sortition
+          broadcast(:ok, sortition)
+        end
+
+        private
+
+        attr_reader :form
+
+        def destroy_sortition
+          sortition.update(
+            cancel_reason: form.cancel_reason,
+            cancelled_on: Time.now.utc,
+            cancelled_by_user: form.current_user
+          )
+        end
+
+        def sortition
+          @sortition ||= Sortition.find(form.id)
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/sortitions/admin/update_sortition.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Sortitions
+    module Admin
+      # Command that creates a sortition that selects proposals
+      class UpdateSortition < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # form - A form object with the params.
+        def initialize(form)
+          @form = form
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if the form wasn't valid and we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          update_sortition
+          broadcast(:ok, sortition)
+        end
+
+        private
+
+        attr_reader :form
+
+        def update_sortition
+          sortition.update(
+            title: form.title,
+            additional_info: form.additional_info
+          )
+        end
+
+        def sortition
+          @sortition ||= Sortition.find(form.id)
+        end
+      end
+    end
+  end
+end

data/app/controllers/concerns/decidim/sortitions/orderable.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  module Sortitions
+    # Common logic to ordering resources
+    module Orderable
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :order, :available_orders, :random_seed
+
+        private
+
+        # Gets how the proposals should be ordered based on the choice made by the user.
+        def order
+          @order ||= detect_order(params[:order]) || default_order
+        end
+
+        # Available orders based on enabled settings
+        def available_orders
+          %w(random recent)
+        end
+
+        def default_order
+          "recent"
+        end
+
+        # Returns: A random float number between -1 and 1 to be used as a random seed at the database.
+        def random_seed
+          @random_seed ||= (params[:random_seed] ? params[:random_seed].to_f : (rand * 2 - 1))
+        end
+
+        def detect_order(candidate)
+          available_orders.detect { |order| order == candidate }
+        end
+
+        def reorder(sortitions)
+          case order
+          when "random"
+            sortitions.order_randomly(random_seed)
+          when "recent"
+            sortitions.order(created_at: :desc)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Sortitions
+    module Admin
+      # 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::Admin::Features::BaseController
+        helper_method :sortitions, :sortition
+
+        def sortitions
+          @sortitions ||= Decidim::Sortitions::FilteredSortitions
+                          .for(current_feature)
+                          .order(created_at: :desc)
+                          .page(params[:page])
+                          .per(Decidim::Sortitions.items_per_page)
+        end
+
+        def sortition
+          @sortition ||= sortitions.find(params[:id])
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Sortitions
+    module Admin
+      # Controller responsible of the sortition that selects proposals from
+      # a participatory space.
+      class SortitionsController < Admin::ApplicationController
+        helper_method :proposal_features
+
+        def index; end
+
+        def show
+          authorize! :show, sortition
+        end
+
+        def edit
+          authorize! :update, sortition
+          @form = edit_sortition_form.from_model(sortition, current_participatory_space: current_participatory_space)
+        end
+
+        def update
+          authorize! :update, sortition
+          @form = edit_sortition_form.from_params(params, current_participatory_space: current_participatory_space)
+          UpdateSortition.call(@form) do
+            on(:ok) do |_sortition|
+              flash[:notice] = I18n.t("sortitions.update.success", scope: "decidim.sortitions.admin")
+              redirect_to action: :index
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("sortitions.update.error", scope: "decidim.sortitions.admin")
+              render :edit
+            end
+          end
+        end
+
+        def new
+          authorize! :create, Sortition
+          @form = sortition_form.instance(current_participatory_space: current_participatory_space)
+        end
+
+        def create
+          authorize! :create, Sortition
+          @form = sortition_form.from_params(params, current_participatory_space: current_participatory_space)
+          CreateSortition.call(@form) do
+            on(:ok) do |sortition|
+              flash[:notice] = I18n.t("sortitions.create.success", scope: "decidim.sortitions.admin")
+              redirect_to action: :show, id: sortition.id
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("sortitions.create.error", scope: "decidim.sortitions.admin")
+              render :new
+            end
+          end
+        end
+
+        def confirm_destroy
+          authorize! :destroy, sortition
+          @form = destroy_sortition_form.from_model(sortition, current_participatory_space: current_participatory_space)
+        end
+
+        def destroy
+          authorize! :destroy, sortition
+          @form = destroy_sortition_form.from_params(params, current_participatory_space: current_participatory_space)
+          DestroySortition.call(@form) do
+            on(:ok) do |_sortition|
+              flash[:notice] = I18n.t("sortitions.destroy.success", scope: "decidim.sortitions.admin")
+              redirect_to action: :index
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("sortitions.destroy.error", scope: "decidim.sortitions.admin")
+              render :confirm_destroy
+            end
+          end
+        end
+
+        private
+
+        def sortition_form
+          form(SortitionForm)
+        end
+
+        def edit_sortition_form
+          form(EditSortitionForm)
+        end
+
+        def destroy_sortition_form
+          form(DestroySortitionForm)
+        end
+
+        def proposal_features
+          ParticipatorySpaceProposalFeatures.for(current_participatory_space)
+        end
+
+        def ability_context
+          super.merge(current_participatory_space: current_participatory_space)
+        end
+      end
+    end
+  end
+end