decidim-admin 0.27.9 → 0.28.0.rc4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2eb2851fd65d6f27916f45b3901c10e56f89fb96e74cdf04ef9708dc48f3ea9
-  data.tar.gz: ec05b6e9a6ccbebf068a79a6c52b4982e6b45db90c9230e3dfe5e5ee3e50888f
+  metadata.gz: 5984ece47933091c48377e75d0b9f5a9ec1b999f90d077a9da76d75b435855fe
+  data.tar.gz: 66d069b1df9ad3b1bde850a0a900f91483751c3c74f93a12e69fc6f3313c449b
 SHA512:
-  metadata.gz: 93a82844392e52a2a9b072be4971787999351b75bef917c0532e3badef6cc80f1e6fe821d73aa15bc1315a5a9c184c8b48218216333e8e0797152c344beb4265
-  data.tar.gz: 6f905c4548408c6a8677df860b7c67db99208a28d4fabe20960257ee0f6522ee05b12f8ee438e227c62272dafb8dbf4c3dc89772dfa81cb02397545d771c47f7
+  metadata.gz: e9a78e6a75102bd913010bccbf30a7495d61df25aa48c9ce9d5be62cff997f9db58c55de12e413d651347a9b60bba3c731a181b234862a1e404d4e919ea86f4b
+  data.tar.gz: 850ecd7ab839cdbcc7569e6058dc148c9e77cd2d409e54a4cfb844bfb47df021321b8216bf654cf7f7574e987b01616444668d0f856466746fdfa1d446d28bf3

data/README.md

@@ -6,7 +6,7 @@ organization, participatory processes and all other entities.
 ## Usage
 
 This will add an admin dashboard to manage an organization an all its entities.
-It's included by default with Decidim.
+It is included by default with Decidim.
 
 ## Installation
 
@@ -29,14 +29,14 @@ bundle
 This component allows an admin to create pages to serve static content. Some
 example of this kind of pages could be:
 
-* Terms and Conditions
+* Terms of service
 * FAQ
 * Accessibility guidelines
 * About the project
 
 All the pages can be created with I18n support and will be accessible as
 `/pages/:page-slug`. You can link them at your website the same way you link
-other Rails models: `pages_path("terms-and-conditions")`.
+other Rails models: `pages_path("terms-of-service")`.
 
 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

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

@@ -1,3 +1,3 @@
 <% if private_space? && !(transparent_space?) %>
-  <div class="callout warning"><%= t("decidim.admin.attachments_privacy_warning.message") %></div>
+  <%= cell("decidim/announcement", t("decidim.admin.attachments_privacy_warning.message"), callout_class: "warning") %>
 <% end %>

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

@@ -1,13 +1,18 @@
-<li draggable="true" data-content-block-manifest-name="<%= manifest_name %>">
+<li draggable="true" data-content-block-id="<%= model.id %>">
   <div class="draggable-content">
-    <%= t(public_name_key) %>
+    <%= name %>
     <div>
-      <% if has_settings? %>
-        <%= link_to edit_content_block_path, class: "mr-s text-muted" do %>
-          <%= icon "pencil", role: "img", "aria-hidden": true %>
+      <% if model.persisted? %>
+        <% if has_settings? %>
+          <%= link_to edit_content_block_path, class: "mr-s text-muted" do %>
+            <%= icon "pencil-line", role: "img", "aria-hidden": true %>
+          <% end %>
+        <% end %>
+        <%= link_to content_block_path, method: :delete, data: { confirm: content_block_destroy_confirmation_text }, class: "mr-s text-muted" do %>
+          <%= icon "delete-bin-line", role: "img", "aria-hidden": true %>
         <% end %>
       <% end %>
-      <%= icon "menu", role: "img", "aria-hidden": true %>
+      <%= icon "menu-line", role: "img", "aria-hidden": true %>
     </div>
   </div>
 </li>

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

