Replace AD::Callbacks.to_prepare with AD::Reloader.to_prepare
Signed-off-by: José Valim <jose.valim@gmail.com>
This commit is contained in:
parent
0f7c970e4f
commit
435bccda93
|
@ -1,32 +1,14 @@
|
|||
module ActionDispatch
|
||||
# Provide callbacks to be executed before and after the request dispatch.
|
||||
#
|
||||
# It also provides a to_prepare callback, which is performed in all requests
|
||||
# in development by only once in production and notification callback for async
|
||||
# operations.
|
||||
#
|
||||
class Callbacks
|
||||
include ActiveSupport::Callbacks
|
||||
|
||||
define_callbacks :call, :rescuable => true
|
||||
define_callbacks :prepare, :scope => :name
|
||||
|
||||
# Add a preparation callback. Preparation callbacks are run before every
|
||||
# request in development mode, and before the first request in production mode.
|
||||
#
|
||||
# If a symbol with a block is given, the symbol is used as an identifier.
|
||||
# That allows to_prepare to be called again with the same identifier to
|
||||
# replace the existing callback. Passing an identifier is a suggested
|
||||
# practice if the code adding a preparation block may be reloaded.
|
||||
def self.to_prepare(*args, &block)
|
||||
first_arg = args.first
|
||||
if first_arg.is_a?(Symbol) && block_given?
|
||||
remove_method :"__#{first_arg}" if method_defined?(:"__#{first_arg}")
|
||||
define_method :"__#{first_arg}", &block
|
||||
set_callback(:prepare, :"__#{first_arg}")
|
||||
else
|
||||
set_callback(:prepare, *args, &block)
|
||||
end
|
||||
ActiveSupport::Deprecation.warn "ActionDispatch::Callbacks.to_prepare is deprecated. " <<
|
||||
"Please use ActionDispatch::Reloader.to_prepare instead."
|
||||
ActionDispatch::Reloader.to_prepare(*args, &block)
|
||||
end
|
||||
|
||||
def self.before(*args, &block)
|
||||
|
@ -37,14 +19,13 @@ module ActionDispatch
|
|||
set_callback(:call, :after, *args, &block)
|
||||
end
|
||||
|
||||
def initialize(app, prepare_each_request = false)
|
||||
@app, @prepare_each_request = app, prepare_each_request
|
||||
_run_prepare_callbacks
|
||||
def initialize(app, unused = nil)
|
||||
ActiveSupport::Deprecation.warn "Passing a second argument to ActionDispatch::Callbacks.new is deprecated." unless unused.nil?
|
||||
@app = app
|
||||
end
|
||||
|
||||
def call(env)
|
||||
_run_call_callbacks do
|
||||
_run_prepare_callbacks if @prepare_each_request
|
||||
@app.call(env)
|
||||
end
|
||||
end
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
require 'abstract_unit'
|
||||
|
||||
class DispatcherTest < Test::Unit::TestCase
|
||||
class DispatcherTest < ActiveSupport::TestCase
|
||||
class Foo
|
||||
cattr_accessor :a, :b
|
||||
end
|
||||
|
@ -13,65 +13,9 @@ class DispatcherTest < Test::Unit::TestCase
|
|||
|
||||
def setup
|
||||
Foo.a, Foo.b = 0, 0
|
||||
ActionDispatch::Callbacks.reset_callbacks(:prepare)
|
||||
ActionDispatch::Callbacks.reset_callbacks(:call)
|
||||
end
|
||||
|
||||
def test_prepare_callbacks_with_cache_classes
|
||||
a = b = c = nil
|
||||
ActionDispatch::Callbacks.to_prepare { |*args| a = b = c = 1 }
|
||||
ActionDispatch::Callbacks.to_prepare { |*args| b = c = 2 }
|
||||
ActionDispatch::Callbacks.to_prepare { |*args| c = 3 }
|
||||
|
||||
# Ensure to_prepare callbacks are not run when defined
|
||||
assert_nil a || b || c
|
||||
|
||||
# Run callbacks
|
||||
dispatch
|
||||
|
||||
assert_equal 1, a
|
||||
assert_equal 2, b
|
||||
assert_equal 3, c
|
||||
|
||||
# Make sure they are only run once
|
||||
a = b = c = nil
|
||||
dispatch
|
||||
assert_nil a || b || c
|
||||
end
|
||||
|
||||
def test_prepare_callbacks_without_cache_classes
|
||||
a = b = c = nil
|
||||
ActionDispatch::Callbacks.to_prepare { |*args| a = b = c = 1 }
|
||||
ActionDispatch::Callbacks.to_prepare { |*args| b = c = 2 }
|
||||
ActionDispatch::Callbacks.to_prepare { |*args| c = 3 }
|
||||
|
||||
# Ensure to_prepare callbacks are not run when defined
|
||||
assert_nil a || b || c
|
||||
|
||||
# Run callbacks
|
||||
dispatch(false)
|
||||
|
||||
assert_equal 1, a
|
||||
assert_equal 2, b
|
||||
assert_equal 3, c
|
||||
|
||||
# Make sure they are run again
|
||||
a = b = c = nil
|
||||
dispatch(false)
|
||||
assert_equal 1, a
|
||||
assert_equal 2, b
|
||||
assert_equal 3, c
|
||||
end
|
||||
|
||||
def test_to_prepare_with_identifier_replaces
|
||||
ActionDispatch::Callbacks.to_prepare(:unique_id) { |*args| Foo.a, Foo.b = 1, 1 }
|
||||
ActionDispatch::Callbacks.to_prepare(:unique_id) { |*args| Foo.a = 2 }
|
||||
|
||||
dispatch
|
||||
assert_equal 2, Foo.a
|
||||
assert_equal 0, Foo.b
|
||||
end
|
||||
|
||||
def test_before_and_after_callbacks
|
||||
ActionDispatch::Callbacks.before { |*args| Foo.a += 1; Foo.b += 1 }
|
||||
ActionDispatch::Callbacks.after { |*args| Foo.a += 1; Foo.b += 1 }
|
||||
|
@ -85,10 +29,20 @@ class DispatcherTest < Test::Unit::TestCase
|
|||
assert_equal 4, Foo.b
|
||||
end
|
||||
|
||||
def test_to_prepare_deprecation
|
||||
prepared = false
|
||||
assert_deprecated do
|
||||
ActionDispatch::Callbacks.to_prepare { prepared = true }
|
||||
end
|
||||
|
||||
ActionDispatch::Reloader.prepare!
|
||||
assert prepared
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def dispatch(cache_classes = true, &block)
|
||||
@dispatcher ||= ActionDispatch::Callbacks.new(block || DummyApp.new, !cache_classes)
|
||||
def dispatch(&block)
|
||||
@dispatcher ||= ActionDispatch::Callbacks.new(block || DummyApp.new)
|
||||
@dispatcher.call({'rack.input' => StringIO.new('')})
|
||||
end
|
||||
|
||||
|
|
|
@ -82,7 +82,7 @@ module ActiveRecord
|
|||
ActiveSupport.on_load(:active_record) do
|
||||
instantiate_observers
|
||||
|
||||
ActionDispatch::Callbacks.to_prepare(:activerecord_instantiate_observers) do
|
||||
ActionDispatch::Reloader.to_prepare(:activerecord_instantiate_observers) do
|
||||
ActiveRecord::Base.instantiate_observers
|
||||
end
|
||||
end
|
||||
|
|
|
@ -8,7 +8,7 @@ module ActiveSupport
|
|||
# I18n.reload!
|
||||
# end
|
||||
#
|
||||
# ActionDispatch::Callbacks.to_prepare do
|
||||
# ActionDispatch::Reloader.to_prepare do
|
||||
# i18n_reloader.execute_if_updated
|
||||
# end
|
||||
#
|
||||
|
|
|
@ -19,7 +19,7 @@ module I18n
|
|||
# on to_prepare callbacks. This will only happen on the config.after_initialize
|
||||
# callback below.
|
||||
initializer "i18n.callbacks" do
|
||||
ActionDispatch::Callbacks.to_prepare do
|
||||
ActionDispatch::Reloader.to_prepare do
|
||||
I18n::Railtie.reloader.execute_if_updated
|
||||
end
|
||||
end
|
||||
|
|
|
@ -157,7 +157,7 @@ module Rails
|
|||
middleware.use ::ActionDispatch::RemoteIp, config.action_dispatch.ip_spoofing_check, config.action_dispatch.trusted_proxies
|
||||
middleware.use ::Rack::Sendfile, config.action_dispatch.x_sendfile_header
|
||||
middleware.use ::ActionDispatch::Reloader unless config.cache_classes
|
||||
middleware.use ::ActionDispatch::Callbacks, !config.cache_classes
|
||||
middleware.use ::ActionDispatch::Callbacks
|
||||
middleware.use ::ActionDispatch::Cookies
|
||||
|
||||
if config.session_store
|
||||
|
|
|
@ -21,7 +21,7 @@ module Rails
|
|||
|
||||
initializer :add_to_prepare_blocks do
|
||||
config.to_prepare_blocks.each do |block|
|
||||
ActionDispatch::Callbacks.to_prepare(&block)
|
||||
ActionDispatch::Reloader.to_prepare(&block)
|
||||
end
|
||||
end
|
||||
|
||||
|
@ -37,6 +37,10 @@ module Rails
|
|||
build_middleware_stack
|
||||
end
|
||||
|
||||
initializer :run_prepare_callbacks do
|
||||
ActionDispatch::Reloader.prepare!
|
||||
end
|
||||
|
||||
initializer :eager_load! do
|
||||
if config.cache_classes && !$rails_rake_task
|
||||
ActiveSupport.run_load_hooks(:before_eager_load, self)
|
||||
|
@ -52,7 +56,7 @@ module Rails
|
|||
initializer :set_routes_reloader do |app|
|
||||
reloader = lambda { app.routes_reloader.execute_if_updated }
|
||||
reloader.call
|
||||
ActionDispatch::Callbacks.to_prepare(&reloader)
|
||||
ActionDispatch::Reloader.to_prepare(&reloader)
|
||||
end
|
||||
|
||||
# Disable dependency loading during request cycle
|
||||
|
|
|
@ -26,7 +26,6 @@ end
|
|||
# reloads the environment
|
||||
def reload!(print=true)
|
||||
puts "Reloading..." if print
|
||||
# This triggers the to_prepare callbacks
|
||||
ActionDispatch::Callbacks.new(Proc.new {}, false).call({})
|
||||
ActionDispatch::Reloader.reload!
|
||||
true
|
||||
end
|
||||
|
|
|
@ -26,14 +26,14 @@ class ConsoleTest < Test::Unit::TestCase
|
|||
assert_instance_of ActionDispatch::Integration::Session, session
|
||||
end
|
||||
|
||||
def test_reload_should_fire_preparation_callbacks
|
||||
def test_reload_should_fire_preparation_and_cleanup_callbacks
|
||||
load_environment
|
||||
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 }
|
||||
ActionDispatch::Reloader.to_prepare { a = b = c = 1 }
|
||||
ActionDispatch::Reloader.to_prepare { b = c = 2 }
|
||||
ActionDispatch::Reloader.to_cleanup { c = 3 }
|
||||
|
||||
# Hide Reloading... output
|
||||
silence_stream(STDOUT) { reload! }
|
||||
|
|
Loading…
Reference in New Issue