decidim-admin 0.28.2 → 0.29.0.rc1

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

@@ -5,16 +5,16 @@ module Decidim
     # This command gets called when permissions for a component are updated
     # in the admin panel.
     class UpdateComponentPermissions < Decidim::Command
+      delegate :current_user, to: :form
       # Public: Initializes the command.
       #
       # form    - The form from which the data in this component comes from.
       # component - The component to update.
       # resource - The resource to update.
-      def initialize(form, component, resource, user)
+      def initialize(form, component, resource)
         @form = form
         @component = component
         @resource = resource
-        @user = user
       end
 
       # Public: Sets the permissions for a component.
@@ -23,7 +23,7 @@ module Decidim
       def call
         return broadcast(:invalid) unless form.valid?
 
-        Decidim.traceability.perform_action!("update_permissions", @component, @user) do
+        Decidim.traceability.perform_action!("update_permissions", @component, current_user) do
           transaction do
             update_permissions
             run_hooks

data/app/commands/decidim/admin/{update_external_domain_whitelist.rb → update_external_domain_allowlist.rb}

@@ -2,19 +2,20 @@
 
 module Decidim
   module Admin
-    class UpdateExternalDomainWhitelist < Decidim::Command
+    class UpdateExternalDomainAllowlist < Decidim::Command
       attr_reader :form, :organization
 
-      def initialize(form, organization, user)
+      delegate :current_user, to: :form
+
+      def initialize(form, organization)
         @form = form
         @organization = organization
-        @user = user
       end
 
       def call
         return broadcast(:invalid) if form.invalid?
 
-        Decidim.traceability.perform_action!("update_external_domain", @organization, @user) do
+        Decidim.traceability.perform_action!("update_external_domain", @organization, current_user) do
           save_domains!
         end
 
@@ -24,7 +25,7 @@ module Decidim
       private
 
       def save_domains!
-        organization.external_domain_whitelist = form.external_domains.filter_map do |external_domain_form|
+        organization.external_domain_allowlist = form.external_domains.filter_map do |external_domain_form|
           external_domain_form.value unless external_domain_form.deleted
         end.flatten
 

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

@@ -5,10 +5,11 @@ module Decidim
     # This command gets called when a content block is updated from the admin
     # panel.
     class UpdateHelpSections < Decidim::Command
-      def initialize(form, organization, user)
+      delegate :current_user, to: :form
+
+      def initialize(form, organization)
         @form = form
         @organization = organization
-        @user = user
       end
 
       def call
@@ -18,7 +19,7 @@ module Decidim
           @form.sections.each do |section|
             next unless content_has_changed?(section)
 
-            Decidim.traceability.perform_action!("update", ContextualHelpSection, @user, { "resource" => { "title" => section.id.humanize } }) do
+            Decidim.traceability.perform_action!("update", ContextualHelpSection, current_user, { "resource" => { "title" => section.id.humanize } }) do
               ContextualHelpSection.set_content(@organization, section.id, section.content)
               ContextualHelpSection.find_by(organization: @organization, section_id: section.id)
             end
@@ -30,6 +31,8 @@ module Decidim
 
       private
 
+      attr_reader :form
+
       def content_has_changed?(section)
         return if ContextualHelpSection.find_by(organization: @organization, section_id: section.id).nil? && section.content.compact_blank.blank?
 

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

@@ -4,17 +4,16 @@ module Decidim
   module Admin
     # Updates the newsletter given form data.
     class UpdateNewsletter < Decidim::Command
+      delegate :current_user, to: :form
       # Initializes the command.
       #
       # newsletter - The Newsletter to update.
       # form       - The form object containing the data to update.
-      # user       - The user that updates the newsletter.
-      def initialize(newsletter, form, user)
+      def initialize(newsletter, form)
         @newsletter = newsletter
         @content_block = newsletter.template
         @form = form
-        @user = user
-        @organization = user.organization
+        @organization = form.current_organization
       end
 
       def call