@@ -4,19 +4,33 @@ module Decidim
   module Admin
     class ContentBlockCell < Decidim::ViewModel
       include Decidim::IconHelper
+      include Decidim::ContentBlocks::HasRelatedComponents
 
-      delegate :public_name_key, :has_settings?, to: :model
+      delegate :public_name_key, :has_settings?, :component_manifest_name, to: :model
+      delegate :content_block_destroy_confirmation_text, to: :controller
 
-      def manifest_name
-        model.try(:manifest_name) || model.name
+      def edit_content_block_path
+        raise "#{self.class.name} is expected to implement #edit_content_block_path"
       end
 
-      def edit_content_block_path
-        decidim_admin.edit_organization_homepage_content_block_path(manifest_name)
+      def content_block_path
+        raise "#{self.class.name} is expected to implement #content_block_path"
+      end
+
+      def component
+        @component ||= if component_manifest_name.present?
+                         components = components_for(model)
+                         component_id = model.settings.try(:component_id)
+                         components = components.where(id: component_id) if component_id.present?
+
+                         components.first if components.one?
+                       end
       end
 
-      def decidim_admin
-        Decidim::Admin::Engine.routes.url_helpers
+      def name
+        return I18n.t(public_name_key) if component.blank?
+
+        "#{I18n.t(public_name_key)} (#{translated_attribute(component&.name)})"
       end
     end
   end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Admin
+    class HomepageContentBlockCell < ContentBlockCell
+      def edit_content_block_path
+        decidim_admin.edit_organization_homepage_content_block_path(model)
+      end
+
+      def content_block_path
+        decidim_admin.organization_homepage_content_block_path(model)
+      end
+
+      def decidim_admin
+        Decidim::Admin::Engine.routes.url_helpers
+      end
+    end
+  end
+end

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

@@ -1,7 +1,7 @@
 <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">
   <li class="is-dropdown-submenu-parent">
-    <a title="<%= %{#{per_page} #{t("decidim.admin.actions.per_page")}} %>">
+    <a title="<%= %(#{per_page} #{t("decidim.admin.actions.per_page")}) %>">
       <%= per_page %>
     </a>
 

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Admin
+    class StaticPageContentBlockCell < ContentBlockCell
+      delegate :scoped_resource, to: :controller
+
+      def edit_content_block_path
+        decidim_admin.edit_static_page_content_block_path(scoped_resource, model)
+      end
+
+      def content_block_path
+        decidim_admin.static_page_content_block_path(scoped_resource, model)
+      end
+
+      def decidim_admin
+        Decidim::Admin::Engine.routes.url_helpers
+      end
+    end
+  end
+end

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

@@ -19,11 +19,10 @@ module Decidim
       def call
         return broadcast(:invalid) unless form.valid?
 
-        transaction do
+        with_events(with_transaction: true) do
           find_or_create_moderation!
           register_justification!
           block!
-          notify_user!
         end
 
         broadcast(:ok, form.user)
@@ -31,10 +30,22 @@ module Decidim
 
       private
 
-      attr_reader :form
+      attr_reader :form, :current_blocking
+
+      def event_arguments
+        {
+          resource: form.user,
+          extra: {
+            event_author: form.current_user,
+            locale:,
+            justification: form.justification,
+            hide: form.hide?
+          }
+        }
+      end
 
       def find_or_create_moderation!
-        Decidim::UserModeration.create_or_find_by!(user: form.user)
+        Decidim::UserModeration.find_or_create_by!(user: form.user)
       end
 
       def register_justification!
@@ -45,13 +56,6 @@ module Decidim
         )
       end
 
