decidim-forms 0.29.1 → 0.30.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3538292d4f18c87b2db6997a34a46b00c4bf71803383a5f24a8fbd21b8dc569
-  data.tar.gz: 9cd1f427d6a6dff2a437c70954edca296f410cef40033096d7ee64c4033cc047
+  metadata.gz: 88f55a44bfdc1edbc0cddbc6be9c92218449a7f0cfc0b846815c6be47fa1fe54
+  data.tar.gz: c743a5ff7aeca3316201d4cc29bdec1d2f04761c138fcddf2d4885972a5b60a9
 SHA512:
-  metadata.gz: 3705165bf5657f09dd1c0abc0b63b8e9695644e80a2f4ea1946e38631dfcdce7da647cc6698c060c76e90fdac306daf3f9347647491a2a68790659e4dc385134
-  data.tar.gz: 5da1fe15aecb9b91820e69a1e87fea6e30a24e6df3dc332fe917957a5960ca4770424a933b9e447dd4571df971e4697b503519d2d038b3bb08a7103bc91a83fa
+  metadata.gz: 92256e91c6951c78dc7579825fbe5ce644b3963d7c50eae712177db4bdd5364157084dad33d5b3a50d057bb540ce6c0e82083c7658a5f9e45189515625ed7009
+  data.tar.gz: 4cc6461edd3c41995e38f1f0d80582c5c1e12f5062d5ebbc4a321573d98ff4d2c80758aa7ed8180eb0b210f731de03ff5961874ca4e4b5952226b0392f13000a

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

@@ -40,12 +40,25 @@ module Decidim
         "step-#{current_step_index}"
       end
 
+      def allow_editing_answers?
+        options[:allow_editing_answers]
+      end
+
       def confirm_data
-        { data: {
-          confirm: t("decidim.forms.step_navigation.show.are_you_sure"),
-          disable: true,
-          data: "survey-buttons"
-        } }
+        {
+          data: {
+            confirm:,
+            disable: true,
+            data: "survey-buttons"
+          }
+        }
+      end
+
+      def confirm
+        return t("decidim.forms.step_navigation.show.are_you_sure_no_edit") unless allow_editing_answers?
+        return t("decidim.forms.step_navigation.show.are_you_sure_edit_guest") unless current_user
+
+        t("decidim.forms.step_navigation.show.are_you_sure_edit")
       end
     end
   end

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

@@ -25,14 +25,7 @@ module Decidim
           Decidim.traceability.perform_action!("update",
                                                @questionnaire,
                                                @user) do
-            Decidim::Forms::Questionnaire.transaction do
-              if @questionnaire.questions_editable?
-                update_questionnaire_questions
-                delete_answers unless @questionnaire.published?
-              end
-
-              update_questionnaire
-            end
+            update_questionnaire
           end
 
           broadcast(:ok)
@@ -40,85 +33,11 @@ module Decidim
 
         private
 
-        def update_questionnaire_questions
-          @form.questions.each do |form_question|
-            update_questionnaire_question(form_question)
-          end
-        end
-
-        def update_questionnaire_question(form_question)
-          question_attributes = {
-            body: form_question.body,
-            description: form_question.description,
-            position: form_question.position,
-            mandatory: form_question.mandatory,
-            question_type: form_question.question_type,
-            max_choices: form_question.max_choices,
-            max_characters: form_question.max_characters
-          }
-
-          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
-              }
-
-              update_nested_model(form_answer_option, answer_option_attributes, question.answer_options)
-            end
-
-            form_question.display_conditions.each do |form_display_condition|
-              type = form_display_condition.condition_type
-
-              display_condition_attributes = {
-                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,
-                mandatory: form_display_condition.mandatory
-              }
-
-              next if form_display_condition.deleted? && form_display_condition.id.blank?
-
-              update_nested_model(form_display_condition, display_condition_attributes, question.display_conditions)
-            end
-
-            form_question.matrix_rows_by_position.each_with_index do |form_matrix_row, idx|
-              matrix_row_attributes = {
-                body: form_matrix_row.body,
-                position: form_matrix_row.position || idx
-              }
-
-              update_nested_model(form_matrix_row, matrix_row_attributes, question.matrix_rows)
-            end
-          end
-        end
-
-        def update_nested_model(form, attributes, parent_association)
-          record = parent_association.find_by(id: form.id) || parent_association.build(attributes)
-
-          yield record if block_given?
-
-          if record.persisted?
-            if form.deleted?
-              record.destroy!
-            else
-              record.update!(attributes)
-            end
-          else
-            record.save!
-          end
-        end
-
         def update_questionnaire
           @questionnaire.update!(title: @form.title,
                                  description: @form.description,
                                  tos: @form.tos)
         end
