decidim-initiatives 0.30.1 → 0.31.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ad28b0cfea28f4d830bf95568ab582724bcdbc1728324682563641dc6661659
-  data.tar.gz: d9df8a436ac7e96d054a8e671d9222c189548ff5d13e7611f09de59b98e6d3c7
+  metadata.gz: 938f0ef2756f0b21f9464216de3219c671e1183611534478f23f9f03893ff81c
+  data.tar.gz: 998542924f4e689283c8040bb93a7d61a56164f08505335a2ff48eb8be8b60d0
 SHA512:
-  metadata.gz: ef8c8f15fefc52409d43f835fbd916e930bd50da374f8bb992b27b5ee9befdf5be4eb54838c184b2172722dcc9b4b948ddaa580f01f5a8df87e553bd7eea7757
-  data.tar.gz: 76eaa09b671474bbba100bd213f3fb3ba52187db7fb3f8d5b67e78ab31acd05a1c6426620023ba9ce37b62be7a461d032c8e71d1112fc4ae674c96a6338dcff7
+  metadata.gz: 150394f29d155746875ea2d5c5de8ebb3deb8c42d9ce61cd3b53d20bca5ef452f924bbb2d3a8bf9d0ec11f1e1a10f9ab44b8a5990e32a6fe51d0d01be4b8eea1
+  data.tar.gz: 12350432841a97cc14267d54a7c65633c9eaa78547fece5971416a62fe1a42b5797e3b26cc8f17d53b280fe3ce3ed9145edf20562f8714f4b64c762484217c5b

data/README.md

@@ -44,30 +44,67 @@ CREATE EXTENSION pg_trgm;
 
 ## Deactivating authorization requirement and other module settings
 
