Browse Source
* Add openai gem * Add validation table and model * Add describe_lettings_validations task * lint * Add describe_soft_lettings_validations task * Add describe_bu_lettings_validations task * Add add_numeric_lettings_validations task * Rename * Add sales tasks for generating validations docs * Add rails admin * refactor * Rename validation table * Rename validation_methods variable (?) * Move tests * lint * Add back fonts * Add method_source gem * Generate numeric validations for both log typespull/2454/head v0.4.47
kosiakkatrina
7 months ago
committed by
GitHub
21 changed files with 1138 additions and 3 deletions
@ -0,0 +1,2 @@
|
||||
$fa-font-path: "."; |
||||
@import "rails_admin/src/rails_admin/styles/base"; |
||||
@ -0,0 +1 @@
|
||||
import 'rails_admin/src/rails_admin/base' |
||||
@ -0,0 +1,2 @@
|
||||
class LogValidation < ApplicationRecord |
||||
end |
||||
@ -0,0 +1,371 @@
|
||||
class DocumentationGenerator |
||||
include Validations::Sales::SetupValidations |
||||
include Validations::Sales::HouseholdValidations |
||||
include Validations::Sales::PropertyValidations |
||||
include Validations::Sales::FinancialValidations |
||||
include Validations::Sales::SaleInformationValidations |
||||
include Validations::SharedValidations |
||||
include Validations::LocalAuthorityValidations |
||||
include Validations::SoftValidations |
||||
include Validations::Sales::SoftValidations |
||||
|
||||
def describe_hard_validations(client, all_validation_methods, all_helper_methods, log_type) |
||||
form = FormHandler.instance.forms["current_#{log_type}"] |
||||
|
||||
all_validation_methods.each do |meth| |
||||
if LogValidation.where(validation_name: meth.to_s, bulk_upload_specific: false, log_type:).exists? |
||||
Rails.logger.info("Validation #{meth} already exists") |
||||
next |
||||
end |
||||
|
||||
validation_source = method(meth).source |
||||
helper_methods_source = all_helper_methods.map { |helper_method| |
||||
if validation_source.include?(helper_method.to_s) |
||||
method(helper_method).source |
||||
end |
||||
}.compact.join("\n") |
||||
|
||||
response = describe_hard_validation(client, meth, validation_source, helper_methods_source, form) |
||||
next unless response |
||||
|
||||
begin |
||||
result = JSON.parse(response.dig("choices", 0, "message", "tool_calls", 0, "function", "arguments")) |
||||
|
||||
save_hard_validation(result, meth, form, log_type) |
||||
rescue StandardError => e |
||||
Rails.logger.error("Failed to save #{meth} for #{form.start_date.year}") |
||||
Rails.logger.error("Error #{e.message}") |
||||
end |
||||
end |
||||
end |
||||
|
||||
def describe_bu_validations(client, form, row_parser_class, all_validation_methods, all_helper_methods, field_mapping_for_errors, log_type) |
||||
all_validation_methods.each do |meth| |
||||
if LogValidation.where(validation_name: meth.to_s, bulk_upload_specific: true, from: form.start_date, log_type:).exists? |
||||
Rails.logger.info("Validation #{meth} already exists for #{form.start_date.year}") |
||||
next |
||||
end |
||||
|
||||
validation_source = row_parser_class.instance_method(meth).source |
||||
helper_methods_source = all_helper_methods.map { |helper_method| |
||||
if validation_source.include?(helper_method.to_s) |
||||
row_parser_class.instance_method(helper_method).source |
||||
end |
||||
}.compact.join("\n") |
||||
|
||||
response = describe_hard_validation(client, meth, validation_source, helper_methods_source, form) |
||||
next unless response |
||||
|
||||
begin |
||||
result = JSON.parse(response.dig("choices", 0, "message", "tool_calls", 0, "function", "arguments")) |
||||
|
||||
save_bu_validation(result, meth, form, log_type, field_mapping_for_errors) |
||||
rescue StandardError => e |
||||
Rails.logger.error("Failed to save #{meth} for #{form.start_date.year}") |
||||
Rails.logger.error("Error #{e.message}") |
||||
end |
||||
end |
||||
end |
||||
|
||||
def describe_soft_validations(client, all_validation_methods, all_helper_methods, log_type) |
||||
validation_descriptions = {} |
||||
all_validation_methods.each do |meth| |
||||
validation_source = method(meth).source |
||||
helper_methods_source = all_helper_methods.map { |helper_method| |
||||
if validation_source.include?(helper_method.to_s) |
||||
method(helper_method).source |
||||
end |
||||
}.compact.join("\n") |
||||
|
||||
response = soft_validation_description(client, meth, validation_source, helper_methods_source) |
||||
next unless response |
||||
|
||||
result = JSON.parse(response.dig("choices", 0, "message", "tool_calls", 0, "function", "arguments")) |
||||
|
||||
validation_descriptions[meth.to_s] = result |
||||
end |
||||
|
||||
current_form = FormHandler.instance.forms["current_#{log_type}"] |
||||
previous_form = FormHandler.instance.forms["previous_#{log_type}"] |
||||
|
||||
[current_form, previous_form].each do |form| |
||||
interruption_screen_pages = form.pages.select { |page| page.questions.first.type == "interruption_screen" } |
||||
interruption_screen_pages_grouped_by_question = interruption_screen_pages.group_by { |page| page.questions.first.id } |
||||
interruption_screen_pages_grouped_by_question.each do |_question_id, pages| |
||||
pages.map do |page| |
||||
save_soft_validation(form, page, validation_descriptions, log_type) |
||||
end |
||||
end |
||||
end |
||||
end |
||||
|
||||
private |
||||
|
||||
def describe_hard_validation(client, meth, validation_source, helper_methods_source, form) |
||||
en_yml = File.read("./config/locales/en.yml") |
||||
|
||||
begin |
||||
client.chat( |
||||
parameters: { |
||||
model: "gpt-3.5-turbo", |
||||
messages: [ |
||||
{ |
||||
role: "system", |
||||
content: "You write amazing documentation, as a senior technical writer. Your audience is non-technical team members. You have been asked to document the validations in a Rails application. The application collects social housing data for different collection years. There are validations on different fields, sometimes the validations depend on several fields. |
||||
Describe what given validation does, be very explicit about all the different validation cases (be specific about the years for which these validations would run, which values would be invalid or which values are required, look at private helper methods to understand what is being checked in more detail). Quote the error messages that would be added in each case exactly. Here is the translation file for validation messages: #{en_yml}. |
||||
You should create `create_documentation_for_given_validation` method. Call it once, and include the documentation for given validation.", |
||||
}, |
||||
{ |
||||
role: "user", |
||||
content: "Describe #{meth} validation in detail. Here is the content of the validation: |
||||
|
||||
#{validation_source} |
||||
Look at these helper methods where needed to understand what is being checked in more detail: #{helper_methods_source}", |
||||
}, |
||||
], |
||||
tools: [ |
||||
{ |
||||
type: "function", |
||||
function: { |
||||
name: "create_documentation_for_given_validation", |
||||
description: "Use this function to save the complete documentation, covering given validation in the provided code.", |
||||
parameters: { |
||||
type: :object, |
||||
properties: { |
||||
description: { |
||||
type: :string, |
||||
description: "A human-readbale description of the validation", |
||||
}, |
||||
cases: { |
||||
type: :array, |
||||
description: "A list of cases that this validation triggers on, each with specific details", |
||||
items: { |
||||
type: :object, |
||||
description: "Information about a single case that triggers this validation", |
||||
properties: { |
||||
case_description: { |
||||
type: :string, |
||||
description: "A human-readable description of the case in which this validation triggers", |
||||
}, |
||||
errors: { |
||||
type: :array, |
||||
description: "The error messages that would be added if this case triggers the validation", |
||||
items: { |
||||
type: :object, |
||||
description: "Information about a single error message for a specific field", |
||||
properties: { |
||||
error_message: { |
||||
type: :string, |
||||
description: "A single error message", |
||||
}, |
||||
field: { |
||||
type: :string, |
||||
description: "The field that the error message would be added to.", |
||||
}, |
||||
}, |
||||
required: %w[error_message field], |
||||
}, |
||||
}, |
||||
from: { |
||||
type: :number, |
||||
description: "the year from which the validation starts. If this validation runs for logs with a startdate after a certain year, specify that year here, only if it is not specified in the validation method, leave this field blank", |
||||
}, |
||||
to: { |
||||
type: :number, |
||||
description: "the year in which the validation ends. If this validation runs for logs with a startdate before a certain year, specify that year here, only if it is not specified in the validation method, leave this field blank", |
||||
}, |
||||
validation_type: { |
||||
type: :string, |
||||
enum: %w[presence format minimum maximum range inclusion length other], |
||||
description: "The type of validation that is being performed. This should be one of the following: presence (validates that the question is answered), format (validates that the answer format is valid), minimum (validates that entered value is more than minimum allowed value), maximum (validates that entered value is less than maximum allowed value), range (values must be between two values), inclusion (validates that the values that are not allowed arent selected), length (validates the length of the answer), other", |
||||
}, |
||||
other_validated_models: { |
||||
type: :string, |
||||
description: "Comma separated list of any other models (other than log) that were used in this validation. These are possible models (only add a value to this field if other validation models are one of these models): User, Organisation, Scheme, Location, Organisation_relationship, LaRentRange. Only leave this blank if no other models were used in this validation.", |
||||
}, |
||||
}, |
||||
required: %w[case_description errors validation_type other_validated_models], |
||||
}, |
||||
}, |
||||
}, |
||||
required: %w[description cases], |
||||
}, |
||||
}, |
||||
}, |
||||
], |
||||
tool_choice: { type: "function", function: { name: "create_documentation_for_given_validation" } }, |
||||
}, |
||||
) |
||||
rescue StandardError => e |
||||
Rails.logger.error("Failed to describe #{meth} for #{form.start_date.year}") |
||||
Rails.logger.error("Error #{e.message}") |
||||
sleep(15) |
||||
false |
||||
end |
||||
end |
||||
|
||||
def soft_validation_description(client, meth, validation_source, helper_methods_source) |
||||
client.chat( |
||||
parameters: { |
||||
model: "gpt-3.5-turbo", |
||||
messages: [ |
||||
{ |
||||
role: "system", |
||||
content: "You write amazing documentation, as a senior technical writer. Your audience is non-technical team members. You have been asked to document the validations in a Rails application. The application collects social housing data for different collection years. There are validations on different fields, sometimes the validations depend on several fields. |
||||
You are given a method that contains a validation. Describe what given method does, be very explicit about all the different validation cases (be specific about the years for which these validations would run, which values would be invalid or which values are required, look at private helper methods to understand what is being checked in more detail). |
||||
You should create `create_documentation_for_given_validation` method. Call it once, and include the documentation for given validation.", |
||||
}, |
||||
{ |
||||
role: "user", |
||||
content: "Describe #{meth} validation in detail. Here is the content of the validation: |
||||
|
||||
#{validation_source} |
||||
Look at these helper methods where needed to understand what is being checked in more detail: #{helper_methods_source}", |
||||
}, |
||||
], |
||||
tools: [ |
||||
{ |
||||
type: "function", |
||||
function: { |
||||
name: "create_documentation_for_given_validation", |
||||
description: "Use this function to save the complete documentation, covering given validation in the provided code.", |
||||
parameters: { |
||||
type: :object, |
||||
properties: { |
||||
description: { |
||||
type: :string, |
||||
description: "A human-readbale description of the validation", |
||||
}, |
||||
validation_type: { |
||||
type: :string, |
||||
enum: %w[presence format minimum maximum range inclusion length other], |
||||
description: "The type of validation that is being performed. This should be one of the following: presence (validates that the question is answered), format (validates that the answer format is valid), minimum (validates that entered value is more than minimum allowed value), maximum (validates that entered value is less than maximum allowed value), range (values must be between two values), inclusion (validates that the values that are not allowed arent selected), length (validates the length of the answer), other", |
||||
}, |
||||
other_validated_models: { |
||||
type: :string, |
||||
description: "Comma separated list of any other models (other than log) that were used in this validation. These are possible models (only add a value to this field if other validation models are one of these models): User, Organisation, Scheme, Location, Organisation_relationship, LaRentRange. Only leave this blank if no other models were used in this validation.", |
||||
}, |
||||
}, |
||||
required: %w[description validation_type other_validated_models], |
||||
}, |
||||
}, |
||||
}, |
||||
], |
||||
tool_choice: { type: "function", function: { name: "create_documentation_for_given_validation" } }, |
||||
}, |
||||
) |
||||
rescue StandardError => e |
||||
Rails.logger.error("Failed to describe #{meth}") |
||||
Rails.logger.error("Error #{e.message}") |
||||
sleep(15) |
||||
false |
||||
end |
||||
|
||||
def save_hard_validation(result, meth, form, log_type) |
||||
result["cases"].each do |case_info| |
||||
case_info["errors"].each do |error| |
||||
LogValidation.create!(log_type:, |
||||
validation_name: meth.to_s, |
||||
description: result["description"], |
||||
field: error["field"], |
||||
error_message: error["error_message"], |
||||
case: case_info["case_description"], |
||||
section: form.get_question(error["field"], nil)&.subsection&.id, |
||||
from: case_info["from"] || "", |
||||
to: case_info["to"] || "", |
||||
validation_type: case_info["validation_type"], |
||||
hard_soft: "hard", |
||||
other_validated_models: case_info["other_validated_models"]) |
||||
end |
||||
end |
||||
|
||||
Rails.logger.info("******** described #{meth} ********") |
||||
end |
||||
|
||||
def save_bu_validation(result, meth, form, log_type, field_mapping_for_errors) |
||||
result["cases"].each do |case_info| |
||||
case_info["errors"].each do |error| |
||||
error_fields = field_mapping_for_errors.select { |_key, values| values.include?(error["field"].to_sym) }.keys |
||||
error_fields = [error["field"]] if error_fields.empty? |
||||
error_fields.each do |error_field| |
||||
LogValidation.create!(log_type:, |
||||
validation_name: meth.to_s, |
||||
description: result["description"], |
||||
field: error_field, |
||||
error_message: error["error_message"], |
||||
case: case_info["case_description"], |
||||
section: form.get_question(error_field, nil)&.subsection&.id, |
||||
from: form.start_date, |
||||
to: form.start_date + 1.year, |
||||
validation_type: case_info["validation_type"], |
||||
hard_soft: "hard", |
||||
other_validated_models: case_info["other_validated_models"], |
||||
bulk_upload_specific: true) |
||||
end |
||||
end |
||||
end |
||||
|
||||
Rails.logger.info("******** described #{meth} for #{form.start_date.year} ********") |
||||
end |
||||
|
||||
def save_soft_validation(form, page, validation_descriptions, log_type) |
||||
subsection_pages = form.subsection_for_page(page).pages |
||||
page_index = subsection_pages.index(page) |
||||
page_the_validation_applied_to = subsection_pages[page_index - 1] |
||||
|
||||
loop do |
||||
break unless page_the_validation_applied_to.questions.first.type == "interruption_screen" |
||||
|
||||
page_index -= 1 |
||||
page_the_validation_applied_to = subsection_pages[page_index - 1] |
||||
end |
||||
|
||||
validation_depends_on_hash = page.depends_on.each_with_object({}) do |depends_on, result| |
||||
depends_on.each do |key, value| |
||||
if validation_descriptions.include?(key) |
||||
result[key] = value |
||||
end |
||||
end |
||||
end |
||||
|
||||
if validation_depends_on_hash.empty? |
||||
Rails.logger.error("No validation description found for #{page.questions.first.id}") |
||||
return |
||||
end |
||||
|
||||
if LogValidation.where(validation_name: validation_depends_on_hash.keys.first, field: page_the_validation_applied_to.questions.first.id, from: form.start_date, log_type:).exists? |
||||
Rails.logger.info("Validation #{validation_depends_on_hash.keys.first} already exists for #{page_the_validation_applied_to.questions.first.id} for start year #{form.start_date.year}") |
||||
return |
||||
end |
||||
|
||||
result = validation_descriptions[validation_depends_on_hash.keys.first] |
||||
|
||||
informative_text = page.informative_text |
||||
if informative_text.present? && !(informative_text.is_a? String) |
||||
informative_text = I18n.t(page.informative_text["translation"]) |
||||
end |
||||
|
||||
title_text = page.title_text |
||||
if title_text.present? && !(title_text.is_a? String) |
||||
title_text = I18n.t(page.title_text["translation"]) |
||||
end |
||||
|
||||
error_message = [title_text, informative_text, page.questions.first.hint_text].compact.join("\n") |
||||
|
||||
case_info = page.depends_on.first.values.first ? "Provided values fulfill the description" : "Provided values do not fulfill the description" |
||||
LogValidation.create!(log_type:, |
||||
validation_name: validation_depends_on_hash.keys.first.to_s, |
||||
description: result["description"], |
||||
field: page_the_validation_applied_to.questions.first.id, |
||||
error_message:, |
||||
case: case_info, |
||||
section: form.get_question(page_the_validation_applied_to.questions.first.id, nil)&.subsection&.id, |
||||
from: form.start_date, |
||||
to: form.start_date + 1.year, |
||||
validation_type: result["validation_type"], |
||||
hard_soft: "soft", |
||||
other_validated_models: result["other_validated_models"]) |
||||
|
||||
Rails.logger.info("******** described #{validation_depends_on_hash.keys.first} for #{page_the_validation_applied_to.questions.first.id} ********") |
||||
end |
||||
end |
||||
@ -0,0 +1 @@
|
||||
Rails.application.config.assets.paths << Rails.root.join("node_modules/@fortawesome/fontawesome-free/webfonts") |
||||
@ -0,0 +1,46 @@
|
||||
RailsAdmin.config do |config| |
||||
config.asset_source = :webpack |
||||
|
||||
### Popular gems integration |
||||
|
||||
## == Devise == |
||||
config.authenticate_with do |
||||
warden.authenticate! scope: :user |
||||
end |
||||
config.current_user_method(&:current_user) |
||||
|
||||
config.authorize_with do |
||||
redirect_to main_app.root_path unless current_user&.support? |
||||
end |
||||
## == CancanCan == |
||||
# config.authorize_with :cancancan |
||||
|
||||
## == Pundit == |
||||
# config.authorize_with :pundit |
||||
|
||||
## == PaperTrail == |
||||
# config.audit_with :paper_trail, 'User', 'PaperTrail::Version' # PaperTrail >= 3.0.0 |
||||
|
||||
### More at https://github.com/railsadminteam/rails_admin/wiki/Base-configuration |
||||
|
||||
## == Gravatar integration == |
||||
## To disable Gravatar integration in Navigation Bar set to false |
||||
# config.show_gravatar = true |
||||
config.included_models = %w[LogValidation] |
||||
|
||||
config.actions do |
||||
dashboard # mandatory |
||||
index # mandatory |
||||
new |
||||
export |
||||
bulk_delete |
||||
show |
||||
edit |
||||
delete |
||||
show_in_app |
||||
|
||||
## With an audit adapter, you can add: |
||||
# history_index |
||||
# history_show |
||||
end |
||||
end |
||||
@ -0,0 +1,20 @@
|
||||
class AddValidationsTable < ActiveRecord::Migration[7.0] |
||||
def change |
||||
create_table :validations do |t| |
||||
t.column :log_type, :string |
||||
t.column :section, :string |
||||
t.column :validation_name, :string |
||||
t.column :description, :string |
||||
t.column :case, :string |
||||
t.column :field, :string |
||||
t.column :error_message, :string |
||||
t.column :from, :datetime |
||||
t.column :to, :datetime |
||||
t.column :validation_type, :string |
||||
t.column :hard_soft, :string |
||||
t.column :bulk_upload_specific, :boolean, default: false |
||||
t.column :other_validated_models, :string |
||||
t.timestamps |
||||
end |
||||
end |
||||
end |
||||
@ -0,0 +1,5 @@
|
||||
class RenameValidationsTable < ActiveRecord::Migration[7.0] |
||||
def change |
||||
rename_table :validations, :log_validations |
||||
end |
||||
end |
||||
@ -0,0 +1,90 @@
|
||||
namespace :generate_lettings_documentation do |
||||
desc "Generate documentation for hard lettings validations" |
||||
task describe_lettings_validations: :environment do |
||||
client = OpenAI::Client.new(access_token: ENV["OPENAI_API_KEY"]) |
||||
include Validations::SetupValidations |
||||
include Validations::HouseholdValidations |
||||
include Validations::PropertyValidations |
||||
include Validations::FinancialValidations |
||||
include Validations::TenancyValidations |
||||
include Validations::DateValidations |
||||
include Validations::LocalAuthorityValidations |
||||
all_validation_methods = public_methods.select { |method| method.starts_with?("validate_") } |
||||
all_methods = [Validations::SetupValidations, |
||||
Validations::HouseholdValidations, |
||||
Validations::PropertyValidations, |
||||
Validations::FinancialValidations, |
||||
Validations::TenancyValidations, |
||||
Validations::DateValidations, |
||||
Validations::LocalAuthorityValidations].map { |x| x.instance_methods + x.private_instance_methods }.flatten |
||||
all_helper_methods = all_methods - all_validation_methods |
||||
|
||||
DocumentationGenerator.new.describe_hard_validations(client, all_validation_methods, all_helper_methods, "lettings") |
||||
end |
||||
|
||||
desc "Generate documentation for soft lettings validations" |
||||
task describe_soft_lettings_validations: :environment do |
||||
include Validations::SoftValidations |
||||
|
||||
client = OpenAI::Client.new(access_token: ENV["OPENAI_API_KEY"]) |
||||
|
||||
all_helper_methods = Validations::SoftValidations.private_instance_methods |
||||
all_validation_methods = Validations::SoftValidations.instance_methods |
||||
|
||||
DocumentationGenerator.new.describe_soft_validations(client, all_validation_methods, all_helper_methods, "lettings") |
||||
end |
||||
|
||||
desc "Generate documentation for hard bu lettings validations" |
||||
task describe_bu_lettings_validations: :environment do |
||||
client = OpenAI::Client.new(access_token: ENV["OPENAI_API_KEY"]) |
||||
|
||||
[[FormHandler.instance.forms[FormHandler.instance.form_name_from_start_year(2023, "lettings")], BulkUpload::Lettings::Year2023::RowParser], |
||||
[FormHandler.instance.forms[FormHandler.instance.form_name_from_start_year(2024, "lettings")], BulkUpload::Lettings::Year2024::RowParser]].each do |form, row_parser_class| |
||||
all_validation_methods = row_parser_class.private_instance_methods.select { |method| method.starts_with?("validate_") } |
||||
|
||||
all_helper_methods = row_parser_class.private_instance_methods(false) + row_parser_class.instance_methods(false) - all_validation_methods |
||||
|
||||
field_mapping_for_errors = row_parser_class.new.send("field_mapping_for_errors") |
||||
DocumentationGenerator.new.describe_bu_validations(client, form, row_parser_class, all_validation_methods, all_helper_methods, field_mapping_for_errors, "lettings") |
||||
end |
||||
end |
||||
|
||||
desc "Generate documentation for lettings numeric validations" |
||||
task add_numeric_lettings_validations: :environment do |
||||
form = FormHandler.instance.forms["current_lettings"] |
||||
|
||||
form.numeric_questions.each do |question| |
||||
next unless question.min || question.max |
||||
|
||||
field = question.id |
||||
min = [question.prefix, question.min].join("") if question.min |
||||
max = [question.prefix, question.max].join("") if question.max |
||||
|
||||
error_message = I18n.t("validations.numeric.above_min", field:, min:) |
||||
validation_name = "minimum" |
||||
validation_description = "Field value is lower than the minimum value" |
||||
|
||||
if min && max |
||||
validation_name = "range" |
||||
error_message = I18n.t("validations.numeric.within_range", field:, min:, max:) |
||||
validation_description = "Field value is lower than the minimum value or higher than the maximum value" |
||||
end |
||||
|
||||
if LogValidation.where(validation_name:, field:, log_type: "lettings").exists? |
||||
|
||||
Rails.logger.info("Validation #{validation_name} already exists for #{field}") |
||||
next |
||||
end |
||||
|
||||
LogValidation.create!(log_type: "lettings", |
||||
validation_name:, |
||||
description: validation_description, |
||||
field:, |
||||
error_message:, |
||||
case: validation_description, |
||||
section: form.get_question(field, nil)&.subsection&.id, |
||||
validation_type: validation_name, |
||||
hard_soft: "hard") |
||||
end |
||||
end |
||||
end |
||||
@ -0,0 +1,89 @@
|
||||
namespace :generate_sales_documentation do |
||||
desc "Generate documentation for hard sales validations" |
||||
task describe_sales_validations: :environment do |
||||
client = OpenAI::Client.new(access_token: ENV["OPENAI_API_KEY"]) |
||||
include Validations::Sales::SetupValidations |
||||
include Validations::Sales::HouseholdValidations |
||||
include Validations::Sales::PropertyValidations |
||||
include Validations::Sales::FinancialValidations |
||||
include Validations::Sales::SaleInformationValidations |
||||
include Validations::SharedValidations |
||||
include Validations::LocalAuthorityValidations |
||||
all_validation_methods = public_methods.select { |method| method.starts_with?("validate_") } |
||||
all_methods = [Validations::Sales::SetupValidations, |
||||
Validations::Sales::HouseholdValidations, |
||||
Validations::Sales::PropertyValidations, |
||||
Validations::Sales::FinancialValidations, |
||||
Validations::Sales::SaleInformationValidations, |
||||
Validations::SharedValidations, |
||||
Validations::LocalAuthorityValidations].map { |x| x.instance_methods + x.private_instance_methods }.flatten |
||||
|
||||
all_helper_methods = all_methods - all_validation_methods |
||||
|
||||
DocumentationGenerator.new.describe_hard_validations(client, all_validation_methods, all_helper_methods, "sales") |
||||
end |
||||
|
||||
desc "Generate documentation for soft sales validations" |
||||
task describe_soft_sales_validations: :environment do |
||||
include Validations::SoftValidations |
||||
include Validations::Sales::SoftValidations |
||||
|
||||
client = OpenAI::Client.new(access_token: ENV["OPENAI_API_KEY"]) |
||||
all_helper_methods = Validations::SoftValidations.private_instance_methods + Validations::Sales::SoftValidations.private_instance_methods |
||||
all_validation_methods = Validations::SoftValidations.instance_methods + Validations::Sales::SoftValidations.instance_methods |
||||
|
||||
DocumentationGenerator.new.describe_soft_validations(client, all_validation_methods, all_helper_methods, "sales") |
||||
end |
||||
|
||||
desc "Generate documentation for hard bu sales validations" |
||||
task describe_bu_sales_validations: :environment do |
||||
client = OpenAI::Client.new(access_token: ENV["OPENAI_API_KEY"]) |
||||
[[FormHandler.instance.forms[FormHandler.instance.form_name_from_start_year(2023, "sales")], BulkUpload::Sales::Year2023::RowParser], |
||||
[FormHandler.instance.forms[FormHandler.instance.form_name_from_start_year(2024, "sales")], BulkUpload::Sales::Year2024::RowParser]].each do |form, row_parser_class| |
||||
all_validation_methods = row_parser_class.private_instance_methods.select { |method| method.starts_with?("validate_") } |
||||
all_helper_methods = row_parser_class.private_instance_methods(false) + row_parser_class.instance_methods(false) - all_validation_methods |
||||
field_mapping_for_errors = row_parser_class.new.send("field_mapping_for_errors") |
||||
|
||||
DocumentationGenerator.new.describe_bu_validations(client, form, row_parser_class, all_validation_methods, all_helper_methods, field_mapping_for_errors, "sales") |
||||
end |
||||
end |
||||
|
||||
desc "Generate documentation for sales numeric validations" |
||||
task add_numeric_sales_validations: :environment do |
||||
form = FormHandler.instance.forms["current_sales"] |
||||
|
||||
form.numeric_questions.each do |question| |
||||
next unless question.min || question.max |
||||
|
||||
field = question.id |
||||
min = [question.prefix, question.min].join("") if question.min |
||||
max = [question.prefix, question.max].join("") if question.max |
||||
|
||||
error_message = I18n.t("validations.numeric.above_min", field:, min:) |
||||
validation_name = "minimum" |
||||
validation_description = "Field value is lower than the minimum value" |
||||
|
||||
if min && max |
||||
validation_name = "range" |
||||
error_message = I18n.t("validations.numeric.within_range", field:, min:, max:) |
||||
validation_description = "Field value is lower than the minimum value or higher than the maximum value" |
||||
end |
||||
|
||||
if LogValidation.where(validation_name:, field:, log_type: "sales").exists? |
||||
|
||||
Rails.logger.info("Validation #{validation_name} already exists for #{field}") |
||||
next |
||||
end |
||||
|
||||
LogValidation.create!(log_type: "sales", |
||||
validation_name:, |
||||
description: validation_description, |
||||
field:, |
||||
error_message:, |
||||
case: validation_description, |
||||
section: form.get_question(field, nil)&.subsection&.id, |
||||
validation_type: validation_name, |
||||
hard_soft: "hard") |
||||
end |
||||
end |
||||
end |
||||
@ -0,0 +1,38 @@
|
||||
require "rails_helper" |
||||
require "rake" |
||||
|
||||
RSpec.describe "generate_lettings_documentation" do |
||||
describe ":add_numeric_lettings_validations", type: :task do |
||||
subject(:task) { Rake::Task["generate_lettings_documentation:add_numeric_lettings_validations"] } |
||||
|
||||
before do |
||||
Rake.application.rake_require("tasks/generate_lettings_documentation") |
||||
Rake::Task.define_task(:environment) |
||||
task.reenable |
||||
end |
||||
|
||||
context "when the rake task is run" do |
||||
it "creates new validation documentation records" do |
||||
expect { task.invoke }.to change(LogValidation, :count) |
||||
expect(LogValidation.where(validation_name: "minimum").count).to be_positive |
||||
expect(LogValidation.where(validation_name: "range").count).to be_positive |
||||
any_min_validation = LogValidation.where(validation_name: "minimum").first |
||||
expect(any_min_validation.description).to include("Field value is lower than the minimum value") |
||||
expect(any_min_validation.field).not_to be_empty |
||||
expect(any_min_validation.error_message).to include("must be at least") |
||||
expect(any_min_validation.case).to include("Field value is lower than the minimum value") |
||||
expect(any_min_validation.from).to be_nil |
||||
expect(any_min_validation.to).to be_nil |
||||
expect(any_min_validation.validation_type).to eq("minimum") |
||||
expect(any_min_validation.hard_soft).to eq("hard") |
||||
expect(any_min_validation.other_validated_models).to be_nil |
||||
expect(any_min_validation.log_type).to eq("lettings") |
||||
end |
||||
|
||||
it "skips if the validation already exists in the database" do |
||||
task.invoke |
||||
expect { task.invoke }.not_to change(LogValidation, :count) |
||||
end |
||||
end |
||||
end |
||||
end |
||||
@ -0,0 +1,38 @@
|
||||
require "rails_helper" |
||||
require "rake" |
||||
|
||||
RSpec.describe "generate_sales_documentation" do |
||||
describe ":add_numeric_sales_validations", type: :task do |
||||
subject(:task) { Rake::Task["generate_sales_documentation:add_numeric_sales_validations"] } |
||||
|
||||
before do |
||||
Rake.application.rake_require("tasks/generate_sales_documentation") |
||||
Rake::Task.define_task(:environment) |
||||
task.reenable |
||||
end |
||||
|
||||
context "when the rake task is run" do |
||||
it "creates new validation documentation records" do |
||||
expect { task.invoke }.to change(LogValidation, :count) |
||||
expect(LogValidation.where(validation_name: "minimum").count).to be_positive |
||||
expect(LogValidation.where(validation_name: "range").count).to be_positive |
||||
any_min_validation = LogValidation.where(validation_name: "minimum").first |
||||
expect(any_min_validation.description).to include("Field value is lower than the minimum value") |
||||
expect(any_min_validation.field).not_to be_empty |
||||
expect(any_min_validation.error_message).to include("must be at least") |
||||
expect(any_min_validation.case).to include("Field value is lower than the minimum value") |
||||
expect(any_min_validation.from).to be_nil |
||||
expect(any_min_validation.to).to be_nil |
||||
expect(any_min_validation.validation_type).to eq("minimum") |
||||
expect(any_min_validation.hard_soft).to eq("hard") |
||||
expect(any_min_validation.other_validated_models).to be_nil |
||||
expect(any_min_validation.log_type).to eq("sales") |
||||
end |
||||
|
||||
it "skips if the validation already exists in the database" do |
||||
task.invoke |
||||
expect { task.invoke }.not_to change(LogValidation, :count) |
||||
end |
||||
end |
||||
end |
||||
end |
||||
@ -0,0 +1,46 @@
|
||||
require "rails_helper" |
||||
|
||||
RSpec.describe "RailsAdmin", type: :request do |
||||
let(:user) { create(:user) } |
||||
let(:support_user) { create(:user, :support) } |
||||
let(:page) { Capybara::Node::Simple.new(response.body) } |
||||
|
||||
before do |
||||
allow(support_user).to receive(:need_two_factor_authentication?).and_return(false) |
||||
end |
||||
|
||||
describe "GET /admin" do |
||||
context "when the user is not signed in" do |
||||
it "routes user to the sign in page" do |
||||
get rails_admin_path |
||||
follow_redirect! |
||||
expect(path).to eq("/account/sign-in") |
||||
expect(page).to have_content("Sign in to your account") |
||||
end |
||||
end |
||||
|
||||
context "when the user is signed in as a non support user" do |
||||
before do |
||||
sign_in user |
||||
end |
||||
|
||||
it "routes user to the home page" do |
||||
get rails_admin_path |
||||
follow_redirect! |
||||
expect(path).to eq("/") |
||||
expect(page).to have_content("Welcome back") |
||||
end |
||||
end |
||||
|
||||
context "when the user is signed in as a support user" do |
||||
before do |
||||
sign_in support_user |
||||
end |
||||
|
||||
it "routes user to the admin page" do |
||||
get rails_admin_path |
||||
expect(page).to have_content("Site Administration") |
||||
end |
||||
end |
||||
end |
||||
end |
||||
@ -0,0 +1,230 @@
|
||||
require "rails_helper" |
||||
|
||||
describe DocumentationGenerator do |
||||
let(:client) { instance_double(OpenAI::Client) } |
||||
let(:response) do |
||||
{ "choices" => [{ "message" => { "tool_calls" => [{ "function" => { "arguments" => |
||||
"{\n \"description\": \"Validates the format.\",\n \"cases\": [\n {\n \"case_description\": \"Previous postcode is known and current postcode is blank\",\n \"errors\": [\n {\n \"error_message\": \"Enter a valid postcode\",\n \"field\": \"ppostcode_full\"\n }\n ],\n \"validation_type\": \"format\",\n \"other_validated_models\": \"User\" }]\n}" } }] } }] } |
||||
end |
||||
let(:all_validation_methods) { %w[validate_numeric_min_max] } |
||||
let(:all_helper_methods) { [] } |
||||
let(:log_type) { "lettings" } |
||||
|
||||
before do |
||||
allow(client).to receive(:chat).and_return(response) |
||||
end |
||||
|
||||
describe ":describe_hard_validations" do |
||||
context "when the service is run with lettings type" do |
||||
let(:log_type) { "lettings" } |
||||
|
||||
it "creates new validation documentation records" do |
||||
expect(Rails.logger).to receive(:info).with(/described/).at_least(:once) |
||||
expect { described_class.new.describe_hard_validations(client, all_validation_methods, all_helper_methods, log_type) }.to change(LogValidation, :count) |
||||
expect(LogValidation.where(validation_name: "validate_numeric_min_max").count).to eq(1) |
||||
any_validation = LogValidation.first |
||||
expect(any_validation.description).to eq("Validates the format.") |
||||
expect(any_validation.field).to eq("ppostcode_full") |
||||
expect(any_validation.error_message).to eq("Enter a valid postcode") |
||||
expect(any_validation.case).to eq("Previous postcode is known and current postcode is blank") |
||||
expect(any_validation.from).to be_nil |
||||
expect(any_validation.to).to be_nil |
||||
expect(any_validation.validation_type).to eq("format") |
||||
expect(any_validation.hard_soft).to eq("hard") |
||||
expect(any_validation.other_validated_models).to eq("User") |
||||
expect(any_validation.log_type).to eq("lettings") |
||||
end |
||||
|
||||
it "calls the client" do |
||||
expect(client).to receive(:chat) |
||||
described_class.new.describe_hard_validations(client, all_validation_methods, all_helper_methods, log_type) |
||||
end |
||||
|
||||
it "skips if the validation already exists in the database" do |
||||
described_class.new.describe_hard_validations(client, all_validation_methods, all_helper_methods, log_type) |
||||
expect { described_class.new.describe_hard_validations(client, all_validation_methods, all_helper_methods, log_type) }.not_to change(LogValidation, :count) |
||||
end |
||||
|
||||
context "when the response is not a JSON" do |
||||
let(:response) { "not a JSON" } |
||||
|
||||
it "raises an error" do |
||||
expect(Rails.logger).to receive(:error).with(/Failed to save/).at_least(:once) |
||||
expect(Rails.logger).to receive(:error).with(/Error/).at_least(:once) |
||||
described_class.new.describe_hard_validations(client, all_validation_methods, all_helper_methods, log_type) |
||||
end |
||||
end |
||||
|
||||
context "when the response does not have expected fields" do |
||||
let(:response) { { "choices" => [{ "message" => { "tool_calls" => [{ "function" => { "arguments" => "{}" } }] } }] } } |
||||
|
||||
it "raises an error" do |
||||
expect(Rails.logger).to receive(:error).with(/Failed to save/).at_least(:once) |
||||
expect(Rails.logger).to receive(:error).with(/Error/).at_least(:once) |
||||
described_class.new.describe_hard_validations(client, all_validation_methods, all_helper_methods, log_type) |
||||
end |
||||
end |
||||
end |
||||
|
||||
context "when the service is run with sales type" do |
||||
let(:log_type) { "sales" } |
||||
|
||||
it "creates new validation documentation records" do |
||||
expect(Rails.logger).to receive(:info).with(/described/).at_least(:once) |
||||
expect { described_class.new.describe_hard_validations(client, all_validation_methods, all_helper_methods, log_type) }.to change(LogValidation, :count) |
||||
expect(LogValidation.where(validation_name: "validate_numeric_min_max").count).to eq(1) |
||||
any_validation = LogValidation.first |
||||
expect(any_validation.description).to eq("Validates the format.") |
||||
expect(any_validation.field).to eq("ppostcode_full") |
||||
expect(any_validation.error_message).to eq("Enter a valid postcode") |
||||
expect(any_validation.case).to eq("Previous postcode is known and current postcode is blank") |
||||
expect(any_validation.from).to be_nil |
||||
expect(any_validation.to).to be_nil |
||||
expect(any_validation.validation_type).to eq("format") |
||||
expect(any_validation.hard_soft).to eq("hard") |
||||
expect(any_validation.other_validated_models).to eq("User") |
||||
expect(any_validation.log_type).to eq("sales") |
||||
end |
||||
end |
||||
end |
||||
|
||||
describe ":describe_soft_validations" do |
||||
let(:all_validation_methods) { ["rent_in_soft_min_range?"] } |
||||
let(:response) do |
||||
{ "choices" => [{ "message" => { "tool_calls" => [{ "function" => { "arguments" => |
||||
"{\n \"description\": \"Validates the format.\",\n \"validation_type\": \"format\",\n \"other_validated_models\": \"User\"}" } }] } }] } |
||||
end |
||||
|
||||
context "when the service is run for lettings" do |
||||
let(:log_type) { "lettings" } |
||||
|
||||
it "creates new validation documentation records" do |
||||
expect { described_class.new.describe_soft_validations(client, all_validation_methods, all_helper_methods, log_type) }.to change(LogValidation, :count) |
||||
expect(LogValidation.where(validation_name: "rent_in_soft_min_range?").count).to be_positive |
||||
any_validation = LogValidation.first |
||||
expect(any_validation.description).to eq("Validates the format.") |
||||
expect(any_validation.field).not_to be_empty |
||||
expect(any_validation.error_message).not_to be_empty |
||||
expect(any_validation.case).to eq("Provided values fulfill the description") |
||||
expect(any_validation.from).not_to be_nil |
||||
expect(any_validation.to).not_to be_nil |
||||
expect(any_validation.validation_type).to eq("format") |
||||
expect(any_validation.hard_soft).to eq("soft") |
||||
expect(any_validation.other_validated_models).to eq("User") |
||||
expect(any_validation.log_type).to eq("lettings") |
||||
end |
||||
|
||||
it "calls the client" do |
||||
expect(client).to receive(:chat) |
||||
described_class.new.describe_soft_validations(client, all_validation_methods, all_helper_methods, log_type) |
||||
end |
||||
|
||||
it "skips if the validation already exists in the database" do |
||||
described_class.new.describe_soft_validations(client, all_validation_methods, all_helper_methods, log_type) |
||||
expect { described_class.new.describe_soft_validations(client, all_validation_methods, all_helper_methods, log_type) }.not_to change(LogValidation, :count) |
||||
end |
||||
end |
||||
|
||||
context "when the service is run for sales" do |
||||
let(:log_type) { "sales" } |
||||
let(:all_validation_methods) { ["income2_under_soft_min?"] } |
||||
|
||||
it "creates new validation documentation records" do |
||||
expect { described_class.new.describe_soft_validations(client, all_validation_methods, all_helper_methods, log_type) }.to change(LogValidation, :count) |
||||
expect(LogValidation.where(validation_name: "income2_under_soft_min?").count).to be_positive |
||||
any_validation = LogValidation.first |
||||
expect(any_validation.description).to eq("Validates the format.") |
||||
expect(any_validation.field).not_to be_empty |
||||
expect(any_validation.error_message).not_to be_empty |
||||
expect(any_validation.case).to eq("Provided values fulfill the description") |
||||
expect(any_validation.from).not_to be_nil |
||||
expect(any_validation.to).not_to be_nil |
||||
expect(any_validation.validation_type).to eq("format") |
||||
expect(any_validation.hard_soft).to eq("soft") |
||||
expect(any_validation.other_validated_models).to eq("User") |
||||
expect(any_validation.log_type).to eq("sales") |
||||
end |
||||
end |
||||
end |
||||
|
||||
describe ":describe_bu_validations", type: :task do |
||||
let(:all_validation_methods) { %w[validate_owning_org_data_given] } |
||||
let(:field_mapping_for_errors) { row_parser_class.new.send("field_mapping_for_errors") } |
||||
|
||||
context "when the service is run for lettings" do |
||||
let(:log_type) { "lettings" } |
||||
let(:form) { FormHandler.instance.forms[FormHandler.instance.form_name_from_start_year(2023, "lettings")] } |
||||
let(:row_parser_class) { BulkUpload::Lettings::Year2023::RowParser } |
||||
|
||||
it "creates new validation documentation records" do |
||||
expect(Rails.logger).to receive(:info).with(/described/).at_least(:once) |
||||
expect { described_class.new.describe_bu_validations(client, form, row_parser_class, all_validation_methods, all_helper_methods, field_mapping_for_errors, log_type) }.to change(LogValidation, :count) |
||||
expect(LogValidation.where(validation_name: "validate_owning_org_data_given").count).to eq(1) |
||||
any_validation = LogValidation.first |
||||
expect(any_validation.description).to eq("Validates the format.") |
||||
expect(any_validation.field).to eq("ppostcode_full") |
||||
expect(any_validation.error_message).to eq("Enter a valid postcode") |
||||
expect(any_validation.case).to eq("Previous postcode is known and current postcode is blank") |
||||
expect(any_validation.from).not_to be_nil |
||||
expect(any_validation.to).not_to be_nil |
||||
expect(any_validation.validation_type).to eq("format") |
||||
expect(any_validation.hard_soft).to eq("hard") |
||||
expect(any_validation.other_validated_models).to eq("User") |
||||
expect(any_validation.log_type).to eq("lettings") |
||||
end |
||||
|
||||
it "calls the client" do |
||||
expect(client).to receive(:chat) |
||||
described_class.new.describe_bu_validations(client, form, row_parser_class, all_validation_methods, all_helper_methods, field_mapping_for_errors, log_type) |
||||
end |
||||
|
||||
it "skips if the validation already exists in the database" do |
||||
described_class.new.describe_bu_validations(client, form, row_parser_class, all_validation_methods, all_helper_methods, field_mapping_for_errors, log_type) |
||||
expect { described_class.new.describe_bu_validations(client, form, row_parser_class, all_validation_methods, all_helper_methods, field_mapping_for_errors, log_type) }.not_to change(LogValidation, :count) |
||||
end |
||||
|
||||
context "when the response is not a JSON" do |
||||
let(:response) { "not a JSON" } |
||||
|
||||
it "raises an error" do |
||||
expect(Rails.logger).to receive(:error).with(/Failed to save/).at_least(:once) |
||||
expect(Rails.logger).to receive(:error).with(/Error/).at_least(:once) |
||||
described_class.new.describe_bu_validations(client, form, row_parser_class, all_validation_methods, all_helper_methods, field_mapping_for_errors, log_type) |
||||
end |
||||
end |
||||
|
||||
context "when the response does not have expected fields" do |
||||
let(:response) { { "choices" => [{ "message" => { "tool_calls" => [{ "function" => { "arguments" => "{}" } }] } }] } } |
||||
|
||||
it "raises an error" do |
||||
expect(Rails.logger).to receive(:error).with(/Failed to save/).at_least(:once) |
||||
expect(Rails.logger).to receive(:error).with(/Error/).at_least(:once) |
||||
described_class.new.describe_bu_validations(client, form, row_parser_class, all_validation_methods, all_helper_methods, field_mapping_for_errors, log_type) |
||||
end |
||||
end |
||||
end |
||||
|
||||
context "when the service is run for sales" do |
||||
let(:log_type) { "sales" } |
||||
let(:form) { FormHandler.instance.forms[FormHandler.instance.form_name_from_start_year(2023, "sales")] } |
||||
let(:row_parser_class) { BulkUpload::Sales::Year2023::RowParser } |
||||
|
||||
it "creates new validation documentation records" do |
||||
expect(Rails.logger).to receive(:info).with(/described/).at_least(:once) |
||||
expect { described_class.new.describe_bu_validations(client, form, row_parser_class, all_validation_methods, all_helper_methods, field_mapping_for_errors, log_type) }.to change(LogValidation, :count) |
||||
expect(LogValidation.where(validation_name: "validate_owning_org_data_given").count).to eq(1) |
||||
any_validation = LogValidation.first |
||||
expect(any_validation.description).to eq("Validates the format.") |
||||
expect(any_validation.field).to eq("ppostcode_full") |
||||
expect(any_validation.error_message).to eq("Enter a valid postcode") |
||||
expect(any_validation.case).to eq("Previous postcode is known and current postcode is blank") |
||||
expect(any_validation.from).not_to be_nil |
||||
expect(any_validation.to).not_to be_nil |
||||
expect(any_validation.validation_type).to eq("format") |
||||
expect(any_validation.hard_soft).to eq("hard") |
||||
expect(any_validation.other_validated_models).to eq("User") |
||||
expect(any_validation.log_type).to eq("sales") |
||||
end |
||||
end |
||||
end |
||||
end |
||||
Loading…
Reference in new issue