ER-793 feedback forms

.github/workflows/ci.yml

@@ -33,6 +33,7 @@ jobs:
       DATABASE_URL: postgres://postgres:password@localhost:5432/test
       DOMAIN: recovery.app
       BOT_TOKEN: bot_token
+      CONTENTFUL_PREVIEW: true # TODO: Reminder to delete this line
 
     services:
       postgres:
@@ -77,21 +78,12 @@ jobs:
       -
         name: Compile assets
         run: bundle exec rails assets:precompile
-      -
-        name: Run test suite
-        run: bundle exec rspec
-      -
-        name: Run rubocop
-        run: bundle exec rubocop
-      # Answer migration feature test
       -
         name: Run test suite
         run: bundle exec rspec
         env:
           DISABLE_USER_ANSWER: true
-      # Gov One feature test
-      -
-        name: Run test suite
-        run: bundle exec rspec
-        env:
           GOV_ONE_LOGIN: true
+      -
+        name: Run rubocop
+        run: bundle exec rubocop

app/controllers/application_controller.rb

@@ -72,9 +72,9 @@ def timeout_timer
 
 private
 
-  # @return [Boolean] health check and landing page requests are exempt
+  # @return [Boolean]
   def maintenance?
-    return false if %w[/maintenance /health].include?(request.path)
+    return false if Rails.configuration.protected_endpoints.include?(request.path)
 
     Rails.application.maintenance?
   end

app/controllers/concerns/learning.rb

@@ -67,6 +67,6 @@ def section_bar
   # @note memoization ensures validation errors work
   # @return [UserAnswer, Response]
   def current_user_response
-    @current_user_response ||= current_user.response_for(content)
+    @current_user_response ||= content.opinion_question? ? current_user.response_for_shared(content, mod) : current_user.response_for(content)
   end
 end

app/controllers/feedback_controller.rb

@@ -0,0 +1,156 @@
+class FeedbackController < ApplicationController
+  helper_method :previous_path, :next_path, :content, :is_checkbox?, :is_free_text?, :feedback_exists?
+
+  # @return [nil]
+  def show
+    redirect_to next_path if skip_question?
+  end
+
+  # @return [nil]
+  def index; end
+
+  # @return [nil]
+  def update
+    return if invalid_answer? || other_blank?
+
+    response_exists? ? update_response : create_response
+    redirect_to next_path
+  end
+
+  # @return [String]
+  def is_checkbox?
+    content.response_type
+  end
+
+  # @return [Boolean]
+  def is_free_text?
+    content.answers.empty?
+  end
+
+  # @return [Boolean]
+  def feedback_exists?
+    return false if current_user.nil?
+
+    Response.where(user_id: current_user.id).exists?
+  end
+
+  # @return [String] path to next feedback step
+  def next_path
+    return my_modules_path if action_name == 'thank_you'
+    return feedback_path(1) if params[:id].nil?
+    return thank_you_path if params[:id].to_i == questions.count
+
+    feedback_path(params[:id].to_i + 1)
+  end
+
+  # @return [String] path to previous feedback step
+  def previous_path
+    return my_modules_path if params[:id].nil?
+    return feedback_path(1) if params[:id] == '1'
+
+    feedback_path(params[:id].to_i - 1)
+  end
+
+private
+
+  # @return [Boolean]
+  def invalid_answer?
+    if answer.blank? || answer.all?(&:blank?)
+      flash[:error] = 'Please answer the question'
+      redirect_to current_feedback_path and return true
+    else
+      false
+    end
+  end
+
+  # @return [Boolean]
+  def other_blank?
+    if answer_content.include?('Other') && text_input.blank?
+      flash[:error] = 'Please specify'
+      redirect_to current_feedback_path and return true
+    else
+      false
+    end
+  end
+
+  # @return [Response]
+  def create_response
+    Response.create!(
+      user_id: current_user ? current_user.id : nil,
+      answers: answer_content,
+      question_name: content.name,
+      text_input: text_input,
+    )
+  end
+
+  # @return [Response]
+  def update_response
+    Response.where(user_id: current_user.id, question_name: content.name).update(
+      answers: answer_content,
+      text_input: text_input,
+    )
+  end
+
+  # @return [Boolean]
+  def response_exists?
+    return false if current_user.nil?
+
+    Response.where(user_id: current_user.id, question_name: content.name).exists?
+  end
+
+  # @return [Boolean]
+  def skip_question?
+    return false unless skipped_questions.include?(content.name)
+
+    true if current_user.nil?
+  end
+
+  # @return [Array<String>]
+  def skipped_questions
+    %w[main-feedback-6]
+  end
+
+  # @param answer [String]
+  # @return [String]
+  def answer_wording(answer)
+    content.answers[answer.to_i - 1].first
+  end
+
+  # @return [Array<Hash>]
+  def questions
+    Course.config.feedback
+  end
+
+  # @return [String]
+  def current_feedback_path
+    feedback_path(params[:id])
+  end
+
+  # @return [Hash]
+  def content
+    @content ||= questions[params[:id].to_i - 1]
+  end
+
+  # @return [Array<String>]
+  def answer
+    @answer ||= if is_free_text?
+                  params[:answers]
+                else
+                  Array.wrap(params[:answers])
+                end
+  end
+
+  # @return [Array<String>]
+  def answer_content
+    @answer_content ||= begin
+      return [] if answer.blank?
+      return answer if is_free_text?
+
+      answer.reject(&:blank?).map { |a| answer_wording(a) }.flatten
+    end
+  end
+
+  def text_input
+    @text_input ||= params[:answers_custom]
+  end
+end

app/controllers/training/pages_controller.rb