-
-        def delete_answers
-          @questionnaire.answers.destroy_all
-        end
       end
     end
   end

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

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Forms
+    module Admin
+      # This command is executed when the user changes a Questionnaire questions from the admin
+      # panel.
+      class UpdateQuestions < Decidim::Command
+        # Initializes a UpdateQuestions Command.
+        #
+        # form - The form from which to get the data.
+        # questionnaire - The current instance of the questionnaire questions to be updated.
+        def initialize(form, questionnaire)
+          @form = form
+          @questionnaire = questionnaire
+        end
+
+        # Updates the questionnaire if valid.
+        #
+        # Broadcasts :ok if successful, :invalid otherwise.
+        def call
+          return broadcast(:invalid) if @form.invalid?
+
+          Decidim.traceability.perform_action!("update",
+                                               @questionnaire,
+                                               @form.current_user) do
+            Decidim::Forms::Questionnaire.transaction do
+              update_questionnaire_questions if @questionnaire.questions_editable?
+            end
+          end
+
+          broadcast(:ok)
+        end
+
+        private
+
+        def update_questionnaire_questions
+          @form.questions.each do |form_question|
+            update_questionnaire_question(form_question)
+          end
+        end
+
+        def update_questionnaire_question(form_question)
+          question_attributes = {
+            body: form_question.body,
+            description: form_question.description,
+            position: form_question.position,
+            mandatory: form_question.mandatory,
+            question_type: form_question.question_type,
+            max_choices: form_question.max_choices,
+            max_characters: form_question.max_characters
+          }
+
+          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
+              }
+
+              update_nested_model(form_answer_option, answer_option_attributes, question.answer_options)
+            end
+
+            form_question.display_conditions.each do |form_display_condition|
+              type = form_display_condition.condition_type
+
+              display_condition_attributes = {
+                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,
+                mandatory: form_display_condition.mandatory
+              }
+
+              next if form_display_condition.deleted? && form_display_condition.id.blank?
+
+              update_nested_model(form_display_condition, display_condition_attributes, question.display_conditions)
+            end
+
+            form_question.matrix_rows_by_position.each_with_index do |form_matrix_row, idx|
+              matrix_row_attributes = {
+                body: form_matrix_row.body,
+                position: form_matrix_row.position || idx
+              }
+
+              update_nested_model(form_matrix_row, matrix_row_attributes, question.matrix_rows)
+            end
+          end
+        end
+
+        def update_nested_model(form, attributes, parent_association)
+          record = parent_association.find_by(id: form.id) || parent_association.build(attributes)
+
+          yield record if block_given?
+
+          if record.persisted?
+            if form.deleted?
+              record.destroy!
+            else
+              record.update!(attributes)
+            end
+          else
+            record.save!
+          end
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/forms/answer_questionnaire.rb

@@ -11,18 +11,21 @@ module Decidim
       #
       # form - The form from which to get the data.
       # questionnaire - The current instance of the questionnaire to be answered.
-      def initialize(form, questionnaire)
+      # 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)
         @form = form
         @questionnaire = questionnaire
+        @allow_editing_answers = allow_editing_answers
       end
 
       # Answers a questionnaire if it is valid
       #
       # Broadcasts :ok if successful, :invalid otherwise.
       def call
-        return broadcast(:invalid) if @form.invalid? || user_already_answered?
+        return broadcast(:invalid) if @form.invalid? || (user_already_answered? && !allow_editing_answers)
 
         with_events do
