decidim-forms 0.23.2 → 0.24.0

data/config/locales/zh-CN.yml

@@ -78,7 +78,6 @@ zh-CN:
             collapse: 收起所有问题
             expand: 展开所有问题
             preview: 预览
-            title: 编辑表单
             unpublished_warning: 表单未发布。您可以修改它的问题，但这样做将删除当前答案。
           matrix_row:
             matrix_row: 行
@@ -110,7 +109,7 @@ zh-CN:
         answer:
           body: 主体不能为空
       files:
-        extension_whitelist: '接受的格式：'
+        extension_allowlist: '接受的格式：'
       images:
         dimensions: "%{width} x %{height} px"
         dimensions_info: '这张图片将是：'

data/db/migrate/20210208094442_add_max_characters_to_decidim_forms_questions.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddMaxCharactersToDecidimFormsQuestions < ActiveRecord::Migration[5.2]
+  def change
+    add_column :decidim_forms_questions, :max_characters, :integer, default: 0
+  end
+end

data/lib/decidim/api/answer_option_type.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Forms
+    class AnswerOptionType < Decidim::Api::Types::BaseObject
+      description "An answer option for a multi-choice question in a questionnaire"
+
+      field :id, GraphQL::Types::ID, "ID of this answer option", null: false
+      field :body, Decidim::Core::TranslatedFieldType, "The text answer response option.", null: false
+      field :free_text, GraphQL::Types::Boolean, "Whether if this answer accepts any free text from the user.", null: false
+    end
+  end
+end

data/lib/decidim/api/question_type.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Forms
+    class QuestionType < Decidim::Api::Types::BaseObject
+      description "A question in a questionnaire"
+
+      implements Decidim::Core::TimestampsInterface
+
+      field :id, GraphQL::Types::ID, "ID of this question", null: false
+      field :body, Decidim::Core::TranslatedFieldType, "What is being asked in this question.", null: false
+      field :description, Decidim::Core::TranslatedFieldType, "The description of this question.", null: true
+      field :mandatory, GraphQL::Types::Boolean, "Whether if this question is mandatory.", null: false
+      field :position, GraphQL::Types::Int, "Order position of the question in the questionnaire", null: true
+      field :max_choices, GraphQL::Types::Int, "On questions with answer options, maximum number of choices the user has", null: true
+      field :max_characters, GraphQL::Types::Int, "On questions with free text answers, maximum number of characters the answer can have (0 if no limit)", null: false
+      field :question_type, GraphQL::Types::String, "Type of question.", null: true
+      field :answer_options, [AnswerOptionType, { null: true }], "List of answer options in multi-choice questions.", null: false
+    end
+  end
+end

data/lib/decidim/api/questionnaire_entity_interface.rb

@@ -4,15 +4,15 @@ module Decidim
   module Forms
     # This interface should be implemented by any Type that can be linked to a questionnaire
     # The only requirement is to have an ID and the Type name be the class.name + Type
-    QuestionnaireEntityInterface = GraphQL::InterfaceType.define do
-      name "QuestionnaireEntityInterface"
+    module QuestionnaireEntityInterface
+      include Decidim::Api::Types::BaseInterface
       description "An interface that can be used in objects with questionnaires"
 
-      field :id, !types.ID, "ID of this entity"
+      field :id, GraphQL::Types::ID, "ID of this entity", null: false
 
-      resolve_type ->(obj, _ctx) {
+      def self.resolve_type(obj, _ctx)
         "#{obj.class.name}Type".constantize
-      }
+      end
     end
   end
 end

data/lib/decidim/api/questionnaire_type.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Forms
+    class QuestionnaireType < Decidim::Api::Types::BaseObject
+      description "A questionnaire"
+
+      implements Decidim::Core::TimestampsInterface
+
+      field :id, GraphQL::Types::ID, "ID of this questionnaire", null: false
+      field :title, Decidim::Core::TranslatedFieldType, "The title of this questionnaire.", null: false
+      field :description, Decidim::Core::TranslatedFieldType, "The description of this questionnaire.", null: true
+      field :tos, Decidim::Core::TranslatedFieldType, "The Terms of Service for this questionnaire.", null: true
+      field :for_type, GraphQL::Types::String, "Type of entity using this questionnaire.", method: :questionnaire_for_type, null: true
+      field :for_entity, QuestionnaireEntityInterface, "Entity using this questionnaire.", method: :questionnaire_for, null: true
+      field :questions, [Decidim::Forms::QuestionType, { null: true }], "Questions in this questionnaire.", null: false
+    end
+  end
+end

