decidim-forms 0.30.3 → 0.31.0.rc1

data/lib/decidim/forms/test/shared_examples/manage_questionnaires/update_questions.rb

@@ -16,7 +16,7 @@ shared_examples_for "update questions" do
         fill_in "questions_questions_#{question.id}_body_en", with: "Modified question"
         fill_in "questions_questions_#{question.id}_max_characters", with: 30
         check "Mandatory"
-        select "Long answer", from: "Type"
+        select "Long response", from: "Type"
       end
 
       click_on "Save"
@@ -29,7 +29,7 @@ shared_examples_for "update questions" do
       expect(page).to have_no_css("input[value='This is the first question']")
       expect(page).to have_css("input#questions_questions_#{question.id}_mandatory[checked]")
       expect(page).to have_css("input#questions_questions_#{question.id}_max_characters[value='30']")
-      expect(page).to have_css("select#questions_questions_#{question.id}_question_type option[value='long_answer'][selected]")
+      expect(page).to have_css("select#questions_questions_#{question.id}_question_type option[value='long_response'][selected]")
     end
 
     it "re-renders the form when the information is invalid and displays errors" do
@@ -85,7 +85,7 @@ shared_examples_for "update questions" do
 
       expect(page).to have_admin_callout("successfully")
 
-      click_on "Manage questions"
+      click_on "Questions"
 
       expect(page).to have_css(".questionnaire-question", count: 0)
     end
@@ -169,7 +169,7 @@ shared_examples_for "update questions" do
 
       expect(page).to have_admin_callout("successfully")
 
-      click_on "Manage questions"
+      click_on "Questions"
 
       expect(page).to have_css(".questionnaire-question", count: 0)
     end
@@ -187,7 +187,7 @@ shared_examples_for "update questions" do
     end
   end
 
