From 635aa91224b5743c5736f916db18e80713650b86 Mon Sep 17 00:00:00 2001 From: Joshua Peek Date: Mon, 5 Oct 2009 09:41:08 -0500 Subject: More robust console test --- railties/test/application/console_test.rb | 52 +++++++++++++++++++++++++++++++ railties/test/console_app_test.rb | 43 ------------------------- railties/test/isolation/abstract_unit.rb | 4 +++ 3 files changed, 56 insertions(+), 43 deletions(-) create mode 100644 railties/test/application/console_test.rb delete mode 100644 railties/test/console_app_test.rb (limited to 'railties') diff --git a/railties/test/application/console_test.rb b/railties/test/application/console_test.rb new file mode 100644 index 0000000000..e8a4a4e158 --- /dev/null +++ b/railties/test/application/console_test.rb @@ -0,0 +1,52 @@ +require 'isolation/abstract_unit' + +class ConsoleTest < Test::Unit::TestCase + include ActiveSupport::Testing::Isolation + + def setup + build_app + boot_rails + + # Load steps taken from rails/commands/console.rb + require "#{rails_root}/config/environment" + require 'rails/console_app' + require 'rails/console_with_helpers' + end + + def test_app_method_should_return_integration_session + console_session = app + assert_not_nil console_session + assert_instance_of ActionController::Integration::Session, console_session + end + + def test_new_session_should_return_integration_session + session = new_session + assert_not_nil session + assert_instance_of ActionController::Integration::Session, session + end + + def test_reload_should_fire_preparation_callbacks + a = b = c = nil + + # TODO: These should be defined on the initializer + ActionDispatch::Callbacks.to_prepare { a = b = c = 1 } + ActionDispatch::Callbacks.to_prepare { b = c = 2 } + ActionDispatch::Callbacks.to_prepare { c = 3 } + + # Hide Reloading... output + silence_stream(STDOUT) do + reload! + end + + assert_equal 1, a + assert_equal 2, b + assert_equal 3, c + end + + def test_access_to_helpers + assert_not_nil helper + assert_instance_of ActionView::Base, helper + assert_equal 'Once upon a time in a world...', + helper.truncate('Once upon a time in a world far far away') + end +end diff --git a/railties/test/console_app_test.rb b/railties/test/console_app_test.rb deleted file mode 100644 index 1437e6d885..0000000000 --- a/railties/test/console_app_test.rb +++ /dev/null @@ -1,43 +0,0 @@ -require 'abstract_unit' - -require 'action_controller' # console_app uses 'action_controller/integration' - -require 'rails/dispatcher' -require 'rails/console_app' - -module Rails - def self.application - ActionController::Routing::Routes - end -end - -# console_app sets Test::Unit.run to work around the at_exit hook in test/unit, which kills IRB -if Test::Unit.respond_to?(:run=) - Test::Unit.run = false - - class ConsoleAppTest < Test::Unit::TestCase - def test_app_method_should_return_integration_session - assert_nothing_thrown do - console_session = app - assert_not_nil console_session - assert_instance_of ActionController::Integration::Session, - console_session - end - end - - def test_reload_should_fire_preparation_callbacks - a = b = c = nil - - ActionDispatch::Callbacks.to_prepare { a = b = c = 1 } - ActionDispatch::Callbacks.to_prepare { b = c = 2 } - ActionDispatch::Callbacks.to_prepare { c = 3 } - ActionController::Routing::Routes.expects(:reload) - - reload! - - assert_equal 1, a - assert_equal 2, b - assert_equal 3, c - end - end -end diff --git a/railties/test/isolation/abstract_unit.rb b/railties/test/isolation/abstract_unit.rb index 869e8429cf..a55ee6c01d 100644 --- a/railties/test/isolation/abstract_unit.rb +++ b/railties/test/isolation/abstract_unit.rb @@ -30,6 +30,10 @@ module TestHelpers def app_path(*args) tmp_path(*%w[app] + args) end + + def rails_root + app_path + end end module Rack -- cgit v1.2.3 From 444ba150bd344793ebd0bd5efa6efd93fee89a7c Mon Sep 17 00:00:00 2001 From: Joshua Peek Date: Mon, 5 Oct 2009 09:42:35 -0500 Subject: Put test in place for deprecated dispatcher --- railties/test/application/load_test.rb | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'railties') diff --git a/railties/test/application/load_test.rb b/railties/test/application/load_test.rb index 5158abdbb4..305cd7f273 100644 --- a/railties/test/application/load_test.rb +++ b/railties/test/application/load_test.rb @@ -43,6 +43,13 @@ module ApplicationTests assert Rails.application.new.is_a?(Rails::Application) end + # Passenger still uses AC::Dispatcher, so we need to + # keep it working for now + test "deprecated ActionController::Dispatcher still works" do + rackup + assert ActionController::Dispatcher.new.is_a?(Rails::Application) + end + test "the config object is available on the application object" do rackup assert_equal 'UTC', Rails.application.config.time_zone -- cgit v1.2.3 From 7de5f69cc6bc9a946afd3a0fa0ec785f9fb94fb5 Mon Sep 17 00:00:00 2001 From: Joshua Peek Date: Mon, 5 Oct 2009 10:01:46 -0500 Subject: Try to load lib before trying to activate the gem for testing --- railties/test/abstract_unit.rb | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) (limited to 'railties') diff --git a/railties/test/abstract_unit.rb b/railties/test/abstract_unit.rb index 4510e6241c..50c427dc64 100644 --- a/railties/test/abstract_unit.rb +++ b/railties/test/abstract_unit.rb @@ -27,8 +27,12 @@ else end def uses_gem(gem_name, test_name, version = '> 0') - gem gem_name.to_s, version - require gem_name.to_s + begin + require gem_name.to_s + rescue LoadError + gem gem_name.to_s, version + require gem_name.to_s + end yield rescue LoadError $stderr.puts "Skipping #{test_name} tests. `gem install #{gem_name}` and try again." -- cgit v1.2.3 From 20d6938453f439531a13e2ef1fd0905edf56294c Mon Sep 17 00:00:00 2001 From: Joshua Peek Date: Mon, 5 Oct 2009 10:36:05 -0500 Subject: Rewrite FCGI handler test --- railties/lib/rails/fcgi_handler.rb | 4 +- railties/test/abstract_unit.rb | 12 - railties/test/application/fcgi_dispatcher_test.rb | 290 ++++++++++++++++++++++ railties/test/fcgi_dispatcher_test.rb | 268 -------------------- 4 files changed, 293 insertions(+), 281 deletions(-) create mode 100644 railties/test/application/fcgi_dispatcher_test.rb delete mode 100644 railties/test/fcgi_dispatcher_test.rb (limited to 'railties') diff --git a/railties/lib/rails/fcgi_handler.rb b/railties/lib/rails/fcgi_handler.rb index ef6f3b094c..77dce5f325 100644 --- a/railties/lib/rails/fcgi_handler.rb +++ b/railties/lib/rails/fcgi_handler.rb @@ -216,7 +216,9 @@ class RailsFCGIHandler def restore! $".replace @features - Dispatcher.reset_application! + # TODO: Reloading the application should be the "Application"s + # responsibility + ActionDispatch::Callbacks.new(lambda {}, true) ActionController::Routing::Routes.reload end diff --git a/railties/test/abstract_unit.rb b/railties/test/abstract_unit.rb index 50c427dc64..6c6af0b2bf 100644 --- a/railties/test/abstract_unit.rb +++ b/railties/test/abstract_unit.rb @@ -25,15 +25,3 @@ if defined?(RAILS_ROOT) else RAILS_ROOT = File.dirname(__FILE__) end - -def uses_gem(gem_name, test_name, version = '> 0') - begin - require gem_name.to_s - rescue LoadError - gem gem_name.to_s, version - require gem_name.to_s - end - yield -rescue LoadError - $stderr.puts "Skipping #{test_name} tests. `gem install #{gem_name}` and try again." -end diff --git a/railties/test/application/fcgi_dispatcher_test.rb b/railties/test/application/fcgi_dispatcher_test.rb new file mode 100644 index 0000000000..b8ab9f8996 --- /dev/null +++ b/railties/test/application/fcgi_dispatcher_test.rb @@ -0,0 +1,290 @@ +require 'isolation/abstract_unit' +require 'mocha' + +begin + +begin + require 'fcgi' +rescue LoadError + gem 'fcgi', '0.8.7' + require 'fcgi' +end + +class RailsFCGIHandlerTest < Test::Unit::TestCase + include ActiveSupport::Testing::Isolation + + def setup + build_app + boot_rails + + require "#{rails_root}/config/environment" + require 'rails/fcgi_handler' + + @log = StringIO.new + @handler = RailsFCGIHandler.new(@log) + end + + def test_process_restart + request = mock + FCGI.stubs(:each).yields(request) + + @handler.expects(:process_request).once + @handler.expects(:dispatcher_error).never + + @handler.expects(:when_ready).returns(:restart) + @handler.expects(:close_connection).with(request) + @handler.expects(:reload!).never + @handler.expects(:restart!) + + @handler.process! + end + + def test_process_exit + request = mock + FCGI.stubs(:each).yields(request) + + @handler.expects(:process_request).once + @handler.expects(:dispatcher_error).never + + @handler.expects(:when_ready).returns(:exit) + @handler.expects(:close_connection).with(request) + @handler.expects(:reload!).never + @handler.expects(:restart!).never + + @handler.process! + end + + def test_process_with_system_exit_exception + request = mock + FCGI.stubs(:each).yields(request) + + @handler.expects(:process_request).once.raises(SystemExit) + @handler.stubs(:dispatcher_log) + @handler.expects(:dispatcher_log).with(:info, regexp_matches(/^stopping/)) + @handler.expects(:dispatcher_error).never + + @handler.expects(:when_ready).never + @handler.expects(:close_connection).never + @handler.expects(:reload!).never + @handler.expects(:restart!).never + + @handler.process! + end + + def test_restart_handler_outside_request + @handler.expects(:dispatcher_log).with(:info, "asked to restart ASAP") + @handler.expects(:restart!).once + + @handler.send(:restart_handler, nil) + assert_equal nil, @handler.when_ready + end + + def test_install_signal_handler_should_log_on_bad_signal + @handler.stubs(:trap).raises(ArgumentError) + + @handler.expects(:dispatcher_log).with(:warn, "Ignoring unsupported signal CHEESECAKE.") + @handler.send(:install_signal_handler, "CHEESECAKE", nil) + end + + def test_reload + @handler.expects(:restore!) + @handler.expects(:dispatcher_log).with(:info, "reloaded") + + @handler.send(:reload!) + assert_nil @handler.when_ready + end + + def test_reload_runs_gc_when_gc_request_period_set + @handler.expects(:run_gc!) + @handler.expects(:restore!) + @handler.expects(:dispatcher_log).with(:info, "reloaded") + @handler.gc_request_period = 10 + @handler.send(:reload!) + end + + def test_reload_doesnt_run_gc_if_gc_request_period_isnt_set + @handler.expects(:run_gc!).never + @handler.expects(:restore!) + @handler.expects(:dispatcher_log).with(:info, "reloaded") + @handler.send(:reload!) + end + + def test_restart! + @handler.expects(:dispatcher_log).with(:info, "restarted") + @handler.expects(:exec).returns('restarted') + assert_equal 'restarted', @handler.send(:restart!) + end + + def test_restore! + $".expects(:replace) + ActionController::Routing::Routes.expects(:reload) + @handler.send(:restore!) + end + + def test_uninterrupted_processing + request = mock + FCGI.expects(:each).yields(request) + @handler.expects(:process_request).with(request) + + @handler.process! + + assert_nil @handler.when_ready + end +end + +class RailsFCGIHandlerSignalsTest < Test::Unit::TestCase + include ActiveSupport::Testing::Isolation + + def setup + build_app + boot_rails + + require "#{rails_root}/config/environment" + require 'rails/fcgi_handler' + + ::RailsFCGIHandler.class_eval do + attr_accessor :signal + alias_method :old_gc_countdown, :gc_countdown + def gc_countdown + signal ? Process.kill(signal, $$) : old_gc_countdown + end + end + + @log = StringIO.new + @handler = RailsFCGIHandler.new(@log) + @dispatcher = mock + Dispatcher.stubs(:new).returns(@dispatcher) + end + + def test_interrupted_via_HUP_when_not_in_request + request = mock + FCGI.expects(:each).once.yields(request) + @handler.expects(:signal).times(2).returns('HUP') + + @handler.expects(:reload!).once + @handler.expects(:close_connection).never + @handler.expects(:exit).never + + @handler.process! + assert_equal :reload, @handler.when_ready + end + + def test_interrupted_via_USR1_when_not_in_request + request = mock + FCGI.expects(:each).once.yields(request) + @handler.expects(:signal).times(2).returns('USR1') + @handler.expects(:exit_handler).never + + @handler.expects(:reload!).never + @handler.expects(:close_connection).with(request).once + @handler.expects(:exit).never + + @handler.process! + assert_nil @handler.when_ready + end + + def test_restart_via_USR2_when_in_request + request = mock + FCGI.expects(:each).once.yields(request) + @handler.expects(:signal).times(2).returns('USR2') + @handler.expects(:exit_handler).never + + @handler.expects(:reload!).never + @handler.expects(:close_connection).with(request).once + @handler.expects(:exit).never + @handler.expects(:restart!).once + + @handler.process! + assert_equal :restart, @handler.when_ready + end + + def test_interrupted_via_TERM + request = mock + FCGI.expects(:each).once.yields(request) + ::Rack::Handler::FastCGI.expects(:serve).once.returns('TERM') + + @handler.expects(:reload!).never + @handler.expects(:close_connection).never + + @handler.process! + assert_nil @handler.when_ready + end + + def test_runtime_exception_in_fcgi + error = RuntimeError.new('foo') + FCGI.expects(:each).times(2).raises(error) + @handler.expects(:dispatcher_error).with(error, regexp_matches(/^retrying/)) + @handler.expects(:dispatcher_error).with(error, regexp_matches(/^stopping/)) + @handler.process! + end + + def test_runtime_error_in_dispatcher + request = mock + error = RuntimeError.new('foo') + FCGI.expects(:each).once.yields(request) + ::Rack::Handler::FastCGI.expects(:serve).once.raises(error) + @handler.expects(:dispatcher_error).with(error, regexp_matches(/^unhandled/)) + @handler.process! + end + + def test_signal_exception_in_fcgi + error = SignalException.new('USR2') + FCGI.expects(:each).once.raises(error) + @handler.expects(:dispatcher_error).with(error, regexp_matches(/^stopping/)) + @handler.process! + end + + def test_signal_exception_in_dispatcher + request = mock + error = SignalException.new('USR2') + FCGI.expects(:each).once.yields(request) + ::Rack::Handler::FastCGI.expects(:serve).once.raises(error) + @handler.expects(:dispatcher_error).with(error, regexp_matches(/^stopping/)) + @handler.process! + end +end + +class RailsFCGIHandlerPeriodicGCTest < Test::Unit::TestCase + include ActiveSupport::Testing::Isolation + + def setup + build_app + boot_rails + + require "#{rails_root}/config/environment" + require 'rails/fcgi_handler' + + @log = StringIO.new + end + + def teardown + GC.enable + end + + def test_normal_gc + @handler = RailsFCGIHandler.new(@log) + assert_nil @handler.gc_request_period + + # When GC is enabled, GC.disable disables and returns false. + assert_equal false, GC.disable + end + + def test_periodic_gc + @handler = RailsFCGIHandler.new(@log, 10) + assert_equal 10, @handler.gc_request_period + + request = mock + FCGI.expects(:each).times(10).yields(request) + + @handler.expects(:run_gc!).never + 9.times { @handler.process! } + @handler.expects(:run_gc!).once + @handler.process! + + assert_nil @handler.when_ready + end +end + +rescue LoadError + $stderr.puts 'Skipping fcgi tests. `gem install fcgi` and try again.' +end diff --git a/railties/test/fcgi_dispatcher_test.rb b/railties/test/fcgi_dispatcher_test.rb deleted file mode 100644 index 4d77a321a0..0000000000 --- a/railties/test/fcgi_dispatcher_test.rb +++ /dev/null @@ -1,268 +0,0 @@ -require 'abstract_unit' - -uses_gem "fcgi", "0.8.7" do - -require 'action_controller' -require 'rails/fcgi_handler' - -module Rails - def self.application - ActionController::Routing::Routes - end -end - -class RailsFCGIHandlerTest < Test::Unit::TestCase - def setup - @log = StringIO.new - @handler = RailsFCGIHandler.new(@log) - end - - def test_process_restart - request = mock - FCGI.stubs(:each).yields(request) - - @handler.expects(:process_request).once - @handler.expects(:dispatcher_error).never - - @handler.expects(:when_ready).returns(:restart) - @handler.expects(:close_connection).with(request) - @handler.expects(:reload!).never - @handler.expects(:restart!) - - @handler.process! - end - - def test_process_exit - request = mock - FCGI.stubs(:each).yields(request) - - @handler.expects(:process_request).once - @handler.expects(:dispatcher_error).never - - @handler.expects(:when_ready).returns(:exit) - @handler.expects(:close_connection).with(request) - @handler.expects(:reload!).never - @handler.expects(:restart!).never - - @handler.process! - end - - def test_process_with_system_exit_exception - request = mock - FCGI.stubs(:each).yields(request) - - @handler.expects(:process_request).once.raises(SystemExit) - @handler.stubs(:dispatcher_log) - @handler.expects(:dispatcher_log).with(:info, regexp_matches(/^stopping/)) - @handler.expects(:dispatcher_error).never - - @handler.expects(:when_ready).never - @handler.expects(:close_connection).never - @handler.expects(:reload!).never - @handler.expects(:restart!).never - - @handler.process! - end - - def test_restart_handler_outside_request - @handler.expects(:dispatcher_log).with(:info, "asked to restart ASAP") - @handler.expects(:restart!).once - - @handler.send(:restart_handler, nil) - assert_equal nil, @handler.when_ready - end - - def test_install_signal_handler_should_log_on_bad_signal - @handler.stubs(:trap).raises(ArgumentError) - - @handler.expects(:dispatcher_log).with(:warn, "Ignoring unsupported signal CHEESECAKE.") - @handler.send(:install_signal_handler, "CHEESECAKE", nil) - end - - def test_reload - @handler.expects(:restore!) - @handler.expects(:dispatcher_log).with(:info, "reloaded") - - @handler.send(:reload!) - assert_nil @handler.when_ready - end - - - def test_reload_runs_gc_when_gc_request_period_set - @handler.expects(:run_gc!) - @handler.expects(:restore!) - @handler.expects(:dispatcher_log).with(:info, "reloaded") - @handler.gc_request_period = 10 - @handler.send(:reload!) - end - - def test_reload_doesnt_run_gc_if_gc_request_period_isnt_set - @handler.expects(:run_gc!).never - @handler.expects(:restore!) - @handler.expects(:dispatcher_log).with(:info, "reloaded") - @handler.send(:reload!) - end - - def test_restart! - @handler.expects(:dispatcher_log).with(:info, "restarted") - @handler.expects(:exec).returns('restarted') - assert_equal 'restarted', @handler.send(:restart!) - end - - def test_restore! - $".expects(:replace) - Dispatcher.expects(:reset_application!) - ActionController::Routing::Routes.expects(:reload) - @handler.send(:restore!) - end - - def test_uninterrupted_processing - request = mock - FCGI.expects(:each).yields(request) - @handler.expects(:process_request).with(request) - - @handler.process! - - assert_nil @handler.when_ready - end -end - - -class RailsFCGIHandlerSignalsTest < Test::Unit::TestCase - class ::RailsFCGIHandler - attr_accessor :signal - alias_method :old_gc_countdown, :gc_countdown - def gc_countdown - signal ? Process.kill(signal, $$) : old_gc_countdown - end - end - - def setup - @log = StringIO.new - @handler = RailsFCGIHandler.new(@log) - @dispatcher = mock - Dispatcher.stubs(:new).returns(@dispatcher) - end - - def test_interrupted_via_HUP_when_not_in_request - request = mock - FCGI.expects(:each).once.yields(request) - @handler.expects(:signal).times(2).returns('HUP') - - @handler.expects(:reload!).once - @handler.expects(:close_connection).never - @handler.expects(:exit).never - - @handler.process! - assert_equal :reload, @handler.when_ready - end - - def test_interrupted_via_USR1_when_not_in_request - request = mock - FCGI.expects(:each).once.yields(request) - @handler.expects(:signal).times(2).returns('USR1') - @handler.expects(:exit_handler).never - - @handler.expects(:reload!).never - @handler.expects(:close_connection).with(request).once - @handler.expects(:exit).never - - @handler.process! - assert_nil @handler.when_ready - end - - def test_restart_via_USR2_when_in_request - request = mock - FCGI.expects(:each).once.yields(request) - @handler.expects(:signal).times(2).returns('USR2') - @handler.expects(:exit_handler).never - - @handler.expects(:reload!).never - @handler.expects(:close_connection).with(request).once - @handler.expects(:exit).never - @handler.expects(:restart!).once - - @handler.process! - assert_equal :restart, @handler.when_ready - end - - def test_interrupted_via_TERM - request = mock - FCGI.expects(:each).once.yields(request) - ::Rack::Handler::FastCGI.expects(:serve).once.returns('TERM') - - @handler.expects(:reload!).never - @handler.expects(:close_connection).never - - @handler.process! - assert_nil @handler.when_ready - end - - def test_runtime_exception_in_fcgi - error = RuntimeError.new('foo') - FCGI.expects(:each).times(2).raises(error) - @handler.expects(:dispatcher_error).with(error, regexp_matches(/^retrying/)) - @handler.expects(:dispatcher_error).with(error, regexp_matches(/^stopping/)) - @handler.process! - end - - def test_runtime_error_in_dispatcher - request = mock - error = RuntimeError.new('foo') - FCGI.expects(:each).once.yields(request) - ::Rack::Handler::FastCGI.expects(:serve).once.raises(error) - @handler.expects(:dispatcher_error).with(error, regexp_matches(/^unhandled/)) - @handler.process! - end - - def test_signal_exception_in_fcgi - error = SignalException.new('USR2') - FCGI.expects(:each).once.raises(error) - @handler.expects(:dispatcher_error).with(error, regexp_matches(/^stopping/)) - @handler.process! - end - - def test_signal_exception_in_dispatcher - request = mock - error = SignalException.new('USR2') - FCGI.expects(:each).once.yields(request) - ::Rack::Handler::FastCGI.expects(:serve).once.raises(error) - @handler.expects(:dispatcher_error).with(error, regexp_matches(/^stopping/)) - @handler.process! - end -end - - -class RailsFCGIHandlerPeriodicGCTest < Test::Unit::TestCase - def setup - @log = StringIO.new - end - - def teardown - GC.enable - end - - def test_normal_gc - @handler = RailsFCGIHandler.new(@log) - assert_nil @handler.gc_request_period - - # When GC is enabled, GC.disable disables and returns false. - assert_equal false, GC.disable - end - - def test_periodic_gc - @handler = RailsFCGIHandler.new(@log, 10) - assert_equal 10, @handler.gc_request_period - - request = mock - FCGI.expects(:each).times(10).yields(request) - - @handler.expects(:run_gc!).never - 9.times { @handler.process! } - @handler.expects(:run_gc!).once - @handler.process! - - assert_nil @handler.when_ready - end -end -end # uses_gem "fcgi" -- cgit v1.2.3 From 570f055c44a0b6da973f63689f8fedbef9fe32d3 Mon Sep 17 00:00:00 2001 From: Joshua Peek Date: Mon, 5 Oct 2009 11:16:24 -0500 Subject: Yank FCGI Handler from core http://github.com/rails/fcgi_handler --- railties/lib/rails/commands/ncgi/listener | 86 ------ railties/lib/rails/fcgi_handler.rb | 241 ----------------- .../rails/generators/rails/app/app_generator.rb | 16 -- .../rails/app/templates/dispatchers/dispatch.fcgi | 24 -- .../rails/app/templates/dispatchers/dispatch.rb | 10 - .../rails/app/templates/dispatchers/gateway.cgi | 97 ------- railties/lib/rails/tasks/framework.rake | 5 - railties/test/application/fcgi_dispatcher_test.rb | 290 --------------------- railties/test/generators/app_generator_test.rb | 12 - 9 files changed, 781 deletions(-) delete mode 100755 railties/lib/rails/commands/ncgi/listener delete mode 100644 railties/lib/rails/fcgi_handler.rb delete mode 100755 railties/lib/rails/generators/rails/app/templates/dispatchers/dispatch.fcgi delete mode 100755 railties/lib/rails/generators/rails/app/templates/dispatchers/dispatch.rb delete mode 100755 railties/lib/rails/generators/rails/app/templates/dispatchers/gateway.cgi delete mode 100644 railties/test/application/fcgi_dispatcher_test.rb (limited to 'railties') diff --git a/railties/lib/rails/commands/ncgi/listener b/railties/lib/rails/commands/ncgi/listener deleted file mode 100755 index 7079ef78a6..0000000000 --- a/railties/lib/rails/commands/ncgi/listener +++ /dev/null @@ -1,86 +0,0 @@ -#!/usr/bin/env ruby - -require 'stringio' -require 'fileutils' -require 'fcgi_handler' - -def message(s) - $stderr.puts "listener: #{s}" if ENV && ENV["DEBUG_GATEWAY"] -end - -class RemoteCGI < CGI - attr_accessor :stdinput, :stdoutput, :env_table - def initialize(env_table, input = nil, output = nil) - self.env_table = env_table - self.stdinput = input || StringIO.new - self.stdoutput = output || StringIO.new - super() - end - - def out(stream) # Ignore the requested output stream - super(stdoutput) - end -end - -class Listener - include DRbUndumped - - def initialize(timeout, socket_path) - @socket = File.expand_path(socket_path) - @mutex = Mutex.new - @active = false - @timeout = timeout - - @handler = RailsFCGIHandler.new - @handler.extend DRbUndumped - - message 'opening socket' - DRb.start_service("drbunix:#{@socket}", self) - - message 'entering process loop' - @handler.process! self - end - - def each_cgi(&cgi_block) - @cgi_block = cgi_block - message 'entering idle loop' - loop do - sleep @timeout rescue nil - die! unless @active - @active = false - end - end - - def process(env, input) - message 'received request' - @mutex.synchronize do - @active = true - - message 'creating input stream' - input_stream = StringIO.new(input) - message 'building CGI instance' - cgi = RemoteCGI.new(eval(env), input_stream) - - message 'yielding to fcgi handler' - @cgi_block.call cgi - message 'yield finished -- sending output' - - cgi.stdoutput.seek(0) - output = cgi.stdoutput.read - - return output - end - end - - def die! - message 'shutting down' - DRb.stop_service - FileUtils.rm_f @socket - Kernel.exit 0 - end -end - -socket_path = ARGV.shift -timeout = (ARGV.shift || 90).to_i - -Listener.new(timeout, socket_path) diff --git a/railties/lib/rails/fcgi_handler.rb b/railties/lib/rails/fcgi_handler.rb deleted file mode 100644 index 77dce5f325..0000000000 --- a/railties/lib/rails/fcgi_handler.rb +++ /dev/null @@ -1,241 +0,0 @@ -require 'fcgi' -require 'logger' -require 'rails/dispatcher' -require 'rbconfig' - -class RailsFCGIHandler - SIGNALS = { - 'HUP' => :reload, - 'INT' => :exit_now, - 'TERM' => :exit_now, - 'USR1' => :exit, - 'USR2' => :restart - } - GLOBAL_SIGNALS = SIGNALS.keys - %w(USR1) - - attr_reader :when_ready - - attr_accessor :log_file_path - attr_accessor :gc_request_period - - # Initialize and run the FastCGI instance, passing arguments through to new. - def self.process!(*args, &block) - new(*args, &block).process! - end - - # Initialize the FastCGI instance with the path to a crash log - # detailing unhandled exceptions (default RAILS_ROOT/log/fastcgi.crash.log) - # and the number of requests to process between garbage collection runs - # (default nil for normal GC behavior.) Optionally, pass a block which - # takes this instance as an argument for further configuration. - def initialize(log_file_path = nil, gc_request_period = nil) - self.log_file_path = log_file_path || "#{RAILS_ROOT}/log/fastcgi.crash.log" - self.gc_request_period = gc_request_period - - # Yield for additional configuration. - yield self if block_given? - - # Safely install signal handlers. - install_signal_handlers - - @app = Dispatcher.new - - # Start error timestamp at 11 seconds ago. - @last_error_on = Time.now - 11 - end - - def process!(provider = FCGI) - mark_features! - - dispatcher_log :info, 'starting' - process_each_request provider - dispatcher_log :info, 'stopping gracefully' - - rescue Exception => error - case error - when SystemExit - dispatcher_log :info, 'stopping after explicit exit' - when SignalException - dispatcher_error error, 'stopping after unhandled signal' - else - # Retry if exceptions occur more than 10 seconds apart. - if Time.now - @last_error_on > 10 - @last_error_on = Time.now - dispatcher_error error, 'retrying after unhandled exception' - retry - else - dispatcher_error error, 'stopping after unhandled exception within 10 seconds of the last' - end - end - end - - protected - def process_each_request(provider) - request = nil - - catch :exit do - provider.each do |request| - process_request(request) - - case when_ready - when :reload - reload! - when :restart - close_connection(request) - restart! - when :exit - close_connection(request) - throw :exit - end - end - end - rescue SignalException => signal - raise unless signal.message == 'SIGUSR1' - close_connection(request) - end - - def process_request(request) - @processing, @when_ready = true, nil - gc_countdown - - with_signal_handler 'USR1' do - begin - ::Rack::Handler::FastCGI.serve(request, @app) - rescue SignalException, SystemExit - raise - rescue Exception => error - dispatcher_error error, 'unhandled dispatch error' - end - end - ensure - @processing = false - end - - def logger - @logger ||= Logger.new(@log_file_path) - end - - def dispatcher_log(level, msg) - time_str = Time.now.strftime("%d/%b/%Y:%H:%M:%S") - logger.send(level, "[#{time_str} :: #{$$}] #{msg}") - rescue Exception => log_error # Logger errors - STDERR << "Couldn't write to #{@log_file_path.inspect}: #{msg}\n" - STDERR << " #{log_error.class}: #{log_error.message}\n" - end - - def dispatcher_error(e, msg = "") - error_message = - "Dispatcher failed to catch: #{e} (#{e.class})\n" + - " #{e.backtrace.join("\n ")}\n#{msg}" - dispatcher_log(:error, error_message) - end - - def install_signal_handlers - GLOBAL_SIGNALS.each { |signal| install_signal_handler(signal) } - end - - def install_signal_handler(signal, handler = nil) - if SIGNALS.include?(signal) && self.class.method_defined?(name = "#{SIGNALS[signal]}_handler") - handler ||= method(name).to_proc - - begin - trap(signal, handler) - rescue ArgumentError - dispatcher_log :warn, "Ignoring unsupported signal #{signal}." - end - else - dispatcher_log :warn, "Ignoring unsupported signal #{signal}." - end - end - - def with_signal_handler(signal) - install_signal_handler(signal) - yield - ensure - install_signal_handler(signal, 'DEFAULT') - end - - def exit_now_handler(signal) - dispatcher_log :info, "asked to stop immediately" - exit - end - - def exit_handler(signal) - dispatcher_log :info, "asked to stop ASAP" - if @processing - @when_ready = :exit - else - throw :exit - end - end - - def reload_handler(signal) - dispatcher_log :info, "asked to reload ASAP" - if @processing - @when_ready = :reload - else - reload! - end - end - - def restart_handler(signal) - dispatcher_log :info, "asked to restart ASAP" - if @processing - @when_ready = :restart - else - restart! - end - end - - def restart! - config = ::Config::CONFIG - ruby = File::join(config['bindir'], config['ruby_install_name']) + config['EXEEXT'] - command_line = [ruby, $0, ARGV].flatten.join(' ') - - dispatcher_log :info, "restarted" - - # close resources as they won't be closed by - # the OS when using exec - logger.close rescue nil - Rails.logger.close rescue nil - - exec(command_line) - end - - def reload! - run_gc! if gc_request_period - restore! - @when_ready = nil - dispatcher_log :info, "reloaded" - end - - # Make a note of $" so we can safely reload this instance. - def mark_features! - @features = $".clone - end - - def restore! - $".replace @features - # TODO: Reloading the application should be the "Application"s - # responsibility - ActionDispatch::Callbacks.new(lambda {}, true) - ActionController::Routing::Routes.reload - end - - def run_gc! - @gc_request_countdown = gc_request_period - GC.enable; GC.start; GC.disable - end - - def gc_countdown - if gc_request_period - @gc_request_countdown ||= gc_request_period - @gc_request_countdown -= 1 - run_gc! if @gc_request_countdown <= 0 - end - end - - def close_connection(request) - request.finish if request - end -end diff --git a/railties/lib/rails/generators/rails/app/app_generator.rb b/railties/lib/rails/generators/rails/app/app_generator.rb index b2322f90b4..78b4b057ae 100644 --- a/railties/lib/rails/generators/rails/app/app_generator.rb +++ b/railties/lib/rails/generators/rails/app/app_generator.rb @@ -18,9 +18,6 @@ module Rails::Generators class_option :template, :type => :string, :aliases => "-m", :desc => "Path to an application template (can be a filesystem path or URL)." - class_option :with_dispatchers, :type => :boolean, :aliases => "-D", :default => false, - :desc => "Add CGI/FastCGI/mod_ruby dispatchers code" - class_option :skip_activerecord, :type => :boolean, :aliases => "-O", :default => false, :desc => "Skip ActiveRecord files" @@ -113,19 +110,6 @@ module Rails::Generators directory "public", "public", :recursive => false # Do small steps, so anyone can overwrite it. end - def create_dispatch_files - return unless options[:with_dispatchers] - - template "dispatchers/dispatch.rb", "public/dispatch.rb" - chmod "public/dispatch.rb", 0755, :verbose => false - - template "dispatchers/dispatch.rb", "public/dispatch.cgi" - chmod "public/dispatch.cgi", 0755, :verbose => false - - template "dispatchers/dispatch.fcgi", "public/dispatch.fcgi" - chmod "public/dispatch.fcgi", 0755, :verbose => false - end - def create_public_image_files directory "public/images" end diff --git a/railties/lib/rails/generators/rails/app/templates/dispatchers/dispatch.fcgi b/railties/lib/rails/generators/rails/app/templates/dispatchers/dispatch.fcgi deleted file mode 100755 index f5b3b71875..0000000000 --- a/railties/lib/rails/generators/rails/app/templates/dispatchers/dispatch.fcgi +++ /dev/null @@ -1,24 +0,0 @@ -<%= shebang %> -# -# You may specify the path to the FastCGI crash log (a log of unhandled -# exceptions which forced the FastCGI instance to exit, great for debugging) -# and the number of requests to process before running garbage collection. -# -# By default, the FastCGI crash log is RAILS_ROOT/log/fastcgi.crash.log -# and the GC period is nil (turned off). A reasonable number of requests -# could range from 10-100 depending on the memory footprint of your app. -# -# Example: -# # Default log path, normal GC behavior. -# RailsFCGIHandler.process! -# -# # Default log path, 50 requests between GC. -# RailsFCGIHandler.process! nil, 50 -# -# # Custom log path, normal GC behavior. -# RailsFCGIHandler.process! '/var/log/myapp_fcgi_crash.log' -# -require File.dirname(__FILE__) + "/../config/environment" -require 'fcgi_handler' - -RailsFCGIHandler.process! diff --git a/railties/lib/rails/generators/rails/app/templates/dispatchers/dispatch.rb b/railties/lib/rails/generators/rails/app/templates/dispatchers/dispatch.rb deleted file mode 100755 index 48e888113a..0000000000 --- a/railties/lib/rails/generators/rails/app/templates/dispatchers/dispatch.rb +++ /dev/null @@ -1,10 +0,0 @@ -<%= shebang %> - -require File.dirname(__FILE__) + "/../config/environment" unless defined?(RAILS_ROOT) - -# If you're using RubyGems and mod_ruby, this require should be changed to an absolute path one, like: -# "/usr/local/lib/ruby/gems/1.8/gems/rails-0.8.0/lib/dispatcher" -- otherwise performance is severely impaired -require "dispatcher" - -ADDITIONAL_LOAD_PATHS.reverse.each { |dir| $:.unshift(dir) if File.directory?(dir) } if defined?(Apache::RubyRun) -Dispatcher.dispatch diff --git a/railties/lib/rails/generators/rails/app/templates/dispatchers/gateway.cgi b/railties/lib/rails/generators/rails/app/templates/dispatchers/gateway.cgi deleted file mode 100755 index bdc1055a22..0000000000 --- a/railties/lib/rails/generators/rails/app/templates/dispatchers/gateway.cgi +++ /dev/null @@ -1,97 +0,0 @@ -<%= shebang %> - -require 'drb' - -# This file includes an experimental gateway CGI implementation. It will work -# only on platforms which support both fork and sockets. -# -# To enable it edit public/.htaccess and replace dispatch.cgi with gateway.cgi. -# -# Next, create the directory log/drb_gateway and grant the apache user rw access -# to said directory. -# -# On the next request to your server, the gateway tracker should start up, along -# with a few listener processes. This setup should provide you with much better -# speeds than dispatch.cgi. -# -# Keep in mind that the first request made to the server will be slow, as the -# tracker and listeners will have to load. Also, the tracker and listeners will -# shutdown after a period if inactivity. You can set this value below -- the -# default is 90 seconds. - -TrackerSocket = File.expand_path(File.join(File.dirname(__FILE__), '../log/drb_gateway/tracker.sock')) -DieAfter = 90 # Seconds -Listeners = 3 - -def message(s) - $stderr.puts "gateway.cgi: #{s}" if ENV && ENV["DEBUG_GATEWAY"] -end - -def listener_socket(number) - File.expand_path(File.join(File.dirname(__FILE__), "../log/drb_gateway/listener_#{number}.sock")) -end - -unless File.exist? TrackerSocket - message "Starting tracker and #{Listeners} listeners" - fork do - Process.setsid - STDIN.reopen "/dev/null" - STDOUT.reopen "/dev/null", "a" - - root = File.expand_path(File.dirname(__FILE__) + '/..') - - message "starting tracker" - fork do - ARGV.clear - ARGV << TrackerSocket << Listeners.to_s << DieAfter.to_s - load File.join(root, 'script', 'tracker') - end - - message "starting listeners" - require File.join(root, 'config/environment.rb') - Listeners.times do |number| - fork do - ARGV.clear - ARGV << listener_socket(number) << DieAfter.to_s - load File.join(root, 'script', 'listener') - end - end - end - - message "waiting for tracker and listener to arise..." - ready = false - 10.times do - sleep 0.5 - break if (ready = File.exist?(TrackerSocket) && File.exist?(listener_socket(0))) - end - - if ready - message "tracker and listener are ready" - else - message "Waited 5 seconds, listener and tracker not ready... dropping request" - Kernel.exit 1 - end -end - -DRb.start_service - -message "connecting to tracker" -tracker = DRbObject.new_with_uri("drbunix:#{TrackerSocket}") - -input = $stdin.read -$stdin.close - -env = ENV.inspect - -output = nil -tracker.with_listener do |number| - message "connecting to listener #{number}" - socket = listener_socket(number) - listener = DRbObject.new_with_uri("drbunix:#{socket}") - output = listener.process(env, input) - message "listener #{number} has finished, writing output" -end - -$stdout.write output -$stdout.flush -$stdout.close diff --git a/railties/lib/rails/tasks/framework.rake b/railties/lib/rails/tasks/framework.rake index 17e16f26fd..16dd0af44e 100644 --- a/railties/lib/rails/tasks/framework.rake +++ b/railties/lib/rails/tasks/framework.rake @@ -110,11 +110,6 @@ namespace :rails do invoke_from_app_generator :create_prototype_files end - desc "Generate dispatcher files in RAILS_ROOT/public" - task :generate_dispatchers do - invoke_from_app_generator :create_dispatch_files - end - desc "Add new scripts to the application script/ directory" task :scripts do invoke_from_app_generator :create_script_files diff --git a/railties/test/application/fcgi_dispatcher_test.rb b/railties/test/application/fcgi_dispatcher_test.rb deleted file mode 100644 index b8ab9f8996..0000000000 --- a/railties/test/application/fcgi_dispatcher_test.rb +++ /dev/null @@ -1,290 +0,0 @@ -require 'isolation/abstract_unit' -require 'mocha' - -begin - -begin - require 'fcgi' -rescue LoadError - gem 'fcgi', '0.8.7' - require 'fcgi' -end - -class RailsFCGIHandlerTest < Test::Unit::TestCase - include ActiveSupport::Testing::Isolation - - def setup - build_app - boot_rails - - require "#{rails_root}/config/environment" - require 'rails/fcgi_handler' - - @log = StringIO.new - @handler = RailsFCGIHandler.new(@log) - end - - def test_process_restart - request = mock - FCGI.stubs(:each).yields(request) - - @handler.expects(:process_request).once - @handler.expects(:dispatcher_error).never - - @handler.expects(:when_ready).returns(:restart) - @handler.expects(:close_connection).with(request) - @handler.expects(:reload!).never - @handler.expects(:restart!) - - @handler.process! - end - - def test_process_exit - request = mock - FCGI.stubs(:each).yields(request) - - @handler.expects(:process_request).once - @handler.expects(:dispatcher_error).never - - @handler.expects(:when_ready).returns(:exit) - @handler.expects(:close_connection).with(request) - @handler.expects(:reload!).never - @handler.expects(:restart!).never - - @handler.process! - end - - def test_process_with_system_exit_exception - request = mock - FCGI.stubs(:each).yields(request) - - @handler.expects(:process_request).once.raises(SystemExit) - @handler.stubs(:dispatcher_log) - @handler.expects(:dispatcher_log).with(:info, regexp_matches(/^stopping/)) - @handler.expects(:dispatcher_error).never - - @handler.expects(:when_ready).never - @handler.expects(:close_connection).never - @handler.expects(:reload!).never - @handler.expects(:restart!).never - - @handler.process! - end - - def test_restart_handler_outside_request - @handler.expects(:dispatcher_log).with(:info, "asked to restart ASAP") - @handler.expects(:restart!).once - - @handler.send(:restart_handler, nil) - assert_equal nil, @handler.when_ready - end - - def test_install_signal_handler_should_log_on_bad_signal - @handler.stubs(:trap).raises(ArgumentError) - - @handler.expects(:dispatcher_log).with(:warn, "Ignoring unsupported signal CHEESECAKE.") - @handler.send(:install_signal_handler, "CHEESECAKE", nil) - end - - def test_reload - @handler.expects(:restore!) - @handler.expects(:dispatcher_log).with(:info, "reloaded") - - @handler.send(:reload!) - assert_nil @handler.when_ready - end - - def test_reload_runs_gc_when_gc_request_period_set - @handler.expects(:run_gc!) - @handler.expects(:restore!) - @handler.expects(:dispatcher_log).with(:info, "reloaded") - @handler.gc_request_period = 10 - @handler.send(:reload!) - end - - def test_reload_doesnt_run_gc_if_gc_request_period_isnt_set - @handler.expects(:run_gc!).never - @handler.expects(:restore!) - @handler.expects(:dispatcher_log).with(:info, "reloaded") - @handler.send(:reload!) - end - - def test_restart! - @handler.expects(:dispatcher_log).with(:info, "restarted") - @handler.expects(:exec).returns('restarted') - assert_equal 'restarted', @handler.send(:restart!) - end - - def test_restore! - $".expects(:replace) - ActionController::Routing::Routes.expects(:reload) - @handler.send(:restore!) - end - - def test_uninterrupted_processing - request = mock - FCGI.expects(:each).yields(request) - @handler.expects(:process_request).with(request) - - @handler.process! - - assert_nil @handler.when_ready - end -end - -class RailsFCGIHandlerSignalsTest < Test::Unit::TestCase - include ActiveSupport::Testing::Isolation - - def setup - build_app - boot_rails - - require "#{rails_root}/config/environment" - require 'rails/fcgi_handler' - - ::RailsFCGIHandler.class_eval do - attr_accessor :signal - alias_method :old_gc_countdown, :gc_countdown - def gc_countdown - signal ? Process.kill(signal, $$) : old_gc_countdown - end - end - - @log = StringIO.new - @handler = RailsFCGIHandler.new(@log) - @dispatcher = mock - Dispatcher.stubs(:new).returns(@dispatcher) - end - - def test_interrupted_via_HUP_when_not_in_request - request = mock - FCGI.expects(:each).once.yields(request) - @handler.expects(:signal).times(2).returns('HUP') - - @handler.expects(:reload!).once - @handler.expects(:close_connection).never - @handler.expects(:exit).never - - @handler.process! - assert_equal :reload, @handler.when_ready - end - - def test_interrupted_via_USR1_when_not_in_request - request = mock - FCGI.expects(:each).once.yields(request) - @handler.expects(:signal).times(2).returns('USR1') - @handler.expects(:exit_handler).never - - @handler.expects(:reload!).never - @handler.expects(:close_connection).with(request).once - @handler.expects(:exit).never - - @handler.process! - assert_nil @handler.when_ready - end - - def test_restart_via_USR2_when_in_request - request = mock - FCGI.expects(:each).once.yields(request) - @handler.expects(:signal).times(2).returns('USR2') - @handler.expects(:exit_handler).never - - @handler.expects(:reload!).never - @handler.expects(:close_connection).with(request).once - @handler.expects(:exit).never - @handler.expects(:restart!).once - - @handler.process! - assert_equal :restart, @handler.when_ready - end - - def test_interrupted_via_TERM - request = mock - FCGI.expects(:each).once.yields(request) - ::Rack::Handler::FastCGI.expects(:serve).once.returns('TERM') - - @handler.expects(:reload!).never - @handler.expects(:close_connection).never - - @handler.process! - assert_nil @handler.when_ready - end - - def test_runtime_exception_in_fcgi - error = RuntimeError.new('foo') - FCGI.expects(:each).times(2).raises(error) - @handler.expects(:dispatcher_error).with(error, regexp_matches(/^retrying/)) - @handler.expects(:dispatcher_error).with(error, regexp_matches(/^stopping/)) - @handler.process! - end - - def test_runtime_error_in_dispatcher - request = mock - error = RuntimeError.new('foo') - FCGI.expects(:each).once.yields(request) - ::Rack::Handler::FastCGI.expects(:serve).once.raises(error) - @handler.expects(:dispatcher_error).with(error, regexp_matches(/^unhandled/)) - @handler.process! - end - - def test_signal_exception_in_fcgi - error = SignalException.new('USR2') - FCGI.expects(:each).once.raises(error) - @handler.expects(:dispatcher_error).with(error, regexp_matches(/^stopping/)) - @handler.process! - end - - def test_signal_exception_in_dispatcher - request = mock - error = SignalException.new('USR2') - FCGI.expects(:each).once.yields(request) - ::Rack::Handler::FastCGI.expects(:serve).once.raises(error) - @handler.expects(:dispatcher_error).with(error, regexp_matches(/^stopping/)) - @handler.process! - end -end - -class RailsFCGIHandlerPeriodicGCTest < Test::Unit::TestCase - include ActiveSupport::Testing::Isolation - - def setup - build_app - boot_rails - - require "#{rails_root}/config/environment" - require 'rails/fcgi_handler' - - @log = StringIO.new - end - - def teardown - GC.enable - end - - def test_normal_gc - @handler = RailsFCGIHandler.new(@log) - assert_nil @handler.gc_request_period - - # When GC is enabled, GC.disable disables and returns false. - assert_equal false, GC.disable - end - - def test_periodic_gc - @handler = RailsFCGIHandler.new(@log, 10) - assert_equal 10, @handler.gc_request_period - - request = mock - FCGI.expects(:each).times(10).yields(request) - - @handler.expects(:run_gc!).never - 9.times { @handler.process! } - @handler.expects(:run_gc!).once - @handler.process! - - assert_nil @handler.when_ready - end -end - -rescue LoadError - $stderr.puts 'Skipping fcgi tests. `gem install fcgi` and try again.' -end diff --git a/railties/test/generators/app_generator_test.rb b/railties/test/generators/app_generator_test.rb index afc0585fba..6e46c4ddc0 100644 --- a/railties/test/generators/app_generator_test.rb +++ b/railties/test/generators/app_generator_test.rb @@ -53,18 +53,6 @@ class AppGeneratorTest < GeneratorsTestCase assert_match /Invalid value for \-\-database option/, content end - def test_dispatchers_are_not_added_by_default - run_generator - assert_no_file "public/dispatch.cgi" - assert_no_file "public/dispatch.fcgi" - end - - def test_dispatchers_are_added_if_required - run_generator ["--with-dispatchers"] - assert_file "public/dispatch.cgi" - assert_file "public/dispatch.fcgi" - end - def test_config_database_is_added_by_default run_generator assert_file "config/database.yml", /sqlite3/ -- cgit v1.2.3 From b480da5cd65de966ac14bbdc52b2fae3ffc06547 Mon Sep 17 00:00:00 2001 From: Joshua Peek Date: Mon, 5 Oct 2009 13:58:43 -0500 Subject: Coerce all out going body parts to Strings --- railties/lib/rails/initializer.rb | 1 + 1 file changed, 1 insertion(+) (limited to 'railties') diff --git a/railties/lib/rails/initializer.rb b/railties/lib/rails/initializer.rb index 2d63ac4d39..c2d6e1609f 100644 --- a/railties/lib/rails/initializer.rb +++ b/railties/lib/rails/initializer.rb @@ -271,6 +271,7 @@ module Rails configuration.middleware.use(ActionDispatch::ParamsParser) configuration.middleware.use(::Rack::MethodOverride) configuration.middleware.use(::Rack::Head) + configuration.middleware.use(ActionDispatch::StringCoercion) end end -- cgit v1.2.3 From f27e7ebc0e2a55a268631c78d49a5b70b06ad59a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Valim?= Date: Tue, 6 Oct 2009 19:57:44 -0300 Subject: Do not ignore .empty_directory files. Signed-off-by: Carl Lerche --- railties/rails.gemspec | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'railties') diff --git a/railties/rails.gemspec b/railties/rails.gemspec index 659d6727ea..dc66e1efea 100644 --- a/railties/rails.gemspec +++ b/railties/rails.gemspec @@ -18,7 +18,7 @@ Gem::Specification.new do |s| s.rdoc_options << '--exclude' << '.' s.has_rdoc = false - s.files = Dir['CHANGELOG', 'README', 'bin/**/*', 'builtin/**/*', 'guides/**/*', 'lib/**/*'] + s.files = Dir['CHANGELOG', 'README', 'bin/**/*', 'builtin/**/*', 'guides/**/*', 'lib/**/{*,.[a-z]*}'] s.require_path = 'lib' s.bindir = "bin" s.executables = ["rails"] -- cgit v1.2.3 From 28bd0873ff7aae8e5949dc77f1f8b78109cd38f1 Mon Sep 17 00:00:00 2001 From: Michael Koziarski Date: Thu, 8 Oct 2009 14:34:15 +1300 Subject: Don't need h in there now that XSS protection is on by default --- railties/lib/rails/generators/erb/scaffold/templates/index.html.erb | 2 +- railties/lib/rails/generators/erb/scaffold/templates/show.html.erb | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) (limited to 'railties') diff --git a/railties/lib/rails/generators/erb/scaffold/templates/index.html.erb b/railties/lib/rails/generators/erb/scaffold/templates/index.html.erb index 5e6a4af9e0..b5c7fd1e58 100644 --- a/railties/lib/rails/generators/erb/scaffold/templates/index.html.erb +++ b/railties/lib/rails/generators/erb/scaffold/templates/index.html.erb @@ -13,7 +13,7 @@ <%% @<%= plural_name %>.each do |<%= singular_name %>| %> <% for attribute in attributes -%> - <%%=h <%= singular_name %>.<%= attribute.name %> %> + <%%= <%= singular_name %>.<%= attribute.name %> %> <% end -%> <%%= link_to 'Show', <%= singular_name %> %> <%%= link_to 'Edit', edit_<%= singular_name %>_path(<%= singular_name %>) %> diff --git a/railties/lib/rails/generators/erb/scaffold/templates/show.html.erb b/railties/lib/rails/generators/erb/scaffold/templates/show.html.erb index 25567957be..24f13fc0f8 100644 --- a/railties/lib/rails/generators/erb/scaffold/templates/show.html.erb +++ b/railties/lib/rails/generators/erb/scaffold/templates/show.html.erb @@ -1,7 +1,7 @@ <% for attribute in attributes -%>