@@ -32,19 +31,20 @@ module Decidim
 
       private
 
-      attr_reader :user, :newsletter, :content_block, :organization, :form
+      attr_reader :newsletter, :content_block, :organization, :form
 
       def update_newsletter
+        # pp current_user.inspect
         @newsletter = Decidim.traceability.update!(
           newsletter,
-          user,
+          current_user,
           subject: form.subject,
-          author: user
+          author: current_user
         )
       end
 
       def update_content_block
-        ContentBlocks::UpdateContentBlock.call(form, content_block, user) do
+        ContentBlocks::UpdateContentBlock.call(form, content_block, current_user) do
           on(:ok) do |content_block|
             @content_block = content_block
           end

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

@@ -4,62 +4,18 @@ module Decidim
   module Admin
     # A command with all the business logic for updating the current
     # organization.
-    class UpdateOrganization < Decidim::Command
-      # Public: Initializes the command.
-      #
-      # organization - The Organization that will be updated.
-      # form - A form object with the params.
-      def initialize(organization, form)
-        @organization = organization
-        @form = form
-      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(:ok, @organization) if update_organization
-
-        broadcast(:invalid)
-      end
+    class UpdateOrganization < Decidim::Commands::UpdateResource
+      fetch_form_attributes :name, :default_locale, :reference_prefix, :time_zone, :twitter_handler,
+                            :facebook_handler, :instagram_handler, :youtube_handler, :github_handler, :badges_enabled,
+                            :user_groups_enabled, :comments_max_length, :enable_machine_translations,
+                            :admin_terms_of_service_body, :rich_text_editor_in_public_views, :enable_participatory_space_filters
 
       private
 
-      attr_reader :form, :organization
-
-      def update_organization
-        @organization = Decidim.traceability.update!(
-          @organization,
-          form.current_user,
-          attributes
-        )
-      end
-
       def attributes
-        {
-          name: form.name,
-          default_locale: form.default_locale,
-          reference_prefix: form.reference_prefix,
-          time_zone: form.time_zone,
-          twitter_handler: form.twitter_handler,
-          facebook_handler: form.facebook_handler,
-          instagram_handler: form.instagram_handler,
-          youtube_handler: form.youtube_handler,
-          github_handler: form.github_handler,
-          badges_enabled: form.badges_enabled,
-          user_groups_enabled: form.user_groups_enabled,
-          comments_max_length: form.comments_max_length,
-          enable_machine_translations: form.enable_machine_translations,
-          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)
-          .merge(machine_translation_attributes || {})
+        super
+          .merge(welcome_notification_attributes)
+          .merge(machine_translation_attributes)
       end
 
       def welcome_notification_attributes
@@ -71,7 +27,7 @@ module Decidim
       end
 
       def machine_translation_attributes
