mirror of
https://gh.wpcy.net/https://github.com/discourse/discourse.git
synced 2026-05-01 20:33:14 +08:00
89f26da39d
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
43 lines
1.2 KiB
Ruby
43 lines
1.2 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
module Migrations
|
|
# Module that adds enumeration functionality to modules that extend it.
|
|
# When extended, adds methods for checking and retrieving enum values.
|
|
#
|
|
# @example
|
|
# module MyEnum
|
|
# extend Migrations::Enum
|
|
#
|
|
# FIRST = 0
|
|
# SECOND = 1
|
|
# end
|
|
#
|
|
# @!method valid?(value)
|
|
# Checks if the provided value is a valid enum value
|
|
# @param value [Integer, String] The value to check
|
|
# @return [Boolean] true if the value is included in the enum values
|
|
#
|
|
# @!method values
|
|
# Returns all values defined in the enum
|
|
# @return [Array<Integer, String>] Array of all enum values
|
|
module Enum
|
|
def self.extended(base)
|
|
TracePoint
|
|
.new(:end) do |tp|
|
|
if tp.self == base
|
|
enum_values =
|
|
base.constants.map { |c| base.const_get(c) }.select { |v| !v.is_a?(Module) }.freeze
|
|
|
|
values = base.const_set(:ALL_ENUM_VALUES__, enum_values)
|
|
base.private_constant :ALL_ENUM_VALUES__
|
|
|
|
base.define_singleton_method(:valid?) { |value| values.include?(value) }
|
|
base.define_singleton_method(:values) { values }
|
|
|
|
tp.disable
|
|
end
|
|
end
|
|
.enable
|
|
end
|
|
end
|
|
end
|
