Overview
The Inspection model represents a fire protection system inspection conducted at a property. It manages the inspection workflow, associated forms, and deficiency tracking.
Database Schema
Attributes
Date when the inspection was/will be conductedIndexed: For efficient date-based queriesValidation: Must be present
Foreign key to the property being inspectedIndexed: For efficient property lookups and composite index with dateValidation: Must be present
Foreign key to the main form template used for this inspection
Foreign key to the user (inspector) conducting the inspection
Additional notes or comments about the inspection
Current status of the inspectionIndexed: For filtering inspections by statusCommon values: “pending”, “in_progress”, “completed”
Category of the fire protection system being inspected (e.g., “Sprinkler”, “Standpipe”)
Inspection interval category (e.g., “Monthly”, “Quarterly”, “Annual”)
Job number or identifier for this inspection
Timestamp when the inspection was created
Timestamp when the inspection was last updated
Associations
Belongs To
The property where the inspection is conductedinspection = Inspection.find(1)
inspection.property # => #<Property...>
inspection.property_address # => "123 Main St, City, State"
The main form template for this inspectioninspection = Inspection.find(1)
inspection.form_template # => #<FormTemplate...>
The inspector assigned to this inspectioninspection = Inspection.find(1)
inspection.user # => #<User...>
Has Many
All form fills associated with this inspectionDependent: destroy - Deletes all form fills when inspection is deletedinspection = Inspection.find(1)
inspection.form_fills # => [#<FormFill...>, #<FormFill...>]
Delegations
Delegates to the property’s customerinspection = Inspection.find(1)
inspection.customer # => #<Customer...>
Validations
validates :date, presence: true
validates :property_id, presence: true
Scopes
by_customer
Filters inspections by customer through the property association.Parameters:
customer (Customer) - The customer to filter by
Example:customer = Customer.find(1)
inspections = Inspection.by_customer(customer)
# => [#<Inspection...>, ...]
by_date_range
by_date_range(start_date, end_date)
Filters inspections within a date range.Parameters:
start_date (Date) - Start of the date rangeend_date (Date) - End of the date range
Example:inspections = Inspection.by_date_range(
Date.parse("2024-01-01"),
Date.parse("2024-01-31")
)
# => [#<Inspection...>, ...]
recent
Orders inspections by date in descending order (most recent first).Example:recent_inspections = Inspection.recent.limit(10)
# => [#<Inspection...>, ...]
Callbacks
After Update
trigger_deficiency_transfer
Automatically triggers deficiency transfer when inspection is marked as completed.Trigger: After update, when status changes to ‘completed’Implementation:after_update :trigger_deficiency_transfer,
if: -> { saved_change_to_status? && status == 'completed' }
TransferDeficienciesJob to process deficiencies asynchronouslyExample:inspection = Inspection.find(1)
inspection.update!(status: 'completed')
# TransferDeficienciesJob is automatically enqueued
Public Methods
customer_name
Returns the name of the customer associated with this inspection.Returns: StringExample:inspection = Inspection.find(1)
inspection.customer_name # => "ABC Corporation"
def customer_name
property.customer.name
end
property_address
Returns the address of the property being inspected.Returns: StringExample:inspection = Inspection.find(1)
inspection.property_address # => "123 Main St, Springfield, IL 62701"
def property_address
property.address
end
Usage Examples
Creating a New Inspection
inspection = Inspection.create!(
date: Date.today,
property: Property.find(1),
form_template: FormTemplate.find(1),
user: User.find(1),
status: "pending",
system_category: "Fire Sprinkler",
interval_category: "Monthly",
job: "JOB-2024-001",
notes: "Regular monthly inspection"
)
Querying Inspections
# Get recent inspections
recent = Inspection.recent.limit(10)
# Get inspections for a specific customer
customer = Customer.find(1)
customer_inspections = Inspection.by_customer(customer)
# Get inspections in a date range
january_inspections = Inspection.by_date_range(
Date.parse("2024-01-01"),
Date.parse("2024-01-31")
)
# Combine scopes
completed_this_month = Inspection
.where(status: "completed")
.by_date_range(Date.today.beginning_of_month, Date.today.end_of_month)
.recent
inspection = Inspection.find(1)
# Access property and customer information
puts "Customer: #{inspection.customer_name}"
puts "Address: #{inspection.property_address}"
puts "Inspector: #{inspection.user.name}"
# Access form fills
inspection.form_fills.each do |form_fill|
puts "Form: #{form_fill.name}"
puts "Status: #{form_fill.pdf_generation_status}"
end
# Get the main form template
template = inspection.form_template
puts "Using template: #{template.name}"
Completing an Inspection
inspection = Inspection.find(1)
# Update status to completed
inspection.update!(status: "completed")
# The after_update callback automatically triggers deficiency transfer
# TransferDeficienciesJob.perform_later(inspection.id) is called
# Check if completed
inspection.reload
puts "Status: #{inspection.status}" # => "completed"
inspection = Inspection.create!(
date: Date.today,
property: property,
form_template: main_template,
user: inspector,
status: "pending"
)
# Create main form fill
main_form = FormFill.create!(
name: "Main Inspection Form",
form_template: main_template,
inspection: inspection
)
# Create additional form fills
additional_template = FormTemplate.find_by(name: "Additional Checklist")
additional_form = FormFill.create!(
name: "Additional Checklist",
form_template: additional_template,
inspection: inspection
)
# Access all forms
inspection.form_fills.count # => 2
Filtering and Reporting
# Get all pending inspections for a user
inspector = User.find(1)
pending_inspections = Inspection
.where(user: inspector, status: "pending")
.recent
# Get inspections by system category
sprinkler_inspections = Inspection
.where(system_category: "Fire Sprinkler")
.by_date_range(1.year.ago, Date.today)
# Count inspections by status
status_counts = Inspection
.group(:status)
.count
# => { "pending" => 5, "completed" => 15, "in_progress" => 3 }
Database Indexes
The Inspection model uses several indexes for optimal query performance:
# Single column indexes
index ["date"]
index ["status"]
index ["form_template_id"]
index ["property_id"]
index ["user_id"]
# Composite index
index ["property_id", "date"]
- FormFill - Form fills associated with this inspection
- FormTemplate - The template used for this inspection
- Property - The property being inspected
- User - The inspector conducting the inspection
- Customer (via Property) - The customer who owns the property