a43b8e44dd
* The main problem I had with the old tests is that information that the reader didn't need to care about was not properly abstracted away. For instance, a helper method used by almost all tests will always create a model called Example, and will always use an attribute called "attr" (on which the validation is present). However, in some tests the class or attribute is referred to directly. The reader shouldn't have to care about either of these things, since they are constant -- the tests should be readable enough so that this information is not necessary to understand the case being tested against. * Speaking of this helper method, some of the tests used it and some didn't. Some defined their own helper methods to represent a particular case (`case_sensitive: true`, `allow_nil`, etc.). This is now fixed so that all but two tests use the same helper method to define a model. This model is completely customizable -- one can specify the type of the attribute being validated, the names and types of scoped attributes, etc. * The tests around scoped attributes and different types are all basically the same, so they are now compressed into a shared context. * Related to this, we no longer have to worry about setting a proper value for a scope attribute. One had to know which type that attribute had and come up with a reasonable default for that type. Now there is a helper method that worries about this automatically. * Finally, we remove tests around case_insensitive against an integer attribute (these don't make any sense, and don't work). |
||
|---|---|---|
| .hound_config | ||
| doc_config | ||
| gemfiles | ||
| lib | ||
| script | ||
| spec | ||
| tasks | ||
| .gitignore | ||
| .hound.yml | ||
| .travis.yml | ||
| .yardopts | ||
| Appraisals | ||
| CONTRIBUTING.md | ||
| cucumber.yml | ||
| docs.watchr | ||
| Gemfile | ||
| Gemfile.lock | ||
| MIT-LICENSE | ||
| NEWS.md | ||
| Rakefile | ||
| README.md | ||
| shoulda-matchers.gemspec | ||
shoulda-matchers 
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
- allow_mass_assignment_of
tests usage of Rails 3's
attr_accessibleandattr_protectedmacros. - allow_value
tests usage of the
validates_format_ofvalidation. - have_secure_password
tests usage of
has_secure_password. - validate_confirmation_of
tests usage of
validates_confirmation_of. - validate_exclusion_of
tests usage of
validates_exclusion_of. - validate_inclusion_of
tests usage of
validates_inclusion_of. - validate_length_of
tests usage of
validates_length_of. - validate_numericality_of
tests usage of
validates_numericality_of. - validate_presence_of
tests usage of
validates_presence_of.
ActiveRecord Matchers
- accept_nested_attributes_for
tests usage of the
accepts_nested_attributes_formacro. - belong_to
tests your
belongs_toassociations. - define_enum_for
tests usage of the
enummacro. - have_and_belong_to_many
tests your
has_and_belongs_to_manyassociations. - have_db_column tests that the table that backs your model has a specific column.
- have_db_index tests that the table that backs your model has an index on a specific column.
- have_many
tests your
has_manyassociations. - have_one
tests your
has_oneassociations. - have_readonly_attribute
tests usage of the
attr_readonlymacro. - serialize tests
usage of the
serializemacro. - validate_uniqueness_of
tests usage of
validates_uniqueness_of.
ActionController Matchers
- filter_param tests parameter filtering configuration.
- redirect_to tests that an action redirects to a certain location.
- render_template tests that an action renders a template.
- render_with_layout tests that an action is rendered with a certain layout.
- rescue_from
tests usage of the
rescue_frommacro. - respond_with tests that an action responds with a certain status code.
- route tests your routes.
- set_session
makes assertions on the
sessionhash. - set_flash
makes assertions on the
flashhash. - use_after_action
tests that a
after_actioncallback is defined in your controller. (Aliased as use_after_filter.) - use_around_action
tests that a
around_actioncallback is defined in your controller. (Aliased as use_around_filter.) - use_before_action
tests that a
before_actioncallback is defined in your controller. (Aliased as use_before_filter.)
Independent Matchers
- delegate_method tests that an object forwards messages to other, internal objects by way of delegation.
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, a meta-gem
that also provides should and context syntax via
shoulda-context. For this reason you'll want to include this
gem 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 present beforehand.
If your application is written against Rails, everything should "just work", as shoulda-matchers will most likely be declared after Rails in your Gemfile. If your application is written against 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.