Around hooks don't receive example

[sj26]

Accessing example within hooks is now deprecated in favour of using example as yielded into the block, but around hooks don't received the example as a parameter but instead just received a proc:

rspec-core/lib/rspec/core/hooks.rb

Lines 427 to 433 in b648cdb

	def run
	hooks.inject(@initial_procsy) do |procsy, around_hook|
	procsy.wrap do
	@example.instance_exec(procsy, &around_hook.block)
	end
	end.call
	end

This means we must fall back to using RSpec.current_example which reeks of accessing Thread.current and is inconsistent.

Example:

gem "rspec", "3.0.0"
require "rspec/autorun"
require "pp"

RSpec.configure do |config|
  config.around do |*args|
    p around: args, current_example: RSpec.current_example
    args.first.call
  end
end

describe "example" do
  it "passes" do
    expect(true).to be_truthy
  end

  it "fails" do
    expect(false).to be_truthy
  end
end

Yields:

{:around=>
  [#<Proc:0x007f93fc65b458@/Users/sj26/.rbenv/gems/2.1.0/gems/rspec-core-3.0.2/lib/rspec/core/example.rb:145>],
 :current_example=>
  #<RSpec::Core::Example:0x007f93fc682cd8
   @around_example_hooks=
    [#<RSpec::Core::Hooks::Hook:0x007f93fca72d48
      @block=#<Proc:0x007f93fca73180@example.rb:6>,
      @options={}>],
   @clock=RSpec::Core::Time,
   @example_block=#<Proc:0x007f93fc682da0@example.rb:13>,
   @example_group_class=RSpec::ExampleGroups::Example,
   @example_group_instance=
    #<RSpec::ExampleGroups::Example:0x007f93fc65b5e8 @__memoized=nil>,
   @exception=nil,
   @metadata=
    {:execution_result=>
      #<RSpec::Core::Example::ExecutionResult:0x007f93fc682b20
       @started_at=2014-06-26 10:30:12 +0800>,
     :block=>#<Proc:0x007f93fc682da0@example.rb:13>,
     :description_args=>["passes"],
     :description=>"passes",
     :full_description=>"example passes",
     :described_class=>nil,
     :file_path=>"example.rb",
     :line_number=>13,
     :location=>"example.rb:13",
     :example_group=>
      {:execution_result=>
        #<RSpec::Core::Example::ExecutionResult:0x007f93fc683b60>,
       :block=>#<Proc:0x007f93fca72ca8@example.rb:12>,
       :description_args=>["example"],
       :description=>"example",
       :full_description=>"example",
       :described_class=>nil,
       :file_path=>"example.rb",
       :line_number=>12,
       :location=>"example.rb:12"}}>}
{:around=>
  [#<Proc:0x007f93fc61aed0@/Users/sj26/.rbenv/gems/2.1.0/gems/rspec-core-3.0.2/lib/rspec/core/example.rb:145>],
 :current_example=>
  #<RSpec::Core::Example:0x007f93fc682788
   @around_example_hooks=
    [#<RSpec::Core::Hooks::Hook:0x007f93fca72d48
      @block=#<Proc:0x007f93fca73180@example.rb:6>,
      @options={}>],
   @clock=RSpec::Core::Time,
   @example_block=#<Proc:0x007f93fc682828@example.rb:17>,
   @example_group_class=RSpec::ExampleGroups::Example,
   @example_group_instance=
    #<RSpec::ExampleGroups::Example:0x007f93fc61b010 @__memoized=nil>,
   @exception=nil,
   @metadata=
    {:execution_result=>
      #<RSpec::Core::Example::ExecutionResult:0x007f93fc6825d0
       @started_at=2014-06-26 10:30:12 +0800>,
     :block=>#<Proc:0x007f93fc682828@example.rb:17>,
     :description_args=>["fails"],
     :description=>"fails",
     :full_description=>"example fails",
     :described_class=>nil,
     :file_path=>"example.rb",
     :line_number=>17,
     :location=>"example.rb:17",
     :example_group=>
      {:execution_result=>
        #<RSpec::Core::Example::ExecutionResult:0x007f93fc683b60>,
       :block=>#<Proc:0x007f93fca72ca8@example.rb:12>,
       :description_args=>["example"],
       :description=>"example",
       :full_description=>"example",
       :described_class=>nil,
       :file_path=>"example.rb",
       :line_number=>12,
       :location=>"example.rb:12"}}>}

[sj26]

Ah, apologies, in my project we're still on 2.99, and I see that the "proc" actually responds to #metadata, but not #exception which is why I was confused:

irb> example.metadata
=> {:example_group=>
  {:description_args=>[Ad],
   :caller=> ...
irb> example.exception
NoMethodError: undefined method `exception' for #<Proc:0x007fb5daf24210>

But doing the same on 3.0 works fine:

irb> example.metadata
=> {:execution_result=>
  #<RSpec::Core::Example::ExecutionResult:0x007fbf07b3a6f0
   @started_at=2014-06-26 10:45:04 +0800>,
 :block=> ...
irb> example.exception
=> nil

Perhaps this should be backported?

[JonRowe]

I believe there should be an upgrade path for those methods on an example, but the object yielded is a proxy to example, maybe we should define inspect to make that clearer. I'm going to close this because it gives you access to the example as expected, but if you'd like to open an issue to backport part of the 3.x api feel free, I'm not sure I want to backport that method though.

[myronmarston]

Glad you figured out we addressed this in 3.0.

I'm of two minds the question of backporting: on the one hand, it aligns with the "yielding the example" feature that is included in 2.99, but if we backport it, it's a new API, and according to SemVer we'd have to release it as 2.100...which I think would cause lots of confusion.

[sj26]

I'll just use RSpec.current_example until we completely upgrade to 3.0.

Thanks! <3