decidim-forms 0.23.6 → 0.24.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22d31db03a32b73c8aea6bc2fe8d1f4c31e09156db13c9507e7bad3abddc1bfc
-  data.tar.gz: e0bd6174d6b1516268d6da9f96f4c3db806a9861cc56cd6675dd13b52d7e9f88
+  metadata.gz: 1f06c183113352ec8c74d0d958b1f1936a71f81ddd55c890e7254e1480b044f2
+  data.tar.gz: aafe2af6840afd6e2c757916bd44e185bbb2b4474380860e6c0d08641d246cb0
 SHA512:
-  metadata.gz: ff6c2524b6eba8f4f26c568f2c91c2b33d5aa30ea53bbaff4b4e5ff8cf70cc4e7e6612bcd29cdadca20dfc76bc28bd2618867253d4aead32c2cc747731840342
-  data.tar.gz: 684a2b52c6524f6ce2f9abc12e3ecebbf21586254c002bc222e4b294394c21e0bec4217afe9b9f2096954781383624321b84a04c05b6ee219670e29a9d6cc5ef
+  metadata.gz: 5ed91cbe536d809e93dd5a7b4f8723b04d982f25cc98aca21eca9b4a7c4a31d4c7f9c78f9aca9c7eeed8c139bdcc33dee163f0838d84c009f6d8d081585bdaa0
+  data.tar.gz: c0eadff0a39fcd19d392dbc4b49db1c7f0715f378a9e4287e4af562e8a008fcac3dc70c281376c00fb83f02d177cb5f1e5b89376af2cc5921288a56bf202330f

data/app/assets/javascripts/decidim/forms/forms.js.es6

@@ -53,16 +53,16 @@
       window.exitUrl = event.currentTarget.action;
     });
 
-    window.onbeforeunload = () => {
+    window.addEventListener("beforeunload", (event) => {
       const exitUrl = window.exitUrl;
       const hasChanged = $form.data("changed");
       window.exitUrl = null;
 
       if (!hasChanged || (exitUrl && exitUrl.includes(safePath))) {
-        return null;
+        return;
       }
 
-      return "";
-    }
+      event.returnValue = true;
+    });
   }
 })(window);

data/app/commands/decidim/forms/admin/update_questionnaire.rb

@@ -48,7 +48,8 @@ module Decidim
             position: form_question.position,
             mandatory: form_question.mandatory,
             question_type: form_question.question_type,
-            max_choices: form_question.max_choices
+            max_choices: form_question.max_choices,
+            max_characters: form_question.max_characters
           }
 
           update_nested_model(form_question, question_attributes, @questionnaire.questions) do |question|

data/app/commands/decidim/forms/answer_questionnaire.rb

@@ -4,6 +4,8 @@ module Decidim
   module Forms
     # This command is executed when the user answers a Questionnaire.
     class AnswerQuestionnaire < Rectify::Command
+      include ::Decidim::MultipleAttachmentsMethods
+
       # Initializes a AnswerQuestionnaire Command.
       #
       # form - The form from which to get the data.
@@ -21,14 +23,34 @@ module Decidim
         return broadcast(:invalid) if @form.invalid?
 
         answer_questionnaire
-        broadcast(:ok)
+
+        if @errors
+          reset_form_attachments
+          broadcast(:invalid)
+        else
+          broadcast(:ok)
+        end
       end
 
       attr_reader :form
 
       private
 
+      # This method will add an error to the `add_documents` field only if there's
+      # any error in any other field or an error in another answer in the
+      # questionnaire. This is needed because when the form has
+      # an error, the attachments are lost, so we need a way to inform the user
+      # of this problem.
+      def reset_form_attachments
+        @form.responses.each do |answer|
+          answer.errors.add(:add_documents, :needs_to_be_reattached) if answer.has_attachments?
+        end
+      end
+
       def answer_questionnaire
