Parent

Included Modules

Class/Module Index [+]

Quicksearch

ActionDispatch::Reloader

ActionDispatch::Reloader provides prepare and cleanup callbacks, intended to assist with code reloading during development.

Prepare callbacks are run before each request, and cleanup callbacks after each request. In this respect they are analogs of ActionDispatch::Callback’s before and after callbacks. However, cleanup callbacks are not called until the request is fully complete – that is, after close has been called on the response body. This is important for streaming responses such as the following:

self.response_body = lambda { |response, output|
  # code here which refers to application models
}

Cleanup callbacks will not be called until after the response_body lambda is evaluated, ensuring that it can refer to application models and other classes before they are unloaded.

By default, ActionDispatch::Reloader is included in the middleware stack only in the development environment; specifically, when config.cache_classes is false. Callbacks may be registered even when it is not included in the middleware stack, but are executed only when +ActionDispatch::Reloader.prepare!+ or +ActionDispatch::Reloader.cleanup!+ are called manually.

Public Class Methods

cleanup!() click to toggle source

Execute all cleanup callbacks.

# File lib/action_dispatch/middleware/reloader.rb, line 50
def self.cleanup!
  new(nil).run_callbacks :cleanup
end
new(app) click to toggle source
# File lib/action_dispatch/middleware/reloader.rb, line 54
def initialize(app)
  @app = app
end
prepare!() click to toggle source

Execute all prepare callbacks.

# File lib/action_dispatch/middleware/reloader.rb, line 45
def self.prepare!
  new(nil).run_callbacks :prepare
end
to_cleanup(*args, &block) click to toggle source

Add a cleanup callback. Cleanup callbacks are run after each request is complete (after close is called on the response body).

# File lib/action_dispatch/middleware/reloader.rb, line 40
def self.to_cleanup(*args, &block)
  set_callback(:cleanup, *args, &block)
end
to_prepare(*args, &block) click to toggle source

Add a prepare callback. Prepare callbacks are run before each request, prior to ActionDispatch::Callback’s before callbacks.

# File lib/action_dispatch/middleware/reloader.rb, line 34
def self.to_prepare(*args, &block)
  set_callback(:prepare, *args, &block)
end

Public Instance Methods

call(env) click to toggle source
# File lib/action_dispatch/middleware/reloader.rb, line 66
def call(env)
  run_callbacks :prepare
  response = @app.call(env)
  response[2].extend(CleanupOnClose)
  response
rescue Exception
  run_callbacks :cleanup
  raise
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.