+          clear_answers! if allow_editing_answers
           answer_questionnaire
         end
 
@@ -34,7 +37,7 @@ module Decidim
         end
       end
 
-      attr_reader :form, :questionnaire
+      attr_reader :form, :questionnaire, :allow_editing_answers
 
       private
 
@@ -75,6 +78,10 @@ module Decidim
         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
+      end
+
       def answer_questionnaire
         @main_form = @form
         @errors = nil

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

@@ -38,13 +38,12 @@ module Decidim
 
               @form = form(Admin::QuestionnaireForm).from_model(questionnaire)
 
-              render template: "decidim/forms/admin/questionnaires/edit"
+              render template: edit_template
             end
 
             def update
               enforce_permission_to(:update, :questionnaire, questionnaire:)
 
-              params["published_at"] = Time.current if params.has_key? "save_and_publish"
               @form = form(Admin::QuestionnaireForm).from_params(params)
 
               Admin::UpdateQuestionnaire.call(@form, questionnaire, current_user) do
@@ -57,7 +56,30 @@ 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: "decidim/forms/admin/questionnaires/edit"
+                  render template: edit_template
+                end
+              end
+            end
+
+            def edit_questions
+              @form = form(Admin::QuestionsForm).from_model(questionnaire)
+
+              render template: edit_questions_template
+            end
+
+            # i18n-tasks-use t("decidim.forms.admin.questionnaires.questions_form.update.success")
+            # i18n-tasks-use t("decidim.forms.admin.questionnaires.update.invalid")
+            def update_questions
+              @form = form(Admin::QuestionsForm).from_params(params)
+              Admin::UpdateQuestions.call(@form, questionnaire) do
+                on(:ok) do
+                  flash[:notice] = I18n.t("update.success", scope: i18n_questions_flashes_scope)
+                  redirect_to after_update_url
+                end
+
+                on(:invalid) do
+                  flash.now[:alert] = I18n.t("update.invalid", scope: i18n_flashes_scope)
+                  render template: edit_questions_template
                 end
               end
             end
@@ -96,6 +118,12 @@ module Decidim
               raise "#{self.class.name} is expected to implement #public_url"
             end
 
+            # Implement this method in your controller to set the URL
+            # where the user will be render while editing the questionnaire questions
+            def edit_questions_template
+              "decidim/forms/admin/questionnaires/edit_questions"
+            end
+
             # Returns the url to get the answer options json (for the display conditions form)
             # for the question with id = params[:id]
             def answer_options_url(params)
@@ -110,10 +138,18 @@ module Decidim
 
             private
 
+            def edit_template
+              "decidim/forms/admin/questionnaires/edit"
+            end
+
             def i18n_flashes_scope
               "decidim.forms.admin.questionnaires"
             end
 
+            def i18n_questions_flashes_scope
+              "decidim.forms.admin.questionnaires.questions_form"
+            end
+
             def questionnaire
               @questionnaire ||= Questionnaire.find_by(questionnaire_for:)
             end

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

@@ -37,7 +37,7 @@ module Decidim
             def show
               enforce_permission_to :show, :questionnaire_answers
 
-              @participant = participant(participants_query.participant(params[:session_token]))
+              @participant = participant(participants_query.participant(params[:id]))
 
               render template: "decidim/forms/admin/questionnaires/answers/show"
             end
@@ -45,7 +45,7 @@ module Decidim
             def export_response
               enforce_permission_to :export_response, :questionnaire_answers
 
-              session_token = params[:session_token]
+              session_token = params[:id]
               answers = QuestionnaireUserAnswers.for(questionnaire)
 
               # i18n-tasks-use t("decidim.forms.admin.questionnaires.answers.export_response.title")

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

@@ -16,7 +16,7 @@ module Decidim
           helper Decidim::Forms::ApplicationHelper
           include FormFactory
 
-          helper_method :questionnaire_for, :questionnaire, :allow_answers?, :visitor_can_answer?, :visitor_already_answered?, :update_url, :form_path
+          helper_method :questionnaire_for, :questionnaire, :allow_answers?, :visitor_can_answer?, :visitor_already_answered?, :update_url, :visitor_can_edit_answers?, :form_path
 
           invisible_captcha on_spam: :spam_detected
 
