Publish AS::Executor and AS::Reloader APIs

These should allow external code to run blocks of user code to do
"work", at a similar unit size to a web request, without needing to get
intimate with ActionDipatch.

3 files changed, 191 insertions, 24 deletions

diff --git a/actionpack/test/dispatch/callbacks_test.rb b/actionpack/test/dispatch/callbacks_test.rb
index 5ba76d9ab9..7b707df7f6 100644
--- a/actionpack/test/dispatch/callbacks_test.rb
+++ b/actionpack/test/dispatch/callbacks_test.rb
@@ -37,13 +37,19 @@ class DispatcherTest < ActiveSupport::TestCase
 
   def test_to_prepare_and_cleanup_delegation
     prepared = cleaned = false
-    ActionDispatch::Callbacks.to_prepare { prepared = true }
-    ActionDispatch::Callbacks.to_prepare { cleaned = true }
+    assert_deprecated do
+      ActionDispatch::Callbacks.to_prepare { prepared = true }
+      ActionDispatch::Callbacks.to_prepare { cleaned = true }
+    end
 
-    ActionDispatch::Reloader.prepare!
+    assert_deprecated do
+      ActionDispatch::Reloader.prepare!
+    end
     assert prepared
 
-    ActionDispatch::Reloader.cleanup!
+    assert_deprecated do
+      ActionDispatch::Reloader.cleanup!
+    end
     assert cleaned
   end
 
diff --git a/actionpack/test/dispatch/executor_test.rb b/actionpack/test/dispatch/executor_test.rb
new file mode 100644
index 0000000000..28bb232ecd
--- /dev/null
+++ b/actionpack/test/dispatch/executor_test.rb
@@ -0,0 +1,134 @@
+require 'abstract_unit'
+
+class ExecutorTest < ActiveSupport::TestCase
+  class MyBody < Array
+    def initialize(&block)
+      @on_close = block
+    end
+
+    def foo
+      "foo"
+    end
+
+    def bar
+      "bar"
+    end
+
+    def close
+      @on_close.call if @on_close
+    end
+  end
+
+  def test_returned_body_object_always_responds_to_close
+    body = call_and_return_body
+    assert_respond_to body, :close
+  end
+
+  def test_returned_body_object_always_responds_to_close_even_if_called_twice
+    body = call_and_return_body
+    assert_respond_to body, :close
+    body.close
+
+    body = call_and_return_body
+    assert_respond_to body, :close
+    body.close
+  end
+
+  def test_returned_body_object_behaves_like_underlying_object
+    body = call_and_return_body do
+      b = MyBody.new
+      b << "hello"
+      b << "world"
+      [200, { "Content-Type" => "text/html" }, b]
+    end
+    assert_equal 2, body.size
+    assert_equal "hello", body[0]
+    assert_equal "world", body[1]
+    assert_equal "foo", body.foo
+    assert_equal "bar", body.bar
+  end
+
+  def test_it_calls_close_on_underlying_object_when_close_is_called_on_body
+    close_called = false
+    body = call_and_return_body do
+      b = MyBody.new do
+        close_called = true
+      end
+      [200, { "Content-Type" => "text/html" }, b]
+    end
+    body.close
+    assert close_called
+  end
+
+  def test_returned_body_object_responds_to_all_methods_supported_by_underlying_object
+    body = call_and_return_body do
+      [200, { "Content-Type" => "text/html" }, MyBody.new]
+    end
+    assert_respond_to body, :size
+    assert_respond_to body, :each
+    assert_respond_to body, :foo
+    assert_respond_to body, :bar
+  end
+
+  def test_run_callbacks_are_called_before_close
+    running = false
+    executor.to_run { running = true }
+
+    body = call_and_return_body
+    assert running
+
+    running = false
+    body.close
+    assert !running
+  end
+
+  def test_complete_callbacks_are_called_on_close
+    completed = false
+    executor.to_complete { completed = true }
+
+    body = call_and_return_body
+    assert !completed
+
+    body.close
+    assert completed
+  end
+
+  def test_complete_callbacks_are_called_on_exceptions
+    completed = false
+    executor.to_complete { completed = true }
+
+    begin
+      call_and_return_body do
+        raise "error"
+      end
+    rescue
+    end
+
+    assert completed
+  end
+
+  def test_callbacks_execute_in_shared_context
+    result = false
+    executor.to_run { @in_shared_context = true }
+    executor.to_complete { result = @in_shared_context }
+
+    call_and_return_body.close
+    assert result
+    assert !defined?(@in_shared_context) # it's not in the test itself
+  end
+
+  private
+    def call_and_return_body(&block)
+      app = middleware(block || proc { [200, {}, 'response'] })
+      _, _, body = app.call({'rack.input' => StringIO.new('')})
+      body
+    end
+
+    def middleware(inner_app)
+      ActionDispatch::Executor.new(inner_app, executor)
+    end
+
+    def executor
+      @executor ||= Class.new(ActiveSupport::Executor)
+    end
+end
diff --git a/actionpack/test/dispatch/reloader_test.rb b/actionpack/test/dispatch/reloader_test.rb
index 62e8197e20..fe8a4a3a17 100644
--- a/actionpack/test/dispatch/reloader_test.rb
+++ b/actionpack/test/dispatch/reloader_test.rb
@@ -4,15 +4,17 @@ class ReloaderTest < ActiveSupport::TestCase
   Reloader = ActionDispatch::Reloader
 
   teardown do