-        return unless Decidim.config.enable_machine_translations
+        return {} unless Decidim.config.enable_machine_translations
 
         {
           machine_translation_display_priority: form.machine_translation_display_priority

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

@@ -4,59 +4,20 @@ module Decidim
   module Admin
     # A command with all the business logic for updating the current
     # organization appearance.
-    class UpdateOrganizationAppearance < Decidim::Command
-      include ::Decidim::AttachmentAttributesMethods
+    class UpdateOrganizationAppearance < Decidim::Commands::UpdateResource
+      fetch_file_attributes :logo, :highlighted_content_banner_image, :favicon, :official_img_footer
 
-      # Public: Initializes the command.
-      #
-      # organization - The Organization that will be updated.
-      # form - A form object with the params.
-      def initialize(organization, form)
-        @organization = organization
-        @form = form
-      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?
-
-        begin
-          update_organization
-          broadcast(:ok, organization)
-        rescue ActiveRecord::RecordInvalid
-          image_fields.each do |field|
-            form.errors.add(field, organization.errors[field]) if organization.errors.include? field
-          end
-          broadcast(:invalid)
-        end
-      end
+      fetch_form_attributes :cta_button_path, :cta_button_text, :description, :official_url,
+                            :highlighted_content_banner_enabled, :highlighted_content_banner_action_url,
+                            :highlighted_content_banner_title, :highlighted_content_banner_short_description,
+                            :highlighted_content_banner_action_title,
+                            :highlighted_content_banner_action_subtitle, :enable_omnipresent_banner, :omnipresent_banner_url,
+                            :omnipresent_banner_title, :omnipresent_banner_short_description
 
       private
 
-      def image_fields
-        [:logo, :highlighted_content_banner_image, :favicon, :official_img_footer]
-      end
-
-      attr_reader :form, :organization
-
-      def update_organization
-        @organization = Decidim.traceability.update!(
-          organization,
-          form.current_user,
-          attributes
-        )
-      end
-
       def attributes
-        appearance_attributes
-          .merge(attachment_attributes(*image_fields))
-          .merge(highlighted_content_banner_attributes)
-          .merge(omnipresent_banner_attributes)
+        super
           .merge(colors_attributes)
           .delete_if { |_k, val| val.is_a?(Decidim::ApplicationUploader) }
           .tap do |attributes|
@@ -64,44 +25,12 @@ module Decidim
           end
       end
 
-      def appearance_attributes
-        {
-          cta_button_path: form.cta_button_path,
-          cta_button_text: form.cta_button_text,
-          description: form.description,
-          official_url: form.official_url
-        }
-      end
-
-      def highlighted_content_banner_attributes
-        {
-          highlighted_content_banner_enabled: form.highlighted_content_banner_enabled,
-          highlighted_content_banner_action_url: form.highlighted_content_banner_action_url,
-          highlighted_content_banner_title: form.highlighted_content_banner_title,
-          highlighted_content_banner_short_description: form.highlighted_content_banner_short_description,
-          highlighted_content_banner_action_title: form.highlighted_content_banner_action_title,
-          highlighted_content_banner_action_subtitle: form.highlighted_content_banner_action_subtitle
-        }
-      end
-
-      def omnipresent_banner_attributes
-        {
-          enable_omnipresent_banner: form.enable_omnipresent_banner,
-          omnipresent_banner_url: form.omnipresent_banner_url,
-          omnipresent_banner_short_description: form.omnipresent_banner_short_description,
-          omnipresent_banner_title: form.omnipresent_banner_title
-        }
-      end
-
       def colors_attributes
         {
           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
+            tertiary: form.tertiary_color
           }.compact_blank
         }
       end

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

@@ -3,50 +3,17 @@
 module Decidim
   module Admin
     # A command with all the business logic when updating a scope.
-    class UpdateScope < Decidim::Command
-      # Public: Initializes the command.
-      #
-      # scope - The Scope to update
-      # form - A form object with the params.
-      def initialize(scope, form)
-        @scope = scope
-        @form = form
-      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?
-
-        update_scope
-        broadcast(:ok)
-      end
-
-      private
+    class UpdateScope < Decidim::Commands::UpdateResource
+      fetch_form_attributes :name, :code, :scope_type
 
-      attr_reader :form
+      protected
 
