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 and components.)
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.
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.
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 757
757:     def initialize
758:       set_root_path!
759: 
760:       self.frameworks                   = default_frameworks
761:       self.load_paths                   = default_load_paths
762:       self.load_once_paths              = default_load_once_paths
763:       self.eager_load_paths             = default_eager_load_paths
764:       self.log_path                     = default_log_path
765:       self.log_level                    = default_log_level
766:       self.view_path                    = default_view_path
767:       self.controller_paths             = default_controller_paths
768:       self.cache_classes                = default_cache_classes
769:       self.dependency_loading           = default_dependency_loading
770:       self.whiny_nils                   = default_whiny_nils
771:       self.plugins                      = default_plugins
772:       self.plugin_paths                 = default_plugin_paths
773:       self.plugin_locators              = default_plugin_locators
774:       self.plugin_loader                = default_plugin_loader
775:       self.database_configuration_file  = default_database_configuration_file
776:       self.routes_configuration_file    = default_routes_configuration_file
777:       self.gems                         = default_gems
778:       self.i18n                         = default_i18n
779: 
780:       for framework in default_frameworks
781:         self.send("#{framework}=", Rails::OrderedOptions.new)
782:       end
783:       self.active_support = Rails::OrderedOptions.new
784:     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 839
839:     def after_initialize(&after_initialize_block)
840:       after_initialize_blocks << after_initialize_block if after_initialize_block
841:     end

Returns the blocks added with Configuration#after_initialize

[Source]

     # File vendor/rails/railties/lib/initializer.rb, line 844
844:     def after_initialize_blocks
845:       @after_initialize_blocks ||= []
846:     end

Deprecated options:

[Source]

     # File vendor/rails/railties/lib/initializer.rb, line 738
738:     def breakpoint_server(_ = nil)
739:       $stderr.puts %(
740:       *******************************************************************
741:       * config.breakpoint_server has been deprecated and has no effect. *
742:       *******************************************************************
743:       )
744:     end
breakpoint_server=(_ = nil)

Alias for breakpoint_server

[Source]

     # File vendor/rails/railties/lib/initializer.rb, line 859
859:     def builtin_directories
860:       # Include builtins only in the development environment.
861:       (environment == 'development') ? Dir["#{RAILTIES_PATH}/builtin/*/"] : []
862:     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 819
819:     def database_configuration
820:       require 'erb'
821:       YAML::load(ERB.new(IO.read(database_configuration_file)).result)
822:     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 832
832:     def environment
833:       ::RAILS_ENV
834:     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 826
826:     def environment_path
827:       "#{root_path}/config/environments/#{environment}.rb"
828:     end

[Source]

     # File vendor/rails/railties/lib/initializer.rb, line 864
864:     def framework_paths
865:       paths = %w(railties railties/lib activesupport/lib)
866:       paths << 'actionpack/lib' if frameworks.include? :action_controller or frameworks.include? :action_view
867: 
868:       [:active_record, :action_mailer, :active_resource, :action_web_service].each do |framework|
869:         paths << "#{framework.to_s.gsub('_', '')}/lib" if frameworks.include? framework
870:       end
871: 
872:       paths.map { |dir| "#{framework_root_path}/#{dir}" }.select { |dir| File.directory?(dir) }
873:     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 733
733:     def gem(name, options = {})
734:       @gems << Rails::GemDependency.new(name, options)
735:     end

[Source]

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

Returns true if plugin reloading is enabled.

[Source]

     # File vendor/rails/railties/lib/initializer.rb, line 699
699:     def reload_plugins?
700:       !!@reload_plugins
701:     end

Set the root_path to RAILS_ROOT and canonicalize it.

[Source]

     # File vendor/rails/railties/lib/initializer.rb, line 787
787:     def set_root_path!
788:       raise 'RAILS_ROOT is not set' unless defined?(::RAILS_ROOT)
789:       raise 'RAILS_ROOT is not a directory' unless File.directory?(::RAILS_ROOT)
790: 
791:       @root_path =
792:         # Pathname is incompatible with Windows, but Windows doesn't have
793:         # real symlinks so File.expand_path is safe.
794:         if RUBY_PLATFORM =~ /(:?mswin|mingw)/
795:           File.expand_path(::RAILS_ROOT)
796: 
797:         # Otherwise use Pathname#realpath which respects symlinks.
798:         else
799:           Pathname.new(::RAILS_ROOT).realpath.to_s
800:         end
801: 
802:       Object.const_set(:RELATIVE_RAILS_ROOT, ::RAILS_ROOT.dup) unless defined?(::RELATIVE_RAILS_ROOT)
803:       ::RAILS_ROOT.replace @root_path
804:     end

Enable threaded mode. Allows concurrent requests to controller actions and multiple database connections. Also disables automatic dependency loading after boot

[Source]

     # File vendor/rails/railties/lib/initializer.rb, line 809
809:     def threadsafe!
810:       self.cache_classes = true
811:       self.dependency_loading = false
812:       self.action_controller.allow_concurrency = true
813:       self
814:     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 852
852:     def to_prepare(&callback)
853:       after_initialize do
854:         require 'dispatcher' unless defined?(::Dispatcher)
855:         Dispatcher.to_prepare(&callback)
856:       end
857:     end

[Validate]