W3cubDocs

/Ruby on Rails 5.2

class Rails::Railtie::Configuration

Parent:
Object

Public Class Methods

new() Show source
# File railties/lib/rails/railtie/configuration.rb, line 8
def initialize
  @@options ||= {}
end

Public Instance Methods

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

Last configurable block to run. Called after frameworks initialize.

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

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

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

app_middleware() Show source
# File railties/lib/rails/railtie/configuration.rb, line 39
def app_middleware
  @@app_middleware ||= Rails::Configuration::MiddlewareStackProxy.new
end

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

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

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

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

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

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

Second configurable block to run. Called before frameworks initialize.

eager_load_namespaces() Show source
# File railties/lib/rails/railtie/configuration.rb, line 18
def eager_load_namespaces
  @@eager_load_namespaces ||= []
end

All namespaces that are eager loaded

respond_to?(name, include_private = false) Show source
# File railties/lib/rails/railtie/configuration.rb, line 85
def respond_to?(name, include_private = false)
  super || @@options.key?(name.to_sym)
end
Calls superclass method
to_prepare(&blk) Show source
# File railties/lib/rails/railtie/configuration.rb, line 81
def to_prepare(&blk)
  to_prepare_blocks << blk if blk
end

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

to_prepare_blocks() Show source
# File railties/lib/rails/railtie/configuration.rb, line 75
def to_prepare_blocks
  @@to_prepare_blocks ||= []
end

Array of callbacks defined by to_prepare.

watchable_dirs() Show source
# File railties/lib/rails/railtie/configuration.rb, line 30
def watchable_dirs
  @@watchable_dirs ||= {}
end

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.

watchable_files() Show source
# File railties/lib/rails/railtie/configuration.rb, line 23
def watchable_files
  @@watchable_files ||= []
end

Add files that should be watched for change.

© 2004–2018 David Heinemeier Hansson
Licensed under the MIT License.