discourse/migrations/lib/database/intermediate_db/log_entry.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

30 lines
793 B
Ruby
Vendored

# frozen_string_literal: true
module Migrations
module Database
module IntermediateDB
module LogEntry
INFO = "info"
WARNING = "warning"
ERROR = "error"
SQL = <<~SQL
INSERT INTO log_entries (created_at, type, message, exception, details)
VALUES (?, ?, ?, ?, ?)
SQL
private_constant :SQL
def self.create(created_at: Time.now, type:, message:, exception: nil, details: nil)
Migrations::Database::IntermediateDB.insert(
SQL,
Migrations::Database.format_datetime(created_at),
type,
message,
exception&.full_message(highlight: false),
Migrations::Database.to_json(details),
)
end
end
end
end
end