Parent

Class/Module Index [+]

Quicksearch

Rails::Configuration

The Configuration class holds all the parameters for the Initializer and ships with defaults that suites most Rails applications. But it's possible to overwrite everything. Usually, you'll create an Configuration file implicitly through the block running on the Initializer, but it's also possible to create the Configuration instance in advance and pass it in like this:

config = Rails::Configuration.new
Rails::Initializer.run(:process, config)

Attributes

action_controller[RW]

A stub for setting options on ActionController::Base.

action_mailer[RW]

A stub for setting options on ActionMailer::Base.

action_view[RW]

A stub for setting options on ActionView::Base.

active_record[RW]

A stub for setting options on ActiveRecord::Base.

active_resource[RW]

A stub for setting options on ActiveResource::Base.

active_support[RW]

A stub for setting options on ActiveSupport.

autoload_once_paths[RW]

An array of paths from which Rails will automatically load from only once. All elements of this array must also be in autoload_paths.

autoload_paths[RW]

An array of additional paths to prepend to the load path. By default, all app, lib, vendor and mock paths are included in this list.

cache_classes[RW]

Whether or not classes should be cached (set to false if you want application classes to be reloaded on each request)

cache_store[RW]

The specific cache store to use. By default, the ActiveSupport::Cache::Store will be used.

controller_paths[RW]

The list of paths that should be searched for controllers. (Defaults to app/controllers.)

database_configuration_file[RW]

The path to the database configuration file to use. (Defaults to config/database.yml.)

dependency_loading[RW]

Enables or disables dependency loading during the request cycle. Setting dependency_loading to true will allow new classes to be loaded during a request. Setting it to false will disable this behavior.

Those who want to run in a threaded environment should disable this option and eager load or require all there classes on initialization.

If cache_classes is disabled, dependency loaded will always be on.

eager_load_paths[RW]

An array of paths from which Rails will eager load on boot if cache classes is enabled. All elements of this array must also be in autoload_paths.

frameworks[RW]

The list of rails framework components that should be loaded. (Defaults to :active_record, :action_controller, :action_view, :action_mailer, and :active_resource).

gems[RW]

An array of gems that this rails application depends on. Rails will automatically load these gems during installation, and allow you to install any missing gems with:

rake gems:install

You can add gems with the gem method.

i18n[RW]

Accessor for i18n settings.

log_level[RW]

The log level to use for the default Rails logger. In production mode, this defaults to :info. In development mode, it defaults to :debug.

log_path[RW]

The path to the log file to use. Defaults to log/#{environment}.log (e.g. log/development.log or log/production.log).

logger[RW]

The specific logger to use. By default, a logger will be created and initialized using log_path and log_level, but a programmer may specifically set the logger to use via this accessor and it will be used directly.

metals[RW]

The list of metals to load. If this is set to nil, all metals will be loaded in alphabetical order. If this is set to [], no metals will be loaded. Otherwise metals will be loaded in the order specified

plugin_loader[RW]

The class that handles loading each plugin. Defaults to Rails::Plugin::Loader, but a sub class would have access to fine grained modification of the loading behavior. See the implementation of Rails::Plugin::Loader for more details.

plugin_locators[RW]

The classes that handle finding the desired plugins that you'd like to load for your application. By default it is the Rails::Plugin::FileSystemLocator which finds plugins to load in vendor/plugins. You can hook into gem location by subclassing Rails::Plugin::Locator and adding it onto the list of plugin_locators.

plugin_paths[RW]

The path to the root of the plugins directory. By default, it is in vendor/plugins.

plugins[R]

The list of plugins to load. If this is set to nil, all plugins will be loaded. If this is set to [], no plugins will be loaded. Otherwise, plugins will be loaded in the order specified.

preload_frameworks[RW]

Whether to preload all frameworks at startup.

reload_plugins[RW]

Enables or disables plugin reloading. You can get around this setting per plugin. If reload_plugins? is false, add this to your plugin's init.rb to make it reloadable:

ActiveSupport::Dependencies.autoload_once_paths.delete lib_path

If reload_plugins? is true, add this to your plugin's init.rb to only load it once:

ActiveSupport::Dependencies.autoload_once_paths << lib_path
root_path[R]

