decidim-forms 0.19.0 → 0.22.0

data/app/cells/decidim/forms/matrix_readonly/show.erb

@@ -0,0 +1,5 @@
+<li class="questionnaire-question_readonly-answer">
+  <%= translated_attribute(model.body) %>
+
+  (<%= answer_options %>)
+</li>

data/app/cells/decidim/forms/matrix_readonly_cell.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Forms
+    # This cell renders a possible matrix answer of a question (readonly)
+    class MatrixReadonlyCell < Decidim::ViewModel
+      def answer_options
+        model.question.answer_options.map { |option| translated_attribute(option.body) }.join(" / ")
+      end
+    end
+  end
+end

data/app/cells/decidim/forms/question_readonly/show.erb

@@ -9,7 +9,11 @@
 
   <% if model.multiple_choice? %>
     <ul class="questionnaire-question_readonly-answers <%= model.question_type %>">
-      <%= cell("decidim/forms/answer_readonly", collection: model.answer_options) %>
+      <% if model.matrix? %>
+        <%= cell("decidim/forms/matrix_readonly", collection: model.matrix_rows) %>
+      <% else %>
+        <%= cell("decidim/forms/answer_readonly", collection: model.answer_options) %>
+      <% end %>
     </ul>
   <% end %>
 </li>

data/app/cells/decidim/forms/question_readonly_cell.rb

@@ -4,6 +4,11 @@ module Decidim
   module Forms
     # This cell renders a question (readonly) of a questionnaire
     class QuestionReadonlyCell < Decidim::ViewModel
+      def show
+        return if model.separator?
+
+        render :show
+      end
     end
   end
 end

data/app/cells/decidim/forms/step_navigation/show.erb

@@ -0,0 +1,35 @@
+<div class="button--double form-general-submit answer-questionnaire__submit">
+  <% if first_step? %>
+    <a></a>
+  <% else %>
+    <%= link_to(
+      icon("caret-left", class: "icon--small", role: "img") + " " + t("decidim.forms.step_navigation.show.back"),
+      "#",
+      class: "hollow secondary",
+      data: {
+        toggle: [previous_step_dom_id, current_step_dom_id].join(" ")
+      }
+    ) %>
+  <% end %>
+
+  <% if last_step? %>
+    <%= form.submit(
+      t("decidim.forms.step_navigation.show.submit"),
+      class: "button button--sc",
+      disabled: button_disabled?,
+      data: {
+        confirm: t("decidim.forms.step_navigation.show.are_you_sure"),
+        disable: true
+      }
+    ) %>
+  <% else %>
+    <%= link_to(
+      t("decidim.forms.step_navigation.show.continue"),
+      "#",
+      class: "button button--sc",
+      data: {
+        toggle: [next_step_dom_id, current_step_dom_id].join(" ")
+      }
+    ) %>
+  <% end %>
+</div>

data/app/cells/decidim/forms/step_navigation_cell.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Forms
+    # This cell renders the navigation of a questionnaire step.
+    class StepNavigationCell < Decidim::ViewModel
+      include Decidim::LayoutHelper
+
+      def current_step_index
+        model
+      end
+
+      def first_step?
+        current_step_index.zero?
+      end
+
+      def last_step?
+        current_step_index + 1 == total_steps
+      end
+
+      def total_steps
+        options[:total_steps]
+      end
+
+      def form
+        options[:form]
+      end
+
+      def button_disabled?
+        options[:button_disabled]
+      end
+
+      def previous_step_dom_id
+        "step-#{current_step_index - 1}"
+      end
+
+      def next_step_dom_id
+        "step-#{current_step_index + 1}"
+      end
+
+      def current_step_dom_id
+        "step-#{current_step_index}"
+      end
+    end
+  end
+end

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

@@ -56,6 +56,14 @@ module Decidim
 
               update_nested_model(form_answer_option, answer_option_attributes, question.answer_options)
             end
+
+            form_question.matrix_rows.each do |form_matrix_row|
+              matrix_row_attributes = {
+                body: form_matrix_row.body
+              }
+
+              update_nested_model(form_matrix_row, matrix_row_attributes, question.matrix_rows)
+            end
           end
         end
 

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

@@ -24,16 +24,20 @@ module Decidim
         broadcast(:ok)
       end
 
+      attr_reader :form
+
       private
 
       def answer_questionnaire
         Answer.transaction do
-          @form.answers.each do |form_answer|
+          form.responses_by_step.flatten.each do |form_answer|
             answer = Answer.new(
               user: @current_user,
               questionnaire: @questionnaire,
               question: form_answer.question,
-              body: form_answer.body
+              body: form_answer.body,
+              session_token: form.context.session_token,
+              ip_hash: form.context.ip_hash
             )
 
             form_answer.selected_choices.each do |choice|