-      def update_scope
-        Decidim.traceability.update!(
-          @scope,
-          form.current_user,
-          attributes,
+      def extra_params
+        {
           extra: {
-            parent_name: @scope.parent.try(:name),
-            scope_type_name: form.scope_type.try(:name)
+            parent_name: resource.parent.try(:name),
+            scope_type_name: resource.scope_type.try(:name)
           }
-        )
-      end
-
-      def attributes
-        {
-          name: form.name,
-          code: form.code,
-          scope_type: form.scope_type
         }
       end
     end

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

@@ -3,48 +3,8 @@
 module Decidim
   module Admin
     # A command with all the business logic when updating a scope type.
-    class UpdateScopeType < Decidim::Command
-      # Public: Initializes the command.
-      #
-      # scope_type - The ScopeType to update
-      # form - A form object with the params.
-      def initialize(scope_type, form, user)
-        @scope_type = scope_type
-        @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?
-
-        update_scope_type
-        broadcast(:ok)
-      end
-
-      private
-
-      attr_reader :form
-
-      def update_scope_type
-        Decidim.traceability.update!(
-          @scope_type,
-          @user,
-          attributes
-        )
-      end
-
-      def attributes
-        {
-          name: form.name,
-          plural: form.plural
-        }
-      end
+    class UpdateScopeType < Decidim::Commands::UpdateResource
+      fetch_form_attributes :name, :plural
     end
   end
 end

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

@@ -3,56 +3,15 @@
 module Decidim
   module Admin
     # A command with all the business logic when updating a static page.
-    class UpdateStaticPage < Decidim::Command
-      # Public: Initializes the command.
-      #
-      # page - The StaticPage to update
-      # form - A form object with the params.
-      def initialize(page, form)
-        @page = page
-        @form = form
-      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?
-
-        update_page
-        update_organization_tos_version if form.changed_notably
-        broadcast(:ok)
-      end
+    class UpdateStaticPage < Decidim::Commands::UpdateResource
+      fetch_form_attributes :title, :slug, :weight, :topic, :content, :allow_public_access
 
       private
 
-      attr_reader :form
-
-      def update_page
-        Decidim.traceability.update!(
-          @page,
-          form.current_user,
-          attributes
-        )
-      end
-
-      def attributes
-        {
-          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 run_after_hooks
+        return unless form.changed_notably
 
-      def update_organization_tos_version
-        UpdateOrganizationTosVersion.call(@form.organization, @page, @form)
+        UpdateOrganizationTosVersion.call(form.organization, resource, form)
       end
     end
   end

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

@@ -3,49 +3,8 @@
 module Decidim
   module Admin
     # A command with all the business logic when updating a static page topic.
-    class UpdateStaticPageTopic < Decidim::Command
-      # Public: Initializes the command.
-      #
-      # page - The StaticPageTopic to update
-      # form - A form object with the params.
-      def initialize(topic, form)
-        @topic = topic
-        @form = form
-      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?
-
-        update_topic
-        broadcast(:ok)
-      end
-
-      private
-
-      attr_reader :form
-
-      def update_topic
-        Decidim.traceability.update!(
-          @topic,
-          form.current_user,
-          attributes
-        )
-      end
-
-      def attributes
-        {
-          title: form.title,
-          description: form.description,
-          show_in_footer: form.show_in_footer,
-          weight: form.weight
-        }
-      end
+    class UpdateStaticPageTopic < Decidim::Commands::UpdateResource
+      fetch_form_attributes :title, :description, :show_in_footer, :weight
     end
   end
 end

data/app/constraints/decidim/admin/organization_dashboard_constraint.rb

@@ -5,7 +5,7 @@ module Decidim
     # A Rails routes constraint to only allow access to an Organization admin to
     # the organization dashboard.
     class OrganizationDashboardConstraint
-      # Initializes the contraint.
+      # Initializes the constraint.
       #
       # request [Rack::Request]
       def initialize(request)

data/app/controllers/concerns/decidim/admin/content_blocks/landing_page.rb

@@ -79,7 +79,7 @@ module Decidim
 
           # Method to be implemented at the controller. Defines the permissions for
           # edit and update actions.
-          # For example `enforce_permission_to :manage_landing_page, :voting, voting: current_space`.
+          # For example `enforce_permission_to :update, :process, process: scoped_resource
           def enforce_permission_to_update_resource
             raise "#{self.class.name} is expected to implement #enforce_permission_to_update_resource"
           end
@@ -99,7 +99,7 @@ module Decidim
           # Method to be implemented at the controller. Returns a string
           # with the cell name to be used for the drag'n'drop for each content_block.
           #
-          # Example: "decidim/votings/content_block"
+          # Example: "decidim/participatory_processes/content_block"
           def resource_content_block_cell
             raise "#{self.class.name} is expected to implement #resource_content_block_cell"
           end