The application's base directory.

routes_configuration_file[RW]

The path to the routes configuration file to use. (Defaults to config/routes.rb.)

time_zone[RW]

Sets the default time_zone. Setting this will enable time_zone awareness for Active Record models and set the Active Record default timezone to :utc.

view_path[RW]

The root of the application's views. (Defaults to app/views.)

whiny_nils[RW]

Set to true if you want to be warned (noisily) when you try to invoke any method of nil. Set to false for the standard Ruby behavior.

Public Class Methods

new() click to toggle source

Create a new Configuration instance, initialized with the default values.

# File lib/initializer.rb, line 871
def initialize
  set_root_path!

  self.frameworks                   = default_frameworks
  self.autoload_paths               = default_autoload_paths
  self.autoload_once_paths          = default_autoload_once_paths
  self.eager_load_paths             = default_eager_load_paths
  self.log_path                     = default_log_path
  self.log_level                    = default_log_level
  self.view_path                    = default_view_path
  self.controller_paths             = default_controller_paths
  self.preload_frameworks           = default_preload_frameworks
  self.cache_classes                = default_cache_classes
  self.dependency_loading           = default_dependency_loading
  self.whiny_nils                   = default_whiny_nils
  self.plugins                      = default_plugins
  self.plugin_paths                 = default_plugin_paths
  self.plugin_locators              = default_plugin_locators
  self.plugin_loader                = default_plugin_loader
  self.database_configuration_file  = default_database_configuration_file
  self.routes_configuration_file    = default_routes_configuration_file
  self.gems                         = default_gems
  self.i18n                         = default_i18n

  for framework in default_frameworks
    self.send("#{framework}=", Rails::OrderedOptions.new)
  end
  self.active_support = Rails::OrderedOptions.new
end

Public Instance Methods

after_initialize(&after_initialize_block) click to toggle source

Adds a block which will be executed after rails has been fully initialized. Useful for per-environment configuration which depends on the framework being fully initialized.

# File lib/initializer.rb, line 956
def after_initialize(&after_initialize_block)
  after_initialize_blocks << after_initialize_block if after_initialize_block
end
after_initialize_blocks() click to toggle source

Returns the blocks added with Configuration#after_initialize

# File lib/initializer.rb, line 961
def after_initialize_blocks
  @after_initialize_blocks ||= []
end
breakpoint_server(_ = nil) click to toggle source

Deprecated options:

# File lib/initializer.rb, line 852
def breakpoint_server(_ = nil)
  $stderr.puts %(
  *******************************************************************
  * config.breakpoint_server has been deprecated and has no effect. *
  *******************************************************************
  )
end
Also aliased as: breakpoint_server=
breakpoint_server=(_ = nil) click to toggle source
Alias for: breakpoint_server
builtin_directories() click to toggle source
# File lib/initializer.rb, line 981
def builtin_directories
  # Include builtins only in the development environment.
  (environment == 'development') ? Dir["#{RAILTIES_PATH}/builtin/*/"] : []
end
database_configuration() click to toggle source

Loads and returns the contents of the database_configuration_file. The contents of the file are processed via ERB before being sent through YAML::load.

# File lib/initializer.rb, line 936
def database_configuration
  require 'erb'
  YAML::load(ERB.new(IO.read(database_configuration_file)).result)
end
environment() click to toggle source

Return the currently selected environment. By default, it returns the value of the RAILS_ENV constant.

# File lib/initializer.rb, line 949
def environment
  ::RAILS_ENV
end
environment_path() click to toggle source

The path to the current environment's file (development.rb, etc.). By default the file is at config/environments/#{environment}.rb.

# File lib/initializer.rb, line 943
def environment_path
  "#{root_path}/config/environments/#{environment}.rb"
end
framework_paths() click to toggle source
# File lib/initializer.rb, line 986
def framework_paths
  paths = %(railties railties/lib activesupport/lib)
  paths << 'actionpack/lib' if frameworks.include?(:action_controller) || frameworks.include?(:action_view)

  [:active_record, :action_mailer, :active_resource, :action_web_service].each do |framework|
    paths << "#{framework.to_s.gsub('_', '')}/lib" if frameworks.include?(framework)
  end

  paths.map { |dir| "#{framework_root_path}/#{dir}" }.select { |dir| File.directory?(dir) }