-    Reloader.reset_callbacks :prepare
-    Reloader.reset_callbacks :cleanup
+    ActiveSupport::Reloader.reset_callbacks :prepare
+    ActiveSupport::Reloader.reset_callbacks :complete
   end
 
   def test_prepare_callbacks
     a = b = c = nil
-    Reloader.to_prepare { |*args| a = b = c = 1 }
-    Reloader.to_prepare { |*args| b = c = 2 }
-    Reloader.to_prepare { |*args| c = 3 }
+    assert_deprecated do
+      Reloader.to_prepare { |*args| a = b = c = 1 }
+      Reloader.to_prepare { |*args| b = c = 2 }
+      Reloader.to_prepare { |*args| c = 3 }
+    end
 
     # Ensure to_prepare callbacks are not run when defined
     assert_nil a || b || c
@@ -60,9 +62,15 @@ class ReloaderTest < ActiveSupport::TestCase
 
   def test_condition_specifies_when_to_reload
     i, j = 0, 0, 0, 0
-    Reloader.to_prepare { |*args| i += 1 }
-    Reloader.to_cleanup { |*args| j += 1 }
-    app = Reloader.new(lambda { |env| [200, {}, []] }, lambda { i < 3 })
+    assert_deprecated do
+      Reloader.to_prepare { |*args| i += 1 }
+      Reloader.to_cleanup { |*args| j += 1 }
+    end
+
+    x = Class.new(ActiveSupport::Reloader)
+    x.check = lambda { i < 3 }
+
+    app = Reloader.new(lambda { |env| [200, {}, []] }, x)
     5.times do
       resp = app.call({})
       resp[2].close
@@ -109,7 +117,9 @@ class ReloaderTest < ActiveSupport::TestCase
 
   def test_cleanup_callbacks_are_called_when_body_is_closed
     cleaned = false
-    Reloader.to_cleanup { cleaned = true }
+    assert_deprecated do
+      Reloader.to_cleanup { cleaned = true }
+    end
 
     body = call_and_return_body
     assert !cleaned
@@ -120,7 +130,9 @@ class ReloaderTest < ActiveSupport::TestCase
 
   def test_prepare_callbacks_arent_called_when_body_is_closed
     prepared = false
-    Reloader.to_prepare { prepared = true }
+    assert_deprecated do
+      Reloader.to_prepare { prepared = true }
+    end
 
     body = call_and_return_body
     prepared = false
@@ -131,31 +143,43 @@ class ReloaderTest < ActiveSupport::TestCase
 
   def test_manual_reloading
     prepared = cleaned = false
-    Reloader.to_prepare { prepared = true }
-    Reloader.to_cleanup { cleaned  = true }
+    assert_deprecated do
+      Reloader.to_prepare { prepared = true }
+      Reloader.to_cleanup { cleaned  = true }
+    end
 
-    Reloader.prepare!
+    assert_deprecated do
+      Reloader.prepare!
+    end
     assert prepared
     assert !cleaned
 
     prepared = cleaned = false
-    Reloader.cleanup!
-    assert !prepared
+    assert_deprecated do
+      Reloader.cleanup!
+    end
+    assert prepared
     assert cleaned
   end
 
   def test_prepend_prepare_callback
     i = 10
-    Reloader.to_prepare { i += 1 }
-    Reloader.to_prepare(:prepend => true) { i = 0 }
+    assert_deprecated do
+      Reloader.to_prepare { i += 1 }
+      Reloader.to_prepare(:prepend => true) { i = 0 }
+    end
 
-    Reloader.prepare!
+    assert_deprecated do
+      Reloader.prepare!
+    end
     assert_equal 1, i
   end
 
   def test_cleanup_callbacks_are_called_on_exceptions
     cleaned = false
-    Reloader.to_cleanup { cleaned  = true }
+    assert_deprecated do
+      Reloader.to_cleanup { cleaned  = true }
+    end
 
     begin
       call_and_return_body do
@@ -169,8 +193,11 @@ class ReloaderTest < ActiveSupport::TestCase
 
   private
     def call_and_return_body(&block)
+      x = Class.new(ActiveSupport::Reloader)
+      x.check = lambda { true }
+
       @response ||= 'response'
-      @reloader ||= Reloader.new(block || proc {[200, {}, @response]})
+      @reloader ||= Reloader.new(block || proc {[200, {}, @response]}, x)
       @reloader.call({'rack.input' => StringIO.new('')})[2]
     end
 end