decidim-forms 0.30.2 → 0.31.0.rc1

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

@@ -16,74 +16,79 @@ module Decidim
           helper Decidim::Forms::ApplicationHelper
           include FormFactory
 
-          helper_method :questionnaire_for, :questionnaire, :allow_answers?, :visitor_can_answer?, :visitor_already_answered?, :update_url, :visitor_can_edit_answers?, :form_path
+          helper_method :questionnaire_for, :questionnaire, :allow_responses?, :visitor_can_respond?, :visitor_already_responded?, :update_url, :visitor_can_edit_responses?,
+                        :form_path
 
           invisible_captcha on_spam: :spam_detected
 
           def show
             @form = form(Decidim::Forms::QuestionnaireForm).from_model(questionnaire)
-            render template: "decidim/forms/questionnaires/show"
+            render template:
           end
 
-          # i18n-tasks-use t("decidim.forms.questionnaires.answer.success")
-          # i18n-tasks-use t("decidim.forms.questionnaires.answer.invalid")
-          def answer
-            enforce_permission_to_answer_questionnaire
+          # i18n-tasks-use t("decidim.forms.questionnaires.response.success")
+          # i18n-tasks-use t("decidim.forms.questionnaires.response.invalid")
+          def respond
+            enforce_permission_to_respond_questionnaire
 
             @form = form(Decidim::Forms::QuestionnaireForm).from_params(params, session_token:, ip_hash:)
 
-            Decidim::Forms::AnswerQuestionnaire.call(@form, questionnaire, allow_editing_answers: allow_editing_answers?) do
+            Decidim::Forms::ResponseQuestionnaire.call(@form, questionnaire, allow_editing_responses: allow_editing_responses?) do
               on(:ok) do
-                flash[:notice] = I18n.t("answer.success", scope: i18n_flashes_scope)
-                redirect_to after_answer_path
+                flash[:notice] = I18n.t("response.success", scope: i18n_flashes_scope)
+                redirect_to after_response_path
               end
 
               on(:invalid) do
-                flash.now[:alert] = I18n.t("answer.invalid", scope: i18n_flashes_scope)
-                render template: "decidim/forms/questionnaires/show"
+                flash.now[:alert] = I18n.t("response.invalid", scope: i18n_flashes_scope)
+                render template:, status: :unprocessable_entity
               end
             end
           end
 
+          def template
+            "decidim/forms/questionnaires/show"
+          end
+
           # Public: Method to be implemented at the controller. You need to
-          # return true if the questionnaire can receive answers
-          def allow_answers?
-            raise "#{self.class.name} is expected to implement #allow_answers?"
+          # return true if the questionnaire can receive responses
+          def allow_responses?
+            raise "#{self.class.name} is expected to implement #allow_responses?"
           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
+          # return true if the questionnaire can receive responses 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?
+          # Public: return true if the current user (if logged) can response the questionnaire
+          def visitor_can_respond?
             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]))
+          # Public: return true if the current user (or session visitor) can respond the questionnaire
+          def visitor_already_responded?
+            questionnaire.responded_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.
+          # responding the questionnaire. By default it redirects to the questionnaire_for.
           #
           # It can be redefined at controller level if you need to redirect elsewhere.
-          def after_answer_path
+          def after_response_path
             questionnaire_for
           end
 
           # 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: :respond }])
           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.
+          # responses, so that we can warn them.
           #
           # Overwrite this method at the controller.
           def form_path
@@ -98,12 +103,12 @@ module Decidim
 
           private
 
-          def allow_editing_answers?
+          def allow_editing_responses?
             false
           end
 
-          def visitor_can_edit_answers?
-            current_user.present? && questionnaire_for.try(:allow_editing_answers?)
+          def visitor_can_edit_responses?
+            current_user.present? && questionnaire_for.try(:allow_editing_responses?)
           end
 
           def i18n_flashes_scope
@@ -111,22 +116,22 @@ module Decidim
           end
 
           def questionnaire
-            @questionnaire ||= Questionnaire.includes(questions: :answer_options).find_by(questionnaire_for:)
+            @questionnaire ||= Questionnaire.includes(questions: :response_options).find_by(questionnaire_for:)
           end
 
           def spam_detected
