README

module Spec::Methods

Defined in:

spec/methods.cr

Instance Method Summary

Instance Method Detail

def assert(file = __FILE__, line = __LINE__, end_line = __END_LINE__, &block) #

DEPRECATED Use #it


[View source]
def context(description, file = __FILE__, line = __LINE__, &block) #

Defines an example group that establishes a specific context, like empty array versus array with elements. Inside &block examples are defined by #it or #pending.

It is functionally equivalent to #describe.


[View source]
def describe(description, file = __FILE__, line = __LINE__, &block) #

Defines an example group that describes a unit to be tested. Inside &block examples are defined by #it or #pending.

Several #describe blocks can be nested.

Example:

describe "Int32" do
  describe "+" do
    it "adds" { (1 + 1).should eq 2 }
  end
end

[View source]
def fail(msg, file = __FILE__, line = __LINE__) #

Fails an example.

This method can be used to manually fail an example defined in an #it block.


[View source]
def it(description = "assert", file = __FILE__, line = __LINE__, end_line = __END_LINE__, &block) #

Defines a concrete test case.

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

Example:

it "adds" { (1 + 1).should eq 2 }

It is usually used inside a #describe or #context section.


[View source]
def pending(description = "assert", file = __FILE__, line = __LINE__, end_line = __END_LINE__, &block) #

Defines a pending test case.

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

Example:

pending "check cat" { cat.alive? }

It is usually used inside a #describe or #context section.


[View source]