123456789_123456789_123456789_123456789_123456789_

Class: Rails::Application

Overview

An Engine with the responsibility of coordinating the whole boot process.

Initialization

Application is responsible for executing all railties and engines initializers. It also executes some bootstrap initializers (check Bootstrap) and finishing initializers, after all the others are executed (check Finisher).

Configuration

Besides providing the same configuration as Engine and Railtie, the application object has several specific configurations, for example enable_reloading, consider_all_requests_local, #filter_parameters, logger, and so forth.

Check 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:

  1. require "config/boot.rb" to set up load paths.

  2. require railties and engines.

  3. Define application as class {MyApp::Application} < Rails::Application.

  4. Run config.before_configuration callbacks.

  5. Load config/environments/ENV.rb.

  6. Run config.before_initialize callbacks.

  7. Run Railtie#initializer defined by railties, engines, and application. One by one, each engine sets up its load paths and routes, and runs its config/initializers/* files.

  8. Custom Railtie#initializers added by railties, engines, and applications are executed.

  9. Build the middleware stack and run to_prepare callbacks.

  10. Run config.before_eager_load and #eager_load! if eager_load is true.

  11. Run config.after_initialize callbacks.

Constant Summary

Railtie - Inherited

ABSTRACT_RAILTIES

::ActiveSupport::Callbacks - Included

CALLBACK_FILTER_TYPES

Class Attribute Summary

Class Method Summary

Engine - Inherited

Railtie - Inherited

.configure

Allows you to configure the railtie.

.console, .generators, .inherited,
.instance

Since Railtie cannot be instantiated, any methods that call .instance are intended to be called only on subclasses of a Railtie.

.railtie_name, .rake_tasks, .runner, .server, .subclasses, .increment_load_index, .generate_railtie_name,
.method_missing

If the class method does not have a method, then send the method call to the Railtie instance.

.register_block_for

receives an instance variable identifier, set the variable value if is blank and append given block to value, which will be used later in #each_registered_block(type, &block).

.respond_to_missing?, .<=>, .new

::ActiveSupport::DescendantsTracker - Extended

Instance Attribute Summary

Engine - Inherited

Railtie - Inherited

#config

This is used to create the config object on Railties, an instance of Railtie::Configuration, that is used by Railties and Application to store related configuration.

#railtie_name

Instance Method Summary

Engine - Inherited

#app

Returns the underlying Rack application for this engine.

#call

Define the Rack API for this engine.

#config

Define the configuration object for the engine.

#eager_load!,
#endpoint

Returns the endpoint for this engine.

#env_config

Defines additional Rack env configuration that is added on each call.

#helpers

Returns a module with all the helpers defined for the engine.

#helpers_paths

Returns all registered helpers paths.

#isolated?,
#load_console

Load console and invoke the registered hooks.

#load_generators

Load Rails generators and invoke the registered hooks.

#load_runner

Load Rails runner and invoke the registered hooks.

#load_seed

Load data from db/seeds.rb file.

#load_server

Invoke the server registered hooks.

#load_tasks

Load Rake and railties tasks, and invoke the registered hooks.

#railties,
#routes

Defines the routes for this engine.

#_all_autoload_once_paths, #_all_autoload_paths, #_all_load_paths, #build_middleware, #build_request, #default_middleware_stack, #fixtures_in_root_and_not_in_vendor_or_dot_dir?, #load_config_initializer, #missing_environment_file, #run_tasks_blocks

::ActiveSupport::Callbacks - Included

#run_callbacks

Runs the callbacks for the given event.

#halted_callback_hook

A hook invoked every time a before callback is halted.

Railtie - Inherited

Initializable - Included

Constructor Details

.new(initial_variable_values = {}, &block) ⇒ Application

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 110

def initialize(initial_variable_values = {}, &block)
  super()
  @initialized       = false
  @reloaders         = []
  @routes_reloader   = nil
  @app_env_config    = nil
  @ordered_railties  = nil
  @railties          = nil
  @key_generators    = {}
  @message_verifiers = nil
  @deprecators       = nil
  @ran_load_hooks    = false
  @revision          = nil
  @revision_initialized = 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

