gummesson / should.lua

BDD-style assertions for Lua.

Should

Should is a library that brings BDD-style assertions to Lua.

It's designed to be a companion to Busted, but should work independently too.

Why?

I love Busted but I'm not a fan of the word "assert".

Installation

luarocks build https://raw.github.com/gummesson/should.lua/master/should-dev-1.rockspec

Assertions

should / expect

• should.Equal / expect:toEqual
• should.Eql / expect:toEql
• should.be.Type / expect:toBeType
• should.be.True / expect:toBeTrue
• should.be.False / expect:toBeFalse
• should.be.Nil / expect:toBeNil
• should.be.Blank / expect:toBeBlank
• should.be.Empty / expect:toBeEmpty
• should.be.Above / expect:toBeAbove
• should.be.Gte / expect:toBeGte
• should.be.Below / expect:toBeBelow
• should.be.Lte / expect:toBeLte
• should.Match / expect:toMatch
• should.have.Property / expect:toHaveProperty
• should.have.Error / expect:toHaveError

should.Not / expect:not

• should.Not.Equal / expect:notToEqual
• should.Not.Eql / expect:notToEql
• should.Not.be.Type / expect:notToBeType
• should.Not.be.True / expect:notToBeTrue
• should.Not.be.False / expect:notToBeFalse
• should.Not.be.Nil / expect:notToBeNil
• should.Not.be.Blank / expect:notToBeBlank
• should.Not.be.Empty / expect:notToBeEmpty
• should.Not.be.Above / expect:notToBeAbove
• should.Not.be.Gte / expect:notToBeGte
• should.Not.be.Below / expect:notToBeBelow
• should.Not.be.Lte / expect:notToBeLte
• should.Not.Match / expect:notToMatch
• should.Not.have.Property / expect:notToHaveProperty
• should.Not.have.Error / expect:notToHaveError

Check out the API documentation for more information.

What's up with the capitalized letters?

Lua has some reserved words, like not, nil and error, which means it's not really appropriate to use them. I decided to capitalized all assertions for consistency.

Dependencies

• inspect, which is licensed under the MIT license.
• ansicolors, which is licensed under the MIT license.

License

The MIT License (MIT)

Copyright (c) 2013 Ellen Gummesson

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.