@@ -25,20 +25,20 @@ module Decidim
             render template: "decidim/forms/questionnaires/show"
           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
 
             @form = form(Decidim::Forms::QuestionnaireForm).from_params(params, session_token:, ip_hash:)
 
-            Decidim::Forms::AnswerQuestionnaire.call(@form, questionnaire) do
+            Decidim::Forms::AnswerQuestionnaire.call(@form, questionnaire, allow_editing_answers: allow_editing_answers?) do
               on(:ok) do
-                # i18n-tasks-use t("decidim.forms.questionnaires.answer.success")
                 flash[:notice] = I18n.t("answer.success", scope: i18n_flashes_scope)
                 redirect_to after_answer_path
               end
 
               on(:invalid) do
-                # i18n-tasks-use t("decidim.forms.questionnaires.answer.invalid")
                 flash.now[:alert] = I18n.t("answer.invalid", scope: i18n_flashes_scope)
                 render template: "decidim/forms/questionnaires/show"
               end
@@ -98,6 +98,14 @@ module Decidim
 
           private
 
+          def allow_editing_answers?
+            false
+          end
+
+          def visitor_can_edit_answers?
+            current_user.present? && questionnaire_for.try(:allow_editing_answers?)
+          end
+
           def i18n_flashes_scope
             "decidim.forms.questionnaires"
           end

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

@@ -44,7 +44,7 @@ module Decidim
               question.translated_body,
               question.id,
               {
-                "disabled" => (question.question_type == "sorting" || question.id == id),
+                "disabled" => question.question_type == "sorting" || question.id == id,
                 "data-type" => question.question_type
               }
             ]

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

@@ -8,19 +8,10 @@ module Decidim
         include TranslatableAttributes
 
         translatable_attribute :title, String
-        translatable_attribute :description, String
-        translatable_attribute :tos, String
-
-        attribute :published_at, Decidim::Attributes::TimeWithZone
-        attribute :questions, Array[QuestionForm]
+        translatable_attribute :description, Decidim::Attributes::RichText
+        translatable_attribute :tos, Decidim::Attributes::RichText
 
         validates :title, :tos, translatable_presence: true
-
-        def map_model(model)
-          self.questions = model.questions.map do |question|
-            QuestionForm.from_model(question)
-          end
-        end
       end
     end
   end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Forms
+    module Admin
+      # This class holds a Form to update questionnaires questions from Decidim's admin panel.
+      class QuestionsForm < Decidim::Form
+        attribute :questions, Array[QuestionForm]
+
+        def map_model(model)
+          self.questions = model.questions.map do |question|
+            QuestionForm.from_model(question)
+          end
+        end
+      end
+    end
+  end
+end

data/app/forms/decidim/forms/answer_choice_form.rb

@@ -11,6 +11,11 @@ module Decidim
       attribute :matrix_row_id, Integer
 
       validates :answer_option_id, presence: true
+
+      def map_model(model)
+        self.answer_option_id = model.decidim_answer_option_id
+        self.matrix_row_id = model.decidim_question_matrix_row_id
+      end
     end
   end
 end

data/app/forms/decidim/forms/answer_form.rb

@@ -44,6 +44,7 @@ module Decidim
       def map_model(model)
         self.question_id = model.decidim_question_id
         self.question = model.question
+        self.documents = model.attachments
 
         self.choices = model.choices.map do |choice|
           AnswerChoiceForm.from_model(choice)

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

@@ -13,6 +13,7 @@ module Decidim
       attribute :public_participation, Boolean, default: false
 
       attribute :tos_agreement, Boolean
+      attribute :allow_editing_answers, Boolean, default: false
 
       before_validation :before_validation
 
@@ -28,6 +29,12 @@ module Decidim
         end
       end
 
+      def add_answers!(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)
+        end
+      end
+
       # Add other responses to the context so AnswerForm can validate conditional questions
       def before_validation
         context.responses = attributes[:responses]