+        @main_form = @form
+        @errors = nil
+
         Answer.transaction do
           form.responses_by_step.flatten.select(&:display_conditions_fulfilled?).each do |form_answer|
             answer = Answer.new(
@@ -51,7 +73,27 @@ module Decidim
             end
 
             answer.save!
+
+            next unless form_answer.question.has_attachments?
+
+            # The attachments module expects `@form` to be the form with the
+            # attachments
+            @form = form_answer
+            @attached_to = answer
+
+            build_attachments
+
+            if attachments_invalid?
+              @errors = true
+              next
+            end
+
+            create_attachments if process_attachments?
+            document_cleanup!
           end
+
+          @form = @main_form
+          raise ActiveRecord::Rollback if @errors
         end
       end
     end

data/app/controllers/decidim/forms/admin/concerns/has_questionnaire.rb

@@ -15,8 +15,10 @@ module Decidim
 
           included do
             helper Decidim::Forms::Admin::ApplicationHelper
+            include Decidim::TranslatableAttributes
+
             helper_method :questionnaire_for, :questionnaire, :blank_question, :blank_answer_option, :blank_matrix_row,
-                          :blank_display_condition, :question_types, :display_condition_types, :update_url, :public_url, :answer_options_url
+                          :blank_display_condition, :question_types, :display_condition_types, :update_url, :public_url, :answer_options_url, :edit_questionnaire_title
 
             if defined? Decidim::Templates::Admin
               include Decidim::Templates::Admin::Concerns::Templatable
@@ -97,7 +99,13 @@ module Decidim
             # Returns the url to get the answer options json (for the display conditions form)
             # for the question with id = params[:id]
             def answer_options_url(params)
-              url_for([questionnaire.questionnaire_for, action: :answer_options, format: :json, **params])
+              url_for([questionnaire.questionnaire_for, { action: :answer_options, format: :json, **params }])
+            end
+
+            # Implement this method in your controller to set the title
+            # of the edit form.
+            def edit_questionnaire_title
+              t(:title, scope: "decidim.forms.admin.questionnaires.form", questionnaire_for: translated_attribute(questionnaire_for.try(:title)))
             end
 
             private

data/app/controllers/decidim/forms/concerns/has_questionnaire.rb

@@ -26,7 +26,7 @@ module Decidim
           end
 
           def answer
-            enforce_permission_to :answer, :questionnaire
+            enforce_permission_to_answer_questionnaire
 
             @form = form(Decidim::Forms::QuestionnaireForm).from_params(params, session_token: session_token, ip_hash: ip_hash)
 
@@ -78,7 +78,7 @@ module Decidim
           # You can implement this method in your controller to change the URL
           # where the questionnaire will be submitted.
           def update_url
-            url_for([questionnaire_for, action: :answer])
+            url_for([questionnaire_for, { action: :answer }])
           end
 
           # Points to the shortest path accessing the current form. This will be
@@ -87,7 +87,7 @@ module Decidim
           #
           # Overwrite this method at the controller.
           def form_path
-            url_for([questionnaire_for, only_path: true])
+            url_for([questionnaire_for, { only_path: true }])
           end
 
           # Public: Method to be implemented at the controller. You need to
@@ -107,7 +107,7 @@ module Decidim
           end
 
           def spam_detected
-            enforce_permission_to :answer, :questionnaire
+            enforce_permission_to_answer_questionnaire
 
             @form = form(Decidim::Forms::QuestionnaireForm).from_params(params)
 
@@ -115,6 +115,12 @@ module Decidim
             render template: "decidim/forms/questionnaires/show"
           end
 
+          # You can implement this method in your controller to change the
+          # enforce_permission_to arguments.
+          def enforce_permission_to_answer_questionnaire
+            enforce_permission_to :answer, :questionnaire
+          end
+
           def ip_hash
             return nil unless request&.remote_ip
 

data/app/forms/decidim/forms/admin/question_form.rb

@@ -14,6 +14,7 @@ module Decidim
         attribute :display_conditions, Array[DisplayConditionForm]
         attribute :matrix_rows, Array[QuestionMatrixRowForm]
         attribute :max_choices, Integer
+        attribute :max_characters, Integer, default: 0
         attribute :deleted, Boolean, default: false
 
         translatable_attribute :body, String
@@ -22,6 +23,7 @@ module Decidim
         validates :position, numericality: { greater_than_or_equal_to: 0 }
         validates :question_type, inclusion: { in: Decidim::Forms::Question::TYPES }
         validates :max_choices, numericality: { only_integer: true, greater_than: 1, less_than_or_equal_to: ->(form) { form.number_of_options } }, allow_blank: true
+        validates :max_characters, numericality: { only_integer: true, greater_than_or_equal_to: 0 }
         validates :body, translatable_presence: true, if: :requires_body?
         validates :matrix_rows, presence: true, if: :matrix?
         validates :answer_options, presence: true, if: :matrix?

data/app/forms/decidim/forms/answer_form.rb

@@ -5,18 +5,23 @@ module Decidim
     # This class holds a Form to save the questionnaire answers from Decidim's public page
     class AnswerForm < Decidim::Form
       include Decidim::TranslationsHelper
+      include Decidim::AttachmentAttributes
 
       attribute :question_id, String
       attribute :body, String
       attribute :choices, Array[AnswerChoiceForm]
       attribute :matrix_choices, Array[AnswerChoiceForm]
 
+      attachments_attribute :documents
+
       validates :body, presence: true, if: :mandatory_body?
       validates :selected_choices, presence: true, if: :mandatory_choices?
 
       validate :max_choices, if: -> { question.max_choices }
       validate :all_choices, if: -> { question.question_type == "sorting" }
       validate :min_choices, if: -> { question.matrix? && question.mandatory? }
+      validate :documents_present, if: -> { question.question_type == "files" && question.mandatory? }
+      validate :max_characters, if: -> { question.max_characters.positive? }
 
       delegate :mandatory_body?, :mandatory_choices?, :matrix?, to: :question
 
@@ -49,6 +54,10 @@ module Decidim
         choices.select(&:body)
       end
 
+      def custom_choices
+        choices.select(&:custom_body)
+      end
+
       def display_conditions_fulfilled?
         question.display_conditions.all? do |condition|
           answer = context.responses&.find { |r| r.question_id&.to_i == condition.condition_question.id }
@@ -56,6 +65,10 @@ module Decidim
         end
       end
 
+      def has_attachments?
+        question.has_attachments? && errors[:add_documents].empty? && add_documents.present?
+      end
+
       private
 
       def mandatory_body?
@@ -78,6 +91,16 @@ module Decidim
         end
       end
 
+      def max_characters
+        if body.present?
+          errors.add(:body, :too_long) if body.size > question.max_characters
+        elsif custom_choices.any?
+          custom_choices.each do |choice|
+            errors.add(:body, :too_long) if choice.custom_body.size > question.max_characters
+          end
+        end
+      end
+
       def min_choices
         errors.add(:choices, :missing) if grouped_choices.count != question.matrix_rows.count
       end
@@ -93,6 +116,10 @@ module Decidim
       def max_choices_label
         I18n.t("questionnaires.question.max_choices", scope: "decidim.forms", n: question.max_choices)
       end
+
+      def documents_present
+        errors.add(:add_documents, :blank) if add_documents.empty? && errors[:add_documents].empty?
+      end
     end
   end
 end

data/app/helpers/decidim/forms/admin/application_helper.rb

@@ -31,7 +31,7 @@ module Decidim
             "placeholder" => options[:placeholder],
             "locale" => I18n.locale
           }