@@ -41,6 +45,7 @@ module Decidim
                 body: choice.body,
                 custom_body: choice.custom_body,
                 decidim_answer_option_id: choice.answer_option_id,
+                decidim_question_matrix_row_id: choice.matrix_row_id,
                 position: choice.position
               )
             end

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

@@ -15,7 +15,7 @@ module Decidim
 
           included do
             helper Decidim::Forms::Admin::ApplicationHelper
-            helper_method :questionnaire_for, :questionnaire, :blank_question, :blank_answer_option, :question_types, :update_url
+            helper_method :questionnaire_for, :questionnaire, :blank_question, :blank_answer_option, :blank_matrix_row, :question_types, :update_url
 
             def edit
               enforce_permission_to :update, :questionnaire, questionnaire: questionnaire
@@ -82,8 +82,12 @@ module Decidim
               @blank_answer_option ||= Admin::AnswerOptionForm.new
             end
 
+            def blank_matrix_row
+              @blank_matrix_row ||= Admin::QuestionMatrixRowForm.new
+            end
+
             def question_types
-              @question_types ||= Question::TYPES.map do |question_type|
+              @question_types ||= Question::QUESTION_TYPES.map do |question_type|
                 [question_type, I18n.t("decidim.forms.question_types.#{question_type}")]
               end
             end

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

@@ -16,7 +16,9 @@ module Decidim
           helper Decidim::Forms::ApplicationHelper
           include FormFactory
 
-          helper_method :questionnaire_for, :questionnaire, :allow_answers?, :update_url
+          helper_method :questionnaire_for, :questionnaire, :allow_answers?, :visitor_can_answer?, :visitor_already_answered?, :update_url, :form_path
+
+          invisible_captcha on_spam: :spam_detected
 
           def show
             @form = form(Decidim::Forms::QuestionnaireForm).from_model(questionnaire)
@@ -26,7 +28,7 @@ module Decidim
           def answer
             enforce_permission_to :answer, :questionnaire
 
-            @form = form(Decidim::Forms::QuestionnaireForm).from_params(params)
+            @form = form(Decidim::Forms::QuestionnaireForm).from_params(params, session_token: session_token, ip_hash: ip_hash)
 
             Decidim::Forms::AnswerQuestionnaire.call(@form, current_user, questionnaire) do
               on(:ok) do
@@ -49,6 +51,22 @@ module Decidim
             raise "#{self.class.name} is expected to implement #allow_answers?"
           end
 
+          # Public: Method to be implemented at the controller if needed. You need to
+          # return true if the questionnaire can receive answers by unregistered users
+          def allow_unregistered?
+            false
+          end
+
+          # Public: return true if the current user (if logged) can answer the questionnaire
+          def visitor_can_answer?
+            current_user || allow_unregistered?
+          end
+
+          # Public: return true if the current user (or session visitor) can answer the questionnaire
+          def visitor_already_answered?
+            questionnaire.answered_by?(current_user || tokenize(session[:session_id]))
+          end
+
           # Public: Returns a String or Object that will be passed to `redirect_to` after
           # answering the questionnaire. By default it redirects to the questionnaire_for.
           #
@@ -63,6 +81,15 @@ module Decidim
             url_for([questionnaire_for, action: :answer])
           end
 
+          # Points to the shortest path accessing the current form. This will be
+          # used to detect whether a user is leaving the form with some partial
+          # answers, so that we can warn them.
+          #
+          # Overwrite this method at the controller.
+          def form_path
+            url_for([questionnaire_for, only_path: true])
+          end
+
           # Public: Method to be implemented at the controller. You need to
           # return the object that will hold the questionnaire.
           def questionnaire_for
@@ -78,6 +105,35 @@ module Decidim
           def questionnaire
             @questionnaire ||= Questionnaire.includes(questions: :answer_options).find_by(questionnaire_for: questionnaire_for)
           end
+
+          def spam_detected
+            enforce_permission_to :answer, :questionnaire
+
+            @form = form(Decidim::Forms::QuestionnaireForm).from_params(params)
+
+            flash.now[:alert] = I18n.t("answer.spam_detected", scope: i18n_flashes_scope)
+            render template: "decidim/forms/questionnaires/show"
+          end
+
+          def ip_hash
+            return nil unless request&.remote_ip
+
+            @ip_hash ||= tokenize(request&.remote_ip)
+          end
+
+          # token is used as a substitute of user_id if unregistered
+          def session_token
+            id = current_user&.id
+            session_id = request.session[:session_id] if request&.session
+
+            return nil unless id || session_id
+
+            @session_token ||= tokenize(id || session_id)
+          end
+
+          def tokenize(id)
+            Digest::MD5.hexdigest("#{id}-#{Rails.application.secrets.secret_key_base}")
+          end
         end
       end
     end

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