-  context "when a questionnaire has an existing question with answer options" do
+  context "when a questionnaire has an existing question with response options" do
     let!(:question) do
       create(
         :questionnaire_question,
@@ -205,13 +205,13 @@ shared_examples_for "update questions" do
 
     before do
       click_on "Save"
-      click_on "Manage questions"
+      click_on "Questions"
     end
 
-    it "allows deleting answer options" do
+    it "allows deleting response options" do
       expand_all_questions
 
-      within ".questionnaire-question-answer-option:last-of-type" do
+      within ".questionnaire-question-response-option:last-of-type" do
         click_on "Remove"
       end
 
@@ -219,7 +219,7 @@ shared_examples_for "update questions" do
 
       visit_manage_questions_and_expand_all
 
-      expect(page).to have_css(".questionnaire-question-answer-option", count: 2)
+      expect(page).to have_css(".questionnaire-question-response-option", count: 2)
     end
 
     it "still removes the question even if previous editions rendered the options invalid" do
@@ -227,7 +227,7 @@ shared_examples_for "update questions" do
 
       expand_all_questions
 
-      within ".questionnaire-question-answer-option:first-of-type" do
+      within ".questionnaire-question-response-option:first-of-type" do
         fill_in find_nested_form_field_locator("body_en"), with: ""
       end
 
@@ -283,7 +283,7 @@ shared_examples_for "update questions" do
 
       within ".questionnaire-question:last-of-type" do
         expect(page).to have_css(".questionnaire-question-matrix-row", count: 2)
-        expect(page).to have_css(".questionnaire-question-answer-option", count: 3)
+        expect(page).to have_css(".questionnaire-question-response-option", count: 3)
       end
     end
 
@@ -317,10 +317,6 @@ shared_examples_for "update questions" do
       create(:questionnaire_question, questionnaire:, body: second_body, position: 1)
     end
 
-    let!(:question3) do
-      create(:questionnaire_question, questionnaire:, body: third_body, position: 2)
-    end
-
     let(:first_body) do
       { en: "First", ca: "Primera", es: "Primera" }
     end
@@ -329,10 +325,6 @@ shared_examples_for "update questions" do
       { en: "Second", ca: "Segona", es: "Segunda" }
     end
 
-    let(:third_body) do
-      { en: "Third", ca: "Tercera", es: "Tercera" }
-    end
-
     before do
       click_on "Save"
       visit_manage_questions_and_expand_all
@@ -352,6 +344,26 @@ shared_examples_for "update questions" do
       end
     end
 
+    context "when moving a question up" do
+      before do
+        within ".questionnaire-question:last-of-type" do
+          click_on "Up"
+        end
+      end
+
+      it_behaves_like "switching questions order"
+    end
+
+    context "when moving a question down" do
+      before do
+        within ".questionnaire-question:first-of-type" do
+          click_on "Down"
+        end
+      end
+
+      it_behaves_like "switching questions order"
+    end
+
     describe "collapsible questions" do
       context "when clicking on Expand all button" do
         it "expands all questions" do
@@ -447,37 +459,16 @@ shared_examples_for "update questions" do
       click_on "Add question"
       expand_all_questions
 
-      question_cards = page.all(".questionnaire-question")
-      expect(question_cards.size).to eq(4)
-
-      within question_cards[1] do
-        expect(find("input[name*='[body_en]']").value).to eq("Second")
-      end
-      within question_cards[2] do
-        expect(find("input[name*='[body_en]']").value).to eq("Third")
-      end
+      expect(page.find(".questionnaire-question:nth-of-type(1)")).to look_like_first_question
+      expect(page.find(".questionnaire-question:nth-of-type(2)")).to look_like_intermediate_question
+      expect(page.find(".questionnaire-question:nth-of-type(3)")).to look_like_last_question
 
       within ".questionnaire-question:first-of-type" do
         click_on "Remove"
       end
 
-      remaining_cards = page.all(".questionnaire-question")
-      expect(remaining_cards.size).to eq(3)
-
-      # Check that the first question is now what was previously the second
-      within remaining_cards.first do
-        expect(find("input[name*='[body_en]']").value).to eq("Second")
-      end
-
-      # Check that the second question is now what was previously the third
-      within remaining_cards[1] do
-        expect(find("input[name*='[body_en]']").value).to eq("Third")
-      end
-
-      # The last question should be the new empty question
-      within remaining_cards.last do
-        expect(find("input[name*='[body_en]']").value).to eq("")
-      end
+      expect(page.all(".questionnaire-question").first).to look_like_first_question
+      expect(page.all(".questionnaire-question").last).to look_like_last_question
     end
 
     it "does not duplicate editors when adding new questions" do
@@ -487,26 +478,26 @@ shared_examples_for "update questions" do
       end.to change { page.all(".editor-toolbar").size }.by(1)
     end
 
-    it "properly decides which button to show after adding/removing answer options" do
+    it "properly decides which button to show after adding/removing response options" do
       click_on "Add question"
       expand_all_questions
 
       within ".questionnaire-question:last-of-type" do
         select "Single option", from: "Type"
 
-        within ".questionnaire-question-answer-options-list" do
+        within ".questionnaire-question-response-options-list" do
           expect(page).to have_no_button("Remove")
         end
 
-        click_on "Add answer option"
+        click_on "Add response option"
 
-        expect(page.all(".questionnaire-question-answer-option")).to all(have_button("Remove"))
+        expect(page.all(".questionnaire-question-response-option")).to all(have_button("Remove"))
 
-        within ".questionnaire-question-answer-option:first-of-type" do
+        within ".questionnaire-question-response-option:first-of-type" do
           click_on "Remove"
         end
 
-        within ".questionnaire-question-answer-options-list" do
+        within ".questionnaire-question-response-options-list" do
           expect(page).to have_no_button("Remove")
         end
       end
@@ -515,100 +506,12 @@ shared_examples_for "update questions" do
       expand_all_questions
 
       within ".questionnaire-question:last-of-type" do
-        within ".questionnaire-question-answer-options-list" do
+        within ".questionnaire-question-response-options-list" do
           expect(page).to have_no_button("Remove")
         end
       end
     end
 
-    context "when reordering questions with drag and drop", :js do
-      before do
-        expand_all_questions
-      end
-
-      it "allows moving questions using drag and drop" do
-        question_cards = all(".questionnaire-question")
-
-        # Verify initial order by checking the body field values
-        within question_cards[0] do
-          expect(find("input[name*='[body_en]']").value).to eq("First")
-        end
-        within question_cards[1] do
-          expect(find("input[name*='[body_en]']").value).to eq("Second")
-        end
-        within question_cards[2] do
-          expect(find("input[name*='[body_en]']").value).to eq("Third")
-        end
-
-        # JavaScript to simulate drag and drop.
-        page.execute_script(<<~JS)
-          var questions = document.querySelectorAll('.questionnaire-question');
-          var container = questions[0].parentNode;
-          var second = questions[1];
-          var first = questions[0];
-
-          // Move second question before first
-          container.insertBefore(second, first);
-
-          // Update position values
-          var updatedQuestions = container.querySelectorAll('.questionnaire-question');
-          updatedQuestions.forEach(function(question, index) {
-            var positionInput = question.querySelector('input[name$="[position]"]');
-            if (positionInput) positionInput.value = index;
-          });
-        JS
-
-        sleep 0.5
-
-        question_cards = all(".questionnaire-question")
-        within question_cards[0] do
-          expect(find("input[name*='[body_en]']").value).to eq("Second")
-        end
-        within question_cards[1] do
-          expect(find("input[name*='[body_en]']").value).to eq("First")
-        end
-        within question_cards[2] do
-          expect(find("input[name*='[body_en]']").value).to eq("Third")
-        end
-      end
-
-      it "persists drag and drop changes when saving" do
-        # Move second question to last position
-        page.execute_script(<<~JS)
-          var questions = document.querySelectorAll('.questionnaire-question');
-          var container = questions[0].parentNode;
-          var second = questions[1];
-
-          container.appendChild(second);
-
-          // Update the positions of questions
-          var updatedQuestions = container.querySelectorAll('.questionnaire-question');
-          updatedQuestions.forEach(function(question, index) {
-            var positionInput = question.querySelector('input[name$="[position]"]');
-            if (positionInput) positionInput.value = index;
-          });
-        JS
-
-        sleep 0.5
-
-        click_on "Save"
-        expect(page).to have_admin_callout("successfully")
-
-        visit_manage_questions_and_expand_all
-
-        question_cards = all(".questionnaire-question")
-        within question_cards[0] do
-          expect(find("input[name*='[body_en]']").value).to eq("First")
-        end
-        within question_cards[1] do
-          expect(find("input[name*='[body_en]']").value).to eq("Third")
-        end
-        within question_cards[2] do
-          expect(find("input[name*='[body_en]']").value).to eq("Second")
-        end
-      end
-    end
-
     private
 
     def look_like_first_question

data/lib/decidim/forms/test/shared_examples/manage_questionnaires.rb

@@ -24,7 +24,7 @@ shared_examples_for "manage questionnaires" do
     }
   end
 
