Logo: Relish

  1. Sign in

Project: RSpec Core 3.4

Publisher: RSpec

shared context

Use shared_context to define a block that will be evaluated in the context
of example groups either explicitly, using include_context, or implicitly by
matching metadata.

When implicitly including shared contexts via matching metadata, the normal way is to define matching metadata on an example group, in which case the context is included in the entire group. However, you also have the option to include it in an individual example instead. RSpec treats every example as having a singleton example group (analogous to Ruby's singleton classes) containing just the one example.

Background
Given
a file named "shared_stuff.rb" with: 
RSpec.shared_context "shared stuff", :a => :b do
  before { @some_var = :some_value }
  def shared_method
    "it works"
  end
  let(:shared_let) { {'arbitrary' => 'object'} }
  subject do
    'this is the subject'
  end
end
Scenarios
  1. Declare a shared context and include it with `include_context`
  2. Declare a shared context, include it with `include_context` and extend it with an additional block
  3. Declare a shared context and include it with metadata
  4. Declare a shared context and include it with metadata of an individual example
Declare a shared context and include it with `include_context`
Given
a file named "shared_context_example.rb" with: 
require "./shared_stuff.rb"

RSpec.describe "group that includes a shared context using 'include_context'" do
  include_context "shared stuff"

  it "has access to methods defined in shared context" do
    expect(shared_method).to eq("it works")
  end

  it "has access to methods defined with let in shared context" do
    expect(shared_let['arbitrary']).to eq('object')
  end

  it "runs the before hooks defined in the shared context" do
    expect(@some_var).to be(:some_value)
  end

  it "accesses the subject defined in the shared context" do
    expect(subject).to eq('this is the subject')
  end
end
When
I run rspec shared_context_example.rb
Then
the examples should all pass
Declare a shared context, include it with `include_context` and extend it with an additional block
Given
a file named "shared_context_example.rb" with: 
require "./shared_stuff.rb"

RSpec.describe "including shared context using 'include_context' and a block" do
  include_context "shared stuff" do
    let(:shared_let) { {'in_a' => 'block'} }
  end

  it "evaluates the block in the shared context" do
    expect(shared_let['in_a']).to eq('block')
  end
end
When
I run rspec shared_context_example.rb
Then
the examples should all pass
Declare a shared context and include it with metadata
Given
a file named "shared_context_example.rb" with: 
require "./shared_stuff.rb"

RSpec.describe "group that includes a shared context using metadata", :a => :b do
  it "has access to methods defined in shared context" do
    expect(shared_method).to eq("it works")
  end

  it "has access to methods defined with let in shared context" do
    expect(shared_let['arbitrary']).to eq('object')
  end

  it "runs the before hooks defined in the shared context" do
    expect(@some_var).to be(:some_value)
  end

  it "accesses the subject defined in the shared context" do
    expect(subject).to eq('this is the subject')
  end
end
When
I run rspec shared_context_example.rb
Then
the examples should all pass
Declare a shared context and include it with metadata of an individual example
Given
a file named "shared_context_example.rb" with: 
require "./shared_stuff.rb"

RSpec.describe "group that does not include the shared context" do
  it "does not have access to shared methods normally" do
    expect(self).not_to respond_to(:shared_method)
  end

  it "has access to shared methods from examples with matching metadata", :a => :b do
    expect(shared_method).to eq("it works")
  end
end
When
I run rspec shared_context_example.rb
Then
the examples should all pass

Last published almost 5 years ago by myronmarston.