-Some of the settings of the module need to be set in the code of your app, for example in the file `config/initializers/decidim.rb`.
+Some of the settings of the module need to be set in the code of your app using the [environment variables](https://docs.decidim.org/en/develop/configure/environment_variables)
 
 This is the case if you want to enable the creation of initiatives even when no authorization method is set.
 
-Just use the following line:
+Just set the following environment variable:
 
-```ruby
-Decidim::Initiatives.do_not_require_authorization = true
+```bash
+export INITIATIVES_DO_NOT_REQUIRE_AUTHORIZATION=true
 ```
 
-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 exporting the following variable:
+
+```bash
+export INITIATIVES_MINIMUM_COMMITTEE_MEMBERS=1
+```
 
-For example, you can also change the minimum number of required committee members to 1 (default is 2) by adding this line:
+Or change the number of days given to gather signatures to 365 (default is 120) with:
 
 ```ruby
-Decidim::Initiatives.minimum_committee_members = 1
+export INITIATIVES_DEFAULT_SIGNATURE_TIME_PERIOD_LENGTH=365
 ```
 
-Or change the number of days given to gather signatures to 365 (default is 120) with:
+### Initiatives signatures
+
+Different signature workflows can be registered in the code of your app and used in the signature workflow settings of signatures types. A signature workflow defines some options of the signature steps and the form objects and commands responsible for validating and managing the data provided by the users.
+
+To define a signature workflow create an initializer in your application and register it. For example, in `config/initializers/decidim_initiatives.rb`:
 
 ```ruby
-Decidim::Initiatives.default_signature_time_period_length = 365
+Decidim::Initiatives::Signatures.register_workflow(:dummy_signature_handler) do |workflow|
+  workflow.form = "DummySignatureHandler"
+  workflow.authorization_handler_form = "DummyAuthorizationHandler"
+  workflow.action_authorizer = "DummySignatureHandler::DummySignatureActionAuthorizer"
+  workflow.promote_authorization_validation_errors = true
+  workflow.sms_verification = true
+  workflow.sms_mobile_phone_validator = "DummySmsMobilePhoneValidator"
+end
+
+Decidim::Initiatives::Signatures.register_workflow(:ephemeral_dummy_signature_handler) do |workflow|
+  workflow.form = "DummySignatureHandler"
+  workflow.ephemeral = true
+  workflow.authorization_handler_form = "DummyAuthorizationHandler"
+  workflow.action_authorizer = "DummySignatureHandler::DummySignatureActionAuthorizer"
+  workflow.promote_authorization_validation_errors = true
+  workflow.sms_verification = false
+end
+
+Decidim::Initiatives::Signatures.register_workflow(:legacy_signature_handler) do |workflow|
+  workflow.form = "Decidim::Initiatives::LegacySignatureHandler"
+  workflow.authorization_handler_form = "DummyAuthorizationHandler"
+  workflow.save_authorizations = false
+  workflow.sms_verification = true
+end
 ```
 
+All the attributes of a workflow are optional except the registered name with which the workflow is registered. A flow without attributes uses default values that generate a direct signature process without steps.
+
+Signature workflows can be defined as ephemeral, in which case users can sign initiatives without prior registration. For a workflow of this type to work correctly, an authorization handler form must be defined in `authorization_handler_form` and authorizations saving must not be disabled using the `save_authorizations` setting, in order to ensure that user verifications are saved based on the personal data they provide.
+
+For more information about the definition of a signature workflow read the documentation of `Decidim::Initiatives::SignatureWorkflowManifest` and `Decidim::Initiatives::SignatureHandler`
+
 ## Rake tasks
 
 This engine comes with three rake tasks that should be executed on daily basis. The best

data/app/cells/decidim/initiatives/content_blocks/highlighted_initiatives_settings_form/show.erb

@@ -1,4 +1,9 @@
 <% form.fields_for :settings, form.object.settings do |settings_fields| %>
-  <%= settings_fields.number_field :max_results, label: max_results_label %>
-  <%= settings_fields.select :order, order_select, prompt: "", label: order_label %>
+  <div class="row column">
+    <%= settings_fields.number_field :max_results, label: max_results_label %>
+  </div>
+
+  <div class="row column">
+    <%= settings_fields.select :order, order_select, prompt: "", label: order_label %>
+  </div>
 <% end %>

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

@@ -8,7 +8,11 @@ module Decidim
       private
 
       def resource_path
-        Decidim::Initiatives::Engine.routes.url_helpers.initiative_path(model)
+        if resource.state == "created" || resource.state == "validating"
+          Decidim::Initiatives::Engine.routes.url_helpers.load_initiative_draft_create_initiative_index_path(initiative_id: resource.id)
+        else
+          Decidim::Initiatives::Engine.routes.url_helpers.initiative_path(model)
+        end
       end
 
       def image

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

@@ -42,11 +42,7 @@ module Decidim
         attr_reader :initiative, :current_user
 
         def increment_score
-          if initiative.user_group
-            Decidim::Gamification.increment_score(initiative.user_group, :initiatives)
-          else
-            Decidim::Gamification.increment_score(initiative.author, :initiatives)
-          end
+          Decidim::Gamification.increment_score(initiative.author, :initiatives)
         end
       end
     end

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

@@ -37,8 +37,7 @@ module Decidim
         def attributes
           attrs = {
             title: form.title,
-            description: form.description,
-            hashtag: form.hashtag
+            description: form.description
           }
 
           if form.signature_type_updatable?

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

@@ -91,7 +91,6 @@ module Decidim
           author: current_user,
           scoped_type:,
           signature_type: form.type.signature_type,
-          decidim_user_group_id: form.decidim_user_group_id,
           decidim_area_id: form.area_id,
           state: "created"
         )

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

@@ -76,9 +76,7 @@ module Decidim
       def attributes
         attrs = {
           title: { current_locale => form.title },
-          description: { current_locale => form.description },
-          hashtag: form.hashtag,
-          decidim_user_group_id: form.decidim_user_group_id
+          description: { current_locale => form.description }
         }
 
         if form.signature_type_updatable?

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

@@ -28,7 +28,6 @@ module Decidim
 
         percentage_after = initiative.reload.percentage
 
-        send_notification
         notify_percentage_change(percentage_before, percentage_after)
         notify_support_threshold_reached(percentage_before, percentage_after)
 
@@ -46,7 +45,7 @@ module Decidim
       def create_votes
         @votes = form.authorized_scopes.map do |scope|
           initiative.votes.create!(
-            author: form.signer,
+            author: form.user,
             encrypted_metadata: form.encrypted_metadata,
             timestamp:,
             hash_id: form.hash_id,
@@ -65,15 +64,6 @@ module Decidim
         @timestamp_service ||= Decidim.timestamp_service.to_s.safe_constantize
       end
 
-      def send_notification
-        Decidim::EventsManager.publish(
-          event: "decidim.events.initiatives.initiative_endorsed",
-          event_class: Decidim::Initiatives::EndorseInitiativeEvent,
-          resource: initiative,
-          followers: initiative.author.followers
-        )
-      end
-
       def notify_percentage_change(before, after)
         percentage = [25, 50, 75, 100].find do |milestone|
           before < milestone && after >= milestone

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  module Initiatives
+    # This concern is used to detect the form associated with the signature
+    # workflow. If the manifest cannot be found the base SignatureHandler is
+    # used.
+    module HasSignatureWorkflow
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :signature_has_steps?, :ephemeral_signature_workflow?
+
+        delegate :signature_form_class, :sms_mobile_phone_form_class, :sms_mobile_phone_validator_class, :sms_code_validator_class, to: :signature_workflow_manifest
+
+        def ephemeral_signature_workflow?
+          signature_workflow_manifest.ephemeral
+        end
+
+        private
+
+        def signature_workflow_manifest
+          @signature_workflow_manifest ||= current_initiative.type.signature_workflow_manifest || Decidim::Initiatives::SignatureWorkflowManifest.new
+        end
+
+        def signature_has_steps?
+          return unless current_initiative
+
+          signature_workflow_manifest.sms_verification || signature_form_class.requires_extra_attributes?
+        end
+      end
+    end
+  end
+end

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

@@ -23,7 +23,7 @@ module Decidim
         include NeedsOrganization
         include InitiativeSlug
 
-        helper_method :current_initiative, :current_participatory_space, :signature_has_steps?
+        helper_method :current_initiative, :current_participatory_space
 
         # Public: Finds the current Initiative given this controller's
         # context.
@@ -35,17 +35,6 @@ module Decidim
 
         alias_method :current_participatory_space, :current_initiative
 
-        # 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
-        def signature_has_steps?
-          return unless current_initiative
-
-          initiative_type = current_initiative.scoped_type.type
-          initiative_type.collect_user_extra_fields? || initiative_type.validate_sms_code_on_votes?
-        end
-
         private
 
         def detect_initiative

data/app/controllers/decidim/initiatives/admin/initiatives_controller.rb

@@ -56,7 +56,7 @@ module Decidim
 
             on(:invalid) do
               flash.now[:alert] = I18n.t("initiatives.update.error", scope: "decidim.initiatives.admin")
-              render :edit, layout: "decidim/admin/initiative"
+              render :edit, layout: "decidim/admin/initiative", status: :unprocessable_entity
             end
           end
         end
@@ -172,7 +172,7 @@ module Decidim
 
           @votes = current_initiative.votes
 
-          serializer = Decidim::Forms::UserAnswersSerializer
+          serializer = Decidim::Forms::UserResponsesSerializer
           pdf_export = Decidim::Exporters::InitiativeVotesPDF.new(@votes, current_initiative, serializer).export
 
           output = if pdf_signature_service

data/app/controllers/decidim/initiatives/admin/initiatives_settings_controller.rb

@@ -31,7 +31,7 @@ module Decidim
 
             on(:invalid) do
               flash.now[:alert] = I18n.t("initiatives_settings.update.error", scope: "decidim.admin")
-              render :edit
+              render :edit, status: :unprocessable_entity
             end
           end
         end

data/app/controllers/decidim/initiatives/admin/initiatives_type_scopes_controller.rb

@@ -32,7 +32,7 @@ module Decidim
 
             on(:invalid) do
               flash.now[:alert] = I18n.t("decidim.initiatives.admin.initiatives_type_scopes.create.error")
-              render :new
+              render :new, status: :unprocessable_entity
             end
           end
         end
@@ -56,7 +56,7 @@ module Decidim
 
             on(:invalid) do
               flash.now[:alert] = I18n.t("decidim.initiatives.admin.initiatives_type_scopes.update.error")
-              render :edit
+              render :edit, status: :unprocessable_entity
             end
           end
         end

data/app/controllers/decidim/initiatives/admin/initiatives_types_controller.rb

@@ -40,7 +40,7 @@ module Decidim
 
             on(:invalid) do
               flash.now[:alert] = I18n.t("decidim.initiatives.admin.initiatives_types.create.error")
-              render :new
+              render :new, status: :unprocessable_entity
             end
           end
         end
@@ -68,7 +68,7 @@ module Decidim
 
             on(:invalid) do
               flash.now[:alert] = I18n.t("decidim.initiatives.admin.initiatives_types.update.error")
-              render :edit
+              render :edit, status: :unprocessable_entity
             end
           end
         end

data/app/controllers/decidim/initiatives/committee_requests_controller.rb

@@ -46,7 +46,7 @@ module Decidim
 
         ApproveMembershipRequest.call(membership_request) do
           on(:ok) do
-            redirect_to edit_initiative_path(current_initiative), flash: {
+            redirect_to redirect_page, flash: {
               notice: I18n.t("success", scope: "decidim.initiatives.committee_requests.approve")
             }
           end
@@ -59,7 +59,7 @@ module Decidim
 
         RevokeMembershipRequest.call(membership_request) do
           on(:ok) do
-            redirect_to edit_initiative_path(current_initiative), flash: {
+            redirect_to redirect_page, flash: {
               notice: I18n.t("success", scope: "decidim.initiatives.committee_requests.revoke")
             }
           end
@@ -68,6 +68,14 @@ module Decidim
 
       private
 
+      def redirect_page
+        if request.referer&.include?("create_initiative")
+          promotal_committee_create_initiative_index_path
+        else
+          edit_initiative_path(current_initiative)
+        end
+      end
+
       def membership_request
         @membership_request ||= InitiativesCommitteeMember.where(initiative: current_participatory_space).find(params[:id])
       end

data/app/controllers/decidim/initiatives/create_initiative_controller.rb

@@ -21,6 +21,8 @@ module Decidim
       helper_method :current_initiative
       helper_method :initiative_type
       helper_method :promotal_committee_required?
+      helper_method :minimum_committee_members
+      helper_method :promoters_committee_members
 
       before_action :authenticate_user!
       before_action :ensure_type_exists,
@@ -29,7 +31,20 @@ module Decidim
                     only: [:fill_data, :store_data, :promotal_committee, :finish]
       before_action :ensure_initiative_exists, only: [:promotal_committee, :finish]
 
+      def load_initiative_draft
+        session[:initiative_id] = params[:initiative_id]
+
+        if current_initiative.validating?
+          redirect_to finish_create_initiative_index_path
+        elsif current_initiative.created?
+          redirect_to promotal_committee_create_initiative_index_path
+        else
+          redirect_to initiatives_path
+        end
+      end
+
       def select_initiative_type
+        session[:initiative_id] = nil
         @form = form(Decidim::Initiatives::SelectInitiativeTypeForm).from_params(params)
 
         redirect_to fill_data_create_initiative_index_path if single_initiative_type?
@@ -56,34 +71,70 @@ module Decidim
       end
 
       def store_data
+        if current_initiative
+          store_data_update_initiative
+        else
+          store_data_create_initiative
+        end
+      end
+
+      def promotal_committee
+        redirect_to finish_create_initiative_index_path unless promotal_committee_required?
+      end
+
+      def finish
+        current_initiative.presence
+
+        if current_initiative.validating?
+          session[:type_id] = nil
+          session[:initiative_id] = nil
+        end
+      end
+
+      private
+
+      def store_data_create_initiative
         @form = form(Decidim::Initiatives::InitiativeForm).from_params(params, { initiative_type: })
 
         CreateInitiative.call(@form) do
           on(:ok) do |initiative|
             session[:initiative_id] = initiative.id
 
-            path = promotal_committee_required? ? "promotal_committee" : "finish"
-
-            redirect_to send(:"#{path}_create_initiative_index_path")
+            redirect_to store_data_next_step
           end
 
           on(:invalid) do
-            render :fill_data
+            render :fill_data, status: :unprocessable_entity
           end
         end
       end
 
-      def promotal_committee
-        redirect_to finish_create_initiative_index_path unless promotal_committee_required?
+      def store_data_update_initiative
+        @form = form(Decidim::Initiatives::InitiativeForm).from_params(params, initiative_type: current_initiative.type, initiative: current_initiative)
+
+        UpdateInitiative.call(current_initiative, @form) do
+          on(:ok) do
+            flash[:notice] = I18n.t("success", scope: "decidim.initiatives.update")
+            redirect_to store_data_next_step
+          end
+
+          on(:invalid) do
+            render :fill_data, status: :unprocessable_entity
+          end
+        end
       end
 
-      def finish
-        current_initiative.presence
-        session[:type_id] = nil
-        session[:initiative_id] = nil
+      def store_data_next_step
+        if promotal_committee_required?
+          promotal_committee_create_initiative_index_path
+        else
+          finish_create_initiative_index_path
+        end
       end
 
-      private
+      def membership_request
+        @membership_request ||= current_initiative.committee_members.find(params[:committee_member_id])
+      end
 
       def ensure_user_can_create_initiative
         enforce_permission_to :create, :initiative, { initiative_type: }
@@ -119,20 +170,35 @@ module Decidim
       end
 
       def current_initiative
-        @current_initiative ||= Initiative.where(organization: current_organization).find_by(id: session[:initiative_id] || nil)
+        @current_initiative ||= Initiative.where(organization: current_organization, author: current_user).find_by(id: session[:initiative_id] || nil)
+      end
+
+      def initiative_types
+        @initiative_types ||= InitiativesType.where(organization: current_organization)
       end
 
       def initiative_type
-        @initiative_type ||= InitiativesType.where(organization: current_organization).find_by(id: initiative_type_id)
+        @initiative_type ||= initiative_types.find_by(id: initiative_type_id)
       end
 
       def promotal_committee_required?
-        return false if initiative_type.blank?
-        return false unless initiative_type.promoting_committee_enabled?
+        if initiative_type.present?
+          initiative_type.promoting_committee_enabled? && minimum_committee_members.positive?
+        else
+          initiative_types.all?(&:promoting_committee_enabled?)
+        end
+      end
+
+      def minimum_committee_members
+        @minimum_committee_members ||= if initiative_type.blank? || !initiative_type.promoting_committee_enabled?
+                                         0
+                                       else
+                                         initiative_type.minimum_committee_members || Decidim::Initiatives.minimum_committee_members
+                                       end
+      end
 
-        minimum_committee_members = initiative_type.minimum_committee_members ||
-                                    Decidim::Initiatives.minimum_committee_members
-        minimum_committee_members.present? && minimum_committee_members.positive?
+      def promoters_committee_members
+        @promoters_committee_members ||= current_initiative.committee_members.approved
       end
     end
   end