Browse Source

Merge branch 'main' into CLDC-687ImplementPropertyInformation

pull/95/head
Milo 3 years ago committed by GitHub
parent
commit
891199eca2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 2
      .env.example
  2. 4
      .github/workflows/pipeline.yml
  3. 2
      Gemfile
  4. 11
      Gemfile.lock
  5. 27
      app/admin/admin_users.rb
  6. 42
      app/controllers/case_logs_controller.rb
  7. 6
      app/controllers/soft_validations_controller.rb
  8. 20
      app/controllers/users/passwords_controller.rb
  9. 61
      app/helpers/check_answers_helper.rb
  10. 8
      app/helpers/conditional_questions_helper.rb
  11. 10
      app/helpers/question_attribute_helper.rb
  12. 43
      app/helpers/tasklist_helper.rb
  13. 5
      app/models/admin_user.rb
  14. 4
      app/models/case_log.rb
  15. 139
      app/models/form.rb
  16. 30
      app/models/form/page.rb
  17. 80
      app/models/form/question.rb
  18. 10
      app/models/form/section.rb
  19. 65
      app/models/form/subsection.rb
  20. 5
      app/models/user.rb
  21. 10
      app/validations/household_validations.rb
  22. 14
      app/views/case_logs/_tasklist.html.erb
  23. 4
      app/views/case_logs/edit.html.erb
  24. 2
      app/views/case_logs/index.html.erb
  25. 16
      app/views/devise/confirmations/new.html.erb
  26. 8
      app/views/devise/confirmations/reset.html.erb
  27. 5
      app/views/devise/mailer/confirmation_instructions.html.erb
  28. 7
      app/views/devise/mailer/email_changed.html.erb
  29. 3
      app/views/devise/mailer/password_change.html.erb
  30. 8
      app/views/devise/mailer/reset_password_instructions.html.erb
  31. 7
      app/views/devise/mailer/unlock_instructions.html.erb
  32. 19
      app/views/devise/passwords/edit.html.erb
  33. 24
      app/views/devise/passwords/new.html.erb
  34. 43
      app/views/devise/registrations/edit.html.erb
  35. 29
      app/views/devise/registrations/new.html.erb
  36. 21
      app/views/devise/sessions/new.html.erb
  37. 15
      app/views/devise/shared/_error_messages.html.erb
  38. 25
      app/views/devise/shared/_links.html.erb
  39. 16
      app/views/devise/unlocks/new.html.erb
  40. 6
      app/views/form/_check_answers_table.html.erb
  41. 10
      app/views/form/_checkbox_question.html.erb
  42. 6
      app/views/form/_date_question.html.erb
  43. 10
      app/views/form/_numeric_question.html.erb
  44. 12
      app/views/form/_radio_question.html.erb
  45. 11
      app/views/form/_select_question.html.erb
  46. 6
      app/views/form/_text_question.html.erb
  47. 6
      app/views/form/_validation_override_question.html.erb
  48. 8
      app/views/form/check_answers.html.erb
  49. 21
      app/views/form/page.html.erb
  50. 2
      app/views/layouts/application.html.erb
  51. 16
      config/environments/development.rb
  52. 3
      config/environments/test.rb
  53. 19
      config/forms/2021_2022.json
  54. 4
      config/initializers/active_admin.rb
  55. 311
      config/initializers/devise.rb
  56. 65
      config/locales/devise.en.yml
  57. 16
      config/routes.rb
  58. 43
      db/migrate/20211101103235_devise_create_users.rb
  59. 17
      db/migrate/20211118090831_change_armed_forces.rb
  60. 18
      db/migrate/20211119120910_add_admin_users.rb
  61. 27
      db/schema.rb
  62. 3
      db/seeds.rb
  63. 9
      docs/adr/adr-010-admin-users-vs-users.md
  64. 10
      docs/adr/adr-011-form-oop-refactor.md
  65. 17
      spec/controllers/case_logs_controller_spec.rb
  66. 118
      spec/factories/case_log.rb
  67. 9
      spec/factories/user.rb
  68. 8
      spec/features/case_log_spec.rb
  69. 53
      spec/features/user_spec.rb
  70. 41
      spec/fixtures/forms/test_form.json
  71. 185
      spec/helpers/check_answers_helper_spec.rb
  72. 12
      spec/helpers/conditional_questions_helper_spec.rb
  73. 22
      spec/helpers/question_attribute_helper_spec.rb
  74. 78
      spec/helpers/tasklist_helper_spec.rb
  75. 19
      spec/models/case_log_spec.rb
  76. 66
      spec/models/form/page_spec.rb
  77. 140
      spec/models/form/question_spec.rb
  78. 21
      spec/models/form/section_spec.rb
  79. 72
      spec/models/form/subsection_spec.rb
  80. 2
      spec/models/form_handler_spec.rb
  81. 26
      spec/models/form_spec.rb
  82. 3
      spec/rails_helper.rb
  83. 46
      spec/requests/users/passwords_controller_spec.rb
  84. 16
      spec/support/controller_macros.rb
  85. 6
      spec/support/devise.rb

2
.env.example

@ -1,2 +1,4 @@
DB_USERNAME=postgres-user
DB_PASSWORD=postgres-password
CORE_EMAIL_USERNAME=email@example.com
CORE_EMAIL_PASSWORD=password123

4
.github/workflows/pipeline.yml

@ -100,10 +100,14 @@ jobs:
API_USER: ${{ secrets.API_USER }}
API_KEY: ${{ secrets.API_KEY }}
APP_NAME: dluhc-core
CORE_EMAIL_USERNAME: ${{ secrets.CORE_EMAIL_USERNAME }}
CORE_EMAIL_PASSWORD: ${{ secrets.CORE_EMAIL_PASSWORD }}
run: |
cf7 api $CF_API_ENDPOINT
cf7 auth
cf7 target -o $CF_ORG -s $CF_SPACE
cf7 set-env $APP_NAME API_USER $API_USER
cf7 set-env $APP_NAME API_KEY $API_KEY
cf7 set-env $APP_NAME CORE_EMAIL_USERNAME $CORE_EMAIL_USERNAME
cf7 set-env $APP_NAME CORE_EMAIL_PASSWORD $CORE_EMAIL_PASSWORD
cf7 push --strategy rolling

2
Gemfile

@ -33,6 +33,8 @@ gem "chartkick"
gem "roo"
# Json Schema
gem "json-schema"
# Authentication
gem "devise"
gem "turbo-rails", "~> 0.8"
gem "uk_postcode"

11
Gemfile.lock

@ -122,6 +122,7 @@ GEM
activesupport (>= 3.0.0, < 6.2)
ruby2_keywords (>= 0.0.2, < 1.0)
ast (2.4.2)
bcrypt (3.1.16)
bindex (0.8.1)
bootsnap (1.9.1)
msgpack (~> 1.0)
@ -146,6 +147,12 @@ GEM
database_cleaner-core (~> 2.0.0)
database_cleaner-core (2.0.1)
deep_merge (1.2.1)
devise (4.8.0)
bcrypt (~> 3.0)
orm_adapter (~> 0.1)
railties (>= 4.1.0)
responders
warden (~> 1.2.3)
diff-lcs (1.4.4)
discard (1.2.0)
activerecord (>= 4.2, < 7)
@ -229,6 +236,7 @@ GEM
racc (~> 1.4)
nokogiri (1.12.5-x86_64-linux)
racc (~> 1.4)
orm_adapter (0.5.0)
overcommit (0.58.0)
childprocess (>= 0.6.3, < 5)
iniparse (~> 1.4)
@ -367,6 +375,8 @@ GEM
view_component (2.39.0)
activesupport (>= 5.0.0, < 8.0)
method_source (~> 1.0)
warden (1.2.9)
rack (>= 2.0.9)
web-console (4.2.0)
actionview (>= 6.0.0)
activemodel (>= 6.0.0)
@ -395,6 +405,7 @@ DEPENDENCIES
capybara
chartkick
database_cleaner-active_record
devise
discard
dotenv-rails
factory_bot_rails

27
app/admin/admin_users.rb

@ -0,0 +1,27 @@
ActiveAdmin.register AdminUser do
permit_params :email, :password, :password_confirmation
index do
selectable_column
id_column
column :email
column :current_sign_in_at
column :sign_in_count
column :created_at
actions
end
filter :email
filter :current_sign_in_at
filter :sign_in_count
filter :created_at
form do |f|
f.inputs do
f.input :email
f.input :password
f.input :password_confirmation
end
f.actions
end
end

42
app/controllers/case_logs_controller.rb

@ -1,6 +1,7 @@
class CaseLogsController < ApplicationController
skip_before_action :verify_authenticity_token, if: :json_api_request?
before_action :authenticate, if: :json_api_request?
before_action :authenticate_user!, unless: :json_api_request?
def index
@completed_case_logs = CaseLog.completed
@ -56,14 +57,15 @@ class CaseLogsController < ApplicationController
def submit_form
form = FormHandler.instance.get_form("2021_2022")
@case_log = CaseLog.find(params[:id])
@case_log.page = params[:case_log][:page]
responses_for_page = responses_for_page(@case_log.page)
@case_log.page_id = params[:case_log][:page]
page = form.get_page(@case_log.page_id)
responses_for_page = responses_for_page(page)
if @case_log.update(responses_for_page) && @case_log.has_no_unresolved_soft_errors?
redirect_path = form.next_page_redirect_path(@case_log.page, @case_log)
redirect_path = form.next_page_redirect_path(page, @case_log)
redirect_to(send(redirect_path, @case_log))
else
page_info = form.all_pages[@case_log.page]
render "form/page", locals: { form: form, page_key: @case_log.page, page_info: page_info }, status: :unprocessable_entity
subsection = form.subsection_for_page(page)
render "form/page", locals: { form: form, page: page, subsection: subsection.label }, status: :unprocessable_entity
end
end
@ -83,15 +85,16 @@ class CaseLogsController < ApplicationController
form = FormHandler.instance.get_form("2021_2022")
@case_log = CaseLog.find(params[:case_log_id])
current_url = request.env["PATH_INFO"]
subsection = current_url.split("/")[-2]
subsection = form.get_subsection(current_url.split("/")[-2])
render "form/check_answers", locals: { subsection: subsection, form: form }
end
form = FormHandler.instance.get_form("2021_2022")
form.all_pages.map do |page_key, page_info|
define_method(page_key) do |_errors = {}|
form.pages.map do |page|
define_method(page.id) do |_errors = {}|
@case_log = CaseLog.find(params[:case_log_id])
render "form/page", locals: { form: form, page_key: page_key, page_info: page_info }
subsection = form.subsection_for_page(page)
render "form/page", locals: { form: form, page: page, subsection: subsection.label }
end
end
@ -100,16 +103,15 @@ private
API_ACTIONS = %w[create show update destroy].freeze
def responses_for_page(page)
form = FormHandler.instance.get_form("2021_2022")
form.expected_responses_for_page(page).each_with_object({}) do |(question_key, question_info), result|
question_params = params["case_log"][question_key]
if question_info["type"] == "date"
day = params["case_log"]["#{question_key}(3i)"]
month = params["case_log"]["#{question_key}(2i)"]
year = params["case_log"]["#{question_key}(1i)"]
page.expected_responses.each_with_object({}) do |question, result|
question_params = params["case_log"][question.id]
if question.type == "date"
day = params["case_log"]["#{question.id}(3i)"]
month = params["case_log"]["#{question.id}(2i)"]
year = params["case_log"]["#{question.id}(1i)"]
next unless [day, month, year].any?(&:present?)
result[question_key] = if day.to_i.between?(1, 31) && month.to_i.between?(1, 12) && year.to_i.between?(2000, 2200)
result[question.id] = if day.to_i.between?(1, 31) && month.to_i.between?(1, 12) && year.to_i.between?(2000, 2200)
Date.new(year.to_i, month.to_i, day.to_i)
else
Date.new(0, 1, 1)
@ -117,12 +119,12 @@ private
end
next unless question_params
if %w[checkbox validation_override].include?(question_info["type"])
question_info["answer_options"].keys.reject { |x| x.match(/divider/) }.each do |option|
if %w[checkbox validation_override].include?(question.type)
question.answer_options.keys.reject { |x| x.match(/divider/) }.each do |option|
result[option] = question_params.include?(option) ? 1 : 0
end
else
result[question_key] = question_params
result[question.id] = question_params
end
result
end

6
app/controllers/soft_validations_controller.rb

@ -1,9 +1,9 @@
class SoftValidationsController < ApplicationController
def show
@case_log = CaseLog.find(params[:case_log_id])
page_key = request.env["PATH_INFO"].split("/")[-2]
page_id = request.env["PATH_INFO"].split("/")[-2]
form = FormHandler.instance.get_form("2021_2022")
page = form.all_pages[page_key]
page = form.get_page(page_id)
if page_requires_soft_validation_override?(page)
errors = @case_log.soft_errors.values.first
render json: { show: true, label: errors.message, hint: errors.hint_text }
@ -15,6 +15,6 @@ class SoftValidationsController < ApplicationController
private
def page_requires_soft_validation_override?(page)
@case_log.soft_errors.present? && @case_log.soft_errors.keys.first == page["soft_validations"]&.keys&.first
@case_log.soft_errors.present? && @case_log.soft_errors.keys.first == page.soft_validations&.first&.id
end
end

20
app/controllers/users/passwords_controller.rb

@ -0,0 +1,20 @@
class Users::PasswordsController < Devise::PasswordsController
def reset_confirmation
@email = params["email"]
flash[:notice] = "Reset password instructions have been sent to #{@email}"
render "devise/confirmations/reset"
end
def create
self.resource = resource_class.send_reset_password_instructions(resource_params)
yield resource if block_given?
respond_with({}, location: after_sending_reset_password_instructions_path_for(resource_name))
end
protected
def after_sending_reset_password_instructions_path_for(_resource)
confirmations_reset_path(email: params.dig("user", "email"))
end
end

61
app/helpers/check_answers_helper.rb

