decidim-forms 0.30.3 → 0.31.0.rc2

data/config/locales/zh-CN.yml

@@ -2,8 +2,6 @@
 zh-CN:
   activemodel:
     attributes:
-      answer:
-        body: 答案
       question:
         max_choices: 选择的最大数量
         question_type: 类型
@@ -17,36 +15,18 @@ zh-CN:
             description: 描述
             tos: 服务条款
         questionnaires:
-          actions:
-            show: 显示回复
-          answer_option:
-            answer_option: 答案选项
-            remove: 删除
-            statement: 声明
-          answers:
-            actions:
-              show: 显示答案
-            empty: 尚无答案
-            export_response:
-              title: survey_user_answers_%{token}
-            show:
-              title: '答案 #%{number}'
           display_condition:
-            answer_option: 答案选项
             condition_question: 问
             condition_type: 条件
             condition_types:
-              answered: 已回答
               equal: 等于
               match: 包含文本
-              not_answered: 未回答
               not_equal: 不等于
             condition_value: 包含文本
             display_condition: 显示条件
             mandatory: 无论其他条件的状况如何，总是需要满足这个条件
             remove: 删除
             save_warning: 在配置显示条件之前记住保存表单
-            select_answer_option: 选择答案选项
             select_condition_question: 选择一个问题
             select_condition_type: 选择一个条件类型
           edit:
@@ -62,7 +42,6 @@ zh-CN:
             remove: 删除
             statement: 声明
           question:
-            add_answer_option: 添加答案选项
             add_display_condition: 添加显示条件
             add_display_condition_info: 保存表单以配置显示条件
             add_matrix_row: 添加行
@@ -73,6 +52,9 @@ zh-CN:
             question: 问
             remove: 删除
             statement: 声明
+          responses:
+            actions:
+              show: 显示回复
           separator:
             remove: 删除
             separator: 分隔符
@@ -82,29 +64,18 @@ zh-CN:
       images:
         dimensions: "%{width} x %{height} px"
       question_types:
-        long_answer: 长答案
         matrix_multiple: 矩阵(多选项)
         matrix_single: 矩阵(单选项)
         multiple_option: 多选项
-        short_answer: 简短答案
         single_option: 单个选项
         sorting: 排序中
       questionnaires:
-        answer:
-          invalid: 回答表单时出现问题。
-          success: 表单回答成功。
         question:
           max_choices: '最大选择数: %{n}'
         show:
-          answer_questionnaire:
-            title: 回答表单
           current_step: 步骤 %{step}
           of_total_steps: '%{total_steps}'
-          questionnaire_answered:
-            body: 您已经回答过这个表单。
-            title: 已经回答
           questionnaire_closed:
-            body: 表格已关闭，无法解答。
             title: 表单已关闭
           questionnaire_for_private_users:
             body: 表单仅供私人用户使用
@@ -120,8 +91,3 @@ zh-CN:
           back: 后退
           continue: 继续
           submit: 提交
-      user_answers_serializer:
-        body: 答案
-        created_at: 回答于
-        id: 答案 ID
-        question: 问

data/config/locales/zh-TW.yml

@@ -2,8 +2,6 @@
 zh-TW:
   activemodel:
     attributes:
-      answer:
-        body: 回答
       question:
         max_choices: 選擇的最大數量
         question_type: 類別
@@ -18,36 +16,18 @@ zh-TW:
             description: 說明
             tos: 服務條款
         questionnaires:
-          actions:
-            show: 顯示回應
-          answer_option:
-            answer_option: 答案選項：
-            remove: 移除
-            statement: 聲明
-          answers:
-            actions:
-              show: 顯示答案
-            empty: 目前尚未回答
-            export_response:
-              title: 調查問卷使用者回答_%{token}
-            show:
-              title: '回答#%{number}'
           display_condition:
-            answer_option: 答案選項
             condition_question: 問題
             condition_type: 條件
             condition_types:
-              answered: 已回答
               equal: 等於
               match: 包含文字
-              not_answered: 未回答
               not_equal: 不等於
             condition_value: 包含文字
             display_condition: 顯示條件
             mandatory: 這個條件必須始終滿足，無論其他條件的狀態如何。
             remove: 移除
             save_warning: 在配置顯示條件之前，請記得保存表單。
-            select_answer_option: 選擇答案選項
             select_condition_question: 選取一個問題
             select_condition_type: 選擇一個條件類型
           edit:
