decidim-forms 0.22.0 → 0.23.0

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

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Forms
+    module Admin
+      # This class holds a Form to update questionnaire questions from Decidim's admin panel.
+      class DisplayConditionForm < Decidim::Form
+        include TranslatableAttributes
+
+        attribute :decidim_question_id, Integer
+        attribute :decidim_condition_question_id, Integer
+        attribute :decidim_answer_option_id, Integer
+        attribute :condition_type, String
+        attribute :mandatory, Boolean, default: false
+        attribute :deleted, Boolean, default: false
+
+        translatable_attribute :condition_value, String
+
+        validates :question, presence: true, unless: :deleted
+        validates :condition_question, presence: true, unless: :deleted
+        validates :answer_option, presence: true, if: :answer_option_mandatory?
+
+        validates :condition_value, translatable_presence: true, if: :condition_value_mandatory?
+        validates :condition_type, presence: true, unless: :deleted
+
+        validate :condition_question_position, unless: :deleted
+        validate :valid_answer_option?, unless: :deleted
+
+        def to_param
+          return id if id.present?
+
+          "questionnaire-display-condition-id"
+        end
+
+        def answer_options
+          return [] if condition_question.blank?
+
+          condition_question.answer_options
+        end
+
+        def questions_for_select(questionnaire, id)
+          questionnaire.questions.map do |question|
+            [
+              question.translated_body,
+              question.id,
+              {
+                "disabled" => (question.question_type == "sorting" || question.id == id),
+                "data-type" => question.question_type
+              }
+            ]
+          end
+        end
+
+        # Finds the Question from the given decidim_question_id
+        #
+        # Returns a Decidim::Forms::Question
+        def question
+          @question ||= Question.find_by(id: @decidim_question_id)
+        end
+
+        # Finds the Condition Question from the given decidim_condition_question_id
+        #
+        # Returns a Decidim::Forms::Question
+        def condition_question
+          @condition_question ||= Question.find_by(id: @decidim_condition_question_id)
+        end
+
+        # Finds the Answer Option from the given decidim_answer_option_id
+        #
+        # Returns a Decidim::Forms::AnswerOption
+        def answer_option
+          @answer_option ||= AnswerOption.find_by(id: @decidim_answer_option_id)
+        end
+
+        private
+
+        def condition_value_mandatory?
+          !deleted && condition_type == "match"
+        end
+
+        def answer_option_mandatory?
+          !deleted && %w(equal not_equal).include?(condition_type)
+        end
+
+        def valid_answer_option?
+          return unless answer_option_mandatory?
+          return if answer_option.blank?
+
+          errors.add(:decidim_answer_option_id, :invalid) if answer_option.question.id != decidim_condition_question_id
+        end
+
+        def condition_question_position
+          return if decidim_question_id.blank?
+
+          errors.add(:decidim_question_id, :invalid) unless question.position&.positive?
+        end
+      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 :display_conditions, Array[DisplayConditionForm]
         attribute :matrix_rows, Array[QuestionMatrixRowForm]
         attribute :max_choices, Integer
         attribute :deleted, Boolean, default: false

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

@@ -49,8 +49,23 @@ module Decidim
         choices.select(&:body)
       end
 
+      def display_conditions_fulfilled?
+        question.display_conditions.all? do |condition|
+          answer = question.questionnaire.answers.find_by(question: condition.condition_question)
+          condition.fulfilled?(answer)
+        end
+      end
+
       private
 
+      def mandatory_body?
+        question.mandatory_body? if display_conditions_fulfilled?
+      end
+
+      def mandatory_choices?
+        question.mandatory_choices? if display_conditions_fulfilled?
+      end
+
       def grouped_choices
         selected_choices.group_by(&:matrix_row_id).values
       end

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# i18n-tasks-use t('decidim.templates.admin.questionnaire_templates.form.title')
+
 module Decidim
   module Forms
     module Admin
@@ -14,6 +16,10 @@ module Decidim
           "questionnaire_question_#{question.to_param}_answer_option_#{answer_option.to_param}"
         end
 
+        def tabs_id_for_question_display_condition(question, display_condition)
+          "questionnaire_question_#{question.to_param}_display_condition_#{display_condition.to_param}"
+        end
+
         def tabs_id_for_question_matrix_row(question, matrix_row)
           "questionnaire_question_#{question.to_param}_matrix_row_#{matrix_row.to_param}"
         end
