Skip to Content Skip to Search
Methods
A
B
E
N
R
T
W

Class Public methods

new()

# File railties/lib/rails/railtie/configuration.rb, line 9
def initialize
  @@options ||= {}
end

Instance Public methods

after_initialize(&block)

Last configurable block to run. Called after frameworks initialize.

# File railties/lib/rails/railtie/configuration.rb, line 71
def after_initialize(&block)
  ActiveSupport.on_load(:after_initialize, yield: true, &block)
end

app_generators()

This allows you to modify application's generators from Railties.

Values set on app_generators will become defaults for application, unless application overwrites them.

# File railties/lib/rails/railtie/configuration.rb, line 48
def app_generators
  @@app_generators ||= Rails::Configuration::Generators.new
  yield(@@app_generators) if block_given?
  @@app_generators
end

app_middleware()

This allows you to modify the application's middlewares from Engines.

All operations you run on the app_middleware will be replayed on the application once it is defined and the default_middlewares are created

# File railties/lib/rails/railtie/configuration.rb, line 40
def app_middleware
  @@app_middleware ||= Rails::Configuration::MiddlewareStackProxy.new
end

before_configuration(&block)

First configurable block to run. Called before any initializers are run.

# File railties/lib/rails/railtie/configuration.rb, line 55
def before_configuration(&block)
  ActiveSupport.on_load(:before_configuration, yield: true, &block)
end

before_eager_load(&block)

Third configurable block to run. Does not run if config.eager_load set to false.

# File railties/lib/rails/railtie/configuration.rb, line 61
def before_eager_load(&block)
  ActiveSupport.on_load(:before_eager_load, yield: true, &block)
end

before_initialize(&block)

Second configurable block to run. Called before frameworks initialize.

# File railties/lib/rails/railtie/configuration.rb, line 66
def before_initialize(&block)
  ActiveSupport.on_load(:before_initialize, yield: true, &block)
end

eager_load_namespaces()

All namespaces that are eager loaded

# File railties/lib/rails/railtie/configuration.rb, line 19
def eager_load_namespaces
  @@eager_load_namespaces ||= []
end

respond_to?(name, include_private = false)

# File railties/lib/rails/railtie/configuration.rb, line 86
def respond_to?(name, include_private = false)
  super || @@options.key?(name.to_sym)
end

to_prepare(&blk)

Defines generic callbacks to run before after_initialize. Useful for Rails::Railtie subclasses.

# File railties/lib/rails/railtie/configuration.rb, line 82
def to_prepare(&blk)
  to_prepare_blocks << blk if blk
end

to_prepare_blocks()

Array of callbacks defined by to_prepare.

# File railties/lib/rails/railtie/configuration.rb, line 76
def to_prepare_blocks
  @@to_prepare_blocks ||= []
end

watchable_dirs()

Add directories that should be watched for change. The key of the hashes should be directories and the values should be an array of extensions to match in each directory.

# File railties/lib/rails/railtie/configuration.rb, line 31
def watchable_dirs
  @@watchable_dirs ||= {}
end

watchable_files()

Add files that should be watched for change.

# File railties/lib/rails/railtie/configuration.rb, line 24
def watchable_files
  @@watchable_files ||= []
end