discourse/migrations/lib/cli/exception_handler.rb
Gerhard Schlager 89f26da39d
MT: Switch to nested module style across migrations/ (#38564)
Ruby's compact module syntax (`module
Migrations::Database::Schema::DSL`) breaks lexical constant lookup —
`Module.nesting` only includes the innermost constant, so every
cross-module reference must be fully qualified. In practice this means
writing `Migrations::Database::Schema::Helpers` even when you're already
inside `Migrations::Database::Schema`.

Nested module definitions restore the full nesting chain, which brings
several practical benefits:

- **Less verbose code**: references like `Schema::Helpers`,
`Database::IntermediateDB`, or `Converters::Base::ProgressStep` work
without repeating the full path from root
- **Easier to write new code**: contributors don't need to remember
which prefixes are required — if you're inside the namespace, short
names just work
- **Fewer aliasing workarounds**: removes the need for constants like
`MappingType = Migrations::Importer::MappingType` that existed solely to
shorten references
- **Standard Ruby style**: consistent with how most Ruby projects and
gems structure their namespaces

The diff is large but mechanical — no logic changes, just module
wrapping and shortening references that the nesting now resolves.
Generated code (intermediate_db models/enums) keeps fully qualified
references like `Migrations::Database.format_*` since it must work
regardless of the configured output namespace.

- Convert 138 lib files from compact to nested module definitions
- Remove now-redundant fully qualified prefixes and aliases
- Update model and enum writers to generate nested modules with correct
indentation
- Regenerate all intermediate_db models and enums
2026-03-19 18:15:19 +01:00

40 lines
1.2 KiB
Ruby

# frozen_string_literal: true
module Migrations
module CLI
class ExceptionHandler
def self.handle_and_exit(&block)
block.call
rescue ClassFilter::UnknownClassNamesError => e
handle_unknown_class_names_error(e)
exit(1)
rescue Database::Schema::ConfigError, Database::Schema::GenerationError => e
puts e.message.red
exit(1)
rescue => e
puts "An error occurred: #{e.message}".red
puts e.backtrace.join("\n")
exit(1)
end
private_class_method def self.handle_unknown_class_names_error(error)
all_suggestions_found = true
error.missing_names.each do |missing_name|
suggestions =
DidYouMean::SpellChecker.new(dictionary: error.available_names).correct(missing_name)
puts "Unknown step '#{missing_name}'".red
if suggestions.any?
puts "Did you mean: #{suggestions.join(", ")}".yellow
else
all_suggestions_found = false
end
end
if !all_suggestions_found
puts "Available steps are: ".yellow + error.available_names.join(", ")
end
end
end
end
end