decidim-participatory_processes 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9ed5778305ec15d3856385d206b64cb0ddf00d48
+  data.tar.gz: 84b18b608fff22066df3d690ee87e0635e85d46d
+SHA512:
+  metadata.gz: 043f3e5ad638d4340701af8047f7fd2fd89e1183b3ccda119c3e41a37a921fd047beadf089640c9546e9118d94c336d4fe44ac1e16f202f9dc393c1dabdb3737
+  data.tar.gz: c0ab2b56c3515fefa73af22f4ba57ca82624307a7b4b972198061c6541f84ad836dff98bb231903220b8735f15aec2c5a18f8e44b5ed180a326baa6deeaccf84

data/README.md

@@ -0,0 +1,36 @@
+# Decidim::ParticipatoryProcesses
+
+Participatory processes are the standard Decidim's participatory space.
+
+A participatory process can define its own steps, and attach different features
+(such as meetings or proposals) with different configurations to each of them.
+
+A participatory process can have attachments, be associated to custom
+categories, and are fully manageable via an administration UI.
+
+## Usage
+
+This plugin provides:
+
+* A CRUD engine to manage participatory processes.
+
+* Public views for participatory process via a high level section in the main
+  menu.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'decidim-participatory_processes'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Contributing
+See [Decidim](https://github.com/decidim/decidim).
+
+## License
+See [Decidim](https://github.com/decidim/decidim).

data/Rakefile

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

data/app/assets/config/admin/decidim_participatory_processes_manifest.js

@@ -0,0 +1 @@
+//= link decidim/participatory_processes/admin/participatory_processes.js

data/app/assets/config/decidim_participatory_processes_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../images/decidim/participatory_processes
+//= link decidim/participatory_processes/filters.js

data/app/assets/images/decidim/participatory_processes/process.svg

@@ -0,0 +1,10 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 36.02 36.02">
+  <path d="M883.8,543.84a18,18,0,1,1,18-18A18,18,0,0,1,883.8,543.84Zm0-34a16,16,0,1,0,16,16A16,16,0,0,0,883.8,509.83Z" transform="translate(-865.8 -507.83)"/>
+  <g transform="rotate(60 18.1 18.1)">
+    <path d="M883.8,528.75a2.91,2.91,0,1,1,2.91-2.91A2.92,2.92,0,0,1,883.8,528.75Zm0-3.83a0.91,0.91,0,1,0,.91.92A0.92,0.92,0,0,0,883.8,524.92Z" transform="translate(-865.8 -507.83)"/>
+    <path d="M883.8,521.18a2.91,2.91,0,1,1,2.91-2.91A2.92,2.92,0,0,1,883.8,521.18Zm0-3.83a0.91,0.91,0,1,0,.91.92A0.92,0.92,0,0,0,883.8,517.35Z" transform="translate(-865.8 -507.83)"/>
+    <path d="M883.8,536.32a2.92,2.92,0,1,1,2.91-2.91A2.92,2.92,0,0,1,883.8,536.32Zm0-3.83a0.92,0.92,0,1,0,.91.92A0.92,0.92,0,0,0,883.8,532.49Z" transform="translate(-865.8 -507.83)"/>
+    <path d="M881.52,526.85a4.79,4.79,0,1,1,0-9.59,1,1,0,0,1,0,2,2.79,2.79,0,1,0,0,5.59A1,1,0,0,1,881.52,526.85Z" transform="translate(-865.8 -507.83)"/>
+    <path d="M886.09,534.47a1,1,0,0,1,0-2,2.79,2.79,0,0,0,0-5.59,1,1,0,0,1,0-2A4.79,4.79,0,0,1,886.09,534.47Z" transform="translate(-865.8 -507.83)"/>
+  </g>
+</svg>

data/app/assets/javascripts/decidim/participatory_processes/admin/participatory_processes.js.es6

@@ -0,0 +1,12 @@
+$(() => {
+  const $participatoryProcessScopeEnabled = $('#participatory_process_scopes_enabled');
+  const $participatoryProcessScopeId = $("#participatory_process_scope_id");
+
+  if ($('.edit_participatory_process, .new_participatory_process').length > 0) {
+    $participatoryProcessScopeEnabled.on('change', (event) => {
+      const checked = event.target.checked;
+      $participatoryProcessScopeId.attr("disabled", !checked);
+    })
+    $participatoryProcessScopeId.attr("disabled", !$participatoryProcessScopeEnabled.prop('checked'));
+  }
+});

data/app/assets/javascripts/decidim/participatory_processes/filters.js.es6

@@ -0,0 +1,25 @@
+$(() => {
+  ((exports) => {
+    const $processesGrid = $('#processes-grid');
+    const $loading = $processesGrid.find('.loading');
+    const filterLinksSelector = '.order-by__tabs a'
+
+    $loading.hide();
+
+    $processesGrid.on('click', filterLinksSelector, (event) => {
+      const $target = $(event.target);
+      const $processesGridCards = $processesGrid.find('.card-grid .column');
+
+      $(filterLinksSelector).removeClass('is-active');
+      $target.addClass('is-active');
+
+      $processesGridCards.hide();
+      $loading.show();
+
+      if (exports.history) {
+        exports.history.pushState(null, null, $target.attr('href'));
+      }
+    });
+  })(window);
+
+});

data/app/commands/decidim/participatory_processes/admin/activate_participatory_process_step.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryProcesses
+    module Admin
+      # A command that sets a step in a participatory process as active (and
+      # unsets a previous active step)
+      class ActivateParticipatoryProcessStep < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # step - A ParticipatoryProcessStep that will be activated
+        def initialize(step)
+          @step = step
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if the data wasn't valid and we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) if step.nil? || step.active?
+
+          Decidim::ParticipatoryProcessStep.transaction do
+            deactivate_active_steps
+            activate_step
+          end
+          broadcast(:ok)
+        end
+
+        private
+
+        attr_reader :step
+
+        def deactivate_active_steps
+          step.participatory_process.steps.where(active: true).update_all(active: false)
+        end
+
+        def activate_step
+          step.update_attribute(:active, true)
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/participatory_processes/admin/copy_participatory_process.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryProcesses
+    module Admin
+      # A command with all the business logic when copying a new participatory
+      # process in the system.
+      class CopyParticipatoryProcess < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # form - A form object with the params.
+        # participatory_process - A participatory_process we want to duplicate
+        def initialize(form, participatory_process)
+          @form = form
+          @participatory_process = participatory_process
+        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?
+
+          ParticipatoryProcess.transaction do
+            copy_participatory_process
+            copy_participatory_process_steps if @form.copy_steps?
+            copy_participatory_process_categories if @form.copy_categories?
+            copy_participatory_process_features if @form.copy_features?
+          end
+
+          broadcast(:ok, @copied_process)
+        end
+
+        private
+
+        attr_reader :form
+
+        def copy_participatory_process
+          @copied_process = ParticipatoryProcess.create!(
+            organization: @participatory_process.organization,
+            title: form.title,
+            subtitle: @participatory_process.subtitle,
+            slug: form.slug,
+            hashtag: @participatory_process.hashtag,
+            description: @participatory_process.description,
+            short_description: @participatory_process.short_description,
+            hero_image: @participatory_process.hero_image,
+            banner_image: @participatory_process.banner_image,
+            promoted: @participatory_process.promoted,
+            scope: @participatory_process.scope,
+            developer_group: @participatory_process.developer_group,
+            local_area: @participatory_process.local_area,
+            target: @participatory_process.target,
+            participatory_scope: @participatory_process.participatory_scope,
+            participatory_structure: @participatory_process.participatory_structure,
+            meta_scope: @participatory_process.meta_scope,
+            start_date: @participatory_process.start_date,
+            end_date: @participatory_process.end_date,
+            participatory_process_group: @participatory_process.participatory_process_group
+          )
+        end
+
+        def copy_participatory_process_steps
+          @steps_relationship = {}
+
+          @participatory_process.steps.each do |step|
+            new_step = ParticipatoryProcessStep.create!(
+              title: step.title,
+              description: step.description,
+              start_date: step.start_date,
+              end_date: step.end_date,
+              participatory_process: @copied_process,
+              position: step.position,
+              active: step.active
+            )
+            @steps_relationship[step.id.to_s] = new_step.id.to_s
+          end
+        end
+
+        def copy_participatory_process_categories
+          @participatory_process.categories.each do |category|
+            Category.create!(
+              name: category.name,
+              description: category.description,
+              parent_id: category.parent_id,
+              participatory_space: @copied_process
+            )
+          end
+        end
+
+        def copy_participatory_process_features
+          @participatory_process.features.each do |feature|
+            copied_step_settings = @form.copy_steps? ? map_step_settings(feature.step_settings) : {}
+            new_feature = Feature.create!(
+              manifest_name: feature.manifest_name,
+              name: feature.name,
+              participatory_space: @copied_process,
+              settings: feature.settings,
+              step_settings: copied_step_settings
+            )
+            feature.manifest.run_hooks(:copy, new_feature: new_feature, old_feature: feature)
+          end
+        end
+
+        def map_step_settings(step_settings)
+          step_settings.each_with_object({}) do |(step_id, settings), acc|
+            acc.update(@steps_relationship[step_id.to_s] => settings)
+          end
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/participatory_processes/admin/create_participatory_process.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryProcesses
+    module Admin
+      # A command with all the business logic when creating a new participatory
+      # process in the system.
+      class CreateParticipatoryProcess < 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?
+          process = create_participatory_process
+
+          if process.persisted?
+            broadcast(:ok, process)
+          else
+            form.errors.add(:hero_image, process.errors[:hero_image]) if process.errors.include? :hero_image
+            form.errors.add(:banner_image, process.errors[:banner_image]) if process.errors.include? :banner_image
+            broadcast(:invalid)
+          end
+        end
+
+        private
+
+        attr_reader :form
+
+        def create_participatory_process
+          process = ParticipatoryProcess.new(
+            organization: form.current_organization,
+            title: form.title,
+            subtitle: form.subtitle,
+            slug: form.slug,
+            hashtag: form.hashtag,
+            description: form.description,
+            short_description: form.short_description,
+            hero_image: form.hero_image,
+            banner_image: form.banner_image,
+            promoted: form.promoted,
+            scopes_enabled: form.scopes_enabled,
+            scope: form.scope,
+            developer_group: form.developer_group,
+            local_area: form.local_area,
+            target: form.target,
+            participatory_scope: form.participatory_scope,
+            participatory_structure: form.participatory_structure,
+            meta_scope: form.meta_scope,
+            start_date: form.start_date,
+            end_date: form.end_date,
+            participatory_process_group: form.participatory_process_group
+          )
+
+          return process unless process.valid?
+          transaction do
+            process.save!
+
+            process.steps.create!(
+              title: TranslationsHelper.multi_translation(
+                "decidim.admin.participatory_process_steps.default_title",
+                form.current_organization.available_locales
+              ),
+              active: true
+            )
+
+            process
+          end
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/participatory_processes/admin/create_participatory_process_admin.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryProcesses
+    module Admin
+      # A command with all the business logic when creating a new participatory
+      # process admin in the system.
+      class CreateParticipatoryProcessAdmin < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # form - A form object with the params.
+        # participatory_process - The ParticipatoryProcess that will hold the
+        #   user role
+        def initialize(form, current_user, participatory_process)
+          @form = form
+          @current_user = current_user
+          @participatory_process = participatory_process
+        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
+            create_or_invite_user
+            create_role
+          end
+
+          broadcast(:ok)
+        rescue ActiveRecord::RecordInvalid
+          form.errors.add(:email, :taken)
+          broadcast(:invalid)
+        end
+
+        private
+
+        attr_reader :form, :participatory_process, :current_user, :user
+
+        def create_role
+          Decidim::ParticipatoryProcessUserRole.find_or_create_by!(
+            role: form.role.to_sym,
+            user: user,
+            participatory_process: @participatory_process
+          )
+        end
+
+        def create_or_invite_user
+          @user ||= existing_user || new_user
+        end
+
+        def existing_user
+          return @existing_user if defined?(@existing_user)
+
+          @existing_user = User.where(
+            email: form.email,
+            organization: participatory_process.organization
+          ).first
+
+          if @existing_user && !@existing_user.invitation_accepted?
+            InviteUserAgain.call(@existing_user, invitation_instructions)
+          end
+
+          @existing_user
+        end
+
+        def new_user
+          @new_user ||= InviteUser.call(user_form) do
+            on(:ok) do |user|
+              return user
+            end
+          end
+        end
+
+        def user_form
+          OpenStruct.new(name: form.name,
+                         email: form.email.downcase,
+                         organization: participatory_process.organization,
+                         admin: false,
+                         invited_by: current_user,
+                         invitation_instructions: invitation_instructions)
+        end
+
+        def invitation_instructions
+          return "invite_admin" if form.role == "admin"
+          "invite_collaborator"
+        end
+      end
+    end
+  end
+end