@@ -64,7 +44,6 @@ zh-TW:
             remove: 移除
             statement: 聲明
           question:
-            add_answer_option: 新增答案選項
             add_display_condition: 新增顯示條件
             add_display_condition_info: 請先儲存表單再設定顯示條件
             add_matrix_row: 新增列
@@ -75,6 +54,9 @@ zh-TW:
             question: 問題
             remove: 移除
             statement: 聲明
+          responses:
+            actions:
+              show: 顯示回應
           separator:
             remove: 移除
             separator: 分隔線
@@ -98,30 +80,19 @@ zh-TW:
           resize_to_fit: 此圖片將被調整大小以符合 %{dimensions}。
       question_types:
         files: 檔案
-        long_answer: 長回答
         matrix_multiple: 矩陣（多重選項）
         matrix_single: 矩陣（單一選項）
         multiple_option: 多選
-        short_answer: 簡答
         single_option: 單選
         sorting: 排序中
         title_and_description: 標題和描述
       questionnaires:
-        answer:
-          invalid: 回答表單時出現問題
-          success: 表單已成功回答
         question:
           max_choices: '最多選擇數量： %{n}'
         show:
-          answer_questionnaire:
-            title: 回答表單 
           current_step: 步驟%{step}
           of_total_steps: 的%{total_steps}
-          questionnaire_answered:
-            body: 您已經回答過此表格。
-            title: 已經回答
           questionnaire_closed:
-            body: 該表格已關閉，無法回答。
             title: 表單已關閉
           questionnaire_for_private_users:
             body: 此表單僅適用於私人使用者
@@ -137,8 +108,3 @@ zh-TW:
           back: 返回
           continue: 繼續
           submit: 提交
-      user_answers_serializer:
-        body: 回答
-        created_at: 回答時間
-        id: 回答 ID
-        question: 問題

data/db/migrate/20190315203056_add_session_token_to_decidim_forms_answers.rb

@@ -10,7 +10,7 @@ class AddSessionTokenToDecidimFormsAnswers < ActiveRecord::Migration[5.2]
     add_index :decidim_forms_answers, :session_token
 
     Answer.find_each do |answer|
-      answer.session_token = Digest::MD5.hexdigest("#{answer.decidim_user_id}-#{Rails.application.secret_key_base}")
+      answer.session_token = Digest::SHA256.hexdigest("#{answer.decidim_user_id}-#{Rails.application.secret_key_base}")
       answer.save!
     end
   end

data/db/migrate/20250314150250_rename_answer_to_response_in_decidim_forms.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class RenameAnswerToResponseInDecidimForms < ActiveRecord::Migration[7.0]
+  def change
+    rename_index :decidim_forms_response_choices, "index_decidim_forms_answer_choices_answer_id", "index_decidim_forms_response_choices_response_id"
+    rename_index :decidim_forms_response_choices, "index_decidim_forms_answer_choices_answer_option_id", "index_decidim_forms_response_choices_response_option_id"
+
+    rename_index :decidim_forms_response_options, "index_decidim_forms_answer_options_question_id", "index_decidim_forms_response_options_question_id"
+
+    rename_index :decidim_forms_responses, "index_decidim_forms_answers_question_id", "index_decidim_forms_responses_question_id"
+    rename_index :decidim_forms_responses, "index_decidim_forms_answers_on_decidim_questionnaire_id", "index_decidim_forms_responses_on_decidim_questionnaire_id"
+    rename_index :decidim_forms_responses, "index_decidim_forms_answers_on_decidim_user_id", "index_decidim_forms_responses_on_decidim_user_id"
+    rename_index :decidim_forms_responses, "index_decidim_forms_answers_on_ip_hash", "index_decidim_forms_responses_on_ip_hash"
+    rename_index :decidim_forms_responses, "index_decidim_forms_answers_on_session_token", "index_decidim_forms_responses_on_session_token"
+
+    rename_index :decidim_forms_display_conditions, "decidim_forms_display_condition_answer_option", "decidim_forms_display_condition_response_option"
+
+    rename_table :decidim_forms_answers, :decidim_forms_responses
+    rename_table :decidim_forms_answer_choices, :decidim_forms_response_choices
+    rename_table :decidim_forms_answer_options, :decidim_forms_response_options
+
+    rename_column :decidim_forms_response_choices, :decidim_answer_id, :decidim_response_id
+    rename_column :decidim_forms_response_choices, :decidim_answer_option_id, :decidim_response_option_id
+
+    rename_column :decidim_forms_display_conditions, :decidim_answer_option_id, :decidim_response_option_id
+
+    rename_column :decidim_forms_questions, :answer_options_count, :response_options_count
+    rename_column :decidim_forms_questions, :survey_answers_published_at, :survey_responses_published_at
+  end
+end