Class Method Details

.add_lib_to_load_path!(root)

This method is for internal use only.

This method is called just after an application inherits from Application, allowing the developer to load classes in lib and use them during application configuration.

class MyApplication < Rails::Application
  require "my_backend" # in lib/my_backend
  config.i18n.backend = MyBackend
end

Notice this method takes into consideration the default root path. So if you are changing config.root inside your application definition or having a custom ::Rails application, you will need to add lib to $LOAD_PATH on your own in case you need to load files in lib/ during the application configuration as well.

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 441

def self.add_lib_to_load_path!(root) # :nodoc:
  path = File.join(root, "lib")
  if File.exist?(path) && !$LOAD_PATH.include?(path)
    $LOAD_PATH.unshift(path)
  end
end

.create(initial_variable_values = {}, &block)

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 85

def create(initial_variable_values = {}, &block)
  new(initial_variable_values, &block).run_load_hooks!
end

.find_root(from)

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 89

def find_root(from)
  find_root_with_flag "config.ru", from, Dir.pwd
end

.inherited(base)

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 72

def inherited(base)
  super
  Rails.app_class = base
  # lib has to be added to $LOAD_PATH unconditionally, even if it's in the
  # autoload paths and config.add_autoload_paths_to_load_path is false.
  add_lib_to_load_path!(find_root(base.called_from))
  ActiveSupport.run_load_hooks(:before_configuration, base)
end

.instance

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 81

def instance
  super.run_load_hooks!
end

Instance Attribute Details

#any_environment_files?Boolean (readonly, private)

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 752

def any_environment_files?
  paths["config/environments"]
    .paths
    .flat_map { |path| [path, *path.glob("*.rb")] }
    .select(&:file?)
    .any?
end

#assets (rw)

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 101

attr_accessor :assets, :sandbox

#autoloaders (readonly)

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 103

attr_reader :reloaders, :reloader, :executor, :autoloaders

#config (rw)