-      def notify_user!
-        Decidim::BlockUserJob.perform_later(
-          @current_blocking.user,
-          @current_blocking.justification
-        )
-      end
-
       def block!
         Decidim.traceability.perform_action!(
           "block",

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

@@ -32,7 +32,7 @@ module Decidim
       private
 
       def impersonation_log
-        @impersonation_log ||= Decidim::ImpersonationLog.where(admin: current_user, user: user).active.first
+        @impersonation_log ||= Decidim::ImpersonationLog.where(admin: current_user, user:).active.first
       end
 
       def close_session

data/app/commands/decidim/admin/content_blocks/create_content_block.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Admin
+    module ContentBlocks
+      # A command that reorders a collection of content blocks. It also creates
+      # the ones that might be missing.
+      class CreateContentBlock < Decidim::Command
+        # Public: Initializes the command.
+        #
+        # organization - the Organization where the content blocks reside
+        # scope - the scope applied to the content blocks
+        # manifest_name - the manifest name for the content block created
+        # scoped_resource_id - (optional) The id of the resource the content blocks belongs to
+        def initialize(organization, scope, manifest_name, scoped_resource_id = nil)
+          @organization = organization
+          @scope = scope
+          @manifest_name = manifest_name
+          @scoped_resource_id = scoped_resource_id
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if the data was not valid and we could not proceed.
+        #
+        # Returns nothing.
+        def call
+          create_content_block
+          broadcast(:ok)
+        rescue StandardError
+          broadcast(:invalid)
+        end
+
+        private
+
+        attr_reader :organization, :scope, :scoped_resource_id, :manifest_name
+
+        def create_content_block
+          Decidim::ContentBlock.create!(
+            organization:,
+            scope_name: scope,
+            scoped_resource_id:,
+            manifest_name:
+          )
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/admin/content_blocks/destroy_content_block.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Admin
+    module ContentBlocks
+      # A command with all the business logic to destroy a content block
+      class DestroyContentBlock < Decidim::Command
+        # Public: Initializes the command.
+        #
+        # content_block - The content_block to destroy
+        def initialize(content_block)
+          @content_block = content_block
+        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
+          destroy_content_block
+          broadcast(:ok)
+        rescue StandardError
+          broadcast(:invalid)
+        end
+
+        private
+
+        def destroy_content_block
+          @content_block.destroy!
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/admin/content_blocks/reorder_content_blocks.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Admin
+    module ContentBlocks
+      # A command that reorders a collection of content blocks
+      # the ones that might be missing.
+      class ReorderContentBlocks < Decidim::Command
+        # Public: Initializes the command.
+        #
+        # organization - the Organization where the content blocks reside
+        # scope - the scope applied to the content blocks
+        # order - an Array holding the order of IDs of published content blocks.
+        # scoped_resource_id - (optional) The id of the resource the content blocks belongs to.
+        def initialize(organization, scope, order, scoped_resource_id = nil)
+          @organization = organization
+          @scope = scope
+          @order = order
+          @scoped_resource_id = scoped_resource_id
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if the data was not valid and we could not proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) if order.blank?
+
+          reorder_steps
+          broadcast(:ok)
+        end
+
+        private
+
+        attr_reader :organization, :scope, :scoped_resource_id
+
+        def reorder_steps
+          transaction do
+            reset_weights
+            collection.reload
+            set_new_weights
+            unpublish_removed_content_blocks
+            publish_appearing_content_blocks
+          end
+        end
+
+        def reset_weights
+          # rubocop:disable Rails/SkipsModelValidations
+          collection.where.not(weight: nil).update_all(weight: nil)
+          # rubocop:enable Rails/SkipsModelValidations
+        end
+
+        def set_new_weights
+          data = order.each_with_index.inject({}) do |hash, (id, index)|
+            hash.update(id => index + 1)
+          end
+
+          data.each do |id, weight|
+            content_block = collection.find_by(id:)
+            content_block.update!(weight:) if content_block.present?
+          end
+        end
+
+        # rubocop:disable Rails/SkipsModelValidations
+        def unpublish_removed_content_blocks
+          collection.where(weight: nil).update_all(published_at: nil)
+        end
+
+        def publish_appearing_content_blocks
+          collection.where(published_at: nil).where.not(weight: nil).update_all(published_at: Time.current)
+        end
+        # rubocop:enable Rails/SkipsModelValidations
+
+        def order
+          return nil unless @order.is_a?(Array) && @order.present?
+
+          @order
+        end
+
+        def collection
+          @collection ||= Decidim::ContentBlock.for_scope(scope, organization:).where(scoped_resource_id:)
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/admin/content_blocks/update_content_block.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Admin
+    module ContentBlocks
+      # This command gets called when a content block is updated from the admin
+      # panel.
+      class UpdateContentBlock < Decidim::Command
+        attr_reader :form, :content_block, :scope
+
+        # Public: Initializes the command.
+        #
+        # form    - The form from which the data in this component comes from.
+        # component - The component to update.
+        # scope - the scope where the content block belongs to.
+        def initialize(form, content_block, scope)
+          @form = form
+          @content_block = content_block
+          @scope = scope
+        end
+
+        # Public: Updates the content block settings and its attachments.
+        #
+        # Broadcasts :ok if created, :invalid otherwise.
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          images_valid = true
+
+          transaction do
+            update_content_block_settings
+            content_block.save!
+
+            # Saving the images will cause the image file validations to run
+            # according to their uploader settings and the organization settings.
+            # The content block validation will fail in case there are processing
+            # errors on the image files.
+            #
+            # NOTE:
+            # The images can be only stored correctly if the content block is
+            # already persisted. This is not the case e.g. when creating a new
+            # newsletter which uses the content blocks through newsletter
+            # templates. This is why this needs to happen after the initial
+            # `content_block.save!` call.
+            update_content_block_images
+            unless content_block.valid?
+              images_valid = false
+              raise ActiveRecord::Rollback
+            end
+
+            # The save method needs to be called another time in order to store
+            # the image information.
+            content_block.save!
+          end
+
+          return broadcast(:invalid) unless images_valid
+
+          broadcast(:ok, content_block)
+        end
+
+        private
+
+        def update_content_block_settings
+          content_block.settings = form.settings
+        end
+
+        def update_content_block_images
+          content_block.manifest.images.each do |image_config|
+            image_name = image_config[:name]
+
+            if form.images[image_name]
+              content_block.images_container.send("#{image_name}=", form.images[image_name])
+            elsif form.images["remove_#{image_name}".to_sym] == "1"
+              content_block.images_container.send("#{image_name}=", nil)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -14,7 +14,7 @@ module Decidim
       # Executes the command. Broadcasts these events:
       #
       # - :ok when everything is valid.