data/db/migrate/20250319130003_change_question_types_in_questions.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class ChangeQuestionTypesInQuestions < ActiveRecord::Migration[7.0]
+  class Question < ApplicationRecord
+    self.table_name = :decidim_forms_questions
+  end
+
+  def change
+    # rubocop:disable Rails/SkipsModelValidations
+    Decidim::Forms::Question.where(question_type: "short_answer").update_all(question_type: "short_response")
+    Decidim::Forms::Question.where(question_type: "long_answer").update_all(question_type: "long_response")
+    # rubocop:enable Rails/SkipsModelValidations
+  end
+end

data/lib/decidim/api/question_matrix_row_type.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Forms
+    class QuestionMatrixRowType < Decidim::Api::Types::BaseObject
+      description "An response option for a multi-choice question in a questionnaire"
+
+      field :body, Decidim::Core::TranslatedFieldType, "The matrix row option text.", null: false
+      field :id, GraphQL::Types::ID, "ID of this matrix row option", null: false
+      field :position, GraphQL::Types::Int, "The position of this matrix row option.", null: false
+    end
+  end
+end

data/lib/decidim/api/question_type.rb

@@ -7,15 +7,16 @@ module Decidim
 
       implements Decidim::Core::TimestampsInterface
 
-      field :answer_options, [AnswerOptionType, { null: true }], "List of answer options in multi-choice questions.", 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 :id, GraphQL::Types::ID, "ID of this question", null: false
       field :mandatory, GraphQL::Types::Boolean, "Whether if this question is mandatory.", null: false
-      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 :max_choices, GraphQL::Types::Int, "On questions with answer options, maximum number of choices the user has", null: true
+      field :matrix_rows, [QuestionMatrixRowType, { null: true }], "List of matrix rows in matrix questions.", null: true
+      field :max_characters, GraphQL::Types::Int, "On questions with free text responses, maximum number of characters the response can have (0 if no limit)", null: false
+      field :max_choices, GraphQL::Types::Int, "On questions with response options, maximum number of choices the user has", null: true
       field :position, GraphQL::Types::Int, "Order position of the question in the questionnaire", null: true
       field :question_type, GraphQL::Types::String, "Type of question.", null: true
+      field :response_options, [ResponseOptionType, { null: true }], "List of response options in multi-choice questions.", null: false
     end
   end
 end

data/lib/decidim/api/questionnaire_type.rb

@@ -11,6 +11,7 @@ module Decidim
       field :for_entity, QuestionnaireEntityInterface, "Entity using this questionnaire.", method: :questionnaire_for, null: true
       field :for_type, GraphQL::Types::String, "Type of entity using this questionnaire.", method: :questionnaire_for_type, null: true
       field :id, GraphQL::Types::ID, "ID of this questionnaire", null: false
+      field :published_at, Decidim::Core::DateTimeType, description: "The date and time this questionnaire was published", null: true
       field :questions, [Decidim::Forms::QuestionType, { null: true }], "Questions in this questionnaire.", null: false
       field :title, Decidim::Core::TranslatedFieldType, "The title of this questionnaire.", null: false
       field :tos, Decidim::Core::TranslatedFieldType, "The Terms of Service for this questionnaire.", null: true

data/lib/decidim/api/response_option_type.rb

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

data/lib/decidim/exporters/form_pdf.rb

@@ -3,41 +3,41 @@
 module Decidim
   module Exporters
     # Inherits from abstract PDF exporter. This class is used to set
-    # the parameters used to create a PDF when exporting Survey Answers.
+    # the parameters used to create a PDF when exporting Survey Responses.
     #
     class FormPDF < PDF
       # i18n-tasks-use t('decidim.admin.exports.formats.FormPDF')
       include ActionView::Helpers::NumberHelper
-      include Decidim::Forms::Admin::QuestionnaireAnswersHelper
+      include Decidim::Forms::Admin::QuestionnaireResponsesHelper
 
