aboutsummaryrefslogtreecommitdiffstats
path: root/railties/lib
diff options
context:
space:
mode:
authorYehuda Katz + Carl Lerche <ykatz+clerche@engineyard.com>2009-06-18 17:44:35 -0700
committerYehuda Katz + Carl Lerche <ykatz+clerche@engineyard.com>2009-06-23 14:49:03 -0700
commita3309e4d70101ec1b32064a99042622c43619d09 (patch)
tree56c286cc67bd0ecc8f64eee676df6fbea5217b9b /railties/lib
parent99b8248f6e83b87fc7f09e43a11c68aebcb2712e (diff)
downloadrails-a3309e4d70101ec1b32064a99042622c43619d09.tar.gz
rails-a3309e4d70101ec1b32064a99042622c43619d09.tar.bz2
rails-a3309e4d70101ec1b32064a99042622c43619d09.zip
Started making progress on implementing a new initializer.
Class.any_instance.expects(:require).raises(LoadError) ... w0t
Diffstat (limited to 'railties/lib')
-rw-r--r--railties/lib/initializer.rb1434
-rw-r--r--railties/lib/initializer_old.rb1137
2 files changed, 1585 insertions, 986 deletions
diff --git a/railties/lib/initializer.rb b/railties/lib/initializer.rb
index 1aa71c31b5..55fef30dbe 100644
--- a/railties/lib/initializer.rb
+++ b/railties/lib/initializer.rb
@@ -1,1137 +1,599 @@
-require 'logger'
-require 'set'
-require 'pathname'
-
-$LOAD_PATH.unshift File.dirname(__FILE__)
-require 'railties_path'
-require 'rails/version'
-require 'rails/gem_dependency'
-require 'rails/rack'
-
-RAILS_ENV = (ENV['RAILS_ENV'] || 'development').dup unless defined?(RAILS_ENV)
-
module Rails
- class << self
- # The Configuration instance used to configure the Rails environment
- def configuration
- @@configuration
- end
-
- def configuration=(configuration)
- @@configuration = configuration
- end
+ class Configuration
+ attr_accessor :cache_classes, :load_paths, :eager_load_paths, :framework_paths,
+ :load_once_paths, :gems_dependencies_loaded, :after_initialize_blocks,
+ :frameworks, :framework_root_path, :root_path
- def initialized?
- @initialized || false
+ def initialize
+ @framework_paths = []
+ @load_once_paths = []
+ @after_initialize_blocks = []
+ @frameworks = []
end
- def initialized=(initialized)
- @initialized ||= initialized
+ def after_initialize(&blk)
+ @after_initialize_blocks << blk if blk
end
- def logger
- if defined?(RAILS_DEFAULT_LOGGER)
- RAILS_DEFAULT_LOGGER
- else
- nil
- end
- end
+ def framework_paths
+ paths = %w(railties railties/lib activesupport/lib)
+ paths << 'actionpack/lib' if frameworks.include?(:action_controller) || frameworks.include?(:action_view)
- def backtrace_cleaner
- @@backtrace_cleaner ||= begin
- # Relies on ActiveSupport, so we have to lazy load to postpone definition until AS has been loaded
- require 'rails/backtrace_cleaner'
- Rails::BacktraceCleaner.new
+ [:active_record, :action_mailer, :active_resource, :action_web_service].each do |framework|
+ paths << "#{framework.to_s.gsub('_', '')}/lib" if frameworks.include?(framework)
end
- end
- def root
- Pathname.new(RAILS_ROOT) if defined?(RAILS_ROOT)
- end
-
- def env
- @_env ||= ActiveSupport::StringInquirer.new(RAILS_ENV)
- end
-
- def cache
- RAILS_CACHE
- end
-
- def version
- VERSION::STRING
- end
-
- def public_path
- @@public_path ||= self.root ? File.join(self.root, "public") : "public"
+ paths.map { |dir| "#{framework_root_path}/#{dir}" }.select { |dir| File.directory?(dir) }
end
- def public_path=(path)
- @@public_path = path
+ def framework_root_path
+ defined?(::RAILS_FRAMEWORK_ROOT) ? ::RAILS_FRAMEWORK_ROOT : "#{root_path}/vendor/rails"
end
end
- # The Initializer is responsible for processing the Rails configuration, such
- # as setting the $LOAD_PATH, requiring the right frameworks, initializing
- # logging, and more. It can be run either as a single command that'll just
- # use the default configuration, like this:
- #
- # Rails::Initializer.run
- #
- # But normally it's more interesting to pass in a custom configuration
- # through the block running:
- #
- # Rails::Initializer.run do |config|
- # config.frameworks -= [ :action_mailer ]
- # end
- #
- # This will use the default configuration options from Rails::Configuration,
- # but allow for overwriting on select areas.
class Initializer
- # The Configuration instance used by this Initializer instance.
- attr_reader :configuration
-
- # The set of loaded plugins.
- attr_reader :loaded_plugins
-
- # Whether or not all the gem dependencies have been met
- attr_reader :gems_dependencies_loaded
-
- # Runs the initializer. By default, this will invoke the #process method,
- # which simply executes all of the initialization routines. Alternately,
- # you can specify explicitly which initialization routine you want:
- #
- # Rails::Initializer.run(:set_load_path)
- #
- # This is useful if you only want the load path initialized, without
- # incurring the overhead of completely loading the entire environment.
- def self.run(command = :process, configuration = Configuration.new)
- yield configuration if block_given?
- initializer = new configuration
- initializer.send(command)
- initializer
- end
-
- # Create a new Initializer instance that references the given Configuration
- # instance.
- def initialize(configuration)
- @configuration = configuration
- @loaded_plugins = []
- end
-
- # Sequentially step through all of the available initialization routines,
- # in order (view execution order in source).
- def process
- Rails.configuration = configuration
-
- check_ruby_version
- install_gem_spec_stubs
- set_load_path
- add_gem_load_paths
-
- require_frameworks
- set_autoload_paths
- add_plugin_load_paths
- load_environment
- preload_frameworks
-
- initialize_encoding
- initialize_database
-
- initialize_cache
- initialize_framework_caches
-
- initialize_logger
- initialize_framework_logging
+ class Error < StandardError ; end
- initialize_dependency_mechanism
- initialize_whiny_nils
-
- initialize_time_zone
- initialize_i18n
-
- initialize_framework_settings
- initialize_framework_views
-
- initialize_metal
-
- add_support_load_paths
-
- check_for_unbuilt_gems
-
- load_gems
- load_plugins
-
- # pick up any gems that plugins depend on
- add_gem_load_paths
- load_gems
- check_gem_dependencies
-
- # bail out if gems are missing - note that check_gem_dependencies will have
- # already called abort() unless $gems_rake_task is set
- return unless gems_dependencies_loaded
-
- load_application_initializers
-
- # the framework is now fully initialized
- after_initialize
-
- # Setup database middleware after initializers have run
- initialize_database_middleware
-
- # Prepare dispatcher callbacks and run 'prepare' callbacks
- prepare_dispatcher
-
- # Routing must be initialized after plugins to allow the former to extend the routes
- initialize_routing
-
- # Observers are loaded after plugins in case Observers or observed models are modified by plugins.
- load_observers
-
- # Load view path cache
- load_view_paths
-
- # Load application classes
- load_application_classes
-
- # Disable dependency loading during request cycle
- disable_dependency_loading
-
- # Flag initialized
- Rails.initialized = true
- end
-
- # Check for valid Ruby version
- # This is done in an external file, so we can use it
- # from the `rails` program as well without duplication.
- def check_ruby_version
- require 'ruby_version_check'
- end
-
- # If Rails is vendored and RubyGems is available, install stub GemSpecs
- # for Rails, Active Support, Active Record, Action Pack, Action Mailer, and
- # Active Resource. This allows Gem plugins to depend on Rails even when
- # the Gem version of Rails shouldn't be loaded.
- def install_gem_spec_stubs
- unless Rails.respond_to?(:vendor_rails?)
- abort %{Your config/boot.rb is outdated: Run "rake rails:update".}
- end
+ class Base
+ class << self
+ def run(&blk)
+ define_method(:run, &blk)
+ end
- if Rails.vendor_rails?
- begin; require "rubygems"; rescue LoadError; return; end
+ def config=(config)
+ @@config = config
+ end
- stubs = %w(rails activesupport activerecord actionpack actionmailer activeresource)
- stubs.reject! { |s| Gem.loaded_specs.key?(s) }
+ def config
+ @@config
+ end
+ alias configuration config
- stubs.each do |stub|
- Gem.loaded_specs[stub] = Gem::Specification.new do |s|
- s.name = stub
- s.version = Rails::VERSION::STRING
- s.loaded_from = ""
- end
+ def gems_dependencies_loaded
+ config.gems_dependencies_loaded
end
end
- end
-
- # Set the <tt>$LOAD_PATH</tt> based on the value of
- # Configuration#load_paths. Duplicates are removed.
- def set_load_path
- load_paths = configuration.load_paths + configuration.framework_paths
- load_paths.reverse_each { |dir| $LOAD_PATH.unshift(dir) if File.directory?(dir) }
- $LOAD_PATH.uniq!
- end
-
- # Set the paths from which Rails will automatically load source files, and
- # the load_once paths.
- def set_autoload_paths
- require 'active_support/dependencies'
- ActiveSupport::Dependencies.load_paths = configuration.load_paths.uniq
- ActiveSupport::Dependencies.load_once_paths = configuration.load_once_paths.uniq
- extra = ActiveSupport::Dependencies.load_once_paths - ActiveSupport::Dependencies.load_paths
- unless extra.empty?
- abort <<-end_error
- load_once_paths must be a subset of the load_paths.
- Extra items in load_once_paths: #{extra * ','}
- end_error
+ def plugin_loader
+ @plugin_loader ||= configuration.plugin_loader.new(self)
end
- # Freeze the arrays so future modifications will fail rather than do nothing mysteriously
- configuration.load_once_paths.freeze
- end
-
- # Requires all frameworks specified by the Configuration#frameworks
- # list. By default, all frameworks (Active Record, Active Support,
- # Action Pack, Action Mailer, and Active Resource) are loaded.
- def require_frameworks
- require 'active_support/all'
- configuration.frameworks.each { |framework| require(framework.to_s) }
- rescue LoadError => e
- # Re-raise as RuntimeError because Mongrel would swallow LoadError.
- raise e.to_s
- end
-
- # Preload all frameworks specified by the Configuration#frameworks.
- # Used by Passenger to ensure everything's loaded before forking and
- # to avoid autoload race conditions in JRuby.
- def preload_frameworks
- if configuration.preload_frameworks
- configuration.frameworks.each do |framework|
- # String#classify and #constantize aren't available yet.
- toplevel = Object.const_get(framework.to_s.gsub(/(?:^|_)(.)/) { $1.upcase })
- toplevel.load_all! if toplevel.respond_to?(:load_all!)
- end
+ def gems_dependencies_loaded
+ self.class.gems_dependencies_loaded
end
end
- # Add the load paths used by support functions such as the info controller
- def add_support_load_paths
- end
-
- # Adds all load paths from plugins to the global set of load paths, so that
- # code from plugins can be required (explicitly or automatically via ActiveSupport::Dependencies).
- def add_plugin_load_paths
- require 'active_support/dependencies'
- plugin_loader.add_plugin_load_paths
- end
+ class Runner
- def add_gem_load_paths
- require 'rails/gem_dependency'
- Rails::GemDependency.add_frozen_gem_path
- unless @configuration.gems.empty?
- require "rubygems"
- @configuration.gems.each { |gem| gem.add_load_paths }
- end
- end
+ attr_reader :names, :initializers
+ attr_writer :config
- def load_gems
- unless $gems_rake_task
- @configuration.gems.each { |gem| gem.load }
+ def initialize(parent = nil)
+ @names = parent ? parent.names.dup : {}
+ @initializers = parent ? parent.initializers.dup : []
end
- end
- def check_for_unbuilt_gems
- unbuilt_gems = @configuration.gems.select {|gem| gem.frozen? && !gem.built? }
- if unbuilt_gems.size > 0
- # don't print if the gems:build rake tasks are being run
- unless $gems_build_rake_task
- abort <<-end_error
-The following gems have native components that need to be built
- #{unbuilt_gems.map { |gem| "#{gem.name} #{gem.requirement}" } * "\n "}
+ def add(name, options = {}, &block)
+ # If :before or :after is specified, set the index to the right spot
+ if other = options[:before] || options[:after]
+ raise Error, "The #{other.inspect} initializer does not exist" unless @names[other]
+ index = @initializers.index(@names[other])
+ index += 1 if options[:after]
+ end
-You're running:
- ruby #{Gem.ruby_version} at #{Gem.ruby}
- rubygems #{Gem::RubyGemsVersion} at #{Gem.path * ', '}
+ @initializers.insert(index || -1, block)
+ @names[name] = block
+ end
-Run `rake gems:build` to build the unbuilt gems.
- end_error
+ def delete(name)
+ @names[name].tap do |initializer|
+ @initializers.delete(initializer)
+ @names.delete(name)
end
end
- end
- def check_gem_dependencies
- unloaded_gems = @configuration.gems.reject { |g| g.loaded? }
- if unloaded_gems.size > 0
- @gems_dependencies_loaded = false
- # don't print if the gems rake tasks are being run
- unless $gems_rake_task
- abort <<-end_error
-Missing these required gems:
- #{unloaded_gems.map { |gem| "#{gem.name} #{gem.requirement}" } * "\n "}
+ def run_initializer(initializer)
+ init_block = initializer.is_a?(Proc) ? initializer : @names[initializer]
+ container = Class.new(Base, &init_block).new
+ container.run if container.respond_to?(:run)
+ end
-You're running:
- ruby #{Gem.ruby_version} at #{Gem.ruby}
- rubygems #{Gem::RubyGemsVersion} at #{Gem.path * ', '}
+ def run(initializer = nil)
+ Base.config = @config
-Run `rake gems:install` to install the missing gems.
- end_error
+ if initializer
+ run_initializer(initializer)
+ else
+ @initializers.each {|block| run_initializer(block) }
end
- else
- @gems_dependencies_loaded = true
end
end
- # Loads all plugins in <tt>config.plugin_paths</tt>. <tt>plugin_paths</tt>
- # defaults to <tt>vendor/plugins</tt> but may also be set to a list of
- # paths, such as
- # config.plugin_paths = ["#{RAILS_ROOT}/lib/plugins", "#{RAILS_ROOT}/vendor/plugins"]
- #
- # In the default implementation, as each plugin discovered in <tt>plugin_paths</tt> is initialized:
- # * its +lib+ directory, if present, is added to the load path (immediately after the applications lib directory)
- # * <tt>init.rb</tt> is evaluated, if present
- #
- # After all plugins are loaded, duplicates are removed from the load path.
- # If an array of plugin names is specified in config.plugins, only those plugins will be loaded
- # and they plugins will be loaded in that order. Otherwise, plugins are loaded in alphabetical
- # order.
- #
- # if config.plugins ends contains :all then the named plugins will be loaded in the given order and all other
- # plugins will be loaded in alphabetical order
- def load_plugins
- plugin_loader.load_plugins
+ def self.default
+ @default ||= Runner.new
end
- def plugin_loader
- @plugin_loader ||= configuration.plugin_loader.new(self)
+ def self.run(initializer = nil, config = nil)
+ default.config = config if config
+ default.run(initializer)
end
+ end
- # Loads the environment specified by Configuration#environment_path, which
- # is typically one of development, test, or production.
- def load_environment
- silence_warnings do
- return if @environment_loaded
- @environment_loaded = true
-
- config = configuration
- constants = self.class.constants
+ # Check for valid Ruby version (1.8.2 or 1.8.4 or higher). This is done in an
+ # external file, so we can use it from the `rails` program as well without duplication.
+ Initializer.default.add :check_ruby_version do
+ require 'ruby_version_check'
+ end
- eval(IO.read(configuration.environment_path), binding, configuration.environment_path)
+ Initializer.default.add :set_root_path do
+ raise 'RAILS_ROOT is not set' unless defined?(RAILS_ROOT)
+ raise 'RAILS_ROOT is not a directory' unless File.directory?(RAILS_ROOT)
- (self.class.constants - constants).each do |const|
- Object.const_set(const, self.class.const_get(const))
- end
- end
- end
+ configuration.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)
- def load_observers
- if gems_dependencies_loaded && configuration.frameworks.include?(:active_record)
- ActiveRecord::Base.instantiate_observers
- end
- end
-
- def load_view_paths
- if configuration.frameworks.include?(:action_view)
- if configuration.cache_classes
- view_path = ActionView::FileSystemResolverWithFallback.new(configuration.view_path)
- ActionController::Base.view_paths = view_path if configuration.frameworks.include?(:action_controller)
- ActionMailer::Base.template_root = view_path if configuration.frameworks.include?(:action_mailer)
- end
- end
- end
-
- # Eager load application classes
- def load_application_classes
- return if $rails_rake_task
- if configuration.cache_classes
- configuration.eager_load_paths.each do |load_path|
- matcher = /\A#{Regexp.escape(load_path)}(.*)\.rb\Z/
- Dir.glob("#{load_path}/**/*.rb").sort.each do |file|
- require_dependency file.sub(matcher, '\1')
- end
- end
- end
- end
-
- # For Ruby 1.8, this initialization sets $KCODE to 'u' to enable the
- # multibyte safe operations. Plugin authors supporting other encodings
- # should override this behaviour and set the relevant +default_charset+
- # on ActionController::Base.
- #
- # For Ruby 1.9, UTF-8 is the default internal and external encoding.
- def initialize_encoding
- if RUBY_VERSION < '1.9'
- $KCODE='u'
+ # Otherwise use Pathname#realpath which respects symlinks.
else
- Encoding.default_internal = Encoding::UTF_8
- Encoding.default_external = Encoding::UTF_8
+ Pathname.new(RAILS_ROOT).realpath.to_s
end
- end
- # This initialization routine does nothing unless <tt>:active_record</tt>
- # is one of the frameworks to load (Configuration#frameworks). If it is,
- # this sets the database configuration from Configuration#database_configuration
- # and then establishes the connection.
- def initialize_database
- if configuration.frameworks.include?(:active_record)
- ActiveRecord::Base.configurations = configuration.database_configuration
- ActiveRecord::Base.establish_connection
- end
- end
+ RAILS_ROOT.replace configuration.root_path
+ end
- def initialize_database_middleware
- if configuration.frameworks.include?(:active_record)
- if configuration.frameworks.include?(:action_controller) &&
- ActionController::Base.session_store.name == 'ActiveRecord::SessionStore'
- configuration.middleware.insert_before :"ActiveRecord::SessionStore", ActiveRecord::ConnectionAdapters::ConnectionManagement
- configuration.middleware.insert_before :"ActiveRecord::SessionStore", ActiveRecord::QueryCache
- else
- configuration.middleware.use ActiveRecord::ConnectionAdapters::ConnectionManagement
- configuration.middleware.use ActiveRecord::QueryCache
- end
- end
+ # If Rails is vendored and RubyGems is available, install stub GemSpecs
+ # for Rails, Active Support, Active Record, Action Pack, Action Mailer, and
+ # Active Resource. This allows Gem plugins to depend on Rails even when
+ # the Gem version of Rails shouldn't be loaded.
+ Initializer.default.add :install_gem_spec_stubs do
+ unless Rails.respond_to?(:vendor_rails?)
+ abort %{Your config/boot.rb is outdated: Run "rake rails:update".}
end
- def initialize_cache
- unless defined?(RAILS_CACHE)
- silence_warnings { Object.const_set "RAILS_CACHE", ActiveSupport::Cache.lookup_store(configuration.cache_store) }
+ if Rails.vendor_rails?
+ begin; require "rubygems"; rescue LoadError; return; end
- if RAILS_CACHE.respond_to?(:middleware)
- # Insert middleware to setup and teardown local cache for each request
- configuration.middleware.insert_after(:"Rack::Lock", RAILS_CACHE.middleware)
- end
- end
- end
+ stubs = %w(rails activesupport activerecord actionpack actionmailer activeresource)
+ stubs.reject! { |s| Gem.loaded_specs.key?(s) }
- def initialize_framework_caches
- if configuration.frameworks.include?(:action_controller)
- ActionController::Base.cache_store ||= RAILS_CACHE
- end
- end
-
- # If the RAILS_DEFAULT_LOGGER constant is already set, this initialization
- # routine does nothing. If the constant is not set, and Configuration#logger
- # is not +nil+, this also does nothing. Otherwise, a new logger instance
- # is created at Configuration#log_path, with a default log level of
- # Configuration#log_level.
- #
- # If the log could not be created, the log will be set to output to
- # +STDERR+, with a log level of +WARN+.
- def initialize_logger
- # if the environment has explicitly defined a logger, use it
- return if Rails.logger
-
- unless logger = configuration.logger
- begin
- logger = ActiveSupport::BufferedLogger.new(configuration.log_path)
- logger.level = ActiveSupport::BufferedLogger.const_get(configuration.log_level.to_s.upcase)
- if configuration.environment == "production"
- logger.auto_flushing = false
- end
- rescue StandardError => e
- logger = ActiveSupport::BufferedLogger.new(STDERR)
- logger.level = ActiveSupport::BufferedLogger::WARN
- logger.warn(
- "Rails Error: Unable to access log file. Please ensure that #{configuration.log_path} exists and is chmod 0666. " +
- "The log level has been raised to WARN and the output directed to STDERR until the problem is fixed."
- )
+ stubs.each do |stub|
+ Gem.loaded_specs[stub] = Gem::Specification.new do |s|
+ s.name = stub
+ s.version = Rails::VERSION::STRING
+ s.loaded_from = ""
end
end
-
- silence_warnings { Object.const_set "RAILS_DEFAULT_LOGGER", logger }
end
+ end
- # Sets the logger for Active Record, Action Controller, and Action Mailer
- # (but only for those frameworks that are to be loaded). If the framework's
- # logger is already set, it is not changed, otherwise it is set to use
- # RAILS_DEFAULT_LOGGER.
- def initialize_framework_logging
- for framework in ([ :active_record, :action_controller, :action_mailer ] & configuration.frameworks)
- framework.to_s.camelize.constantize.const_get("Base").logger ||= Rails.logger
- end
+ # Set the <tt>$LOAD_PATH</tt> based on the value of
+ # Configuration#load_paths. Duplicates are removed.
+ Initializer.default.add :set_load_path do
+ load_paths = configuration.load_paths + configuration.framework_paths
+ load_paths.reverse_each { |dir| $LOAD_PATH.unshift(dir) if File.directory?(dir) }
+ $LOAD_PATH.uniq!
+ end
- ActiveSupport::Dependencies.logger ||= Rails.logger
- Rails.cache.logger ||= Rails.logger
+ Initializer.default.add :add_gem_load_paths do
+ require 'rails/gem_dependency'
+ Rails::GemDependency.add_frozen_gem_path
+ unless @configuration.gems.empty?
+ require "rubygems"
+ @configuration.gems.each { |gem| gem.add_load_paths }
end
+ end
- # Sets +ActionController::Base#view_paths+ and +ActionMailer::Base#template_root+
- # (but only for those frameworks that are to be loaded). If the framework's
- # paths have already been set, it is not changed, otherwise it is
- # set to use Configuration#view_path.
- def initialize_framework_views
- if configuration.frameworks.include?(:action_view)
- view_path = ActionView::PathSet.type_cast(configuration.view_path)
- ActionMailer::Base.template_root = view_path if configuration.frameworks.include?(:action_mailer) && ActionMailer::Base.view_paths.blank?
- ActionController::Base.view_paths = view_path if configuration.frameworks.include?(:action_controller) && ActionController::Base.view_paths.blank?
- end
+ # Requires all frameworks specified by the Configuration#frameworks
+ # list. By default, all frameworks (Active Record, Active Support,
+ # Action Pack, Action Mailer, and Active Resource) are loaded.
+ Initializer.default.add :require_frameworks do
+ begin
+ require 'active_support/all'
+ configuration.frameworks.each { |framework| require(framework.to_s) }
+ rescue LoadError => e
+ # Re-raise as RuntimeError because Mongrel would swallow LoadError.
+ raise e.to_s
end
+ end
- # If Action Controller is not one of the loaded frameworks (Configuration#frameworks)
- # this does nothing. Otherwise, it loads the routing definitions and sets up
- # loading module used to lazily load controllers (Configuration#controller_paths).
- def initialize_routing
- return unless configuration.frameworks.include?(:action_controller)
+ # Set the paths from which Rails will automatically load source files, and
+ # the load_once paths.
+ Initializer.default.add :set_autoload_paths do
+ require 'active_support/dependencies'
+ ActiveSupport::Dependencies.load_paths = configuration.load_paths.uniq
+ ActiveSupport::Dependencies.load_once_paths = configuration.load_once_paths.uniq
- ActionController::Routing.controller_paths += configuration.controller_paths
- ActionController::Routing::Routes.add_configuration_file(configuration.routes_configuration_file)
- ActionController::Routing::Routes.reload!
+ extra = ActiveSupport::Dependencies.load_once_paths - ActiveSupport::Dependencies.load_paths
+ unless extra.empty?
+ abort <<-end_error
+ load_once_paths must be a subset of the load_paths.
+ Extra items in load_once_paths: #{extra * ','}
+ end_error
end
- # Sets the dependency loading mechanism based on the value of
- # Configuration#cache_classes.
- def initialize_dependency_mechanism
- ActiveSupport::Dependencies.mechanism = configuration.cache_classes ? :require : :load
- end
+ # Freeze the arrays so future modifications will fail rather than do nothing mysteriously
+ configuration.load_once_paths.freeze
+ end
- # Loads support for "whiny nil" (noisy warnings when methods are invoked
- # on +nil+ values) if Configuration#whiny_nils is true.
- def initialize_whiny_nils
- require('active_support/whiny_nil') if configuration.whiny_nils
- end
+ # Adds all load paths from plugins to the global set of load paths, so that
+ # code from plugins can be required (explicitly or automatically via ActiveSupport::Dependencies).
+ Initializer.default.add :add_plugin_load_paths do
+ require 'active_support/dependencies'
+ plugin_loader.add_plugin_load_paths
+ end
- # Sets the default value for Time.zone, and turns on ActiveRecord::Base#time_zone_aware_attributes.
- # If assigned value cannot be matched to a TimeZone, an exception will be raised.
- def initialize_time_zone
- if configuration.time_zone
- zone_default = Time.__send__(:get_zone, configuration.time_zone)
+ # Loads the environment specified by Configuration#environment_path, which
+ # is typically one of development, test, or production.
+ Initializer.default.add :load_environment do
+ silence_warnings do
+ return if @environment_loaded
+ @environment_loaded = true
- unless zone_default
- raise \
- 'Value assigned to config.time_zone not recognized.' +
- 'Run "rake -D time" for a list of tasks for finding appropriate time zone names.'
- end
+ config = configuration
+ constants = self.class.constants
- Time.zone_default = zone_default
+ eval(IO.read(configuration.environment_path), binding, configuration.environment_path)
- if configuration.frameworks.include?(:active_record)
- ActiveRecord::Base.time_zone_aware_attributes = true
- ActiveRecord::Base.default_timezone = :utc
- end
+ (self.class.constants - constants).each do |const|
+ Object.const_set(const, self.class.const_get(const))
end
end
+ end
- # Set the i18n configuration from config.i18n but special-case for the load_path which should be
- # appended to what's already set instead of overwritten.
- def initialize_i18n
- configuration.i18n.each do |setting, value|
- if setting == :load_path
- I18n.load_path += value
- else
- I18n.send("#{setting}=", value)
- end
+ # Preload all frameworks specified by the Configuration#frameworks.
+ # Used by Passenger to ensure everything's loaded before forking and
+ # to avoid autoload race conditions in JRuby.
+ Initializer.default.add :preload_frameworks do
+ if configuration.preload_frameworks
+ configuration.frameworks.each do |framework|
+ # String#classify and #constantize aren't available yet.
+ toplevel = Object.const_get(framework.to_s.gsub(/(?:^|_)(.)/) { $1.upcase })
+ toplevel.load_all! if toplevel.respond_to?(:load_all!)
end
end
+ end
- def initialize_metal
- Rails::Rack::Metal.requested_metals = configuration.metals
- Rails::Rack::Metal.metal_paths += plugin_loader.engine_metal_paths
+ # For Ruby 1.8, this initialization sets $KCODE to 'u' to enable the
+ # multibyte safe operations. Plugin authors supporting other encodings
+ # should override this behaviour and set the relevant +default_charset+
+ # on ActionController::Base.
+ #
+ # For Ruby 1.9, UTF-8 is the default internal and external encoding.
+ Initializer.default.add :initialize_encoding do
+ if RUBY_VERSION < '1.9'
+ $KCODE='u'
+ else
+ Encoding.default_internal = Encoding::UTF_8
+ Encoding.default_external = Encoding::UTF_8
+ end
+ end
- configuration.middleware.insert_before(
- :"ActionDispatch::ParamsParser",
- Rails::Rack::Metal, :if => Rails::Rack::Metal.metals.any?)
+ # This initialization routine does nothing unless <tt>:active_record</tt>
+ # is one of the frameworks to load (Configuration#frameworks). If it is,
+ # this sets the database configuration from Configuration#database_configuration
+ # and then establishes the connection.
+ Initializer.default.add :initialize_database do
+ if configuration.frameworks.include?(:active_record)
+ ActiveRecord::Base.configurations = configuration.database_configuration
+ ActiveRecord::Base.establish_connection
end
+ end
- # Initializes framework-specific settings for each of the loaded frameworks
- # (Configuration#frameworks). The available settings map to the accessors
- # on each of the corresponding Base classes.
- def initialize_framework_settings
- configuration.frameworks.each do |framework|
- base_class = framework.to_s.camelize.constantize.const_get("Base")
+ Initializer.default.add :initialize_cache do
+ unless defined?(RAILS_CACHE)
+ silence_warnings { Object.const_set "RAILS_CACHE", ActiveSupport::Cache.lookup_store(configuration.cache_store) }
- configuration.send(framework).each do |setting, value|
- base_class.send("#{setting}=", value)
- end
- end
- configuration.active_support.each do |setting, value|
- ActiveSupport.send("#{setting}=", value)
+ if RAILS_CACHE.respond_to?(:middleware)
+ # Insert middleware to setup and teardown local cache for each request
+ configuration.middleware.insert_after(:"Rack::Lock", RAILS_CACHE.middleware)
end
end
+ end
- # Fires the user-supplied after_initialize block (Configuration#after_initialize)
- def after_initialize
- if gems_dependencies_loaded
- configuration.after_initialize_blocks.each do |block|
- block.call
- end
- end
+ Initializer.default.add :initialize_framework_caches do
+ if configuration.frameworks.include?(:action_controller)
+ ActionController::Base.cache_store ||= RAILS_CACHE
end
+ end
- def load_application_initializers
- if gems_dependencies_loaded
- Dir["#{configuration.root_path}/config/initializers/**/*.rb"].sort.each do |initializer|
- load(initializer)
+ Initializer.default.add :initialize_logger do
+ # if the environment has explicitly defined a logger, use it
+ next if Rails.logger
+
+ unless logger = configuration.logger
+ begin
+ logger = ActiveSupport::BufferedLogger.new(configuration.log_path)
+ logger.level = ActiveSupport::BufferedLogger.const_get(configuration.log_level.to_s.upcase)
+ if configuration.environment == "production"
+ logger.auto_flushing = false
end
+ rescue StandardError => e
+ logger = ActiveSupport::BufferedLogger.new(STDERR)
+ logger.level = ActiveSupport::BufferedLogger::WARN
+ logger.warn(
+ "Rails Error: Unable to access log file. Please ensure that #{configuration.log_path} exists and is chmod 0666. " +
+ "The log level has been raised to WARN and the output directed to STDERR until the problem is fixed."
+ )
end
end
- def prepare_dispatcher
- return unless configuration.frameworks.include?(:action_controller)
- require 'dispatcher' unless defined?(::Dispatcher)
- Dispatcher.define_dispatcher_callbacks(configuration.cache_classes)
- end
-
- def disable_dependency_loading
- if configuration.cache_classes && !configuration.dependency_loading
- ActiveSupport::Dependencies.unhook!
- end
- end
+ silence_warnings { Object.const_set "RAILS_DEFAULT_LOGGER", logger }
end
- # 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)
- class Configuration
- # The application's base directory.
- attr_reader :root_path
-
- # A stub for setting options on ActionController::Base.
- attr_accessor :action_controller
-
- # A stub for setting options on ActionMailer::Base.
- attr_accessor :action_mailer
-
- # A stub for setting options on ActionView::Base.
- attr_accessor :action_view
-
- # A stub for setting options on ActiveRecord::Base.
- attr_accessor :active_record
-
- # A stub for setting options on ActiveResource::Base.
- attr_accessor :active_resource
-
- # A stub for setting options on ActiveSupport.
- attr_accessor :active_support
-
- # Whether to preload all frameworks at startup.
- attr_accessor :preload_frameworks
-
- # Whether or not classes should be cached (set to false if you want
- # application classes to be reloaded on each request)
- attr_accessor :cache_classes
-
- # The list of paths that should be searched for controllers. (Defaults
- # to <tt>app/controllers</tt>.)
- attr_accessor :controller_paths
-
- # The path to the database configuration file to use. (Defaults to
- # <tt>config/database.yml</tt>.)
- attr_accessor :database_configuration_file
-
- # The path to the routes configuration file to use. (Defaults to
- # <tt>config/routes.rb</tt>.)
- attr_accessor :routes_configuration_file
-
- # The list of rails framework components that should be loaded. (Defaults
- # to <tt>:active_record</tt>, <tt>:action_controller</tt>,
- # <tt>:action_view</tt>, <tt>:action_mailer</tt>, and
- # <tt>:active_resource</tt>).
- attr_accessor :frameworks
-
- # 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.
- attr_accessor :load_paths
-
- # An array of paths from which Rails will automatically load from only once.
- # All elements of this array must also be in +load_paths+.
- attr_accessor :load_once_paths
-
- # 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+.
- attr_accessor :eager_load_paths
-
- # The log level to use for the default Rails logger. In production mode,
- # this defaults to <tt>:info</tt>. In development mode, it defaults to
- # <tt>:debug</tt>.
- attr_accessor :log_level
+ # Sets the logger for Active Record, Action Controller, and Action Mailer
+ # (but only for those frameworks that are to be loaded). If the framework's
+ # logger is already set, it is not changed, otherwise it is set to use
+ # RAILS_DEFAULT_LOGGER.
+ Initializer.default.add :initialize_framework_logging do
+ for framework in ([ :active_record, :action_controller, :action_mailer ] & configuration.frameworks)
+ framework.to_s.camelize.constantize.const_get("Base").logger ||= Rails.logger
+ end
- # The path to the log file to use. Defaults to log/#{environment}.log
- # (e.g. log/development.log or log/production.log).
- attr_accessor :log_path
+ ActiveSupport::Dependencies.logger ||= Rails.logger
+ Rails.cache.logger ||= Rails.logger
+ end
- # 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.
- attr_accessor :logger
+ # Sets the dependency loading mechanism based on the value of
+ # Configuration#cache_classes.
+ Initializer.default.add :initialize_dependency_mechanism do
+ ActiveSupport::Dependencies.mechanism = configuration.cache_classes ? :require : :load
+ end
- # The specific cache store to use. By default, the ActiveSupport::Cache::Store will be used.
- attr_accessor :cache_store
+ # Loads support for "whiny nil" (noisy warnings when methods are invoked
+ # on +nil+ values) if Configuration#whiny_nils is true.
+ Initializer.default.add :initialize_whiny_nils do
+ require('active_support/whiny_nil') if configuration.whiny_nils
+ end
- # The root of the application's views. (Defaults to <tt>app/views</tt>.)
- attr_accessor :view_path
- # 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.
- attr_accessor :whiny_nils
+ # Sets the default value for Time.zone, and turns on ActiveRecord::Base#time_zone_aware_attributes.
+ # If assigned value cannot be matched to a TimeZone, an exception will be raised.
+ Initializer.default.add :initialize_time_zone do
+ if configuration.time_zone
+ zone_default = Time.__send__(:get_zone, configuration.time_zone)
- # The list of plugins to load. If this is set to <tt>nil</tt>, all plugins will
- # be loaded. If this is set to <tt>[]</tt>, no plugins will be loaded. Otherwise,
- # plugins will be loaded in the order specified.
- attr_reader :plugins
- def plugins=(plugins)
- @plugins = plugins.nil? ? nil : plugins.map { |p| p.to_sym }
- end
+ unless zone_default
+ raise \
+ 'Value assigned to config.time_zone not recognized.' +
+ 'Run "rake -D time" for a list of tasks for finding appropriate time zone names.'
+ end
- # The list of metals to load. If this is set to <tt>nil</tt>, all metals will
- # be loaded in alphabetical order. If this is set to <tt>[]</tt>, no metals will
- # be loaded. Otherwise metals will be loaded in the order specified
- attr_accessor :metals
-
- # The path to the root of the plugins directory. By default, it is in
- # <tt>vendor/plugins</tt>.
- attr_accessor :plugin_paths
-
- # 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 <tt>vendor/plugins</tt>. You can hook into gem location by subclassing
- # Rails::Plugin::Locator and adding it onto the list of <tt>plugin_locators</tt>.
- attr_accessor :plugin_locators
-
- # 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.
- attr_accessor :plugin_loader
-
- # Enables or disables plugin reloading. You can get around this setting per plugin.
- # If <tt>reload_plugins?</tt> is false, add this to your plugin's <tt>init.rb</tt>
- # to make it reloadable:
- #
- # ActiveSupport::Dependencies.load_once_paths.delete lib_path
- #
- # If <tt>reload_plugins?</tt> is true, add this to your plugin's <tt>init.rb</tt>
- # to only load it once:
- #
- # ActiveSupport::Dependencies.load_once_paths << lib_path
- #
- attr_accessor :reload_plugins
-
- # Returns true if plugin reloading is enabled.
- def reload_plugins?
- !!@reload_plugins
- end
+ Time.zone_default = zone_default
- # Enables or disables dependency loading during the request cycle. Setting
- # <tt>dependency_loading</tt> 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 <tt>cache_classes</tt> is disabled, dependency loaded will always be
- # on.
- attr_accessor :dependency_loading
-
- # 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.
- attr_accessor :gems
-
- # 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
- def gem(name, options = {})
- @gems << Rails::GemDependency.new(name, options)
+ if configuration.frameworks.include?(:active_record)
+ ActiveRecord::Base.time_zone_aware_attributes = true
+ ActiveRecord::Base.default_timezone = :utc
+ end
end
+ end
- # Deprecated options:
- def breakpoint_server(_ = nil)
- $stderr.puts %(
- *******************************************************************
- * config.breakpoint_server has been deprecated and has no effect. *
- *******************************************************************
- )
+ # Set the i18n configuration from config.i18n but special-case for the load_path which should be
+ # appended to what's already set instead of overwritten.
+ Initializer.default.add :initialize_i18n do
+ configuration.i18n.each do |setting, value|
+ if setting == :load_path
+ I18n.load_path += value
+ else
+ I18n.send("#{setting}=", value)
+ end
end
- alias_method :breakpoint_server=, :breakpoint_server
-
- # Sets the default +time_zone+. Setting this will enable +time_zone+
- # awareness for Active Record models and set the Active Record default
- # timezone to <tt>:utc</tt>.
- attr_accessor :time_zone
+ end
- # Accessor for i18n settings.
- attr_accessor :i18n
+ # Initializes framework-specific settings for each of the loaded frameworks
+ # (Configuration#frameworks). The available settings map to the accessors
+ # on each of the corresponding Base classes.
+ Initializer.default.add :initialize_framework_settings do
+ configuration.frameworks.each do |framework|
+ base_class = framework.to_s.camelize.constantize.const_get("Base")
- # Create a new Configuration instance, initialized with the default
- # values.
- def initialize
- set_root_path!
-
- self.frameworks = default_frameworks
- self.load_paths = default_load_paths
- self.load_once_paths = default_load_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)
+ configuration.send(framework).each do |setting, value|
+ base_class.send("#{setting}=", value)
end
- self.active_support = Rails::OrderedOptions.new
end
-
- # Set the root_path to RAILS_ROOT and canonicalize it.
- 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
+ configuration.active_support.each do |setting, value|
+ ActiveSupport.send("#{setting}=", value)
end
+ 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.
- def threadsafe!
- self.preload_frameworks = true
- self.cache_classes = true
- self.dependency_loading = false
- self.action_controller.allow_concurrency = true
- self
+ # Sets +ActionController::Base#view_paths+ and +ActionMailer::Base#template_root+
+ # (but only for those frameworks that are to be loaded). If the framework's
+ # paths have already been set, it is not changed, otherwise it is
+ # set to use Configuration#view_path.
+ Initializer.default.add :initialize_framework_views do
+ if configuration.frameworks.include?(:action_view)
+ view_path = ActionView::PathSet.type_cast(configuration.view_path)
+ ActionMailer::Base.template_root = view_path if configuration.frameworks.include?(:action_mailer) && ActionMailer::Base.view_paths.blank?
+ ActionController::Base.view_paths = view_path if configuration.frameworks.include?(:action_controller) && ActionController::Base.view_paths.blank?
end
+ 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.
- def database_configuration
- require 'erb'
- YAML::load(ERB.new(IO.read(database_configuration_file)).result)
- end
+ Initializer.default.add :initialize_metal do
+ Rails::Rack::Metal.requested_metals = configuration.metals
+ Rails::Rack::Metal.metal_paths += plugin_loader.engine_metal_paths
- # The path to the current environment's file (<tt>development.rb</tt>, etc.). By
- # default the file is at <tt>config/environments/#{environment}.rb</tt>.
- def environment_path
- "#{root_path}/config/environments/#{environment}.rb"
- end
+ configuration.middleware.insert_before(
+ :"ActionDispatch::ParamsParser",
+ Rails::Rack::Metal, :if => Rails::Rack::Metal.metals.any?)
+ end
- # Return the currently selected environment. By default, it returns the
- # value of the RAILS_ENV constant.
- def environment
- ::RAILS_ENV
- end
+ # Add the load paths used by support functions such as the info controller
+ Initializer.default.add :add_support_load_paths do
+ end
- # 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.
- def after_initialize(&after_initialize_block)
- after_initialize_blocks << after_initialize_block if after_initialize_block
- end
+ Initializer.default.add :check_for_unbuilt_gems do
+ unbuilt_gems = @configuration.gems.select {|gem| gem.frozen? && !gem.built? }
+ if unbuilt_gems.size > 0
+ # don't print if the gems:build rake tasks are being run
+ unless $gems_build_rake_task
+ abort <<-end_error
+The following gems have native components that need to be built
+#{unbuilt_gems.map { |gemm| "#{gemm.name} #{gemm.requirement}" } * "\n "}
- # Returns the blocks added with Configuration#after_initialize
- def after_initialize_blocks
- @after_initialize_blocks ||= []
- end
+You're running:
+ruby #{Gem.ruby_version} at #{Gem.ruby}
+rubygems #{Gem::RubyGemsVersion} at #{Gem.path * ', '}
- # Add a preparation callback that will run before every request in development
- # mode, or before the first request in production.
- #
- # See Dispatcher#to_prepare.
- def to_prepare(&callback)
- after_initialize do
- require 'dispatcher' unless defined?(::Dispatcher)
- Dispatcher.to_prepare(&callback)
+Run `rake gems:build` to build the unbuilt gems.
+ end_error
end
end
+ end
- def middleware
- require 'action_controller'
- ActionController::Dispatcher.middleware
- end
-
- def builtin_directories
- # Include builtins only in the development environment.
- (environment == 'development') ? Dir["#{RAILTIES_PATH}/builtin/*/"] : []
+ Initializer.default.add :load_gems do
+ unless $gems_rake_task
+ @configuration.gems.each { |gem| gem.load }
end
+ end
- def framework_paths
- paths = %w(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
+ # Loads all plugins in <tt>config.plugin_paths</tt>. <tt>plugin_paths</tt>
+ # defaults to <tt>vendor/plugins</tt> but may also be set to a list of
+ # paths, such as
+ # config.plugin_paths = ["#{RAILS_ROOT}/lib/plugins", "#{RAILS_ROOT}/vendor/plugins"]
+ #
+ # In the default implementation, as each plugin discovered in <tt>plugin_paths</tt> is initialized:
+ # * its +lib+ directory, if present, is added to the load path (immediately after the applications lib directory)
+ # * <tt>init.rb</tt> is evaluated, if present
+ #
+ # After all plugins are loaded, duplicates are removed from the load path.
+ # If an array of plugin names is specified in config.plugins, only those plugins will be loaded
+ # and they plugins will be loaded in that order. Otherwise, plugins are loaded in alphabetical
+ # order.
+ #
+ # if config.plugins ends contains :all then the named plugins will be loaded in the given order and all other
+ # plugins will be loaded in alphabetical order
+ Initializer.default.add :load_plugins do
+ plugin_loader.load_plugins
+ end
- paths.map { |dir| "#{framework_root_path}/#{dir}" }.select { |dir| File.directory?(dir) }
+ #
+ # # pick up any gems that plugins depend on
+ Initializer.default.add :add_gem_load_paths do
+ require 'rails/gem_dependency'
+ Rails::GemDependency.add_frozen_gem_path
+ unless @configuration.gems.empty?
+ require "rubygems"
+ @configuration.gems.each { |gem| gem.add_load_paths }
end
+ end
- private
- def framework_root_path
- defined?(::RAILS_FRAMEWORK_ROOT) ? ::RAILS_FRAMEWORK_ROOT : "#{root_path}/vendor/rails"
- end
-
- def default_frameworks
- [ :active_record, :action_controller, :action_view, :action_mailer, :active_resource ]
- end
-
- def default_load_paths
- paths = []
-
- # Add the old mock paths only if the directories exists
- paths.concat(Dir["#{root_path}/test/mocks/#{environment}"]) if File.exists?("#{root_path}/test/mocks/#{environment}")
-
- # Add the app's controller directory
- paths.concat(Dir["#{root_path}/app/controllers/"])
-
- # Followed by the standard includes.
- paths.concat %w(
- app
- app/metal
- app/models
- app/controllers
- app/helpers
- app/services
- lib
- vendor
- ).map { |dir| "#{root_path}/#{dir}" }.select { |dir| File.directory?(dir) }
-
- paths.concat builtin_directories
- end
-
- # Doesn't matter since plugins aren't in load_paths yet.
- def default_load_once_paths
- []
- end
-
- def default_eager_load_paths
- %w(
- app/metal
- app/models
- app/controllers
- app/helpers
- ).map { |dir| "#{root_path}/#{dir}" }.select { |dir| File.directory?(dir) }
- end
-
- def default_log_path
- File.join(root_path, 'log', "#{environment}.log")
- end
-
- def default_log_level
- environment == 'production' ? :info : :debug
- end
-
- def default_database_configuration_file
- File.join(root_path, 'config', 'database.yml')
- end
-
- def default_routes_configuration_file
- File.join(root_path, 'config', 'routes.rb')
- end
-
- def default_view_path
- File.join(root_path, 'app', 'views')
- end
-
- def default_controller_paths
- paths = [File.join(root_path, 'app', 'controllers')]
- paths.concat builtin_directories
- paths
- end
-
- def default_dependency_loading
- true
- end
-
- def default_preload_frameworks
- false
- end
+ # TODO: Figure out if this needs to run a second time
+ # load_gems
- def default_cache_classes
- true
- end
-
- def default_whiny_nils
- false
- end
+ Initializer.default.add :check_gem_dependencies do
+ unloaded_gems = @configuration.gems.reject { |g| g.loaded? }
+ if unloaded_gems.size > 0
+ configuration.gems_dependencies_loaded = false
+ # don't print if the gems rake tasks are being run
+ unless $gems_rake_task
+ abort <<-end_error
+Missing these required gems:
+#{unloaded_gems.map { |gemm| "#{gemm.name} #{gemm.requirement}" } * "\n "}
- def default_plugins
- nil
- end
+You're running:
+ruby #{Gem.ruby_version} at #{Gem.ruby}
+rubygems #{Gem::RubyGemsVersion} at #{Gem.path * ', '}
- def default_plugin_paths
- ["#{root_path}/vendor/plugins"]
+Run `rake gems:install` to install the missing gems.
+ end_error
end
+ else
+ configuration.gems_dependencies_loaded = true
+ end
+ end
- def default_plugin_locators
- require 'rails/plugin/locator'
- locators = []
- locators << Plugin::GemLocator if defined? Gem
- locators << Plugin::FileSystemLocator
- end
+ # # bail out if gems are missing - note that check_gem_dependencies will have
+ # # already called abort() unless $gems_rake_task is set
+ # return unless gems_dependencies_loaded
- def default_plugin_loader
- require 'rails/plugin/loader'
- Plugin::Loader
+ Initializer.default.add :load_application_initializers do
+ if gems_dependencies_loaded
+ Dir["#{configuration.root_path}/config/initializers/**/*.rb"].sort.each do |initializer|
+ load(initializer)
end
+ end
+ end
- def default_cache_store
- if File.exist?("#{root_path}/tmp/cache/")
- [ :file_store, "#{root_path}/tmp/cache/" ]
- else
- :memory_store
- end
+ # Fires the user-supplied after_initialize block (Configuration#after_initialize)
+ Initializer.default.add :after_initialize do
+ if gems_dependencies_loaded
+ configuration.after_initialize_blocks.each do |block|
+ block.call
end
+ end
+ end
- def default_gems
- []
+ # # Setup database middleware after initializers have run
+ Initializer.default.add :initialize_database_middleware do
+ if configuration.frameworks.include?(:active_record)
+ if configuration.frameworks.include?(:action_controller) &&
+ ActionController::Base.session_store.name == 'ActiveRecord::SessionStore'
+ configuration.middleware.insert_before :"ActiveRecord::SessionStore", ActiveRecord::ConnectionAdapters::ConnectionManagement
+ configuration.middleware.insert_before :"ActiveRecord::SessionStore", ActiveRecord::QueryCache
+ else
+ configuration.middleware.use ActiveRecord::ConnectionAdapters::ConnectionManagement
+ configuration.middleware.use ActiveRecord::QueryCache
end
+ end
+ end
- def default_i18n
- i18n = Rails::OrderedOptions.new
- i18n.load_path = []
- if File.exist?(File.join(RAILS_ROOT, 'config', 'locales'))
- i18n.load_path << Dir[File.join(RAILS_ROOT, 'config', 'locales', '*.{rb,yml}')]
- i18n.load_path.flatten!
- end
+ # # Prepare dispatcher callbacks and run 'prepare' callbacks
+ Initializer.default.add :prepare_dispatcher do
+ return unless configuration.frameworks.include?(:action_controller)
+ require 'dispatcher' unless defined?(::Dispatcher)
+ Dispatcher.define_dispatcher_callbacks(configuration.cache_classes)
+ end
- i18n
- end
+ # Routing must be initialized after plugins to allow the former to extend the routes
+ # ---
+ # If Action Controller is not one of the loaded frameworks (Configuration#frameworks)
+ # this does nothing. Otherwise, it loads the routing definitions and sets up
+ # loading module used to lazily load controllers (Configuration#controller_paths).
+ Initializer.default.add :initialize_routing do
+ return unless configuration.frameworks.include?(:action_controller)
+
+ ActionController::Routing.controller_paths += configuration.controller_paths
+ ActionController::Routing::Routes.add_configuration_file(configuration.routes_configuration_file)
+ ActionController::Routing::Routes.reload!
end
-end
-
-# Needs to be duplicated from Active Support since its needed before Active
-# Support is available. Here both Options and Hash are namespaced to prevent
-# conflicts with other implementations AND with the classes residing in Active Support.
-class Rails::OrderedOptions < Array #:nodoc:
- def []=(key, value)
- key = key.to_sym
-
- if pair = find_pair(key)
- pair.pop
- pair << value
- else
- self << [key, value]
+ #
+ # # Observers are loaded after plugins in case Observers or observed models are modified by plugins.
+ Initializer.default.add :load_observers do
+ if gems_dependencies_loaded && configuration.frameworks.include?(:active_record)
+ ActiveRecord::Base.instantiate_observers
end
end
- def [](key)
- pair = find_pair(key.to_sym)
- pair ? pair.last : nil
+ # # Load view path cache
+ Initializer.default.add :load_view_paths do
+ if configuration.frameworks.include?(:action_view)
+ if configuration.cache_classes
+ view_path = ActionView::FileSystemResolverWithFallback.new(configuration.view_path)
+ ActionController::Base.view_paths = view_path if configuration.frameworks.include?(:action_controller)
+ ActionMailer::Base.template_root = view_path if configuration.frameworks.include?(:action_mailer)
+ end
+ end
end
- def method_missing(name, *args)
- if name.to_s =~ /(.*)=$/
- self[$1.to_sym] = args.first
- else
- self[name]
+ # Eager load application classes
+ Initializer.default.add :load_application_classes do
+ return if $rails_rake_task
+ if configuration.cache_classes
+ configuration.eager_load_paths.each do |load_path|
+ matcher = /\A#{Regexp.escape(load_path)}(.*)\.rb\Z/
+ Dir.glob("#{load_path}/**/*.rb").sort.each do |file|
+ require_dependency file.sub(matcher, '\1')
+ end
+ end
end
end
- private
- def find_pair(key)
- self.each { |i| return i if i.first == key }
- return false
+ # Disable dependency loading during request cycle
+ Initializer.default.add :disable_dependency_loading do
+ if configuration.cache_classes && !configuration.dependency_loading
+ ActiveSupport::Dependencies.unhook!
end
-end
-
+ end
+end \ No newline at end of file
diff --git a/railties/lib/initializer_old.rb b/railties/lib/initializer_old.rb
new file mode 100644
index 0000000000..cee5c7bcb6
--- /dev/null
+++ b/railties/lib/initializer_old.rb
@@ -0,0 +1,1137 @@
+require 'logger'
+require 'set'
+require 'pathname'
+
+$LOAD_PATH.unshift File.dirname(__FILE__)
+require 'railties_path'
+require 'rails/version'
+require 'rails/gem_dependency'
+require 'rails/rack'
+
+RAILS_ENV = (ENV['RAILS_ENV'] || 'development').dup unless defined?(RAILS_ENV)
+
+module Rails
+ class << self
+ # The Configuration instance used to configure the Rails environment
+ def configuration
+ @@configuration
+ end
+
+ def configuration=(configuration)
+ @@configuration = configuration
+ end
+
+ def initialized?
+ @initialized || false
+ end
+
+ def initialized=(initialized)
+ @initialized ||= initialized
+ end
+
+ def logger
+ if defined?(RAILS_DEFAULT_LOGGER)
+ RAILS_DEFAULT_LOGGER
+ else
+ nil
+ end
+ end
+
+ def backtrace_cleaner
+ @@backtrace_cleaner ||= begin
+ # Relies on ActiveSupport, so we have to lazy load to postpone definition until AS has been loaded
+ require 'rails/backtrace_cleaner'
+ Rails::BacktraceCleaner.new
+ end
+ end
+
+ def root
+ Pathname.new(RAILS_ROOT) if defined?(RAILS_ROOT)
+ end
+
+ def env
+ @_env ||= ActiveSupport::StringInquirer.new(RAILS_ENV)
+ end
+
+ def cache
+ RAILS_CACHE
+ end
+
+ def version
+ VERSION::STRING
+ end
+
+ def public_path
+ @@public_path ||= self.root ? File.join(self.root, "public") : "public"
+ end
+
+ def public_path=(path)
+ @@public_path = path
+ end
+ end
+
+ # The Initializer is responsible for processing the Rails configuration, such
+ # as setting the $LOAD_PATH, requiring the right frameworks, initializing
+ # logging, and more. It can be run either as a single command that'll just
+ # use the default configuration, like this:
+ #
+ # Rails::Initializer.run
+ #
+ # But normally it's more interesting to pass in a custom configuration
+ # through the block running:
+ #
+ # Rails::Initializer.run do |config|
+ # config.frameworks -= [ :action_mailer ]
+ # end
+ #
+ # This will use the default configuration options from Rails::Configuration,
+ # but allow for overwriting on select areas.
+ class Initializer
+ # The Configuration instance used by this Initializer instance.
+ attr_reader :configuration
+
+ # The set of loaded plugins.
+ attr_reader :loaded_plugins
+
+ # Whether or not all the gem dependencies have been met
+ attr_reader :gems_dependencies_loaded
+
+ # Runs the initializer. By default, this will invoke the #process method,
+ # which simply executes all of the initialization routines. Alternately,
+ # you can specify explicitly which initialization routine you want:
+ #
+ # Rails::Initializer.run(:set_load_path)
+ #
+ # This is useful if you only want the load path initialized, without
+ # incurring the overhead of completely loading the entire environment.
+ def self.run(command = :process, configuration = Configuration.new)
+ yield configuration if block_given?
+ initializer = new configuration
+ initializer.send(command)
+ initializer
+ end
+
+ # Create a new Initializer instance that references the given Configuration
+ # instance.
+ def initialize(configuration)
+ @configuration = configuration
+ @loaded_plugins = []
+ end
+
+ # Sequentially step through all of the available initialization routines,
+ # in order (view execution order in source).
+ def process
+ Rails.configuration = configuration
+
+ check_ruby_version
+ install_gem_spec_stubs
+ set_load_path
+ add_gem_load_paths
+
+ require_frameworks
+ set_autoload_paths
+ add_plugin_load_paths
+ load_environment
+ preload_frameworks
+
+ initialize_encoding
+ initialize_database
+
+ initialize_cache
+ initialize_framework_caches
+
+ initialize_logger
+ initialize_framework_logging
+
+ initialize_dependency_mechanism
+ initialize_whiny_nils
+
+ initialize_time_zone
+ initialize_i18n
+
+ initialize_framework_settings
+ initialize_framework_views
+
+ initialize_metal
+
+ add_support_load_paths
+
+ check_for_unbuilt_gems
+
+ load_gems
+ load_plugins
+
+ # pick up any gems that plugins depend on
+ add_gem_load_paths
+ load_gems
+ check_gem_dependencies
+
+ # bail out if gems are missing - note that check_gem_dependencies will have
+ # already called abort() unless $gems_rake_task is set
+ return unless gems_dependencies_loaded
+
+ load_application_initializers
+
+ # the framework is now fully initialized
+ after_initialize
+
+ # Setup database middleware after initializers have run
+ initialize_database_middleware
+
+ # Prepare dispatcher callbacks and run 'prepare' callbacks
+ prepare_dispatcher
+
+ # Routing must be initialized after plugins to allow the former to extend the routes
+ initialize_routing
+
+ # Observers are loaded after plugins in case Observers or observed models are modified by plugins.
+ load_observers
+
+ # Load view path cache
+ load_view_paths
+
+ # Load application classes
+ load_application_classes
+
+ # Disable dependency loading during request cycle
+ disable_dependency_loading
+
+ # Flag initialized
+ Rails.initialized = true
+ end
+
+ # Check for valid Ruby version
+ # This is done in an external file, so we can use it
+ # from the `rails` program as well without duplication.
+ def check_ruby_version
+ require 'ruby_version_check'
+ end
+
+ # If Rails is vendored and RubyGems is available, install stub GemSpecs
+ # for Rails, Active Support, Active Record, Action Pack, Action Mailer, and
+ # Active Resource. This allows Gem plugins to depend on Rails even when
+ # the Gem version of Rails shouldn't be loaded.
+ def install_gem_spec_stubs
+ unless Rails.respond_to?(:vendor_rails?)
+ abort %{Your config/boot.rb is outdated: Run "rake rails:update".}
+ end
+
+ if Rails.vendor_rails?
+ begin; require "rubygems"; rescue LoadError; return; end
+
+ stubs = %w(rails activesupport activerecord actionpack actionmailer activeresource)
+ stubs.reject! { |s| Gem.loaded_specs.key?(s) }
+
+ stubs.each do |stub|
+ Gem.loaded_specs[stub] = Gem::Specification.new do |s|
+ s.name = stub
+ s.version = Rails::VERSION::STRING
+ s.loaded_from = ""
+ end
+ end
+ end
+ end
+
+ # Set the <tt>$LOAD_PATH</tt> based on the value of
+ # Configuration#load_paths. Duplicates are removed.
+ def set_load_path
+ load_paths = configuration.load_paths + configuration.framework_paths
+ load_paths.reverse_each { |dir| $LOAD_PATH.unshift(dir) if File.directory?(dir) }
+ $LOAD_PATH.uniq!
+ end
+
+ # Set the paths from which Rails will automatically load source files, and
+ # the load_once paths.
+ def set_autoload_paths
+ require 'active_support/dependencies'
+ ActiveSupport::Dependencies.load_paths = configuration.load_paths.uniq
+ ActiveSupport::Dependencies.load_once_paths = configuration.load_once_paths.uniq
+
+ extra = ActiveSupport::Dependencies.load_once_paths - ActiveSupport::Dependencies.load_paths
+ unless extra.empty?
+ abort <<-end_error
+ load_once_paths must be a subset of the load_paths.
+ Extra items in load_once_paths: #{extra * ','}
+ end_error
+ end
+
+ # Freeze the arrays so future modifications will fail rather than do nothing mysteriously
+ configuration.load_once_paths.freeze
+ end
+
+ # Requires all frameworks specified by the Configuration#frameworks
+ # list. By default, all frameworks (Active Record, Active Support,
+ # Action Pack, Action Mailer, and Active Resource) are loaded.
+ def require_frameworks
+ require 'active_support/all'
+ configuration.frameworks.each { |framework| require(framework.to_s) }
+ rescue LoadError => e
+ # Re-raise as RuntimeError because Mongrel would swallow LoadError.
+ raise e.to_s
+ end
+
+ # Preload all frameworks specified by the Configuration#frameworks.
+ # Used by Passenger to ensure everything's loaded before forking and
+ # to avoid autoload race conditions in JRuby.
+ def preload_frameworks
+ if configuration.preload_frameworks
+ configuration.frameworks.each do |framework|
+ # String#classify and #constantize aren't available yet.
+ toplevel = Object.const_get(framework.to_s.gsub(/(?:^|_)(.)/) { $1.upcase })
+ toplevel.load_all! if toplevel.respond_to?(:load_all!)
+ end
+ end
+ end
+
+ # Add the load paths used by support functions such as the info controller
+ def add_support_load_paths
+ end
+
+ # Adds all load paths from plugins to the global set of load paths, so that
+ # code from plugins can be required (explicitly or automatically via ActiveSupport::Dependencies).
+ def add_plugin_load_paths
+ require 'active_support/dependencies'
+ plugin_loader.add_plugin_load_paths
+ end
+
+ def add_gem_load_paths
+ require 'rails/gem_dependency'
+ Rails::GemDependency.add_frozen_gem_path
+ unless @configuration.gems.empty?
+ require "rubygems"
+ @configuration.gems.each { |gem| gem.add_load_paths }
+ end
+ end
+
+ def load_gems
+ unless $gems_rake_task
+ @configuration.gems.each { |gem| gem.load }
+ end
+ end
+
+ def check_for_unbuilt_gems
+ unbuilt_gems = @configuration.gems.select {|gem| gem.frozen? && !gem.built? }
+ if unbuilt_gems.size > 0
+ # don't print if the gems:build rake tasks are being run
+ unless $gems_build_rake_task
+ abort <<-end_error
+The following gems have native components that need to be built
+ #{unbuilt_gems.map { |gemm| "#{gemm.name} #{gemm.requirement}" } * "\n "}
+
+You're running:
+ ruby #{Gem.ruby_version} at #{Gem.ruby}
+ rubygems #{Gem::RubyGemsVersion} at #{Gem.path * ', '}
+
+Run `rake gems:build` to build the unbuilt gems.
+ end_error
+ end
+ end
+ end
+
+ def check_gem_dependencies
+ unloaded_gems = @configuration.gems.reject { |g| g.loaded? }
+ if unloaded_gems.size > 0
+ @gems_dependencies_loaded = false
+ # don't print if the gems rake tasks are being run
+ unless $gems_rake_task
+ abort <<-end_error
+Missing these required gems:
+ #{unloaded_gems.map { |gemm| "#{gemm.name} #{gemm.requirement}" } * "\n "}
+
+You're running:
+ ruby #{Gem.ruby_version} at #{Gem.ruby}
+ rubygems #{Gem::RubyGemsVersion} at #{Gem.path * ', '}
+
+Run `rake gems:install` to install the missing gems.
+ end_error
+ end
+ else
+ @gems_dependencies_loaded = true
+ end
+ end
+
+ # Loads all plugins in <tt>config.plugin_paths</tt>. <tt>plugin_paths</tt>
+ # defaults to <tt>vendor/plugins</tt> but may also be set to a list of
+ # paths, such as
+ # config.plugin_paths = ["#{RAILS_ROOT}/lib/plugins", "#{RAILS_ROOT}/vendor/plugins"]
+ #
+ # In the default implementation, as each plugin discovered in <tt>plugin_paths</tt> is initialized:
+ # * its +lib+ directory, if present, is added to the load path (immediately after the applications lib directory)
+ # * <tt>init.rb</tt> is evaluated, if present
+ #
+ # After all plugins are loaded, duplicates are removed from the load path.
+ # If an array of plugin names is specified in config.plugins, only those plugins will be loaded
+ # and they plugins will be loaded in that order. Otherwise, plugins are loaded in alphabetical
+ # order.
+ #
+ # if config.plugins ends contains :all then the named plugins will be loaded in the given order and all other
+ # plugins will be loaded in alphabetical order
+ def load_plugins
+ plugin_loader.load_plugins
+ end
+
+ def plugin_loader
+ @plugin_loader ||= configuration.plugin_loader.new(self)
+ end
+
+ # Loads the environment specified by Configuration#environment_path, which
+ # is typically one of development, test, or production.
+ def load_environment
+ silence_warnings do
+ return if @environment_loaded
+ @environment_loaded = true
+
+ config = configuration
+ constants = self.class.constants
+
+ eval(IO.read(configuration.environment_path), binding, configuration.environment_path)
+
+ (self.class.constants - constants).each do |const|
+ Object.const_set(const, self.class.const_get(const))
+ end
+ end
+ end
+
+ def load_observers
+ if gems_dependencies_loaded && configuration.frameworks.include?(:active_record)
+ ActiveRecord::Base.instantiate_observers
+ end
+ end
+
+ def load_view_paths
+ if configuration.frameworks.include?(:action_view)
+ if configuration.cache_classes
+ view_path = ActionView::FileSystemResolverWithFallback.new(configuration.view_path)
+ ActionController::Base.view_paths = view_path if configuration.frameworks.include?(:action_controller)
+ ActionMailer::Base.template_root = view_path if configuration.frameworks.include?(:action_mailer)
+ end
+ end
+ end
+
+ # Eager load application classes
+ def load_application_classes
+ return if $rails_rake_task
+ if configuration.cache_classes
+ configuration.eager_load_paths.each do |load_path|
+ matcher = /\A#{Regexp.escape(load_path)}(.*)\.rb\Z/
+ Dir.glob("#{load_path}/**/*.rb").sort.each do |file|
+ require_dependency file.sub(matcher, '\1')
+ end
+ end
+ end
+ end
+
+ # For Ruby 1.8, this initialization sets $KCODE to 'u' to enable the
+ # multibyte safe operations. Plugin authors supporting other encodings
+ # should override this behaviour and set the relevant +default_charset+
+ # on ActionController::Base.
+ #
+ # For Ruby 1.9, UTF-8 is the default internal and external encoding.
+ def initialize_encoding
+ if RUBY_VERSION < '1.9'
+ $KCODE='u'
+ else
+ Encoding.default_internal = Encoding::UTF_8
+ Encoding.default_external = Encoding::UTF_8
+ end
+ end
+
+ # This initialization routine does nothing unless <tt>:active_record</tt>
+ # is one of the frameworks to load (Configuration#frameworks). If it is,
+ # this sets the database configuration from Configuration#database_configuration
+ # and then establishes the connection.
+ def initialize_database
+ if configuration.frameworks.include?(:active_record)
+ ActiveRecord::Base.configurations = configuration.database_configuration
+ ActiveRecord::Base.establish_connection
+ end
+ end
+
+ def initialize_database_middleware
+ if configuration.frameworks.include?(:active_record)
+ if configuration.frameworks.include?(:action_controller) &&
+ ActionController::Base.session_store.name == 'ActiveRecord::SessionStore'
+ configuration.middleware.insert_before :"ActiveRecord::SessionStore", ActiveRecord::ConnectionAdapters::ConnectionManagement
+ configuration.middleware.insert_before :"ActiveRecord::SessionStore", ActiveRecord::QueryCache
+ else
+ configuration.middleware.use ActiveRecord::ConnectionAdapters::ConnectionManagement
+ configuration.middleware.use ActiveRecord::QueryCache
+ end
+ end
+ end
+
+ def initialize_cache
+ unless defined?(RAILS_CACHE)
+ silence_warnings { Object.const_set "RAILS_CACHE", ActiveSupport::Cache.lookup_store(configuration.cache_store) }
+
+ if RAILS_CACHE.respond_to?(:middleware)
+ # Insert middleware to setup and teardown local cache for each request
+ configuration.middleware.insert_after(:"Rack::Lock", RAILS_CACHE.middleware)
+ end
+ end
+ end
+
+ def initialize_framework_caches
+ if configuration.frameworks.include?(:action_controller)
+ ActionController::Base.cache_store ||= RAILS_CACHE
+ end
+ end
+
+ # If the RAILS_DEFAULT_LOGGER constant is already set, this initialization
+ # routine does nothing. If the constant is not set, and Configuration#logger
+ # is not +nil+, this also does nothing. Otherwise, a new logger instance
+ # is created at Configuration#log_path, with a default log level of
+ # Configuration#log_level.
+ #
+ # If the log could not be created, the log will be set to output to
+ # +STDERR+, with a log level of +WARN+.
+ def initialize_logger
+ # if the environment has explicitly defined a logger, use it
+ return if Rails.logger
+
+ unless logger = configuration.logger
+ begin
+ logger = ActiveSupport::BufferedLogger.new(configuration.log_path)
+ logger.level = ActiveSupport::BufferedLogger.const_get(configuration.log_level.to_s.upcase)
+ if configuration.environment == "production"
+ logger.auto_flushing = false
+ end
+ rescue StandardError => e
+ logger = ActiveSupport::BufferedLogger.new(STDERR)
+ logger.level = ActiveSupport::BufferedLogger::WARN
+ logger.warn(
+ "Rails Error: Unable to access log file. Please ensure that #{configuration.log_path} exists and is chmod 0666. " +
+ "The log level has been raised to WARN and the output directed to STDERR until the problem is fixed."
+ )
+ end
+ end
+
+ silence_warnings { Object.const_set "RAILS_DEFAULT_LOGGER", logger }
+ end
+
+ # Sets the logger for Active Record, Action Controller, and Action Mailer
+ # (but only for those frameworks that are to be loaded). If the framework's
+ # logger is already set, it is not changed, otherwise it is set to use
+ # RAILS_DEFAULT_LOGGER.
+ def initialize_framework_logging
+ for framework in ([ :active_record, :action_controller, :action_mailer ] & configuration.frameworks)
+ framework.to_s.camelize.constantize.const_get("Base").logger ||= Rails.logger
+ end
+
+ ActiveSupport::Dependencies.logger ||= Rails.logger
+ Rails.cache.logger ||= Rails.logger
+ end
+
+ # Sets +ActionController::Base#view_paths+ and +ActionMailer::Base#template_root+
+ # (but only for those frameworks that are to be loaded). If the framework's
+ # paths have already been set, it is not changed, otherwise it is
+ # set to use Configuration#view_path.
+ def initialize_framework_views
+ if configuration.frameworks.include?(:action_view)
+ view_path = ActionView::PathSet.type_cast(configuration.view_path)
+ ActionMailer::Base.template_root = view_path if configuration.frameworks.include?(:action_mailer) && ActionMailer::Base.view_paths.blank?
+ ActionController::Base.view_paths = view_path if configuration.frameworks.include?(:action_controller) && ActionController::Base.view_paths.blank?
+ end
+ end
+
+ # If Action Controller is not one of the loaded frameworks (Configuration#frameworks)
+ # this does nothing. Otherwise, it loads the routing definitions and sets up
+ # loading module used to lazily load controllers (Configuration#controller_paths).
+ def initialize_routing
+ return unless configuration.frameworks.include?(:action_controller)
+
+ ActionController::Routing.controller_paths += configuration.controller_paths
+ ActionController::Routing::Routes.add_configuration_file(configuration.routes_configuration_file)
+ ActionController::Routing::Routes.reload!
+ end
+
+ # Sets the dependency loading mechanism based on the value of
+ # Configuration#cache_classes.
+ def initialize_dependency_mechanism
+ ActiveSupport::Dependencies.mechanism = configuration.cache_classes ? :require : :load
+ end
+
+ # Loads support for "whiny nil" (noisy warnings when methods are invoked
+ # on +nil+ values) if Configuration#whiny_nils is true.
+ def initialize_whiny_nils
+ require('active_support/whiny_nil') if configuration.whiny_nils
+ end
+
+ # Sets the default value for Time.zone, and turns on ActiveRecord::Base#time_zone_aware_attributes.
+ # If assigned value cannot be matched to a TimeZone, an exception will be raised.
+ def initialize_time_zone
+ if configuration.time_zone
+ zone_default = Time.__send__(:get_zone, configuration.time_zone)
+
+ unless zone_default
+ raise \
+ 'Value assigned to config.time_zone not recognized.' +
+ 'Run "rake -D time" for a list of tasks for finding appropriate time zone names.'
+ end
+
+ Time.zone_default = zone_default
+
+ if configuration.frameworks.include?(:active_record)
+ ActiveRecord::Base.time_zone_aware_attributes = true
+ ActiveRecord::Base.default_timezone = :utc
+ end
+ end
+ end
+
+ # Set the i18n configuration from config.i18n but special-case for the load_path which should be
+ # appended to what's already set instead of overwritten.
+ def initialize_i18n
+ configuration.i18n.each do |setting, value|
+ if setting == :load_path
+ I18n.load_path += value
+ else
+ I18n.send("#{setting}=", value)
+ end
+ end
+ end
+
+ def initialize_metal
+ Rails::Rack::Metal.requested_metals = configuration.metals
+ Rails::Rack::Metal.metal_paths += plugin_loader.engine_metal_paths
+
+ configuration.middleware.insert_before(
+ :"ActionDispatch::ParamsParser",
+ Rails::Rack::Metal, :if => Rails::Rack::Metal.metals.any?)
+ end
+
+ # Initializes framework-specific settings for each of the loaded frameworks
+ # (Configuration#frameworks). The available settings map to the accessors
+ # on each of the corresponding Base classes.
+ def initialize_framework_settings
+ configuration.frameworks.each do |framework|
+ base_class = framework.to_s.camelize.constantize.const_get("Base")
+
+ configuration.send(framework).each do |setting, value|
+ base_class.send("#{setting}=", value)
+ end
+ end
+ configuration.active_support.each do |setting, value|
+ ActiveSupport.send("#{setting}=", value)
+ end
+ end
+
+ # Fires the user-supplied after_initialize block (Configuration#after_initialize)
+ def after_initialize
+ if gems_dependencies_loaded
+ configuration.after_initialize_blocks.each do |block|
+ block.call
+ end
+ end
+ end
+
+ def load_application_initializers
+ if gems_dependencies_loaded
+ Dir["#{configuration.root_path}/config/initializers/**/*.rb"].sort.each do |initializer|
+ load(initializer)
+ end
+ end
+ end
+
+ def prepare_dispatcher
+ return unless configuration.frameworks.include?(:action_controller)
+ require 'dispatcher' unless defined?(::Dispatcher)
+ Dispatcher.define_dispatcher_callbacks(configuration.cache_classes)
+ end
+
+ def disable_dependency_loading
+ if configuration.cache_classes && !configuration.dependency_loading
+ ActiveSupport::Dependencies.unhook!
+ end
+ end
+ end
+
+ # 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)
+ class Configuration
+ # The application's base directory.
+ attr_reader :root_path
+
+ # A stub for setting options on ActionController::Base.
+ attr_accessor :action_controller
+
+ # A stub for setting options on ActionMailer::Base.
+ attr_accessor :action_mailer
+
+ # A stub for setting options on ActionView::Base.
+ attr_accessor :action_view
+
+ # A stub for setting options on ActiveRecord::Base.
+ attr_accessor :active_record
+
+ # A stub for setting options on ActiveResource::Base.
+ attr_accessor :active_resource
+
+ # A stub for setting options on ActiveSupport.
+ attr_accessor :active_support
+
+ # Whether to preload all frameworks at startup.
+ attr_accessor :preload_frameworks
+
+ # Whether or not classes should be cached (set to false if you want
+ # application classes to be reloaded on each request)
+ attr_accessor :cache_classes
+
+ # The list of paths that should be searched for controllers. (Defaults
+ # to <tt>app/controllers</tt>.)
+ attr_accessor :controller_paths
+
+ # The path to the database configuration file to use. (Defaults to
+ # <tt>config/database.yml</tt>.)
+ attr_accessor :database_configuration_file
+
+ # The path to the routes configuration file to use. (Defaults to
+ # <tt>config/routes.rb</tt>.)
+ attr_accessor :routes_configuration_file
+
+ # The list of rails framework components that should be loaded. (Defaults
+ # to <tt>:active_record</tt>, <tt>:action_controller</tt>,
+ # <tt>:action_view</tt>, <tt>:action_mailer</tt>, and
+ # <tt>:active_resource</tt>).
+ attr_accessor :frameworks
+
+ # 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.
+ attr_accessor :load_paths
+
+ # An array of paths from which Rails will automatically load from only once.
+ # All elements of this array must also be in +load_paths+.
+ attr_accessor :load_once_paths
+
+ # 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+.
+ attr_accessor :eager_load_paths
+
+ # The log level to use for the default Rails logger. In production mode,
+ # this defaults to <tt>:info</tt>. In development mode, it defaults to
+ # <tt>:debug</tt>.
+ attr_accessor :log_level
+
+ # The path to the log file to use. Defaults to log/#{environment}.log
+ # (e.g. log/development.log or log/production.log).
+ attr_accessor :log_path
+
+ # 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.
+ attr_accessor :logger
+
+ # The specific cache store to use. By default, the ActiveSupport::Cache::Store will be used.
+ attr_accessor :cache_store
+
+ # The root of the application's views. (Defaults to <tt>app/views</tt>.)
+ attr_accessor :view_path
+
+ # 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.
+ attr_accessor :whiny_nils
+
+ # The list of plugins to load. If this is set to <tt>nil</tt>, all plugins will
+ # be loaded. If this is set to <tt>[]</tt>, no plugins will be loaded. Otherwise,
+ # plugins will be loaded in the order specified.
+ attr_reader :plugins
+ def plugins=(plugins)
+ @plugins = plugins.nil? ? nil : plugins.map { |p| p.to_sym }
+ end
+
+ # The list of metals to load. If this is set to <tt>nil</tt>, all metals will
+ # be loaded in alphabetical order. If this is set to <tt>[]</tt>, no metals will
+ # be loaded. Otherwise metals will be loaded in the order specified
+ attr_accessor :metals
+
+ # The path to the root of the plugins directory. By default, it is in
+ # <tt>vendor/plugins</tt>.
+ attr_accessor :plugin_paths
+
+ # 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 <tt>vendor/plugins</tt>. You can hook into gem location by subclassing
+ # Rails::Plugin::Locator and adding it onto the list of <tt>plugin_locators</tt>.
+ attr_accessor :plugin_locators
+
+ # 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.
+ attr_accessor :plugin_loader
+
+ # Enables or disables plugin reloading. You can get around this setting per plugin.
+ # If <tt>reload_plugins?</tt> is false, add this to your plugin's <tt>init.rb</tt>
+ # to make it reloadable:
+ #
+ # ActiveSupport::Dependencies.load_once_paths.delete lib_path
+ #
+ # If <tt>reload_plugins?</tt> is true, add this to your plugin's <tt>init.rb</tt>
+ # to only load it once:
+ #
+ # ActiveSupport::Dependencies.load_once_paths << lib_path
+ #
+ attr_accessor :reload_plugins
+
+ # Returns true if plugin reloading is enabled.
+ def reload_plugins?
+ !!@reload_plugins
+ end
+
+ # Enables or disables dependency loading during the request cycle. Setting
+ # <tt>dependency_loading</tt> 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 <tt>cache_classes</tt> is disabled, dependency loaded will always be
+ # on.
+ attr_accessor :dependency_loading
+
+ # 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.
+ attr_accessor :gems
+
+ # 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
+ def gem(name, options = {})
+ @gems << Rails::GemDependency.new(name, options)
+ end
+
+ # Deprecated options:
+ def breakpoint_server(_ = nil)
+ $stderr.puts %(
+ *******************************************************************
+ * config.breakpoint_server has been deprecated and has no effect. *
+ *******************************************************************
+ )
+ end
+ alias_method :breakpoint_server=, :breakpoint_server
+
+ # Sets the default +time_zone+. Setting this will enable +time_zone+
+ # awareness for Active Record models and set the Active Record default
+ # timezone to <tt>:utc</tt>.
+ attr_accessor :time_zone
+
+ # Accessor for i18n settings.
+ attr_accessor :i18n
+
+ # Create a new Configuration instance, initialized with the default
+ # values.
+ def initialize
+ set_root_path!
+
+ self.frameworks = default_frameworks
+ self.load_paths = default_load_paths
+ self.load_once_paths = default_load_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
+
+ # Set the root_path to RAILS_ROOT and canonicalize it.
+ 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
+
+ # 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.
+ def threadsafe!
+ self.preload_frameworks = true
+ self.cache_classes = true
+ self.dependency_loading = false
+ self.action_controller.allow_concurrency = true
+ self
+ 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.
+ def database_configuration
+ require 'erb'
+ YAML::load(ERB.new(IO.read(database_configuration_file)).result)
+ end
+
+ # The path to the current environment's file (<tt>development.rb</tt>, etc.). By
+ # default the file is at <tt>config/environments/#{environment}.rb</tt>.
+ def environment_path
+ "#{root_path}/config/environments/#{environment}.rb"
+ end
+
+ # Return the currently selected environment. By default, it returns the
+ # value of the RAILS_ENV constant.
+ def environment
+ ::RAILS_ENV
+ end
+
+ # 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.
+ def after_initialize(&after_initialize_block)
+ after_initialize_blocks << after_initialize_block if after_initialize_block
+ end
+
+ # Returns the blocks added with Configuration#after_initialize
+ def after_initialize_blocks
+ @after_initialize_blocks ||= []
+ 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.
+ def to_prepare(&callback)
+ after_initialize do
+ require 'dispatcher' unless defined?(::Dispatcher)
+ Dispatcher.to_prepare(&callback)
+ end
+ end
+
+ def middleware
+ require 'action_controller'
+ ActionController::Dispatcher.middleware
+ end
+
+ def builtin_directories
+ # Include builtins only in the development environment.
+ (environment == 'development') ? Dir["#{RAILTIES_PATH}/builtin/*/"] : []
+ end
+
+ def framework_paths
+ paths = %w(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
+
+ private
+ def framework_root_path
+ defined?(::RAILS_FRAMEWORK_ROOT) ? ::RAILS_FRAMEWORK_ROOT : "#{root_path}/vendor/rails"
+ end
+
+ def default_frameworks
+ [ :active_record, :action_controller, :action_view, :action_mailer, :active_resource ]
+ end
+
+ def default_load_paths
+ paths = []
+
+ # Add the old mock paths only if the directories exists
+ paths.concat(Dir["#{root_path}/test/mocks/#{environment}"]) if File.exists?("#{root_path}/test/mocks/#{environment}")
+
+ # Add the app's controller directory
+ paths.concat(Dir["#{root_path}/app/controllers/"])
+
+ # Followed by the standard includes.
+ paths.concat %w(
+ app
+ app/metal
+ app/models
+ app/controllers
+ app/helpers
+ app/services
+ lib
+ vendor
+ ).map { |dir| "#{root_path}/#{dir}" }.select { |dir| File.directory?(dir) }
+
+ paths.concat builtin_directories
+ end
+
+ # Doesn't matter since plugins aren't in load_paths yet.
+ def default_load_once_paths
+ []
+ end
+
+ def default_eager_load_paths
+ %w(
+ app/metal
+ app/models
+ app/controllers
+ app/helpers
+ ).map { |dir| "#{root_path}/#{dir}" }.select { |dir| File.directory?(dir) }
+ end
+
+ def default_log_path
+ File.join(root_path, 'log', "#{environment}.log")
+ end
+
+ def default_log_level
+ environment == 'production' ? :info : :debug
+ end
+
+ def default_database_configuration_file
+ File.join(root_path, 'config', 'database.yml')
+ end
+
+ def default_routes_configuration_file
+ File.join(root_path, 'config', 'routes.rb')
+ end
+
+ def default_view_path
+ File.join(root_path, 'app', 'views')
+ end
+
+ def default_controller_paths
+ paths = [File.join(root_path, 'app', 'controllers')]
+ paths.concat builtin_directories
+ paths
+ end
+
+ def default_dependency_loading
+ true
+ end
+
+ def default_preload_frameworks
+ false
+ end
+
+ def default_cache_classes
+ true
+ end
+
+ def default_whiny_nils
+ false
+ end
+
+ def default_plugins
+ nil
+ end
+
+ def default_plugin_paths
+ ["#{root_path}/vendor/plugins"]
+ end
+
+ def default_plugin_locators
+ require 'rails/plugin/locator'
+ locators = []
+ locators << Plugin::GemLocator if defined? Gem
+ locators << Plugin::FileSystemLocator
+ end
+
+ def default_plugin_loader
+ require 'rails/plugin/loader'
+ Plugin::Loader
+ end
+
+ def default_cache_store
+ if File.exist?("#{root_path}/tmp/cache/")
+ [ :file_store, "#{root_path}/tmp/cache/" ]
+ else
+ :memory_store
+ end
+ end
+
+ def default_gems
+ []
+ end
+
+ def default_i18n
+ i18n = Rails::OrderedOptions.new
+ i18n.load_path = []
+
+ if File.exist?(File.join(RAILS_ROOT, 'config', 'locales'))
+ i18n.load_path << Dir[File.join(RAILS_ROOT, 'config', 'locales', '*.{rb,yml}')]
+ i18n.load_path.flatten!
+ end
+
+ i18n
+ end
+ end
+end
+
+# Needs to be duplicated from Active Support since its needed before Active
+# Support is available. Here both Options and Hash are namespaced to prevent
+# conflicts with other implementations AND with the classes residing in Active Support.
+class Rails::OrderedOptions < Array #:nodoc:
+ def []=(key, value)
+ key = key.to_sym
+
+ if pair = find_pair(key)
+ pair.pop
+ pair << value
+ else
+ self << [key, value]
+ end
+ end
+
+ def [](key)
+ pair = find_pair(key.to_sym)
+ pair ? pair.last : nil
+ end
+
+ def method_missing(name, *args)
+ if name.to_s =~ /(.*)=$/
+ self[$1.to_sym] = args.first
+ else
+ self[name]
+ end
+ end
+
+ private
+ def find_pair(key)
+ self.each { |i| return i if i.first == key }
+ return false
+ end
+end
+