decidim-admin 0.28.3 → 0.29.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b4c55445cbf1d61f5aabef092569d33d79906e1de58106cab2d0650cf4046b5
-  data.tar.gz: 508c3c95f08c68df503df0b9bd9bb752a9d8c999f048421133da80190a876add
+  metadata.gz: f2203fd3c924ab306246e912329cdaac02091b61e4e8d2db4027ff44705b8032
+  data.tar.gz: 6119bde10948eca047d065a5030536b2c7ac720062f2ff0f81862b6f07b5c384
 SHA512:
-  metadata.gz: 5cfe3db6149075c9308985f333d7f9cbd03e7f6878f34545c40c67c40378466e105ec82fe960c1a1625d75f1b8a31870aedc17647d7e7c72677c2cc424f1bd76
-  data.tar.gz: 4bd3495d6613ee0619dba4825ad378eba623983bb1f7074649039ab4a7381f07edc4bb6c641722779c8ac57d7057421145049c7a7574ce1b430a1b4f88c5606d
+  metadata.gz: 981be4fdb86e6aa0eed5d5d51f3df7d7fff0fd317646247a06e14de255d4d5235ca2cc70d87705ce061ca35178c3ead74d6555df004e6cd5349c27d273d656e8
+  data.tar.gz: 586c39385d2a7b2bc6fe356c9405b6b426b39f30c5afe457cab495d905f177829a3c7ebca332ee51e08b1cd5a6ede59cc00b1c160922ea9b9322d964acc9cde5

data/README.md

@@ -42,6 +42,19 @@ There are some pages that exist by default and cannot be deleted since there
 are links to them inside the Decidim framework, see `Decidim::StaticPage` for
 the default list.
 