-            enforce_permission_to_answer_questionnaire
+            enforce_permission_to_respond_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"
+            flash.now[:alert] = I18n.t("response.spam_detected", scope: i18n_flashes_scope)
+            render template:
           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
+          def enforce_permission_to_respond_questionnaire
+            enforce_permission_to :respond, :questionnaire
           end
 
           def ip_hash

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

@@ -9,7 +9,7 @@ module Decidim
 
         attribute :decidim_question_id, Integer
         attribute :decidim_condition_question_id, Integer
-        attribute :decidim_answer_option_id, Integer
+        attribute :decidim_response_option_id, Integer
         attribute :condition_type, String
         attribute :mandatory, Boolean, default: false
         attribute :deleted, Boolean, default: false
@@ -18,13 +18,13 @@ module Decidim
 
         validates :question, presence: true, unless: :deleted
         validates :condition_question, presence: true, unless: :deleted
-        validates :answer_option, presence: true, if: :answer_option_mandatory?
+        validates :response_option, presence: true, if: :response_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
+        validate :valid_response_option?, unless: :deleted
 
         def to_param
           return id if id.present?
@@ -32,10 +32,10 @@ module Decidim
           "questionnaire-display-condition-id"
         end
 
-        def answer_options
+        def response_options
           return [] if condition_question.blank?
 
-          condition_question.answer_options
+          condition_question.response_options
         end
 
         def questions_for_select(questionnaire, id)
@@ -65,11 +65,11 @@ module Decidim
           @condition_question ||= Question.find_by(id: decidim_condition_question_id)
         end
 
-        # Finds the Answer Option from the given decidim_answer_option_id
+        # Finds the Response Option from the given decidim_response_option_id
         #
-        # Returns a Decidim::Forms::AnswerOption
-        def answer_option
-          @answer_option ||= AnswerOption.find_by(id: decidim_answer_option_id)
+        # Returns a Decidim::Forms::ResponseOption
+        def response_option
+          @response_option ||= ResponseOption.find_by(id: decidim_response_option_id)
         end
 
         private
@@ -78,15 +78,15 @@ module Decidim
           !deleted && condition_type == "match"
         end
 
-        def answer_option_mandatory?
+        def response_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?
+        def valid_response_option?
+          return unless response_option_mandatory?
+          return if response_option.blank?
 
-          errors.add(:decidim_answer_option_id, :invalid) if answer_option.question.id != decidim_condition_question_id
+          errors.add(:decidim_response_option_id, :invalid) if response_option.question.id != decidim_condition_question_id
         end
 
         def condition_question_position

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

@@ -10,7 +10,7 @@ module Decidim
         attribute :position, Integer
         attribute :mandatory, Boolean, default: false
         attribute :question_type, String
-        attribute :answer_options, Array[AnswerOptionForm]
+        attribute :response_options, Array[ResponseOptionForm]
         attribute :display_conditions, Array[DisplayConditionForm]
         attribute :matrix_rows, Array[QuestionMatrixRowForm]
         attribute :max_choices, Integer
@@ -26,7 +26,7 @@ module Decidim
         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?
+        validates :response_options, presence: true, if: :matrix?
 
         def to_param
           return id if id.present?
@@ -35,7 +35,7 @@ module Decidim
         end
 
         def number_of_options
-          answer_options.size
+          response_options.size
         end
 
         def separator?

data/app/forms/decidim/forms/admin/{answer_option_form.rb → response_option_form.rb}

@@ -3,8 +3,8 @@
 module Decidim
   module Forms
     module Admin
-      # This class holds a Form to update answer options
-      class AnswerOptionForm < Decidim::Form
+      # This class holds a Form to update response options
+      class ResponseOptionForm < Decidim::Form
         include TranslatableAttributes
 
         attribute :deleted, Boolean, default: false
@@ -17,7 +17,7 @@ module Decidim
         def to_param
           return id if id.present?
 
-          "questionnaire-question-answer-option-id"
+          "questionnaire-question-response-option-id"
         end
       end
     end

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

