decidim-forms 0.30.2 → 0.31.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1a8b24f27a5fe27e2a6ebf4799b2f59683f3da639198b0e7a346c60dcd28561
-  data.tar.gz: 7c4caea9fc78e3515c2d2f95bb31db886e96a091f51f248d2939eaf03ecb2b6b
+  metadata.gz: 05af3125cda32c7d53951e708a287eb891e0461c260db0d8d153412af721be38
+  data.tar.gz: b5d48ab5cbb0f1fbb6e970b874f1283cc827053a4d8c8251d46ab575183f7c68
 SHA512:
-  metadata.gz: 5c3946e36ebcc2261912001d51c32363e77fda1a3949d3d0c12ec5c794fa75211b958ded800bc860ffdefab777ec96d89f964e1f1e7bc294af4afc1ca0953cbb
-  data.tar.gz: 70eef05c6c7bb3cb7000f1659db5c6249962754a0add45ccd7f6f1dcf88e583b8852c0e2b77ebd7131c2ef365ededf5fb8e8182a91acfdd41c5e69466a804f78
+  metadata.gz: b161e3aa8dfc6ac31403c294b7e0bbe9f204bff581a081b7941c7e5d79e3f0d8bfe9c05d8977b96245b303c6faaca4de97f6fe5262f21a5b59bd5d844ac6f9ed
+  data.tar.gz: 4a0f3aeb5702e008483a90afea735eba581c53bd9d949a7447178c40c67d263705573b91012aa0c6f94234537123abb87ebe6b401482754cc0170718930a0c26

data/README.md

@@ -4,8 +4,8 @@ This gem encapsulates the logic to create and manage forms, so it can be reused
 
 A `Decidim::Forms::Question` must be of one of the types:
 
-- short_answer
-- long_answer
+- short_response
+- long_response
 - single_option
 - multiple_option
 - sorting
@@ -13,15 +13,15 @@ A `Decidim::Forms::Question` must be of one of the types:
 Here are the relations between the classes of a `Decidim::Questionnaire`:
 
 ```plantuml
-                  1..* +----------+         1..* +--------------+
-        +------------->| Question |------------->| AnswerOption |
-        |              +-----+----+              +------+-------+
+                  1..* +----------+         1..* +----------------+
+        +------------->| Question |------------->| ResponseOption |
+        |              +-----+----+              +-------+--------+
         |                    ^ 1..1                     ^ 1..*
         |                    |                          |
         |                    |                          |
-+-------+-------+   1..* +---+----+ 1..*         +------+-------+
-| Questionnaire +------->| Answer |<-------------+ AnswerChoice |
-+---------------+        +---+----+              +--------------+
++-------+-------+   1..* +----+-----+ 1..*         +--------+-------+
+| Questionnaire +------->| Response |<-------------+ ResponseChoice |
++---------------+        +----+0----+              +----------------+
                              |
                              |
                              v 1..1
@@ -71,7 +71,7 @@ Decidim::Forms::Questionnaire.new(
 
 Decidim::Surveys::Survey.create!(component: component, questionnaire: questionnaire)
 
-%w(short_answer long_answer).each do |text_question_type|
+%w(short_response long_response).each do |text_question_type|
   Decidim::Forms::Question.create!(
     questionnaire: questionnaire,
     body: Decidim::Faker::Localized.paragraph,
@@ -87,7 +87,7 @@ end
   )
 
   3.times do
-    question.answer_options.create!(body: Decidim::Faker::Localized.sentence)
+    question.response_options.create!(body: Decidim::Faker::Localized.sentence)
   end
 end
 ```

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

@@ -1,5 +1,5 @@
 <li>
   <%= translated_attribute(model.body) %>
 
-  (<%= answer_options %>)
+  (<%= response_options %>)
 </li>

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

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

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

@@ -1,18 +1,18 @@
-<li class="answer-questionnaire__question" data-question-readonly>
-  <p class="answer-questionnaire__question-label" data-answer-idx="<%= position %>">
+<li class="response-questionnaire__question" data-question-readonly>
+  <p class="response-questionnaire__question-label" data-response-idx="<%= position %>">
     <%= decidim_escape_translated(model.body) %>
   </p>
 