<%= attribute.human_name %>: - <%%=h @<%= singular_name %>.<%= attribute.name %> %> + <%%= @<%= singular_name %>.<%= attribute.name %> %>

<% end -%> -- cgit v1.2.3 From d0965892456e0ec76f9cb95a151d3b8e11622e36 Mon Sep 17 00:00:00 2001 From: Carl Lerche Date: Wed, 7 Oct 2009 11:07:24 -0700 Subject: Remove the old initializer file. --- railties/lib/rails/initializer_old.rb | 1137 --------------------------------- 1 file changed, 1137 deletions(-) delete mode 100644 railties/lib/rails/initializer_old.rb (limited to 'railties') diff --git a/railties/lib/rails/initializer_old.rb b/railties/lib/rails/initializer_old.rb deleted file mode 100644 index cee5c7bcb6..0000000000 --- a/railties/lib/rails/initializer_old.rb +++ /dev/null @@ -1,1137 +0,0 @@ -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 $LOAD_PATH 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 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 - 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 :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. - 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 app/controllers.) - attr_accessor :controller_paths - - # The path to the database configuration file to use. (Defaults to - # config/database.yml.) - attr_accessor :database_configuration_file - - # The path to the routes configuration file to use. (Defaults to - # config/routes.rb.) - attr_accessor :routes_configuration_file - - # The list of rails framework components that should be loaded. (Defaults - # to :active_record, :action_controller, - # :action_view, :action_mailer, and - # :active_resource). - 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 :info. In development mode, it defaults to - # :debug. - 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 app/views.) - 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 nil, all plugins will - # be loaded. If this is set to [], no plugins will be loaded. Otherwise, - # plugins will be loaded in the order specified. - 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 nil, all metals will - # be loaded in alphabetical order. If this is set to [], no metals will - # be loaded. Otherwise metals will be loaded in the order specified - attr_accessor :metals - - # The path to the root of the plugins directory. By default, it is in - # vendor/plugins. - 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 vendor/plugins. You can hook into gem location by subclassing - # Rails::Plugin::Locator and adding it onto the list of plugin_locators. - 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 reload_plugins? is false, add this to your plugin's init.rb - # to make it reloadable: - # - # ActiveSupport::Dependencies.load_once_paths.delete lib_path - # - # If reload_plugins? is true, add this to your plugin's init.rb - # to only load it once: - # - # ActiveSupport::Dependencies.load_once_paths << lib_path - # - 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 - # dependency_loading to true will allow new classes to be loaded - # during a request. Setting it to false will disable this behavior. - # - # Those who want to run in a threaded environment should disable this - # option and eager load or require all there classes on initialization. - # - # If cache_classes is disabled, dependency loaded will always be - # on. - 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 :utc. - 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 (development.rb, etc.). By - # default the file is at config/environments/#{environment}.rb. - 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 - -- cgit v1.2.3 From 6d6ae0841c94d3c0ce0c91311028ff7396c44a4a Mon Sep 17 00:00:00 2001 From: Carl Lerche Date: Wed, 7 Oct 2009 15:21:19 -0700 Subject: Start moving the initializers into the application object --- railties/lib/rails/application.rb | 38 +++++++++--- .../generators/rails/app/templates/config/boot.rb | 13 ++-- railties/lib/rails/initializable.rb | 70 ++++++++++++++++++++++ railties/lib/rails/initializer.rb | 42 ++----------- railties/test/application/initializable_test.rb | 26 ++++++++ railties/test/application/initializer_test.rb | 33 ++++++++++ railties/test/application/load_test.rb | 4 +- railties/test/initializer/initialize_i18n_test.rb | 51 ++++++++++++++++ railties/test/initializer_test.rb | 18 ------ railties/test/isolation/abstract_unit.rb | 3 +- 10 files changed, 225 insertions(+), 73 deletions(-) create mode 100644 railties/lib/rails/initializable.rb create mode 100644 railties/test/application/initializable_test.rb create mode 100644 railties/test/application/initializer_test.rb create mode 100644 railties/test/initializer/initialize_i18n_test.rb (limited to 'railties') diff --git a/railties/lib/rails/application.rb b/railties/lib/rails/application.rb index 6139e20e95..783d45aa65 100644 --- a/railties/lib/rails/application.rb +++ b/railties/lib/rails/application.rb @@ -1,5 +1,10 @@ module Rails class Application + extend Initializable + + def self.inherited(child) + child.initializers = initializers.dup + end def self.config @config ||= Configuration.new @@ -9,21 +14,40 @@ module Rails @config = config end - def config - self.class.config - end - - def routes + def self.routes ActionController::Routing::Routes end - def middleware + def self.middleware config.middleware end - def call(env) + def self.call(env) @app ||= middleware.build(routes) @app.call(env) end + + def self.new + initializers.run + self + end + + initializer :initialize_rails do + Rails.initializers.run + end + + # Set the $LOAD_PATH based on the value of + # Configuration#load_paths. Duplicates are removed. + initializer :set_load_path do + config.paths.add_to_load_path + $LOAD_PATH.uniq! + end + + # Bail if boot.rb is outdated + initializer :freak_out_if_boot_rb_is_outdated do + unless defined?(Rails::BOOTSTRAP_VERSION) + abort %{Your config/boot.rb is outdated: Run "rake rails:update".} + end + end end end diff --git a/railties/lib/rails/generators/rails/app/templates/config/boot.rb b/railties/lib/rails/generators/rails/app/templates/config/boot.rb index 52086fbc7d..6e0e2279cd 100644 --- a/railties/lib/rails/generators/rails/app/templates/config/boot.rb +++ b/railties/lib/rails/generators/rails/app/templates/config/boot.rb @@ -40,20 +40,20 @@ module Rails class Boot def run - load_initializer set_load_paths + load_initializer end def set_load_paths %w( - railties - railties/lib - activesupport/lib + actionmailer/lib actionpack/lib + activemodel/lib activerecord/lib - actionmailer/lib activeresource/lib - actionwebservice/lib + activesupport/lib + railties/lib + railties ).reverse_each do |path| path = "#{framework_root_path}/#{path}" $LOAD_PATH.unshift(path) if File.directory?(path) @@ -68,7 +68,6 @@ module Rails class VendorBoot < Boot def load_initializer - $:.unshift("#{framework_root_path}/railties/lib") require "rails" install_gem_spec_stubs Rails::GemDependency.add_frozen_gem_path diff --git a/railties/lib/rails/initializable.rb b/railties/lib/rails/initializable.rb new file mode 100644 index 0000000000..61c98d4f99 --- /dev/null +++ b/railties/lib/rails/initializable.rb @@ -0,0 +1,70 @@ +module Rails + module Initializable + + # A collection of initializers + class Collection < ActiveSupport::OrderedHash + # def initialize_copy(other) + # super + # each do |key, value| + # self[key] = value.dup + # end + # end + + def run + each do |key, initializer| + initializer.run + end + self + end + end + + class Initializer + attr_reader :name, :options, :block + + def initialize(name, options = {}, &block) + @name, @options, @block = name, options, block + end + + def run + return if @already_ran + @block.call + @already_ran = true + end + end + + def initializer(name, options = {}, &block) + initializers[name] = Initializer.new(name, options, &block) + end + + def initializers + @initializers ||= Collection.new + end + + def initializers=(initializers) + @initializers = initializers + end + + end + + extend Initializable + + # 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 :check_ruby_version do + require 'rails/ruby_version_check' + 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. + initializer :initialize_encoding do + if RUBY_VERSION < '1.9' + $KCODE='u' + else + Encoding.default_external = Encoding::UTF_8 + end + end +end \ No newline at end of file diff --git a/railties/lib/rails/initializer.rb b/railties/lib/rails/initializer.rb index c2d6e1609f..d3e7f934ea 100644 --- a/railties/lib/rails/initializer.rb +++ b/railties/lib/rails/initializer.rb @@ -1,5 +1,7 @@ require "pathname" +require 'active_support/ordered_hash' +require 'rails/initializable' require 'rails/application' require 'rails/railties_path' require 'rails/version' @@ -12,10 +14,6 @@ require 'rails/configuration' RAILS_ENV = (ENV['RAILS_ENV'] || 'development').dup unless defined?(RAILS_ENV) module Rails - # Sanity check to make sure this file is only loaded once - # TODO: Get to the point where this can be removed. - raise "It looks like initializer.rb was required twice" if defined?(Initializer) - class Initializer class Error < StandardError ; end @@ -110,6 +108,8 @@ module Rails default.run(initializer) else Rails.application = Class.new(Application) + # Trigger the initializer + Rails.application.new yield Rails.application.config if block_given? default.config = Rails.application.config default.run @@ -117,26 +117,6 @@ module Rails end end - # 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 'rails/ruby_version_check' - end - - # Bail if boot.rb is outdated - Initializer.default.add :freak_out_if_boot_rb_is_outdated do - unless defined?(Rails::BOOTSTRAP_VERSION) - abort %{Your config/boot.rb is outdated: Run "rake rails:update".} - end - end - - # Set the $LOAD_PATH based on the value of - # Configuration#load_paths. Duplicates are removed. - Initializer.default.add :set_load_path do - configuration.paths.add_to_load_path - $LOAD_PATH.uniq! - 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. @@ -230,20 +210,6 @@ module Rails 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. - Initializer.default.add :initialize_encoding do - if RUBY_VERSION < '1.9' - $KCODE='u' - else - Encoding.default_external = Encoding::UTF_8 - end - end - # 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 diff --git a/railties/test/application/initializable_test.rb b/railties/test/application/initializable_test.rb new file mode 100644 index 0000000000..38eaec63c0 --- /dev/null +++ b/railties/test/application/initializable_test.rb @@ -0,0 +1,26 @@ +require "isolation/abstract_unit" + +module ApplicationTests + class InitializerTest < Test::Unit::TestCase + include ActiveSupport::Testing::Isolation + + def setup + build_app + boot_rails + end + + test "initializers only ever run once" do + class MyApp < Rails::Application + initializer :counter do + $counter += 1 + end + end + + $counter = 0 + MyApp.initializers[:counter].run + MyApp.initializers[:counter].run + + assert_equal 1, $counter + end + end +end \ No newline at end of file diff --git a/railties/test/application/initializer_test.rb b/railties/test/application/initializer_test.rb new file mode 100644 index 0000000000..9583e1606c --- /dev/null +++ b/railties/test/application/initializer_test.rb @@ -0,0 +1,33 @@ +require "isolation/abstract_unit" + +module ApplicationTests + class InitializerTest < Test::Unit::TestCase + include ActiveSupport::Testing::Isolation + + def setup + build_app + boot_rails + end + + test "initializing an application initializes rails" do + class MyApp < Rails::Application ; end + + if RUBY_VERSION < '1.9' + $KCODE = '' + MyApp.new + assert_equal 'UTF8', $KCODE + else + Encoding.default_external = Encoding::US_ASCII + MyApp.new + assert_equal Encoding::UTF_8, Encoding.default_external + end + end + + test "initializing an application adds the application paths to the load path" do + class MyApp < Rails::Application ; end + + MyApp.new + assert $:.include?("#{app_path}/app/models") + end + end +end \ No newline at end of file diff --git a/railties/test/application/load_test.rb b/railties/test/application/load_test.rb index 305cd7f273..5c3d35fb16 100644 --- a/railties/test/application/load_test.rb +++ b/railties/test/application/load_test.rb @@ -40,14 +40,14 @@ module ApplicationTests test "Rails.application is available after config.ru has been racked up" do rackup - assert Rails.application.new.is_a?(Rails::Application) + assert Rails.application.new < Rails::Application end # Passenger still uses AC::Dispatcher, so we need to # keep it working for now test "deprecated ActionController::Dispatcher still works" do rackup - assert ActionController::Dispatcher.new.is_a?(Rails::Application) + assert ActionController::Dispatcher.new < Rails::Application end test "the config object is available on the application object" do diff --git a/railties/test/initializer/initialize_i18n_test.rb b/railties/test/initializer/initialize_i18n_test.rb new file mode 100644 index 0000000000..e909688817 --- /dev/null +++ b/railties/test/initializer/initialize_i18n_test.rb @@ -0,0 +1,51 @@ +require "isolation/abstract_unit" + +module InitializerTests + class InitializeI18nTest < Test::Unit::TestCase + include ActiveSupport::Testing::Isolation + + def setup + build_app + boot_rails + end + + # test_config_defaults_and_settings_should_be_added_to_i18n_defaults + test "i18n config defaults and settings should be added to i18n defaults" do + Rails::Initializer.run do |c| + c.i18n.load_path << "my/other/locale.yml" + end + + #{RAILS_FRAMEWORK_ROOT}/railties/test/fixtures/plugins/engines/engine/config/locales/en.yml + assert_equal %W( + #{RAILS_FRAMEWORK_ROOT}/activesupport/lib/active_support/locale/en.yml + #{RAILS_FRAMEWORK_ROOT}/activemodel/lib/active_model/locale/en.yml + #{RAILS_FRAMEWORK_ROOT}/activerecord/lib/active_record/locale/en.yml + #{RAILS_FRAMEWORK_ROOT}/actionpack/lib/action_view/locale/en.yml + #{RAILS_FRAMEWORK_ROOT}/railties/tmp/app/config/locales/en.yml + my/other/locale.yml + ), I18n.load_path + end + + test "i18n finds locale files in engines" do + app_file "vendor/plugins/engine/init.rb", "" + app_file "vendor/plugins/engine/app/models/hellos.rb", "class Hello ; end" + app_file "vendor/plugins/engine/lib/omg.rb", "puts 'omg'" + app_file "vendor/plugins/engine/config/locales/en.yml", "hello:" + + Rails::Initializer.run do |c| + c.i18n.load_path << "my/other/locale.yml" + end + + #{RAILS_FRAMEWORK_ROOT}/railties/test/fixtures/plugins/engines/engine/config/locales/en.yml + assert_equal %W( + #{RAILS_FRAMEWORK_ROOT}/activesupport/lib/active_support/locale/en.yml + #{RAILS_FRAMEWORK_ROOT}/activemodel/lib/active_model/locale/en.yml + #{RAILS_FRAMEWORK_ROOT}/activerecord/lib/active_record/locale/en.yml + #{RAILS_FRAMEWORK_ROOT}/actionpack/lib/action_view/locale/en.yml + #{app_path}/config/locales/en.yml + my/other/locale.yml + #{app_path}/vendor/plugins/engine/config/locales/en.yml + ), I18n.load_path + end + end +end \ No newline at end of file diff --git a/railties/test/initializer_test.rb b/railties/test/initializer_test.rb index b67db9c835..92383a74fd 100644 --- a/railties/test/initializer_test.rb +++ b/railties/test/initializer_test.rb @@ -393,24 +393,6 @@ class InitializerSetupI18nTests < Test::Unit::TestCase assert_equal [ "my/test/locale.yml", "my/other/locale.yml" ], config.i18n.load_path end - def test_config_defaults_and_settings_should_be_added_to_i18n_defaults - File.stubs(:exist?).returns(true) - Dir.stubs(:[]).returns([ "my/test/locale.yml" ]) - - config = Rails::Configuration.new - config.i18n.load_path << "my/other/locale.yml" - - Rails::Initializer.run(:initialize_i18n, config) - assert_equal [ - File.expand_path(File.dirname(__FILE__) + "/../../activesupport/lib/active_support/locale/en.yml"), - File.expand_path(File.dirname(__FILE__) + "/../../actionpack/lib/action_view/locale/en.yml"), - File.expand_path(File.dirname(__FILE__) + "/../../activemodel/lib/active_model/locale/en.yml"), - File.expand_path(File.dirname(__FILE__) + "/../../activerecord/lib/active_record/locale/en.yml"), - File.expand_path(File.dirname(__FILE__) + "/../../railties/test/fixtures/plugins/engines/engine/config/locales/en.yml"), - "my/test/locale.yml", - "my/other/locale.yml" ], I18n.load_path.collect { |path| path =~ /\.\./ ? File.expand_path(path) : path } - end - def test_setting_another_default_locale config = Rails::Configuration.new config.i18n.default_locale = :de diff --git a/railties/test/isolation/abstract_unit.rb b/railties/test/isolation/abstract_unit.rb index a55ee6c01d..c452adaa52 100644 --- a/railties/test/isolation/abstract_unit.rb +++ b/railties/test/isolation/abstract_unit.rb @@ -91,7 +91,8 @@ module TestHelpers end def app_file(path, contents) - File.open(app_path(path), 'w') do |f| + FileUtils.mkdir_p File.dirname("#{app_path}/#{path}") + File.open("#{app_path}/#{path}", 'w') do |f| f.puts contents end end -- cgit v1.2.3 From e4d7e5090c928e5b64350be9a1fb3aaf6f968e4c Mon Sep 17 00:00:00 2001 From: Carl Lerche Date: Thu, 8 Oct 2009 12:14:57 -0700 Subject: Moving more initializers into the application object --- railties/lib/rails/application.rb | 93 ++++++++++++++++++------ railties/lib/rails/initializable.rb | 69 ++++++++++++------ railties/lib/rails/initializer.rb | 47 +----------- railties/test/application/initializable_test.rb | 26 ------- railties/test/application/initializer_test.rb | 25 +++++++ railties/test/application/plugins_test.rb | 90 +++++++++++++++++++++++ railties/test/initializable_test.rb | 56 +++++++++++++++ railties/test/initializer_test.rb | 95 ------------------------- 8 files changed, 292 insertions(+), 209 deletions(-) delete mode 100644 railties/test/application/initializable_test.rb create mode 100644 railties/test/application/plugins_test.rb create mode 100644 railties/test/initializable_test.rb (limited to 'railties') diff --git a/railties/lib/rails/application.rb b/railties/lib/rails/application.rb index 783d45aa65..011a9c489d 100644 --- a/railties/lib/rails/application.rb +++ b/railties/lib/rails/application.rb @@ -2,34 +2,39 @@ module Rails class Application extend Initializable - def self.inherited(child) - child.initializers = initializers.dup - end + class << self + def config + @config ||= Configuration.new + end - def self.config - @config ||= Configuration.new - end + # TODO: change the plugin loader to use config + alias configuration config - def self.config=(config) - @config = config - end + def config=(config) + @config = config + end - def self.routes - ActionController::Routing::Routes - end + def plugin_loader + @plugin_loader ||= config.plugin_loader.new(self) + end - def self.middleware - config.middleware - end + def routes + ActionController::Routing::Routes + end - def self.call(env) - @app ||= middleware.build(routes) - @app.call(env) - end + def middleware + config.middleware + end + + def call(env) + @app ||= middleware.build(routes) + @app.call(env) + end - def self.new - initializers.run - self + def new + initializers.run + self + end end initializer :initialize_rails do @@ -49,5 +54,49 @@ module Rails abort %{Your config/boot.rb is outdated: Run "rake rails:update".} end 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 :require_frameworks do + begin + require 'active_support' + require 'active_support/core_ext/kernel/reporting' + require 'active_support/core_ext/logger' + + # TODO: This is here to make Sam Ruby's tests pass. Needs discussion. + require 'active_support/core_ext/numeric/bytes' + config.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 + + # Set the paths from which Rails will automatically load source files, and + # the load_once paths. + initializer :set_autoload_paths do + require 'active_support/dependencies' + ActiveSupport::Dependencies.load_paths = config.load_paths.uniq + ActiveSupport::Dependencies.load_once_paths = config.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 + config.load_once_paths.freeze + 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 :add_plugin_load_paths do + require 'active_support/dependencies' + plugin_loader.add_plugin_load_paths + end end end diff --git a/railties/lib/rails/initializable.rb b/railties/lib/rails/initializable.rb index 61c98d4f99..4bd5088207 100644 --- a/railties/lib/rails/initializable.rb +++ b/railties/lib/rails/initializable.rb @@ -2,20 +2,58 @@ module Rails module Initializable # A collection of initializers - class Collection < ActiveSupport::OrderedHash - # def initialize_copy(other) - # super - # each do |key, value| - # self[key] = value.dup - # end - # end + class Collection + def initialize(context) + @context = context + @keys = [] + @values = {} + @ran = false + end def run + return self if @ran each do |key, initializer| - initializer.run + @context.class_eval(&initializer.block) end + @ran = true self end + + def [](key) + keys, values = merge_with_parent + values[key.to_sym] + end + + def []=(key, value) + key = key.to_sym + @keys |= [key] + @values[key] = value + end + + def each + keys, values = merge_with_parent + keys.each { |k| yield k, values[k] } + self + end + + protected + + attr_reader :keys, :values + + private + + def merge_with_parent + keys, values = [], {} + + if @context.is_a?(Class) && @context.superclass.is_a?(Initializable) + parent = @context.superclass.initializers + keys, values = parent.keys, parent.values + end + + values = values.merge(@values) + return keys | @keys, values + end + end class Initializer @@ -24,24 +62,15 @@ module Rails def initialize(name, options = {}, &block) @name, @options, @block = name, options, block end - - def run - return if @already_ran - @block.call - @already_ran = true - end end def initializer(name, options = {}, &block) - initializers[name] = Initializer.new(name, options, &block) + @initializers ||= Collection.new(self) + @initializers[name] = Initializer.new(name, options, &block) end def initializers - @initializers ||= Collection.new - end - - def initializers=(initializers) - @initializers = initializers + @initializers ||= Collection.new(self) end end diff --git a/railties/lib/rails/initializer.rb b/railties/lib/rails/initializer.rb index d3e7f934ea..4487cacf7a 100644 --- a/railties/lib/rails/initializer.rb +++ b/railties/lib/rails/initializer.rb @@ -1,6 +1,5 @@ require "pathname" -require 'active_support/ordered_hash' require 'rails/initializable' require 'rails/application' require 'rails/railties_path' @@ -117,50 +116,6 @@ module Rails end 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' - require 'active_support/core_ext/kernel/reporting' - require 'active_support/core_ext/logger' - - # TODO: This is here to make Sam Ruby's tests pass. Needs discussion. - require 'active_support/core_ext/numeric/bytes' - 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 - - # 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 - - 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 - - # 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 - # Create tmp directories Initializer.default.add :ensure_tmp_directories_exist do %w(cache pids sessions sockets).each do |dir_to_make| @@ -373,7 +328,7 @@ module Rails Initializer.default.add :initialize_metal do # TODO: Make Rails and metal work without ActionController - if defined?(ActionController) + if configuration.frameworks.include?(:action_controller) Rails::Rack::Metal.requested_metals = configuration.metals Rails::Rack::Metal.metal_paths += plugin_loader.engine_metal_paths diff --git a/railties/test/application/initializable_test.rb b/railties/test/application/initializable_test.rb deleted file mode 100644 index 38eaec63c0..0000000000 --- a/railties/test/application/initializable_test.rb +++ /dev/null @@ -1,26 +0,0 @@ -require "isolation/abstract_unit" - -module ApplicationTests - class InitializerTest < Test::Unit::TestCase - include ActiveSupport::Testing::Isolation - - def setup - build_app - boot_rails - end - - test "initializers only ever run once" do - class MyApp < Rails::Application - initializer :counter do - $counter += 1 - end - end - - $counter = 0 - MyApp.initializers[:counter].run - MyApp.initializers[:counter].run - - assert_equal 1, $counter - end - end -end \ No newline at end of file diff --git a/railties/test/application/initializer_test.rb b/railties/test/application/initializer_test.rb index 9583e1606c..1b6af718c0 100644 --- a/railties/test/application/initializer_test.rb +++ b/railties/test/application/initializer_test.rb @@ -29,5 +29,30 @@ module ApplicationTests MyApp.new assert $:.include?("#{app_path}/app/models") end + + test "adding an unknown framework raises an error" do + class MyApp < Rails::Application + config.frameworks << :action_foo + end + + assert_raises RuntimeError do + MyApp.new + end + end + + test "eager loading loads parent classes before children" do + app_file "lib/zoo.rb", <<-ZOO + class Zoo ; include ReptileHouse ; end + ZOO + app_file "lib/zoo/reptile_house.rb", <<-ZOO + module Zoo::ReptileHouse ; end + ZOO + + Rails::Initializer.run do |config| + config.eager_load_paths = "#{app_path}/lib" + end + + assert Zoo + end end end \ No newline at end of file diff --git a/railties/test/application/plugins_test.rb b/railties/test/application/plugins_test.rb new file mode 100644 index 0000000000..2a433ea016 --- /dev/null +++ b/railties/test/application/plugins_test.rb @@ -0,0 +1,90 @@ +require "isolation/abstract_unit" + +module ApplicationTests + class PluginTest < Test::Unit::TestCase + include ActiveSupport::Testing::Isolation + + def assert_plugins(list_of_names, array_of_plugins, message=nil) + assert_equal list_of_names.map { |n| n.to_s }, array_of_plugins.map { |p| p.name }, message + end + + def setup + build_app + boot_rails + @failure_tip = "It's likely someone has added a new plugin fixture without updating this list" + # Tmp hax to get tests working + FileUtils.cp_r "#{File.dirname(__FILE__)}/../fixtures/plugins", "#{app_path}/vendor" + end + + test "all plugins are loaded when registered plugin list is untouched" do + Rails::Initializer.run { } + assert_plugins [ + :a, :acts_as_chunky_bacon, :engine, :gemlike, :plugin_with_no_lib_dir, :stubby + ], Rails.application.config.loaded_plugins, @failure_tip + end + + test "all plugins loaded after all" do + Rails::Initializer.run do |config| + config.plugins = [:stubby, :all, :acts_as_chunky_bacon] + end + assert_plugins [:stubby, :a, :engine, :gemlike, :plugin_with_no_lib_dir, :acts_as_chunky_bacon], Rails.application.config.loaded_plugins, @failure_tip + end + + test "plugin names may be strings" do + plugin_names = ['stubby', 'acts_as_chunky_bacon', :a, :plugin_with_no_lib_dir] + Rails::Initializer.run do |config| + config.plugins = ['stubby', 'acts_as_chunky_bacon', :a, :plugin_with_no_lib_dir] + end + + assert_plugins plugin_names, Rails.application.config.loaded_plugins, @failure_tip + end + + test "all plugins loaded when all is used" do + Rails::Initializer.run do |config| + config.plugins = [:stubby, :acts_as_chunky_bacon, :all] + end + + assert_plugins [:stubby, :acts_as_chunky_bacon, :a, :engine, :gemlike, :plugin_with_no_lib_dir], Rails.application.config.loaded_plugins, @failure_tip + end + + test "all loaded plugins are added to the load paths" do + Rails::Initializer.run do |config| + config.plugins = [:stubby, :acts_as_chunky_bacon] + end + + assert $LOAD_PATH.include?("#{app_path}/vendor/plugins/default/stubby/lib") + assert $LOAD_PATH.include?("#{app_path}/vendor/plugins/default/acts/acts_as_chunky_bacon/lib") + end + + test "registering a plugin name that does not exist raises a load error" do + assert_raise(LoadError) do + Rails::Initializer.run do |config| + config.plugins = [:stubby, :acts_as_a_non_existant_plugin] + end + end + end + + test "load error messages mention missing plugins and no others" do + valid_plugins = [:stubby, :acts_as_chunky_bacon] + invalid_plugins = [:non_existant_plugin1, :non_existant_plugin2] + + begin + Rails::Initializer.run do |config| + config.plugins = [:stubby, :acts_as_chunky_bacon, :non_existant_plugin1, :non_existant_plugin2] + end + flunk "Expected a LoadError but did not get one" + rescue LoadError => e + assert_plugins valid_plugins, Rails.application.config.loaded_plugins, @failure_tip + + invalid_plugins.each do |plugin| + assert_match(/#{plugin.to_s}/, e.message, "LoadError message should mention plugin '#{plugin}'") + end + + valid_plugins.each do |plugin| + assert_no_match(/#{plugin.to_s}/, e.message, "LoadError message should not mention '#{plugin}'") + end + end + end + + end +end \ No newline at end of file diff --git a/railties/test/initializable_test.rb b/railties/test/initializable_test.rb new file mode 100644 index 0000000000..4d8b429a4f --- /dev/null +++ b/railties/test/initializable_test.rb @@ -0,0 +1,56 @@ +require 'abstract_unit' +require 'rails/initializable' + +module InitializableTests + + class Foo + extend Rails::Initializable + + class << self + attr_accessor :foo, :bar + end + + initializer :omg do + @foo ||= 0 + @foo += 1 + end + end + + class Bar < Foo + initializer :bar do + @bar ||= 0 + @bar += 1 + end + end + + class Basic < ActiveSupport::TestCase + include ActiveSupport::Testing::Isolation + + test "initializers run" do + Foo.initializers.run + assert_equal 1, Foo.foo + end + + test "initializers are inherited" do + Bar.initializers.run + assert_equal [1, 1], [Bar.foo, Bar.bar] + end + + test "initializers only get run once" do + Foo.initializers.run + Foo.initializers.run + assert_equal 1, Foo.foo + end + + test "running initializers on children does not effect the parent" do + Bar.initializers.run + assert_nil Foo.foo + assert_nil Foo.bar + end + + test "inherited initializers are the same objects" do + assert Foo.initializers[:foo].eql?(Bar.initializers[:foo]) + end + + end +end \ No newline at end of file diff --git a/railties/test/initializer_test.rb b/railties/test/initializer_test.rb index 92383a74fd..616374b183 100644 --- a/railties/test/initializer_test.rb +++ b/railties/test/initializer_test.rb @@ -44,25 +44,6 @@ class Initializer_load_environment_Test < Test::Unit::TestCase end end -class Initializer_eager_loading_Test < Test::Unit::TestCase - def setup - @config = ConfigurationMock.new("") - @config.cache_classes = true - @config.load_paths = [File.expand_path(File.dirname(__FILE__) + "/fixtures/eager")] - @config.eager_load_paths = [File.expand_path(File.dirname(__FILE__) + "/fixtures/eager")] - @initializer = Rails::Initializer.default - @initializer.config = @config - @initializer.run(:set_load_path) - @initializer.run(:set_autoload_paths) - end - - def test_eager_loading_loads_parent_classes_before_children - assert_nothing_raised do - @initializer.run(:load_application_classes) - end - end -end - class Initializer_after_initialize_with_blocks_environment_Test < Test::Unit::TestCase def setup config = ConfigurationMock.new("") @@ -154,16 +135,6 @@ class ConfigurationFrameworkPathsTests < Test::Unit::TestCase end end - def test_unknown_framework_raises_error - @config.frameworks << :action_foo - - Class.any_instance.expects(:require).raises(LoadError) - - assert_raise RuntimeError do - @initializer.run(:require_frameworks) - end - end - def test_action_mailer_load_paths_set_only_if_action_mailer_in_use @config.frameworks = [:action_controller] @initializer.config = @config @@ -216,72 +187,6 @@ class InitializerPluginLoadingTests < Test::Unit::TestCase assert_plugins plugin_names, @configuration.loaded_plugins end - def test_all_plugins_are_loaded_when_registered_plugin_list_is_untouched - failure_tip = "It's likely someone has added a new plugin fixture without updating this list" - load_plugins! - assert_plugins [:a, :acts_as_chunky_bacon, :engine, :gemlike, :plugin_with_no_lib_dir, :stubby], @configuration.loaded_plugins, failure_tip - end - - def test_all_plugins_loaded_when_all_is_used - plugin_names = [:stubby, :acts_as_chunky_bacon, :all] - only_load_the_following_plugins! plugin_names - load_plugins! - failure_tip = "It's likely someone has added a new plugin fixture without updating this list" - assert_plugins [:stubby, :acts_as_chunky_bacon, :a, :engine, :gemlike, :plugin_with_no_lib_dir], @configuration.loaded_plugins, failure_tip - end - - def test_all_plugins_loaded_after_all - plugin_names = [:stubby, :all, :acts_as_chunky_bacon] - only_load_the_following_plugins! plugin_names - load_plugins! - failure_tip = "It's likely someone has added a new plugin fixture without updating this list" - assert_plugins [:stubby, :a, :engine, :gemlike, :plugin_with_no_lib_dir, :acts_as_chunky_bacon], @configuration.loaded_plugins, failure_tip - end - - def test_plugin_names_may_be_strings - plugin_names = ['stubby', 'acts_as_chunky_bacon', :a, :plugin_with_no_lib_dir] - only_load_the_following_plugins! plugin_names - load_plugins! - failure_tip = "It's likely someone has added a new plugin fixture without updating this list" - assert_plugins plugin_names, @configuration.loaded_plugins, failure_tip - end - - def test_registering_a_plugin_name_that_does_not_exist_raises_a_load_error - only_load_the_following_plugins! [:stubby, :acts_as_a_non_existant_plugin] - assert_raise(LoadError) do - load_plugins! - end - end - - def test_load_error_messages_mention_missing_plugins_and_no_others - valid_plugin_names = [:stubby, :acts_as_chunky_bacon] - invalid_plugin_names = [:non_existant_plugin1, :non_existant_plugin2] - only_load_the_following_plugins!( valid_plugin_names + invalid_plugin_names ) - begin - load_plugins! - flunk "Expected a LoadError but did not get one" - rescue LoadError => e - failure_tip = "It's likely someone renamed or deleted plugin fixtures without updating this test" - assert_plugins valid_plugin_names, @configuration.loaded_plugins, failure_tip - invalid_plugin_names.each do |plugin| - assert_match(/#{plugin.to_s}/, e.message, "LoadError message should mention plugin '#{plugin}'") - end - valid_plugin_names.each do |plugin| - assert_no_match(/#{plugin.to_s}/, e.message, "LoadError message should not mention '#{plugin}'") - end - - end - end - - def test_should_ensure_all_loaded_plugins_load_paths_are_added_to_the_load_path - only_load_the_following_plugins! [:stubby, :acts_as_chunky_bacon] - - @initializer.run(:add_plugin_load_paths) - - assert $LOAD_PATH.include?(File.join(plugin_fixture_path('default/stubby'), 'lib')) - assert $LOAD_PATH.include?(File.join(plugin_fixture_path('default/acts/acts_as_chunky_bacon'), 'lib')) - end - private def load_plugins! -- cgit v1.2.3 From feb04bf897dc3d904379d400f568b80116b18551 Mon Sep 17 00:00:00 2001 From: Carl Lerche Date: Thu, 8 Oct 2009 12:30:44 -0700 Subject: Move the ensure_tmp_directories_exist initializer to the application object --- railties/lib/rails/application.rb | 7 +++++++ railties/lib/rails/initializer.rb | 7 ------- 2 files changed, 7 insertions(+), 7 deletions(-) (limited to 'railties') diff --git a/railties/lib/rails/application.rb b/railties/lib/rails/application.rb index 011a9c489d..c7b92ef9b7 100644 --- a/railties/lib/rails/application.rb +++ b/railties/lib/rails/application.rb @@ -98,5 +98,12 @@ module Rails require 'active_support/dependencies' plugin_loader.add_plugin_load_paths end + + # Create tmp directories + initializer :ensure_tmp_directories_exist do + %w(cache pids sessions sockets).each do |dir_to_make| + FileUtils.mkdir_p(File.join(configuration.root_path, 'tmp', dir_to_make)) + end + end end end diff --git a/railties/lib/rails/initializer.rb b/railties/lib/rails/initializer.rb index 4487cacf7a..687455feca 100644 --- a/railties/lib/rails/initializer.rb +++ b/railties/lib/rails/initializer.rb @@ -116,13 +116,6 @@ module Rails end end - # Create tmp directories - Initializer.default.add :ensure_tmp_directories_exist do - %w(cache pids sessions sockets).each do |dir_to_make| - FileUtils.mkdir_p(File.join(configuration.root_path, 'tmp', dir_to_make)) - end - end - # Loads the environment specified by Configuration#environment_path, which # is typically one of development, test, or production. Initializer.default.add :load_environment do -- cgit v1.2.3 From 7faa52a424a7a9edea796babf6d091930df5396a Mon Sep 17 00:00:00 2001 From: Carl Lerche Date: Thu, 8 Oct 2009 12:30:58 -0700 Subject: Add a test that ensures that Rails::Initializable can be used with modules --- railties/test/initializable_test.rb | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'railties') diff --git a/railties/test/initializable_test.rb b/railties/test/initializable_test.rb index 4d8b429a4f..7c8aed00c9 100644 --- a/railties/test/initializable_test.rb +++ b/railties/test/initializable_test.rb @@ -23,6 +23,14 @@ module InitializableTests end end + module Word + extend Rails::Initializable + + initializer :word do + $word = "bird" + end + end + class Basic < ActiveSupport::TestCase include ActiveSupport::Testing::Isolation @@ -52,5 +60,9 @@ module InitializableTests assert Foo.initializers[:foo].eql?(Bar.initializers[:foo]) end + test "initializing with modules" do + Word.initializers.run + assert_equal "bird", $word + end end end \ No newline at end of file -- cgit v1.2.3 From ed77e84c4b00bf1d2269af6a07575c30039d942d Mon Sep 17 00:00:00 2001 From: Carl Lerche Date: Thu, 8 Oct 2009 15:08:08 -0700 Subject: Ported over more initializers --- railties/lib/rails/application.rb | 42 ++++++++++++++++++++++++++- railties/lib/rails/initializer.rb | 42 --------------------------- railties/test/application/initializer_test.rb | 7 +++++ railties/test/initializer_test.rb | 11 ------- 4 files changed, 48 insertions(+), 54 deletions(-) (limited to 'railties') diff --git a/railties/lib/rails/application.rb b/railties/lib/rails/application.rb index c7b92ef9b7..5b5f6842b9 100644 --- a/railties/lib/rails/application.rb +++ b/railties/lib/rails/application.rb @@ -102,7 +102,47 @@ module Rails # Create tmp directories initializer :ensure_tmp_directories_exist do %w(cache pids sessions sockets).each do |dir_to_make| - FileUtils.mkdir_p(File.join(configuration.root_path, 'tmp', dir_to_make)) + FileUtils.mkdir_p(File.join(config.root_path, 'tmp', dir_to_make)) + end + end + + # Loads the environment specified by Configuration#environment_path, which + # is typically one of development, test, or production. + initializer :load_environment do + silence_warnings do + next if @environment_loaded + next unless File.file?(config.environment_path) + + @environment_loaded = true + 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 + + initializer :add_gem_load_paths do + require 'rails/gem_dependency' + Rails::GemDependency.add_frozen_gem_path + unless config.gems.empty? + require "rubygems" + config.gems.each { |gem| gem.add_load_paths } + end + 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 :preload_frameworks do + if config.preload_frameworks + config.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 end diff --git a/railties/lib/rails/initializer.rb b/railties/lib/rails/initializer.rb index 687455feca..bfdecd0f80 100644 --- a/railties/lib/rails/initializer.rb +++ b/railties/lib/rails/initializer.rb @@ -116,48 +116,6 @@ module Rails end end - # 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 - next if @environment_loaded - next unless File.file?(configuration.environment_path) - - @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 - - Initializer.default.add :add_gem_load_paths do - require 'rails/gem_dependency' - Rails::GemDependency.add_frozen_gem_path - unless config.gems.empty? - require "rubygems" - config.gems.each { |gem| gem.add_load_paths } - end - 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 - # 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 diff --git a/railties/test/application/initializer_test.rb b/railties/test/application/initializer_test.rb index 1b6af718c0..6de07b4122 100644 --- a/railties/test/application/initializer_test.rb +++ b/railties/test/application/initializer_test.rb @@ -54,5 +54,12 @@ module ApplicationTests assert Zoo end + + test "load environment with global" do + app_file "config/environments/development.rb", "$initialize_test_set_from_env = 'success'" + assert_nil $initialize_test_set_from_env + Rails::Initializer.run { } + assert_equal "success", $initialize_test_set_from_env + end end end \ No newline at end of file diff --git a/railties/test/initializer_test.rb b/railties/test/initializer_test.rb index 616374b183..219c65e637 100644 --- a/railties/test/initializer_test.rb +++ b/railties/test/initializer_test.rb @@ -33,17 +33,6 @@ class ConfigurationMock < Rails::Configuration end end -class Initializer_load_environment_Test < Test::Unit::TestCase - def test_load_environment_with_constant - config = ConfigurationMock.new("#{File.dirname(__FILE__)}/fixtures/environment_with_constant.rb") - assert_nil $initialize_test_set_from_env - Rails::Initializer.run(:load_environment, config) - assert_equal "success", $initialize_test_set_from_env - ensure - $initialize_test_set_from_env = nil - end -end - class Initializer_after_initialize_with_blocks_environment_Test < Test::Unit::TestCase def setup config = ConfigurationMock.new("") -- cgit v1.2.3 From 5c42157cd83b022d05738c6759e38536f74fc572 Mon Sep 17 00:00:00 2001 From: Carl Lerche Date: Thu, 8 Oct 2009 15:30:17 -0700 Subject: Even more initializers ported over --- railties/lib/rails/application.rb | 134 ++++++++++++++++++++++++- railties/lib/rails/initializer.rb | 135 +------------------------- railties/test/application/initializer_test.rb | 7 ++ railties/test/initializer_test.rb | 7 -- 4 files changed, 141 insertions(+), 142 deletions(-) (limited to 'railties') diff --git a/railties/lib/rails/application.rb b/railties/lib/rails/application.rb index 5b5f6842b9..5c1c69d5e0 100644 --- a/railties/lib/rails/application.rb +++ b/railties/lib/rails/application.rb @@ -116,7 +116,7 @@ module Rails @environment_loaded = true constants = self.class.constants - eval(IO.read(configuration.environment_path), binding, configuration.environment_path) + eval(IO.read(config.environment_path), binding, config.environment_path) (self.class.constants - constants).each do |const| Object.const_set(const, self.class.const_get(const)) @@ -145,5 +145,137 @@ module Rails end end end + + # 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. + initializer :initialize_database do + if config.frameworks.include?(:active_record) + ActiveRecord::Base.configurations = config.database_configuration + ActiveRecord::Base.establish_connection + end + end + + # Include middleware to serve up static assets + initializer :initialize_static_server do + if config.frameworks.include?(:action_controller) && config.serve_static_assets + config.middleware.use(ActionDispatch::Static, Rails.public_path) + end + end + + initializer :initialize_middleware_stack do + if config.frameworks.include?(:action_controller) + config.middleware.use(::Rack::Lock) unless ActionController::Base.allow_concurrency + config.middleware.use(ActionDispatch::ShowExceptions, ActionController::Base.consider_all_requests_local) + config.middleware.use(ActionDispatch::Callbacks, ActionController::Dispatcher.prepare_each_request) + config.middleware.use(lambda { ActionController::Base.session_store }, lambda { ActionController::Base.session_options }) + config.middleware.use(ActionDispatch::ParamsParser) + config.middleware.use(::Rack::MethodOverride) + config.middleware.use(::Rack::Head) + config.middleware.use(ActionDispatch::StringCoercion) + end + end + + initializer :initialize_cache do + unless defined?(RAILS_CACHE) + silence_warnings { Object.const_set "RAILS_CACHE", ActiveSupport::Cache.lookup_store(config.cache_store) } + + if RAILS_CACHE.respond_to?(:middleware) + # Insert middleware to setup and teardown local cache for each request + config.middleware.insert_after(:"Rack::Lock", RAILS_CACHE.middleware) + end + end + end + + initializer :initialize_framework_caches do + if config.frameworks.include?(:action_controller) + ActionController::Base.cache_store ||= RAILS_CACHE + end + end + + initializer :initialize_logger do + # if the environment has explicitly defined a logger, use it + next if Rails.logger + + unless logger = config.logger + begin + logger = ActiveSupport::BufferedLogger.new(config.log_path) + logger.level = ActiveSupport::BufferedLogger.const_get(config.log_level.to_s.upcase) + if RAILS_ENV == "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 #{config.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 + + # TODO: Why are we silencing warning here? + 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. + initializer :initialize_framework_logging do + for framework in ([ :active_record, :action_controller, :action_mailer ] & config.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 the dependency loading mechanism based on the value of + # Configuration#cache_classes. + initializer :initialize_dependency_mechanism do + # TODO: Remove files from the $" and always use require + ActiveSupport::Dependencies.mechanism = config.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. + initializer :initialize_whiny_nils do + require('active_support/whiny_nil') if config.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. + initializer :initialize_time_zone do + if config.time_zone + zone_default = Time.__send__(:get_zone, config.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 config.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. + initializer :initialize_i18n do + config.i18n.each do |setting, value| + if setting == :load_path + I18n.load_path += value + else + I18n.send("#{setting}=", value) + end + end + end end end diff --git a/railties/lib/rails/initializer.rb b/railties/lib/rails/initializer.rb index bfdecd0f80..eb24707ed9 100644 --- a/railties/lib/rails/initializer.rb +++ b/railties/lib/rails/initializer.rb @@ -107,148 +107,15 @@ module Rails default.run(initializer) else Rails.application = Class.new(Application) + yield Rails.application.config if block_given? # Trigger the initializer Rails.application.new - yield Rails.application.config if block_given? default.config = Rails.application.config default.run end end end - # 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. - Initializer.default.add :initialize_database do - if configuration.frameworks.include?(:active_record) - ActiveRecord::Base.configurations = configuration.database_configuration - ActiveRecord::Base.establish_connection - end - end - - # Include middleware to serve up static assets - Initializer.default.add :initialize_static_server do - if configuration.frameworks.include?(:action_controller) && configuration.serve_static_assets - configuration.middleware.use(ActionDispatch::Static, Rails.public_path) - end - end - - Initializer.default.add :initialize_middleware_stack do - if configuration.frameworks.include?(:action_controller) - configuration.middleware.use(::Rack::Lock) unless ActionController::Base.allow_concurrency - configuration.middleware.use(ActionDispatch::ShowExceptions, ActionController::Base.consider_all_requests_local) - configuration.middleware.use(ActionDispatch::Callbacks, ActionController::Dispatcher.prepare_each_request) - configuration.middleware.use(lambda { ActionController::Base.session_store }, lambda { ActionController::Base.session_options }) - configuration.middleware.use(ActionDispatch::ParamsParser) - configuration.middleware.use(::Rack::MethodOverride) - configuration.middleware.use(::Rack::Head) - configuration.middleware.use(ActionDispatch::StringCoercion) - end - end - - Initializer.default.add :initialize_cache do - 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 - - Initializer.default.add :initialize_framework_caches do - if configuration.frameworks.include?(:action_controller) - ActionController::Base.cache_store ||= RAILS_CACHE - end - end - - 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 RAILS_ENV == "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 - - # TODO: Why are we silencing warning here? - 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. - 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 - - ActiveSupport::Dependencies.logger ||= Rails.logger - Rails.cache.logger ||= Rails.logger - end - - # Sets the dependency loading mechanism based on the value of - # Configuration#cache_classes. - Initializer.default.add :initialize_dependency_mechanism do - # TODO: Remove files from the $" and always use require - 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. - Initializer.default.add :initialize_whiny_nils do - 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. - Initializer.default.add :initialize_time_zone do - 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. - 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 - 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. diff --git a/railties/test/application/initializer_test.rb b/railties/test/application/initializer_test.rb index 6de07b4122..c57ed08fdc 100644 --- a/railties/test/application/initializer_test.rb +++ b/railties/test/application/initializer_test.rb @@ -55,6 +55,13 @@ module ApplicationTests assert Zoo end + test "setting another default locale" do + Rails::Initializer.run do |config| + config.i18n.default_locale = :de + end + assert_equal :de, I18n.default_locale + end + test "load environment with global" do app_file "config/environments/development.rb", "$initialize_test_set_from_env = 'success'" assert_nil $initialize_test_set_from_env diff --git a/railties/test/initializer_test.rb b/railties/test/initializer_test.rb index 219c65e637..e1c497c8a8 100644 --- a/railties/test/initializer_test.rb +++ b/railties/test/initializer_test.rb @@ -286,13 +286,6 @@ class InitializerSetupI18nTests < Test::Unit::TestCase assert_equal [ "my/test/locale.yml", "my/other/locale.yml" ], config.i18n.load_path end - - def test_setting_another_default_locale - config = Rails::Configuration.new - config.i18n.default_locale = :de - Rails::Initializer.run(:initialize_i18n, config) - assert_equal :de, I18n.default_locale - end end class InitializerDatabaseMiddlewareTest < Test::Unit::TestCase -- cgit v1.2.3 From 992c2db76cd6cd6aa9a6ba3711a6ea1ad8910062 Mon Sep 17 00:00:00 2001 From: Carl Lerche Date: Thu, 8 Oct 2009 18:12:28 -0700 Subject: Finish porting over the initializers to the app object and fix all the tests --- railties/lib/rails/application.rb | 206 +++++++++++++++ railties/lib/rails/core.rb | 6 +- railties/lib/rails/initializer.rb | 296 +--------------------- railties/test/application/generators_test.rb | 89 +++++++ railties/test/application/initializer_test.rb | 132 +++++++++- railties/test/application/plugins_test.rb | 11 + railties/test/initializer/path_test.rb | 2 +- railties/test/initializer_test.rb | 351 -------------------------- railties/test/isolation/abstract_unit.rb | 4 + railties/test/new_initializer_test.rb | 165 ------------ railties/test/plugin_loader_test.rb | 17 +- railties/test/plugin_locator_test.rb | 16 +- railties/test/plugin_test.rb | 15 +- 13 files changed, 476 insertions(+), 834 deletions(-) create mode 100644 railties/test/application/generators_test.rb delete mode 100644 railties/test/new_initializer_test.rb (limited to 'railties') diff --git a/railties/lib/rails/application.rb b/railties/lib/rails/application.rb index 5c1c69d5e0..d54120f850 100644 --- a/railties/lib/rails/application.rb +++ b/railties/lib/rails/application.rb @@ -277,5 +277,211 @@ module Rails end 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. + initializer :initialize_framework_settings do + config.frameworks.each do |framework| + base_class = framework.to_s.camelize.constantize.const_get("Base") + + config.send(framework).each do |setting, value| + base_class.send("#{setting}=", value) + end + end + config.active_support.each do |setting, value| + ActiveSupport.send("#{setting}=", value) + 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. + initializer :initialize_framework_views do + if config.frameworks.include?(:action_view) + view_path = ActionView::PathSet.type_cast(config.view_path, config.cache_classes) + ActionMailer::Base.template_root = view_path if config.frameworks.include?(:action_mailer) && ActionMailer::Base.view_paths.blank? + ActionController::Base.view_paths = view_path if config.frameworks.include?(:action_controller) && ActionController::Base.view_paths.blank? + end + end + + initializer :initialize_metal do + # TODO: Make Rails and metal work without ActionController + if config.frameworks.include?(:action_controller) + Rails::Rack::Metal.requested_metals = config.metals + Rails::Rack::Metal.metal_paths += plugin_loader.engine_metal_paths + + config.middleware.insert_before( + :"ActionDispatch::ParamsParser", + Rails::Rack::Metal, :if => Rails::Rack::Metal.metals.any?) + end + end + + initializer :check_for_unbuilt_gems do + unbuilt_gems = config.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 + + initializer :load_gems do + unless $gems_rake_task + config.gems.each { |gem| gem.load } + end + end + + # 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 + initializer :load_plugins do + plugin_loader.load_plugins + end + + # TODO: Figure out if this needs to run a second time + # load_gems + + initializer :check_gem_dependencies do + unloaded_gems = config.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 "} + + 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 + configuration.gems_dependencies_loaded = true + end + 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 + + initializer :load_application_initializers do + if config.gems_dependencies_loaded + Dir["#{configuration.root_path}/config/initializers/**/*.rb"].sort.each do |initializer| + load(initializer) + end + end + end + + # Fires the user-supplied after_initialize block (Configuration#after_initialize) + initializer :after_initialize do + if config.gems_dependencies_loaded + configuration.after_initialize_blocks.each do |block| + block.call + end + end + end + + # # Setup database middleware after initializers have run + initializer :initialize_database_middleware do + if configuration.frameworks.include?(:active_record) + if configuration.frameworks.include?(:action_controller) && ActionController::Base.session_store && + 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 + + # TODO: Make a DSL way to limit an initializer to a particular framework + + # # Prepare dispatcher callbacks and run 'prepare' callbacks + initializer :prepare_dispatcher do + next unless configuration.frameworks.include?(:action_controller) + require 'rails/dispatcher' unless defined?(::Dispatcher) + Dispatcher.define_dispatcher_callbacks(configuration.cache_classes) + 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 :initialize_routing do + next 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 + # + # # Observers are loaded after plugins in case Observers or observed models are modified by plugins. + initializer :load_observers do + if config.gems_dependencies_loaded && configuration.frameworks.include?(:active_record) + ActiveRecord::Base.instantiate_observers + end + end + + # Eager load application classes + initializer :load_application_classes do + next 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 + + # Disable dependency loading during request cycle + initializer :disable_dependency_loading do + if configuration.cache_classes && !configuration.dependency_loading + ActiveSupport::Dependencies.unhook! + end + end + + # Configure generators if they were already loaded + # === + # TODO: Does this need to be an initializer here? + initializer :initialize_generators do + if defined?(Rails::Generators) + Rails::Generators.no_color! unless config.generators.colorize_logging + Rails::Generators.aliases.deep_merge! config.generators.aliases + Rails::Generators.options.deep_merge! config.generators.options + end + end end end diff --git a/railties/lib/rails/core.rb b/railties/lib/rails/core.rb index 4be90de792..929c38bd22 100644 --- a/railties/lib/rails/core.rb +++ b/railties/lib/rails/core.rb @@ -15,11 +15,7 @@ module Rails # The Configuration instance used to configure the Rails environment def configuration - @@configuration - end - - def configuration=(configuration) - @@configuration = configuration + application.configuration end def initialized? diff --git a/railties/lib/rails/initializer.rb b/railties/lib/rails/initializer.rb index eb24707ed9..f7c3774450 100644 --- a/railties/lib/rails/initializer.rb +++ b/railties/lib/rails/initializer.rb @@ -15,308 +15,14 @@ RAILS_ENV = (ENV['RAILS_ENV'] || 'development').dup unless defined?(RAILS_ENV) module Rails class Initializer class Error < StandardError ; end - - class Base - class << self - def run(&blk) - define_method(:run, &blk) - end - - def config=(config) - @@config = config - end - - def config - @@config || Configuration.new - end - alias configuration config - - def gems_dependencies_loaded - config.gems_dependencies_loaded - end - - def plugin_loader - @plugin_loader ||= configuration.plugin_loader.new(self) - end - end - - def gems_dependencies_loaded - self.class.gems_dependencies_loaded - end - - def plugin_loader - self.class.plugin_loader - end - end - - class Runner - - attr_reader :names, :initializers - attr_accessor :config - alias configuration config - - def initialize(parent = nil) - @names = parent ? parent.names.dup : {} - @initializers = parent ? parent.initializers.dup : [] - end - - 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 - - @initializers.insert(index || -1, block) - @names[name] = block - end - - def delete(name) - @names[name].tap do |initializer| - @initializers.delete(initializer) - @names.delete(name) - end - end - - 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 - - def run(initializer = nil) - Rails.configuration = Base.config = @config - - if initializer - run_initializer(initializer) - else - @initializers.each {|block| run_initializer(block) } - end - end - end - - def self.default - @default ||= Runner.new - end - def self.run(initializer = nil, config = nil) - # TODO: Clean this all up if initializer - default.config = config - default.run(initializer) + # Deprecated else Rails.application = Class.new(Application) yield Rails.application.config if block_given? - # Trigger the initializer Rails.application.new - default.config = Rails.application.config - default.run - end - 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. - Initializer.default.add :initialize_framework_settings do - 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 - - # 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 - - Initializer.default.add :initialize_metal do - # TODO: Make Rails and metal work without ActionController - if configuration.frameworks.include?(:action_controller) - 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 - end - - Initializer.default.add :check_for_unbuilt_gems do - unbuilt_gems = config.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 - - Initializer.default.add :load_gems do - unless $gems_rake_task - config.gems.each { |gem| gem.load } - end - end - - # 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 - Initializer.default.add :load_plugins do - plugin_loader.load_plugins - end - - # TODO: Figure out if this needs to run a second time - # load_gems - - Initializer.default.add :check_gem_dependencies do - unloaded_gems = config.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 "} - -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 - configuration.gems_dependencies_loaded = true - end - 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 - - 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 - - # 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 - - # # 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 && - 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 - - # TODO: Make a DSL way to limit an initializer to a particular framework - - # # Prepare dispatcher callbacks and run 'prepare' callbacks - Initializer.default.add :prepare_dispatcher do - next unless configuration.frameworks.include?(:action_controller) - require 'rails/dispatcher' unless defined?(::Dispatcher) - Dispatcher.define_dispatcher_callbacks(configuration.cache_classes) - 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 - next 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 - # - # # 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 - - # Eager load application classes - Initializer.default.add :load_application_classes do - next 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 - - # 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 - - # Configure generators if they were already loaded - Initializer.default.add :initialize_generators do - if defined?(Rails::Generators) - Rails::Generators.no_color! unless config.generators.colorize_logging - Rails::Generators.aliases.deep_merge! config.generators.aliases - Rails::Generators.options.deep_merge! config.generators.options - end end end diff --git a/railties/test/application/generators_test.rb b/railties/test/application/generators_test.rb new file mode 100644 index 0000000000..0d6eb4147a --- /dev/null +++ b/railties/test/application/generators_test.rb @@ -0,0 +1,89 @@ +require "isolation/abstract_unit" + +module ApplicationTests + class GeneratorsTest < Test::Unit::TestCase + include ActiveSupport::Testing::Isolation + + def setup + require "rails/generators" + build_app + boot_rails + end + + test "generators default values" do + Rails::Initializer.run do |c| + assert_equal(true, c.generators.colorize_logging) + assert_equal({}, c.generators.aliases) + assert_equal({}, c.generators.options) + end + end + + test "generators set rails options" do + Rails::Initializer.run do |c| + c.generators.orm = :datamapper + c.generators.test_framework = :rspec + expected = { :rails => { :orm => :datamapper, :test_framework => :rspec } } + assert_equal(expected, c.generators.options) + end + end + + test "generators set rails aliases" do + Rails::Initializer.run do |c| + c.generators.aliases = { :rails => { :test_framework => "-w" } } + expected = { :rails => { :test_framework => "-w" } } + assert_equal expected, c.generators.aliases + end + end + + test "generators aliases and options on initialization" do + Rails::Initializer.run do |c| + c.generators.rails :aliases => { :test_framework => "-w" } + c.generators.orm :datamapper + c.generators.test_framework :rspec + end + + assert_equal :rspec, Rails::Generators.options[:rails][:test_framework] + assert_equal "-w", Rails::Generators.aliases[:rails][:test_framework] + end + + test "generators no color on initialization" do + Rails::Initializer.run do |c| + c.generators.colorize_logging = false + end + + assert_equal Thor::Base.shell, Thor::Shell::Basic + end + + test "generators with hashes for options and aliases" do + Rails::Initializer.run do |c| + c.generators do |g| + g.orm :datamapper, :migration => false + g.plugin :aliases => { :generator => "-g" }, + :generator => true + end + + expected = { + :rails => { :orm => :datamapper }, + :plugin => { :generator => true }, + :datamapper => { :migration => false } + } + + assert_equal expected, c.generators.options + assert_equal({ :plugin => { :generator => "-g" } }, c.generators.aliases) + end + end + + test "generators with hashes are deep merged" do + Rails::Initializer.run do |c| + c.generators do |g| + g.orm :datamapper, :migration => false + g.plugin :aliases => { :generator => "-g" }, + :generator => true + end + end + + assert Rails::Generators.aliases.size >= 1 + assert Rails::Generators.options.size >= 1 + end + end +end \ No newline at end of file diff --git a/railties/test/application/initializer_test.rb b/railties/test/application/initializer_test.rb index c57ed08fdc..f46bf2b656 100644 --- a/railties/test/application/initializer_test.rb +++ b/railties/test/application/initializer_test.rb @@ -55,6 +55,59 @@ module ApplicationTests assert Zoo end + test "load environment with global" do + app_file "config/environments/development.rb", "$initialize_test_set_from_env = 'success'" + assert_nil $initialize_test_set_from_env + Rails::Initializer.run { } + assert_equal "success", $initialize_test_set_from_env + end + + test "action_controller load paths set only if action controller in use" do + assert_nothing_raised NameError do + Rails::Initializer.run do |config| + config.frameworks = [] + end + end + end + + test "action_pack is added to the load path if action_controller is required" do + Rails::Initializer.run do |config| + config.frameworks = [:action_controller] + end + + assert $:.include?("#{framework_path}/actionpack/lib") + end + + test "action_pack is added to the load path if action_view is required" do + Rails::Initializer.run do |config| + config.frameworks = [:action_view] + end + + assert $:.include?("#{framework_path}/actionpack/lib") + end + + test "after_initialize block works correctly" do + Rails::Initializer.run do |config| + config.after_initialize { $test_after_initialize_block1 = "success" } + config.after_initialize { $test_after_initialize_block2 = "congratulations" } + end + + assert_equal "success", $test_after_initialize_block1 + assert_equal "congratulations", $test_after_initialize_block2 + end + + test "after_initialize block works correctly when no block is passed" do + Rails::Initializer.run do |config| + config.after_initialize { $test_after_initialize_block1 = "success" } + config.after_initialize # don't pass a block, this is what we're testing! + config.after_initialize { $test_after_initialize_block2 = "congratulations" } + end + + assert_equal "success", $test_after_initialize_block1 + assert_equal "congratulations", $test_after_initialize_block2 + end + + # i18n test "setting another default locale" do Rails::Initializer.run do |config| config.i18n.default_locale = :de @@ -62,11 +115,80 @@ module ApplicationTests assert_equal :de, I18n.default_locale end - test "load environment with global" do - app_file "config/environments/development.rb", "$initialize_test_set_from_env = 'success'" - assert_nil $initialize_test_set_from_env - Rails::Initializer.run { } - assert_equal "success", $initialize_test_set_from_env + test "no config locales dir present should return empty load path" do + FileUtils.rm_rf "#{app_path}/config/locales" + Rails::Initializer.run do |c| + assert_equal [], c.i18n.load_path + end + end + + test "config locales dir present should be added to load path" do + Rails::Initializer.run do |c| + assert_equal ["#{app_path}/config/locales/en.yml"], c.i18n.load_path + end + end + + test "config defaults should be added with config settings" do + Rails::Initializer.run do |c| + c.i18n.load_path << "my/other/locale.yml" + end + + assert_equal [ + "#{app_path}/config/locales/en.yml", "my/other/locale.yml" + ], Rails.application.config.i18n.load_path + end + + # DB middleware + test "database middleware doesn't initialize when session store is not active_record" do + Rails::Initializer.run do |config| + config.action_controller.session_store = :cookie_store + end + + assert !Rails.application.config.middleware.include?(ActiveRecord::SessionStore) + end + + test "database middleware doesn't initialize when activerecord is not in frameworks" do + Rails::Initializer.run do |c| + c.frameworks = [] + end + assert_equal [], Rails.application.config.middleware + end + + test "database middleware initializes when session store is active record" do + Rails::Initializer.run do |c| + c.action_controller.session_store = :active_record_store + end + + expects = [ActiveRecord::ConnectionAdapters::ConnectionManagement, ActiveRecord::QueryCache, ActiveRecord::SessionStore] + middleware = Rails.application.config.middleware.map { |m| m.klass } + assert_equal expects, middleware & expects + end + + test "ensure database middleware doesn't use action_controller on initializing" do + Rails::Initializer.run do |c| + c.frameworks -= [:action_controller] + c.action_controller.session_store = :active_record_store + end + + assert !Rails.application.config.middleware.include?(ActiveRecord::SessionStore) + end + + # Pathview test + test "load view paths doesn't perform anything when action_view not in frameworks" do + Rails::Initializer.run do |c| + c.frameworks -= [:action_view] + end + assert_equal nil, ActionMailer::Base.template_root + assert_equal [], ActionController::Base.view_paths + end + + # Rails root test + test "Rails.root == RAILS_ROOT" do + assert_equal RAILS_ROOT, Rails.root.to_s + end + + test "Rails.root should be a Pathname" do + assert_instance_of Pathname, Rails.root end end end \ No newline at end of file diff --git a/railties/test/application/plugins_test.rb b/railties/test/application/plugins_test.rb index 2a433ea016..81e7f4d88c 100644 --- a/railties/test/application/plugins_test.rb +++ b/railties/test/application/plugins_test.rb @@ -23,6 +23,17 @@ module ApplicationTests ], Rails.application.config.loaded_plugins, @failure_tip end + test "no plugins are loaded if the configuration has an empty plugin list" do + Rails::Initializer.run { |c| c.plugins = [] } + assert_plugins [], Rails.application.config.loaded_plugins + end + + test "only the specified plugins are located in the order listed" do + plugin_names = [:plugin_with_no_lib_dir, :acts_as_chunky_bacon] + Rails::Initializer.run { |c| c.plugins = plugin_names } + assert_plugins plugin_names, Rails.application.config.loaded_plugins + end + test "all plugins loaded after all" do Rails::Initializer.run do |config| config.plugins = [:stubby, :all, :acts_as_chunky_bacon] diff --git a/railties/test/initializer/path_test.rb b/railties/test/initializer/path_test.rb index a4264bc31c..72ff8d88e0 100644 --- a/railties/test/initializer/path_test.rb +++ b/railties/test/initializer/path_test.rb @@ -12,7 +12,7 @@ class PathsTest < Test::Unit::TestCase ActionController::Base.session_store = nil end end - @paths = Rails::Initializer.default.config.paths + @paths = Rails.application.config.paths end def root(*path) diff --git a/railties/test/initializer_test.rb b/railties/test/initializer_test.rb index e1c497c8a8..80e774b7b7 100644 --- a/railties/test/initializer_test.rb +++ b/railties/test/initializer_test.rb @@ -6,359 +6,8 @@ require 'action_view' require 'action_mailer' require 'active_record' -# Mocks out the configuration -module Rails - def self.configuration - Rails::Configuration.new - end - - module Generators - def self.clear_aliases! - @aliases = nil - end - - def self.clear_options! - @@options = nil - end - end -end - - -class ConfigurationMock < Rails::Configuration - attr_reader :environment_path - - def initialize(envpath) - super() - @environment_path = envpath - end -end - -class Initializer_after_initialize_with_blocks_environment_Test < Test::Unit::TestCase - def setup - config = ConfigurationMock.new("") - config.after_initialize do - $test_after_initialize_block1 = "success" - end - config.after_initialize do - $test_after_initialize_block2 = "congratulations" - end - assert_nil $test_after_initialize_block1 - assert_nil $test_after_initialize_block2 - - config.expects(:gems_dependencies_loaded).returns(true) - Rails::Initializer.run(:after_initialize, config) - end - - def teardown - $test_after_initialize_block1 = nil - $test_after_initialize_block2 = nil - end - - def test_should_have_called_the_first_after_initialize_block - assert_equal "success", $test_after_initialize_block1 - end - - def test_should_have_called_the_second_after_initialize_block - assert_equal "congratulations", $test_after_initialize_block2 - end -end - -class Initializer_after_initialize_with_no_block_environment_Test < Test::Unit::TestCase - def setup - config = ConfigurationMock.new("") - config.after_initialize do - $test_after_initialize_block1 = "success" - end - config.after_initialize # don't pass a block, this is what we're testing! - config.after_initialize do - $test_after_initialize_block2 = "congratulations" - end - assert_nil $test_after_initialize_block1 - - config.expects(:gems_dependencies_loaded).returns(true) - Rails::Initializer.run(:after_initialize, config) - end - - def teardown - $test_after_initialize_block1 = nil - $test_after_initialize_block2 = nil - end - - def test_should_have_called_the_first_after_initialize_block - assert_equal "success", $test_after_initialize_block1, "should still get set" - end - - def test_should_have_called_the_second_after_initialize_block - assert_equal "congratulations", $test_after_initialize_block2 - end -end - -class ConfigurationFrameworkPathsTests < Test::Unit::TestCase - def setup - @config = Rails::Configuration.new - @config.frameworks.clear - @initializer = Rails::Initializer.default - @initializer.config = @config - - File.stubs(:directory?).returns(true) - Rails::Initializer.run(:set_root_path, @config) - end - - def test_minimal - expected = %w(railties railties/lib activesupport/lib) - assert_equal expected.map {|e| "#{@config.framework_root_path}/#{e}"}, @config.framework_paths - end - - def test_actioncontroller_or_actionview_add_actionpack - @config.frameworks << :action_controller - assert_framework_path "actionpack/lib" - - @config.frameworks = [:action_view] - assert_framework_path 'actionpack/lib' - end - - def test_paths_for_ar_ares_and_mailer - [:active_record, :action_mailer, :active_resource, :action_web_service].each do |framework| - @config.frameworks = [framework] - assert_framework_path "#{framework.to_s.gsub('_', '')}/lib" - end - end - - def test_action_mailer_load_paths_set_only_if_action_mailer_in_use - @config.frameworks = [:action_controller] - @initializer.config = @config - @initializer.run :require_frameworks - - assert_nothing_raised NameError do - @initializer.run :load_view_paths - end - end - - def test_action_controller_load_paths_set_only_if_action_controller_in_use - @config.frameworks = [] - @initializer.run :require_frameworks - - assert_nothing_raised NameError do - @initializer.run :load_view_paths - end - end - - protected - def assert_framework_path(path) - assert @config.framework_paths.include?("#{@config.framework_root_path}/#{path}"), - "<#{path.inspect}> not found among <#{@config.framework_paths.inspect}>" - end -end - require 'plugin_test_helper' -class InitializerPluginLoadingTests < Test::Unit::TestCase - def setup - @configuration = Rails::Configuration.new - @configuration.frameworks -= [:action_mailer] - @configuration.plugin_paths << plugin_fixture_root_path - @initializer = Rails::Initializer.default - @initializer.config = @configuration - @valid_plugin_path = plugin_fixture_path('default/stubby') - @empty_plugin_path = plugin_fixture_path('default/empty') - end - - def test_no_plugins_are_loaded_if_the_configuration_has_an_empty_plugin_list - only_load_the_following_plugins! [] - @initializer.run :load_plugins - assert_equal [], @configuration.loaded_plugins - end - - def test_only_the_specified_plugins_are_located_in_the_order_listed - plugin_names = [:plugin_with_no_lib_dir, :acts_as_chunky_bacon] - only_load_the_following_plugins! plugin_names - load_plugins! - assert_plugins plugin_names, @configuration.loaded_plugins - end - - private - - def load_plugins! - @initializer.run(:add_plugin_load_paths) - @initializer.run(:load_plugins) - end -end - -class InitializerGeneratorsTests < Test::Unit::TestCase - - def setup - @configuration = Rails::Configuration.new - @initializer = Rails::Initializer.default - @initializer.config = @configuration - end - - def test_generators_default_values - assert_equal(true, @configuration.generators.colorize_logging) - assert_equal({}, @configuration.generators.aliases) - assert_equal({}, @configuration.generators.options) - end - - def test_generators_set_rails_options - @configuration.generators.orm = :datamapper - @configuration.generators.test_framework = :rspec - expected = { :rails => { :orm => :datamapper, :test_framework => :rspec } } - assert_equal expected, @configuration.generators.options - end - - def test_generators_set_rails_aliases - @configuration.generators.aliases = { :rails => { :test_framework => "-w" } } - expected = { :rails => { :test_framework => "-w" } } - assert_equal expected, @configuration.generators.aliases - end - - def test_generators_aliases_and_options_on_initialization - @configuration.generators.rails :aliases => { :test_framework => "-w" } - @configuration.generators.orm :datamapper - @configuration.generators.test_framework :rspec - - @initializer.run(:initialize_generators) - - assert_equal :rspec, Rails::Generators.options[:rails][:test_framework] - assert_equal "-w", Rails::Generators.aliases[:rails][:test_framework] - end - - def test_generators_no_color_on_initialization - @configuration.generators.colorize_logging = false - @initializer.run(:initialize_generators) - assert_equal Thor::Base.shell, Thor::Shell::Basic - end - - def test_generators_with_hashes_for_options_and_aliases - @configuration.generators do |g| - g.orm :datamapper, :migration => false - g.plugin :aliases => { :generator => "-g" }, - :generator => true - end - - expected = { - :rails => { :orm => :datamapper }, - :plugin => { :generator => true }, - :datamapper => { :migration => false } - } - - assert_equal expected, @configuration.generators.options - assert_equal({ :plugin => { :generator => "-g" } }, @configuration.generators.aliases) - end - - def test_generators_with_hashes_are_deep_merged - @configuration.generators do |g| - g.orm :datamapper, :migration => false - g.plugin :aliases => { :generator => "-g" }, - :generator => true - end - @initializer.run(:initialize_generators) - - assert Rails::Generators.aliases.size >= 1 - assert Rails::Generators.options.size >= 1 - end - - protected - - def teardown - Rails::Generators.clear_aliases! - Rails::Generators.clear_options! - end -end - -class InitializerSetupI18nTests < Test::Unit::TestCase - def test_no_config_locales_dir_present_should_return_empty_load_path - File.stubs(:exist?).returns(false) - assert_equal [], Rails::Configuration.new.i18n.load_path - end - - def test_config_locales_dir_present_should_be_added_to_load_path - File.stubs(:exist?).returns(true) - Dir.stubs(:[]).returns([ "my/test/locale.yml" ]) - assert_equal [ "my/test/locale.yml" ], Rails::Configuration.new.i18n.load_path - end - - def test_config_defaults_should_be_added_with_config_settings - File.stubs(:exist?).returns(true) - Dir.stubs(:[]).returns([ "my/test/locale.yml" ]) - - config = Rails::Configuration.new - config.i18n.load_path << "my/other/locale.yml" - - assert_equal [ "my/test/locale.yml", "my/other/locale.yml" ], config.i18n.load_path - end -end - -class InitializerDatabaseMiddlewareTest < Test::Unit::TestCase - def setup - @config = Rails::Configuration.new - @config.frameworks = [:active_record, :action_controller, :action_view] - end - - def test_initialize_database_middleware_doesnt_perform_anything_when_active_record_not_in_frameworks - @config.frameworks.clear - @config.expects(:middleware).never - Rails::Initializer.run(:initialize_database_middleware, @config) - end - - def test_database_middleware_initializes_when_session_store_is_active_record - store = ActionController::Base.session_store - ActionController::Base.session_store = ActiveRecord::SessionStore - - @config.middleware.expects(:insert_before).with(:"ActiveRecord::SessionStore", ActiveRecord::ConnectionAdapters::ConnectionManagement) - @config.middleware.expects(:insert_before).with(:"ActiveRecord::SessionStore", ActiveRecord::QueryCache) - - Rails::Initializer.run(:initialize_database_middleware, @config) - ensure - ActionController::Base.session_store = store - end - - def test_database_middleware_doesnt_initialize_when_session_store_is_not_active_record - store = ActionController::Base.session_store - ActionController::Base.session_store = ActionDispatch::Session::CookieStore - - # Define the class, so we don't have to actually make it load - eval("class ActiveRecord::ConnectionAdapters::ConnectionManagement; end") - - @config.middleware.expects(:use).with(ActiveRecord::ConnectionAdapters::ConnectionManagement) - @config.middleware.expects(:use).with(ActiveRecord::QueryCache) - - Rails::Initializer.run(:initialize_database_middleware, @config) - ensure - ActionController::Base.session_store = store - end - - def test_ensure_database_middleware_doesnt_use_action_controller_on_initializing - @config.frameworks -= [:action_controller] - store = ActionController::Base.session_store - ActionController::Base.session_store = ActiveRecord::SessionStore - - @config.middleware.expects(:use).with(ActiveRecord::ConnectionAdapters::ConnectionManagement) - @config.middleware.expects(:use).with(ActiveRecord::QueryCache) - - Rails::Initializer.run(:initialize_database_middleware, @config) - ensure - ActionController::Base.session_store = store - @config.frameworks += [:action_controller] - end -end - -class InitializerViewPathsTest < Test::Unit::TestCase - def setup - @config = Rails::Configuration.new - @config.frameworks = [:action_view, :action_controller, :action_mailer] - - ActionController::Base.stubs(:view_paths).returns(stub) - ActionMailer::Base.stubs(:view_paths).returns(stub) - end - - def test_load_view_paths_doesnt_perform_anything_when_action_view_not_in_frameworks - @config.frameworks -= [:action_view] - ActionController::Base.view_paths.expects(:load!).never - ActionMailer::Base.view_paths.expects(:load!).never - Rails::Initializer.run(:load_view_paths, @config) - end -end - class RailsRootTest < Test::Unit::TestCase def test_rails_dot_root_equals_rails_root assert_equal RAILS_ROOT, Rails.root.to_s diff --git a/railties/test/isolation/abstract_unit.rb b/railties/test/isolation/abstract_unit.rb index c452adaa52..261e8d09dc 100644 --- a/railties/test/isolation/abstract_unit.rb +++ b/railties/test/isolation/abstract_unit.rb @@ -31,6 +31,10 @@ module TestHelpers tmp_path(*%w[app] + args) end + def framework_path + RAILS_FRAMEWORK_ROOT + end + def rails_root app_path end diff --git a/railties/test/new_initializer_test.rb b/railties/test/new_initializer_test.rb deleted file mode 100644 index 67b66fb088..0000000000 --- a/railties/test/new_initializer_test.rb +++ /dev/null @@ -1,165 +0,0 @@ -require 'abstract_unit' -require 'active_support/ruby/shim' -require 'rails/initializer' - -class InitializerRunnerTest < ActiveSupport::TestCase - - def setup - @runner = Rails::Initializer::Runner.new - end - - test "A new runner can be created" do - assert @runner - end - - test "The initializers actually get run when the runner is run" do - state = nil - - @runner.add :foo do - run { state = true } - end - - @runner.run - assert state - end - - test "By default, initializers get run in the order that they are added" do - state = [] - - @runner.add :first do - run { state << :first } - end - - @runner.add :second do - run { state << :second } - end - - @runner.run - assert_equal [:first, :second], state - end - - test "Raises an exception if :before or :after are specified, but don't exist" do - assert_raise(Rails::Initializer::Error) do - @runner.add(:fail, :before => :whale) { 1 } - end - - assert_raise(Rails::Initializer::Error) do - @runner.add(:fail, :after => :whale) { 1 } - end - end - - test "When adding an initializer, specifying :after allows you to move an initializer after another" do - state = [] - - @runner.add :first do - run { state << :first } - end - - @runner.add :second do - run { state << :second } - end - - @runner.add :third, :after => :first do - run { state << :third } - end - - @runner.run - assert_equal [:first, :third, :second], state - end - - test "An initializer can be deleted" do - state = [] - - @runner.add :first do - run { state << :first } - end - - @runner.add :second do - run { state << :second } - end - - @runner.delete(:second) - - @runner.run - assert_equal [:first], state - end - - test "A runner can be initialized with an existing runner, which it copies" do - state = [] - - @runner.add :first do - run { state << :first } - end - - @runner.add :second do - run { state << :second } - end - - Rails::Initializer::Runner.new(@runner).run - assert_equal [:first, :second], state - end - - test "A child runner can be still be modified without modifying the parent" do - state = [] - - @runner.add :first do - run { state << :first } - end - - @runner.add :second do - run { state << :second } - end - - new_runner = Rails::Initializer::Runner.new(@runner) - new_runner.add :trois do - run { state << :trois } - end - new_runner.delete(:second) - - new_runner.run - assert_equal [:first, :trois], state - state.clear - @runner.run - assert_equal [:first, :second], state - end - - test "A child runner that is modified does not modify any other children of the same parent" do - state = [] - - @runner.add :first do - run { state << :first } - end - - @runner.add :second do - run { state << :second } - end - - child_one = Rails::Initializer::Runner.new(@runner) - child_two = Rails::Initializer::Runner.new(@runner) - - child_one.delete(:second) - child_two.run - - assert_equal [:first, :second], state - end - - test "It does not run the initializer block immediately" do - state = [] - @runner.add :first do - state << :first - end - - assert_equal [], state - end - - test "It runs the block when the runner is run" do - state = [] - @runner.add :first do - state << :first - end - - @runner.run - assert_equal [:first], state - end - -end \ No newline at end of file diff --git a/railties/test/plugin_loader_test.rb b/railties/test/plugin_loader_test.rb index 99301347b6..0b43c49bb2 100644 --- a/railties/test/plugin_loader_test.rb +++ b/railties/test/plugin_loader_test.rb @@ -5,10 +5,13 @@ $:.unshift File.dirname(__FILE__) + "/../../actionmailer/lib" require 'action_controller' require 'action_mailer' -# Mocks out the configuration -module Rails - def self.configuration - Rails::Configuration.new +# TODO: Rewrite all these tests +class FakeInitializerSlashApplication + attr_reader :config + alias configuration config + + def initialize + @config = Rails::Configuration.new end end @@ -18,10 +21,10 @@ class TestPluginLoader < Test::Unit::TestCase def setup reset_load_path! - @configuration = Rails::Configuration.new + @initializer = FakeInitializerSlashApplication.new + @configuration = @initializer.config + Rails.application = @initializer @configuration.plugin_paths << plugin_fixture_root_path - @initializer = Rails::Initializer.default - @initializer.config = @configuration @valid_plugin_path = plugin_fixture_path('default/stubby') @empty_plugin_path = plugin_fixture_path('default/empty') diff --git a/railties/test/plugin_locator_test.rb b/railties/test/plugin_locator_test.rb index da1548dee1..ef57e7ed4c 100644 --- a/railties/test/plugin_locator_test.rb +++ b/railties/test/plugin_locator_test.rb @@ -1,5 +1,15 @@ require 'plugin_test_helper' +# TODO: Rewrite all these tests +class FakeInitializerSlashApplication + attr_reader :config + alias configuration config + + def initialize + @config = Rails::Configuration.new + end +end + class PluginLocatorTest < Test::Unit::TestCase def test_should_require_subclasses_to_implement_the_plugins_method assert_raise(RuntimeError) do @@ -23,12 +33,12 @@ end class PluginFileSystemLocatorTest < Test::Unit::TestCase def setup - @configuration = Rails::Configuration.new + @initializer = FakeInitializerSlashApplication.new + @configuration = @initializer.config + Rails.application = @initializer # We need to add our testing plugin directory to the plugin paths so # the locator knows where to look for our plugins @configuration.plugin_paths << plugin_fixture_root_path - @initializer = Rails::Initializer.default - @initializer.config = @configuration @locator = Rails::Plugin::FileSystemLocator.new(@initializer) @valid_plugin_path = plugin_fixture_path('default/stubby') @empty_plugin_path = plugin_fixture_path('default/empty') diff --git a/railties/test/plugin_test.rb b/railties/test/plugin_test.rb index ae03ea4662..199adcfe39 100644 --- a/railties/test/plugin_test.rb +++ b/railties/test/plugin_test.rb @@ -1,9 +1,20 @@ require 'plugin_test_helper' +# TODO: Rewrite all these tests +class FakeInitializerSlashApplication + attr_reader :config + alias configuration config + + def initialize + @config = Rails::Configuration.new + end +end + class PluginTest < Test::Unit::TestCase def setup - @initializer = Rails::Initializer.default - @initializer.config = Rails::Configuration.new + @initializer = FakeInitializerSlashApplication.new + @configuration = @initializer.config + Rails.application = @initializer @valid_plugin_path = plugin_fixture_path('default/stubby') @empty_plugin_path = plugin_fixture_path('default/empty') @gemlike_plugin_path = plugin_fixture_path('default/gemlike') -- cgit v1.2.3 From ed139730ff4ea4574cf3d234dd7cc76db3663b2f Mon Sep 17 00:00:00 2001 From: Jeremy Kemper Date: Wed, 7 Oct 2009 17:02:36 -0700 Subject: Uses fileutils --- railties/test/isolation/abstract_unit.rb | 2 ++ 1 file changed, 2 insertions(+) (limited to 'railties') diff --git a/railties/test/isolation/abstract_unit.rb b/railties/test/isolation/abstract_unit.rb index 261e8d09dc..f83e0151a4 100644 --- a/railties/test/isolation/abstract_unit.rb +++ b/railties/test/isolation/abstract_unit.rb @@ -7,6 +7,8 @@ # It is also good to know what is the bare minimum to get # Rails booted up. +require 'fileutils' + # TODO: Remove rubygems when possible require 'rubygems' require 'test/unit' -- cgit v1.2.3