-      # - :invalid if the form wasn't valid and we couldn't proceed.
+      # - :invalid if the form was not valid and we could not proceed.
       #
       # Returns nothing.
       def call

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

@@ -15,7 +15,7 @@ module Decidim
       # Executes the command. Broadcasts these events:
       #
       # - :ok when everything is valid.
-      # - :invalid if the form wasn't valid and we couldn't proceed.
+      # - :invalid if the form was not valid and we could not proceed.
       #
       # Returns nothing.
       def call

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

@@ -18,7 +18,7 @@ module Decidim
       # Executes the command. Broadcasts these events:
       #
       # - :ok when everything is valid.
-      # - :invalid if the form wasn't valid and we couldn't proceed.
+      # - :invalid if the form was not valid and we could not proceed.
       #
       # Returns nothing.
       def call

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

@@ -18,7 +18,7 @@ module Decidim
       # Executes the command. Broadcasts these events:
       #
       # - :ok when everything is valid.
-      # - :invalid if the form wasn't valid and we couldn't proceed.
+      # - :invalid if the form was not valid and we could not proceed.
       #
       # Returns nothing.
       def call

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

@@ -19,7 +19,7 @@ module Decidim
       # Executes the command. Broadcasts these events:
       #
       # - :ok when everything is valid.
-      # - :invalid if the form wasn't valid and we couldn't proceed.
+      # - :invalid if the form was not valid and we could not proceed.
       #
       # Returns nothing.
       def call

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

