Class: Rails::Initializer

Inherits:
Object show all
Defined in:
lib/initializer.rb

Overview

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.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(configuration) ⇒ Initializer

Create a new Initializer instance that references the given Configuration instance.



119
120
121
122
 
# File 'lib/initializer.rb', line 119

def initialize(configuration)
  @configuration = configuration
  @loaded_plugins = []
end

Instance Attribute Details

#configuration ⇒ Object (readonly)

The Configuration instance used by this Initializer instance.



94
95
96
 
# File 'lib/initializer.rb', line 94

def configuration
  @configuration
end

#gems_dependencies_loaded ⇒ Object (readonly)

Whether or not all the gem dependencies have been met



100
101
102
 
# File 'lib/initializer.rb', line 100

def gems_dependencies_loaded
  @gems_dependencies_loaded
end

#loaded_plugins ⇒ Object (readonly)

The set of loaded plugins.



97
98
99
 
# File 'lib/initializer.rb', line 97

def loaded_plugins
  @loaded_plugins
end

Class Method Details

.run(command = :process, configuration = Configuration.new) {|configuration| ... } ⇒ Object

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.

Yields:



110
111
112
113
114
115
 
# File 'lib/initializer.rb', line 110

def self.run(command = :process, configuration = Configuration.new)
  yield configuration if block_given?
  initializer = new configuration
  initializer.send(command)
  initializer
end

Instance Method Details

#add_gem_load_paths ⇒ Object 



297
298
299
300
301
302
303
 
# File 'lib/initializer.rb', line 297

def add_gem_load_paths
  Rails::GemDependency.add_frozen_gem_path
  unless @configuration.gems.empty?
    require "rubygems"
    @configuration.gems.each { |gem| gem.add_load_paths }
  end
end

#add_plugin_load_paths ⇒ Object

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).



293
294
295
 
# File 'lib/initializer.rb', line 293

def add_plugin_load_paths
  plugin_loader.add_plugin_load_paths
end

#add_support_load_paths ⇒ Object

Add the load paths used by support functions such as the info controller



288
289
 
# File 'lib/initializer.rb', line 288

def add_support_load_paths
end

#after_initialize ⇒ Object