@@ -2,18 +2,17 @@
 
 module Decidim
   module Forms
-    # This class holds a Form to answer a questionnaire from Decidim's public page.
+    # This class holds a Form to response a questionnaire from Decidim's public page.
     class QuestionnaireForm < Decidim::Form
       include ActiveModel::Validations::Callbacks
 
-      # as questionnaire uses "answers" for the database relationships is
+      # as questionnaire uses "responses" 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 :responses, Array[ResponseForm]
       attribute :public_participation, Boolean, default: false
 
       attribute :tos_agreement, Boolean
-      attribute :allow_editing_answers, Boolean, default: false
+      attribute :allow_editing_responses, Boolean, default: false
 
       before_validation :before_validation
 
@@ -25,17 +24,17 @@ module Decidim
       # Returns nothing.
       def map_model(model)
         self.responses = model.questions.map do |question|
-          AnswerForm.from_model(Decidim::Forms::Answer.new(question:))
+          ResponseForm.from_model(Decidim::Forms::Response.new(question:))
         end
       end
 
-      def add_answers!(questionnaire:, session_token:, ip_hash:)
+      def add_responses!(questionnaire:, session_token:, ip_hash:)
         self.responses = questionnaire.questions.map do |question|
-          AnswerForm.from_model(Decidim::Forms::Answer.where(question:, user: current_user, session_token:, ip_hash:).first_or_initialize)
+          ResponseForm.from_model(Decidim::Forms::Response.where(question:, user: current_user, session_token:, ip_hash:).first_or_initialize)
         end
       end
 
-      # Add other responses to the context so AnswerForm can validate conditional questions
+      # Add other responses to the context so ResponseForm can validate conditional questions
       def before_validation
         context.responses = attributes[:responses]
       end

data/app/forms/decidim/forms/{answer_choice_form.rb → response_choice_form.rb}

@@ -2,18 +2,18 @@
 
 module Decidim
   module Forms
-    # This class holds a Form to save the chosen option for an answer
-    class AnswerChoiceForm < Decidim::Form
+    # This class holds a Form to save the chosen option for an response
+    class ResponseChoiceForm < Decidim::Form
       attribute :body, String
       attribute :custom_body, String
       attribute :position, Integer
-      attribute :answer_option_id, Integer
+      attribute :response_option_id, Integer
       attribute :matrix_row_id, Integer
 
-      validates :answer_option_id, presence: true
+      validates :response_option_id, presence: true
 
       def map_model(model)
-        self.answer_option_id = model.decidim_answer_option_id
+        self.response_option_id = model.decidim_response_option_id
         self.matrix_row_id = model.decidim_question_matrix_row_id
       end
     end

data/app/forms/decidim/forms/{answer_form.rb → response_form.rb}

@@ -2,15 +2,15 @@
 
 module Decidim
   module Forms
-    # This class holds a Form to save the questionnaire answers from Decidim's public page
-    class AnswerForm < Decidim::Form
+    # This class holds a Form to save the questionnaire responses from Decidim's public page
+    class ResponseForm < Decidim::Form
       include Decidim::TranslationsHelper
       include Decidim::AttachmentAttributes
 
       attribute :question_id, String
       attribute :body, String
-      attribute :choices, Array[AnswerChoiceForm]
-      attribute :matrix_choices, Array[AnswerChoiceForm]
+      attribute :choices, Array[ResponseChoiceForm]
+      attribute :matrix_choices, Array[ResponseChoiceForm]
 
       attachments_attribute :documents
 
@@ -47,7 +47,7 @@ module Decidim
         self.documents = model.attachments
 
         self.choices = model.choices.map do |choice|
-          AnswerChoiceForm.from_model(choice)
+          ResponseChoiceForm.from_model(choice)
         end
       end
 
@@ -67,8 +67,8 @@ module Decidim
 
       def mandatory_conditions_fulfilled?
         question.display_conditions.where(mandatory: true).all? do |condition|
-          answer = context.responses&.find { |r| r.question_id&.to_i == condition.condition_question.id }
-          condition.fulfilled?(answer)
+          response = context.responses&.find { |r| r.question_id&.to_i == condition.condition_question.id }
+          condition.fulfilled?(response)
         end
       end
 
