An Engine
with the responsibility of coordinating the whole boot process.
Initialization
Rails::Application
is responsible for executing all railties and engines initializers. It also executes some bootstrap initializers (check Rails::Application::Bootstrap
) and finishing initializers, after all the others are executed (check Rails::Application::Finisher
).
Configuration
Besides providing the same configuration as Rails::Engine
and Rails::Railtie
, the application object has several specific configurations, for example cache_classes
, consider_all_requests_local
, filter_parameters
, logger
, and so forth.
Check Rails::Application::Configuration
to see them all.
Routes
The application object is also responsible for holding the routes and reloading routes whenever the files change in development.
Middlewares
The Application
is also responsible for building the middleware stack.
Booting process
The application is also responsible for setting up and executing the booting process. From the moment you require config/application.rb
in your app, the booting process goes like this:
-
require "config/boot.rb"
to set up load paths. -
require
railties and engines. -
Define
Rails.application
asclass MyApp::Application < Rails::Application
. -
Run
config.before_configuration
callbacks. -
Load
config/environments/ENV.rb
. -
Run
config.before_initialize
callbacks. -
Run
Railtie#initializer
defined by railties, engines, and application. One by one, each engine sets up its load paths and routes, and runs itsconfig/initializers/*
files. -
Custom
Railtie#initializers
added by railties, engines, and applications are executed. -
Build the middleware stack and run
to_prepare
callbacks. -
Run
config.before_eager_load
andeager_load!
ifeager_load
istrue
. -
Run
config.after_initialize
callbacks.
- MODULE Rails::Application::Bootstrap
- MODULE Rails::Application::Finisher
- CLASS Rails::Application::Configuration
- CLASS Rails::Application::DefaultMiddlewareStack
- CLASS Rails::Application::RoutesReloader
- C
- E
- F
- G
- I
- K
- M
- N
- R
- S
- V
Attributes
[RW] | assets | |
[R] | autoloaders | |
[W] | config | |
[W] | credentials | |
[R] | executor | |
[R] | reloader | |
[R] | reloaders | |
[RW] | sandbox | |
[RW] | sandbox? | |
[W] | secrets |
Class Public methods
create(initial_variable_values = {}, &block) Link
find_root(from) Link
inherited(base) Link
instance() Link
new(initial_variable_values = {}, &block) Link
# File railties/lib/rails/application.rb, line 106 def initialize(initial_variable_values = {}, &block) super() @initialized = false @reloaders = [] @routes_reloader = nil @app_env_config = nil @ordered_railties = nil @railties = nil @message_verifiers = {} @ran_load_hooks = false @executor = Class.new(ActiveSupport::Executor) @reloader = Class.new(ActiveSupport::Reloader) @reloader.executor = @executor @autoloaders = Rails::Autoloaders.new # are these actually used? @initial_variable_values = initial_variable_values @block = block end
Instance Public methods
config_for(name, env: Rails.env) Link
Convenience for loading config/foo.yml for the current Rails
env.
Examples:
# config/exception_notification.yml:
production:
url: http://127.0.0.1:8080
namespace: my_app_production
development:
url: http://localhost:3001
namespace: my_app_development
# config/environments/production.rb
Rails.application.configure do
config.middleware.use ExceptionNotifier, config_for(:exception_notification)
end
# You can also store configurations in a shared section which will be
# merged with the environment configuration
# config/example.yml
shared:
foo:
bar:
baz: 1
development:
foo:
bar:
qux: 2
# development environment
Rails.application.config_for(:example)[:foo][:bar]
# => { baz: 1, qux: 2 }
# File railties/lib/rails/application.rb, line 221 def config_for(name, env: Rails.env) yaml = name.is_a?(Pathname) ? name : Pathname.new("#{paths["config"].existent.first}/#{name}.yml") if yaml.exist? require "erb" all_configs = ActiveSupport::ConfigurationFile.parse(yaml).deep_symbolize_keys config, shared = all_configs[env.to_sym], all_configs[:shared] if shared config = {} if config.nil? && shared.is_a?(Hash) if config.is_a?(Hash) && shared.is_a?(Hash) config = shared.deep_merge(config) elsif config.nil? config = shared end end if config.is_a?(Hash) config = ActiveSupport::OrderedOptions.new.update(config) end config else raise "Could not load configuration. No such file - #{yaml}" end end
console(&blk) Link
Sends any console called in the instance of a new application up to the console
method defined in Rails::Railtie
.
credentials() Link
Returns an ActiveSupport::EncryptedConfiguration
instance for the credentials file specified by config.credentials.content_path
.
By default, config.credentials.content_path
will point to either config/credentials/#{environment}.yml.enc
for the current environment (for example, config/credentials/production.yml.enc
for the production
environment), or config/credentials.yml.enc
if that file does not exist.
The encryption key is taken from either ENV["RAILS_MASTER_KEY"]
, or from the file specified by config.credentials.key_path
. By default, config.credentials.key_path
will point to either config/credentials/#{environment}.key
for the current environment, or config/master.key
if that file does not exist.
eager_load!() Link
Eager loads the application code.
encrypted(path, key_path: "config/master.key", env_key: "RAILS_MASTER_KEY") Link
Returns an ActiveSupport::EncryptedConfiguration
instance for an encrypted file. By default, the encryption key is taken from either ENV["RAILS_MASTER_KEY"]
, or from the config/master.key
file.
my_config = Rails.application.encrypted("config/my_config.enc")
my_config.read
# => "foo:\n bar: 123\n"
my_config.foo.bar
# => 123
Encrypted files can be edited with the bin/rails encrypted:edit
command. (See the output of bin/rails encrypted:edit --help
for more information.)
# File railties/lib/rails/application.rb, line 458 def encrypted(path, key_path: "config/master.key", env_key: "RAILS_MASTER_KEY") ActiveSupport::EncryptedConfiguration.new( config_path: Rails.root.join(path), key_path: Rails.root.join(key_path), env_key: env_key, raise_if_missing_key: config.require_master_key ) end
env_config() Link
Stores some of the Rails
initial environment parameters which will be used by middlewares and engines to configure themselves.
# File railties/lib/rails/application.rb, line 250 def env_config @app_env_config ||= super.merge( "action_dispatch.parameter_filter" => config.filter_parameters, "action_dispatch.redirect_filter" => config.filter_redirect, "action_dispatch.secret_key_base" => secret_key_base, "action_dispatch.show_exceptions" => config.action_dispatch.show_exceptions, "action_dispatch.show_detailed_exceptions" => config.consider_all_requests_local, "action_dispatch.log_rescued_responses" => config.action_dispatch.log_rescued_responses, "action_dispatch.logger" => Rails.logger, "action_dispatch.backtrace_cleaner" => Rails.backtrace_cleaner, "action_dispatch.key_generator" => key_generator, "action_dispatch.http_auth_salt" => config.action_dispatch.http_auth_salt, "action_dispatch.signed_cookie_salt" => config.action_dispatch.signed_cookie_salt, "action_dispatch.encrypted_cookie_salt" => config.action_dispatch.encrypted_cookie_salt, "action_dispatch.encrypted_signed_cookie_salt" => config.action_dispatch.encrypted_signed_cookie_salt, "action_dispatch.authenticated_encrypted_cookie_salt" => config.action_dispatch.authenticated_encrypted_cookie_salt, "action_dispatch.use_authenticated_cookie_encryption" => config.action_dispatch.use_authenticated_cookie_encryption, "action_dispatch.encrypted_cookie_cipher" => config.action_dispatch.encrypted_cookie_cipher, "action_dispatch.signed_cookie_digest" => config.action_dispatch.signed_cookie_digest, "action_dispatch.cookies_serializer" => config.action_dispatch.cookies_serializer, "action_dispatch.cookies_digest" => config.action_dispatch.cookies_digest, "action_dispatch.cookies_rotations" => config.action_dispatch.cookies_rotations, "action_dispatch.cookies_same_site_protection" => coerce_same_site_protection(config.action_dispatch.cookies_same_site_protection), "action_dispatch.use_cookies_with_metadata" => config.action_dispatch.use_cookies_with_metadata, "action_dispatch.content_security_policy" => config.content_security_policy, "action_dispatch.content_security_policy_report_only" => config.content_security_policy_report_only, "action_dispatch.content_security_policy_nonce_generator" => config.content_security_policy_nonce_generator, "action_dispatch.content_security_policy_nonce_directives" => config.content_security_policy_nonce_directives, "action_dispatch.permissions_policy" => config.permissions_policy, ) end
generators(&blk) Link
Sends any generators called in the instance of a new application up to the generators
method defined in Rails::Railtie
.
initialized?() Link
Returns true if the application is initialized.
initializer(name, opts = {}, &block) Link
Sends the initializers to the initializer
method defined in the Rails::Initializable
module. Each Rails::Application
class has its own set of initializers, as defined by the Initializable
module.
isolate_namespace(mod) Link
Sends the isolate_namespace
method up to the class method.
key_generator() Link
Returns the application's KeyGenerator
# File railties/lib/rails/application.rb, line 153 def key_generator # number of iterations selected based on consultation with the google security # team. Details at https://github.com/rails/rails/pull/6952#issuecomment-7661220 @caching_key_generator ||= ActiveSupport::CachingKeyGenerator.new( ActiveSupport::KeyGenerator.new(secret_key_base, iterations: 1000) ) end
message_verifier(verifier_name) Link
Returns a message verifier object.
This verifier can be used to generate and verify signed messages in the application.
It is recommended not to use the same verifier for different things, so you can get different verifiers passing the verifier_name
argument.
Parameters
-
verifier_name
- the name of the message verifier.
Examples
message = Rails.application.message_verifier('sensitive_data').generate('my sensible data')
Rails.application.message_verifier('sensitive_data').verify(message)
# => 'my sensible data'
See the ActiveSupport::MessageVerifier
documentation for more information.
rake_tasks(&block) Link
If you try to define a set of Rake tasks on the instance, these will get passed up to the Rake tasks defined on the application's class.
reload_routes!() Link
Reload application routes regardless if they changed or not.
runner(&blk) Link
Sends any runner called in the instance of a new application up to the runner
method defined in Rails::Railtie
.
secret_key_base() Link
The secret_key_base
is used as the input secret to the application's key generator, which in turn is used to create all ActiveSupport::MessageVerifier
and ActiveSupport::MessageEncryptor
instances, including the ones that sign and encrypt cookies.
In development and test, this is randomly generated and stored in a temporary file in tmp/development_secret.txt
.
In all other environments, we look for it first in ENV["SECRET_KEY_BASE"]
, then credentials.secret_key_base
, and finally secrets.secret_key_base
. For most applications, the correct place to store it is in the encrypted credentials file.
# File railties/lib/rails/application.rb, line 415 def secret_key_base if Rails.env.development? || Rails.env.test? secrets.secret_key_base ||= generate_development_secret else validate_secret_key_base( ENV["SECRET_KEY_BASE"] || credentials.secret_key_base || secrets.secret_key_base ) end end
secrets() Link
# File railties/lib/rails/application.rb, line 389 def secrets @secrets ||= begin secrets = ActiveSupport::OrderedOptions.new files = config.paths["config/secrets"].existent files = files.reject { |path| path.end_with?(".enc") } unless config.read_encrypted_secrets secrets.merge! Rails::Secrets.parse(files, env: Rails.env) # Fallback to config.secret_key_base if secrets.secret_key_base isn't set secrets.secret_key_base ||= config.secret_key_base secrets end end
server(&blk) Link
Sends any server called in the instance of a new application up to the server
method defined in Rails::Railtie
.
Instance Protected methods
validate_secret_key_base(secret_key_base) Link
# File railties/lib/rails/application.rb, line 570 def validate_secret_key_base(secret_key_base) if secret_key_base.is_a?(String) && secret_key_base.present? secret_key_base elsif secret_key_base raise ArgumentError, "`secret_key_base` for #{Rails.env} environment must be a type of String`" else raise ArgumentError, "Missing `secret_key_base` for '#{Rails.env}' environment, set this string with `bin/rails credentials:edit`" end end