mirror of
https://github.com/rails/rails.git
synced 2022-11-09 12:12:34 -05:00
79ce7d9af6
I have so. many. regrets. about using `spec_name` for database configurations and now I'm finally putting this mistake to an end. Back when I started multi-db work I assumed that eventually `connection_specification_name` (sometimes called `spec_name`) and `spec_name` for configurations would one day be the same thing. After 2 years I no longer believe they will ever be the same thing. This PR deprecates `spec_name` on database configurations in favor of `name`. It's the same behavior, just a better name, or at least a less confusing name. `connection_specification_name` refers to the parent class name (ie ActiveRecord::Base, AnimalsBase, etc) that holds the connection for it's models. In some places like ConnectionHandler it shortens this to `spec_name`, hence the major confusion. Recently I've been working with some new folks on database stuff and connection management and realize how confusing it was to explain that `db_config.spec_name` was not `spec_name` and `connection_specification_name`. Worse than that one is a symbole while the other is a class name. This was made even more complicated by the fact that `ActiveRecord::Base` used `primary` as the `connection_specification_name` until #38190. After spending 2 years with connection management I don't believe that we can ever use the symbols from the database configs as a way to connect the database without the class name being _somewhere_ because a db_config does not know who it's owner class is until it's been connected and a model has no idea what db_config belongs to it until it's connected. The model is the only way to tie a primary/writer config to a replica/reader config. This could change in the future but I don't see value in adding a class name to the db_configs before connection or telling a model what config belongs to it before connection. That would probably break a lot of application assumptions. If we do ever end up in that world, we can use name, because tbh `spec_name` and `connection_specification_name` were always confusing to me.
105 lines
2.7 KiB
Ruby
105 lines
2.7 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require "cgi"
|
|
|
|
module Rails
|
|
# This module helps build the runtime properties that are displayed in
|
|
# Rails::InfoController responses. These include the active Rails version,
|
|
# Ruby version, Rack version, and so on.
|
|
module Info
|
|
mattr_accessor :properties, default: []
|
|
|
|
class << @@properties
|
|
def names
|
|
map(&:first)
|
|
end
|
|
|
|
def value_for(property_name)
|
|
if property = assoc(property_name)
|
|
property.last
|
|
end
|
|
end
|
|
end
|
|
|
|
class << self #:nodoc:
|
|
def property(name, value = nil)
|
|
value ||= yield
|
|
properties << [name, value] if value
|
|
rescue Exception
|
|
end
|
|
|
|
def to_s
|
|
column_width = properties.names.map(&:length).max
|
|
info = properties.map do |name, value|
|
|
value = value.join(", ") if value.is_a?(Array)
|
|
"%-#{column_width}s %s" % [name, value]
|
|
end
|
|
info.unshift "About your application's environment"
|
|
info * "\n"
|
|
end
|
|
|
|
alias inspect to_s
|
|
|
|
def to_html
|
|
(+"<table>").tap do |table|
|
|
properties.each do |(name, value)|
|
|
table << %(<tr><td class="name">#{CGI.escapeHTML(name.to_s)}</td>)
|
|
formatted_value = if value.kind_of?(Array)
|
|
"<ul>" + value.map { |v| "<li>#{CGI.escapeHTML(v.to_s)}</li>" }.join + "</ul>"
|
|
else
|
|
CGI.escapeHTML(value.to_s)
|
|
end
|
|
table << %(<td class="value">#{formatted_value}</td></tr>)
|
|
end
|
|
table << "</table>"
|
|
end
|
|
end
|
|
end
|
|
|
|
# The Rails version.
|
|
property "Rails version" do
|
|
Rails.version.to_s
|
|
end
|
|
|
|
# The Ruby version and platform, e.g. "2.0.0-p247 (x86_64-darwin12.4.0)".
|
|
property "Ruby version" do
|
|
RUBY_DESCRIPTION
|
|
end
|
|
|
|
# The RubyGems version, if it's installed.
|
|
property "RubyGems version" do
|
|
Gem::VERSION
|
|
end
|
|
|
|
property "Rack version" do
|
|
::Rack.release
|
|
end
|
|
|
|
property "JavaScript Runtime" do
|
|
ExecJS.runtime.name
|
|
end
|
|
|
|
property "Middleware" do
|
|
Rails.configuration.middleware.map(&:inspect)
|
|
end
|
|
|
|
# The application's location on the filesystem.
|
|
property "Application root" do
|
|
File.expand_path(Rails.root)
|
|
end
|
|
|
|
# The current Rails environment (development, test, or production).
|
|
property "Environment" do
|
|
Rails.env
|
|
end
|
|
|
|
# The name of the database adapter for the current environment.
|
|
property "Database adapter" do
|
|
ActiveRecord::Base.configurations.configs_for(env_name: Rails.env, name: "primary").adapter
|
|
end
|
|
|
|
property "Database schema version" do
|
|
ActiveRecord::Base.connection.migration_context.current_version rescue nil
|
|
end
|
|
end
|
|
end
|