@@ -19,7 +19,7 @@ def index
     end
 
     def show
-      if content.is_question?
+      if content.is_question? || content.opinion_question?
         redirect_to training_module_question_path(mod.name, content.name)
       elsif content.assessment_results?
         redirect_to training_module_assessment_path(mod.name, content.name)
@@ -38,7 +38,7 @@ def note
     end
 
     def render_page
-      if content.section? && !content.certificate?
+      if content.section? && !content.certificate? && !content.opinion_intro?
         render 'section_intro'
       else
         render content.page_type

app/controllers/training/questions_controller.rb

@@ -30,7 +30,9 @@ def show; end
     # @see Tracking
     # @return [Event] Show action
     def track_events
-      if track_confidence_start?
+      if track_feedback_start?
+        track('feedback_start')
+      elsif track_confidence_start?
         track('confidence_check_start')
       elsif track_assessment_start?
         track('summative_assessment_start')
@@ -50,6 +52,11 @@ def track_confidence_start?
       content.first_confidence? && confidence_start_untracked?
     end
 
+    # @return [Boolean]
+    def track_feedback_start?
+      content.opinion_question? || content.opinion_intro?
+    end
+
     # @return [Boolean]
     def track_assessment_start?
       content.first_assessment? && summative_start_untracked?

app/controllers/training/responses_controller.rb

@@ -17,10 +17,14 @@ class ResponsesController < ApplicationController
     layout 'hero'
 
     def update
-      if save_response!
+      if save_response! || (content.opinion_question? && content.options.blank?)
         track_question_answer
         redirect
       else
+        if content.opinion_question? && user_answer_text.blank? && content.options.present?
+          current_user_response.errors.clear
+          current_user_response.errors.add :answers, :invalid
+        end
         render 'training/questions/show', status: :unprocessable_entity
       end
     end
@@ -41,10 +45,10 @@ def response_params
     # @note migrate from user_answer to response
     # @return [Boolean]
     def save_response!
-      correct_answers = content.confidence_question? ? true : content.correct_answers.eql?(user_answers)
+      correct_answers = content.confidence_question? || content.opinion_question? ? true : content.correct_answers.eql?(user_answers)
 
       if Rails.application.migrated_answers?
-        current_user_response.update(answers: user_answers, correct: correct_answers)
+        current_user_response.update(answers: user_answers, correct: correct_answers, text_input: user_answer_text)
       else
         current_user_response.update(answer: user_answers, correct: correct_answers)
       end
@@ -55,6 +59,10 @@ def user_answers
       Array(response_params[:answers]).compact_blank.map(&:to_i)
     end
 
+    def user_answer_text
+      response_params[:text_input]
+    end
+
     def redirect
       assessment.grade! if content.last_assessment?
 
@@ -73,7 +81,8 @@ def track_question_answer
               mod_uid: mod.id,
               type: content.question_type,
               success: current_user_response.correct?,
-              answers: current_user_response.answers)
+              answers: current_user_response.answers,
+              text_input: user_answer_text)
       else
         track('questionnaire_answer',
               uid: content.id,

app/decorators/module_overview_decorator.rb

@@ -42,6 +42,7 @@ def sections
         display_line: position != mod.submodule_count,
         icon: status(content_items),
         subsections: subsections(submodule: submodule, items: content_items),
+        hide: content_items.first.opinion_intro?,
       }
     end
   end

app/decorators/next_page_decorator.rb

@@ -34,7 +34,8 @@ def text
     case
     when next?            then label[:next]
     when missing?         then label[:missing]
-    when content.section? then label[:section]
+    when content_section? then label[:section]
+    when opinion_intro?   then label[:give_feedback] # Make confidence outro
     when test_start?      then label[:start_test]
     when test_finish?     then label[:finish_test]
     when finish?          then label[:finish]
@@ -99,6 +100,14 @@ def missing?
     content.next_item.eql?(content) && wip?
   end
 
+  def opinion_intro?
+    content.opinion_intro?
+  end
+
+  def content_section?
+    content.section? && !content.opinion_intro?
+  end
+
   # @return [Boolean]
   def wip?
     Rails.application.preview? || Rails.env.test?

app/decorators/pagination_decorator.rb

@@ -15,7 +15,11 @@ def heading
 
   # @return [String]
   def section_numbers
-    I18n.t(:section, scope: :pagination, current: content.submodule, total: section_total)
+    if content.opinion_intro? || content.opinion_question?
+      I18n.t(:section, scope: :pagination, current: content.submodule - 1, total: section_total - 1)
+    else
+      I18n.t(:section, scope: :pagination, current: content.submodule, total: section_total - 1)
+    end
   end
 
   # @return [String]
@@ -37,7 +41,17 @@ def current_page
 
   # @return [Integer]
   def page_total
-    content.section_content.size
+    size = content.section_content.size
+    if content.section_content.any?(&:skippable?) # && response_for_shared.responded?
+      # don't count skipped page
+      content.section_content.each do |section_content|
+        if section_content.opinion_question? && section_content.always_show_question.eql?(false)
+          size -= 1
+        end
+      end
+    end
+
+    size
   end
 
   # @return [Integer]

app/forms/form_builder.rb

@@ -31,6 +31,16 @@ def question_radio_button(option)
                        checked: option.checked?
   end
 
+  # @param option [Training::Answer::Option]
+  def opinion_radio_button(option)
+    govuk_radio_button :answers,
+                       option.id,
+                       label: { text: option.label },
+                       link_errors: true,
+                       disabled: option.disabled?,
+                       checked: option.checked?
+  end
+
   # @param option [Training::Answer::Option]
   def question_check_box(option)
     govuk_check_box :answers,