@ -1,57 +1,20 @@
module CheckAnswersHelper
def total_answered_questions(subsection, case_log, form)
total_questions(subsection, case_log, form).keys.count do |question_key|
case_log[question_key].present?
end
end
def total_number_of_questions(subsection, case_log, form)
total_questions(subsection, case_log, form).count
end
def total_questions(subsection, case_log, form)
questions = form.questions_for_subsection(subsection)
form.filter_conditional_questions(questions, case_log)
end
def get_next_page_name(form, page_name, case_log)
page = form.all_pages[page_name]
if page.key?("conditional_route_to")
page["conditional_route_to"].each do |conditional_page_name, condition|
unless condition.any? { |field, value| case_log[field].blank? || !value.include?(case_log[field]) }
return conditional_page_name
end
end
end
form.next_page(page_name)
end
def create_update_answer_link(question_title, question_info, case_log, form)
page = form.page_for_question(question_title)
link_name = if question_info["type"] == "checkbox"
question_info["answer_options"].keys.any? { |key| case_log[key] == "Yes" } ? "Change" : "Answer"
def display_answered_questions_summary(subsection, case_log)
total = subsection.applicable_questions_count(case_log)
answered = subsection.answered_questions_count(case_log)
if total == answered
'<p class="govuk-body govuk-!-margin-bottom-7">You answered all the questions</p>'.html_safe
else
case_log[question_title].blank? ? "Answer" : "Change"
"<p class=\"govuk-body govuk-!-margin-bottom-7\">You answered #{answered} of #{total} questions</p>
#{create_next_missing_question_link(subsection, case_log)}".html_safe
end
link_to(link_name, "/case_logs/#{case_log.id}/#{page}", class: "govuk-link").html_safe
end
def create_next_missing_question_link(case_log_id, subsection, case_log, form)
pages_to_fill_in = []
form.pages_for_subsection(subsection).each do |page_title, page_info|
page_info["questions"].any? { |question| case_log[question].blank? }
pages_to_fill_in << page_title
end
url = "/case_logs/#{case_log_id}/#{pages_to_fill_in.first}"
link_to("Answer the missing questions", url, class: "govuk-link").html_safe
end
private
def display_answered_questions_summary(subsection, case_log, form)
if total_answered_questions(subsection, case_log, form) == total_number_of_questions(subsection, case_log, form)
'<p class="govuk-body govuk-!-margin-bottom-7">You answered all the questions</p>'.html_safe
else
"<p class=\"govuk-body govuk-!-margin-bottom-7\">You answered #{total_answered_questions(subsection, case_log, form)} of #{total_number_of_questions(subsection, case_log, form)} questions</p>
#{create_next_missing_question_link(case_log['id'], subsection, case_log, form)}".html_safe
end
def create_next_missing_question_link(subsection, case_log)
pages_to_fill_in = subsection.unanswered_questions(case_log).map(&:page)
url = "/case_logs/#{case_log.id}/#{pages_to_fill_in.first.id}"
link_to("Answer the missing questions", url, class: "govuk-link").html_safe
end
end

8
app/helpers/conditional_questions_helper.rb

@ -1,11 +1,9 @@
module ConditionalQuestionsHelper
def conditional_questions_for_page(page)
page["questions"].values.map { |question|
question["conditional_for"]
}.compact.map(&:keys).flatten
page.questions.map(&:conditional_for).compact.map(&:keys).flatten
end
def display_question_key_div(page_info, question_key)
"style='display:none;'".html_safe if conditional_questions_for_page(page_info).include?(question_key)
def display_question_key_div(page, question)
"style='display:none;'".html_safe if conditional_questions_for_page(page).include?(question.id)
end
end

10
app/helpers/question_attribute_helper.rb

@ -10,23 +10,23 @@ module QuestionAttributeHelper
private
def numeric_question_html_attributes(question)
return {} if question["fields-to-add"].blank? || question["result-field"].blank?
return {} if question.fields_to_add.blank? || question.result_field.blank?
{
"data-controller": "numeric-question",
"data-action": "numeric-question#calculateFields",
"data-target": "case-log-#{question['result-field'].to_s.dasherize}-field",
"data-calculated": question["fields-to-add"].to_json,
"data-target": "case-log-#{question.result_field.to_s.dasherize}-field",
"data-calculated": question.fields_to_add.to_json,
}
end
def conditional_html_attributes(question)
return {} if question["conditional_for"].blank?
return {} if question.conditional_for.blank?
{
"data-controller": "conditional-question",
"data-action": "conditional-question#displayConditional",
"data-info": question["conditional_for"].to_json,
"data-info": question.conditional_for.to_json,
}
end
end

43
app/helpers/tasklist_helper.rb

@ -13,48 +13,31 @@ module TasklistHelper
in_progress: "govuk-tag--blue",
}.freeze
def get_subsection_status(subsection_name, case_log, form, questions)
applicable_questions = form.filter_conditional_questions(questions, case_log).keys
if subsection_name == "declaration"
return case_log.completed? ? :not_started : :cannot_start_yet
end
return :not_started if applicable_questions.all? { |question| case_log[question].blank? }
return :completed if applicable_questions.all? { |question| case_log[question].present? }
:in_progress
end
def get_next_incomplete_section(form, case_log)
subsections = form.all_subsections.keys
subsections.find { |subsection| is_incomplete?(subsection, case_log, form, form.questions_for_subsection(subsection)) }
form.subsections.find { |subsection| subsection.is_incomplete?(case_log) }
end
def get_subsections_count(form, case_log, status = :all)
subsections = form.all_subsections.keys
return subsections.count if status == :all
return form.subsections.count if status == :all
subsections.count { |subsection| get_subsection_status(subsection, case_log, form, form.questions_for_subsection(subsection)) == status }
form.subsections.count { |subsection| subsection.status(case_log) == status }
end
def get_first_page_or_check_answers(subsection, case_log, form, questions)
path = if is_started?(subsection, case_log, form, questions)
"case_log_#{subsection}_check_answers_path"
def first_page_or_check_answers(subsection, case_log)
path = if subsection.is_started?(case_log)
"case_log_#{subsection.id}_check_answers_path"
else
"case_log_#{form.first_page_for_subsection(subsection)}_path"
"case_log_#{subsection.pages.first.id}_path"
end
send(path, case_log)
end
private
def is_incomplete?(subsection, case_log, form, questions)
status = get_subsection_status(subsection, case_log, form, questions)
%i[not_started in_progress].include?(status)
def subsection_link(subsection, case_log)
next_page_path = if subsection.status(case_log) != :cannot_start_yet
first_page_or_check_answers(subsection, case_log)
else
"#"
end
def is_started?(subsection, case_log, form, questions)
status = get_subsection_status(subsection, case_log, form, questions)
%i[in_progress completed].include?(status)
link_to(subsection.label, next_page_path, class: "task-name govuk-link")
end
end

5
app/models/admin_user.rb

@ -0,0 +1,5 @@
class AdminUser < ApplicationRecord
# Include default devise modules. Others available are:
# :confirmable, :lockable, :timeoutable, :trackable and :omniauthable
devise :database_authenticatable, :recoverable, :rememberable, :validatable
end

4
app/models/case_log.rb

@ -11,7 +11,7 @@ class CaseLogValidator < ActiveModel::Validator
# If we've come from the form UI we only want to validate the specific fields
# that have just been submitted. If we're submitting a log via API or Bulk Upload
# we want to validate all data fields.
page_to_validate = record.page
page_to_validate = record.page_id
if page_to_validate
public_send("validate_#{page_to_validate}", record) if respond_to?("validate_#{page_to_validate}")
else
@ -44,7 +44,7 @@ class CaseLog < ApplicationRecord
validates_with CaseLogValidator
before_save :update_status!
attr_accessor :page
attr_accessor :page_id
enum status: { "not_started" => 0, "in_progress" => 1, "completed" => 2 }

139
app/models/form.rb

@ -1,75 +1,34 @@
class Form
attr_reader :form_definition
attr_reader :form_definition, :sections, :subsections, :pages, :questions
def initialize(form_path)
raise "No form definition file exists for given year".freeze unless File.exist?(form_path)
@form_definition = JSON.parse(File.open(form_path).read)
@sections = form_definition["sections"].map { |id, s| Form::Section.new(id, s, self) }
@subsections = sections.flat_map(&:subsections)
@pages = subsections.flat_map(&:pages)
@questions = pages.flat_map(&:questions)
end
# Returns a hash with sections as keys
def all_sections
@all_sections ||= @form_definition["sections"]
def get_subsection(id)
subsections.find { |s| s.id == id }
end
# Returns a hash with subsections as keys
def all_subsections
@all_subsections ||= all_sections.map { |_section_key, section_value|
section_value["subsections"]
}.reduce(:merge)
end
# Returns a hash with pages as keys
def all_pages
@all_pages ||= all_subsections.map { |_subsection_key, subsection_value|
subsection_value["pages"]
}.reduce(:merge)
end
# Returns a hash with the pages of a subsection as keys
def pages_for_subsection(subsection)
all_subsections[subsection]["pages"]
end
# Returns a hash with the questions as keys
def questions_for_page(page)
all_pages[page]["questions"]
end
# Returns a hash with the questions as keys
def questions_for_subsection(subsection)
pages_for_subsection(subsection).map { |title, _value| questions_for_page(title) }.reduce(:merge)
end
# Returns a hash with soft validation questions as keys
def soft_validations_for_page(page)
all_pages[page]["soft_validations"]
end
def expected_responses_for_page(page)
questions_for_page(page).merge(soft_validations_for_page(page) || {})
end
def first_page_for_subsection(subsection)
pages_for_subsection(subsection).keys.first
def get_page(id)
pages.find { |p| p.id == id }
end
def subsection_for_page(page)
all_subsections.find { |_subsection_key, subsection_value|
subsection_value["pages"].key?(page)
}.first
end
def page_for_question(question)
all_pages.find { |_page_key, page_value| page_value["questions"].key?(question) }.first
subsections.find { |s| s.pages.find { |p| p.id == page.id } }
end
def next_page(page, case_log)
subsection = subsection_for_page(page)
page_idx = pages_for_subsection(subsection).keys.index(page)
nxt_page = pages_for_subsection(subsection).keys[page_idx + 1]
page_ids = subsection_for_page(page).pages.map(&:id)
page_index = page_ids.index(page.id)
nxt_page = get_page(page_ids[page_index + 1])
return :check_answers if nxt_page.nil?
return nxt_page if page_routed_to?(nxt_page, case_log)
return nxt_page.id if nxt_page.routed_to?(case_log)
next_page(nxt_page, case_log)
end
@ -77,74 +36,16 @@ class Form
def next_page_redirect_path(page, case_log)
nxt_page = next_page(page, case_log)
if nxt_page == :check_answers
subsection = subsection_for_page(page)
"case_log_#{subsection}_check_answers_path"
"case_log_#{subsection_for_page(page).id}_check_answers_path"
else
"case_log_#{nxt_page}_path"
end
end
def all_questions
@all_questions ||= all_pages.map { |_page_key, page_value|
page_value["questions"]
}.reduce(:merge)
end
def filter_conditional_questions(questions, case_log)
applicable_questions = questions
questions.each do |k, question|
unless page_routed_to?(page_for_question(k), case_log)
applicable_questions = applicable_questions.reject { |z| z == k }
end
question.fetch("conditional_for", []).each do |conditional_question_key, condition|
if condition_not_met(case_log, k, question, condition)
applicable_questions = applicable_questions.reject { |z| z == conditional_question_key }
end
end
end
applicable_questions
end
def page_routed_to?(page, case_log)
# binding.pry
return true unless (conditions = page_dependencies(page))
conditions.all? do |question, value|
case_log[question].present? && case_log[question] == value
end
end
def page_dependencies(page)
all_pages[page]["depends_on"]
end
def condition_not_met(case_log, question_key, question, condition)
case question["type"]
when "numeric"
operator = condition[/[<>=]+/].to_sym
operand = condition[/\d+/].to_i
case_log[question_key].blank? || !case_log[question_key].send(operator, operand)
when "text"
case_log[question_key].blank? || !condition.include?(case_log[question_key])
when "radio"
case_log[question_key].blank? || !condition.include?(case_log[question_key])
when "select"
case_log[question_key].blank? || !condition.include?(case_log[question_key])
else
raise "Not implemented yet"
end
end
def get_answer_label(case_log, question_title)
question = all_questions[question_title]
if question["type"] == "checkbox"
answer = []
question["answer_options"].each { |key, value| case_log[key] == "Yes" ? answer << value : nil }
return answer.join(", ")
end
case_log[question_title]
def conditional_question_conditions
conditions = questions.map { |q| Hash(q.id => q.conditional_for) if q.conditional_for.present? }.compact
conditions.map { |c|
c.map { |k, v| v.keys.map { |key| Hash(from: k, to: key, cond: v[key]) } }
}.flatten
end
end

30
app/models/form/page.rb

@ -0,0 +1,30 @@
class Form::Page
attr_accessor :id, :header, :description, :questions, :soft_validations,
:depends_on, :subsection
def initialize(id, hsh, subsection)
@id = id
@header = hsh["header"]
@description = hsh["description"]
@questions = hsh["questions"].map { |q_id, q| Form::Question.new(q_id, q, self) }
@depends_on = hsh["depends_on"]
@soft_validations = hsh["soft_validations"]&.map { |v_id, s| Form::Question.new(v_id, s, self) }
@subsection = subsection
end
def expected_responses
questions + (soft_validations || [])
end
def has_soft_validations?
soft_validations.present?
end
def routed_to?(case_log)
return true unless depends_on
depends_on.all? do |question, value|
case_log[question].present? && case_log[question] == value
end
end
end

80
app/models/form/question.rb

@ -0,0 +1,80 @@
class Form::Question
attr_accessor :id, :header, :hint_text, :description, :questions,
:type, :min, :max, :step, :fields_to_add, :result_field,
:conditional_for, :readonly, :answer_options, :page, :check_answer_label
def initialize(id, hsh, page)
@id = id
@check_answer_label = hsh["check_answer_label"]
@header = hsh["header"]
@hint_text = hsh["hint_text"]
@type = hsh["type"]
@min = hsh["min"]
@max = hsh["max"]
@step = hsh["step"]
@fields_to_add = hsh["fields-to-add"]
@result_field = hsh["result-field"]
@readonly = hsh["readonly"]
@answer_options = hsh["answer_options"]
@conditional_for = hsh["conditional_for"]
@page = page
end
delegate :subsection, to: :page
delegate :form, to: :subsection
def answer_label(case_log)
return checkbox_answer_label(case_log) if type == "checkbox"
case_log[id].to_s
end
def read_only?
!!readonly
end
def conditional_on
@conditional_on ||= form.conditional_question_conditions.select do |condition|
condition[:to] == id
end
end
def enabled?(case_log)
return true if conditional_on.blank?
conditional_on.map { |condition| evaluate_condition(condition, case_log) }.all?
end
def update_answer_link_name(case_log)
if type == "checkbox"
answer_options.keys.any? { |key| case_log[key] == "Yes" } ? "Change" : "Answer"
else
case_log[id].blank? ? "Answer" : "Change"
end
end
private
def checkbox_answer_label(case_log)
answer = []
answer_options.each { |key, value| case_log[key] == "Yes" ? answer << value : nil }
answer.join(", ")
end
def evaluate_condition(condition, case_log)
case page.questions.find { |q| q.id == condition[:from] }.type
when "numeric"
operator = condition[:cond][/[<>=]+/].to_sym
operand = condition[:cond][/\d+/].to_i
case_log[condition[:from]].present? && case_log[condition[:from]].send(operator, operand)
when "text"
case_log[condition[:from]].present? && condition[:cond].include?(case_log[condition[:from]])
when "radio"
case_log[condition[:from]].present? && condition[:cond].include?(case_log[condition[:from]])
when "select"
case_log[condition[:from]].present? && condition[:cond].include?(case_log[condition[:from]])
else
raise "Not implemented yet"
end
end
end

10
app/models/form/section.rb

@ -0,0 +1,10 @@
class Form::Section
attr_accessor :id, :label, :subsections, :form
def initialize(id, hsh, form)
@id = id
@label = hsh["label"]
@form = form
@subsections = hsh["subsections"].map { |s_id, s| Form::Subsection.new(s_id, s, self) }
end
end

65
app/models/form/subsection.rb