-          content_tag :span, class: options[:class], data: data do
+          tag.span(class: options[:class], data: data) do
             truncate translated_attribute(title), length: options[:max_length], omission: options[:omission]
           end
         end
@@ -45,11 +45,6 @@ module Decidim
         def templates_defined?
           defined? Decidim::Templates::Admin::Concerns::Templatable
         end
-
-        def title_for_questionnaire
-          scope = templates_defined? ? "decidim.templates.admin.questionnaire_templates" : "decidim.forms.admin.questionnaires"
-          t("form.title", scope: scope)
-        end
       end
     end
   end

data/app/helpers/decidim/forms/admin/concerns/has_questionnaire_answers_url_helper.rb

@@ -21,17 +21,17 @@ module Decidim
           # You can implement this method in your controller to change the URL
           # where the questionnaire participants' info will be shown.
           def questionnaire_participants_url
-            url_for([:index, questionnaire.questionnaire_for, format: nil])
+            url_for([:index, questionnaire.questionnaire_for, { format: nil }])
           end
 
           # You can implement this method in your controller to change the URL
           # where the user's questionnaire answers will be shown.
           def questionnaire_participant_answers_url(session_token)
-            url_for([:show, questionnaire.questionnaire_for, session_token: session_token])
+            url_for([:show, questionnaire.questionnaire_for, { session_token: session_token }])
           end
 
           def questionnaire_export_response_url(session_token)
-            url_for([:export_response, questionnaire.questionnaire_for, session_token: session_token, format: "pdf"])
+            url_for([:export_response, questionnaire.questionnaire_for, { session_token: session_token, format: "pdf" }])
           end
         end
       end

data/app/jobs/decidim/forms/export_questionnaire_answers_job.rb

@@ -7,7 +7,7 @@ module Decidim
 
       def perform(user, title, answers)
         return if user&.email.blank?
-        return if answers&.blank?
+        return if answers.blank?
 
         serializer = Decidim::Forms::UserAnswersSerializer
         export_data = Decidim::Exporters::FormPDF.new(answers, serializer).export

data/app/models/decidim/forms/answer.rb

@@ -6,6 +6,7 @@ module Decidim
     class Answer < Forms::ApplicationRecord
       include Decidim::DataPortability
       include Decidim::NewsletterParticipant
+      include Decidim::HasAttachments
 
       belongs_to :user, class_name: "Decidim::User", foreign_key: "decidim_user_id", optional: true
       belongs_to :questionnaire, class_name: "Questionnaire", foreign_key: "decidim_questionnaire_id"
@@ -20,6 +21,8 @@ module Decidim
       validate :user_questionnaire_same_organization
       validate :question_belongs_to_questionnaire
 