data/lib/decidim/exporters/form_pdf_controller_helper.rb

@@ -2,8 +2,10 @@
 
 module Decidim
   module Exporters
+    # rubocop: disable Rails/ApplicationController
     # A dummy controller to render views while exporting questionnaires
     class FormPDFControllerHelper < ActionController::Base
+      # rubocop: enable Rails/ApplicationController
       helper Decidim::TranslationsHelper
       helper Decidim::Forms::Admin::QuestionnaireAnswersHelper
     end

data/lib/decidim/forms.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 require "decidim/forms/admin"
+require "decidim/forms/api"
 require "decidim/forms/engine"
 require "decidim/forms/admin_engine"
-require "decidim/forms/api"
 
 module Decidim
   # This namespace holds the logic of the `Forms`.

data/lib/decidim/forms/api.rb

@@ -3,5 +3,8 @@
 module Decidim
   module Forms
     autoload :QuestionnaireEntityInterface, "decidim/api/questionnaire_entity_interface"
+    autoload :AnswerOptionType, "decidim/api/answer_option_type"
+    autoload :QuestionType, "decidim/api/question_type"
+    autoload :QuestionnaireType, "decidim/api/questionnaire_type"
   end
 end

data/lib/decidim/forms/data_portability_user_answers_serializer.rb

@@ -30,7 +30,13 @@ module Decidim
       private
 
       def normalize_body(resource)
-        resource.body || resource.choices.pluck(:body)
+        attachments_for(resource) || resource.body || resource.choices.pluck(:body)
+      end
+
+      def attachments_for(resource)
+        return if resource.attachments.blank?
+
+        resource.attachments.map(&:url)
       end
     end
   end

data/lib/decidim/forms/test/factories.rb

@@ -17,10 +17,13 @@ FactoryBot.define do
 
     trait :with_questions do
       questions do
+        position = 0
         qs = %w(short_answer long_answer).collect do |text_question_type|
-          build(:questionnaire_question, question_type: text_question_type)
+          q = build(:questionnaire_question, question_type: text_question_type, position: position)
+          position += 1
+          q
         end
-        qs << build(:questionnaire_question, :with_answer_options, question_type: :single_option)
+        qs << build(:questionnaire_question, :with_answer_options, question_type: :single_option, position: position)
         qs
       end
     end
@@ -91,6 +94,13 @@ FactoryBot.define do
     question { create(:questionnaire_question, questionnaire: questionnaire) }
     user { create(:user, organization: questionnaire.questionnaire_for.organization) }
     session_token { Digest::MD5.hexdigest(user.id.to_s) }
+
+    trait :with_attachments do
+      after(:create) do |answer, _evaluator|
+        create :attachment, :with_image, attached_to: answer
+        create :attachment, :with_pdf, attached_to: answer
+      end
+    end
   end
 
   factory :answer_option, class: "Decidim::Forms::AnswerOption" do

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

@@ -194,6 +194,28 @@ shared_examples_for "has questionnaire" do
       end
     end
 
+    shared_examples_for "question has a character limit" do
+      context "when max_characters value is positive" do
+        let(:max_characters) { 30 }
+
+        it "shows a message indicating number of characters left" do
+          visit questionnaire_public_path
+
+          expect(page).to have_content("30 characters left")
+        end
+      end
+
+      context "when max_characters value is 0" do
+        let(:max_characters) { 0 }
+
+        it "doesn't show message indicating number of characters left" do
+          visit questionnaire_public_path
+
+          expect(page).not_to have_content("characters left")
+        end
+      end
+    end
+
     describe "leaving a blank question (without js)", driver: :rack_test do
       include_context "when a non multiple choice question is mandatory"
 
@@ -268,12 +290,13 @@ shared_examples_for "has questionnaire" do
 
     describe "free text options" do
       let(:answer_option_bodies) { Array.new(3) { Decidim::Faker::Localized.sentence } }