-  context "when the questionnaire is not already answered" do
+  context "when the questionnaire is not already responded" do
     before do
       visit manage_questions_path
     end
@@ -35,9 +35,9 @@ shared_examples_for "manage questionnaires" do
     it_behaves_like "update display conditions"
   end
 
-  context "when the questionnaire is already answered" do
+  context "when the questionnaire is already responded" do
     let!(:question) { create(:questionnaire_question, questionnaire:, body:, question_type: "multiple_option") }
-    let!(:answer) { create(:answer, questionnaire:, question:) }
+    let!(:response) { create(:response, questionnaire:, question:) }
 
     it "cannot modify questionnaire questions" do
       visit manage_questions_path
@@ -92,7 +92,7 @@ shared_examples_for "manage questionnaires" do
   end
 
   def visit_manage_questions_and_expand_all
-    click_on "Manage questions"
+    click_on "Questions"
     expand_all_questions
   end
 end

data/lib/decidim/forms/test.rb

@@ -2,7 +2,7 @@
 
 require "decidim/forms/test/shared_examples/has_questionnaire"
 require "decidim/forms/test/shared_examples/manage_questionnaires"
-require "decidim/forms/test/shared_examples/manage_questionnaire_answers"
+require "decidim/forms/test/shared_examples/manage_questionnaire_responses"
 
 if defined? Decidim::Templates
   require "decidim/templates/test/shared_examples/uses_questionnaire_templates"

