decidim-admin 0.27.10 → 0.28.0.rc4

data/app/commands/decidim/admin/destroy_share_token.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_static_page_topic.rb

@@ -24,7 +24,7 @@ module Decidim
 
       attr_reader :page, :current_user
 
-      def destroy_page
+      def destroy_topic
         transaction do
           Decidim.traceability.perform_action!(
             "delete",

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

@@ -22,49 +22,23 @@ module Decidim
       def call
         return broadcast(:invalid) unless hideable?
 
-        hide!
-
-        send_hide_notification_to_author
+        with_events do
+          tool = Decidim::ModerationTools.new(@reportable, @current_user)
+          tool.hide!
+          tool.send_notification_to_author
+        end
 
         broadcast(:ok, @reportable)
       end
 
       private
 
-      def hideable?
-        !@reportable.hidden? && @reportable.reported?
-      end
-
-      def hide!
-        Decidim.traceability.perform_action!(
-          "hide",
-          @reportable.moderation,
-          @current_user,
-          extra: {
-            reportable_type: @reportable.class.name
-          }
-        ) do
-          @reportable.moderation.update!(hidden_at: Time.current)
-          @reportable.try(:touch)
-        end
-      end
-
-      def send_hide_notification_to_author
-        data = {
-          event: "decidim.events.reports.resource_hidden",
-          event_class: Decidim::ResourceHiddenEvent,
-          resource: @reportable,
-          extra: {
-            report_reasons: report_reasons
-          },
-          affected_users: @reportable.try(:authors) || [@reportable.try(:normalized_author)]
-        }
-
-        Decidim::EventsManager.publish(**data)
+      def event_arguments
+        { resource: @reportable }
       end
 
-      def report_reasons
-        @reportable.moderation.reports.pluck(:reason).uniq
+      def hideable?
+        !@reportable.hidden? && @reportable.reported?
       end
     end
   end

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

@@ -50,7 +50,7 @@ module Decidim
       def create_impersonation_log
         Decidim::ImpersonationLog.create!(
           admin: form.current_user,
-          user: user,
+          user:,
           reason: form.reason,
           started_at: Time.current
         )

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

@@ -35,7 +35,7 @@ module Decidim
       end
 
       # Ugly fix to get the user from the block inside the
-      # `InviteUser#call` method. I'm not proud of this.
+      # `InviteUser#call` method. I am not proud of this.
       def save_user(user)
         @user = user
       end

data/app/commands/decidim/admin/participatory_space/create_admin.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Admin
+    module ParticipatorySpace
+      class CreateAdmin < Decidim::Command
+        # Public: Initializes the command.
+        #
+        # form - A form object with the params.
+        # participatory_space - The ParticipatoryProcess that will hold the
+        #   user role
+        def initialize(form, participatory_space, options = {})
+          @form = form
+          @current_user = form.current_user
+          @participatory_space = participatory_space
+          @event_class = options.delete(:event_class)
+          @event = options.delete(:event)
+          @role_class = options.delete(:role_class)
+        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?
+
+          ActiveRecord::Base.transaction do
+            @user ||= existing_user || new_user
+            existing_role || create_role
+            add_admin_as_follower
+          end
+
+          broadcast(:ok)
+        rescue ActiveRecord::RecordInvalid
+          form.errors.add(:email, :taken)
+          broadcast(:invalid)
+        end
+
+        private
+
+        attr_reader :form, :participatory_space, :current_user, :user
+
+        def event_class = @event_class || (raise NotImplementedError, "You must define an event_class")
+
+        def event = @event || (raise NotImplementedError, "You must define an event")
+
+        def role_class = @role_class || (raise NotImplementedError, "You must define a role_class")
+
+        # This is command specific
+        # It is expected to
+        # - create a XxxUserRole using `Decidim.traceability`
+        # - send a notification to the user telling she has been invited to manage the participatory space
+        def create_role
+          Decidim.traceability.create!(role_class, current_user, role_params, extra_info)
+          send_notification user
+        end
+
+        # This is command specific
+        # It is expected to find if a UserRole for the same user, role and participatory_process already exist
+        # Return a boolean, or some object equally evaluable
+        def existing_role
+          role_class.for_space(participatory_space).exists?(role: form.role.to_sym, user:)
+        end
+
+        def extra_info = { resource: { title: user.name } }
+
+        def role_params = { role: form.role.to_sym, user:, role_class.new.target_space_association => participatory_space }
+
+        def send_notification(user)
+          Decidim::EventsManager.publish(
+            event:,
+            event_class:,
+            resource: form.current_participatory_space,
+            affected_users: [user],
+            extra: {
+              role: form.role
+            }
+          )
+        end
+
+        def new_user
+          @new_user ||= InviteUser.call(user_form) do
+            on(:ok) do |user|
+              return user
+            end
+          end
+        end
+
+        def invitation_instructions
+          return "invite_admin" if form.role == "admin"
+
+          "invite_collaborator"
+        end
+
+        def user_form
+          OpenStruct.new(name: form.name,
+                         email: form.email.downcase,
+                         organization: participatory_space.organization,
+                         admin: false,
+                         invited_by: current_user,
+                         invitation_instructions:)
+        end
+
+        def add_admin_as_follower
+          return if user.follows?(participatory_space)
+
+          form = Decidim::FollowForm
+                 .from_params(followable_gid: participatory_space.to_signed_global_id.to_s)
+                 .with_context(
+                   current_organization: participatory_space.organization,
+                   current_user: user
+                 )
+
+          Decidim::CreateFollow.new(form, user).call
+        end
+
+        def existing_user
+          return @existing_user if defined?(@existing_user)
+
+          @existing_user = User.find_by(email: form.email, organization: participatory_space.organization)
+
+          InviteUserAgain.call(@existing_user, invitation_instructions) if @existing_user&.invitation_pending?
+
+          @existing_user
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/admin/participatory_space/destroy_admin.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Admin
+    module ParticipatorySpace
+      class DestroyAdmin < Decidim::Command
+        # Public: Initializes the command.
+        #
+        # role - the UserRole to destroy
+        # current_user - the user performing this action
+        def initialize(role, current_user)
+          @role = role
+          @current_user = current_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
+          with_events do
+            destroy_role!
+          end
+
+          broadcast(:ok)
+        end
+
+        private
+
+        attr_reader :role, :current_user
+
+        def event_arguments
+          {
+            class_name: role.class.name,
+            role: role.id
+          }
+        end
+
+        def destroy_role!
+          extra_info = {
+            resource: {
+              title: role.user.name
+            }
+          }
+
+          Decidim.traceability.perform_action!(
+            "delete",
+            role,
+            current_user,
+            extra_info
+          ) do
+            role.destroy!
+            role
+          end
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/admin/participatory_space/publish.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Admin
+    module ParticipatorySpace
+      # A command that sets a ParticipatorySpace as published.
+      class Publish < Decidim::Command
+        # Public: Initializes the command.
+        #
+        # participatory_space - A ParticipatorySpace that will be published
+        # user - the user performing the action
+        def initialize(participatory_space, user)
+          @participatory_space = participatory_space
+          @user = user
+        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 participatory_space.nil? || participatory_space.published?
+
+          Decidim.traceability.perform_action!(:publish, participatory_space, user, **default_options) do
+            participatory_space.publish!
+          end
+
+          broadcast(:ok, participatory_space)
+        end
+
+        private
+
+        attr_reader :participatory_space, :user
+
+        def default_options = { visibility: "all" }
+      end
+    end
+  end
+end

data/app/commands/decidim/admin/participatory_space/unpublish.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Admin
+    module ParticipatorySpace
+      # A command that sets a ParticipatorySpace as unpublished.
+      class Unpublish < Decidim::Command
+        # Public: Initializes the command.
+        #
+        # participatory_space - A ParticipatorySpace that will be unpublished
+        # user - the user performing the action
+        def initialize(participatory_space, user)
+          @participatory_space = participatory_space
+          @user = user
+        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 participatory_space.nil? || !participatory_space.published?
+
+          Decidim.traceability.perform_action!(:unpublish, participatory_space, user, **default_options) do
+            participatory_space.unpublish!
+          end
+
+          broadcast(:ok, participatory_space)
+        end
+
+        private
+
+        attr_reader :participatory_space, :user
+
+        def default_options = { visibility: "all" }
+      end
+    end
+  end
+end

data/app/commands/decidim/admin/participatory_space/update_admin.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Admin
+    module ParticipatorySpace
+      class UpdateAdmin < Decidim::Command
+        # Public: Initializes the command.
+        #
+        # form - A form object with the params.
+        # user_role - The UserRole to update
+        # options: a hash with at least two mandatory keys, event_class and event
+        # - event_class - The event class to be used when notifying the user
+        # - event - The event name to be used when notifying the user
+        def initialize(form, user_role, options = {})
+          @form = form
+          @user_role = user_role
+          @event_class = options.delete(:event_class)
+          @event = options.delete(:event)
+        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?
+          return broadcast(:invalid) unless user_role
+
+          update_role!
+          broadcast(:ok)
+        end
+
+        private
+
+        attr_reader :form, :user_role
+
+        def event_class = @event_class || (raise NotImplementedError, "You must define an event_class")
+
+        def event = @event || (raise NotImplementedError, "You must define an event")
+
+        def update_role!
+          log_info = {
+            resource: {
+              title: user_role.user.name
+            }
+          }
+          Decidim.traceability.update!(
+            user_role,
+            form.current_user,
+            { role: form.role },
+            log_info
+          )
+          send_notification user_role.user
+        end
+
+        def send_notification(user)
+          Decidim::EventsManager.publish(
+            event:,
+            event_class:,
+            resource: form.current_participatory_space,
+            affected_users: [user],
+            extra: {
+              role: form.role
+            }
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -5,7 +5,7 @@ require "csv"
 module Decidim
   module Admin
     class ProcessParticipatorySpacePrivateUserImportCsv < Decidim::Command
-      include Decidim::ProcessesFileLocally
+      include Decidim::Admin::CustomImport
 
       # Public: Initializes the command.
       #
@@ -21,7 +21,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
@@ -34,10 +34,8 @@ module Decidim
       private
 
       def process_csv
-        process_file_locally(@form.file) do |file_path|
-          CSV.foreach(file_path, encoding: "BOM|UTF-8") do |email, user_name|
-            ImportParticipatorySpacePrivateUserCsvJob.perform_later(email, user_name, @private_users_to, @current_user) if email.present? && user_name.present?
-          end
+        process_import_file(@form.file) do |(email, user_name)|
+          ImportParticipatorySpacePrivateUserCsvJob.perform_later(email, user_name, @private_users_to, @current_user) if email.present? && user_name.present?
         end
       end
     end

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

@@ -7,7 +7,7 @@ module Decidim
     # A command with all the business logic when processing the CSV to verify
     # user groups.
     class ProcessUserGroupVerificationCsv < Decidim::Command
-      include Decidim::ProcessesFileLocally
+      include Decidim::Admin::CustomImport
 
       # Public: Initializes the command.
       #
@@ -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
@@ -35,11 +35,8 @@ module Decidim
         verifier = @form.current_user
         organization = @form.current_organization
 
-        process_file_locally(@form.file) do |file_path|
-          CSV.foreach(file_path) do |row|
-            email = row[0]
-            VerifyUserGroupFromCsvJob.perform_later(email, verifier, organization) if email.present?
-          end
+        process_import_file(@form.file) do |(email)|
+          VerifyUserGroupFromCsvJob.perform_later(email, verifier, organization) if email.present?
         end
       end
     end

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

@@ -22,7 +22,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/reject_user_group.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/update_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/update_area_type.rb

@@ -17,7 +17,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/update_attachment.rb

@@ -22,7 +22,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/update_attachment_collection.rb

@@ -17,7 +17,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/update_category.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

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

@@ -62,12 +62,12 @@ module Decidim
         if resource
           resource_permissions.update!(permissions: different_from_component_permissions(permissions))
         else
-          component.update!(permissions: permissions)
+          component.update!(permissions:)
         end
       end
 
       def run_hooks
-        component.manifest.run_hooks(:permission_update, component: component, resource: resource)
+        component.manifest.run_hooks(:permission_update, component:, resource:)
       end
 
       def resource_permissions

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

@@ -44,7 +44,7 @@ module Decidim
       end
 
       def update_content_block
-        UpdateContentBlock.call(form, content_block, user) do
+        ContentBlocks::UpdateContentBlock.call(form, content_block, user) do
           on(:ok) do |content_block|
             @content_block = content_block
           end

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

@@ -17,7 +17,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
@@ -55,7 +55,7 @@ module Decidim
           user_groups_enabled: form.user_groups_enabled,
           comments_max_length: form.comments_max_length,
           enable_machine_translations: form.enable_machine_translations,
-          admin_terms_of_use_body: form.admin_terms_of_use_body,
+          admin_terms_of_service_body: form.admin_terms_of_service_body,
           rich_text_editor_in_public_views: form.rich_text_editor_in_public_views,
           enable_participatory_space_filters: form.enable_participatory_space_filters
         }.merge(welcome_notification_attributes)

data/app/commands/decidim/admin/update_organization_appearance.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
@@ -39,7 +39,7 @@ module Decidim
       private
 
       def image_fields
-        [:logo, :highlighted_content_banner_image, :favicon, :official_img_header, :official_img_footer]
+        [:logo, :highlighted_content_banner_image, :favicon, :official_img_footer]
       end
 
       attr_reader :form, :organization
@@ -98,13 +98,11 @@ module Decidim
           colors: {
             primary: form.primary_color,
             secondary: form.secondary_color,
+            tertiary: form.tertiary_color,
             success: form.success_color,
             warning: form.warning_color,
-            alert: form.alert_color,
-            highlight: form.highlight_color,
-            "highlight-alternative": form.highlight_alternative_color,
-            theme: form.theme_color
-          }
+            alert: form.alert_color
+          }.compact_blank
         }
       end
     end