Class Rails::Configuration
In: vendor/rails/railties/lib/initializer.rb
Parent: Object

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)

Methods

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.
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 load_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.
load_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 load_paths.
load_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.
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.load_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.load_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

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

[Source]

     # File vendor/rails/railties/lib/initializer.rb, line 838
838:     def initialize
839:       set_root_path!
840: 
841:       self.frameworks                   = default_frameworks
842:       self.load_paths                   = default_load_paths
843:       self.load_once_paths              = default_load_once_paths
844:       self.eager_load_paths             = default_eager_load_paths
845:       self.log_path                     = default_log_path
846:       self.log_level                    = default_log_level
847:       self.view_path                    = default_view_path
848:       self.controller_paths             = default_controller_paths
849:       self.preload_frameworks           = default_preload_frameworks
850:       self.cache_classes                = default_cache_classes
851:       self.dependency_loading           = default_dependency_loading
852:       self.whiny_nils                   = default_whiny_nils
853:       self.plugins                      = default_plugins
854:       self.plugin_paths                 = default_plugin_paths
855:       self.plugin_locators              = default_plugin_locators
856:       self.plugin_loader                = default_plugin_loader
857:       self.database_configuration_file  = default_database_configuration_file
858:       self.routes_configuration_file    = default_routes_configuration_file
859:       self.gems                         = default_gems
860:       self.i18n                         = default_i18n
861: 
862:       for framework in default_frameworks
863:         self.send("#{framework}=", Rails::OrderedOptions.new)
864:       end
865:       self.active_support = Rails::OrderedOptions.new
866:     end

Public Instance methods

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.

[Source]

     # File vendor/rails/railties/lib/initializer.rb, line 923
923:     def after_initialize(&after_initialize_block)
924:       after_initialize_blocks << after_initialize_block if after_initialize_block
925:     end

Returns the blocks added with Configuration#after_initialize

[Source]

     # File vendor/rails/railties/lib/initializer.rb, line 928
928:     def after_initialize_blocks
929:       @after_initialize_blocks ||= []
930:     end

Deprecated options:

[Source]

     # File vendor/rails/railties/lib/initializer.rb, line 819
819:     def breakpoint_server(_ = nil)
820:       $stderr.puts %(
821:       *******************************************************************
822:       * config.breakpoint_server has been deprecated and has no effect. *
823:       *******************************************************************
824:       )
825:     end
breakpoint_server=(_ = nil)

Alias for breakpoint_server

[Source]

     # File vendor/rails/railties/lib/initializer.rb, line 948
948:     def builtin_directories
949:       # Include builtins only in the development environment.
950:       (environment == 'development') ? Dir["#{RAILTIES_PATH}/builtin/*/"] : []
951:     end

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.

[Source]

     # File vendor/rails/railties/lib/initializer.rb, line 903
903:     def database_configuration
904:       require 'erb'
905:       YAML::load(ERB.new(IO.read(database_configuration_file)).result)
906:     end

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

[Source]

     # File vendor/rails/railties/lib/initializer.rb, line 916
916:     def environment
917:       ::RAILS_ENV
918:     end

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

[Source]

     # File vendor/rails/railties/lib/initializer.rb, line 910
910:     def environment_path
911:       "#{root_path}/config/environments/#{environment}.rb"
912:     end

[Source]

     # File vendor/rails/railties/lib/initializer.rb, line 953
953:     def framework_paths
954:       paths = %w(railties railties/lib activesupport/lib)
955:       paths << 'actionpack/lib' if frameworks.include?(:action_controller) || frameworks.include?(:action_view)
956: 
957:       [:active_record, :action_mailer, :active_resource, :action_web_service].each do |framework|
958:         paths << "#{framework.to_s.gsub('_', '')}/lib" if frameworks.include?(framework)
959:       end
960: 
961:       paths.map { |dir| "#{framework_root_path}/#{dir}" }.select { |dir| File.directory?(dir) }
962:     end

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

[Source]

     # File vendor/rails/railties/lib/initializer.rb, line 814
814:     def gem(name, options = {})
815:       @gems << Rails::GemDependency.new(name, options)
816:     end

[Source]

     # File vendor/rails/railties/lib/initializer.rb, line 943
943:     def middleware
944:       require 'action_controller'
945:       ActionController::Dispatcher.middleware
946:     end

[Source]

     # File vendor/rails/railties/lib/initializer.rb, line 742
742:     def plugins=(plugins)
743:       @plugins = plugins.nil? ? nil : plugins.map { |p| p.to_sym }
744:     end

Returns true if plugin reloading is enabled.

[Source]

     # File vendor/rails/railties/lib/initializer.rb, line 780
780:     def reload_plugins?
781:       !!@reload_plugins
782:     end

Set the root_path to RAILS_ROOT and canonicalize it.

[Source]

     # File vendor/rails/railties/lib/initializer.rb, line 869
869:     def set_root_path!
870:       raise 'RAILS_ROOT is not set' unless defined?(::RAILS_ROOT)
871:       raise 'RAILS_ROOT is not a directory' unless File.directory?(::RAILS_ROOT)
872: 
873:       @root_path =
874:         # Pathname is incompatible with Windows, but Windows doesn't have
875:         # real symlinks so File.expand_path is safe.
876:         if RUBY_PLATFORM =~ /(:?mswin|mingw)/
877:           File.expand_path(::RAILS_ROOT)
878: 
879:         # Otherwise use Pathname#realpath which respects symlinks.
880:         else
881:           Pathname.new(::RAILS_ROOT).realpath.to_s
882:         end
883: 
884:       Object.const_set(:RELATIVE_RAILS_ROOT, ::RAILS_ROOT.dup) unless defined?(::RELATIVE_RAILS_ROOT)
885:       ::RAILS_ROOT.replace @root_path
886:     end

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.

[Source]

     # File vendor/rails/railties/lib/initializer.rb, line 892
892:     def threadsafe!
893:       self.preload_frameworks = true
894:       self.cache_classes = true
895:       self.dependency_loading = false
896:       self.action_controller.allow_concurrency = true
897:       self
898:     end

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

See Dispatcher#to_prepare.

[Source]

     # File vendor/rails/railties/lib/initializer.rb, line 936
936:     def to_prepare(&callback)
937:       after_initialize do
938:         require 'dispatcher' unless defined?(::Dispatcher)
939:         Dispatcher.to_prepare(&callback)
940:       end
941:     end

[Validate]