thoughtbot have created a really nice set of custom matchers for RSpec. The Shoulda matchers make writing tests for rails models beautiful and clean.
Shoulda matchers make it possible to write specs of the form:
It’s easy to do this for yourself using the friendly matcher DSL that ships with RSpec. Let’s take a look at how.
In the simplest form, all you need to do is to call the define method, passing a name, and a block which in turn calls out to match. The simple case might be:
We’ve just defined a matcher :be_less_than which allows us to do the following:
If we use the describe auto subject feature of RSpec we can also write:
With that example we can see that we are getting close to the shoulda matcher syntax. There’s still an extra level that helps make the shoulda matchers nice, chaining. Happily this is easy to do as well. The dsl provides a chain method. The chain methods are called before the match, so you can use the chain calls to collect up additional information to validate. Using our example above, we might want to add in an :and_greater_than chain.
This now will give us the ability to write:
Unfortunately the default descriptions don’t quite work as nice when there are chains in place. You’ll find that you’ll want to write a description in the matcher definition.
Unfortunately the description doesn’t automatically get used in the error messages when the matcher fails, so you’ll want to specify a failure_message_for_should. Basing it off the description is an ok starting point.
Happily RSpec does the right thing with the should not description, so with the details above the matcher will be good. There might be a case where you want a different failure_message_for_should_not, which can also be specified.
That covers how to write simple reusable RSpec matchers to make your test code look as beautiful as your production code. Go ahead and try it yourself. I’d love to see comments or questions you might have on this.