Fires the user-supplied after_initialize block (Configuration#after_initialize)



611
612
613
614
615
616
617
 
# File 'lib/initializer.rb', line 611

def after_initialize
  if gems_dependencies_loaded
    configuration.after_initialize_blocks.each do |block|
      block.call
    end
  end
end

#check_for_unbuilt_gems ⇒ Object 



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/initializer.rb', line 311

def check_for_unbuilt_gems
  unbuilt_gems = @configuration.gems.select(&:frozen?).reject(&: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  "}

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

#check_gem_dependencies ⇒ Object 



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/initializer.rb', line 330

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  "}

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

#check_ruby_version ⇒ Object

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.



209
210
211
 
# File 'lib/initializer.rb', line 209

def check_ruby_version
  require 'ruby_version_check'
end

#disable_dependency_loading ⇒ Object 



634
635
636
637
638
 
# File 'lib/initializer.rb', line 634

def disable_dependency_loading
  if configuration.cache_classes && !configuration.dependency_loading
    ActiveSupport::Dependencies.unhook!
  end
end

#initialize_cache ⇒ Object 



455
456
457
458
459
460
461
462
463
464
 
# File 'lib/initializer.rb', line 455

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(:"ActionController::Failsafe", RAILS_CACHE.middleware)
    end
  end
end

#initialize_database ⇒ Object

This initialization routine does nothing unless :active_record 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.



435
436
437
438
439
440
 
# File 'lib/initializer.rb', line 435

def initialize_database
  if configuration.frameworks.include?(:active_record)
    ActiveRecord::Base.configurations = configuration.database_configuration
    ActiveRecord::Base.establish_connection
  end
end

#initialize_database_middleware ⇒ Object 



442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/initializer.rb', line 442

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

#initialize_dependency_mechanism ⇒ Object

Sets the dependency loading mechanism based on the value of Configuration#cache_classes.



542
543
544
 
# File 'lib/initializer.rb', line 542

def initialize_dependency_mechanism
  ActiveSupport::Dependencies.mechanism = configuration.cache_classes ? :require : :load
end

#initialize_encoding ⇒ Object

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, this does nothing. Specify the default encoding in the Ruby shebang line if you don’t want UTF-8.



427
428
429
 
# File 'lib/initializer.rb', line 427

def initialize_encoding
  $KCODE='u' if RUBY_VERSION < '1.9'
end

#initialize_framework_caches ⇒ Object 



466
467
468
469
470
 
# File 'lib/initializer.rb', line 466

def initialize_framework_caches
  if configuration.frameworks.include?(:action_controller)
    ActionController::Base.cache_store ||= RAILS_CACHE
  end
end

#initialize_framework_logging ⇒ Object

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.



508
509
510
511
512
513
514
515
 
# File 'lib/initializer.rb', line 508

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

#initialize_framework_settings ⇒ Object

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.



597
598
599
600
601
602
603
604
605
606
607
608
 
# File 'lib/initializer.rb', line 597

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

#initialize_framework_views ⇒ Object

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.



521
522
523
524
525
526
527
 
# File 'lib/initializer.rb', line 521

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

#initialize_i18n ⇒ Object

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.



575
576
577
578
579
580
581
582
583
 
# File 'lib/initializer.rb', line 575

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

#initialize_logger ⇒ Object

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.



480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
 
# File 'lib/initializer.rb', line 480

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

#initialize_metal ⇒ Object 



585
586
587
588
589
590
591
592
 
# File 'lib/initializer.rb', line 585

def initialize_metal
  Rails::Rack::Metal.requested_metals = configuration.metals
  Rails::Rack::Metal.metal_paths += plugin_loader.engine_metal_paths

  configuration.middleware.insert_before(
    :"ActionController::ParamsParser",
    Rails::Rack::Metal, :if => Rails::Rack::Metal.metals.any?)
end

#initialize_routing ⇒ Object

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).



532
533
534
535
536
537
538
 
# File 'lib/initializer.rb', line 532

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

#initialize_time_zone ⇒ Object

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.



554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
 
# File 'lib/initializer.rb', line 554

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

#initialize_whiny_nils ⇒ Object

Loads support for “whiny nil” (noisy warnings when methods are invoked on nil values) if Configuration#whiny_nils is true.



548
549
550
 
# File 'lib/initializer.rb', line 548

def initialize_whiny_nils
  require('active_support/whiny_nil') if configuration.whiny_nils
end

#install_gem_spec_stubs ⇒ Object

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.



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/initializer.rb', line 217

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

#load_application_classes ⇒ Object

Eager load application classes



408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/initializer.rb', line 408

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

#load_application_initializers ⇒ Object 



619
620
621
622
623
624
625
 
# File 'lib/initializer.rb', line 619

def load_application_initializers
  if gems_dependencies_loaded
    Dir["#{configuration.root_path}/config/initializers/**/*.rb"].sort.each do |initializer|
      load(initializer)
    end
  end
end

#load_environment ⇒ Object

Loads the environment specified by Configuration#environment_path, which is typically one of development, test, or production.



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/initializer.rb', line 378

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

#load_gems ⇒ Object 



305
306
307
308
309
 
# File 'lib/initializer.rb', line 305

def load_gems
  unless $gems_rake_task
    @configuration.gems.each { |gem| gem.load }
  end
end

#load_observers ⇒ Object 



394
395
396
397
398
 
# File 'lib/initializer.rb', line 394

def load_observers
  if gems_dependencies_loaded && configuration.frameworks.include?(:active_record)
    ActiveRecord::Base.instantiate_observers
  end
end

#load_plugins ⇒ Object

Loads all plugins in config.plugin_paths. plugin_paths defaults to vendor/plugins 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 plugin_paths is initialized:

  • its lib directory, if present, is added to the load path (immediately after the applications lib directory)

  • init.rb 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



368
369
370
 
# File 'lib/initializer.rb', line 368

def load_plugins
  plugin_loader.load_plugins
end

#load_view_paths ⇒ Object 



400
401
402
403
404
405
 
# File 'lib/initializer.rb', line 400

def load_view_paths
  if configuration.frameworks.include?(:action_view)
    ActionController::Base.view_paths.load! if configuration.frameworks.include?(:action_controller)
    ActionMailer::Base.view_paths.load! if configuration.frameworks.include?(:action_mailer)
  end
end

#plugin_loader ⇒ Object 



372
373
374
 
# File 'lib/initializer.rb', line 372

def plugin_loader
  @plugin_loader ||= configuration.plugin_loader.new(self)
end

#preload_frameworks ⇒ Object

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.



277
278
279
280
281
282
283
284
285
 
# File 'lib/initializer.rb', line 277

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

#prepare_dispatcher ⇒ Object 



627
628
629
630
631
632
 
# File 'lib/initializer.rb', line 627

def prepare_dispatcher
  return unless configuration.frameworks.include?(:action_controller)
  require 'dispatcher' unless defined?(::Dispatcher)
  Dispatcher.define_dispatcher_callbacks(configuration.cache_classes)
  Dispatcher.run_prepare_callbacks
end

#process ⇒ Object

Sequentially step through all of the available initialization routines, in order (view execution order in source).



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/initializer.rb', line 126

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

#require_frameworks ⇒ Object

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.



267
268
269
270
271
272
 
# File 'lib/initializer.rb', line 267

def require_frameworks
  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

#set_autoload_paths ⇒ Object

Set the paths from which Rails will automatically load source files, and the load_once paths.



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/initializer.rb', line 248

def set_autoload_paths
  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

#set_load_path ⇒ Object

Set the $LOAD_PATH based on the value of Configuration#load_paths. Duplicates are removed.



240
241
242
243
244
 
# File 'lib/initializer.rb', line 240

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