This method is for internal use only.
[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 485

def config # :nodoc:
  @config ||= Application::Configuration.new(self.class.find_root(self.class.called_from))
end

#config=(value) (rw)

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 489

attr_writer :config

#credentials (rw)

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.

Is best used via #creds to ensure that values can be overwritten via ENV (or Rails.env in dev).

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 606

def credentials
  @credentials ||= encrypted(config.credentials.content_path, key_path: config.credentials.key_path)
end

#credentials=(value) (rw)

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 490

attr_writer :credentials

#creds (rw)

Returns an ::ActiveSupport::CombinedConfiguration instance that combines access to the encrypted credentials available via #credentials and keys used for the same purpose in ENV.

In the development environment, Rails.env variables are also included, and looked up after ENV and before the encrypted credentials.

This allows application creds to be accessed in a uniform way regardless of where they’re being provided. You don’t have to change app code when you move from ENV to encrypted credentials or vice versa.

Examples:

Rails.app.creds.require(:db_password)
Rails.app.creds.require(:aws, :access_key_id)
Rails.app.creds.option(:cache_host, default: "cache-host-1")
Rails.app.creds.option(:cache_host, default: -> { HostProvider.cache })
[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 532

def creds
  if Rails.env.development?
    @creds ||= ActiveSupport::CombinedConfiguration.new(envs, dotenvs, credentials)
  else
    @creds ||= ActiveSupport::CombinedConfiguration.new(envs, credentials)
  end
end

#creds=(value) (rw)

Allows for a custom combined configuration to be used for creds.

Example adding a OnePassword backend between ENVS and encrypted credentials:

Rails.app.creds = ActiveSupport::CombinedConfiguration.new \
  Rails.app.envs, OnePasswordConfiguration.new, Rails.app.credentials
[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 546

attr_writer :creds

#default_url_options (rw)

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 105

delegate :default_url_options, :default_url_options=, to: :routes

#executor (readonly)

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 103

attr_reader :reloaders, :reloader, :executor, :autoloaders

#initialized?Boolean (readonly)

Returns true if the application is initialized.

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 137

def initialized?
  @initialized
end

#reloader (readonly)

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 103

attr_reader :reloaders, :reloader, :executor, :autoloaders

#reloaders (readonly)

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 103

attr_reader :reloaders, :reloader, :executor, :autoloaders

#revision (rw)

Returns the application’s revision (deployment identifier). Useful for error reporting and deployment verification.

Set via config.revision (string) or REVISION file. Always either a ::String or nil.

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 404

def revision
  unless @revision_initialized
    @revision = begin
      root.join("REVISION").read.strip.presence
    rescue SystemCallError
      r, w = IO.pipe
      success = system("git", "-C", root.to_s, "rev-parse", "HEAD", in: File::NULL, err: File::NULL, out: w)
      w.close
      rev = r.read.strip
      r.close
      rev if success
    end
    @revision_initialized = true
  end
  @revision
end

#revision=(rev) (rw)

This method is for internal use only.

::Rails internal API

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 423

def revision=(rev) # :nodoc:
  @revision = rev&.to_s
  @revision_initialized = true
end

#sandbox? (rw)

Alias for #sandbox.

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 102

alias_method :sandbox?, :sandbox

Instance Method Details

#build_middleware (private)

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 767

def build_middleware
  config.app_middleware + super
end

#build_middleware_stack (protected)

Alias for Engine#app.

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 669

alias :build_middleware_stack :app

#build_request(env) (private)

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 760

def build_request(env)
  req = super
  env["ORIGINAL_FULLPATH"] = req.fullpath
  env["ORIGINAL_SCRIPT_NAME"] = req.script_name
  req
end

#coerce_same_site_protection(protection) (private)

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 771

def coerce_same_site_protection(protection)
  protection.respond_to?(:call) ? protection : proc { protection }
end

#config_for(name, env: Rails.env)

Convenience for loading config/foo.yml for the current Rails env. Example:

# config/exception_notification.yml:
production:
  url: http://127.0: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 }
[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 295

def config_for(name, env: Rails.env)
  yaml = name.is_a?(Pathname) ? name : Pathname.new("#{paths["config"].existent.first}/#{name}.yml")

  if yaml.exist?
    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)

Sends any console called in the instance of a new application up to the console method defined in Railtie.

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 377

def console(&blk)
  self.class.console(&blk)
end

#default_middleware_stack (protected)

This method is for internal use only.
[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 737

def default_middleware_stack # :nodoc:
  default_stack = DefaultMiddlewareStack.new(self, config, paths)
  default_stack.build_stack
end

#deprecators

A managed collection of deprecators (ActiveSupport::Deprecation::Deprecators). The collection’s configuration methods affect all deprecators in the collection. Additionally, the collection’s silence method silences all deprecators in the collection for the duration of a given block.

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 251

def deprecators
  @deprecators ||= ActiveSupport::Deprecation::Deprecators.new.tap do |deprecators|
    deprecators[:railties] = Rails.deprecator
  end
end

#dotenvs(path = Rails.root.join(".env"))

Returns an ::ActiveSupport::DotEnvConfiguration instance that provides access to the variables in Rails.env through symbol-based lookup with explicit methods for required and optional values. This is the same interface offered by #envs and can be accessed in a combined manner via #creds.

The Rails.env file format supports:

  • Lines with KEY=value pairs

  • Comments starting with #

  • Empty lines (ignored)

  • Quoted values (single or double quotes)

  • Variable interpolation with $VAR syntax

  • Command execution with $(command) syntax

Examples:

Rails.app.dotenvs.require(:db_password) # DB_PASSWORD from .env
Rails.app.dotenvs.require(:aws, :access_key_id) # AWS__ACCESS_KEY_ID from .env
Rails.app.dotenvs.option(:cache_host) # CACHE_HOST from .env or nil
Rails.app.dotenvs.option(:cache_host, default: "cache-host-1") # CACHE_HOST from .env or "cache-host-1"
Rails.app.dotenvs.option(:cache_host, default: -> { HostProvider.cache }) # CACHE_HOST from .env or HostProvider.cache

In development mode, this configuration backend is automatically part of Rails.app.creds.

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 586

def dotenvs(path = Rails.root.join(".env"))
  @dotenvs ||= ActiveSupport::DotEnvConfiguration.new(path)
end

#eager_load!

Eager loads the application code.

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 664

def eager_load!
  Rails.autoloaders.each(&:eager_load)
end

#encrypted(path, key_path: "config/master.key", env_key: "RAILS_MASTER_KEY")

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.)

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 625

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

#ensure_generator_templates_added (protected)

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 742

def ensure_generator_templates_added
  configured_paths = config.generators.templates
  configured_paths.unshift(*(paths["lib/templates"].existent - configured_paths))
end

#env_config

Stores some of the Rails initial environment parameters which will be used by middlewares and engines to configure themselves.

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 323

def env_config
  @app_env_config ||= super.merge(
      "action_dispatch.parameter_filter" => 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.debug_exception_log_level" => ActiveSupport::Logger.const_get(config.action_dispatch.debug_exception_log_level.to_s.upcase),
      "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.,
      "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

#envs

Returns an ::ActiveSupport::EnvConfiguration instance that provides access to the ENV variables through symbol-based lookup with explicit methods for required and optional values. This is the same interface offered by #credentials and can be accessed in a combined manner via #creds.

Examples:

Rails.app.envs.require(:db_password) # ENV,fetch("DB_PASSWORD")
Rails.app.envs.require(:aws, :access_key_id) # ENV.fetch("AWS__ACCESS_KEY_ID")
Rails.app.envs.option(:cache_host) # ENV["CACHE_HOST"]
Rails.app.envs.option(:cache_host, default: "cache-host-1") # ENV.fetch("CACHE_HOST", "cache-host-1")
Rails.app.envs.option(:cache_host, default: -> { HostProvider.cache }) # ENV.fetch("CACHE_HOST") { HostProvider.cache }
[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 560

def envs
  @envs ||= ActiveSupport::EnvConfiguration.new
end

#filter_parameters (private)

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 775

def filter_parameters
  if config.precompile_filter_parameters
    config.filter_parameters.replace(
      ActiveSupport::ParameterFilter.precompile_filters(config.filter_parameters)
    )
  end
  config.filter_parameters
end

#generators(&blk)

Sends any generators called in the instance of a new application up to the generators method defined in Railtie.

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 383

def generators(&blk)
  self.class.generators(&blk)
end

#helpers_paths

This method is for internal use only.
[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 638

def helpers_paths # :nodoc:
  config.helpers_paths
end

#initialize!(group = :default)

This method is for internal use only.

Initialize the application passing the given group. By default, the group is :default

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 472

def initialize!(group = :default) # :nodoc:
  raise "Application has been already initialized." if @initialized
  run_initializers(group, self)
  @initialized = true
  self
end

#initializer(name, opts = {}, &block)

Sends the initializers to the initializer method defined in the Initializable module. Each Application class has its own set of initializers, as defined by the Initializable module.

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 365

def initializer(name, opts = {}, &block)
  self.class.initializer(name, opts, &block)
end

#initializers

This method is for internal use only.
[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 479

def initializers # :nodoc:
  Bootstrap.initializers_for(self) +
  railties_initializers(super) +
  Finisher.initializers_for(self)
end

#isolate_namespace(mod)

Sends the isolate_namespace method up to the class method.

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 394

def isolate_namespace(mod)
  self.class.isolate_namespace(mod)
end

#key_generator(secret_key_base = self.secret_key_base)

Returns a key generator (ActiveSupport::CachingKeyGenerator) for a specified #secret_key_base. The return value is memoized, so additional calls with the same #secret_key_base will return the same key generator instance.

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 179

def key_generator(secret_key_base = self.secret_key_base)
  # number of iterations selected based on consultation with the google security
  # team. Details at https://github.com/rails/rails/pull/6952#issuecomment-7661220
  @key_generators[secret_key_base] ||= ActiveSupport::CachingKeyGenerator.new(
    ActiveSupport::KeyGenerator.new(secret_key_base, iterations: 1000)
  )
end

#load_generators(app = self)

This method is for internal use only.
[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 658

def load_generators(app = self) # :nodoc:
  app.ensure_generator_templates_added
  super
end

#message_verifier(verifier_name)

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.

For instance, ActiveStorage::Blob.signed_id_verifier is implemented using this feature, which assures that the IDs strings haven’t been tampered with and are safe to use in a finder.

See the ::ActiveSupport::MessageVerifier documentation for more information.

Parameters

  • verifier_name - the name of the message verifier.

Examples

message = Rails.application.message_verifier('my_purpose').generate('data to sign against tampering')
Rails.application.message_verifier('my_purpose').verify(message)
# => 'data to sign against tampering'
[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 243

def message_verifier(verifier_name)
  message_verifiers[verifier_name]
end

#message_verifiers

Returns a message verifier factory (ActiveSupport::MessageVerifiers). This factory can be used as a central point to configure and create message verifiers (ActiveSupport::MessageVerifier) for your application.

By default, message verifiers created by this factory will generate messages using the default ::ActiveSupport::MessageVerifier options. You can override these options with a combination of ActiveSupport::MessageVerifiers#clear_rotations and ActiveSupport::MessageVerifiers#rotate. However, this must be done prior to building any message verifier instances. For example, in a before_initialize block:

# Use `url_safe: true` when generating messages
config.before_initialize do |app|
  app.message_verifiers.clear_rotations
  app.message_verifiers.rotate(url_safe: true)
end

Message verifiers created by this factory will always use a secret derived from #secret_key_base when generating messages. clear_rotations will not affect this behavior. However, older #secret_key_base values can be rotated for verifying messages:

# Fall back to old {secret_key_base} when verifying messages
config.before_initialize do |app|
  app.message_verifiers.rotate(secret_key_base: "old secret_key_base")
end
[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 215

def message_verifiers
  @message_verifiers ||=
    ActiveSupport::MessageVerifiers.new do |salt, secret_key_base: self.secret_key_base|
      key_generator(secret_key_base).generate_key(salt)
    end.rotate_defaults
end

#migration_railties

This method is for internal use only.

Return an array of railties respecting the order they’re loaded and the order specified by the railties_order config.

While running initializers we need engines in reverse order here when copying migrations from railties ; we need them in the order given by railties_order.

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 654

def migration_railties # :nodoc:
  ordered_railties.flatten - [self]
end

#missing_environment_file (private)

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 748

def missing_environment_file
  raise "Rails environment has been set to #{Rails.env} but config/environments/#{Rails.env}.rb does not exist."
end

#name

Returns the dasherized application name.

MyApp::Application.new.name => "my-app"
[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 144

def name
  self.class.name.underscore.dasherize.delete_suffix("/application")
end

#ordered_railties (protected)

This method is for internal use only.

Returns the ordered railties for this application considering railties_order.

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 703

def ordered_railties # :nodoc:
  @ordered_railties ||= begin
    order = config.railties_order.map do |railtie|
      if railtie == :main_app
        self
      elsif railtie.respond_to?(:instance)
        railtie.instance
      else
        railtie
      end
    end

    all = (railties - order)
    all.push(self)   unless (all + order).include?(self)
    order.push(:all) unless order.include?(:all)

    index = order.index(:all)
    order[index] = all
    order
  end
end

#railties_initializers(current) (protected)

This method is for internal use only.
[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 725

def railties_initializers(current) # :nodoc:
  initializers = Initializable::Collection.new
  ordered_railties.reverse.flatten.each do |r|
    if r == self
      initializers += current
    else
      initializers += r.initializers
    end
  end
  initializers
end

#rake_tasks(&block)

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.

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 358

def rake_tasks(&block)
  self.class.rake_tasks(&block)
end

#reload_routes!

Reload application routes regardless if they changed or not.

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 163

def reload_routes!
  if routes_reloader.execute_unless_loaded
    routes_reloader.loaded = false
  else
    routes_reloader.reload!
  end
end

#reload_routes_unless_loaded

This method is for internal use only.
[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 171

def reload_routes_unless_loaded # :nodoc:
  initialized? && routes_reloader.execute_unless_loaded
end

#require_environment!

This method is for internal use only.
[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 448

def require_environment! # :nodoc:
  environment = paths["config/environment"].existent.first
  require environment if environment
end

#routes_reloader

This method is for internal use only.
[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 453

def routes_reloader # :nodoc:
  @routes_reloader ||= RoutesReloader.new(file_watcher: config.file_watcher)
end

#run_console_blocks(app) (protected)

This method is for internal use only.
[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 692

def run_console_blocks(app) # :nodoc:
  railties.each { |r| r.run_console_blocks(app) }
  super
end

#run_generators_blocks(app) (protected)

This method is for internal use only.
[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 682

def run_generators_blocks(app) # :nodoc:
  railties.each { |r| r.run_generators_blocks(app) }
  super
end

#run_load_hooks!

This method is for internal use only.
[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 148

def run_load_hooks! # :nodoc:
  return self if @ran_load_hooks
  @ran_load_hooks = true

  @initial_variable_values.each do |variable_name, value|
    if INITIAL_VARIABLES.include?(variable_name)
      instance_variable_set("@#{variable_name}", value)
    end
  end

  instance_eval(&@block) if @block
  self
end

#run_runner_blocks(app) (protected)

This method is for internal use only.
[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 687

def run_runner_blocks(app) # :nodoc:
  railties.each { |r| r.run_runner_blocks(app) }
  super
end

#run_server_blocks(app) (protected)

This method is for internal use only.
[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 697

def run_server_blocks(app) # :nodoc:
  railties.each { |r| r.run_server_blocks(app) }
  super
end

#run_tasks_blocks(app) (protected)

This method is for internal use only.
[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 671

def run_tasks_blocks(app) # :nodoc:
  railties.each { |r| r.run_tasks_blocks(app) }
  super
  load "rails/tasks.rb"
  task :environment do
    ActiveSupport.on_load(:before_initialize) { config.eager_load = config.rake_eager_load }

    require_environment!
  end
end

#runner(&blk)

Sends any runner called in the instance of a new application up to the runner method defined in Railtie.

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 371

def runner(&blk)
  self.class.runner(&blk)
end

#sandbox (rw) Also known as: #sandbox?

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 101

attr_accessor :assets, :sandbox

#secret_key_base

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.

We look for it first in ENV["SECRET_KEY_BASE"], then in credentials.secret_key_base. For most applications, the correct place to store it is in the encrypted credentials file.

In development and test, if the secret_key_base is still empty, it is randomly generated and stored in a temporary file in tmp/local_secret.txt.

Generating a random secret_key_base and storing it in tmp/local_secret.txt can also be triggered by setting ENV["SECRET_KEY_BASE_DUMMY"]. This is useful when precompiling assets for production as part of a build step that otherwise does not need access to the production secrets.

Dockerfile example: RUN SECRET_KEY_BASE_DUMMY=1 bundle exec rails assets:precompile.

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 511

def secret_key_base
  config.secret_key_base
end

#server(&blk)

Sends any server called in the instance of a new application up to the server method defined in Railtie.

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 389

def server(&blk)
  self.class.server(&blk)
end

#to_app

This method is for internal use only.
[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 634

def to_app # :nodoc:
  self
end

#watchable_args

This method is for internal use only.

Returns an array of file paths appended with a hash of directories-extensions suitable for ::ActiveSupport::FileUpdateChecker API.

[ GitHub ]

  
# File 'railties/lib/rails/application.rb', line 460

def watchable_args # :nodoc:
  files, dirs = config.watchable_files.dup, config.watchable_dirs.dup

  Rails.autoloaders.main.dirs.each do |path|
    dirs[path] = [:rb]
  end

  [files, dirs]
end