decidim-initiatives 0.28.5 → 0.29.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 385f59fc013f222a12e84ea61d1d07e2b89e35ddd948e9c2c296fca9d451a94e
-  data.tar.gz: 18a6a641473cb761c30337e9fe87c9995fd55e94b6db0d7127dac6021ae8da4a
+  metadata.gz: cd08d9cd4c6c2cb8076f7c9b161dbbd6c2ed330e8cd2a5a76d5f111ebe64b51a
+  data.tar.gz: 42b081ca2e2c766cec299f9f8c23035a250c3a4313602572e60ec85ade2ef707
 SHA512:
-  metadata.gz: cc8356303d54a4f5ba5d8b48a388a1cd56ffdf337cbac9f8e577e79b6b676b9edaf0d9862f5deb3c0e8f0aeb4ba87a8dfbae75104df9eaaf6573f3783e2db600
-  data.tar.gz: 86dc4362c15cd2e458c19cf11f36d2a56e00346a30360ef7bab24ddc980400da4f1cf248345714d27ee95fc3306017522a9f8d5a88ccba80a4a4ee7dc4171948
+  metadata.gz: 79b0beb868ad7316b8d28e15172f4c7326f3b7793614bcc4be2a807c8bbd1d88776e9dc19fff7e73d556c68a82222972706d6911fb55441080c7ba2f9b0704de
+  data.tar.gz: '09312dad53e48a78893d965e23bb2dc4415667c765c1a77e39907756d4e3827202e3b9ee6c16a749633a7d907e1fda46aa1f5f3172bd46c524c41461468093c8'

data/README.md

@@ -54,7 +54,7 @@ Just use the following line:
 Decidim::Initiatives.do_not_require_authorization = true
 ```
 
-All the settings and their default values which can be overriden can be found in the file [`lib/decidim/initiatives.rb`](https://github.com/decidim/decidim/blob/develop/decidim-initiatives/lib/decidim/initiatives.rb).
+All the settings and their default values which can be overridden can be found in the file [`lib/decidim/initiatives.rb`](https://github.com/decidim/decidim/blob/develop/decidim-initiatives/lib/decidim/initiatives.rb).
 
 For example, you can also change the minimum number of required committee members to 1 (default is 2) by adding this line:
 
@@ -125,7 +125,7 @@ In order to populate the database with example data proceed as usual in rails:
 bundle exec rails db:seed
 ```
 
-## Aditional considerations
+## Additional considerations
 
 ### Cookies
 

data/app/cells/decidim/initiatives/initiative_g_cell.rb

@@ -11,14 +11,16 @@ module Decidim
         Decidim::Initiatives::Engine.routes.url_helpers.initiative_path(model)
       end
 
+      def has_image?
+        image.present?
+      end
+
       def image
         @image ||= model.attachments.find(&:image?)
       end
 
-      def resource_image_url
-        return if image.blank?
-
-        image.url
+      def resource_image_path
+        image.url if has_image?
       end
 
       def metadata_cell

data/app/cells/decidim/initiatives_votes/vote_cell.rb

@@ -3,8 +3,6 @@
 module Decidim
   module InitiativesVotes
     class VoteCell < Decidim::ViewModel
-      include Decidim::SanitizeHelper
-
       delegate :timestamp, :hash_id, to: :model
 
       def show
@@ -16,7 +14,7 @@ module Decidim
       end
 
       def initiative_title
-        decidim_sanitize(translated_attribute(model.initiative.title))
+        decidim_sanitize_translated(model.initiative.title)
       end
 
       def name_and_surname

data/app/commands/decidim/initiatives/admin/create_initiative_type.rb

@@ -4,67 +4,18 @@ module Decidim
   module Initiatives
     module Admin
       # A command with all the business logic that creates a new initiative type
-      class CreateInitiativeType < Decidim::Command
-        # Public: Initializes the command.
-        #
-        # form - A form object with the params.
-        def initialize(form, user)
-          @form = form
-          @user = user
-        end
+      class CreateInitiativeType < Decidim::Commands::CreateResource
+        fetch_file_attributes :banner_image
 
-        # 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?
+        fetch_form_attributes :title, :description, :signature_type, :comments_enabled, :attachments_enabled,
+                              :undo_online_signatures_enabled, :custom_signature_end_date_enabled, :area_enabled,
+                              :promoting_committee_enabled, :minimum_committee_members, :collect_user_extra_fields,
+                              :extra_fields_legal_information, :validate_sms_code_on_votes, :document_number_authorization_handler,
+                              :child_scope_threshold_enabled, :only_global_scope_enabled, :organization
 
