decidim-assemblies 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 591047129445508418be028edb2f2504ed403d6a
+  data.tar.gz: 75821f7bde3542f291179dd1faaa37e617bb6822
+SHA512:
+  metadata.gz: a1ba81ca9013d9c3fee4c2d344a655a9747f26fad14f65d1a220360d57c73f889e0edd76da7b1fd32038aa8ff1e908de23bcb5827f4be0f46d97ec019eb1ea71
+  data.tar.gz: 6eca23d69ffc25424fc679a1942c2dc4f26f000792c10e59e3b7abc0926f89c21e4e7048946582f40d51bb03dde8a7a405ca2fdb2ded2660d089301b0a02f0be

data/README.md

@@ -0,0 +1,34 @@
+# Decidim::Assemblies
+
+Assemblies are the permanent Decidim's participatory space. They are always
+"active" so unlike participatory processes, they have no steps or phases.
+
+A assembly can get different features (such as meetings or proposals) attached.
+It can also have attachments, be associated to custom categories or scopes, and
+can be fully managed via an administration UI.
+
+## Usage
+
+This plugin provides:
+
+* A CRUD engine to manage assemblies.
+
+* Public views for assembly via a high level section in the main menu.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'decidim-assemblies'
+```
+
+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_assemblies_manifest.js

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

data/app/assets/config/decidim_assemblies_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../images/decidim/assemblies

data/app/assets/images/decidim/assemblies/assembly.svg

@@ -0,0 +1,6 @@
+<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)" />
+  <ellipse ry="5.504777" rx="5.5598245" cy="17.971844" cx="18" />
+  <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)" />
+  <path d="m 6.3078227,-25.154474 a 9.3338938,9.0435648 0 0 1 -8.7369752,9.025052 9.3338938,9.0435648 0 0 1 -9.8544645,-7.870717 9.3338938,9.0435648 0 0 1 7.4765554,-10.031744" transform="matrix(-0.78352169,0.62136443,-0.62136443,-0.78352169,0,0)" class="stroked-shape" />
+</svg>

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

@@ -0,0 +1,12 @@
+$(() => {
+  const $assemblyScopeEnabled = $('#assembly_scopes_enabled');
+  const $assemblyScopeId = $("#assembly_scope_id");
+
+  if ($('.edit_assembly, .new_assembly').length > 0) {
+    $assemblyScopeEnabled.on('change', (event) => {
+      const checked = event.target.checked;
+      $assemblyScopeId.attr("disabled", !checked);
+    })
+    $assemblyScopeId.attr("disabled", !$assemblyScopeEnabled.prop('checked'));
+  }
+});

data/app/commands/decidim/assemblies/admin/copy_assembly.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Assemblies
+    module Admin
+      # A command with all the business logic when copying a new participatory
+      # assembly in the system.
+      class CopyAssembly < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # form - A form object with the params.
+        # assembly - An assembly we want to duplicate
+        def initialize(form, assembly)
+          @form = form
+          @assembly = assembly
+        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?
+
+          Assembly.transaction do
+            copy_assembly
+            copy_assembly_categories if @form.copy_categories?
+            copy_assembly_features if @form.copy_features?
+          end
+
+          broadcast(:ok, @copied_assembly)
+        end
+
+        private
+
+        attr_reader :form
+
+        def copy_assembly
+          @copied_assembly = Assembly.create!(
+            organization: @assembly.organization,
+            title: form.title,
+            subtitle: @assembly.subtitle,
+            slug: form.slug,
+            hashtag: @assembly.hashtag,
+            description: @assembly.description,
+            short_description: @assembly.short_description,
+            hero_image: @assembly.hero_image,
+            banner_image: @assembly.banner_image,
+            promoted: @assembly.promoted,
+            scope: @assembly.scope,
+            developer_group: @assembly.developer_group,
+            local_area: @assembly.local_area,
+            target: @assembly.target,
+            participatory_scope: @assembly.participatory_scope,
+            participatory_structure: @assembly.participatory_structure,
+            meta_scope: @assembly.meta_scope
+          )
+        end
+
+        def copy_assembly_categories
+          @assembly.categories.each do |category|
+            Category.create!(
+              name: category.name,
+              description: category.description,
+              parent_id: category.parent_id,
+              participatory_space: @copied_assembly
+            )
+          end
+        end
+
+        def copy_assembly_features
+          @assembly.features.each do |feature|
+            new_feature = Feature.create!(
+              manifest_name: feature.manifest_name,
+              name: feature.name,
+              participatory_space: @copied_assembly,
+              settings: feature.settings,
+              step_settings: feature.step_settings
+            )
+            feature.manifest.run_hooks(:copy, new_feature: new_feature, old_feature: feature)
+          end
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/assemblies/admin/create_assembly.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Assemblies
+    module Admin
+      # A command with all the business logic when creating a new participatory
+      # assembly in the system.
+      class CreateAssembly < 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?
+          assembly = create_assembly
+
+          if assembly.persisted?
+            broadcast(:ok, assembly)
+          else
+            form.errors.add(:hero_image, assembly.errors[:hero_image]) if assembly.errors.include? :hero_image
+            form.errors.add(:banner_image, assembly.errors[:banner_image]) if assembly.errors.include? :banner_image
+            broadcast(:invalid)
+          end
+        end
+
+        private
+
+        attr_reader :form
+
+        def create_assembly
+          assembly = Assembly.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
+          )
+
+          return assembly unless assembly.valid?
+          assembly.save!
+          assembly
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/assemblies/admin/publish_assembly.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Assemblies
+    module Admin
+      # A command that sets an assembly as published.
+      class PublishAssembly < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # assembly - A Assembly that will be published
+        def initialize(assembly)
+          @assembly = assembly
+        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 assembly.nil? || assembly.published?
+
+          assembly.publish!
+          broadcast(:ok)
+        end
+
+        private
+
+        attr_reader :assembly
+      end
+    end
+  end
+end

data/app/commands/decidim/assemblies/admin/unpublish_assembly.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Assemblies
+    module Admin
+      # A command that sets an assembly as unpublished.
+      class UnpublishAssembly < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # assembly - A Assembly that will be unpublished
+        def initialize(assembly)
+          @assembly = assembly
+        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 assembly.nil? || !assembly.published?
+
+          assembly.unpublish!
+          broadcast(:ok)
+        end
+
+        private
+
+        attr_reader :assembly
+      end
+    end
+  end
+end

data/app/commands/decidim/assemblies/admin/update_assembly.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Assemblies
+    module Admin
+      # A command with all the business logic when creating a new participatory
+      # assembly in the system.
+      class UpdateAssembly < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # assembly - the Assembly to update
+        # form - A form object with the params.
+        def initialize(assembly, form)
+          @assembly = assembly
+          @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_assembly
+
+          if @assembly.valid?
+            broadcast(:ok, @assembly)
+          else
+            form.errors.add(:hero_image, @assembly.errors[:hero_image]) if @assembly.errors.include? :hero_image
+            form.errors.add(:banner_image, @assembly.errors[:banner_image]) if @assembly.errors.include? :banner_image
+            broadcast(:invalid)
+          end
+        end
+
+        private
+
+        attr_reader :form, :assembly
+
+        def update_assembly
+          @assembly.assign_attributes(attributes)
+          @assembly.save! if @assembly.valid?
+        end
+
+        def attributes
+          {
+            title: form.title,
+            subtitle: form.subtitle,
+            slug: form.slug,
+            hashtag: form.hashtag,
+            hero_image: form.hero_image,
+            remove_hero_image: form.remove_hero_image,
+            banner_image: form.banner_image,
+            remove_banner_image: form.remove_banner_image,
+            promoted: form.promoted,
+            description: form.description,
+            short_description: form.short_description,
+            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,
+            show_statistics: form.show_statistics
+          }
+        end
+      end
+    end
+  end
+end

data/app/constraints/decidim/assemblies/current_assembly.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Assemblies
+    # This class infers the current assembly we're scoped to by
+    # looking at the request parameters and the organization in the request
+    # environment, and injects it into the environment.
+    class CurrentAssembly
+      # Public: Matches the request against an assembly and injects it
+      #         into the environment.
+      #
+      # request - The request that holds the assembly relevant
+      #           information.
+      #
+      # Returns a true if the request matched, false otherwise
+      def matches?(request)
+        env = request.env
+
+        @organization = env["decidim.current_organization"]
+        return false unless @organization
+
+        current_assembly(env, request.params) ? true : false
+      end
+
+      private
+
+      def current_assembly(env, params)
+        env["decidim.current_participatory_space"] ||=
+          detect_current_assembly(params)
+      end
+
+      def detect_current_assembly(params)
+        OrganizationAssemblies.new(@organization).query.find_by_id(params["assembly_id"])
+      end
+    end
+  end
+end

data/app/constraints/decidim/assemblies/current_feature.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Assemblies
+    # This class infers the current feature on an assembly context
+    # request parameters and injects it into the environment.
+    class CurrentFeature
+      # Public: Initializes the class.
+      #
+      # manifest - The manifest of the feature to check against.
+      def initialize(manifest)
+        @manifest = manifest
+      end
+
+      # Public: Matches the request against a feature and injects it into the
+      #         environment.
+      #
+      # request - The request that holds the current feature relevant information.
+      #
+      # Returns a true if the request matches an assembly and a
+      # feature belonging to that assembly, false otherwise
+      def matches?(request)
+        CurrentAssembly.new.matches?(request) &&
+          Decidim::CurrentFeature.new(@manifest).matches?(request)
+      end
+    end
+  end
+end