-  <p class="answer-questionnaire__question-description">
+  <p class="response-questionnaire__question-description">
     <em><%= t(model.question_type, scope: "decidim.forms.question_types") %></em>
   </p>
 
   <% if model.multiple_choice? %>
-    <ul class="answer-questionnaire__question-description space-y-4">
+    <ul class="response-questionnaire__question-description space-y-4">
       <% if model.matrix? %>
         <%= cell("decidim/forms/matrix_readonly", collection: model.matrix_rows) %>
       <% else %>
-        <%= cell("decidim/forms/answer_readonly", collection: model.answer_options) %>
+        <%= cell("decidim/forms/response_readonly", collection: model.response_options) %>
       <% end %>
     </ul>
   <% end %>

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

@@ -1,7 +1,7 @@
-<li class="answer-questionnaire__question" data-question-readonly>
-  <div class="answer-questionnaire__step-heading">
+<li class="response-questionnaire__question" data-question-readonly>
+  <div class="response-questionnaire__step-heading">
     <h3 class="h3"><%= decidim_escape_translated(model.body) %></h3>
-    <p class="answer-questionnaire__question-description">
+    <p class="response-questionnaire__question-description">
       <em><%= t(model.question_type, scope: "decidim.forms.question_types") %></em>
     </p>
   </div>

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Forms
+    # This cell renders a possible response of a question (readonly)
+    class ResponseReadonlyCell < Decidim::ViewModel
+    end
+  end
+end

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

@@ -1,6 +1,6 @@
-<div class="answer-questionnaire__submit layout-aside__ctas-buttons survey-section-buttons" data-sticky-buttons>
+<div class="response-questionnaire__submit layout-aside__ctas-buttons survey-section-buttons" data-controller="sticky-buttons">
   <% if !first_step? %>
-    <button type="button" class="button button__sm button__transparent-secondary" data-toggle="<%= [previous_step_dom_id, current_step_dom_id].join(" ") %>" data-survey-buttons>
+    <button type="button" class="button button__sm button__transparent-secondary" data-controller="toggle" data-toggle-toggle-value="<%= [previous_step_dom_id, current_step_dom_id].join(" ") %>" data-survey-buttons>
       <%= icon "arrow-left-line", class: "fill-current" %>
       <%= t("decidim.forms.step_navigation.show.back") %>
     </button>
@@ -14,7 +14,7 @@
       **confirm_data
     ) %>
   <% else %>
-    <button type="button" class="button button__sm button__secondary" data-toggle="<%= [next_step_dom_id, current_step_dom_id].join(" ") %>" data-survey-buttons>
+    <button type="button" class="button button__sm button__secondary" data-controller="toggle" data-toggle-toggle-value="<%= [next_step_dom_id, current_step_dom_id].join(" ") %>" data-survey-buttons>
       <%= t("decidim.forms.step_navigation.show.continue") %>
       <%= icon "arrow-right-line", class: "fill-current" %>
     </button>

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

@@ -40,12 +40,12 @@ module Decidim
         "step-#{current_step_index}"
       end
 
-      def allow_editing_answers?
-        options[:allow_editing_answers]
+      def allow_editing_responses?
+        options[:allow_editing_responses]
       end
 
       def confirm_data