-      class QuestionnaireAnswerPresenter < Decidim::Forms::Admin::QuestionnaireAnswerPresenter
+      class QuestionnaireResponsePresenter < Decidim::Forms::Admin::QuestionnaireResponsePresenter
         def choice(choice_hash)
           render_body_for choice_hash
         end
 
-        delegate :attachments, to: :answer
+        delegate :attachments, to: :response
 
         def body
-          return { string: answer.body } if answer.body.present?
-          return { attachments: answer.attachments } if answer.attachments.any?
-          return { string: "-" } if answer.choices.empty?
+          return { string: response.body } if response.body.present?
+          return { attachments: response.attachments } if response.attachments.any?
+          return { string: "-" } if response.choices.empty?
 
-          choices = answer.choices.map do |choice|
+          choices = response.choices.map do |choice|
             {
-              answer_option_body: choice.try(:answer_option).try(:translated_body),
+              response_option_body: choice.try(:response_option).try(:translated_body),
               choice_body: body_or_custom_body(choice)
             }
           end
 
-          return { single_option: choice(choices.first) } if answer.question.question_type == "single_option"
+          return { single_option: choice(choices.first) } if response.question.question_type == "single_option"
 
           { multiple_option: choices.map { |c| choice(c) } }
         end
       end
 
       class ParticipantPresenter < Decidim::Forms::Admin::QuestionnaireParticipantPresenter
-        def answers
-          siblings.map { |answer| QuestionnaireAnswerPresenter.new(answer:) }
+        def responses
+          siblings.map { |response| QuestionnaireResponsePresenter.new(response:) }
         end
       end
 
@@ -46,9 +46,9 @@ module Decidim
       def add_data!
         composer.text(decidim_sanitize(translated_attribute(questionnaire.title), strip_tags: true), style: :h1)
         composer.text(decidim_sanitize(translated_attribute(questionnaire.description), strip_tags: true), style: :description)
-        composer.text(I18n.t("title", scope: "decidim.forms.admin.questionnaires.answers.index", total: collection.count), style: :section_title)
+        composer.text(I18n.t("title", scope: "decidim.forms.admin.questionnaires.responses.index", total: collection.count), style: :section_title)
 
-        local_collection = collection.map { |answer| ParticipantPresenter.new(participant: answer.first) }
+        local_collection = collection.map { |response| ParticipantPresenter.new(participant: response.first) }
 
         local_collection.each_with_index do |record, index|
           add_response_box(record, index)
@@ -65,7 +65,7 @@ module Decidim
           description: { font:, margin: [0, 0, 10, 0], font_size: 10 },
           section_title: { font: bold_font, margin: [15, 0, 15, 0], font_size: 16 },
           question_title: { font: bold_font, margin: [10, 0, 10, 0], font_size: 12 },
-          question_answer: { font:, margin: [10, 0, 10, 0], font_size: 10 },
+          question_response: { font:, margin: [10, 0, 10, 0], font_size: 10 },
           file_info: { font:, margin: [10, 0, 10, 0], font_size: 8 },
           link: { font:, margin: [10, 0, 10, 0], font_size: 10, underline: true }
         }
@@ -73,11 +73,11 @@ module Decidim
 
       def header
         [
-          layout.text(I18n.t("session_token", scope: "decidim.forms.user_answers_serializer"), style: :th),
-          layout.text(I18n.t("user_status", scope: "decidim.forms.user_answers_serializer"), style: :th),
-          layout.text(I18n.t("ip_hash", scope: "decidim.forms.user_answers_serializer"), style: :th),
-          layout.text(I18n.t("completion", scope: "decidim.forms.user_answers_serializer"), style: :th),
-          layout.text(I18n.t("created_at", scope: "decidim.forms.user_answers_serializer"), style: :th)
+          layout.text(I18n.t("session_token", scope: "decidim.forms.user_responses_serializer"), style: :th),
+          layout.text(I18n.t("user_status", scope: "decidim.forms.user_responses_serializer"), style: :th),
+          layout.text(I18n.t("ip_hash", scope: "decidim.forms.user_responses_serializer"), style: :th),
+          layout.text(I18n.t("completion", scope: "decidim.forms.user_responses_serializer"), style: :th),
+          layout.text(I18n.t("created_at", scope: "decidim.forms.user_responses_serializer"), style: :th)
         ]
       end
 
