Class: Rails::Railtie::Configuration

Inherits:
Object
  • Object
show all
Defined in:
railties/lib/rails/railtie/configuration.rb

Direct Known Subclasses

Engine::Configuration

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeConfiguration

Returns a new instance of Configuration



6
7
8
# File 'railties/lib/rails/railtie/configuration.rb', line 6

def initialize
  @@options ||= {}
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(name, *args, &blk) ⇒ Object (private)



89
90
91
92
93
94
95
96
97
# File 'railties/lib/rails/railtie/configuration.rb', line 89

def method_missing(name, *args, &blk)
  if name.to_s =~ /=$/
    @@options[$`.to_sym] = args.first
  elsif @@options.key?(name)
    @@options[name]
  else
    super
  end
end

Class Method Details

.eager_load_namespacesObject

Expose the eager_load_namespaces at “module” level for convenience.



11
12
13
# File 'railties/lib/rails/railtie/configuration.rb', line 11

def self.eager_load_namespaces #:nodoc:
  @@eager_load_namespaces ||= []
end

Instance Method Details

#after_initialize(&block) ⇒ Object

Last configurable block to run. Called after frameworks initialize.



68
69
70
# File 'railties/lib/rails/railtie/configuration.rb', line 68

def after_initialize(&block)
  ActiveSupport.on_load(:after_initialize, yield: true, &block)
end

#app_generators {|@@app_generators| ... } ⇒ Object

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

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

Yields:

  • (@@app_generators)


45
46
47
48
49
# File 'railties/lib/rails/railtie/configuration.rb', line 45

def app_generators
  @@app_generators ||= Rails::Configuration::Generators.new
  yield(@@app_generators) if block_given?
  @@app_generators
end

#app_middlewareObject

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



37
38
39
# File 'railties/lib/rails/railtie/configuration.rb', line 37

def app_middleware
  @@app_middleware ||= Rails::Configuration::MiddlewareStackProxy.new
end

#before_configuration(&block) ⇒ Object

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



52
53
54
# File 'railties/lib/rails/railtie/configuration.rb', line 52

def before_configuration(&block)
  ActiveSupport.on_load(:before_configuration, yield: true, &block)
end

#before_eager_load(&block) ⇒ Object

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



58
59
60
# File 'railties/lib/rails/railtie/configuration.rb', line 58

def before_eager_load(&block)
  ActiveSupport.on_load(:before_eager_load, yield: true, &block)
end

#before_initialize(&block) ⇒ Object

Second configurable block to run. Called before frameworks initialize.



63
64
65
# File 'railties/lib/rails/railtie/configuration.rb', line 63

def before_initialize(&block)
  ActiveSupport.on_load(:before_initialize, yield: true, &block)
end

#eager_load_namespacesObject

All namespaces that are eager loaded



16
17
18
# File 'railties/lib/rails/railtie/configuration.rb', line 16

def eager_load_namespaces
  @@eager_load_namespaces ||= []
end

#respond_to?(name, include_private = false) ⇒ Boolean

Returns:

  • (Boolean)


83
84
85
# File 'railties/lib/rails/railtie/configuration.rb', line 83

def respond_to?(name, include_private = false)
  super || @@options.key?(name.to_sym)
end

#to_prepare(&blk) ⇒ Object

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



79
80
81
# File 'railties/lib/rails/railtie/configuration.rb', line 79

def to_prepare(&blk)
  to_prepare_blocks << blk if blk
end

#to_prepare_blocksObject

Array of callbacks defined by #to_prepare.



73
74
75
# File 'railties/lib/rails/railtie/configuration.rb', line 73

def to_prepare_blocks
  @@to_prepare_blocks ||= []
end

#watchable_dirsObject

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.



28
29
30
# File 'railties/lib/rails/railtie/configuration.rb', line 28

def watchable_dirs
  @@watchable_dirs ||= {}
end

#watchable_filesObject

Add files that should be watched for change.



21
22
23
# File 'railties/lib/rails/railtie/configuration.rb', line 21

def watchable_files
  @@watchable_files ||= []
end