-          initiative_type = create_initiative_type
+        protected
 
-          if initiative_type.persisted?
-            broadcast(:ok, initiative_type)
-          else
-            form.errors.add(:banner_image, initiative_type.errors[:banner_image]) if initiative_type.errors.include? :banner_image
-            broadcast(:invalid)
-          end
-        end
-
-        private
-
-        attr_reader :form
-
-        def create_initiative_type
-          initiative_type = Decidim.traceability.create!(
-            InitiativesType,
-            @user,
-            organization: form.current_organization,
-            title: form.title,
-            description: form.description,
-            signature_type: form.signature_type,
-            comments_enabled: form.comments_enabled,
-            attachments_enabled: form.attachments_enabled,
-            undo_online_signatures_enabled: form.undo_online_signatures_enabled,
-            custom_signature_end_date_enabled: form.custom_signature_end_date_enabled,
-            area_enabled: form.area_enabled,
-            promoting_committee_enabled: form.promoting_committee_enabled,
-            minimum_committee_members: form.minimum_committee_members,
-            banner_image: form.banner_image,
-            collect_user_extra_fields: form.collect_user_extra_fields,
-            extra_fields_legal_information: form.extra_fields_legal_information,
-            validate_sms_code_on_votes: form.validate_sms_code_on_votes,
-            document_number_authorization_handler: form.document_number_authorization_handler,
-            child_scope_threshold_enabled: form.child_scope_threshold_enabled,
-            only_global_scope_enabled: form.only_global_scope_enabled
-          )
-
-          return initiative_type unless initiative_type.valid?
-
-          initiative_type.save
-          initiative_type
-        end
+        def resource_class = Decidim::InitiativesType
       end
     end
   end

data/app/commands/decidim/initiatives/admin/create_initiative_type_scope.rb

@@ -4,52 +4,14 @@ module Decidim
   module Initiatives
     module Admin
       # A command with all the business logic that creates a new initiative type scope
-      class CreateInitiativeTypeScope < Decidim::Command
-        # Public: Initializes the command.
-        #
-        # form - A form object with the params.
-        def initialize(form)
-          @form = form
-        end
+      class CreateInitiativeTypeScope < Decidim::Commands::CreateResource
+        protected
 
-        # 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?
+        fetch_form_attributes :supports_required, :decidim_scopes_id
 
-          initiative_type_scope = create_initiative_type_scope
+        def attributes = super.merge(decidim_initiatives_types_id: form.context.type_id)
 
-          if initiative_type_scope.persisted?
-            broadcast(:ok, initiative_type_scope)
-          else
-            initiative_type_scope.errors.each do |error|
-              form.errors.add(error.attribute, error.message)
-            end
-
-            broadcast(:invalid)
-          end
-        end
-
-        private
-
-        attr_reader :form
-
-        def create_initiative_type_scope
-          initiative_type = InitiativesTypeScope.new(
-            supports_required: form.supports_required,
-            decidim_scopes_id: form.decidim_scopes_id,
-            decidim_initiatives_types_id: form.context.type_id
-          )
-
-          return initiative_type unless initiative_type.valid?
-
-          initiative_type.save
-          initiative_type
-        end
+        def resource_class = Decidim::InitiativesTypeScope
       end
     end
   end

data/app/commands/decidim/initiatives/admin/update_initiative.rb

@@ -5,51 +5,34 @@ module Decidim
     module Admin
       # A command with all the business logic that updates an
       # existing initiative.
-      class UpdateInitiative < Decidim::Command
+      class UpdateInitiative < Decidim::Commands::UpdateResource
         include Decidim::Initiatives::AttachmentMethods
 
-        # Public: Initializes the command.
-        #
-        # initiative - Decidim::Initiative
-        # form       - A form object with the params.
-        def initialize(initiative, form, current_user)
-          @form = form
-          @initiative = initiative
-          @current_user = current_user
-          @attached_to = initiative
-        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
 
-          if process_attachments?
-            @initiative.attachments.destroy_all
+        attr_reader :attachment
 
-            build_attachment
-            return broadcast(:invalid) if attachment_invalid?
-          end
+        def update_resource
+          super
+        rescue ActiveRecord::RecordInvalid
+          raise Decidim::Commands::HookError
+        end
 
-          @initiative = Decidim.traceability.update!(
-            initiative,
-            current_user,
-            attributes
-          )
+        def run_after_hooks
           create_attachment if process_attachments?
           notify_initiative_is_extended if @notify_extended