+### Pager Configuration
+
+The number of results shown per page and per page range can be configured in the app `decidim.rb` initializer as follows:
+
+```ruby
+Decidim::Admin.configure do |config|
+  config.per_page_range = [15, 50, 100]
+end
+```
+
+* `Decidim::Admin.per_page_range.first` sets the `default_per_page` value for `Decidim::Admin` (in Kaminari)
+* `Decidim::Admin.per_page_range.last` sets the `max_per_page`  value for `Decidim::Admin` (in Kaminari)
+
 ## Contributing
 
 See [Decidim](https://github.com/decidim/decidim).

data/app/cells/decidim/admin/content_block_cell.rb

@@ -3,7 +3,6 @@
 module Decidim
   module Admin
     class ContentBlockCell < Decidim::ViewModel
-      include Decidim::IconHelper
       include Decidim::ContentBlocks::HasRelatedComponents
 
       delegate :public_name_key, :has_settings?, :component_manifest_name, to: :model

data/app/cells/decidim/admin/results_per_page/show.erb

@@ -1,5 +1,5 @@
-<span class="dropdown-menu-inverted_label"><%= t("decidim.admin.actions.per_page") %> :</span>
-<ul class="results-per-page__dropdown dropdown menu dropdown-inverted" data-dropdown-menu data-close-on-click-inside="false">
+<span><%= t("decidim.admin.actions.per_page") %> :</span>
+<ul class="dropdown menu" data-dropdown-menu data-close-on-click-inside="false">
   <li class="is-dropdown-submenu-parent">
     <a title="<%= %(#{per_page} #{t("decidim.admin.actions.per_page")}) %>">
       <%= per_page %>

data/app/cells/decidim/admin/results_per_page_cell.rb

@@ -4,8 +4,6 @@ module Decidim
   module Admin
     class ResultsPerPageCell < Decidim::ViewModel
       property :per_page, :per_page_range
-      delegate :params, to: :controller, prefix: false
-
       def path_for_num_per_page(num_per_page = per_page_range.first)
         controller.url_for(params.to_unsafe_h.merge(per_page: num_per_page))
       end

data/app/commands/decidim/admin/create_area.rb

@@ -3,40 +3,12 @@
 module Decidim
   module Admin
     # A command with all the business logic when creating an area
-    class CreateArea < Decidim::Command
-      # Public: Initializes the command.
-      #
-      # form - A form object with the params.
-      def initialize(form)
-        @form = form
-      end
+    class CreateArea < Decidim::Commands::CreateResource
+      fetch_form_attributes :name, :organization, :area_type
 
-      # Executes the command. Broadcasts these events:
-      #
-      # - :ok when everything is valid.
-      # - :invalid if the form was not valid and we could not proceed.
-      #
-      # Returns nothing.
-      def call
-        return broadcast(:invalid) if form.invalid?
+      protected
 
-        create_area
-        broadcast(:ok)
-      end
-
-      private
-
-      attr_reader :form
-
-      def create_area
-        Decidim.traceability.create!(
-          Area,
-          form.current_user,
-          name: form.name,
-          organization: form.organization,
-          area_type: form.area_type
-        )
-      end
+      def resource_class = Decidim::Area
     end
   end
 end

data/app/commands/decidim/admin/create_area_type.rb

@@ -3,41 +3,12 @@
 module Decidim
   module Admin
     # A command with all the business logic when creating an area type.
-    class CreateAreaType < Decidim::Command
-      # Public: Initializes the command.
-      #
-      # form - A form object with the params.
-      def initialize(form, user)
-        @form = form
-        @user = user
-      end
+    class CreateAreaType < Decidim::Commands::CreateResource
+      fetch_form_attributes :name, :organization, :plural
 
-      # Executes the command. Broadcasts these events:
-      #
-      # - :ok when everything is valid.
-      # - :invalid if the form was not valid and we could not proceed.
-      #
-      # Returns nothing.
-      def call
-        return broadcast(:invalid) if form.invalid?
+      protected
 
-        create_area_type
-        broadcast(:ok)
-      end
-
-      private
-
-      attr_reader :form
-
-      def create_area_type
-        Decidim.traceability.create!(
-          AreaType,
-          @user,
-          name: form.name,
-          organization: form.organization,
-          plural: form.plural
-        )
-      end
+      def resource_class = Decidim::AreaType
     end
   end
 end

data/app/commands/decidim/admin/create_attachment.rb

@@ -5,14 +5,14 @@ module Decidim
     # A command with all the business logic to add an attachment to a
     # participatory process.
     class CreateAttachment < Decidim::Command
+      delegate :current_user, to: :form
       # Public: Initializes the command.
       #
       # form - A form object with the params.
       # attached_to - The ActiveRecord::Base that will hold the attachment
-      def initialize(form, attached_to, user)
+      def initialize(form, attached_to)
         @form = form
         @attached_to = attached_to
-        @user = user
       end
 
       # Executes the command. Broadcasts these events:
@@ -27,7 +27,7 @@ module Decidim
         build_attachment
 
         if @attachment.valid?
-          Decidim.traceability.perform_action!(:create, Decidim::Attachment, @user) do
+          Decidim.traceability.perform_action!(:create, Decidim::Attachment, current_user) do
             @attachment.save!
             notify_followers
             broadcast(:ok)
@@ -51,7 +51,8 @@ module Decidim
           weight: form.weight,
           attachment_collection: form.attachment_collection,
           file: form.file, # Define attached_to before this
-          content_type: blob(form.file).content_type
+          content_type: form.file && blob(form.file).content_type,
+          link: form.file ? nil : form.link
         )
       end
 

data/app/commands/decidim/admin/create_attachment_collection.rb

@@ -5,14 +5,14 @@ module Decidim
     # A command with all the business logic to add an attachment collection
     # to a participatory space.
     class CreateAttachmentCollection < Decidim::Command
+      delegate :current_user, to: :form
       # Public: Initializes the command.
       #
       # form - A form object with the params.
       # collection_for - The ActiveRecord::Base that will hold the collection
-      def initialize(form, collection_for, user)
+      def initialize(form, collection_for)
         @form = form
         @collection_for = collection_for
-        @user = user
       end
 
       # Executes the command. Broadcasts these events:
@@ -35,7 +35,7 @@ module Decidim
       def create_attachment_collection
         Decidim.traceability.create!(
           AttachmentCollection,
-          @user,
+          current_user,
           attributes
         )
       end

data/app/commands/decidim/admin/create_category.rb

@@ -4,45 +4,12 @@ module Decidim
   module Admin
     # A command with all the business logic to create a new category in the
     # system.