@ -0,0 +1,65 @@
class Form::Subsection
attr_accessor :id, :label, :section, :pages, :depends_on, :form
def initialize(id, hsh, section)
@id = id
@label = hsh["label"]
@depends_on = hsh["depends_on"]
@pages = hsh["pages"].map { |s_id, p| Form::Page.new(s_id, p, self) }
@section = section
end
delegate :form, to: :section
def questions
@questions ||= pages.flat_map(&:questions)
end
def enabled?(case_log)
return true unless depends_on
depends_on.all? do |subsection_id, dependent_status|
form.get_subsection(subsection_id).status(case_log) == dependent_status.to_sym
end
end
def status(case_log)
unless enabled?(case_log)
return :cannot_start_yet
end
qs = applicable_questions(case_log)
return :not_started if qs.all? { |question| case_log[question.id].blank? }
return :completed if qs.all? { |question| case_log[question.id].present? }
:in_progress
end
def is_incomplete?(case_log)
%i[not_started in_progress].include?(status(case_log))
end
def is_started?(case_log)
%i[in_progress completed].include?(status(case_log))
end
def applicable_questions_count(case_log)
applicable_questions(case_log).count
end
def answered_questions_count(case_log)
answered_questions(case_log).count
end
def applicable_questions(case_log)
questions.select { |q| q.page.routed_to?(case_log) && q.enabled?(case_log) }
end
def answered_questions(case_log)
applicable_questions(case_log).select { |question| case_log[question.id].present? }
end
def unanswered_questions(case_log)
applicable_questions(case_log) - answered_questions(case_log)
end
end

5
app/models/user.rb

@ -0,0 +1,5 @@
class User < ApplicationRecord
# Include default devise modules. Others available are:
# :confirmable, :lockable, :timeoutable, :trackable and :omniauthable
devise :database_authenticatable, :recoverable, :rememberable, :validatable
end

10
app/validations/household_validations.rb

@ -5,12 +5,12 @@ module HouseholdValidations
if record.homeless == "No" && record.reasonpref == "Yes"
record.errors.add :reasonpref, "Can not be Yes if Not Homeless immediately prior to this letting has been selected"
elsif record.reasonpref == "Yes"
if !record.rp_homeless && !record.rp_insan_unsat && !record.rp_medwel && !record.rp_hardship && !record.rp_dontknow
record.errors.add :reasonable_preference_reason, "If reasonable preference is Yes, a reason must be given"
if [record.rp_homeless, record.rp_insan_unsat, record.rp_medwel, record.rp_hardship, record.rp_dontknow].none? { |a| a == "Yes" }
record.errors.add :reasonable_preference_reason, 'If reasonable preference is "Yes", a reason must be given'
end
elsif record.reasonpref == "No"
if record.rp_homeless || record.rp_insan_unsat || record.rp_medwel || record.rp_hardship || record.rp_dontknow
record.errors.add :reasonable_preference_reason, "If reasonable preference is No, no reasons should be given"
if [record.rp_homeless, record.rp_insan_unsat, record.rp_medwel, record.rp_hardship, record.rp_dontknow].any? { |a| a == "Yes" }
record.errors.add :reasonable_preference_reason, 'If reasonable preference is "No", no reasons should be given'
end
end
end
@ -66,7 +66,7 @@ module HouseholdValidations
return unless record.age1
if !record.age1.is_a?(Integer) || record.age1 < 16 || record.age1 > 120
record.errors.add "age1", "Tenant age must be an integer between 16 and 120"
record.errors.add :age1, "Tenant age must be an integer between 16 and 120"
end
end

14
app/views/case_logs/_tasklist.html.erb

@ -1,18 +1,16 @@
<ol class="app-task-list app-task-list--no-numbers">
<% @form.all_sections.map do |section_key, section_value| %>
<% @form.sections.map do |section| %>
<li>
<h2 class="app-task-list__section">
<span class="app-task-list__section-number">
<%= section_value["label"] %>
<%= section.label %>
</span>
</h2>
<ul class="app-task-list__items">
<% section_value["subsections"].map do |subsection_key, subsection_value| %>
<li class="app-task-list__item" id=<%= subsection_key %>>
<% questions_for_subsection = @form.questions_for_subsection(subsection_key) %>
<% next_page_path = get_first_page_or_check_answers(subsection_key, @case_log, @form, questions_for_subsection) %>
<%= link_to subsection_value["label"], next_page_path, class: "task-name govuk-link" %>
<% subsection_status = get_subsection_status(subsection_key, @case_log, @form, questions_for_subsection) %>
<% section.subsections.map do |subsection| %>
<li class="app-task-list__item" id=<%= subsection.id %>>
<% subsection_status = subsection.status(@case_log) %>
<%= subsection_link(subsection, @case_log) %>
<strong class="govuk-tag app-task-list__tag <%= TasklistHelper::STYLES[subsection_status] %>">
<%= TasklistHelper::STATUSES[subsection_status] %>
</strong>

4
app/views/case_logs/edit.html.erb

@ -1,14 +1,14 @@
<%= turbo_frame_tag "case_log_form", target: "_top" do %>
<div class="govuk-grid-row">
<div class="govuk-grid-column-two-thirds-from-desktop">
<h1 class="govuk-heading-xl">Tasklist for log
<h1 class="govuk-heading-l">Tasklist for log
<%= @case_log.id %></h1>
<h2 class="govuk-heading-s govuk-!-margin-bottom-2">This submission is
<%= @case_log.status.to_s.humanize.downcase %></h2>
<p class="govuk-body govuk-!-margin-bottom-7">You've completed <%= get_subsections_count(@form, @case_log, :completed) %> of <%= get_subsections_count(@form, @case_log, :all) %> sections.</p>
<p class="govuk-body govuk-!-margin-bottom-7">
<% next_incomplete_section=get_next_incomplete_section(@form, @case_log) %>
<% next_incomplete_section = get_next_incomplete_section(@form, @case_log).id %>
<a class="govuk-link" href="#<%= next_incomplete_section %>"
data-controller="tasklist"
data-action="tasklist#addHighlight"

2
app/views/case_logs/index.html.erb

@ -1,6 +1,6 @@
<div class="govuk-grid-row">
<div class="govuk-grid-column-full">
<h1 class="govuk-heading-xl">Your logs</h1>
<h1 class="govuk-heading-l">Your logs</h1>
</div>
<div class="govuk-grid-column-two-thirds-from-desktop">

16
app/views/devise/confirmations/new.html.erb

@ -0,0 +1,16 @@
<h2>Resend confirmation instructions</h2>
<%= form_for(resource, as: resource_name, url: confirmation_path(resource_name), html: { method: :post }) do |f| %>
<%= render "devise/shared/error_messages", resource: resource %>
<div class="field">
<%= f.label :email %><br />
<%= f.email_field :email, autofocus: true, autocomplete: "email", value: (resource.pending_reconfirmation? ? resource.unconfirmed_email : resource.email) %>
</div>
<div class="actions">
<%= f.submit "Resend confirmation instructions" %>
</div>
<% end %>
<%= render "devise/shared/links" %>

8
app/views/devise/confirmations/reset.html.erb

@ -0,0 +1,8 @@
<div class="govuk-grid-row">
<div class="govuk-grid-column-two-thirds">
<h1 class="govuk-heading-l"> Check your email</h1>
<p class="govuk-body">We’ve sent a link to reset your password to <strong><%= @email %></strong>.</p>
<p class="govuk-body">You’ll only this receive this link if your email address already exists in our system.</p>
<p class="govuk-body">If you don’t receive the email within 5 minutes, check your spam or junk folders. Try again if you still haven’t received the email.</p>
</div>
</div>

5
app/views/devise/mailer/confirmation_instructions.html.erb

@ -0,0 +1,5 @@
<p>Welcome <%= @email %>!</p>
<p>You can confirm your account email through the link below:</p>
<p><%= link_to 'Confirm my account', confirmation_url(@resource, confirmation_token: @token) %></p>

7
app/views/devise/mailer/email_changed.html.erb

@ -0,0 +1,7 @@
<p>Hello <%= @email %>!</p>
<% if @resource.try(:unconfirmed_email?) %>
<p>We're contacting you to notify you that your email is being changed to <%= @resource.unconfirmed_email %>.</p>
<% else %>
<p>We're contacting you to notify you that your email has been changed to <%= @resource.email %>.</p>
<% end %>

3
app/views/devise/mailer/password_change.html.erb

@ -0,0 +1,3 @@
<p>Hello <%= @resource.email %>!</p>
<p>We're contacting you to notify you that your password has been changed.</p>

8
app/views/devise/mailer/reset_password_instructions.html.erb

@ -0,0 +1,8 @@
<p>Hello <%= @resource.email %>!</p>
<p>Someone has requested a link to change your password. You can do this through the link below.</p>
<p><%= link_to 'Change my password', edit_password_url(@resource, reset_password_token: @token) %></p>
<p>If you didn't request this, please ignore this email.</p>
<p>Your password won't change until you access the link above and create a new one.</p>

7
app/views/devise/mailer/unlock_instructions.html.erb

@ -0,0 +1,7 @@
<p>Hello <%= @resource.email %>!</p>
<p>Your account has been locked due to an excessive number of unsuccessful sign in attempts.</p>
<p>Click the link below to unlock your account:</p>
<p><%= link_to 'Unlock my account', unlock_url(@resource, unlock_token: @token) %></p>

19
app/views/devise/passwords/edit.html.erb

@ -0,0 +1,19 @@
<%= form_for(resource, as: resource_name, url: password_path(resource_name), html: { method: :put }) do |f| %>
<div class="govuk-grid-row">
<div class="govuk-grid-column-two-thirds">
<h1 class="govuk-heading-l">Reset your password</h1>
<%= render "devise/shared/error_messages", resource: resource %>
<%= f.hidden_field :reset_password_token %>
<div class="govuk-form-group">
<%= f.label :password, "New password", class: "govuk-label" %>
<% if @minimum_password_length %>
<div class="govuk-hint">Your password must be at least 8 characters and hard to guess.</div>
<% end %>
<%= f.password_field :password, autofocus: true, autocomplete: "new-password", class: "govuk-input" %>
</div>
<%= f.submit "Reset password", class: "govuk-button" %>
</div>
</div>
<% end %>

24
app/views/devise/passwords/new.html.erb

@ -0,0 +1,24 @@
<% content_for :before_content do %>
<%= link_to 'Back', :back, class: "govuk-back-link" %>
<% end %>
<%= form_for(resource, as: resource_name, url: password_path(resource_name), html: { method: :post }) do |f| %>
<div class="govuk-grid-row">
<div class="govuk-grid-column-two-thirds">
<h1 class="govuk-heading-l">Reset password</h1>
<%= render "devise/shared/error_messages", resource: resource %>
<p class="govuk-body">Enter the email address you used to create your account.</p>
<p class="govuk-body">We’ll email you a link to reset your password. This link will expire in 3 hours.</p>
<div class="govuk-form-group">
<%= f.label :email, "Email address", class: "govuk-label" %>
<%= f.email_field :email, autofocus: true, autocomplete: "email", class: "govuk-input" %>
</div>
<%= f.submit "Send email", class: "govuk-button" %>
</div>
</div>
<% end %>
<%= render "devise/shared/links" %>

43
app/views/devise/registrations/edit.html.erb