-          broadcast(:ok, initiative)
-        rescue ActiveRecord::RecordInvalid
-          broadcast(:invalid, initiative)
         end
 
-        private
+        def run_before_hooks
+          return unless process_attachments?
+
+          resource.attachments.destroy_all
 
-        attr_reader :form, :initiative, :current_user, :attachment
+          @attached_to = resource
+
+          build_attachment
+          raise Decidim::Commands::HookError if attachment_invalid?
+        end
 
         def attributes
           attrs = {
@@ -65,9 +48,9 @@ module Decidim
 
           if current_user.admin?
             add_admin_accessible_attrs(attrs)
-          elsif initiative.created?
-            attrs[:signature_end_date] = form.signature_end_date if initiative.custom_signature_end_date_enabled?
-            attrs[:decidim_area_id] = form.area_id if initiative.area_enabled?
+          elsif resource.created?
+            attrs[:signature_end_date] = form.signature_end_date if resource.custom_signature_end_date_enabled?
+            attrs[:decidim_area_id] = form.area_id if resource.area_enabled?
           end
 
           attrs
@@ -80,8 +63,8 @@ module Decidim
           attrs[:state] = form.state if form.state
           attrs[:decidim_area_id] = form.area_id
 
-          if initiative.published? && form.signature_end_date != initiative.signature_end_date &&
-             form.signature_end_date > initiative.signature_end_date
+          if resource.published? && form.signature_end_date != resource.signature_end_date &&
+             form.signature_end_date > resource.signature_end_date
             @notify_extended = true
           end
         end
@@ -90,8 +73,8 @@ module Decidim
           Decidim::EventsManager.publish(
             event: "decidim.events.initiatives.initiative_extended",
             event_class: Decidim::Initiatives::ExtendInitiativeEvent,
-            resource: initiative,
-            followers: initiative.followers - [initiative.author]
+            resource:,
+            followers: resource.followers - [resource.author]
           )
         end
       end

data/app/commands/decidim/initiatives/admin/update_initiative_answer.rb

@@ -6,15 +6,14 @@ module Decidim
       # A command with all the business logic to answer
       # initiatives.
       class UpdateInitiativeAnswer < Decidim::Command
+        delegate :current_user, to: :form
         # Public: Initializes the command.
         #
         # initiative   - Decidim::Initiative
         # form         - A form object with the params.
-        # current_user - Decidim::User
-        def initialize(initiative, form, current_user)
+        def initialize(initiative, form)
           @form = form
           @initiative = initiative
-          @current_user = current_user
         end
 
         # Executes the command. Broadcasts these events:
@@ -39,7 +38,7 @@ module Decidim
 
         private
 
-        attr_reader :form, :initiative, :current_user
+        attr_reader :form, :initiative
 
         def attributes
           attrs = {

data/app/commands/decidim/initiatives/admin/update_initiative_type.rb

@@ -5,70 +5,20 @@ module Decidim
     module Admin
       # A command with all the business logic that updates an
       # existing initiative type.
-      class UpdateInitiativeType < Decidim::Command
-        include ::Decidim::AttachmentAttributesMethods
+      class UpdateInitiativeType < Decidim::Commands::UpdateResource
+        fetch_file_attributes :banner_image
 
-        # Public: Initializes the command.
-        #
-        # initiative_type: Decidim::InitiativesType
-        # form - A form object with the params.
-        def initialize(initiative_type, form, user)
-          @form = form
-          @initiative_type = initiative_type
-          @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?
-
-          Decidim.traceability.perform_action!("update", initiative_type, @user) do
-            initiative_type.update(attributes)
+        fetch_form_attributes :title, :description, :signature_type, :attachments_enabled, :comments_enabled,
+                              :undo_online_signatures_enabled, :custom_signature_end_date_enabled, :area_enabled,
+                              :promoting_committee_enabled, :minimum_committee_members, :collect_user_extra_fields,
+                              :extra_fields_legal_information, :validate_sms_code_on_votes, :document_number_authorization_handler,
+                              :child_scope_threshold_enabled, :only_global_scope_enabled
 
-            if initiative_type.valid?
-              update_initiatives_signature_type
-              broadcast(:ok, initiative_type)
-            else
-              broadcast(:invalid)
-            end
-          end
-        end
-
-        private
-
-        attr_reader :form, :initiative_type
-
-        def attributes
-          {
-            title: form.title,
-            description: form.description,
-            signature_type: form.signature_type,
-            attachments_enabled: form.attachments_enabled,
-            comments_enabled: form.comments_enabled,
-            undo_online_signatures_enabled: form.undo_online_signatures_enabled,
-            custom_signature_end_date_enabled: form.custom_signature_end_date_enabled,
-            area_enabled: form.area_enabled,
-            promoting_committee_enabled: form.promoting_committee_enabled,
-            minimum_committee_members: form.minimum_committee_members,
-            collect_user_extra_fields: form.collect_user_extra_fields,
-            extra_fields_legal_information: form.extra_fields_legal_information,
-            validate_sms_code_on_votes: form.validate_sms_code_on_votes,
-            document_number_authorization_handler: form.document_number_authorization_handler,
-            child_scope_threshold_enabled: form.child_scope_threshold_enabled,
-            only_global_scope_enabled: form.only_global_scope_enabled
-          }.merge(
-            attachment_attributes(:banner_image)
-          )
-        end
+        protected
 
-        def update_initiatives_signature_type
-          initiative_type.initiatives.signature_type_updatable.each do |initiative|
-            initiative.update!(signature_type: initiative_type.signature_type)
+        def run_after_hooks
+          resource.initiatives.signature_type_updatable.each do |initiative|
+            initiative.update!(signature_type: resource.signature_type)
           end
         end
       end

data/app/commands/decidim/initiatives/admin/update_initiative_type_scope.rb

@@ -5,39 +5,8 @@ module Decidim
     module Admin
       # A command with all the business logic that updates an
       # existing initiative type scope.
-      class UpdateInitiativeTypeScope < Decidim::Command
-        # Public: Initializes the command.
-        #
-        # initiative_type: Decidim::InitiativesTypeScope
-        # form - A form object with the params.
-        def initialize(initiative_type_scope, form)
-          @form = form
-          @initiative_type_scope = initiative_type_scope
-        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?
-
-          initiative_type_scope.update(attributes)
-          broadcast(:ok, initiative_type_scope)
-        end
-
-        private
-
-        attr_reader :form, :initiative_type_scope
-
-        def attributes
-          {
-            supports_required: form.supports_required,
-            decidim_scopes_id: form.decidim_scopes_id
-          }
-        end
+      class UpdateInitiativeTypeScope < Decidim::Commands::UpdateResource
+        fetch_form_attributes :supports_required, :decidim_scopes_id
       end
     end
   end

data/app/commands/decidim/initiatives/admin/update_initiatives_settings.rb

@@ -5,41 +5,8 @@ module Decidim
     module Admin
       # A command with all the business logic when updating initiatives
       # settings in admin area.
-      class UpdateInitiativesSettings < Decidim::Command
-        # Public: Initializes the command.
-        #
-        # initiatives_settings - A initiatives settings object to update.
-        # form - A form object with the params.
-        def initialize(initiatives_settings, form)
-          @initiatives_settings = initiatives_settings
-          @form = form
-        end
-
-        # Executes the command. Broadcasts these events:
-        #
-        # - :ok when everything is valid.
-        # - :invalid if the form or initiatives_settings is not valid and we could not proceed.
-        #
-        # Returns nothing.
-        def call
-          return broadcast(:invalid) if form.invalid? || initiatives_settings.invalid?
-
-          update_initiatives_settings!
-
-          broadcast(:ok)
-        end
-
-        private
-
-        attr_reader :form, :initiatives_settings
-
-        def update_initiatives_settings!
-          Decidim.traceability.update!(
-            @initiatives_settings,
-            form.current_user,
-            initiatives_order: form.initiatives_order
-          )
-        end
+      class UpdateInitiativesSettings < Decidim::Commands::UpdateResource
+        fetch_form_attributes :initiatives_order
       end
     end
   end

data/app/commands/decidim/initiatives/approve_membership_request.rb

@@ -32,7 +32,7 @@ module Decidim
           resource: @membership_request.initiative,
           affected_users: [@membership_request.user],
           force_send: true,
-          extra: { author: { id: @membership_request.initiative.author&.id } }
+          extra: { author: @membership_request.initiative.author }
         )
       end
     end

data/app/commands/decidim/initiatives/create_initiative.rb

@@ -10,13 +10,12 @@ module Decidim
       include ::Decidim::MultipleAttachmentsMethods
       include ::Decidim::GalleryMethods
 
+      delegate :current_user, to: :form
       # Public: Initializes the command.
       #
       # form - A form object with the params.
-      # current_user - Current user.
-      def initialize(form, current_user)
+      def initialize(form)
         @form = form
-        @current_user = current_user
       end
 
       # Executes the command. Broadcasts these events:
@@ -49,7 +48,7 @@ module Decidim
 
       private
 
-      attr_reader :form, :current_user, :attachment
+      attr_reader :form, :attachment
 
       # Creates the initiative and all default components
       def create_initiative
@@ -87,7 +86,7 @@ module Decidim
       end
 
       def scoped_type
-        InitiativesTypeScope.order(:id).find_by(type: form.type, scope: form.scope)
+        InitiativesTypeScope.order(:id).find_by(type: form.type)
       end
 
       def signature_end_date
@@ -138,7 +137,7 @@ module Decidim
                  current_user:
                )
 
