Docs4dev
Docs
rails / 5.2 / activesupport / executionwrapper.html

class ActiveSupport::ExecutionWrapper

Parent:
Object
Included modules:
ActiveSupport::Callbacks

Attributes

active[RW]

Public Class Methods

register_hook(hook, outer: false) Show source 
# File activesupport/lib/active_support/execution_wrapper.rb, line 49
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

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.)

run!() Show source 
# File activesupport/lib/active_support/execution_wrapper.rb, line 65
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

Run this execution.

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

Where possible, prefer wrap.

to_complete(*args, &block) Show source 
# File activesupport/lib/active_support/execution_wrapper.rb, line 20
def self.to_complete(*args, &block)
  set_callback(:complete, *args, &block)
end
to_run(*args, &block) Show source 
# File activesupport/lib/active_support/execution_wrapper.rb, line 16
def self.to_run(*args, &block)
  set_callback(:run, *args, &block)
end
wrap() { || ... } Show source 
# File activesupport/lib/active_support/execution_wrapper.rb, line 82
def self.wrap
  return yield if active?

  instance = run!
  begin
    yield
  ensure
    instance.complete!
  end
end

Perform the work in the supplied block as an execution.

Public Instance Methods

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

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

Where possible, prefer wrap.

© 2004–2018 David Heinemeier Hansson
Licensed under the MIT License.