@@ -11,6 +11,7 @@ module Decidim
         attribute :mandatory, Boolean, default: false
         attribute :question_type, String
         attribute :answer_options, Array[AnswerOptionForm]
+        attribute :matrix_rows, Array[QuestionMatrixRowForm]
         attribute :max_choices, Integer
         attribute :deleted, Boolean, default: false
 
@@ -20,7 +21,9 @@ 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 :body, translatable_presence: true, unless: :deleted
+        validates :body, translatable_presence: true, if: :requires_body?
+        validates :matrix_rows, presence: true, if: :matrix?
+        validates :answer_options, presence: true, if: :matrix?
 
         def to_param
           return id if id.present?
@@ -31,6 +34,22 @@ module Decidim
         def number_of_options
           answer_options.size
         end
+
+        def separator?
+          question_type == Decidim::Forms::Question::SEPARATOR_TYPE
+        end
+
+        private
+
+        def matrix?
+          question_type == "matrix_single" || question_type == "matrix_multiple"
+        end
+
+        def requires_body?
+          return false if separator?
+
+          !deleted
+        end
       end
     end
   end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Forms
+    module Admin
+      # This class holds a Form to update questionnaire question matrixes from Decidim's admin panel.
+      class QuestionMatrixRowForm < Decidim::Form
+        include TranslatableAttributes
+
+        attribute :position, Integer, default: 0
+        attribute :deleted, Boolean, default: false
+
+        translatable_attribute :body, String
+
+        validates :position, numericality: { greater_than_or_equal_to: 0 }
+        validates :body, translatable_presence: true, unless: :deleted
+
+        def to_param
+          return id if id.present?
+
+          "questionnaire-question-matrix-row-id"
+        end
+      end
+    end
+  end
+end

data/app/forms/decidim/forms/answer_choice_form.rb

@@ -8,6 +8,7 @@ module Decidim
       attribute :custom_body, String
       attribute :position, Integer
       attribute :answer_option_id, Integer
+      attribute :matrix_row_id, Integer
 
       validates :answer_option_id, presence: true
     end

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

@@ -9,14 +9,16 @@ module Decidim
       attribute :question_id, String
       attribute :body, String
       attribute :choices, Array[AnswerChoiceForm]
+      attribute :matrix_choices, Array[AnswerChoiceForm]
 
       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? }
 
-      delegate :mandatory_body?, :mandatory_choices?, to: :question
+      delegate :mandatory_body?, :mandatory_choices?, :matrix?, to: :question
 
       attr_writer :question
 
@@ -49,8 +51,20 @@ module Decidim
 
       private
 
+      def grouped_choices
+        selected_choices.group_by(&:matrix_row_id).values
+      end
+
       def max_choices
-        errors.add(:choices, :too_many) if selected_choices.size > question.max_choices
+        if matrix?
+          errors.add(:choices, :too_many) if grouped_choices.any? { |choices| choices.count > question.max_choices }
+        elsif selected_choices.size > question.max_choices
+          errors.add(:choices, :too_many)
+        end
+      end
+
+      def min_choices
+        errors.add(:choices, :missing) if grouped_choices.count != question.matrix_rows.count
       end
 
       def all_choices

data/app/forms/decidim/forms/questionnaire_form.rb

@@ -4,20 +4,50 @@ module Decidim
   module Forms
     # This class holds a Form to answer a questionnaire from Decidim's public page.
     class QuestionnaireForm < Decidim::Form
-      attribute :answers, Array[AnswerForm]
+      # as questionnaire uses "answers" for the database relationships is
+      # important not to use the same word here to avoid querying all the entries, resulting in a high performance penalty
+      attribute :responses, Array[AnswerForm]
       attribute :user_group_id, Integer
 
       attribute :tos_agreement, Boolean
+
       validates :tos_agreement, allow_nil: false, acceptance: true
+      validate :session_token_in_context
 
-      # Private: Create the answers from the questionnaire questions
+      # Private: Create the responses from the questionnaire questions
       #
       # Returns nothing.
       def map_model(model)
-        self.answers = model.questions.map do |question|
+        self.responses = model.questions.map do |question|
           AnswerForm.from_model(Decidim::Forms::Answer.new(question: question))
         end
       end
+
+      # Public: Splits reponses by step, keeping the separator.
+      #
+      # Returns an array of steps. Each step is a list of the questions in that
+      # step, including the separator.
+      def responses_by_step
+        @responses_by_step ||=
+          begin
+            steps = responses.chunk_while do |a, b|
+              !a.question.separator? || b.question.separator?
+            end.to_a
+
+            steps = [[]] if steps == []
+            steps
+          end
+      end
+
+      def total_steps
+        responses_by_step.count
+      end
+
+      def session_token_in_context
+        return if context&.session_token
+
+        errors.add(:tos_agreement, I18n.t("activemodel.errors.models.questionnaire.request_invalid"))
+      end
     end
   end
 end