@@ -29,6 +35,21 @@ module Decidim
             truncate translated_attribute(title), length: options[:max_length], omission: options[:omission]
           end
         end
+
+        def template?(questionnaire_for)
+          return unless defined? Decidim::Templates::Template
+
+          questionnaire_for.is_a? Decidim::Templates::Template
+        end
+
+        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_pagination_helper.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Forms
+    module Admin
+      module Concerns
+        # Pagination helper for HasQuestionnaireAnswers controller concern
+        #
+        module HasQuestionnaireAnswersPaginationHelper
+          def self.included(base)
+            base.helper_method :prev_url, :next_url, :first?, :last?, :current_idx
+          end
+
+          def prev_url
+            return if first?
+
+            token = participant_ids[current_idx - 1]
+            questionnaire_participant_answers_url(token)
+          end
+
+          def next_url
+            return if last?
+
+            token = participant_ids[current_idx + 1]
+            questionnaire_participant_answers_url(token)
+          end
+
+          def first?
+            current_idx.zero?
+          end
+
+          def last?
+            current_idx == participant_ids.count - 1
+          end
+
+          private
+
+          def participant_ids
+            @participant_ids ||= collection.pluck(:session_token)
+          end
+
+          def current_idx
+            participant_ids.index(params[:session_token])
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Forms
+    module Admin
+      module Concerns
+        # Url helper for HasQuestionnaireAnswers controller concern
+        #
+        module HasQuestionnaireAnswersUrlHelper
+          def self.included(base)
+            base.helper_method :questionnaire_url, :questionnaire_participants_url,
+                               :questionnaire_participant_answers_url, :questionnaire_export_response_url
+          end
+
+          # You can implement this method in your controller to change the URL
+          # where the questionnaire can be edited.
+          def questionnaire_url
+            url_for(questionnaire.questionnaire_for)
+          end
+
+          # 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])
+          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])
+          end
+
+          def questionnaire_export_response_url(session_token)
+            url_for([:export_response, questionnaire.questionnaire_for, session_token: session_token, format: "pdf"])
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Forms
+    module Admin
+      # Custom helpers for questionnaire answers
+      #
+      module QuestionnaireAnswersHelper
+        def first_table_th(answer)
+          return translated_attribute answer.first_short_answer.question.body if answer.first_short_answer
+
+          t("session_token", scope: "decidim.forms.user_answers_serializer")
+        end
+
+        def first_table_td(answer)
+          return answer.first_short_answer.body if answer.first_short_answer
+
+          answer.session_token
+        end
+
+        def display_percentage(number)
+          number_to_percentage(number, precision: 0, strip_insignificant_zeros: true, locale: I18n.locale)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Forms
+    class ExportQuestionnaireAnswersJob < ApplicationJob
+      queue_as :default
+
+      def perform(user, title, answers)
+        return if user&.email.blank?
+        return if answers&.blank?
+
+        serializer = Decidim::Forms::UserAnswersSerializer
+        export_data = Decidim::Exporters::FormPDF.new(answers, serializer).export
+
+        ExportMailer.export(user, title, export_data).deliver_now
+      end
+    end
+  end
+end

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

@@ -17,9 +17,6 @@ module Decidim
                dependent: :destroy,
                inverse_of: :answer
 
-      validates :body, presence: true, if: -> { question.mandatory_body? }
-      validates :choices, presence: true, if: -> { question.mandatory_choices? }
-
       validate :user_questionnaire_same_organization
       validate :question_belongs_to_questionnaire
 

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

@@ -3,9 +3,23 @@
 module Decidim
   module Forms
     class AnswerOption < Forms::ApplicationRecord
+      include Decidim::TranslatableResource
+
       default_scope { order(arel_table[:id].asc) }
 
+      translatable_fields :body
+
       belongs_to :question, class_name: "Question", foreign_key: "decidim_question_id"
+
+      has_many :display_conditions,
+               class_name: "DisplayCondition",
+               foreign_key: "decidim_answer_option_id",
+               dependent: :nullify,
+               inverse_of: :answer_option
+
+      def translated_body
+        Decidim::Forms::AnswerOptionPresenter.new(self).translated_body
+      end
     end
   end
 end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Forms