-        Decidim::CreateFollow.new(form, current_user).call
+        Decidim::CreateFollow.new(form).call
       end
 
       def add_author_as_committee_member(initiative)
@@ -149,7 +148,7 @@ module Decidim
                  current_user:
                )
 
-        Decidim::Initiatives::SpawnCommitteeRequest.new(form, current_user).call
+        Decidim::Initiatives::SpawnCommitteeRequest.new(form).call
       end
     end
   end

data/app/commands/decidim/initiatives/revoke_membership_request.rb

@@ -32,7 +32,7 @@ module Decidim
           resource: @membership_request.initiative,
           affected_users: [@membership_request.user],
           force_send: true,
-          extra: { author: { id: @membership_request.initiative.author&.id } }
+          extra: { author: @membership_request.initiative.author }
         )
       end
     end

data/app/commands/decidim/initiatives/spawn_committee_request.rb

@@ -5,13 +5,12 @@ module Decidim
     # A command with all the business logic that creates a new membership
     # request for the committee of an initiative.
     class SpawnCommitteeRequest < Decidim::Command
+      delegate :current_user, to: :form
       # Public: Initializes the command.
       #
       # form - Decidim::Initiative::CommitteeMemberForm
-      # current_user - Decidim::User
-      def initialize(form, current_user)
+      def initialize(form)
         @form = form