-    class CreateCategory < Decidim::Command
-      # Public: Initializes the command.
-      #
-      # form - A form object with the params.
-      # participatory_space - The participatory space that will hold the
-      #   category
-      def initialize(form, participatory_space, user)
-        @form = form
-        @participatory_space = participatory_space
-        @user = user
-      end
+    class CreateCategory < Decidim::Commands::CreateResource
+      fetch_form_attributes :name, :weight, :parent_id, :participatory_space
 
-      # Executes the command. Broadcasts these events:
-      #
-      # - :ok when everything is valid.
-      # - :invalid if the form was not valid and we could not proceed.
-      #
-      # Returns nothing.
-      def call
-        return broadcast(:invalid) if form.invalid?
+      protected
 
-        create_category
-        broadcast(:ok)
-      end
-
-      private
-
-      attr_reader :form
-
-      def create_category
-        Decidim.traceability.create!(
-          Category,
-          @user,
-          name: form.name,
-          weight: form.weight,
-          parent_id: form.parent_id,
-          participatory_space: @participatory_space
-        )
-      end
+      def resource_class = Decidim::Category
     end
   end
 end

data/app/commands/decidim/admin/create_component.rb

@@ -3,50 +3,17 @@
 module Decidim
   module Admin
     # This command gets called when a component is created from the admin panel.
-    class CreateComponent < Decidim::Command
-      attr_reader :form, :manifest, :participatory_space
-
-      # Public: Initializes the command.
-      #
-      # form - The form from which the data in this component comes from.
-      def initialize(form)
-        @form = form
-        @manifest = form.manifest
-      end
-
-      # Public: Creates the Component.
-      #
-      # Broadcasts :ok if created, :invalid otherwise.
-      def call
-        return broadcast(:invalid) if form.invalid?
-
-        transaction do
-          create_component
-          run_hooks
-        end
-
-        broadcast(:ok)
-      end
+    class CreateComponent < Decidim::Commands::CreateResource
+      fetch_form_attributes :name, :participatory_space, :weight, :settings, :default_step_settings, :step_settings
 
       private
 
-      def create_component
-        @component = Decidim.traceability.create!(
-          Component,
-          form.current_user,
-          manifest_name: manifest.name,
-          name: form.name,
-          participatory_space: form.participatory_space,
-          weight: form.weight,
-          settings: form.settings,
-          default_step_settings: form.default_step_settings,
-          step_settings: form.step_settings
-        )
-      end
+      # Use `reverse_merge` instead of `merge` as we need the `manifest_name` first
+      def attributes = super.reverse_merge({ manifest_name: form.manifest.name })
+
+      def resource_class = Decidim::Component
 
-      def run_hooks
-        manifest.run_hooks(:create, @component)
-      end
+      def run_after_hooks = form.manifest.run_hooks(:create, resource)
     end
   end
 end

data/app/commands/decidim/admin/create_newsletter.rb

@@ -4,48 +4,30 @@ module Decidim
   module Admin
     # Creates a newsletter and assigns the right author and
     # organization.
-    class CreateNewsletter < Decidim::Command
+    class CreateNewsletter < Decidim::Commands::CreateResource
+      fetch_form_attributes :subject, :organization
       # Initializes the command.
       #
       # form - The source fo data for this newsletter.
       # content_block - An instance of `Decidim::ContentBlock` that holds the
       #     newsletter attributes.
-      # user - The User that authored this newsletter.
-      def initialize(form, content_block, user)
-        @form = form
+      def initialize(form, content_block)
+        super(form)
         @content_block = content_block
-        @user = user
-      end
-
-      def call
-        return broadcast(:invalid) unless form.valid?
-
-        transaction do
-          create_newsletter
-          create_content_block
-        end
-
-        broadcast(:ok, newsletter)
       end
 
       private
 
-      attr_reader :user, :form, :newsletter, :content_block
+      attr_reader :content_block
 
-      def create_newsletter
-        @newsletter = Decidim.traceability.create!(
-          Newsletter,
-          user,
-          subject: form.subject,
-          author: user,
-          organization: user.organization
-        )
-      end
+      def resource_class = Decidim::Newsletter
+
+      def attributes = super.merge({ author: form.current_user })
 