data/lib/decidim/forms/user_responses_serializer.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Forms
+    # This class serializes the responses given by a User for questionnaire so can be
+    # exported to CSV, JSON or other formats.
+    class UserResponsesSerializer < Decidim::Exporters::Serializer
+      include Decidim::TranslationsHelper
+
+      # Public: Initializes the serializer with a collection of Responses.
+      def initialize(responses)
+        @responses = responses
+      end
+
+      # i18n-tasks-use t('decidim.forms.user_responses_serializer.body')
+      # i18n-tasks-use t('decidim.forms.user_responses_serializer.id')
+      # i18n-tasks-use t('decidim.forms.user_responses_serializer.question')
+      # i18n-tasks-use t('decidim.forms.user_responses_serializer.registered')
+      # i18n-tasks-use t('decidim.forms.user_responses_serializer.unregistered')
+      # Public: Exports a hash with the serialized data for the user responses.
+      def serialize
+        responses_hash = hash_for(@responses.first)
+        responses_hash.merge!(questions_hash)
+
+        @responses.each do |response|
+          responses_hash[translated_question_key(response.question.position, response.question.body)] = normalize_body(response)
+        end
+
+        responses_hash
+      end
+
+      private
+
+      attr_reader :responses
+      alias resource responses
+
+      def hash_for(response)
+        {
+          response_translated_attribute_name(:id) => response&.session_token,
+          response_translated_attribute_name(:created_at) => response&.created_at,
+          response_translated_attribute_name(:ip_hash) => response&.ip_hash,
+          response_translated_attribute_name(:user_status) => response_translated_attribute_name(response&.decidim_user_id.present? ? "registered" : "unregistered")
+        }
+      end
+
+      def questions_hash
+        questionnaire_id = @responses.first&.decidim_questionnaire_id
+        return {} unless questionnaire_id
+
+        questions = Decidim::Forms::Question.where(decidim_questionnaire_id: questionnaire_id).order(:position)
+        return {} if questions.none?
+
+        questions.each.inject({}) do |serialized, question|
+          serialized.update(
+            translated_question_key(question.position, question.body) => ""
+          )
+        end
+      end
+
+      def translated_question_key(idx, body)
+        "#{idx + 1}. #{translated_attribute(body)}"
+      end
+
+      def normalize_body(response)
+        response.body ||
+          normalize_attachments(response) ||
+          normalize_choices(response, response.choices)
+      end
+
+      def normalize_attachments(response)
+        return if response.attachments.blank?
+
+        response.attachments.map(&:url)
+      end
+
+      def normalize_choices(response, choices)
+        if response.question.matrix?
+          normalize_matrix_choices(response, choices)
+        else
+          choices.map do |choice|
+            format_free_text_for choice
+          end
+        end
+      end
+
+      def normalize_matrix_choices(response, choices)
+        response.question.matrix_rows.to_h do |matrix_row|
+          row_body = translated_attribute(matrix_row.body)
+
+          row_choices = response.question.response_options.map do |response_option|
+            choice = choices.find_by(matrix_row:, response_option:)
+            choice.try(:custom_body) || choice.try(:body)
+          end
+
+          [row_body, row_choices]
+        end
+      end
+
+      def response_translated_attribute_name(attribute)
+        I18n.t(attribute.to_sym, scope: "decidim.forms.user_responses_serializer")
+      end
+
+      def format_free_text_for(choice)
+        return choice.try(:body) if choice.try(:custom_body).blank?
+
+        "#{choice.try(:body)} (#{choice.try(:custom_body)})"
+      end
+    end
+  end
+end

data/lib/decidim/forms/version.rb

@@ -4,7 +4,7 @@ module Decidim
   # This holds the decidim-forms version.
   module Forms
     def self.version
-      "0.30.3"
+      "0.31.0.rc1"
     end
   end
 end

data/lib/decidim/forms.rb

@@ -8,8 +8,8 @@ require "decidim/forms/admin_engine"
 module Decidim
   # This namespace holds the logic of the `Forms`.
   module Forms
-    autoload :UserAnswersSerializer, "decidim/forms/user_answers_serializer"
-    autoload :DownloadYourDataUserAnswersSerializer, "decidim/forms/download_your_data_user_answers_serializer"
+    autoload :UserResponsesSerializer, "decidim/forms/user_responses_serializer"
+    autoload :DownloadYourDataUserResponsesSerializer, "decidim/forms/download_your_data_user_responses_serializer"
   end
 
   module Exporters