Scampi

A small Ruby test framework forked from Bacon with built-in TAP (Test Anything Protocol) output.

Usage

Tests can live alongside your code using the test block — it only runs when the file is executed directly or via scampi:

# greet.rb
def greet(name) = "hello #{name}"

test do
  it "equality and matching" do
    greet("world").should == "hello world"
    greet("world").should.equal "hello world"
    greet("world").should =~ /hello/
    greet("world").should.match(/hello/)
  end

  it "negation" do
    greet("world").should.not == "goodbye"
    greet("world").should.not.match(/goodbye/)
  end

  it "predicates" do
    [].should.be.empty
    nil.should.be.nil
    true.should.be.true
    false.should.be.false
  end

  it "type checks" do
    "hello".should.be.kind_of String
    "hello".should.be.instance_of String
    "hello".should.respond_to :upcase
  end

  it "identity" do
    s = "hello"
    s.should.be.identical_to s
    s.should.be.same_as s
  end

  it "comparisons" do
    5.should.be > 3
    5.should.be >= 5
    3.should.be < 5
    5.should.be <= 5
  end

  it "collections" do
    [1, 2, 3].should.include 2
  end

  it "numeric closeness" do
    3.14.should.be.close 3.1, 0.05
  end

  it "custom matchers" do
    palindrome = lambda { |obj| obj == obj.reverse }
    "racecar".should.be.a palindrome
  end

  it "satisfy" do
    10.should.satisfy { |n| n.even? }
  end

  describe "exceptions and flow" do
    it "raises" do
      lambda { raise "boom" }.should.raise
      lambda { raise "boom" }.should.raise(RuntimeError)
      lambda { 1 + 1 }.should.not.raise
    end

    it "throws" do
      lambda { throw :halt }.should.throw(:halt)
    end

    it "detects change" do
      i = 0
      lambda { i += 1 }.should.change { i }
    end
  end
end

$ ruby greet.rb
$ scampi greet.rb