-      def create_content_block
-        ContentBlocks::UpdateContentBlock.call(form, content_block, user) do
+      def run_after_hooks
+        ContentBlocks::UpdateContentBlock.call(form, content_block, form.current_user) do
           on(:ok) do |content_block|
-            content_block.update(scoped_resource_id: newsletter.id)
+            content_block.update(scoped_resource_id: resource.id)
             @content_block = content_block
           end
           on(:invalid) do

data/app/commands/decidim/admin/create_participatory_space_private_user.rb

@@ -5,14 +5,14 @@ module Decidim
     # A command with all the business logic when creating a new participatory space
     # private user in the system.
     class CreateParticipatorySpacePrivateUser < Decidim::Command
+      delegate :current_user, to: :form
       # Public: Initializes the command.
       #
       # form - A form object with the params.
       # private_user_to - The private_user_to that will hold the
       #   user role
-      def initialize(form, current_user, private_user_to, via_csv: false)
+      def initialize(form, private_user_to, via_csv: false)
         @form = form
-        @current_user = current_user
         @private_user_to = private_user_to
         @via_csv = via_csv
       end
@@ -39,7 +39,7 @@ module Decidim
 
       private
 
-      attr_reader :form, :private_user_to, :current_user, :user
+      attr_reader :form, :private_user_to, :user
 
       def create_private_user
         action = @via_csv ? "create_via_csv" : "create"

data/app/commands/decidim/admin/create_scope.rb

@@ -2,50 +2,33 @@
 
 module Decidim
   module Admin
-    # A command with all the business logic when creating a static scope.
-    class CreateScope < Decidim::Command
+    # A command with all the business logic when creating a scope.
+    class CreateScope < Decidim::Commands::CreateResource
+      fetch_form_attributes :name, :organization, :code, :scope_type
       # Public: Initializes the command.
       #
       # form - A form object with the params.
-      # parent_scope - A parent scope for the scope to be created
-      def initialize(form, parent_scope = nil)
-        @form = form
-        @parent_scope = parent_scope
+      # parent - A parent scope for the scope to be created
+      def initialize(form, parent = nil)
+        super(form)
+        @parent = parent
       end
 
-      # Executes the command. Broadcasts these events:
-      #
-      # - :ok when everything is valid.
-      # - :invalid if the form was not valid and we could not proceed.
-      #
-      # Returns nothing.
-      def call
-        return broadcast(:invalid) if form.invalid?
+      protected
 
-        create_scope
-        broadcast(:ok)
-      end
+      attr_reader :parent
 
-      private
+      def resource_class = Decidim::Scope
 
-      attr_reader :form
+      def attributes = super.merge({ parent: })
 
-      def create_scope
-        Decidim.traceability.create!(
-          Scope,
-          form.current_user,
-          {
-            name: form.name,
-            organization: form.organization,
-            code: form.code,
-            scope_type: form.scope_type,
-            parent: @parent_scope
-          },
+      def extra_params
+        {
           extra: {
-            parent_name: @parent_scope.try(:name),
+            parent_name: parent.try(:name),
             scope_type_name: form.scope_type.try(:name)
           }
-        )
+        }
       end
     end
   end

data/app/commands/decidim/admin/create_scope_type.rb

@@ -3,41 +3,12 @@
 module Decidim
   module Admin
     # A command with all the business logic when creating a scope type.
-    class CreateScopeType < Decidim::Command
-      # Public: Initializes the command.
-      #
-      # form - A form object with the params.
-      def initialize(form, user)
-        @form = form
-        @user = user
-      end
-
-      # Executes the command. Broadcasts these events:
-      #
-      # - :ok when everything is valid.
-      # - :invalid if the form was not valid and we could not proceed.
-      #
-      # Returns nothing.
-      def call
-        return broadcast(:invalid) if form.invalid?
-
-        create_scope_type
-        broadcast(:ok)
-      end
+    class CreateScopeType < Decidim::Commands::CreateResource
+      fetch_form_attributes :name, :organization, :plural
 
       private
 
-      attr_reader :form
-
-      def create_scope_type
-        Decidim.traceability.create!(
-          ScopeType,
-          @user,
-          name: form.name,
-          organization: form.organization,
-          plural: form.plural
-        )
-      end
+      def resource_class = Decidim::ScopeType
     end
   end
 end