@@ -76,8 +76,8 @@ module Decidim
         return true unless question.display_conditions.where(mandatory: false).any?
 
         question.display_conditions.where(mandatory: false).any? do |condition|
-          answer = context.responses&.find { |r| r.question_id&.to_i == condition.condition_question.id }
-          condition.fulfilled?(answer)
+          response = context.responses&.find { |r| r.question_id&.to_i == condition.condition_question.id }
+          condition.fulfilled?(response)
         end
       end
 

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

@@ -12,8 +12,8 @@ module Decidim
           "questionnaire_question_#{question.to_param}"
         end
 
-        def tabs_id_for_question_answer_option(question, answer_option)
-          "questionnaire_question_#{question.to_param}_answer_option_#{answer_option.to_param}"
+        def tabs_id_for_question_response_option(question, response_option)
+          "questionnaire_question_#{question.to_param}_response_option_#{response_option.to_param}"
         end
 
         def tabs_id_for_question_display_condition(question, display_condition)

data/app/helpers/decidim/forms/admin/concerns/{has_questionnaire_answers_pagination_helper.rb → has_questionnaire_responses_pagination_helper.rb}

@@ -4,9 +4,9 @@ module Decidim
   module Forms
     module Admin
       module Concerns
-        # Pagination helper for HasQuestionnaireAnswers controller concern
+        # Pagination helper for HasQuestionnaireResponses controller concern
         #
-        module HasQuestionnaireAnswersPaginationHelper
+        module HasQuestionnaireResponsesPaginationHelper
           def self.included(base)
             base.helper_method :prev_url, :next_url, :first?, :last?, :current_idx
           end
@@ -15,14 +15,14 @@ module Decidim
             return if first?
 
             token = participant_ids[current_idx - 1]
-            questionnaire_participant_answers_url(token)
+            questionnaire_participant_responses_url(token)
           end
 
           def next_url
             return if last?
 
             token = participant_ids[current_idx + 1]
-            questionnaire_participant_answers_url(token)
+            questionnaire_participant_responses_url(token)
           end
 
           def first?

data/app/helpers/decidim/forms/admin/concerns/{has_questionnaire_answers_url_helper.rb → has_questionnaire_responses_url_helper.rb}

@@ -4,12 +4,12 @@ module Decidim
   module Forms
     module Admin
       module Concerns
-        # Url helper for HasQuestionnaireAnswers controller concern
+        # Url helper for HasQuestionnaireResponses controller concern
         #
-        module HasQuestionnaireAnswersUrlHelper
+        module HasQuestionnaireResponsesUrlHelper
           def self.included(base)
             base.helper_method :questionnaire_url, :questionnaire_participants_url,
-                               :questionnaire_participant_answers_url, :questionnaire_export_response_url
+                               :questionnaire_participant_responses_url, :questionnaire_export_response_url
           end
 
           # You can implement this method in your controller to change the URL
@@ -25,8 +25,8 @@ module Decidim
           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(id)
+          # where the user's questionnaire responses will be shown.
+          def questionnaire_participant_responses_url(id)
             url_for([questionnaire.questionnaire_for, { id: }])
           end
 

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Forms
+    module Admin
+      # Custom helpers for questionnaire responses
+      #
+      module QuestionnaireResponsesHelper
+        def first_table_th(response)
+          return nil if response.nil?
+
+          if response.first_short_response
+            @first_short_response = response.first_short_response
+            return translated_attribute @first_short_response.question.body
+          end
+
+          t("session_token", scope: "decidim.forms.user_responses_serializer")
+        end
+
+        def first_table_td(response)
+          return response.first_short_response&.body if @first_short_response
+
+          response.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/helpers/decidim/forms/application_helper.rb

@@ -5,12 +5,11 @@ module Decidim
     # Custom helpers, scoped to the forms engine.
     module ApplicationHelper
       # Show cell for selected models
-      def show_represent_user_group?
+      def show_public_participation?
         model_name = questionnaire_for.model_name.element
 
         permitted_models.include?(model_name)
       end
