Class: ActiveSupport::ExecutionWrapper

Inherits:
Object
  • Object
show all
Includes:
Callbacks
Defined in:
lib/active_support/execution_wrapper.rb

Direct Known Subclasses

Executor, Reloader

Defined Under Namespace

Classes: CompleteHook, RunHook

Constant Summary collapse

Null =

:nodoc:

Object.new

Constants included from Callbacks

Callbacks::CALLBACK_FILTER_TYPES

Class Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Callbacks

#run_callbacks

Methods included from Concern

#append_features, #class_methods, extended, #included, #prepend_features, #prepended

Class Attribute Details

.active ⇒ Object

Returns the value of attribute active.



109
110
111
 
# File 'lib/active_support/execution_wrapper.rb', line 109

def active
  @active
end

Class Method Details

.active? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


123
124
125
 
# File 'lib/active_support/execution_wrapper.rb', line 123

def self.active? # :nodoc:
  @active[IsolatedExecutionState.unique_id]
end

.error_reporter ⇒ Object 



112
113
114
 
# File 'lib/active_support/execution_wrapper.rb', line 112

def self.error_reporter
  @error_reporter ||= ActiveSupport::ErrorReporter.new
end

.inherited(other) ⇒ Object

:nodoc:



116
117
118
119
 
# File 'lib/active_support/execution_wrapper.rb', line 116

def self.inherited(other) # :nodoc:
  super
  other.active = Concurrent::Hash.new
end

.perform ⇒ Object

:nodoc:



98
99
100
101
102
103
104
105
106
 
# File 'lib/active_support/execution_wrapper.rb', line 98

def self.perform # :nodoc:
  instance = new
  instance.run
  begin
    yield
  ensure
    instance.complete
  end
end

.register_hook(hook, outer: false) ⇒ Object

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



51
52
53
54
55
56
57
58
59
 
# File 'lib/active_support/execution_wrapper.rb', line 51

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! ⇒ Object

Run this execution.

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

Where possible, prefer wrap.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/active_support/execution_wrapper.rb', line 67

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) ⇒ Object 



22
23
24
 
# File 'lib/active_support/execution_wrapper.rb', line 22

def self.to_complete(*args, &block)
  set_callback(:complete, *args, &block)
end

.to_run(*args, &block) ⇒ Object 



18
19
20
 
# File 'lib/active_support/execution_wrapper.rb', line 18

def self.to_run(*args, &block)
  set_callback(:run, *args, &block)
end

.wrap ⇒ Object

Perform the work in the supplied block as an execution.



84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/active_support/execution_wrapper.rb', line 84

def self.wrap
  return yield if active?

  instance = run!
  begin
    yield
  rescue => error
    error_reporter.report(error, handled: false)
    raise
  ensure
    instance.complete!
  end
end

Instance Method Details

#complete ⇒ Object

:nodoc:



146
147
148
 
# File 'lib/active_support/execution_wrapper.rb', line 146

def complete # :nodoc:
  run_callbacks(:complete)
end

#complete! ⇒ Object

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

Where possible, prefer wrap.



140
141
142
143
144
 
# File 'lib/active_support/execution_wrapper.rb', line 140

def complete!
  complete
ensure
  self.class.active.delete(IsolatedExecutionState.unique_id)
end

#run ⇒ Object

:nodoc:



132
133
134
 
# File 'lib/active_support/execution_wrapper.rb', line 132

def run # :nodoc:
  run_callbacks(:run)
end

#run! ⇒ Object

:nodoc:



127
128
129
130
 
# File 'lib/active_support/execution_wrapper.rb', line 127

def run! # :nodoc:
  self.class.active[IsolatedExecutionState.unique_id] = true
  run
end