-        @current_user = current_user
       end
 
       # Executes the command. Broadcasts these events:
@@ -35,7 +34,7 @@ module Decidim
 
       private
 
-      attr_reader :form, :current_user
+      attr_reader :form
 
       def create_request
         request = InitiativesCommitteeMember.new(
@@ -58,7 +57,7 @@ module Decidim
           resource: initiative,
           affected_users: [initiative.author],
           force_send: true,
-          extra: { applicant: { id: current_user&.id } }
+          extra: { applicant: current_user }
         )
       end
 

data/app/commands/decidim/initiatives/update_initiative.rb

@@ -8,15 +8,15 @@ module Decidim
       include ::Decidim::MultipleAttachmentsMethods
       include ::Decidim::GalleryMethods
       include CurrentLocale
+      delegate :current_user, to: :form
 
       # Public: Initializes the command.
       #
       # initiative - Decidim::Initiative
       # form       - A form object with the params.
-      def initialize(initiative, form, current_user)
+      def initialize(initiative, form)
         @form = form
         @initiative = initiative
-        @current_user = current_user
         @attached_to = initiative
       end
 
@@ -57,7 +57,7 @@ module Decidim
 
       private
 
-      attr_reader :form, :initiative, :current_user
+      attr_reader :form, :initiative
 
       def attributes
         attrs = {

data/app/commands/decidim/initiatives/validate_sms_code.rb

@@ -15,7 +15,7 @@ module Decidim
 
       # Executes the command. Broadcasts these events:
       #
-      # - :ok when everithing is valid.
+      # - :ok when everything is valid.
       # - :invalid if verification_metadata is not present or the form code is
       #            invalid.
       #
@@ -29,11 +29,11 @@ module Decidim
       private
 
       def verification_metadata_valid?
-        @verification_metadata && @verification_metadata["verification_code"].present?
+        @verification_metadata && @verification_metadata[:verification_code].present?
       end
 
       def valid_code?
-        @verification_metadata["verification_code"] == @form.verification_code
+        @verification_metadata[:verification_code] == @form.verification_code
       end
     end
   end

data/app/controllers/concerns/decidim/initiatives/needs_initiative.rb

@@ -35,7 +35,7 @@ module Decidim
 
         alias_method :current_participatory_space, :current_initiative
 
-        # Public: Wether the current initiative belongs to an initiative type
+        # Public: Whether the current initiative belongs to an initiative type
         # which requires one or more step before creating a signature
         #
         # Returns nil if there is no current_initiative, true or false