end
gem(name, options = {}) click to toggle source

Adds a single Gem dependency to the rails application. By default, it will require the library with the same name as the gem. Use :lib to specify a different name.

# gem 'aws-s3', '>= 0.4.0'
# require 'aws/s3'
config.gem 'aws-s3', :lib => 'aws/s3', :version => '>= 0.4.0', \
  :source => "http://code.whytheluckystiff.net"

To require a library be installed, but not attempt to load it, pass :lib => false

config.gem 'qrp', :version => '0.4.1', :lib => false
# File lib/initializer.rb, line 847
def gem(name, options = {})
  @gems << Rails::GemDependency.new(name, options)
end
load_once_paths() click to toggle source

Deprecated, use autoload_once_paths.

# File lib/initializer.rb, line 730
def load_once_paths
  $stderr.puts("config.load_once_paths is deprecated and removed in Rails 3, please use autoload_once_paths instead")
  autoload_once_paths
end
load_once_paths=(paths) click to toggle source

Deprecated, use autoload_once_paths=.

# File lib/initializer.rb, line 736
def load_once_paths=(paths)
  $stderr.puts("config.load_once_paths= is deprecated and removed in Rails 3, please use autoload_once_paths= instead")
  self.autoload_once_paths = paths
end
load_paths() click to toggle source

Deprecated, use autoload_paths.

# File lib/initializer.rb, line 714
def load_paths
  $stderr.puts("config.load_paths is deprecated and removed in Rails 3, please use autoload_paths instead")
  autoload_paths
end
load_paths=(paths) click to toggle source

Deprecated, use autoload_paths=.

# File lib/initializer.rb, line 720
def load_paths=(paths)
  $stderr.puts("config.load_paths= is deprecated and removed in Rails 3, please use autoload_paths= instead")
  self.autoload_paths = paths
end
middleware() click to toggle source
# File lib/initializer.rb, line 976
def middleware
  require 'action_controller'
  ActionController::Dispatcher.middleware
end
plugins=(plugins) click to toggle source
# File lib/initializer.rb, line 775
def plugins=(plugins)
  @plugins = plugins.nil? ? nil : plugins.map { |p| p.to_sym }
end
reload_plugins?() click to toggle source

Returns true if plugin reloading is enabled.

# File lib/initializer.rb, line 813
def reload_plugins?
  !!@reload_plugins
end
set_root_path!() click to toggle source

Set the root_path to RAILS_ROOT and canonicalize it.

# File lib/initializer.rb, line 902
def set_root_path!
  raise 'RAILS_ROOT is not set' unless defined?(::RAILS_ROOT)
  raise 'RAILS_ROOT is not a directory' unless File.directory?(::RAILS_ROOT)

  @root_path =
    # Pathname is incompatible with Windows, but Windows doesn't have
    # real symlinks so File.expand_path is safe.
    if RUBY_PLATFORM =~ /(:?mswin|mingw)/
      File.expand_path(::RAILS_ROOT)

    # Otherwise use Pathname#realpath which respects symlinks.
    else
      Pathname.new(::RAILS_ROOT).realpath.to_s
    end

  Object.const_set(:RELATIVE_RAILS_ROOT, ::RAILS_ROOT.dup) unless defined?(::RELATIVE_RAILS_ROOT)
  ::RAILS_ROOT.replace @root_path
end
threadsafe!() click to toggle source

Enable threaded mode. Allows concurrent requests to controller actions and multiple database connections. Also disables automatic dependency loading after boot, and disables reloading code on every request, as these are fundamentally incompatible with thread safety.

# File lib/initializer.rb, line 925
def threadsafe!
  self.preload_frameworks = true
  self.cache_classes = true
  self.dependency_loading = false
  self.action_controller.allow_concurrency = true
  self
end
to_prepare(&callback) click to toggle source

Add a preparation callback that will run before every request in development mode, or before the first request in production.

See Dispatcher#to_prepare.

# File lib/initializer.rb, line 969
def to_prepare(&callback)
  after_initialize do
    require 'dispatcher' unless defined?(::Dispatcher)
    Dispatcher.to_prepare(&callback)
  end
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.