-
+      let(:max_characters) { 0 }
       let!(:question) do
         create(
           :questionnaire_question,
           questionnaire: questionnaire,
           question_type: question_type,
+          max_characters: max_characters,
           position: 1,
           options: [
             { "body" => answer_option_bodies[0] },
@@ -346,6 +369,8 @@ shared_examples_for "has questionnaire" do
 
           expect(page).to have_field("questionnaire_responses_0_choices_2_custom_body", with: "Cacatua")
         end
+
+        it_behaves_like "question has a character limit"
       end
 
       context "when question is multiple_option type" do
@@ -392,27 +417,35 @@ shared_examples_for "has questionnaire" do
 
           expect(page).to have_field("questionnaire_responses_0_choices_2_custom_body", with: "Cacatua")
         end
+
+        it_behaves_like "question has a character limit"
       end
     end
 
     context "when question type is long answer" do
-      let!(:question) { create(:questionnaire_question, questionnaire: questionnaire, question_type: "long_answer") }
+      let(:max_characters) { 0 }
+      let!(:question) { create(:questionnaire_question, questionnaire: questionnaire, question_type: "long_answer", max_characters: max_characters) }
 
       it "renders the answer as a textarea" do
         visit questionnaire_public_path
 
         expect(page).to have_selector("textarea#questionnaire_responses_0")
       end
+
+      it_behaves_like "question has a character limit"
     end
 
     context "when question type is short answer" do
-      let!(:question) { create(:questionnaire_question, questionnaire: questionnaire, question_type: "short_answer") }
+      let(:max_characters) { 0 }
+      let!(:question) { create(:questionnaire_question, questionnaire: questionnaire, question_type: "short_answer", max_characters: max_characters) }
 
       it "renders the answer as a text field" do
         visit questionnaire_public_path
 
         expect(page).to have_selector("input[type=text]#questionnaire_responses_0")
       end
+
+      it_behaves_like "question has a character limit"
     end
 
     context "when question type is single option" do
@@ -665,7 +698,7 @@ shared_examples_for "has questionnaire" do
         end
 
         radio_buttons = page.all(".radio-button-collection input[type=radio]")
-        expect(radio_buttons.map { |b| b[:checked] }).to eq([nil, "true", nil, nil])
+        expect(radio_buttons.pluck(:checked)).to eq([nil, "true", nil, nil])
       end
 
       context "when the question is mandatory and the answer is not complete" do
@@ -830,7 +863,7 @@ shared_examples_for "has questionnaire" do
           end
 
           checkboxes = page.all(".check-box-collection input[type=checkbox]")
-          expect(checkboxes.map { |c| c[:checked] }).to eq(["true", "true", "true", nil, nil, "true"])
+          expect(checkboxes.pluck(:checked)).to eq(["true", "true", "true", nil, nil, "true"])
         end
       end
     end

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

@@ -2,10 +2,10 @@
 
 require "spec_helper"
 
-require "decidim/forms/test/shared_examples/manage_questionnaires/add_questions.rb"
-require "decidim/forms/test/shared_examples/manage_questionnaires/update_questions.rb"
-require "decidim/forms/test/shared_examples/manage_questionnaires/add_display_conditions.rb"
-require "decidim/forms/test/shared_examples/manage_questionnaires/update_display_conditions.rb"
+require "decidim/forms/test/shared_examples/manage_questionnaires/add_questions"
+require "decidim/forms/test/shared_examples/manage_questionnaires/update_questions"
+require "decidim/forms/test/shared_examples/manage_questionnaires/add_display_conditions"
+require "decidim/forms/test/shared_examples/manage_questionnaires/update_display_conditions"
 
 shared_examples_for "manage questionnaires" do
   let(:body) do
@@ -63,6 +63,7 @@ shared_examples_for "manage questionnaires" do
       expect(page).to have_selector("input[value='This is the first question'][disabled]")
       expect(page).to have_selector("select[id$=question_type][disabled]")
       expect(page).to have_selector("select[id$=max_choices][disabled]")
+      expect(page).to have_selector("input[id$=max_characters][disabled]")
       expect(page).to have_selector(".ql-editor[contenteditable=false]")
     end
   end

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

@@ -39,18 +39,21 @@ shared_examples_for "add display conditions" do
     context "when questionnaire has more than one question" do
       let!(:question_short_answer) do
         create(:questionnaire_question,
+               position: 0,
                questionnaire: questionnaire,
                body: Decidim::Faker::Localized.sentence,
                question_type: "short_answer")
       end
       let!(:question_long_answer) do
         create(:questionnaire_question,
+               position: 1,
                questionnaire: questionnaire,
                body: Decidim::Faker::Localized.sentence,
                question_type: "long_answer")
       end
       let!(:question_single_option) do
         create(:questionnaire_question,
+               position: 2,
                questionnaire: questionnaire,
                body: Decidim::Faker::Localized.sentence,
                question_type: "single_option",
@@ -58,6 +61,7 @@ shared_examples_for "add display conditions" do
       end
       let!(:question_multiple_option) do
         create(:questionnaire_question,
+               position: 3,
                questionnaire: questionnaire,
                body: Decidim::Faker::Localized.sentence,
                question_type: "multiple_option",
@@ -101,7 +105,7 @@ shared_examples_for "add display conditions" do
 
             within "select[id$=decidim_condition_question_id]" do
               elements = page.all("option[data-type]")
-              expect(elements.map { |element| element[:"data-type"] }).to eq(questions.map(&:question_type))
+              expect(elements.map { |element| element[:"data-type"] }).to match_array(questions.map(&:question_type))
               expect(page.find("option[value='#{questions.last.id}']")).to be_disabled
             end
           end
@@ -117,7 +121,7 @@ shared_examples_for "add display conditions" do
               option_elements = page.all("select[id$=condition_type] option")
               option_elements = option_elements.to_a.reject { |option| option[:style].match? "display: none" }
 
-              expect(option_elements.map(&:text)).to eq(options)
+              expect(option_elements.map(&:text)).to match_array(options)
             end
           end
         end
@@ -132,7 +136,7 @@ shared_examples_for "add display conditions" do
               option_elements = page.all("select[id$=condition_type] option")
               option_elements = option_elements.to_a.reject { |option| option[:style].match? "display: none" }
 
-              expect(option_elements.map(&:text)).to eq(options)
+              expect(option_elements.map(&:text)).to match_array(options)
             end
           end
         end

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

@@ -41,7 +41,7 @@ shared_examples_for "add questions" do
       within ".questionnaire-question" do
         fill_in find_nested_form_field_locator("body_en"), with: "Body"
 
-        fill_in_editor find_nested_form_field_locator("description_en", visible: false), with: "<b>Superkalifragilistic description</b>"
+        fill_in_editor find_nested_form_field_locator("description_en", visible: false), with: "<strong>Superkalifragilistic description</strong>"
       end
 
       click_button "Save"

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

@@ -15,6 +15,7 @@ shared_examples_for "update questions" do
       within "form.edit_questionnaire" do
         within ".questionnaire-question" do
           fill_in "questionnaire_questions_#{question.id}_body_en", with: "Modified question"
+          fill_in "questionnaire_questions_#{question.id}_max_characters", with: 30
           check "Mandatory"
           select "Long answer", from: "Type"
         end
@@ -29,6 +30,7 @@ shared_examples_for "update questions" do
       expect(page).to have_selector("input[value='Modified question']")
       expect(page).to have_no_selector("input[value='This is the first question']")
       expect(page).to have_selector("input#questionnaire_questions_#{question.id}_mandatory[checked]")
+      expect(page).to have_selector("input#questionnaire_questions_#{question.id}_max_characters[value='30']")
       expect(page).to have_selector("select#questionnaire_questions_#{question.id}_question_type option[value='long_answer'][selected]")
     end
 
@@ -39,6 +41,7 @@ shared_examples_for "update questions" do
         within ".questionnaire-question" do
           expect(page).to have_content("Statement*")
           fill_in "questionnaire_questions_#{question.id}_body_en", with: ""
+          fill_in "questionnaire_questions_#{question.id}_max_characters", with: -3
           check "Mandatory"
           select "Matrix (Multiple option)", from: "Type"
           select "2", from: "Maximum number of choices"
@@ -51,10 +54,12 @@ shared_examples_for "update questions" do
 
       expect(page).to have_admin_callout("There was a problem saving")
       expect(page).to have_content("can't be blank", count: 5) # emtpy question, 2 empty default answer options, 2 empty default matrix rows
+      expect(page).to have_content("must be greater than or equal to 0", count: 1)
 
       expect(page).to have_selector("input[value='']")
       expect(page).to have_no_selector("input[value='This is the first question']")
       expect(page).to have_selector("input#questionnaire_questions_#{question.id}_mandatory[checked]")
+      expect(page).to have_selector("input#questionnaire_questions_#{question.id}_max_characters[value='-3']")
       expect(page).to have_select("Maximum number of choices", selected: "2")
       expect(page).to have_selector("select#questionnaire_questions_#{question.id}_question_type option[value='matrix_multiple'][selected]")
     end

data/lib/decidim/forms/user_answers_serializer.rb

@@ -28,7 +28,15 @@ module Decidim
       private
 
       def normalize_body(answer)
-        answer.body || normalize_choices(answer, answer.choices)
+        answer.body ||
+          normalize_attachments(answer) ||
+          normalize_choices(answer, answer.choices)
+      end
+
+      def normalize_attachments(answer)
+        return if answer.attachments.blank?
+
+        answer.attachments.map(&:url)
       end
 
       def normalize_choices(answer, choices)

data/lib/decidim/forms/version.rb

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