@@ -87,31 +87,31 @@ module Decidim
           layout.text(record.status, style: :td),
           layout.text(record.ip_hash, style: :td),
           layout.text(display_percentage(record.completion), style: :td),
-          layout.text(I18n.l(record.answered_at, format: :short), style: :td)
+          layout.text(I18n.l(record.responded_at, format: :short), style: :td)
         ]
         composer.table([cells], header: ->(_table) { [header] }, cell_style: { border: { width: 0 } })
       end
 
       def add_response_box(record, index)
-        composer.text(I18n.t("title", number: index + 1, scope: "decidim.forms.admin.questionnaires.answers.export.answer"), style: :section_title)
+        composer.text(I18n.t("title", number: index + 1, scope: "decidim.forms.admin.questionnaires.responses.export.response"), style: :section_title)
         add_user_data(record)
 
-        record.answers.each do |answer|
-          composer.text(answer.question, style: :question_title)
-          add_answer_body(answer)
+        record.responses.each do |response|
+          composer.text(response.question, style: :question_title)
+          add_response_body(response)
         end
       end
 
-      def add_answer_body(answer)
-        return composer.text(answer.body[:string], style: :question_answer) if answer.body.has_key?(:string)
+      def add_response_body(response)
+        return composer.text(response.body[:string], style: :question_response) if response.body.has_key?(:string)
 
-        if answer.attachments.any?
+        if response.attachments.any?
           composer.list(marker_type: :disc) do |sub_list|
-            answer.attachments.each do |attachment|
+            response.attachments.each do |attachment|
               sub_list.formatted_text(
                 [{ link: attachment.url,
                    text: translated_attribute(attachment.title).presence ||
-                    I18n.t("download_attachment", scope: "decidim.forms.questionnaire_answer_presenter"),
+                    I18n.t("download_attachment", scope: "decidim.forms.questionnaire_response_presenter"),
                    style: :link },
                  " (#{attachment.file_type} #{number_to_human_size(attachment.file_size)})"],
                 style: :file_info
@@ -121,13 +121,13 @@ module Decidim
           return
         end
 
-        if answer.body.has_key?(:single_option)
+        if response.body.has_key?(:single_option)
           composer.list(marker_type: :disc) do |sub_list|
-            sub_list.text(answer.body[:single_option], style: :question_answer)
+            sub_list.text(response.body[:single_option], style: :question_response)
           end
         else
           composer.list(marker_type: :disc) do |sub_list|
-            answer.body[:multiple_option].map { |choice| sub_list.text(choice, style: :question_answer) }
+            response.body[:multiple_option].map { |choice| sub_list.text(choice, style: :question_response) }
           end
         end
       end

data/lib/decidim/forms/api.rb

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

data/lib/decidim/forms/{download_your_data_user_answers_serializer.rb → download_your_data_user_responses_serializer.rb}

@@ -2,9 +2,9 @@
 
 module Decidim
   module Forms
-    class DownloadYourDataUserAnswersSerializer < Decidim::Exporters::Serializer
+    class DownloadYourDataUserResponsesSerializer < Decidim::Exporters::Serializer
       include Decidim::TranslationsHelper
-      # Serializes an user answer for download your data
+      # Serializes an user response for download your data
       def serialize
         {
           id: resource.id,
@@ -19,7 +19,7 @@ module Decidim
             body: translated_attribute(resource.question.body),
             description: translated_attribute(resource.question.description)
           },
-          answer: normalize_body(resource)
+          response: normalize_body(resource)
         }
       end
 

data/lib/decidim/forms/engine.rb

@@ -12,14 +12,14 @@ module Decidim
         Cell::ViewModel.view_paths << File.expand_path("#{Decidim::Forms::Engine.root}/app/cells")
       end
 
-      initializer "decidim_forms.webpacker.assets_path" do
+      initializer "decidim_forms.shakapacker.assets_path" do
         Decidim.register_assets_path File.expand_path("app/packs", root)
       end
 
       initializer "decidim_forms.authorization_transfer" do
         config.to_prepare do
           Decidim::AuthorizationTransfer.register(:forms) do |transfer|
-            transfer.move_records(Decidim::Forms::Answer, :decidim_user_id)
+            transfer.move_records(Decidim::Forms::Response, :decidim_user_id)
           end
         end
       end