+    # The data store for a DisplayCondition in the Decidim::Forms component.
+    # A display condition is associated to two questions. :question is the question
+    # that we want to display or hide based on some conditions, and :condition_question
+    # is the question the answers of which are checked against the conditions.
+    # Conditions can be whether the question is answered ("answered") or it is not ("not_answered"),
+    # if the selected answer option is ("equal") or is not ("not_equal") a given one, or whethe
+    # the text value of the answer matches a string ("match").
+    class DisplayCondition < Forms::ApplicationRecord
+      enum condition_type: [:answered, :not_answered, :equal, :not_equal, :match], _prefix: true
+
+      # Question which will be displayed or hidden
+      belongs_to :question, class_name: "Question", foreign_key: "decidim_question_id", inverse_of: :display_conditions
+
+      # Question the answers of which are checked against conditions
+      belongs_to :condition_question, class_name: "Question", foreign_key: "decidim_condition_question_id", inverse_of: :display_conditions_for_other_questions
+
+      # Answer option provided to check for "equal" or "not_equal" (optional)
+      belongs_to :answer_option, class_name: "AnswerOption", foreign_key: "decidim_answer_option_id", optional: true
+
+      def fulfilled?(answer)
+        case condition_type
+        when "answered"
+          answer.present?
+        when "not_answered"
+          answer.blank?
+        when "equal"
+          answer.present? ? answer.choices.pluck(:decidim_answer_option_id).include?(answer_option.id) : false
+        when "not_equal"
+          answer.present? ? !answer.choices.pluck(:decidim_answer_option_id).include?(answer_option.id) : true
+        when "match"
+          answer.present? ? condition_value.values.any? { |value| answer.body.match?(Regexp.new(value, Regexp::IGNORECASE)) } : false
+        end
+      end
+
+      def to_html_data
+        {
+          id: id,
+          type: condition_type,
+          condition: decidim_condition_question_id,
+          option: decidim_answer_option_id,
+          mandatory: mandatory,
+          value: condition_value&.dig(I18n.locale.to_s)
+        }.compact
+      end
+    end
+  end
+end

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

@@ -4,10 +4,14 @@ module Decidim
   module Forms
     # The data store for a Question in the Decidim::Forms component.
     class Question < Forms::ApplicationRecord
+      include Decidim::TranslatableResource
+
       QUESTION_TYPES = %w(short_answer long_answer single_option multiple_option sorting matrix_single matrix_multiple).freeze
       SEPARATOR_TYPE = "separator"
       TYPES = (QUESTION_TYPES + [SEPARATOR_TYPE]).freeze
 
+      translatable_fields :body, :description
+
       belongs_to :questionnaire, class_name: "Questionnaire", foreign_key: "decidim_questionnaire_id"
 
       has_many :matrix_rows,
@@ -22,8 +26,34 @@ module Decidim
                dependent: :destroy,
                inverse_of: :question
 
+      # Conditions to display this question in questionnaire
+      has_many :display_conditions,
+               class_name: "DisplayCondition",
+               foreign_key: "decidim_question_id",
+               dependent: :destroy,
+               inverse_of: :question
+
+      # Conditions to display other questions based on the value of this question's answer
+      has_many :display_conditions_for_other_questions,
+               class_name: "DisplayCondition",
+               foreign_key: "decidim_condition_question_id",
+               dependent: :destroy,
+               inverse_of: :question
+
+      # Questions which have display conditions based on the value of this question's answer
+      has_many :conditioned_questions,
+               through: :display_conditions_for_other_questions,
+               foreign_key: "decidim_condition_question_id",
+               class_name: "Question"
+
       validates :question_type, inclusion: { in: TYPES }
 
+      scope :with_body, -> { where(question_type: %w(short_answer long_answer)) }
+      scope :with_choices, -> { where.not(question_type: %w(short_answer long_answer)) }
+
+      scope :conditioned, -> { includes(:display_conditions).where.not(decidim_forms_display_conditions: { id: nil }) }
+      scope :not_conditioned, -> { includes(:display_conditions).where(decidim_forms_display_conditions: { id: nil }) }
+
       def matrix?
         %w(matrix_single matrix_multiple).include?(question_type)
       end
@@ -44,6 +74,10 @@ module Decidim
         answer_options.size
       end
 
+      def translated_body
+        Decidim::Forms::QuestionPresenter.new(self).translated_body
+      end
+
       def separator?
         question_type.to_s == SEPARATOR_TYPE
       end