2005-09-03 11:13:06 -04:00
|
|
|
require 'logger'
|
|
|
|
|
2005-09-29 08:37:44 -04:00
|
|
|
old_verbose, $VERBOSE = $VERBOSE, nil
|
2005-09-03 11:13:06 -04:00
|
|
|
RAILS_ENV = ENV['RAILS_ENV'] || 'development'
|
2005-09-29 08:37:44 -04:00
|
|
|
$VERBOSE = old_verbose
|
2005-09-03 11:13:06 -04:00
|
|
|
|
|
|
|
module Rails
|
2005-09-03 11:44:19 -04:00
|
|
|
# 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_web_service ]
|
|
|
|
# end
|
|
|
|
#
|
|
|
|
# This will use the default configuration options from Rails::Configuration, but allow for overwriting on select areas.
|
2005-09-03 11:13:06 -04:00
|
|
|
class Initializer
|
|
|
|
attr_reader :configuration
|
|
|
|
|
|
|
|
def self.run(command = :process, configuration = Configuration.new)
|
|
|
|
yield configuration if block_given?
|
|
|
|
new(configuration).send(command)
|
|
|
|
end
|
|
|
|
|
|
|
|
def initialize(configuration)
|
|
|
|
@configuration = configuration
|
|
|
|
end
|
|
|
|
|
|
|
|
def process
|
|
|
|
set_load_path
|
2005-09-15 02:40:39 -04:00
|
|
|
set_connection_adapters
|
2005-09-03 11:13:06 -04:00
|
|
|
|
|
|
|
require_frameworks
|
2005-09-13 05:58:16 -04:00
|
|
|
load_environment
|
2005-09-03 11:13:06 -04:00
|
|
|
|
|
|
|
initialize_database
|
|
|
|
initialize_logger
|
|
|
|
initialize_framework_logging
|
2005-09-03 11:44:19 -04:00
|
|
|
initialize_framework_views
|
2005-09-03 11:13:06 -04:00
|
|
|
initialize_routing
|
2005-09-13 05:58:16 -04:00
|
|
|
initialize_dependency_mechanism
|
|
|
|
initialize_breakpoints
|
|
|
|
initialize_whiny_nils
|
|
|
|
|
|
|
|
intitialize_framework_settings
|
|
|
|
|
|
|
|
# Support for legacy configuration style where the environment
|
|
|
|
# could overwrite anything set from the defaults/global through
|
|
|
|
# the individual base class configurations.
|
|
|
|
load_environment
|
2005-09-03 11:13:06 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
def set_load_path
|
|
|
|
configuration.load_paths.reverse.each { |dir| $LOAD_PATH.unshift(dir) if File.directory?(dir) }
|
|
|
|
$LOAD_PATH.uniq!
|
|
|
|
end
|
|
|
|
|
2005-09-15 02:40:39 -04:00
|
|
|
def set_connection_adapters
|
2005-09-15 04:25:46 -04:00
|
|
|
Object.const_set("RAILS_CONNECTION_ADAPTERS", configuration.connection_adapters) if configuration.connection_adapters
|
2005-09-15 02:40:39 -04:00
|
|
|
end
|
|
|
|
|
2005-09-03 11:13:06 -04:00
|
|
|
def require_frameworks
|
|
|
|
configuration.frameworks.each { |framework| require(framework.to_s) }
|
|
|
|
end
|
|
|
|
|
2005-09-13 05:58:16 -04:00
|
|
|
def load_environment
|
|
|
|
silence_warnings do
|
|
|
|
config = configuration
|
|
|
|
eval(IO.read(configuration.environment_path), binding)
|
|
|
|
end
|
2005-09-03 11:13:06 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
def initialize_database
|
|
|
|
return unless configuration.frameworks.include?(:active_record)
|
|
|
|
ActiveRecord::Base.configurations = configuration.database_configuration
|
|
|
|
ActiveRecord::Base.establish_connection
|
|
|
|
end
|
|
|
|
|
|
|
|
def initialize_logger
|
2005-09-05 08:36:40 -04:00
|
|
|
# if the environment has explicitly defined a logger, use it
|
|
|
|
return if defined?(RAILS_DEFAULT_LOGGER)
|
|
|
|
|
2005-09-13 05:58:16 -04:00
|
|
|
unless logger = configuration.logger
|
|
|
|
begin
|
|
|
|
logger = Logger.new(configuration.log_path)
|
|
|
|
logger.level = Logger.const_get(configuration.log_level.to_s.upcase)
|
|
|
|
rescue StandardError
|
|
|
|
logger = Logger.new(STDERR)
|
|
|
|
logger.level = Logger::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
|
2005-09-03 11:13:06 -04:00
|
|
|
end
|
|
|
|
|
2005-09-11 00:58:27 -04:00
|
|
|
silence_warnings { Object.const_set "RAILS_DEFAULT_LOGGER", logger }
|
2005-09-03 11:13:06 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
def initialize_framework_logging
|
2005-09-22 10:11:13 -04:00
|
|
|
for framework in ([ :active_record, :action_controller, :action_mailer ] & configuration.frameworks)
|
|
|
|
framework.to_s.camelize.constantize.const_get("Base").logger ||= RAILS_DEFAULT_LOGGER
|
|
|
|
end
|
2005-09-03 11:13:06 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
def initialize_framework_views
|
2005-09-22 10:11:13 -04:00
|
|
|
for framework in ([ :action_controller, :action_mailer ] & configuration.frameworks)
|
|
|
|
framework.to_s.camelize.constantize.const_get("Base").template_root ||= configuration.view_path
|
|
|
|
end
|
2005-09-03 11:13:06 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
def initialize_routing
|
|
|
|
return unless configuration.frameworks.include?(:action_controller)
|
|
|
|
ActionController::Routing::Routes.reload
|
|
|
|
Object.const_set "Controllers", Dependencies::LoadingModule.root(*configuration.controller_paths)
|
|
|
|
end
|
2005-09-12 13:30:40 -04:00
|
|
|
|
2005-09-13 05:58:16 -04:00
|
|
|
def initialize_dependency_mechanism
|
|
|
|
Dependencies.mechanism = configuration.cache_classes ? :require : :load
|
2005-09-12 13:30:40 -04:00
|
|
|
end
|
2005-09-13 05:58:16 -04:00
|
|
|
|
|
|
|
def initialize_breakpoints
|
|
|
|
silence_warnings { Object.const_set("BREAKPOINT_SERVER_PORT", 42531) if configuration.breakpoint_server }
|
2005-09-12 14:05:46 -04:00
|
|
|
end
|
2005-09-12 13:49:07 -04:00
|
|
|
|
2005-09-13 05:58:16 -04:00
|
|
|
def initialize_whiny_nils
|
|
|
|
require('active_support/whiny_nil') if configuration.whiny_nils
|
|
|
|
end
|
2005-09-12 13:49:07 -04:00
|
|
|
|
2005-09-13 05:58:16 -04:00
|
|
|
def intitialize_framework_settings
|
|
|
|
configuration.frameworks.each do |framework|
|
|
|
|
base_class = framework.to_s.camelize.constantize.const_get("Base")
|
2005-09-12 13:49:07 -04:00
|
|
|
|
2005-09-13 05:58:16 -04:00
|
|
|
configuration.send(framework).each do |setting, value|
|
|
|
|
base_class.send("#{setting}=", value)
|
|
|
|
end
|
2005-09-12 13:49:07 -04:00
|
|
|
end
|
|
|
|
end
|
2005-09-03 11:13:06 -04:00
|
|
|
end
|
|
|
|
|
2005-09-03 11:44:19 -04:00
|
|
|
# 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)
|
2005-09-03 11:13:06 -04:00
|
|
|
class Configuration
|
2005-09-13 05:58:16 -04:00
|
|
|
attr_accessor :frameworks, :load_paths, :logger, :log_level, :log_path, :database_configuration_file, :view_path, :controller_paths
|
2005-09-13 15:46:42 -04:00
|
|
|
attr_accessor :cache_classes, :breakpoint_server, :whiny_nils
|
2005-09-15 02:40:39 -04:00
|
|
|
attr_accessor :connection_adapters
|
2005-09-13 05:58:16 -04:00
|
|
|
attr_accessor :active_record, :action_controller, :action_view, :action_mailer, :action_web_service
|
2005-09-03 11:13:06 -04:00
|
|
|
|
|
|
|
def initialize
|
2005-09-13 05:58:16 -04:00
|
|
|
self.frameworks = default_frameworks
|
|
|
|
self.load_paths = default_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.cache_classes = default_cache_classes
|
|
|
|
self.breakpoint_server = default_breakpoint_server
|
|
|
|
self.whiny_nils = default_whiny_nils
|
2005-09-03 11:13:06 -04:00
|
|
|
self.database_configuration_file = default_database_configuration_file
|
2005-09-13 05:58:16 -04:00
|
|
|
|
|
|
|
for framework in default_frameworks
|
|
|
|
self.send("#{framework}=", new_hash_with_method_access)
|
|
|
|
end
|
2005-09-03 11:13:06 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
def database_configuration
|
|
|
|
YAML::load(ERB.new((IO.read(database_configuration_file))).result)
|
|
|
|
end
|
|
|
|
|
2005-09-13 05:58:16 -04:00
|
|
|
def environment_path
|
|
|
|
"#{RAILS_ROOT}/config/environments/#{environment}.rb"
|
2005-09-03 11:13:06 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
def environment
|
|
|
|
::RAILS_ENV
|
|
|
|
end
|
2005-09-13 05:58:16 -04:00
|
|
|
|
2005-09-03 11:13:06 -04:00
|
|
|
private
|
|
|
|
def default_frameworks
|
2005-09-19 04:18:21 -04:00
|
|
|
[ :active_record, :action_controller, :action_view, :action_mailer, :action_web_service ]
|
2005-09-03 11:13:06 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
def default_load_paths
|
2005-09-03 16:21:38 -04:00
|
|
|
paths = ["#{RAILS_ROOT}/test/mocks/#{environment}"]
|
2005-09-03 11:13:06 -04:00
|
|
|
|
|
|
|
# Then model subdirectories.
|
2005-09-03 12:04:33 -04:00
|
|
|
# TODO: Don't include .rb models as load paths
|
2005-09-03 11:13:06 -04:00
|
|
|
paths.concat(Dir["#{RAILS_ROOT}/app/models/[_a-z]*"])
|
|
|
|
paths.concat(Dir["#{RAILS_ROOT}/components/[_a-z]*"])
|
|
|
|
|
|
|
|
# Followed by the standard includes.
|
2005-09-03 12:04:33 -04:00
|
|
|
# TODO: Don't include dirs for frameworks that are not used
|
2005-09-03 11:13:06 -04:00
|
|
|
paths.concat %w(
|
|
|
|
app
|
|
|
|
app/models
|
|
|
|
app/controllers
|
|
|
|
app/helpers
|
|
|
|
app/apis
|
|
|
|
components
|
|
|
|
config
|
|
|
|
lib
|
|
|
|
vendor
|
|
|
|
vendor/rails/railties
|
|
|
|
vendor/rails/railties/lib
|
|
|
|
vendor/rails/actionpack/lib
|
|
|
|
vendor/rails/activesupport/lib
|
|
|
|
vendor/rails/activerecord/lib
|
|
|
|
vendor/rails/actionmailer/lib
|
|
|
|
vendor/rails/actionwebservice/lib
|
|
|
|
).map { |dir| "#{RAILS_ROOT}/#{dir}" }.select { |dir| File.directory?(dir) }
|
|
|
|
end
|
|
|
|
|
|
|
|
def default_log_path
|
|
|
|
File.join(RAILS_ROOT, 'log', "#{environment}.log")
|
|
|
|
end
|
|
|
|
|
|
|
|
def default_log_level
|
2005-09-12 14:05:46 -04:00
|
|
|
environment == 'production' ? :info : :debug
|
2005-09-03 11:13:06 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
def default_database_configuration_file
|
|
|
|
File.join(RAILS_ROOT, 'config', 'database.yml')
|
|
|
|
end
|
|
|
|
|
|
|
|
def default_view_path
|
|
|
|
File.join(RAILS_ROOT, 'app', 'views')
|
|
|
|
end
|
|
|
|
|
|
|
|
def default_controller_paths
|
|
|
|
[ File.join(RAILS_ROOT, 'app', 'controllers'), File.join(RAILS_ROOT, 'components') ]
|
|
|
|
end
|
2005-09-12 13:30:40 -04:00
|
|
|
|
2005-09-13 05:58:16 -04:00
|
|
|
def default_dependency_mechanism
|
|
|
|
:load
|
|
|
|
end
|
|
|
|
|
|
|
|
def new_hash_with_method_access
|
|
|
|
hash = Hash.new
|
|
|
|
|
|
|
|
def hash.method_missing(name, *args)
|
|
|
|
if has_key?(name)
|
|
|
|
self[name]
|
|
|
|
elsif name.to_s =~ /(.*)=$/
|
|
|
|
self[$1.to_sym] = args.first
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
hash
|
|
|
|
end
|
|
|
|
|
|
|
|
def default_cache_classes
|
|
|
|
false
|
|
|
|
end
|
|
|
|
|
|
|
|
def default_breakpoint_server
|
|
|
|
false
|
|
|
|
end
|
|
|
|
|
|
|
|
def default_whiny_nils
|
|
|
|
false
|
|
|
|
end
|
2005-09-03 11:13:06 -04:00
|
|
|
end
|
2005-09-05 08:36:40 -04:00
|
|
|
end
|