@@ -43,7 +43,7 @@ module Decidim
       end
 
       def create_content_block
-        UpdateContentBlock.call(form, content_block, user) do
+        ContentBlocks::UpdateContentBlock.call(form, content_block, user) do
           on(:ok) do |content_block|
             content_block.update(scoped_resource_id: newsletter.id)
             @content_block = content_block

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

@@ -20,7 +20,7 @@ module Decidim
       # Executes the command. Broadcasts these events:
       #
       # - :ok when everything is valid.
-      # - :invalid if the form wasn't valid and we couldn't proceed.
+      # - :invalid if the form was not valid and we could not proceed.
       #
       # Returns nothing.
       def call
@@ -52,7 +52,7 @@ module Decidim
           }
         ) do
           Decidim::ParticipatorySpacePrivateUser.find_or_create_by!(
-            user: user,
+            user:,
             privatable_to: @private_user_to
           )
         end
@@ -85,7 +85,7 @@ module Decidim
                        organization: private_user_to.organization,
                        admin: false,
                        invited_by: current_user,
-                       invitation_instructions: invitation_instructions)
+                       invitation_instructions:)
       end
 
       def invitation_instructions

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

@@ -16,7 +16,7 @@ module Decidim
       # Executes the command. Broadcasts these events:
       #
       # - :ok when everything is valid.
-      # - :invalid if the form wasn't valid and we couldn't proceed.
+      # - :invalid if the form was not valid and we could not proceed.
       #
       # Returns nothing.
       def call

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

@@ -15,7 +15,7 @@ module Decidim
       # Executes the command. Broadcasts these events:
       #
       # - :ok when everything is valid.
-      # - :invalid if the form wasn't valid and we couldn't proceed.
+      # - :invalid if the form was not valid and we could not proceed.
       #
       # Returns nothing.
       def call

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

@@ -15,7 +15,7 @@ module Decidim
       # Executes the command. Broadcasts these events:
       #
       # - :ok when everything is valid.
-      # - :invalid if the form wasn't valid and we couldn't proceed.
+      # - :invalid if the form was not valid and we could not proceed.
       #
       # Returns nothing.
       def call

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

@@ -14,7 +14,7 @@ module Decidim
       # Executes the command. Broadcasts these events:
       #
       # - :ok when everything is valid.
-      # - :invalid if the form wasn't valid and we couldn't proceed.
+      # - :invalid if the form was not valid and we could not proceed.
       #
       # Returns nothing.
       def call

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

@@ -16,7 +16,7 @@ module Decidim
       # Executes the command. Broadcasts these events:
       #
       # - :ok when everything is valid.
-      # - :invalid if the form wasn't valid and we couldn't proceed.
+      # - :invalid if the form was not valid and we could not proceed.
       #
       # Returns nothing.
       def call

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

@@ -16,11 +16,11 @@ module Decidim
       # Executes the command. Broadcasts these events:
       #
       # - :ok when everything is valid.
-      # - :invalid if the data wasn't valid and we couldn't proceed.
+      # - :invalid if the data was not valid and we could not proceed.
       #
       # Returns nothing.
       def call
-        return broadcast(:invalid) if category.nil? || category.subcategories.any? || !category.unused?
+        return broadcast(:invalid) if category.nil? || category.subcategories.any?
 
         destroy_category
         broadcast(:ok)

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

@@ -16,7 +16,7 @@ module Decidim
       # Executes the command. Broadcasts these events:
       #
       # - :ok when everything is valid.
-      # - :invalid if the form wasn't valid and we couldn't proceed.
+      # - :invalid if the form was not valid and we could not proceed.
       #
       # Returns nothing.
       def call

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

@@ -16,7 +16,7 @@ module Decidim
       # Executes the command. Broadcasts these events:
       #
       # - :ok when everything is valid.
-      # - :invalid if the form wasn't valid and we couldn't proceed.
+      # - :invalid if the form was not valid and we could not proceed.
       #
       # Returns nothing.
       def call