data/app/commands/decidim/admin/create_static_page.rb

@@ -3,56 +3,15 @@
 module Decidim
   module Admin
     # A command with all the business logic when creating a static page.
-    class CreateStaticPage < Decidim::Command
-      # Public: Initializes the command.
-      #
-      # form - A form object with the params.
-      def initialize(form)
-        @form = form
-        @page = nil
-      end
-
-      # Executes the command. Broadcasts these events:
-      #
-      # - :ok when everything is valid.
-      # - :invalid if the form was not valid and we could not proceed.
-      #
-      # Returns nothing.
-      def call
-        return broadcast(:invalid) if form.invalid?
-
-        create_page
-        update_organization_tos_version
-        broadcast(:ok)
-      end
+    class CreateStaticPage < Decidim::Commands::CreateResource
+      fetch_form_attributes :organization, :title, :slug, :weight, :topic, :content, :allow_public_access
 
-      private
+      protected
 
-      attr_reader :form
-
-      def create_page
-        @page = Decidim.traceability.create!(
-          StaticPage,
-          form.current_user,
-          attributes
-        )
-      end
-
-      def attributes
-        {
-          organization: form.organization,
-          title: form.title,
-          slug: form.slug,
-          show_in_footer: form.show_in_footer,
-          weight: form.weight,
-          topic: form.topic,
-          content: form.content,
-          allow_public_access: form.allow_public_access
-        }
-      end
+      def resource_class = Decidim::StaticPage
 
-      def update_organization_tos_version
-        UpdateOrganizationTosVersion.call(@form.organization, @page, @form)
+      def run_after_hooks
+        UpdateOrganizationTosVersion.call(form.organization, resource, form)
       end
     end
   end

data/app/commands/decidim/admin/create_static_page_topic.rb

@@ -3,34 +3,12 @@
 module Decidim
   module Admin
     # A command with all the business logic when creating a static page topic.
-    class CreateStaticPageTopic < Decidim::Command
-      # Public: Initializes the command.
-      #
-      # form - A form object with the params.
-      def initialize(form)
-        @form = form
-      end
+    class CreateStaticPageTopic < Decidim::Commands::CreateResource
+      fetch_form_attributes :title, :description, :show_in_footer, :weight, :organization
 
-      # Executes the command. Broadcasts these events:
-      #
-      # - :ok when everything is valid.
-      # - :invalid if the form was not valid and we could not proceed.
-      #
-      # Returns nothing.
-      def call
-        return broadcast(:invalid) if @form.invalid?
+      protected
 
-        @topic = Decidim.traceability.create!(
-          StaticPageTopic,
-          @form.current_user,
-          title: @form.title,
-          description: @form.description,
-          organization: @form.current_organization,
-          show_in_footer: @form.show_in_footer,
-          weight: @form.weight
-        )
-        broadcast(:ok)
-      end
+      def resource_class = Decidim::StaticPageTopic
     end
   end
 end

data/app/commands/decidim/admin/deliver_newsletter.rb

@@ -4,19 +4,18 @@ module Decidim
   module Admin
     # Delivers the newsletter to its recipients.
     class DeliverNewsletter < Decidim::Command
+      delegate :current_user, to: :form
       # Initializes the command.
       #
       # newsletter - The newsletter to deliver.
       # form - A form object with the params.
-      # user - the Decidim::User that delivers the newsletter
-      def initialize(newsletter, form, user)
+      def initialize(newsletter, form)
         @newsletter = newsletter
         @form = form
-        @user = user
       end
 
       def call
-        return broadcast(:invalid) if @form.send_to_all_users && !@user.admin?
+        return broadcast(:invalid) if @form.send_to_all_users && !current_user.admin?
         return broadcast(:invalid) unless @form.valid?
         return broadcast(:invalid) if @newsletter.sent?
         return broadcast(:no_recipients) if recipients.blank?
@@ -36,7 +35,7 @@ module Decidim
         Decidim.traceability.perform_action!(
           "deliver",
           @newsletter,
-          @user
+          current_user
         ) do
           NewsletterJob.perform_later(@newsletter, @form.as_json, recipients.map(&:id))
         end