-        return {} if allow_editing_answers? && current_user
+        return {} if allow_editing_responses? && current_user
 
         {
           data: {

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

@@ -52,13 +52,13 @@ module Decidim
           }
 
           update_nested_model(form_question, question_attributes, @questionnaire.questions) do |question|
-            form_question.answer_options.each do |form_answer_option|
-              answer_option_attributes = {
-                body: form_answer_option.body,
-                free_text: form_answer_option.free_text
+            form_question.response_options.each do |form_response_option|
+              response_option_attributes = {
+                body: form_response_option.body,
+                free_text: form_response_option.free_text
               }
 
-              update_nested_model(form_answer_option, answer_option_attributes, question.answer_options)
+              update_nested_model(form_response_option, response_option_attributes, question.response_options)
             end
 
             form_question.display_conditions.each do |form_display_condition|
@@ -68,7 +68,7 @@ module Decidim
                 condition_question: form_display_condition.condition_question,
                 condition_type: form_display_condition.condition_type,
                 condition_value: type == "match" ? form_display_condition.condition_value : nil,
-                answer_option: %w(equal not_equal).include?(type) ? form_display_condition.answer_option : nil,
+                response_option: %w(equal not_equal).include?(type) ? form_display_condition.response_option : nil,
                 mandatory: form_display_condition.mandatory
               }
 

data/app/commands/decidim/forms/{answer_questionnaire.rb → response_questionnaire.rb}

@@ -2,31 +2,31 @@
 
 module Decidim
   module Forms
-    # This command is executed when the user answers a Questionnaire.
-    class AnswerQuestionnaire < Decidim::Command
+    # This command is executed when the user responds a Questionnaire.
+    class ResponseQuestionnaire < Decidim::Command
       delegate :current_user, to: :form
       include ::Decidim::MultipleAttachmentsMethods
 
-      # Initializes a AnswerQuestionnaire Command.
+      # Initializes a ResponseQuestionnaire Command.
       #
       # form - The form from which to get the data.
-      # questionnaire - The current instance of the questionnaire to be answered.
-      # allow_editing_answers - Flag that ensures a form can or cannot be editable after the questionnaire's answers have been provided.
-      def initialize(form, questionnaire, allow_editing_answers: false)
+      # questionnaire - The current instance of the questionnaire to be responded.
+      # allow_editing_responses - Flag that ensures a form can or cannot be editable after the questionnaire's responses have been provided.
+      def initialize(form, questionnaire, allow_editing_responses: false)
         @form = form
         @questionnaire = questionnaire
-        @allow_editing_answers = allow_editing_answers
+        @allow_editing_responses = allow_editing_responses
       end
 
-      # Answers a questionnaire if it is valid
+      # Responds a questionnaire if it is valid
       #
       # Broadcasts :ok if successful, :invalid otherwise.
       def call
-        return broadcast(:invalid) if @form.invalid? || (user_already_answered? && !allow_editing_answers)
+        return broadcast(:invalid) if @form.invalid? || (user_already_responded? && !allow_editing_responses)
 
         with_events do
-          clear_answers! if allow_editing_answers
-          answer_questionnaire
+          clear_responses! if allow_editing_responses
+          response_questionnaire
         end
 
         if @errors
@@ -37,7 +37,7 @@ module Decidim
         end
       end
 
-      attr_reader :form, :questionnaire, :allow_editing_answers
+      attr_reader :form, :questionnaire, :allow_editing_responses
 
       private
 
@@ -53,60 +53,60 @@ module Decidim
       end
 
       # This method will add an error to the `add_documents` field only if there is
-      # any error in any other field or an error in another answer in the
+      # any error in any other field or an error in another response 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? || answer.has_error_in_attachments?
+        @form.responses.each do |response|
+          response.errors.add(:add_documents, :needs_to_be_reattached) if response.has_attachments? || response.has_error_in_attachments?
         end
       end
 
-      def build_choices(answer, form_answer)
-        use_position = form_answer.sorting?
+      def build_choices(response, form_response)
+        use_position = form_response.sorting?
 
-        form_answer.selected_choices.each_with_index do |choice, idx|
+        form_response.selected_choices.each_with_index do |choice, idx|
           choice_position = use_position ? choice.position.presence || idx : choice.position
-          answer.choices.build(
+          response.choices.build(
             body: choice.body,
             custom_body: choice.custom_body,
-            decidim_answer_option_id: choice.answer_option_id,
+            decidim_response_option_id: choice.response_option_id,
             decidim_question_matrix_row_id: choice.matrix_row_id,
             position: choice_position
           )
         end
       end
 
-      def clear_answers!
-        Answer.where(questionnaire: questionnaire, user: current_user, session_token: form.context.session_token, ip_hash: form.context.ip_hash).destroy_all
+      def clear_responses!
+        Response.where(questionnaire: questionnaire, user: current_user, session_token: form.context.session_token, ip_hash: form.context.ip_hash).destroy_all
       end
 
-      def answer_questionnaire
+      def response_questionnaire
         @main_form = @form
         @errors = nil
 
-        Answer.transaction(requires_new: true) do
-          form.responses_by_step.flatten.select(&:display_conditions_fulfilled?).each do |form_answer|
-            answer = Answer.new(
+        Response.transaction(requires_new: true) do
+          form.responses_by_step.flatten.select(&:display_conditions_fulfilled?).each do |form_response|
+            response = Response.new(
               user: current_user,
               questionnaire: @questionnaire,
-              question: form_answer.question,
-              body: form_answer.body,
+              question: form_response.question,
+              body: form_response.body,
               session_token: form.context.session_token,
               ip_hash: form.context.ip_hash
             )
 
-            build_choices(answer, form_answer)
+            build_choices(response, form_response)
 
-            answer.save!
+            response.save!
 
-            next unless form_answer.question.has_attachments?
+            next unless form_response.question.has_attachments?
 
             # The attachments module expects `@form` to be the form with the
             # attachments
-            @form = form_answer
-            @attached_to = answer
+            @form = form_response
+            @attached_to = response
 
             build_attachments
 
@@ -124,8 +124,8 @@ module Decidim
         end
       end
 
-      def user_already_answered?
-        questionnaire.answered_by?(current_user || form.context.session_token)
+      def user_already_responded?
+        questionnaire.responded_by?(current_user || form.context.session_token)
       end
     end
   end

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

@@ -17,8 +17,8 @@ module Decidim
             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, :edit_questionnaire_title
+            helper_method :questionnaire_for, :questionnaire, :blank_question, :blank_response_option, :blank_matrix_row,
+                          :blank_display_condition, :question_types, :display_condition_types, :update_url, :public_url, :response_options_url, :edit_questionnaire_title
 
             if defined?(Decidim::Templates::Admin::Concerns::Templatable)
               include Decidim::Templates::Admin::Concerns::Templatable
@@ -56,7 +56,7 @@ module Decidim
                 on(:invalid) do
                   # i18n-tasks-use t("decidim.forms.admin.questionnaires.update.invalid")
                   flash.now[:alert] = I18n.t("update.invalid", scope: i18n_flashes_scope)
-                  render template: edit_template
+                  render template: edit_template, status: :unprocessable_entity
                 end
               end
             end
@@ -79,17 +79,17 @@ module Decidim
 
                 on(:invalid) do
                   flash.now[:alert] = I18n.t("update.invalid", scope: i18n_flashes_scope)
-                  render template: edit_questions_template
+                  render template: edit_questions_template, status: :unprocessable_entity
                 end
               end
             end
 
-            def answer_options
+            def response_options
               respond_to do |format|
                 format.json do
                   question_id = params["id"]
                   question = Question.find_by(id: question_id)
-                  render json: question.answer_options.map { |answer_option| AnswerOptionPresenter.new(answer_option).as_json } if question.present?
+                  render json: question.response_options.map { |response_option| ResponseOptionPresenter.new(response_option).as_json } if question.present?
                 end
               end
             end
@@ -113,7 +113,7 @@ module Decidim
             end
 
             # Implement this method in your controller to set the URL
-            # where the questionnaire can be answered.
+            # where the questionnaire can be responded.
             def public_url
               raise "#{self.class.name} is expected to implement #public_url"
             end
@@ -124,10 +124,10 @@ module Decidim
               "decidim/forms/admin/questionnaires/edit_questions"
             end
 
-            # Returns the url to get the answer options json (for the display conditions form)
+            # Returns the url to get the response 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 }])
+            def response_options_url(params)
+              url_for([questionnaire.questionnaire_for, { action: :response_options, format: :json, **params }])
             end
 
             # Implement this method in your controller to set the title
@@ -158,8 +158,8 @@ module Decidim
               @blank_question ||= Admin::QuestionForm.new
             end
 
-            def blank_answer_option
-              @blank_answer_option ||= Admin::AnswerOptionForm.new
+            def blank_response_option
+              @blank_response_option ||= Admin::ResponseOptionForm.new
             end
 
             def blank_display_condition

data/app/controllers/decidim/forms/admin/concerns/{has_questionnaire_answers.rb → has_questionnaire_responses.rb}

@@ -5,7 +5,7 @@ module Decidim
     module Admin
       module Concerns
         # Questionnaires can be related to any class in Decidim. In order to
-        # manage the questionnaires answers for a given type, you should create a new
+        # manage the questionnaires responses for a given type, you should create a new
         # controller and include the HasQuestionnaire concern as well as this one.
         #
         # In the controller that includes this concern, you should define a
@@ -14,50 +14,50 @@ module Decidim
         # `index_<model>_url` and `export_<model>_url` as well as
         # `show_<model>_url` and `export_response_<model>_url` (which are passed
         # a `:session_token` parameter)
-        module HasQuestionnaireAnswers
+        module HasQuestionnaireResponses
           extend ActiveSupport::Concern
 
           included do
             include Decidim::Paginable
-            include Decidim::Forms::Admin::Concerns::HasQuestionnaireAnswersUrlHelper
-            include Decidim::Forms::Admin::Concerns::HasQuestionnaireAnswersPaginationHelper
+            include Decidim::Forms::Admin::Concerns::HasQuestionnaireResponsesUrlHelper
+            include Decidim::Forms::Admin::Concerns::HasQuestionnaireResponsesPaginationHelper
 
-            helper Decidim::Forms::Admin::QuestionnaireAnswersHelper
+            helper Decidim::Forms::Admin::QuestionnaireResponsesHelper
 
             def index
-              enforce_permission_to :index, :questionnaire_answers
+              enforce_permission_to :index, permission_subject
 
               @query = paginate(collection)
               @participants = participants(@query)
               @total = questionnaire.count_participants
 
-              render template: "decidim/forms/admin/questionnaires/answers/index"
+              render template: "decidim/forms/admin/questionnaires/responses/index"
             end
 
             def show
-              enforce_permission_to :show, :questionnaire_answers
+              enforce_permission_to :show, permission_subject
 
               @participant = participant(participants_query.participant(params[:id]))
 
-              render template: "decidim/forms/admin/questionnaires/answers/show"
+              render template: "decidim/forms/admin/questionnaires/responses/show"
             end
 
             def export_response
-              enforce_permission_to :export_response, :questionnaire_answers
+              enforce_permission_to :export_response, permission_subject
 
               session_token = params[:id]
-              answers = QuestionnaireUserAnswers.for(questionnaire)
+              responses = QuestionnaireUserResponses.for(questionnaire)
 
-              # i18n-tasks-use t("decidim.forms.admin.questionnaires.answers.export_response.title")
+              # i18n-tasks-use t("decidim.forms.admin.questionnaires.responses.export_response.title")
               file_name = t("export_response.title", scope: i18n_scope, token: session_token)
 
-              selected_response = answers.select { |a| a.first.session_token == session_token }
+              selected_response = responses.select { |a| a.first.session_token == session_token }
 
-              Decidim::Forms::ExportQuestionnaireAnswersJob.perform_later(current_user, file_name, selected_response, :survey_user_answers)
+              Decidim::Forms::ExportQuestionnaireResponsesJob.perform_later(current_user, file_name, selected_response, :survey_user_responses)
 
               flash[:notice] = t("decidim.admin.exports.notice")
 
-              redirect_back(fallback_location: questionnaire_participant_answers_url(session_token))
+              redirect_back(fallback_location: questionnaire_participant_responses_url(session_token))
             end
 
             # Public: The only method to be implemented at the controller. You need to
@@ -68,8 +68,12 @@ module Decidim
 
             private
 
+            def permission_subject
+              :questionnaire_responses
+            end
+
             def i18n_scope
-              "decidim.forms.admin.questionnaires.answers"
+              "decidim.forms.admin.questionnaires.responses"
             end
 
             def questionnaire
@@ -84,12 +88,12 @@ module Decidim
               @collection ||= participants_query.participants
             end
 
-            def participant(answer)
-              Decidim::Forms::Admin::QuestionnaireParticipantPresenter.new(participant: answer)
+            def participant(response)
+              Decidim::Forms::Admin::QuestionnaireParticipantPresenter.new(participant: response)
             end
 
             def participants(query)
-              query.map { |answer| participant(answer) }
+              query.map { |response| participant(response) }
             end
           end
         end