+      scope :not_separator, -> { joins(:question).where.not(decidim_forms_questions: { question_type: Decidim::Forms::Question::SEPARATOR_TYPE }) }
+
       def self.user_collection(user)
         where(decidim_user_id: user.id)
       end
@@ -39,6 +42,11 @@ module Decidim
         answers.pluck(:decidim_user_id).flatten.compact.uniq
       end
 
+      def organization
+        user.organization if user.present?
+        questionnaire&.questionnaire_for.try(:organization)
+      end
+
       private
 
       def user_questionnaire_same_organization

data/app/models/decidim/forms/question.rb

@@ -6,7 +6,7 @@ module Decidim
     class Question < Forms::ApplicationRecord
       include Decidim::TranslatableResource
 
-      QUESTION_TYPES = %w(short_answer long_answer single_option multiple_option sorting matrix_single matrix_multiple).freeze
+      QUESTION_TYPES = %w(short_answer long_answer single_option multiple_option sorting files matrix_single matrix_multiple).freeze
       SEPARATOR_TYPE = "separator"
       TYPES = (QUESTION_TYPES + [SEPARATOR_TYPE]).freeze
 
@@ -48,6 +48,8 @@ module Decidim
 
       validates :question_type, inclusion: { in: TYPES }
 
+      scope :not_separator, -> { where.not(question_type: SEPARATOR_TYPE) }
+
       scope :with_body, -> { where(question_type: %w(short_answer long_answer)) }
       scope :with_choices, -> { where.not(question_type: %w(short_answer long_answer)) }
 
@@ -63,11 +65,11 @@ module Decidim
       end
 
       def mandatory_body?
-        mandatory? && !multiple_choice?
+        mandatory? && !multiple_choice? && !has_attachments?
       end
 
       def mandatory_choices?
-        mandatory? && multiple_choice?
+        mandatory? && multiple_choice? && !has_attachments?
       end
 
       def number_of_options
@@ -81,6 +83,10 @@ module Decidim
       def separator?
         question_type.to_s == SEPARATOR_TYPE
       end
+
+      def has_attachments?
+        question_type.to_s == "files"
+      end
     end
   end
 end

data/app/presenters/decidim/forms/admin/questionnaire_answer_presenter.rb

@@ -17,6 +17,7 @@ module Decidim
 
         def body
           return answer.body if answer.body.present?
+          return attachments if answer.attachments.any?
           return "-" if answer.choices.empty?
 
           choices = answer.choices.map do |choice|
@@ -30,8 +31,27 @@ module Decidim
           end
         end
 
+        def attachments
+          content_tag(:ul) do
+            safe_join(answer.attachments.map { |a| pretty_attachment(a) })
+          end
+        end
+
         private
 
+        def pretty_attachment(attachment)
+          # rubocop:disable Style/StringConcatenation
+          # Interpolating strings that are `html_safe` is problematic with Rails.
+          content_tag :li do
+            link_to(translated_attribute(attachment.title), attachment.url) +
+              " " +
+              content_tag(:small) do
+                "#{attachment.file_type} #{number_to_human_size(attachment.file_size)}"
+              end
+          end
+          # rubocop:enable Style/StringConcatenation
+        end
+
         def choice(choice_body)
           content_tag :li do
             choice_body

data/app/presenters/decidim/forms/admin/questionnaire_participant_presenter.rb

@@ -36,23 +36,23 @@ module Decidim
         end
 
         def first_short_answer
-          short = sibilings.where("decidim_forms_questions.question_type in (?)", %w(short_answer))
+          short = sibilings.where(decidim_forms_questions: { question_type: %w(short_answer) })
           short.first
         end
 
         def completion
-          with_body = sibilings.where("decidim_forms_questions.question_type in (?)", %w(short_answer long_answer))
+          with_body = sibilings.where(decidim_forms_questions: { question_type: %w(short_answer long_answer) })
                                .where.not(body: "").count
           with_choices = sibilings.where.not("decidim_forms_questions.question_type in (?)", %w(short_answer long_answer))
                                   .where("decidim_forms_answers.id IN (SELECT decidim_answer_id FROM decidim_forms_answer_choices)").count
 
-          (with_body + with_choices).to_f / questionnaire.questions.count * 100
+          (with_body + with_choices).to_f / questionnaire.questions.not_separator.count * 100
         end
 
         private
 
         def sibilings
-          Answer.where(questionnaire: questionnaire, session_token: participant.session_token).joins(:question).order("decidim_forms_questions.position ASC")
+          Answer.not_separator.where(questionnaire: questionnaire, session_token: participant.session_token).joins(:question).order("decidim_forms_questions.position ASC")
         end
       end
     end