Simple one-liner tests for common Rails functionality
Go to file
Elliot Winkler 2a7389ef69 Tweak failure message for allow_value
allow_value currently gives an error message that looks like this:

    Expected errors to include "must be greater than 0" when amount is set to 0, got errors: ["amount must be greater than 0.0 (0)"]

This is confusing because the error message here is "must be greater than 0.0",
not "amount must be greater than 0.0".

With this commit the message changes to:

    Expected errors to include "must be greater than 0" when amount is set to 0, got errors: ["must be greater than 0.0 (attribute: "amount", value: 0)"]
2014-06-27 14:39:01 -06:00
doc_config Fix method links in README to work on GH and YARD 2014-06-21 20:02:21 -06:00
features Use same assertion class as Rails, if loaded 2014-06-27 14:06:47 -06:00
gemfiles Use same assertion class as Rails, if loaded 2014-06-27 14:06:47 -06:00
lib Tweak failure message for allow_value 2014-06-27 14:39:01 -06:00
script Add a script to run all tests on all Rubies 2014-06-27 14:04:50 -06:00
spec Tweak failure message for allow_value 2014-06-27 14:39:01 -06:00
.gitignore Publish new docs when releasing a new version 2014-06-20 16:41:37 -06:00
.travis.yml Use same assertion class as Rails, if loaded 2014-06-27 14:06:47 -06:00
.yardopts Generate docs using YARD 2014-06-20 16:41:32 -06:00
Appraisals Use same assertion class as Rails, if loaded 2014-06-27 14:06:47 -06:00
CONTRIBUTING.md Install appraisals before running the test suite 2014-02-22 14:46:55 -07:00
Gemfile Generate docs using YARD 2014-06-20 16:41:32 -06:00
Gemfile.lock Generate docs using YARD 2014-06-20 16:41:32 -06:00
MIT-LICENSE Changed MIT License copyright year to 2014 2014-01-20 09:22:41 -07:00
NEWS.md Use same assertion class as Rails, if loaded 2014-06-27 14:06:47 -06:00
README.md Rename yard.watchr to docs.watchr 2014-06-21 20:04:17 -06:00
Rakefile Use same assertion class as Rails, if loaded 2014-06-27 14:06:47 -06:00
cucumber.yml Use same assertion class as Rails, if loaded 2014-06-27 14:06:47 -06:00
docs.watchr Rename yard.watchr to docs.watchr 2014-06-21 20:04:17 -06:00
shoulda-matchers.gemspec Move dev dependencies to Gemfile 2014-06-19 22:24:29 -06:00

README.md

shoulda-matchers Gem Version Build Status

Official Documentation

shoulda-matchers provides Test::Unit- and RSpec-compatible one-liners that test common Rails functionality. These tests would otherwise be much longer, more complex, and error-prone.

ActiveModel Matchers

ActiveRecord Matchers

ActionController Matchers

Installation

RSpec

Include the gem in your Gemfile:

group :test do
  gem 'shoulda-matchers', require: false
end

Then require the gem following rspec-rails in your rails_helper (or spec_helper if you're using RSpec 2.x):

require 'rspec/rails'
require 'shoulda/matchers'

Test::Unit

shoulda-matchers was originally a component of Shoulda -- it's what provides the nice should syntax which is demonstrated below. For this reason, include it in your Gemfile instead:

group :test do
  gem 'shoulda'
end

Non-Rails apps

Once it is loaded, shoulda-matchers automatically includes itself into your test framework. It will mix in the appropriate matchers for ActiveRecord, ActiveModel, and ActionController depending on the modules that are available at runtime. For instance, in order to use the ActiveRecord matchers, ActiveRecord must be available beforehand.

If your application is on Rails, everything should "just work", as shoulda-matchers will most likely be declared after Rails in your Gemfile. If your application is on another framework such as Sinatra or Padrino, you may have a different setup, so you will want to ensure that you are requiring shoulda-matchers after the components of Rails you are using. For instance, if you wanted to use and test against ActiveModel, you'd say:

gem 'activemodel'
gem 'shoulda-matchers'

and not:

gem 'shoulda-matchers'
gem 'activemodel'

Generating documentation

YARD is used to generate documentation, which can be viewed online. You can preview changes you make to the documentation locally by running

yard doc

from this directory. Then, open doc/index.html in your browser.

If you want to see a live preview as you work without having to run yard over and over again, keep this command running in a separate terminal session:

watchr docs.watchr

Versioning

shoulda-matchers follows Semantic Versioning 2.0 as defined at http://semver.org.

Credits

shoulda-matchers is maintained and funded by thoughtbot. Thank you to all the contributors.

License

shoulda-matchers is copyright © 2006-2014 thoughtbot, inc. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.