data/app/helpers/decidim/forms/admin/concerns/has_questionnaire_answers_pagination_helper.rb

@@ -40,7 +40,7 @@ module Decidim
           end
 
           def current_idx
-            participant_ids.index(params[:session_token])
+            participant_ids.index(params[:id])
           end
         end
       end

data/app/helpers/decidim/forms/admin/concerns/has_questionnaire_answers_url_helper.rb

@@ -21,17 +21,17 @@ module Decidim
           # You can implement this method in your controller to change the URL
           # where the questionnaire participants' info will be shown.
           def questionnaire_participants_url
-            url_for([:index, questionnaire.questionnaire_for, { format: nil }])
+            url_for([questionnaire.questionnaire_for, { format: nil }])
           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(session_token)
-            url_for([:show, questionnaire.questionnaire_for, { session_token: }])
+          def questionnaire_participant_answers_url(id)
+            url_for([questionnaire.questionnaire_for, { id: }])
           end
 
-          def questionnaire_export_response_url(session_token)
-            url_for([:export_response, questionnaire.questionnaire_for, { session_token:, format: "pdf" }])
+          def questionnaire_export_response_url(id)
+            url_for([questionnaire.questionnaire_for, { id:, format: "pdf" }])
           end
         end
       end

data/app/jobs/decidim/forms/export_questionnaire_answers_job.rb

@@ -3,6 +3,8 @@
 module Decidim
   module Forms
     class ExportQuestionnaireAnswersJob < ApplicationJob
+      include Decidim::PrivateDownloadHelper
+
       queue_as :exports
 
       def perform(user, title, answers)
@@ -12,7 +14,9 @@ module Decidim
         serializer = Decidim::Forms::UserAnswersSerializer
         export_data = Decidim::Exporters::FormPDF.new(answers, serializer).export
 
-        ExportMailer.export(user, title, export_data).deliver_now
+        private_export = attach_archive(export_data, title, user)
+
+        ExportMailer.export(user, private_export).deliver_later
       end
     end
   end

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

@@ -9,7 +9,7 @@ module Decidim
 
       translatable_fields :body
 
-      belongs_to :question, class_name: "Question", foreign_key: "decidim_question_id", counter_cache: true
+      belongs_to :question, class_name: "Question", foreign_key: "decidim_question_id", counter_cache: :answer_options_count
 
       has_many :display_conditions,
                class_name: "DisplayCondition",

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

@@ -47,6 +47,12 @@ module Decidim
                foreign_key: "decidim_condition_question_id",
                class_name: "Question"
 
+      has_many :answers,
+               class_name: "Answer",
+               foreign_key: "decidim_question_id",
+               dependent: :destroy,
+               inverse_of: :question
+
       validates :question_type, inclusion: { in: TYPES }
 
       scope :not_separator, -> { where.not(question_type: SEPARATOR_TYPE) }
@@ -97,6 +103,10 @@ module Decidim
       def answers_count
         questionnaire.answers.where(question: self).count
       end
+
+      def self.log_presenter_class_for(_log)
+        Decidim::Forms::AdminLog::QuestionPresenter
+      end
     end
   end
 end

data/app/packs/entrypoints/decidim_forms.js

@@ -2,7 +2,6 @@ import "src/decidim/forms/forms"
 
 // CSS
 import "stylesheets/decidim/forms/forms.scss"
-import "stylesheets/decidim/forms/questionnaire-answers-pdf.scss"
 
 // Images
 require.context("../images", true)

data/app/packs/entrypoints/decidim_forms_admin.js

@@ -1,4 +1,10 @@
 import "src/decidim/forms/admin/collapsible_questions"
 
 import createEditableForm from "src/decidim/forms/admin/forms"
+import createPublicableQuestionAnswersButtons from "src/decidim/forms/admin/publish_answers_buttons"
+
 window.Decidim.createEditableForm = createEditableForm
+
+document.addEventListener("DOMContentLoaded", function() {
+  document.querySelectorAll("[data-publish-question-answer-action]").forEach((el) =>  createPublicableQuestionAnswersButtons(el));
+});