Class: RSpec::Core::Example::Procsy

Inherits:
Object
  • Object
show all
Defined in:
lib/rspec/core/example.rb

Overview

Note:

This class also exposes the instance methods of RSpec::Core::Example, proxying them through to the wrapped RSpec::Core::Example instance.

Wraps both a Proc and an RSpec::Core::Example for use in around hooks. In around hooks we need to yield this special kind of object (rather than the raw RSpec::Core::Example) because when there are multiple around hooks we have to wrap them recursively.

Examples:


RSpec.configure do |c|
  c.around do |ex| # Procsy which wraps the example
    if ex.[:key] == :some_value && some_global_condition
      raise "some message"
    end
    ex.run         # run delegates to ex.call
  end
end

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (Procsy) initialize(example, &block)

Returns a new instance of Procsy



231
232
233
234
235
# File 'lib/rspec/core/example.rb', line 231

def initialize(example, &block)
  @example  = example
  @proc     = block
  @executed = false
end

Instance Attribute Details

- (void) example (readonly)

The RSpec::Core::Example instance.



205
206
207
# File 'lib/rspec/core/example.rb', line 205

def example
  @example
end

Instance Method Details

- (void) call(*args, &block) Also known as: run

Calls the proc and notes that the example has been executed.



220
221
222
223
# File 'lib/rspec/core/example.rb', line 220

def call(*args, &block)
  @executed = true
  @proc.call(*args, &block)
end

- (Boolean) executed?

Indicates whether or not the around hook has executed the example.

Returns:

  • (Boolean)


243
244
245
# File 'lib/rspec/core/example.rb', line 243

def executed?
  @executed
end

- (void) to_proc

Provides a wrapped proc that will update our executed? state when executed.



227
228
229
# File 'lib/rspec/core/example.rb', line 227

def to_proc
  method(:call).to_proc
end