edge badge
Namespace
Methods
C
R
T
W
Included Modules
Constants
Null = Object.new # :nodoc:
 
RunHook = Struct.new(:hook) do # :nodoc: def before(target) hook_state = target.send(:hook_state) hook_state[hook] = hook.run end end
 
CompleteHook = Struct.new(:hook) do # :nodoc: def before(target) hook_state = target.send(:hook_state) if hook_state.key?(hook) hook.complete hook_state[hook] end end alias after before end
 
Attributes
[RW] active
Class Public methods
register_hook(hook, outer: false)

Register an object to be invoked during both the run and complete steps.

hook.complete will be passed the value returned from hook.run, and will only be invoked if run has previously been called. (Mostly, this means it won't be invoked if an exception occurs in a preceding to_run block; all ordinary to_complete blocks are invoked in that situation.)

# File activesupport/lib/active_support/execution_wrapper.rb, line 48
def self.register_hook(hook, outer: false)
  if outer
    to_run RunHook.new(hook), prepend: true
    to_complete :after, CompleteHook.new(hook)
  else
    to_run RunHook.new(hook)
    to_complete CompleteHook.new(hook)
  end
end
run!()

Run this execution.

Returns an instance, whose complete! method must be invoked after the work has been performed.

Where possible, prefer wrap.

# File activesupport/lib/active_support/execution_wrapper.rb, line 64
def self.run!
  if active?
    Null
  else
    new.tap do |instance|
      success = nil
      begin
        instance.run!
        success = true
      ensure
        instance.complete! unless success
      end
    end
  end
end
to_complete(*args, &block)
# File activesupport/lib/active_support/execution_wrapper.rb, line 19
def self.to_complete(*args, &block)
  set_callback(:complete, *args, &block)
end
to_run(*args, &block)
# File activesupport/lib/active_support/execution_wrapper.rb, line 15
def self.to_run(*args, &block)
  set_callback(:run, *args, &block)
end
wrap()

Perform the work in the supplied block as an execution.

# File activesupport/lib/active_support/execution_wrapper.rb, line 81
def self.wrap
  return yield if active?

  instance = run!
  begin
    yield
  ensure
    instance.complete!
  end
end
Instance Public methods
complete!()

Complete this in-flight execution. This method must be called exactly once on the result of any call to run!.

Where possible, prefer wrap.

# File activesupport/lib/active_support/execution_wrapper.rb, line 116
def complete!
  run_callbacks(:complete)
ensure
  self.class.active.delete Thread.current
end