Module: RSpec

Defined in:
lib/r_spec.rb,
lib/r_spec/clone.rb,
lib/r_spec/clone/dsl.rb,
lib/r_spec/clone/error.rb,
lib/r_spec/clone/console.rb,
lib/r_spec/clone/expectation_helper.rb,
lib/r_spec/clone/expectation_target.rb,
lib/r_spec/clone/error/reserved_method.rb,
lib/r_spec/clone/expectation_helper/it.rb,
lib/r_spec/clone/expectation_helper/its.rb,
lib/r_spec/clone/error/undefined_subject.rb,
lib/r_spec/clone/expectation_target/base.rb,
lib/r_spec/clone/expectation_target/block.rb,
lib/r_spec/clone/expectation_target/value.rb,
lib/r_spec/clone/error/pending_expectation.rb,
lib/r_spec/clone/expectation_helper/shared.rb,
lib/r_spec/clone/error/undefined_described_class.rb

Overview

Top level namespace for the RSpec clone.

Examples:

The true from the false

require "r_spec"

RSpec.describe "The true from the false" do
  it { expect(false).not_to be true }
end

# Output to the console
#   Success: expected false not to be true.

The basic behavior of arrays

require "r_spec"

RSpec.describe Array do
  describe "#size" do
    it "correctly reports the number of elements in the Array" do
      expect([1, 2, 3].size).to eq 3
    end
  end

  describe "#empty?" do
    it "is empty when no elements are in the array" do
      expect([].empty?).to be_true
    end

    it "is not empty if there are elements in the array" do
      expect([1].empty?).to be_false
    end
  end
end

# Output to the console
#   Success: expected to eq 3.
#   Success: expected to be true.
#   Success: expected to be false.

An inherited definition of let

require "r_spec"

RSpec.describe Integer do
  let(:answer) { 42 }

  it "returns the value" do
    expect(answer).to be(42)
  end

  context "when the number is incremented" do
    let(:answer) { super().next }

    it "returns the next value" do
      expect(answer).to be(43)
    end
  end
end

# Output to the console
#   Success: expected to be 42.
#   Success: expected to be 43.

Defined Under Namespace

Modules: Clone

Class Method Summary collapse

Class Method Details

.context(description, &block) ⇒ Object

Defines an example group that establishes a specific context, like _empty array_ versus _array with elements_.

Examples:

require "r_spec"

RSpec.context "when divided by zero" do
  subject { 42 / 0 }

  it { is_expected.to raise_exception ZeroDivisionError }
end

# Output to the console
#   Success: divided by 0.

Parameters:

  • description (String)

    A description that usually begins with “when”, “with” or “without”.

  • block (Proc)

    The block to define the specs.


86
87
88
# File 'lib/r_spec.rb', line 86

def self.context(description, &block)
  Clone::Dsl.context(description, &block)
end

.context!(description, &block) ⇒ Object

Runs a context example group in a subprocess to isolate side effects.

Examples:

str = "Hello, world!"

require "r_spec"

RSpec.context! "when a string becomes uppercase" do
  before do
    str.upcase!
  end

  it { expect(str).to eq "HELLO, WORLD!" }
end

# Output to the console
#   Success: expected to eq "HELLO, WORLD!".

RSpec.it { expect(str).to eq "Hello, world!" }

# Output to the console
#   Success: expected to eq "Hello, world!".

116
117
118
# File 'lib/r_spec.rb', line 116

def self.context!(description, &block)
  Clone::Dsl.context!(description, &block)
end

.describe(const, &block) ⇒ Object

Defines an example group that describes a unit to be tested.

Examples:

require "r_spec"

RSpec.describe String do
  it { expect(described_class).to be String }
end

# Output to the console
#   Success: expected to be String.
require "r_spec"

RSpec.describe String do
  let(:foo) { "foo" }

  describe "+" do
    it("concats") { expect(foo + "bar").to eq "foobar" }
  end
end

# Output to the console
#   Success: expected to eq "foobar".

Parameters:

  • const (Module, String)

    A module to include in block context.

  • block (Proc)

    The block to define the specs.


150
151
152
# File 'lib/r_spec.rb', line 150

def self.describe(const, &block)
  Clone::Dsl.describe(const, &block)
end

.describe!(const, &block) ⇒ Object

Runs a describe example group in a subprocess to isolate side effects.

Examples:

$app = "foo"

require "r_spec"

RSpec.describe! "#gsub!" do
  before do
    $app.gsub!("o", "0")
  end

  it { expect($app).to eq "f00" }
end

# Output to the console
#   Success: expected to eq "f00".

RSpec.it { expect($app).to eq "foo" }

# Output to the console
#   Success: expected to eq "foo".

180
181
182
# File 'lib/r_spec.rb', line 180

def self.describe!(const, &block)
  Clone::Dsl.describe!(const, &block)
end

.it(name = nil, &block) ⇒ nil

Defines a concrete test case.

The test is performed by the block supplied to &block.

It is usually used inside a RSpec::Clone::Dsl.describe or RSpec::Clone::Dsl.context section.

Examples:

The integer after 41

require "r_spec"

RSpec.it { expect(41.next).to be 42 }

# Output to the console
#   Success: expected to be 42.

Parameters:

  • name (String, nil) (defaults to: nil)

    The name of the spec.

  • block (Proc)

    An expectation to evaluate.

Returns:

  • (nil)

    Write a message to STDOUT.

Raises:

  • (SystemExit)

    Terminate execution immediately by calling `Kernel.exit(false)` with a failure message written to STDERR.


206
207
208
# File 'lib/r_spec.rb', line 206

def self.it(name = nil, &block)
  Clone::Dsl.it(name, &block)
end

.it!(name = nil, &block) ⇒ Object

Runs a concrete test case in a subprocess to isolate side effects.

Examples:

app = "Hello, world!"

require "r_spec"

RSpec.it! { expect(app.gsub!("world", "Alice")).to eq "Hello, Alice!" }

# Output to the console
#   Success: expected to eq "Hello, Alice!".

RSpec.it { expect(app).to eq "Hello, world!" }

# Output to the console
#   Success: expected to eq "Hello, world!".

233
234
235
# File 'lib/r_spec.rb', line 233

def self.it!(name = nil, &block)
  Clone::Dsl.it!(name, &block)
end

.pending(message) ⇒ nil

Defines a pending test case.

`&block` is never evaluated. It can be used to describe behaviour that is not yet implemented.

It is usually used inside a RSpec::Clone::Dsl.describe or RSpec::Clone::Dsl.context section.

Examples:

require "r_spec"

RSpec.pending "is implemented but waiting" do
  expect something to be finished
end

RSpec.pending "is not yet implemented and waiting"

# Output to the console
#   Warning: is implemented but waiting.
#   Warning: is not yet implemented and waiting.

Parameters:

  • message (String)

    The reason why the example is pending.

Returns:

  • (nil)

    Write a message to STDOUT.


263
264
265
# File 'lib/r_spec.rb', line 263

def self.pending(message)
  Clone::Dsl.pending(message)
end