@ -0,0 +1,43 @@
<h2>Edit <%= resource_name.to_s.humanize %></h2>
<%= form_for(resource, as: resource_name, url: registration_path(resource_name), html: { method: :put }) do |f| %>
<%= render "devise/shared/error_messages", resource: resource %>
<div class="field">
<%= f.label :email %><br />
<%= f.email_field :email, autofocus: true, autocomplete: "email" %>
</div>
<% if devise_mapping.confirmable? && resource.pending_reconfirmation? %>
<div>Currently waiting confirmation for: <%= resource.unconfirmed_email %></div>
<% end %>
<div class="field">
<%= f.label :password %> <i>(leave blank if you don't want to change it)</i><br />
<%= f.password_field :password, autocomplete: "new-password" %>
<% if @minimum_password_length %>
<br />
<em><%= @minimum_password_length %> characters minimum</em>
<% end %>
</div>
<div class="field">
<%= f.label :password_confirmation %><br />
<%= f.password_field :password_confirmation, autocomplete: "new-password" %>
</div>
<div class="field">
<%= f.label :current_password %> <i>(we need your current password to confirm your changes)</i><br />
<%= f.password_field :current_password, autocomplete: "current-password" %>
</div>
<div class="actions">
<%= f.submit "Update" %>
</div>
<% end %>
<h3>Cancel my account</h3>
<p>Unhappy? <%= button_to "Cancel my account", registration_path(resource_name), data: { confirm: "Are you sure?" }, method: :delete %></p>
<%= link_to "Back", :back %>

29
app/views/devise/registrations/new.html.erb

@ -0,0 +1,29 @@
<h2>Sign up</h2>
<%= form_for(resource, as: resource_name, url: registration_path(resource_name)) do |f| %>
<%= render "devise/shared/error_messages", resource: resource %>
<div class="field">
<%= f.label :email %><br />
<%= f.email_field :email, autofocus: true, autocomplete: "email" %>
</div>
<div class="field">
<%= f.label :password %>
<% if @minimum_password_length %>
<em>(<%= @minimum_password_length %> characters minimum)</em>
<% end %><br />
<%= f.password_field :password, autocomplete: "new-password" %>
</div>
<div class="field">
<%= f.label :password_confirmation %><br />
<%= f.password_field :password_confirmation, autocomplete: "new-password" %>
</div>
<div class="actions">
<%= f.submit "Sign up" %>
</div>
<% end %>
<%= render "devise/shared/links" %>

21
app/views/devise/sessions/new.html.erb

@ -0,0 +1,21 @@
<%= form_for(resource, as: resource_name, url: session_path(resource_name)) do |f| %>
<div class="govuk-grid-row">
<div class="govuk-grid-column-two-thirds">
<h1 class="govuk-heading-l">Sign in to your account to submit CORE data</h1>
<div class="govuk-form-group">
<%= f.label :email, "Email address", class: "govuk-label" %>
<%= f.email_field :email, autofocus: true, autocomplete: "email", class: "govuk-input" %>
</div>
<div class="govuk-form-group">
<%= f.label :password, class: "govuk-label" %>
<%= f.password_field :password, autocomplete: "current-password", class: "govuk-input" %>
</div>
<%= f.submit "Sign in", class: "govuk-button" %>
</div>
</div>
<% end %>
<%= render "devise/shared/links" %>

15
app/views/devise/shared/_error_messages.html.erb

@ -0,0 +1,15 @@
<% if resource.errors.any? %>
<div id="error_explanation">
<h2>
<%= I18n.t("errors.messages.not_saved",
count: resource.errors.count,
resource: resource.class.model_name.human.downcase)
%>
</h2>
<ul>
<% resource.errors.full_messages.each do |message| %>
<li><%= message %></li>
<% end %>
</ul>
</div>
<% end %>

25
app/views/devise/shared/_links.html.erb

@ -0,0 +1,25 @@
<%- if controller_name != 'sessions' %>
<p class="govuk-body">Already have an account? <%= link_to "Sign in", new_session_path(resource_name) %>.</p><br />
<% end %>
<%- if devise_mapping.registerable? && controller_name != 'registrations' %>
<%= link_to "Sign up", new_registration_path(resource_name) %><br />
<% end %>
<%- if devise_mapping.recoverable? && controller_name != 'passwords' && controller_name != 'registrations' %>
<p class="govuk-body"> You can <%= link_to "reset your password", new_password_path(resource_name) %> if you've forgotten it.<p><br />
<% end %>
<%- if devise_mapping.confirmable? && controller_name != 'confirmations' %>
<%= link_to "Didn't receive confirmation instructions?", new_confirmation_path(resource_name) %><br />
<% end %>
<%- if devise_mapping.lockable? && resource_class.unlock_strategy_enabled?(:email) && controller_name != 'unlocks' %>
<%= link_to "Didn't receive unlock instructions?", new_unlock_path(resource_name) %><br />
<% end %>
<%- if devise_mapping.omniauthable? %>
<%- resource_class.omniauth_providers.each do |provider| %>
<%= link_to "Sign in with #{OmniAuth::Utils.camelize(provider)}", omniauth_authorize_path(resource_name, provider), method: :post %><br />
<% end %>
<% end %>

16
app/views/devise/unlocks/new.html.erb

@ -0,0 +1,16 @@
<h2>Resend unlock instructions</h2>
<%= form_for(resource, as: resource_name, url: unlock_path(resource_name), html: { method: :post }) do |f| %>
<%= render "devise/shared/error_messages", resource: resource %>
<div class="field">
<%= f.label :email %><br />
<%= f.email_field :email, autofocus: true, autocomplete: "email" %>
</div>
<div class="actions">
<%= f.submit "Resend unlock instructions" %>
</div>
<% end %>
<%= render "devise/shared/links" %>

6
app/views/form/_check_answers_table.html.erb

@ -1,11 +1,11 @@
<div class="govuk-summary-list__row">
<dt class="govuk-summary-list__key">
<%= question_info["check_answer_label"].to_s.present? ? question_info["check_answer_label"].to_s : question_info["header"].to_s%>
<%= question.check_answer_label.to_s.present? ? question.check_answer_label.to_s : question.header.to_s %>
<dt>
<dd class="govuk-summary-list__value">
<%= form.get_answer_label(@case_log, question_title) %>
<%= question.answer_label(@case_log) %>
</dd>
<dd class="govuk-summary-list__actions">
<%= create_update_answer_link(question_title, question_info, @case_log, form) %>
<%= link_to(question.update_answer_link_name(@case_log), "/case_logs/#{@case_log.id}/#{question.page.id}", class: "govuk-link").html_safe %>
</dd>
</div>

10
app/views/form/_checkbox_question.html.erb

@ -1,12 +1,12 @@
<%= f.govuk_check_boxes_fieldset question_key,
legend: { text: question["header"].html_safe, size: "l" },
hint: { text: question["hint_text"] } do %>
<%= f.govuk_check_boxes_fieldset question.id.to_sym,
legend: { text: question.header.html_safe, size: page_header.nil? ? "l" : "m", tag: page_header.nil? ? "h2" : "h1" },
hint: { text: question.hint_text } do %>
<% question["answer_options"].map do |key, val| %>
<% question.answer_options.map do |key, val| %>
<% if key.starts_with?("divider") %>
<%= f.govuk_check_box_divider %>
<% else %>
<%= f.govuk_check_box question_key, key,
<%= f.govuk_check_box question.id, key,
label: { text: val },
checked: @case_log[key] == "Yes",
**stimulus_html_attributes(question)

6
app/views/form/_date_question.html.erb

@ -1,6 +1,6 @@
<%= f.govuk_date_field question_key,
hint: { text: question["hint_text"] },
legend: { text: question["header"].html_safe, size: "l"},
<%= f.govuk_date_field question.id.to_sym,
hint: { text: question.hint_text },
legend: { text: question.header.html_safe, size: page_header.nil? ? "l" : "m", tag: page_header.nil? ? "h2" : "h1" },
width: 20,
**stimulus_html_attributes(question)
%>

10
app/views/form/_numeric_question.html.erb

@ -1,7 +1,7 @@
<%= f.govuk_number_field question_key,
hint: { text: question["hint_text"] },
label: { text: question["header"].html_safe, size: "l"},
min: question["min"], max: question["max"], step: question["step"],
width: 20, :readonly => question["readonly"],
<%= f.govuk_number_field question.id.to_sym,
hint: { text: question.hint_text },
label: { text: question.header.html_safe, size: page_header.nil? ? "l" : "m", tag: page_header.nil? ? "h2" : "h1" },
min: question.min, max: question.max, step: question.step,
width: 20, :readonly => question.read_only?,
**stimulus_html_attributes(question)
%>

12
app/views/form/_radio_question.html.erb

@ -1,13 +1,13 @@
<%= f.govuk_radio_buttons_fieldset question_key,
legend: { text: question["header"].html_safe, size: "l" },
hint: { text: question["hint_text"] },
small: (question["answer_options"].size > 5) do %>
<%= f.govuk_radio_buttons_fieldset question.id.to_sym,
legend: { text: question.header.html_safe, size: page_header.nil? ? "l" : "m", tag: page_header.nil? ? "h2" : "h1" },
hint: { text: question.hint_text },
small: (question.answer_options.size > 5) do %>
<% question["answer_options"].map do |key, val| %>
<% question.answer_options.map do |key, val| %>
<% if key.starts_with?("divider") %>
<%= f.govuk_radio_divider %>
<% else %>
<%= f.govuk_radio_button question_key, val, label: { text: val }, **stimulus_html_attributes(question) %>
<%= f.govuk_radio_button question.id, val, label: { text: val }, **stimulus_html_attributes(question) %>
<% end %>
<% end %>
<% end %>

11
app/views/form/_select_question.html.erb

@ -1,11 +1,8 @@
<%= answers = question["answer_options"].map {|key, value| OpenStruct.new(id:key, name: value)}
f.govuk_collection_select question_key,
<%= answers = question.answer_options.map { |key, value| OpenStruct.new(id:key, name: value) }
f.govuk_collection_select question.id.to_sym,
answers,
:name,
:name,
label: { text: question["header"]},
hint: { text: question["hint_text"] }
label: { text: question.header, size: page_header.nil? ? "l" : "m", tag: page_header.nil? ? "h2" : "h1" },
hint: { text: question.hint_text }
%>

6
app/views/form/_text_question.html.erb

@ -1,6 +1,6 @@
<%= f.govuk_text_field question_key,
hint: { text: question["hint_text"] },
label: { text: question["header"].html_safe, size: "l"},
<%= f.govuk_text_field question.id.to_sym,
hint: { text: question.hint_text },
label: { text: question.header.html_safe, size: page_header.nil? ? "l" : "m", tag: page_header.nil? ? "h2" : "h1" },
width: 20,
**stimulus_html_attributes(question)
%>

6
app/views/form/_validation_override_question.html.erb

@ -3,13 +3,13 @@
data-soft-validations-target="override"
style='display:none;'>
<%= f.govuk_check_boxes_fieldset page_info["soft_validations"]&.keys&.first,
<%= f.govuk_check_boxes_fieldset page.soft_validations&.first&.id.to_sym,
legend: { text: "soft-validations-placeholder-message", size: "l" },
hint: { text: "soft-validations-placeholder-hint-text" } do %>
<%= f.govuk_check_box page_info["soft_validations"]&.keys&.first, page_info["soft_validations"]&.keys&.first,
<%= f.govuk_check_box page.soft_validations&.first&.id, page.soft_validations&.first&.id,
label: { text: "Yes" },
checked: @case_log[page_info["soft_validations"]&.keys&.first] == "Yes"
checked: @case_log[page.soft_validations&.first&.id] == "Yes"
%>
<% end %>
</div>

8
app/views/form/check_answers.html.erb

@ -1,11 +1,11 @@
<%= turbo_frame_tag "case_log_form", target: "_top" do %>
<div class="govuk-grid-row">
<div class="govuk-grid-column-three-quarters-from-desktop">
<h1 class="govuk-heading-l">Check the answers you gave for <%= subsection.humanize(capitalize: false) %></h1>
<%= display_answered_questions_summary(subsection, @case_log, form) %>
<h1 class="govuk-heading-l">Check the answers you gave for <%= subsection.id.humanize(capitalize: false) %></h1>
<%= display_answered_questions_summary(subsection, @case_log) %>
<dl class="govuk-summary-list govuk-!-margin-bottom-9">
<% total_questions(subsection, @case_log, form).each do |question_title, question_info| %>
<%= render partial: 'form/check_answers_table', locals: { question_title: question_title, question_info: question_info, case_log: @case_log, form: form } %>
<% subsection.applicable_questions(@case_log).each do |question| %>
<%= render partial: 'form/check_answers_table', locals: { question: question, case_log: @case_log } %>
<% end %>
</dl>
<%= form_with model: @case_log, method: "get", builder: GOVUKDesignSystemFormBuilder::FormBuilder do |f| %>

21
app/views/form/page.html.erb

@ -5,24 +5,27 @@
<%= turbo_frame_tag "case_log_form", target: "_top" do %>
<div class="govuk-grid-row">
<div class="govuk-grid-column-two-thirds-from-desktop">
<% if page_info["header"].present? %>
<h1 class="govuk-heading-xl">
<%= page_info["header"] %>
<span class="govuk-caption-l">
<%= subsection %>
</span>
<% if page.header.present? %>
<h1 class="govuk-heading-l">
<%= page.header %>
</h1>
<% end %>
<%= form_with model: @case_log, url: form_case_log_path(@case_log), method: "post", builder: GOVUKDesignSystemFormBuilder::FormBuilder do |f| %>
<%= f.govuk_error_summary %>
<% page_info["questions"].map do |question_key, question| %>
<div id=<%= question_key + "_div " %><%= display_question_key_div(page_info, question_key) %> >
<%= render partial: "form/#{question["type"]}_question", locals: { question_key: question_key.to_sym, question: question, f: f } %>
<% page.questions.map do |question| %>
<div id=<%= question.id + "_div " %><%= display_question_key_div(page, question) %> >
<%= render partial: "form/#{question.type}_question", locals: { question: question, page_header: page.header, f: f } %>
</div>
<% end %>
<% if page_info["soft_validations"]&.keys&.first %>
<%= render partial: "form/validation_override_question", locals: { f: f, page_key: page_key, page_info: page_info } %>
<% if page.has_soft_validations? %>
<%= render partial: "form/validation_override_question", locals: { f: f, page: page } %>
<% end %>
<%= f.hidden_field :page, value: page_key %>
<%= f.hidden_field :page, value: page.id %>
<%= f.govuk_submit "Save and continue" %>
<% end %>
</div>

2
app/views/layouts/application.html.erb

@ -16,6 +16,8 @@
<%= stylesheet_pack_tag 'application', media: 'all' %>
<%= javascript_pack_tag 'application', defer: true %>
<p class="notice"><%= notice %></p>
<p class="alert"><%= alert %></p>
<% if Rails.env.development? %>
<script>

16
config/environments/development.rb

@ -38,6 +38,22 @@ Rails.application.configure do
config.action_mailer.perform_caching = false
config.action_mailer.default_url_options = { host: "localhost", port: 3000 }
config.action_mailer.perform_deliveries = true
config.action_mailer.delivery_method = :smtp
config.action_mailer.smtp_settings = {
address: "smtp.gmail.com",
port: 465,
domain: "gmail.com",
user_name: ENV["CORE_EMAIL_USERNAME"],
password: ENV["CORE_EMAIL_PASSWORD"],
authentication: "plain",
enable_starttls_auto: true,
ssl: true,
}
# Print deprecation notices to the Rails logger.
config.active_support.deprecation = :log

3
config/environments/test.rb

@ -37,10 +37,13 @@ Rails.application.configure do
config.action_mailer.perform_caching = false
config.action_mailer.default_url_options = { host: "localhost", port: 3000 }
# Tell Action Mailer not to deliver emails to the real world.
# The :test delivery method accumulates sent emails in the
# ActionMailer::Base.deliveries array.
config.action_mailer.delivery_method = :test
config.action_mailer.default_options = { from: "test@gmail.com" }
# Print deprecation notices to the stderr.
config.active_support.deprecation = :stderr

19
config/forms/2021_2022.json

@ -194,6 +194,7 @@
"subsections": {
"household_characteristics": {
"label": "Household characteristics",
"depends_on": {"about_this_log": "completed"},
"pages": {
"person_1_age": {
"header": "",
@ -740,6 +741,7 @@
},
"household_situation": {
"label": "Household situation",
"depends_on": {"about_this_log": "completed"},
"pages": {
"previous_housing_situation": {
"header": "",
@ -865,6 +867,7 @@
},
"household_needs": {
"label": "Household needs",
"depends_on": {"about_this_log": "completed"},
"pages": {
"armed_forces": {
"header": "Experience of the UK Armed Forces",
@ -1002,6 +1005,7 @@
"subsections": {
"tenancy_information": {
"label": "Tenancy information",
"depends_on": {"about_this_log": "completed"},
"pages": {
"starter_tenancy": {
"header": "",
@ -1101,6 +1105,7 @@
},
"property_information": {
"label": "Property information",
"depends_on": { "about_this_log": "completed" },
"pages": {
"property_reference": {
"header": "",
@ -1750,6 +1755,7 @@
"subsections": {
"income_and_benefits": {
"label": "Income and benefits",
"depends_on": {"about_this_log": "completed"},
"pages": {
"net_income": {
"header": "",
@ -1843,6 +1849,7 @@
},
"rent": {
"label": "Rent",
"depends_on": {"about_this_log": "completed"},
"pages": {
"rent": {
"header": "",
@ -1968,6 +1975,7 @@
"subsections": {
"local_authority": {
"label": "Local authority",
"depends_on": {"about_this_log": "completed"},
"pages": {
"time_lived_in_la": {
"header": "",
@ -2431,6 +2439,17 @@
"subsections": {
"declaration": {
"label": "Declaration",
"depends_on": {
"about_this_log": "completed",
"household_characteristics": "completed",
"household_situation": "completed",
"household_needs": "completed",
"tenancy_information": "completed",
"property_information": "completed",
"income_and_benefits": "completed",
"rent": "completed",
"local_authority": "completed"
},
"pages": {
"declaration": {
"header": "",

4
config/initializers/active_admin.rb

@ -54,7 +54,7 @@ ActiveAdmin.setup do |config|
#
# This setting changes the method which Active Admin calls
# within the application controller.
# config.authentication_method = :authenticate_admin_user!
config.authentication_method = :authenticate_admin_user!
# == User Authorization
#
@ -91,7 +91,7 @@ ActiveAdmin.setup do |config|
#
# This setting changes the method which Active Admin calls
# (within the application controller) to return the currently logged in user.
# config.current_user_method = :current_admin_user
config.current_user_method = :current_admin_user
# == Logging Out
#

311
config/initializers/devise.rb

@ -0,0 +1,311 @@
# frozen_string_literal: true
# Assuming you have not yet modified this file, each configuration option below
# is set to its default value. Note that some are commented out while others
# are not: uncommented lines are intended to protect your configuration from
# breaking changes in upgrades (i.e., in the event that future versions of
# Devise change the default values for those options).
#
# Use this hook to configure devise mailer, warden hooks and so forth.
# Many of these configuration options can be set straight in your model.
Devise.setup do |config|
# The secret key used by Devise. Devise uses this key to generate
# random tokens. Changing this key will render invalid all existing
# confirmation, reset password and unlock tokens in the database.
# Devise will use the `secret_key_base` as its `secret_key`
# by default. You can change it below and use your own secret key.
# config.secret_key = '34fb13b209832f5c881689fa96eb14f27bff6e61657dfcf944205feaef9ee8d313573d9eabab816b737bffbacf1782d4d687d379d9559c195a4990df12a93785'
# ==> Controller configuration
# Configure the parent class to the devise controllers.
# config.parent_controller = 'DeviseController'
# ==> Mailer Configuration
# Configure the e-mail address which will be shown in Devise::Mailer,
# note that it will be overwritten if you use your own mailer class
# with default "from" parameter.
config.mailer_sender = ENV["CORE_EMAIL_USERNAME"]
# Configure the class responsible to send e-mails.
# config.mailer = 'Devise::Mailer'
# Configure the parent class responsible to send e-mails.
# config.parent_mailer = 'ActionMailer::Base'
# ==> ORM configuration
# Load and configure the ORM. Supports :active_record (default) and
# :mongoid (bson_ext recommended) by default. Other ORMs may be
# available as additional gems.
require "devise/orm/active_record"
# ==> Configuration for any authentication mechanism
# Configure which keys are used when authenticating a user. The default is
# just :email. You can configure it to use [:username, :subdomain], so for
# authenticating a user, both parameters are required. Remember that those
# parameters are used only when authenticating and not when retrieving from
# session. If you need permissions, you should implement that in a before filter.
# You can also supply a hash where the value is a boolean determining whether
# or not authentication should be aborted when the value is not present.
# config.authentication_keys = [:email]
# Configure parameters from the request object used for authentication. Each entry
# given should be a request method and it will automatically be passed to the
# find_for_authentication method and considered in your model lookup. For instance,
# if you set :request_keys to [:subdomain], :subdomain will be used on authentication.
# The same considerations mentioned for authentication_keys also apply to request_keys.
# config.request_keys = []
# Configure which authentication keys should be case-insensitive.
# These keys will be downcased upon creating or modifying a user and when used
# to authenticate or find a user. Default is :email.
config.case_insensitive_keys = [:email]
# Configure which authentication keys should have whitespace stripped.
# These keys will have whitespace before and after removed upon creating or
# modifying a user and when used to authenticate or find a user. Default is :email.
config.strip_whitespace_keys = [:email]
# Tell if authentication through request.params is enabled. True by default.
# It can be set to an array that will enable params authentication only for the
# given strategies, for example, `config.params_authenticatable = [:database]` will
# enable it only for database (email + password) authentication.
# config.params_authenticatable = true
# Tell if authentication through HTTP Auth is enabled. False by default.
# It can be set to an array that will enable http authentication only for the
# given strategies, for example, `config.http_authenticatable = [:database]` will
# enable it only for database authentication.
# For API-only applications to support authentication "out-of-the-box", you will likely want to
# enable this with :database unless you are using a custom strategy.
# The supported strategies are:
# :database = Support basic authentication with authentication key + password
# config.http_authenticatable = false
# If 401 status code should be returned for AJAX requests. True by default.
# config.http_authenticatable_on_xhr = true
# The realm used in Http Basic Authentication. 'Application' by default.
# config.http_authentication_realm = 'Application'
# It will change confirmation, password recovery and other workflows
# to behave the same regardless if the e-mail provided was right or wrong.
# Does not affect registerable.
# config.paranoid = true
# By default Devise will store the user in session. You can skip storage for
# particular strategies by setting this option.
# Notice that if you are skipping storage for all authentication paths, you
# may want to disable generating routes to Devise's sessions controller by
# passing skip: :sessions to `devise_for` in your config/routes.rb
config.skip_session_storage = [:http_auth]
# By default, Devise cleans up the CSRF token on authentication to
# avoid CSRF token fixation attacks. This means that, when using AJAX
# requests for sign in and sign up, you need to get a new CSRF token
# from the server. You can disable this option at your own risk.
# config.clean_up_csrf_token_on_authentication = true
# When false, Devise will not attempt to reload routes on eager load.
# This can reduce the time taken to boot the app but if your application
# requires the Devise mappings to be loaded during boot time the application
# won't boot properly.
# config.reload_routes = true
# ==> Configuration for :database_authenticatable
# For bcrypt, this is the cost for hashing the password and defaults to 12. If
# using other algorithms, it sets how many times you want the password to be hashed.
# The number of stretches used for generating the hashed password are stored
# with the hashed password. This allows you to change the stretches without
# invalidating existing passwords.
#
# Limiting the stretches to just one in testing will increase the performance of
# your test suite dramatically. However, it is STRONGLY RECOMMENDED to not use
# a value less than 10 in other environments. Note that, for bcrypt (the default
# algorithm), the cost increases exponentially with the number of stretches (e.g.
# a value of 20 is already extremely slow: approx. 60 seconds for 1 calculation).
config.stretches = Rails.env.test? ? 1 : 12
# Set up a pepper to generate the hashed password.
# config.pepper = '1c69067fda44e12f0ea1e8573fcdb122e5ff7e51a28cc6944c2548af7b7cbfe1400739e2d71cdf0ab53a3b60305942301d7fd7f43ff3a51316e51438145d80ad'
# Send a notification to the original email when the user's email is changed.
# config.send_email_changed_notification = false
# Send a notification email when the user's password is changed.
# config.send_password_change_notification = false
# ==> Configuration for :confirmable
# A period that the user is allowed to access the website even without
# confirming their account. For instance, if set to 2.days, the user will be
# able to access the website for two days without confirming their account,
# access will be blocked just in the third day.
# You can also set it to nil, which will allow the user to access the website
# without confirming their account.
# Default is 0.days, meaning the user cannot access the website without
# confirming their account.
# config.allow_unconfirmed_access_for = 2.days
# A period that the user is allowed to confirm their account before their
# token becomes invalid. For example, if set to 3.days, the user can confirm
# their account within 3 days after the mail was sent, but on the fourth day
# their account can't be confirmed with the token any more.
# Default is nil, meaning there is no restriction on how long a user can take
# before confirming their account.
# config.confirm_within = 3.days
# If true, requires any email changes to be confirmed (exactly the same way as
# initial account confirmation) to be applied. Requires additional unconfirmed_email
# db field (see migrations). Until confirmed, new email is stored in
# unconfirmed_email column, and copied to email column on successful confirmation.
config.reconfirmable = true
# Defines which key will be used when confirming an account
# config.confirmation_keys = [:email]
# ==> Configuration for :rememberable
# The time the user will be remembered without asking for credentials again.
# config.remember_for = 2.weeks
# Invalidates all the remember me tokens when the user signs out.
config.expire_all_remember_me_on_sign_out = true
# If true, extends the user's remember period when remembered via cookie.
# config.extend_remember_period = false
# Options to be passed to the created cookie. For instance, you can set
# secure: true in order to force SSL only cookies.
# config.rememberable_options = {}
# ==> Configuration for :validatable
# Range for password length.
config.password_length = 8..128
# Email regex used to validate email formats. It simply asserts that
# one (and only one) @ exists in the given string. This is mainly
# to give user feedback and not to assert the e-mail validity.
config.email_regexp = /\A[^@\s]+@[^@\s]+\z/
# ==> Configuration for :timeoutable
# The time you want to timeout the user session without activity. After this
# time the user will be asked for credentials again. Default is 30 minutes.
# config.timeout_in = 30.minutes
# ==> Configuration for :lockable
# Defines which strategy will be used to lock an account.
# :failed_attempts = Locks an account after a number of failed attempts to sign in.
# :none = No lock strategy. You should handle locking by yourself.
# config.lock_strategy = :failed_attempts
# Defines which key will be used when locking and unlocking an account
# config.unlock_keys = [:email]
# Defines which strategy will be used to unlock an account.
# :email = Sends an unlock link to the user email
# :time = Re-enables login after a certain amount of time (see :unlock_in below)
# :both = Enables both strategies
# :none = No unlock strategy. You should handle unlocking by yourself.
# config.unlock_strategy = :both
# Number of authentication tries before locking an account if lock_strategy
# is failed attempts.
# config.maximum_attempts = 20
# Time interval to unlock the account if :time is enabled as unlock_strategy.
# config.unlock_in = 1.hour
# Warn on the last attempt before the account is locked.
# config.last_attempt_warning = true
# ==> Configuration for :recoverable
#
# Defines which key will be used when recovering the password for an account
# config.reset_password_keys = [:email]
# Time interval you can reset your password with a reset password key.
# Don't put a too small interval or your users won't have the time to
# change their passwords.
config.reset_password_within = 3.hours
# When set to false, does not sign a user in automatically after their password is
# reset. Defaults to true, so a user is signed in automatically after a reset.
# config.sign_in_after_reset_password = true
# ==> Configuration for :encryptable
# Allow you to use another hashing or encryption algorithm besides bcrypt (default).
# You can use :sha1, :sha512 or algorithms from others authentication tools as
# :clearance_sha1, :authlogic_sha512 (then you should set stretches above to 20
# for default behavior) and :restful_authentication_sha1 (then you should set
# stretches to 10, and copy REST_AUTH_SITE_KEY to pepper).
#
# Require the `devise-encryptable` gem when using anything other than bcrypt
# config.encryptor = :sha512
# ==> Scopes configuration
# Turn scoped views on. Before rendering "sessions/new", it will first check for
# "users/sessions/new". It's turned off by default because it's slower if you
# are using only default views.
# config.scoped_views = false
# Configure the default scope given to Warden. By default it's the first
# devise role declared in your routes (usually :user).
# config.default_scope = :user
# Set this configuration to false if you want /users/sign_out to sign out
# only the current scope. By default, Devise signs out all scopes.
# config.sign_out_all_scopes = true
# ==> Navigation configuration
# Lists the formats that should be treated as navigational. Formats like
# :html, should redirect to the sign in page when the user does not have
# access, but formats like :xml or :json, should return 401.
#
# If you have any extra navigational formats, like :iphone or :mobile, you
# should add them to the navigational formats lists.
#
# The "*/*" below is required to match Internet Explorer requests.
# config.navigational_formats = ['*/*', :html]
# The default HTTP method used to sign out a resource. Default is :delete.
config.sign_out_via = :delete
# ==> OmniAuth
# Add a new OmniAuth provider. Check the wiki for more information on setting
# up on your models and hooks.
# config.omniauth :github, 'APP_ID', 'APP_SECRET', scope: 'user,public_repo'
# ==> Warden configuration
# If you want to use other strategies, that are not supported by Devise, or
# change the failure app, you can configure them inside the config.warden block.
#
# config.warden do |manager|
# manager.intercept_401 = false
# manager.default_strategies(scope: :user).unshift :some_external_strategy
# end
# ==> Mountable engine configurations
# When using Devise inside an engine, let's call it `MyEngine`, and this engine
# is mountable, there are some extra configurations to be taken into account.
# The following options are available, assuming the engine is mounted as:
#
# mount MyEngine, at: '/my_engine'
#
# The router that invoked `devise_for`, in the example above, would be:
# config.router_name = :my_engine
#
# When using OmniAuth, Devise cannot automatically set OmniAuth path,
# so you need to do it manually. For the users scope, it would be:
# config.omniauth_path_prefix = '/my_engine/users/auth'
# ==> Turbolinks configuration
# If your app is using Turbolinks, Turbolinks::Controller needs to be included to make redirection work correctly:
#
# ActiveSupport.on_load(:devise_failure_app) do
# include Turbolinks::Controller
# end
# ==> Configuration for :registerable
# When set to false, does not sign a user in automatically after their password is
# changed. Defaults to true, so a user is signed in automatically after changing a password.
# config.sign_in_after_change_password = true
end

65
config/locales/devise.en.yml

@ -0,0 +1,65 @@
# Additional translations at https://github.com/heartcombo/devise/wiki/I18n
en:
devise:
confirmations:
confirmed: "Your email address has been successfully confirmed."
send_instructions: "You will receive an email with instructions for how to confirm your email address in a few minutes."
send_paranoid_instructions: "If your email address exists in our database, you will receive an email with instructions for how to confirm your email address in a few minutes."
failure:
already_authenticated: "You are already signed in."
inactive: "Your account is not activated yet."
invalid: "Invalid %{authentication_keys} or password."
locked: "Your account is locked."
last_attempt: "You have one more attempt before your account is locked."
not_found_in_database: "Invalid %{authentication_keys} or password."
timeout: "Your session expired. Please sign in again to continue."
unauthenticated: "You need to sign in or sign up before continuing."
unconfirmed: "You have to confirm your email address before continuing."
mailer:
confirmation_instructions:
subject: "Confirmation instructions"
reset_password_instructions:
subject: "Reset password instructions"
unlock_instructions:
subject: "Unlock instructions"
email_changed:
subject: "Email Changed"
password_change:
subject: "Password Changed"
omniauth_callbacks:
failure: "Could not authenticate you from %{kind} because \"%{reason}\"."
success: "Successfully authenticated from %{kind} account."
passwords:
no_token: "You can't access this page without coming from a password reset email. If you do come from a password reset email, please make sure you used the full URL provided."
send_instructions: "You will receive an email with instructions on how to reset your password in a few minutes."
send_paranoid_instructions: "If your email address exists in our database, you will receive a password recovery link at your email address in a few minutes."
updated: "Your password has been changed successfully. You are now signed in."
updated_not_active: "Your password has been changed successfully."
registrations:
destroyed: "Bye! Your account has been successfully cancelled. We hope to see you again soon."
signed_up: "Welcome! You have signed up successfully."
signed_up_but_inactive: "You have signed up successfully. However, we could not sign you in because your account is not yet activated."
signed_up_but_locked: "You have signed up successfully. However, we could not sign you in because your account is locked."
signed_up_but_unconfirmed: "A message with a confirmation link has been sent to your email address. Please follow the link to activate your account."
update_needs_confirmation: "You updated your account successfully, but we need to verify your new email address. Please check your email and follow the confirmation link to confirm your new email address."
updated: "Your account has been updated successfully."
updated_but_not_signed_in: "Your account has been updated successfully, but since your password was changed, you need to sign in again."
sessions:
signed_in: "Signed in successfully."
signed_out: "Signed out successfully."
already_signed_out: "Signed out successfully."
unlocks:
send_instructions: "You will receive an email with instructions for how to unlock your account in a few minutes."
send_paranoid_instructions: "If your account exists, you will receive an email with instructions for how to unlock it in a few minutes."
unlocked: "Your account has been unlocked successfully. Please sign in to continue."
errors:
messages:
already_confirmed: "was already confirmed, please try signing in"
confirmation_period_expired: "needs to be confirmed within %{period}, please request a new one"
expired: "has expired, please request a new one"
not_found: "not found"
not_locked: "was not locked"
not_saved:
one: "1 error prohibited this %{resource} from being saved:"
other: "%{count} errors prohibited this %{resource} from being saved:"

16
config/routes.rb

@ -1,4 +1,10 @@
Rails.application.routes.draw do
devise_for :admin_users, ActiveAdmin::Devise.config
devise_for :users, controllers: { passwords: "users/passwords" }
devise_scope :user do
get "confirmations/reset", to: "users/passwords#reset_confirmation"
end
# For details on the DSL available within this file, see https://guides.rubyonrails.org/routing.html
ActiveAdmin.routes(self)
root to: "test#index"
@ -17,13 +23,13 @@ Rails.application.routes.draw do
post "/form", to: "case_logs#submit_form"
end
form.all_pages.keys.map do |page|
get page.to_s, to: "case_logs##{page}"
get "#{page}/soft_validations", to: "soft_validations#show" if form.soft_validations_for_page(page)
form.pages.map do |page|
get page.id.to_s, to: "case_logs##{page.id}"
get "#{page.id}/soft_validations", to: "soft_validations#show" if page.has_soft_validations?
end
form.all_subsections.keys.map do |subsection|
get "#{subsection}/check_answers", to: "case_logs#check_answers"
form.subsections.map do |subsection|
get "#{subsection.id}/check_answers", to: "case_logs#check_answers"
end
end
end

43
db/migrate/20211101103235_devise_create_users.rb

@ -0,0 +1,43 @@
# frozen_string_literal: true
class DeviseCreateUsers < ActiveRecord::Migration[6.1]
def change
create_table :users do |t|
## Database authenticatable
t.string :email, null: false, default: ""
t.string :encrypted_password, null: false, default: ""
## Recoverable
t.string :reset_password_token
t.datetime :reset_password_sent_at
## Rememberable
t.datetime :remember_created_at
## Trackable
# t.integer :sign_in_count, default: 0, null: false
# t.datetime :current_sign_in_at
# t.datetime :last_sign_in_at
# t.string :current_sign_in_ip
# t.string :last_sign_in_ip
## Confirmable
# t.string :confirmation_token
# t.datetime :confirmed_at
# t.datetime :confirmation_sent_at
# t.string :unconfirmed_email # Only if using reconfirmable
## Lockable
# t.integer :failed_attempts, default: 0, null: false # Only if lock strategy is :failed_attempts
# t.string :unlock_token # Only if unlock strategy is :email or :both
# t.datetime :locked_at
t.timestamps null: false
end
add_index :users, :email, unique: true
add_index :users, :reset_password_token, unique: true
# add_index :users, :confirmation_token, unique: true
# add_index :users, :unlock_token, unique: true
end
end

17
db/migrate/20211118090831_change_armed_forces.rb

@ -0,0 +1,17 @@
class ChangeArmedForces < ActiveRecord::Migration[6.1]
def up
change_table :case_logs, bulk: true do |t|
t.remove :armed_forces
t.remove :armed_forces_partner
t.column :armedforces, :integer
end
end
def down
change_table :case_logs, bulk: true do |t|
t.remove :armedforces
t.column :armed_forces, :string
t.column :armed_forces_partner, :string
end
end
end

18
db/migrate/20211119120910_add_admin_users.rb

@ -0,0 +1,18 @@
class AddAdminUsers < ActiveRecord::Migration[6.1]
def change
create_table :admin_users do |t|
## Database authenticatable
t.string :email, null: false, default: ""
t.string :encrypted_password, null: false, default: ""
## Recoverable
t.string :reset_password_token
t.datetime :reset_password_sent_at
## Rememberable
t.datetime :remember_created_at
t.timestamps null: false
end
end
end

27
db/schema.rb

@ -10,11 +10,21 @@
#
# It's strongly recommended that you check this file into your version control system.
ActiveRecord::Schema.define(version: 2021_11_19_104835) do
ActiveRecord::Schema.define(version: 2021_11_19_120910) do
# These are extensions that must be enabled in order to support this database
enable_extension "plpgsql"
create_table "admin_users", force: :cascade do |t|
t.string "email", default: "", null: false
t.string "encrypted_password", default: "", null: false
t.string "reset_password_token"
t.datetime "reset_password_sent_at"
t.datetime "remember_created_at"
t.datetime "created_at", precision: 6, null: false
t.datetime "updated_at", precision: 6, null: false
end
create_table "case_logs", force: :cascade do |t|
t.integer "status", default: 0
t.datetime "created_at", precision: 6, null: false
@ -90,7 +100,6 @@ ActiveRecord::Schema.define(version: 2021_11_19_104835) do
t.integer "tcharge"
t.integer "layear"
t.integer "lawaitlist"
t.string "property_postcode"
t.integer "reasonpref"
t.string "reasonable_preference_reason"
t.integer "cbl"
@ -158,7 +167,21 @@ ActiveRecord::Schema.define(version: 2021_11_19_104835) do
t.string "why_dont_you_know_la"
t.string "type_property_most_recently_let_as"
t.string "builtype"
t.integer "armedforces"
t.string "property_postcode"
t.index ["discarded_at"], name: "index_case_logs_on_discarded_at"
end
create_table "users", force: :cascade do |t|
t.string "email", default: "", null: false
t.string "encrypted_password", default: "", null: false
t.string "reset_password_token"
t.datetime "reset_password_sent_at"
t.datetime "remember_created_at"
t.datetime "created_at", precision: 6, null: false
t.datetime "updated_at", precision: 6, null: false
t.index ["email"], name: "index_users_on_email", unique: true
t.index ["reset_password_token"], name: "index_users_on_reset_password_token", unique: true
end
end

3
db/seeds.rb

@ -5,3 +5,6 @@
#
# movies = Movie.create([{ name: 'Star Wars' }, { name: 'Lord of the Rings' }])
# Character.create(name: 'Luke', movie: movies.first)
User.create!(email: "test@example.com", password: "password")
AdminUser.create!(email: "admin@example.com", password: "password")

9
docs/adr/adr-010-admin-users-vs-users.md

@ -0,0 +1,9 @@
### ADR - 010: Admin Users vs Users
#### Why do we have 2 User classes, AdminUser and User?
This is modelling a real life split. `AdminUsers` are internal DLUHC users or helpdesk employees. While `Users` are external users working at data providing organisations. So local authority/housing association's "admin" users, i.e. Data Co-ordinators are a type of the User class. They have the ability to add or remove other users to or from their organisation, and to update their organisation details etc, but only through the designed UI. They do not get direct access to ActiveAdmin.
AdminUsers on the other hand get direct access to ActiveAdmin. From there they can download entire datasets (via CSV, XML, JSON), view any log from any organisation, and add or remove users of any type including other Admin users. This means TDA will likely also require more stringent authentication for them using MFA (which users will likely not require). So the class split also helps there.
A potential downside to this approach is that it does not currently allow for `AdminUsers` to sign into the application UI itself with their Admin credentials. However, we need to see if there's an actual use case for this and what it would be (since they aren't part of an organisation to be uploading data for, but could add or amend data or user or org details through ActiveAdmin anyway). If there is a strong use case for it this could be work around by either: providing them with two sets of credentials, or modifying the `authenticate_user` method to also check `AdminUser` credentials.

10
docs/adr/adr-011-form-oop-refactor.md

@ -0,0 +1,10 @@
### ADR - 011: Splitting the form parsing into objects
Initially a single "Form" class handled the parsing of the form definition JSON as well as a lot of the logic around what different sections meant. This works fine but led to a lot of places in code where we're passing around arguments to determine whether a page or section should or shouldn't do something rather than being able to ask it directly. Refactoring this into smaller form domain object classes has several benefits:
- It's easier to compare the form definition JSON to the code classes and reason about what fields can be passed and what effect they'll have
- It moves business logic out of the helpers and keeps them to just dealing with display logic
- It makes it easier to unit test form functionality, and group that into smaller chunks
- It allows for less passing of arguments. e.g. `page.routed_to?(case_log)` vs `form.was_page_routed_to?(page, case_log)`
This abstraction is likely still not the best (the form vs case log split) but this seems like an improvement that can be iterated on.

17
spec/controllers/case_logs_controller_spec.rb

@ -1,7 +1,9 @@
require "rails_helper"
require_relative "../support/devise"
RSpec.describe CaseLogsController, type: :controller do
let(:valid_session) { {} }
login_user
context "Collection routes" do
describe "GET #index" do
@ -91,7 +93,9 @@ RSpec.describe CaseLogsController, type: :controller do
page: "accessibility_requirements" }
end
let(:questions_for_page) do
{ "accessibility_requirements" =>
[
Form::Question.new(
"accessibility_requirements",
{
"type" => "checkbox",
"answer_options" =>
@ -104,15 +108,14 @@ RSpec.describe CaseLogsController, type: :controller do
"housingneeds_h" => "Do not know",
"divider_b" => true,
"accessibility_requirements_prefer_not_to_say" => "Prefer not to say" },
},
"tenant_code" =>
{
"type" => "text",
} }
}, nil
),
Form::Question.new("tenant_code", { "type" => "text" }, nil),
]
end
it "updates both question fields" do
allow_any_instance_of(Form).to receive(:questions_for_page).and_return(questions_for_page)
allow_any_instance_of(Form::Page).to receive(:expected_responses).and_return(questions_for_page)
post :submit_form, params: { id: id, case_log: case_log_form_params }
case_log.reload

118
spec/factories/case_log.rb

@ -8,11 +8,6 @@ FactoryBot.define do
previous_postcode { "SW2 6HI" }
age1 { "17" }
end
trait :completed do
status { 2 }
tenant_code { "BZ737" }
property_postcode { "NW1 7TY" }
end
trait :soft_validations_triggered do
status { 1 }
ecstat1 { "Full-time - 30 hours or more" }
@ -28,6 +23,119 @@ FactoryBot.define do
ecstat1 { 2 }
other_hhmemb { 0 }
end
trait :completed do
status { 2 }
tenant_code { "BZ737" }
postcode { "NW1 7TY" }
age1 { 35 }
sex1 { "F" }
ethnic { 2 }
national { 4 }
prevten { "Private sector tenancy" }
ecstat1 { 2 }
other_hhmemb { 1 }
hhmemb { 2 }
relat2 { "Partner" }
age2 { 32 }
sex2 { "Male" }
ecstat2 { "Not seeking work" }
homeless { "Yes - other homelessness" }
underoccupation_benefitcap { "No" }
leftreg { "No - they left up to 5 years ago" }
reservist { "No" }
illness { "Yes" }
preg_occ { "No" }
accessibility_requirements { "No" }
condition_effects { "dummy" }
tenancy_code { "BZ757" }
startertenancy { "No" }
tenancylength { 5 }
tenancy { "Secure (including flexible)" }
lettype { "Affordable Rent - General Needs" }
landlord { "This landlord" }
previous_postcode { "SE2 6RT" }
rsnvac { "Relet - tenant abandoned property" }
unittype_gn { "House" }
property_building_type { "dummy" }
beds { 3 }
property_void_date { "03/11/2019" }
offered { 2 }
wchair { "Yes" }
earnings { 60 }
incfreq { "Weekly" }
benefits { "Some" }
period { "Fortnightly" }
brent { 200 }
scharge { 50 }
pscharge { 40 }
supcharg { 35 }
tcharge { 325 }
layear { "1 to 2 years" }
lawaitlist { "Less than 1 year" }
property_postcode { "NW1 5TY" }
reasonpref { "Yes" }
reasonable_preference_reason { "dummy" }
cbl { "Yes" }
chr { "Yes" }
cap { "No" }
other_reason_for_leaving_last_settled_home { nil }
housingneeds_a { "Yes" }
housingneeds_b { "No" }
housingneeds_c { "No" }
housingneeds_f { "No" }
housingneeds_g { "No" }
housingneeds_h { "No" }
accessibility_requirements_prefer_not_to_say { 0 }
illness_type_1 { "No" }
illness_type_2 { "Yes" }
illness_type_3 { "No" }
illness_type_4 { "No" }
illness_type_8 { "No" }
illness_type_5 { "No" }
illness_type_6 { "No" }
illness_type_7 { "No" }
illness_type_9 { "No" }
illness_type_10 { "No" }
rp_homeless { "Yes" }
rp_insan_unsat { "No" }
rp_medwel { "No" }
rp_hardship { "No" }
rp_dontknow { "No" }
discarded_at { nil }
tenancyother { nil }
override_net_income_validation { nil }
net_income_known { "Yes" }
gdpr_acceptance { "Yes" }
gdpr_declined { "No" }
property_owner_organisation { "Test" }
property_manager_organisation { "Test" }
sale_or_letting { "Letting" }
tenant_same_property_renewal { 1 }
rent_type { 1 }
intermediate_rent_product_name { 2 }
needs_type { 1 }
purchaser_code { 798_794 }
reason { "Permanently decanted from another property owned by this landlord" }
propcode { "123" }
majorrepairs { "Yes" }
la { "Barnet" }
prevloc { "Ashford" }
hb { 1 }
hbrentshortfall { "Yes" }
tshortfall { 12 }
postcod2 { "w3" }
ppostc1 { "w3" }
ppostc2 { "w3" }
property_relet { "No" }
mrcdate { Time.zone.now }
mrcday { 5 }
mrcmonth { 5 }
mrcyear { 2020 }
incref { 554_355 }
sale_completion_date { nil }
startdate { nil }
armedforces { 1 }
end
created_at { Time.zone.now }
updated_at { Time.zone.now }
end

9
spec/factories/user.rb

@ -0,0 +1,9 @@
FactoryBot.define do
factory :user do
sequence(:id) { |i| i }
email { "test@example.com" }
password { "pAssword1" }
created_at { Time.zone.now }
updated_at { Time.zone.now }
end
end

8
spec/features/case_log_spec.rb

@ -1,10 +1,14 @@
require "rails_helper"
RSpec.describe "Test Features" do
RSpec.describe "Form Features" do
let!(:case_log) { FactoryBot.create(:case_log, :in_progress) }
let!(:empty_case_log) { FactoryBot.create(:case_log) }
let(:id) { case_log.id }
let(:status) { case_log.status }
before do
allow_any_instance_of(CaseLogsController).to receive(:authenticate_user!).and_return(true)
end
question_answers = {
tenant_code: { type: "text", answer: "BZ737", path: "tenant_code" },
age1: { type: "numeric", answer: 25, path: "person_1_age" },
@ -25,7 +29,7 @@ RSpec.describe "Test Features" do
click_button("Save and continue")
choose("case-log-benefits-all-field")
click_button("Save and continue")
choose("case-log-hb-housing-benefit-but-not-universal-credit-field")
choose("case-log-hb-prefer-not-to-say-field")
click_button("Save and continue")
end

53
spec/features/user_spec.rb

@ -0,0 +1,53 @@
require "rails_helper"
RSpec.describe "User Features" do
let!(:user) { FactoryBot.create(:user) }
context "A user navigating to case logs" do
it " is required to log in" do
visit("/case_logs")
expect(page).to have_current_path("/users/sign_in")
end
it " is redirected to case logs after signing in" do
visit("/case_logs")
fill_in("user_email", with: "test@example.com")
fill_in("user_password", with: "pAssword1")
click_button("Sign in")
expect(page).to have_current_path("/case_logs")
end
end
context "A user who has forgotten their password" do
it " is redirected to the reset password page when they click the reset password link" do
visit("/case_logs")
click_link("reset your password")
expect(page).to have_current_path("/users/password/new")
end
it " is redirected to check your email page after submitting an email on the reset password page" do
visit("/users/password/new")
fill_in("user_email", with: "test@example.com")
click_button("Send email")
expect(page).to have_content("Check your email")
end
it " is shown their email on the password reset confirmation page" do
visit("/users/password/new")
fill_in("user_email", with: "test@example.com")
click_button("Send email")
expect(page).to have_content("test@example.com")
end
it " is shown the reset password confirmation page even if their email doesn't exist in the system" do
visit("/users/password/new")
fill_in("user_email", with: "idontexist@example.com")
click_button("Send email")
expect(page).to have_current_path("/confirmations/reset?email=idontexist%40example.com")
end
it " is sent a reset password email" do
visit("/users/password/new")
fill_in("user_email", with: "test@example.com")
expect { click_button("Send email") }.to change { ActionMailer::Base.deliveries.count }.by(1)
end
end
end

41
spec/fixtures/forms/test_form.json vendored

@ -303,13 +303,15 @@
"label": "Income and benefits",
"pages": {
"net_income": {
"header": "Test header",
"description": "Some extra text for the page",
"questions": {
"earnings": {
"check_answer_label": "Income",
"header": "What is the tenant’s /and partner’s combined income after tax?",
"type": "numeric",
"min": 0,
"step": "1"
"step": 1
},
"incfreq": {
"check_answer_label": "Income Frequency",
@ -354,6 +356,32 @@
"answer_options": {
"0": "Housing Benefit, but not Universal Credit",
"1": "Prefer not to say"
},
"conditional_for": {
"conditional_question": ["Housing Benefit, but not Universal Credit"]
}
},
"conditional_question": {
"check_answer_label": "Conditional Question",
"header": "Question to test page conditions",
"type": "radio",
"answer_options": {
"0": "Option A",
"1": "Option B"
}
}
}
},
"dependent_page": {
"depends_on": { "incfreq": "Weekly" },
"questions": {
"dependent_question": {
"check_answer_label": "Dependent Question",
"header": "Question to test page routing",
"type": "checkbox",
"answer_options": {
"0": "Option A",
"1": "Option B"
}
}
}
@ -365,7 +393,7 @@
"pages": {
"rent": {
"questions": {
"rent_frequency": {
"period": {
"check_answer_label": "Rent Period",
"header": "Which period are rent and other charges due?",
"type": "radio",
@ -529,6 +557,15 @@
"subsections": {
"declaration": {
"label": "Declaration",
"depends_on": {
"household_characteristics": "completed",
"household_needs": "completed",
"tenancy_information": "completed",
"property_information": "completed",
"income_and_benefits": "completed",
"rent": "completed",
"local_authority": "completed"
},
"pages": {
"declaration": {
"questions": {

185
spec/helpers/check_answers_helper_spec.rb

@ -1,172 +1,29 @@
require "rails_helper"
RSpec.describe CheckAnswersHelper do
let(:case_log) { FactoryBot.create(:case_log) }
let(:case_log_with_met_numeric_condition) do
FactoryBot.create(
:case_log,
:in_progress,
other_hhmemb: 1,
relat2: "Partner",
)
end
let(:case_log_with_met_radio_condition) do
FactoryBot.create(:case_log, armedforces: "A current or former regular in the UK Armed Forces (exc. National Service)",
reservist: "No",
leftreg: "Yes")
end
let(:subsection) { "income_and_benefits" }
let(:subsection_with_numeric_conditionals) { "household_characteristics" }
let(:subsection_with_radio_conditionals) { "household_needs" }
let(:conditional_routing_subsection) { "conditional_question" }
let(:conditional_page_subsection) { "household_needs" }
form_handler = FormHandler.instance
let(:form) { form_handler.get_form("test_form") }
describe "Get answered questions total" do
it "returns 0 if no questions are answered" do
expect(total_answered_questions(subsection, case_log, form)).to equal(0)
end
it "returns 1 if 1 question gets answered" do
case_log["earnings"] = "123"
expect(total_answered_questions(subsection, case_log, form)).to equal(1)
end
it "ignores questions with unmet numeric conditions" do
case_log["tenant_code"] = "T1234"
expect(total_answered_questions(subsection_with_numeric_conditionals, case_log, form)).to equal(1)
end
it "includes conditional questions with met numeric conditions" do
expect(total_answered_questions(
subsection_with_numeric_conditionals,
case_log_with_met_numeric_condition,
form,
)).to equal(4)
end
it "ignores questions with unmet radio conditions" do
case_log["armedforces"] = "No"
expect(total_answered_questions(subsection_with_radio_conditionals, case_log, form)).to equal(1)
end
it "includes conditional questions with met radio conditions" do
case_log_with_met_radio_condition["reservist"] = "No"
case_log_with_met_radio_condition["illness"] = "No"
expect(total_answered_questions(
subsection_with_radio_conditionals,
case_log_with_met_radio_condition,
form,
)).to equal(4)
end
end
describe "Get total number of questions" do
it "returns the total number of questions for a subsection" do
expect(total_number_of_questions(subsection, case_log, form)).to eq(4)
end
it "ignores questions with unmet numeric conditions" do
expect(total_number_of_questions(subsection_with_numeric_conditionals, case_log, form)).to eq(4)
end
it "includes conditional questions with met numeric conditions" do
expect(total_number_of_questions(
subsection_with_numeric_conditionals,
case_log_with_met_numeric_condition,
form,
)).to eq(8)
end
it "ignores questions with unmet radio conditions" do
expect(total_number_of_questions(subsection_with_radio_conditionals, case_log, form)).to eq(4)
end
it "includes conditional questions with met radio conditions" do
expect(total_number_of_questions(
subsection_with_radio_conditionals,
case_log_with_met_radio_condition,
form,
)).to eq(6)
end
context "conditional questions with type that hasn't been implemented yet" do
let(:unimplemented_conditional) do
{ "previous_postcode" =>
{ "header" => "The actual question?",
"hint_text" => "",
"type" => "date",
"check_answer_label" => "Question Label",
"conditional_for" => { "question_2" => %w[12-12-2021] } } }
end
it "raises an error" do
allow_any_instance_of(Form).to receive(:questions_for_page).and_return(unimplemented_conditional)
expect { total_number_of_questions(subsection, case_log, form) }.to raise_error(RuntimeError, "Not implemented yet")
end
end
context "conditional routing" do
it "ignores not visited questions when no questions are answered" do
expect(total_number_of_questions(conditional_routing_subsection, case_log, form)).to eq(1)
end
it "counts correct questions when the conditional question is answered" do
case_log["preg_occ"] = "Yes"
expect(total_number_of_questions(conditional_routing_subsection, case_log, form)).to eq(2)
end
it "counts correct questions when the conditional question is answered" do
case_log["preg_occ"] = "No"
case_log["sex1"] = "Male"
expect(total_number_of_questions(conditional_routing_subsection, case_log, form)).to eq(3)
end
end
context "total questions" do
it "returns total questions" do
result = total_questions(subsection, case_log, form)
expected_keys = %w[earnings incfreq benefits hb]
expect(result.keys).to eq(expected_keys)
end
context "conditional questions on the same page" do
it "it filters out conditional questions that were not displayed" do
result = total_questions(conditional_page_subsection, case_log, form)
expected_keys = %w[armedforces illness accessibility_requirements condition_effects]
expect(result.keys).to eq(expected_keys)
end
it "it includes conditional questions that were displayed" do
case_log["armedforces"] = "A current or former regular in the UK Armed Forces (exc. National Service)"
result = total_questions(conditional_page_subsection, case_log, form)
expected_keys = %w[armedforces leftreg reservist illness accessibility_requirements condition_effects]
expect(result.keys).to eq(expected_keys)
end
end
context "conditional routing" do
it "it ignores skipped pages and the questions therein when conditional routing" do
result = total_questions(conditional_routing_subsection, case_log, form)
expected_keys = %w[preg_occ]
expect(result.keys).to match_array(expected_keys)
end
it "it includes conditional pages and questions that were displayed" do
case_log["preg_occ"] = "Yes"
case_log["sex1"] = "Female"
result = total_questions(conditional_routing_subsection, case_log, form)
expected_keys = %w[preg_occ cbl]
expect(result.keys).to match_array(expected_keys)
end
it "it includes conditional pages and questions that were displayed" do
case_log["preg_occ"] = "No"
result = total_questions(conditional_routing_subsection, case_log, form)
expected_keys = %w[preg_occ conditional_question_no_question]
expect(result.keys).to match_array(expected_keys)
end
let(:subsection) { form.get_subsection("household_characteristics") }
let(:case_log) { FactoryBot.build(:case_log, :in_progress) }
describe "display_answered_questions_summary" do
context "given a section that hasn't been completed yet" do
it "returns a link to the next unanswered question" do
expect(display_answered_questions_summary(subsection, case_log))
.to match(/You answered 2 of 4 questions/)
expect(display_answered_questions_summary(subsection, case_log))
.to match(/href/)
end
end
context "given a section that has been completed" do
it "returns that you have answered all the questions" do
case_log.sex1 = "F"
case_log.other_hhmemb = 0
expect(display_answered_questions_summary(subsection, case_log))
.to match(/You answered all the questions/)
expect(display_answered_questions_summary(subsection, case_log))
.not_to match(/href/)
end
end
end

12
spec/helpers/conditional_questions_helper_spec.rb

@ -3,8 +3,7 @@ require "rails_helper"
RSpec.describe ConditionalQuestionsHelper do
form_handler = FormHandler.instance
let(:form) { form_handler.get_form("test_form") }
let(:page_key) { "armed_forces" }
let(:page) { form.all_pages[page_key] }
let(:page) { form.get_page("armed_forces") }
describe "conditional questions for page" do
let(:conditional_pages) { %w[leftreg reservist] }
@ -15,15 +14,14 @@ RSpec.describe ConditionalQuestionsHelper do
end
describe "display question key div" do
let(:question_key) { "armed_forces" }
let(:conditional_question_key) { "reservist" }
let(:conditional_question) { page.questions.find { |q| q.id == "reservist" } }
it "returns a non visible div for conditional questions" do
expect(display_question_key_div(page, conditional_question_key)).to match("style='display:none;'")
expect(display_question_key_div(page, conditional_question)).to match("style='display:none;'")
end
it "returns a visible div for conditional questions" do
expect(display_question_key_div(page, question_key)).not_to match("style='display:none;'")
it "returns a visible div for questions" do
expect(display_question_key_div(page, page.questions.first)).not_to match("style='display:none;'")
end
end
end

22
spec/helpers/question_attribute_helper_spec.rb

@ -3,25 +3,27 @@ require "rails_helper"
RSpec.describe QuestionAttributeHelper do
form_handler = FormHandler.instance
let(:form) { form_handler.get_form("test_form") }
let(:questions) { form.questions_for_page("rent") }
let(:questions) { form.get_page("rent").questions }
describe "html attributes" do
it "returns empty hash if fields-to-add or result-field are empty " do
expect(stimulus_html_attributes(questions["tcharge"])).to eq({})
question = questions.find { |q| q.id == "tcharge" }
expect(stimulus_html_attributes(question)).to eq({})
end
it "returns html attributes if fields-to-add or result-field are not empty " do
expect(stimulus_html_attributes(questions["brent"])).to eq({
brent = questions.find { |q| q.id == "brent" }
expect(stimulus_html_attributes(brent)).to eq({
"data-controller": "numeric-question",
"data-action": "numeric-question#calculateFields",
"data-target": "case-log-#{questions['brent']['result-field'].to_s.dasherize}-field",
"data-calculated": questions["brent"]["fields-to-add"].to_json,
"data-target": "case-log-#{brent.result_field.to_s.dasherize}-field",
"data-calculated": brent.fields_to_add.to_json,
})
end
context "a question that requires multiple controllers" do
let(:question) do
{
Form::Question.new("brent", {
"check_answer_label" => "Basic Rent",
"header" => "What is the basic rent?",
"hint_text" => "Eligible for housing benefit or Universal Credit",
@ -33,15 +35,15 @@ RSpec.describe QuestionAttributeHelper do
"conditional_for" => {
"next_question": ">1",
},
}
}, nil)
end
let(:expected_attribs) do
{
"data-controller": "numeric-question conditional-question",
"data-action": "numeric-question#calculateFields conditional-question#displayConditional",
"data-target": "case-log-#{question['result-field'].to_s.dasherize}-field",
"data-calculated": question["fields-to-add"].to_json,
"data-info": question["conditional_for"].to_json,
"data-target": "case-log-#{question.result_field.to_s.dasherize}-field",
"data-calculated": question.fields_to_add.to_json,
"data-info": question.conditional_for.to_json,
}
end
it "correctly merges html attributes" do

78
spec/helpers/tasklist_helper_spec.rb

@ -3,65 +3,17 @@ require "rails_helper"
RSpec.describe TasklistHelper do
let(:empty_case_log) { FactoryBot.build(:case_log) }
let(:case_log) { FactoryBot.build(:case_log, :in_progress) }
let(:completed_case_log) { FactoryBot.build(:case_log, :completed) }
form_handler = FormHandler.instance
let(:form) { form_handler.get_form("test_form") }
let(:household_characteristics_questions) { form.questions_for_subsection("household_characteristics") }
describe "get subsection status" do
let(:section) { "income_and_benefits" }
let(:income_and_benefits_questions) { form.questions_for_subsection("income_and_benefits") }
let(:declaration_questions) { form.questions_for_subsection("declaration") }
let(:local_authority_questions) { form.questions_for_subsection("local_authority") }
it "returns not started if none of the questions in the subsection are answered" do
status = get_subsection_status("income_and_benefits", case_log, form, income_and_benefits_questions)
expect(status).to eq(:not_started)
end
it "returns cannot start yet if the subsection is declaration" do
status = get_subsection_status("declaration", case_log, form, declaration_questions)
expect(status).to eq(:cannot_start_yet)
end
it "returns in progress if some of the questions have been answered" do
case_log["previous_postcode"] = "P0 5TT"
status = get_subsection_status("local_authority", case_log, form, local_authority_questions)
expect(status).to eq(:in_progress)
end
it "returns completed if all the questions in the subsection have been answered" do
case_log["earnings"] = "value"
case_log["incfreq"] = "Weekly"
case_log["benefits"] = "All"
case_log["hb"] = "Do not know"
status = get_subsection_status("income_and_benefits", case_log, form, income_and_benefits_questions)
expect(status).to eq(:completed)
end
it "returns not started if the subsection is declaration and all the questions are completed" do
status = get_subsection_status("declaration", completed_case_log, form, declaration_questions)
expect(status).to eq(:not_started)
end
let(:conditional_section_complete_case_log) { FactoryBot.build(:case_log, :conditional_section_complete) }
it "sets the correct status for sections with conditional questions" do
status = get_subsection_status(
"household_characteristics", conditional_section_complete_case_log, form, household_characteristics_questions
)
expect(status).to eq(:completed)
end
end
describe "get next incomplete section" do
it "returns the first subsection name if it is not completed" do
expect(get_next_incomplete_section(form, case_log)).to eq("household_characteristics")
expect(get_next_incomplete_section(form, case_log).id).to eq("household_characteristics")
end
it "returns the first subsection name if it is partially completed" do
case_log["tenant_code"] = 123
expect(get_next_incomplete_section(form, case_log)).to eq("household_characteristics")
expect(get_next_incomplete_section(form, case_log).id).to eq("household_characteristics")
end
end
@ -88,12 +40,34 @@ RSpec.describe TasklistHelper do
end
describe "get_first_page_or_check_answers" do
let(:subsection) { form.get_subsection("household_characteristics") }
it "returns the check answers page path if the section has been started already" do
expect(get_first_page_or_check_answers("household_characteristics", case_log, form, household_characteristics_questions)).to match(/check_answers/)
expect(first_page_or_check_answers(subsection, case_log)).to match(/check_answers/)
end
it "returns the first question page path for the section if it has not been started yet" do
expect(get_first_page_or_check_answers("household_characteristics", empty_case_log, form, household_characteristics_questions)).to match(/tenant_code/)
expect(first_page_or_check_answers(subsection, empty_case_log)).to match(/tenant_code/)
end
end
describe "subsection link" do
let(:subsection) { form.get_subsection("household_characteristics") }
context "for a subsection that's enabled" do
it "returns the subsection link url" do
expect(subsection_link(subsection, case_log)).to match(/household_characteristics/)
end
end
context "for a subsection that cannot be started yet" do
before do
allow(subsection).to receive(:status).with(case_log).and_return(:cannot_start_yet)
end
it "returns a # link" do
expect(subsection_link(subsection, case_log)).to match(/#/)
end
end
end
end

19
spec/models/case_log_spec.rb

@ -26,8 +26,8 @@ RSpec.describe Form, type: :model do
expect { CaseLog.create!(offered: 0) }.to raise_error(ActiveRecord::RecordInvalid)
end
context "reasonable preference validation" do
it "if given reasonable preference is yes a reason must be selected" do
context "reasonable preference is yes" do
it "validates a reason must be selected" do
expect {
CaseLog.create!(reasonpref: "Yes",
rp_homeless: nil,
@ -38,7 +38,7 @@ RSpec.describe Form, type: :model do
}.to raise_error(ActiveRecord::RecordInvalid)
end
it "if not previously homeless reasonable preference should not be selected" do
it "validates that previously homeless should be selected" do
expect {
CaseLog.create!(
homeless: "No",
@ -46,17 +46,16 @@ RSpec.describe Form, type: :model do
)
}.to raise_error(ActiveRecord::RecordInvalid)
end
end
it "if not given reasonable preference a reason should not be selected" do
context "reasonable preference is no" do
it "validates no reason is needed" do
expect {
CaseLog.create!(
homeless: "Yes - other homelessness",
reasonpref: "No",
rp_homeless: "Yes",
)
}.to raise_error(ActiveRecord::RecordInvalid)
CaseLog.create!(reasonpref: "No", rp_homeless: "No")
}.not_to raise_error
end
end
context "reason for leaving last settled home validation" do
it "Reason for leaving must be don't know if reason for leaving settled home (Q9a) is don't know." do
expect {

66
spec/models/form/page_spec.rb

@ -0,0 +1,66 @@
require "rails_helper"
RSpec.describe Form::Page, type: :model do
let(:form) { FormHandler.instance.get_form("test_form") }
let(:section_id) { "rent_and_charges" }
let(:section_definition) { form.form_definition["sections"][section_id] }
let(:section) { Form::Section.new(section_id, section_definition, form) }
let(:subsection_id) { "income_and_benefits" }
let(:subsection_definition) { section_definition["subsections"][subsection_id] }
let(:subsection) { Form::Subsection.new(subsection_id, subsection_definition, section) }
let(:page_id) { "net_income" }
let(:page_definition) { subsection_definition["pages"][page_id] }
subject { Form::Page.new(page_id, page_definition, subsection) }
it "has an id" do
expect(subject.id).to eq(page_id)
end
it "has a header" do
expect(subject.header).to eq("Test header")
end
it "has a description" do
expect(subject.description).to eq("Some extra text for the page")
end
it "has questions" do
expected_questions = %w[earnings incfreq]
expect(subject.questions.map(&:id)).to eq(expected_questions)
end
it "has soft validations" do
expected_soft_validations = %w[override_net_income_validation]
expect(subject.soft_validations.map(&:id)).to eq(expected_soft_validations)
end
it "has a soft_validation helper" do
expect(subject.has_soft_validations?).to be true
end
it "has expected form responses" do
expected_responses = %w[earnings incfreq override_net_income_validation]
expect(subject.expected_responses.map(&:id)).to eq(expected_responses)
end
context "for a given case log" do
let(:case_log) { FactoryBot.build(:case_log, :in_progress) }
it "knows if it's been routed to" do
expect(subject.routed_to?(case_log)).to be true
end
context "given routing conditions" do
let(:page_id) { "dependent_page" }
it "evaluates not met conditions correctly" do
expect(subject.routed_to?(case_log)).to be false
end
it "evaluates not conditions correctly" do
case_log.incfreq = "Weekly"
expect(subject.routed_to?(case_log)).to be true
end
end
end
end

140
spec/models/form/question_spec.rb

@ -0,0 +1,140 @@
require "rails_helper"
RSpec.describe Form::Question, type: :model do
let(:form) { FormHandler.instance.get_form("test_form") }
let(:section_id) { "rent_and_charges" }
let(:section_definition) { form.form_definition["sections"][section_id] }
let(:section) { Form::Section.new(section_id, section_definition, form) }
let(:subsection_id) { "income_and_benefits" }
let(:subsection_definition) { section_definition["subsections"][subsection_id] }
let(:subsection) { Form::Subsection.new(subsection_id, subsection_definition, section) }
let(:page_id) { "net_income" }
let(:page_definition) { subsection_definition["pages"][page_id] }
let(:page) { Form::Page.new(page_id, page_definition, subsection) }
let(:question_id) { "earnings" }
let(:question_definition) { page_definition["questions"][question_id] }
subject { Form::Question.new(question_id, question_definition, page) }
it "has an id" do
expect(subject.id).to eq(question_id)
end
it "has a header" do
expect(subject.header).to eq("What is the tenant’s /and partner’s combined income after tax?")
end
it "has a check answers label" do
expect(subject.check_answer_label).to eq("Income")
end
it "has a question type" do
expect(subject.type).to eq("numeric")
end
it "belongs to a page" do
expect(subject.page).to eq(page)
end
it "belongs to a subsection" do
expect(subject.subsection).to eq(subsection)
end
it "has a read only helper" do
expect(subject.read_only?).to be false
end
context "when type is numeric" do
it "has a min value" do
expect(subject.min).to eq(0)
end
it "has a step value" do
expect(subject.step).to eq(1)
end
end
context "when type is radio" do
let(:question_id) { "incfreq" }
it "has answer options" do
expected_answer_options = { "0" => "Weekly", "1" => "Monthly", "2" => "Yearly" }
expect(subject.answer_options).to eq(expected_answer_options)
end
end
context "when type is checkbox" do
let(:page_id) { "dependent_page" }
let(:question_id) { "dependent_question" }
it "has answer options" do
expected_answer_options = { "0" => "Option A", "1" => "Option B" }
expect(subject.answer_options).to eq(expected_answer_options)
end
end
context "when the question is read only" do
let(:subsection_id) { "rent" }
let(:page_id) { "rent" }
let(:question_id) { "tcharge" }
it "has a read only helper" do
expect(subject.read_only?).to be true
end
context "when the answer is part of a sum" do
let(:question_id) { "pscharge" }
it "has a result_field" do
expect(subject.result_field).to eq("tcharge")
end
it "has fields to sum" do
expected_fields_to_sum = %w[brent scharge pscharge supcharg]
expect(subject.fields_to_add).to eq(expected_fields_to_sum)
end
end
end
context "for a given case log" do
let(:case_log) { FactoryBot.build(:case_log, :in_progress) }
it "has an answer label" do
case_log.earnings = 100
expect(subject.answer_label(case_log)).to eq("100")
end
it "has an update answer link text helper" do
expect(subject.update_answer_link_name(case_log)).to eq("Answer")
case_log[question_id] = 5
expect(subject.update_answer_link_name(case_log)).to eq("Change")
end
context "when type is checkbox" do
let(:section_id) { "household" }
let(:subsection_id) { "household_needs" }
let(:page_id) { "accessibility_requirements" }
let(:question_id) { "accessibility_requirements" }
it "has a joined answers label" do
case_log.housingneeds_a = 1
case_log.housingneeds_c = 1
expected_answer_label = "Fully wheelchair accessible housing, Level access housing"
expect(subject.answer_label(case_log)).to eq(expected_answer_label)
end
end
context "when a condition is present" do
let(:page_id) { "housing_benefit" }
let(:question_id) { "conditional_question" }
it "knows whether it is enabled or not for unmet conditions" do
expect(subject.enabled?(case_log)).to be false
end
it "knows whether it is enabled or not for met conditions" do
case_log.hb = "Housing Benefit, but not Universal Credit"
expect(subject.enabled?(case_log)).to be true
end
end
end
end

21
spec/models/form/section_spec.rb

@ -0,0 +1,21 @@
require "rails_helper"
RSpec.describe Form::Section, type: :model do
let(:form) { FormHandler.instance.get_form("test_form") }
let(:section_id) { "household" }
let(:section_definition) { form.form_definition["sections"][section_id] }
subject { Form::Section.new(section_id, section_definition, form) }
it "has an id" do
expect(subject.id).to eq(section_id)
end
it "has a label" do
expect(subject.label).to eq("About the household")
end
it "has subsections" do
expected_subsections = %w[household_characteristics household_needs]
expect(subject.subsections.map(&:id)).to eq(expected_subsections)
end
end

72
spec/models/form/subsection_spec.rb

@ -0,0 +1,72 @@
require "rails_helper"
RSpec.describe Form::Subsection, type: :model do
let(:form) { FormHandler.instance.get_form("test_form") }
let(:section_id) { "household" }
let(:section_definition) { form.form_definition["sections"][section_id] }
let(:section) { Form::Section.new(section_id, section_definition, form) }
let(:subsection_id) { "household_characteristics" }
let(:subsection_definition) { section_definition["subsections"][subsection_id] }
subject { Form::Subsection.new(subsection_id, subsection_definition, section) }
it "has an id" do
expect(subject.id).to eq(subsection_id)
end
it "has a label" do
expect(subject.label).to eq("Household characteristics")
end
it "has pages" do
expected_pages = %w[tenant_code person_1_age person_1_gender household_number_of_other_members]
expect(subject.pages.map(&:id)).to eq(expected_pages)
end
it "has questions" do
expected_questions = %w[tenant_code age1 sex1 other_hhmemb relat2 age2 sex2 ecstat2]
expect(subject.questions.map(&:id)).to eq(expected_questions)
end
context "for a given in progress case log" do
let(:case_log) { FactoryBot.build(:case_log, :in_progress) }
it "has a status" do
expect(subject.status(case_log)).to eq(:in_progress)
end
it "has status helpers" do
expect(subject.is_incomplete?(case_log)).to be(true)
expect(subject.is_started?(case_log)).to be(true)
end
it "has question helpers for the number of applicable questions" do
expected_questions = %w[tenant_code age1 sex1 other_hhmemb]
expect(subject.applicable_questions(case_log).map(&:id)).to eq(expected_questions)
expect(subject.applicable_questions_count(case_log)).to eq(4)
end
it "has question helpers for the number of answered questions" do
expected_questions = %w[tenant_code age1]
expect(subject.answered_questions(case_log).map(&:id)).to eq(expected_questions)
expect(subject.answered_questions_count(case_log)).to eq(2)
end
it "has a question helpers for the unanswered questions" do
expected_questions = %w[sex1 other_hhmemb]
expect(subject.unanswered_questions(case_log).map(&:id)).to eq(expected_questions)
end
end
context "for a given completed case log" do
let(:case_log) { FactoryBot.build(:case_log, :completed) }
it "has a status" do
expect(subject.status(case_log)).to eq(:completed)
end
it "has status helpers" do
expect(subject.is_incomplete?(case_log)).to be(false)
expect(subject.is_started?(case_log)).to be(true)
end
end
end

2
spec/models/form_handler_spec.rb

@ -15,7 +15,7 @@ RSpec.describe FormHandler do
form_handler = FormHandler.instance
form = form_handler.get_form("test_form")
expect(form).to be_a(Form)
expect(form.all_pages.count).to eq(23)
expect(form.pages.count).to eq(24)
end
end

26
spec/models/form_spec.rb

@ -4,34 +4,20 @@ RSpec.describe Form, type: :model do
form_handler = FormHandler.instance
let(:form) { form_handler.get_form("test_form") }
let(:case_log) { FactoryBot.build(:case_log, :in_progress) }
let(:completed_case_log) { FactoryBot.build(:case_log, :completed) }
let(:conditional_section_complete_case_log) { FactoryBot.build(:case_log, :conditional_section_complete) }
describe ".next_page" do
let(:previous_page) { "person_1_age" }
let(:previous_page) { form.get_page("person_1_age") }
it "returns the next page given the previous" do
expect(form.next_page(previous_page, case_log)).to eq("person_1_gender")
end
end
describe ".first_page_for_subsection" do
let(:subsection) { "household_characteristics" }
it "returns the first page given a subsection" do
expect(form.first_page_for_subsection(subsection)).to eq("tenant_code")
end
end
describe ".questions_for_subsection" do
let(:subsection) { "income_and_benefits" }
it "returns all questions for subsection" do
result = form.questions_for_subsection(subsection)
expect(result.length).to eq(4)
expect(result.keys).to eq(%w[earnings incfreq benefits hb])
end
end
describe "next_page_redirect_path" do
let(:previous_page) { "net_income" }
let(:last_previous_page) { "housing_benefit" }
let(:previous_conditional_page) { "conditional_question" }
let(:previous_page) { form.get_page("net_income") }
let(:last_previous_page) { form.get_page("housing_benefit") }
let(:previous_conditional_page) { form.get_page("conditional_question") }
it "returns a correct page path if there is no conditional routing" do
expect(form.next_page_redirect_path(previous_page, case_log)).to eq("case_log_net_income_uc_proportion_path")

3
spec/rails_helper.rb

@ -113,4 +113,7 @@ RSpec.configure do |config|
# Silence capybara logging puma start up messages to stdout on first js: true
# spec
Capybara.server = :puma, { Silent: true }
config.include Devise::Test::ControllerHelpers, type: :controller
config.include Devise::Test::IntegrationHelpers, type: :request
end

46
spec/requests/users/passwords_controller_spec.rb

@ -0,0 +1,46 @@
require "rails_helper"
require_relative "../../support/devise"
RSpec.describe Users::PasswordsController, type: :request do
let(:params) { { user: { email: email } } }
context "when a password reset is requested for a valid email" do
let(:user) { FactoryBot.create(:user) }
let(:email) { user.email }
it "redirects to the email sent page anyway" do
post "/users/password", params: params
expect(response).to have_http_status(:redirect)
follow_redirect!
expect(response.body).to match(/Check your email/)
end
end
context "when a password reset is requested with an email that doesn't exist in the system" do
before do
allow_any_instance_of(Users::PasswordsController).to receive(:is_navigational_format?).and_return(false)
end
let(:email) { "madeup_email@test.com" }
it "redirects to the email sent page anyway" do
post "/users/password", params: params
expect(response).to have_http_status(:redirect)
follow_redirect!
expect(response.body).to match(/Check your email/)
end
end
context "when a password reset is requested the email" do
let(:user) { FactoryBot.create(:user) }
let(:email) { user.email }
it "should contain the correct email" do
post "/users/password", params: params
follow_redirect!
email_ascii_content = ActionMailer::Base.deliveries.last.body.raw_source
email_content = email_ascii_content.encode("ASCII", "UTF-8", undef: :replace)
expect(email_content).to match(email)
end
end
end

16
spec/support/controller_macros.rb

@ -0,0 +1,16 @@
module ControllerMacros
# def login_admin
# before(:each) do
# @request.env["devise.mapping"] = Devise.mappings[:admin]
# sign_in FactoryBot.create(:admin) # Using factory bot as an example
# end
# end
def login_user
before(:each) do
@request.env["devise.mapping"] = Devise.mappings[:user]
user = FactoryBot.create(:user)
sign_in user
end
end
end

6
spec/support/devise.rb

@ -0,0 +1,6 @@
require_relative "./controller_macros"
RSpec.configure do |config|
config.include Devise::Test::ControllerHelpers, type: :controller
config.extend ControllerMacros, type: :controller
end
Loading…
Cancel
Save