-      alias show_public_participation? show_represent_user_group?
 
       def permitted_models
         %(meeting)

data/app/jobs/decidim/forms/{export_questionnaire_answers_job.rb → export_questionnaire_responses_job.rb}

@@ -2,17 +2,17 @@
 
 module Decidim
   module Forms
-    class ExportQuestionnaireAnswersJob < ApplicationJob
+    class ExportQuestionnaireResponsesJob < ApplicationJob
       include Decidim::PrivateDownloadHelper
 
       queue_as :exports
 
-      def perform(user, file_name, answers, export_type = nil)
+      def perform(user, file_name, responses, export_type = nil)
         return if user&.email.blank?
-        return if answers.blank?
+        return if responses.blank?
 
-        serializer = Decidim::Forms::UserAnswersSerializer
-        export_data = Decidim::Exporters::FormPDF.new(answers, serializer).export
+        serializer = Decidim::Forms::UserResponsesSerializer
+        export_data = Decidim::Exporters::FormPDF.new(responses, serializer).export
 
         private_export = attach_archive(export_data, file_name, user, export_type)
 

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

@@ -5,12 +5,12 @@ module Decidim
     # 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 whether
-    # the text value of the answer matches a string ("match").
+    # is the question the responses of which are checked against the conditions.
+    # Conditions can be whether the question is responded ("responded") or it is not ("not_responded"),
+    # if the selected response option is ("equal") or is not ("not_equal") a given one, or whether
+    # the text value of the response matches a string ("match").
     class DisplayCondition < Forms::ApplicationRecord
-      enum condition_type: [:answered, :not_answered, :equal, :not_equal, :match], _prefix: true
+      enum :condition_type, [:responded, :not_responded, :equal, :not_equal, :match], prefix: true
 
       # Question which will be displayed or hidden
       belongs_to :question,
@@ -19,29 +19,29 @@ module Decidim
                  inverse_of: :display_conditions,
                  counter_cache: :display_conditions_count
 
-      # Question the answers of which are checked against conditions
+      # Question the responses 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,
                  counter_cache: :display_conditions_for_other_questions_count
 
-      # 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
+      # Response option provided to check for "equal" or "not_equal" (optional)
+      belongs_to :response_option, class_name: "ResponseOption", foreign_key: "decidim_response_option_id", optional: true
 
-      def fulfilled?(answer_form)
-        return answer_form.present? if condition_type == "answered"
-        return answer_form.blank? if condition_type == "not_answered"
+      def fulfilled?(response_form)
+        return response_form.present? if condition_type == "responded"
+        return response_form.blank? if condition_type == "not_responded"
         # rest of options require presence
-        return if answer_form.blank?
+        return if response_form.blank?
 
         case condition_type
         when "equal"
-          answer_form.choices.pluck(:answer_option_id).include?(answer_option.id)
+          response_form.choices.pluck(:response_option_id).include?(response_option.id)
         when "not_equal"
-          answer_form.choices.pluck(:answer_option_id).exclude?(answer_option.id)
+          response_form.choices.pluck(:response_option_id).exclude?(response_option.id)
         when "match"
-          condition_value.values.compact_blank.any? { |value| answer_form_matches?(answer_form, value) }
+          condition_value.values.compact_blank.any? { |value| response_form_matches?(response_form, value) }
         end
       end
 
@@ -50,7 +50,7 @@ module Decidim
           id:,
           type: condition_type,
           condition: decidim_condition_question_id,
-          option: decidim_answer_option_id,
+          option: decidim_response_option_id,
           mandatory:,
           value: condition_value&.dig(I18n.locale.to_s)
         }.compact
@@ -58,12 +58,12 @@ module Decidim
 
       private
 
-      def answer_form_matches?(answer_form, value)
+      def response_form_matches?(response_form, value)
         search = Regexp.new(value, Regexp::IGNORECASE)
-        if answer_form.body
-          answer_form.body.match?(search)
+        if response_form.body
+          response_form.body.match?(search)
         else
-          answer_form.choices.any? do |choice_value|
+          response_form.choices.any? do |choice_value|
             choice_value.body&.match?(search) || choice_value.custom_body&.match?(search)
           end
         end