shoulda-matchers

# Shoulda Matchers [![Gem Version][version-badge]][rubygems] [![Build Status][github-actions-badge]][github-actions] [![Total Downloads][downloads-total]][rubygems] [![Downloads][downloads-badge]][rubygems]

[version-badge]: https://img.shields.io/gem/v/shoulda-matchers.svg
[rubygems]: https://rubygems.org/gems/shoulda-matchers
[github-actions-badge]: https://img.shields.io/github/actions/workflow/status/thoughtbot/shoulda-matchers/ci.yml?branch=main
[github-actions]: https://github.com/thoughtbot/shoulda-matchers/actions
[downloads-total]: https://img.shields.io/gem/dt/shoulda-matchers.svg
[downloads-badge]: https://img.shields.io/gem/dtv/shoulda-matchers.svg
[downloads-badge]: https://img.shields.io/gem/dtv/shoulda-matchers.svg

[![shoulda-matchers][logo]][website]

[logo]: https://matchers.shoulda.io/images/shoulda-matchers-logo.png
[website]: https://matchers.shoulda.io/

Shoulda Matchers provides RSpec and Minitest-compatible one-liners to test
common Rails functionality that, if written by hand, would be much longer, more
complex, and error-prone.

## Quick links

📖 **[Read the documentation for the latest version][rubydocs].**
📢 **[See what's changed in recent versions][changelog].**

[rubydocs]: https://matchers.shoulda.io/docs
[changelog]: CHANGELOG.md

## Table of contents

- [Getting started](#getting-started)
   - [RSpec](#rspec)
    - [Rails apps](#rails-apps)
    - [Non-Rails apps](#non-rails-apps)
  - [Minitest](#minitest)
    - [Rails apps](#rails-apps-1)
    - [Non-Rails apps](#non-rails-apps-1)
- [Usage](#usage)
  - [On the subject of `subject`](#on-the-subject-of-subject)
  - [Availability of RSpec matchers in example groups](#availability-of-rspec-matchers-in-example-groups)
    - [Rails projects](#rails-projects)
    - [Non-Rails projects](#non-rails-projects)
  - [`should` vs `is_expected.to`](#should-vs-is_expectedto)
  - [A Note on Testing Style](#a-note-on-testing-style)
- [Matchers](#matchers)
  - [ActiveModel matchers](#activemodel-matchers)
  - [ActiveRecord matchers](#activerecord-matchers)
  - [ActionController matchers](#actioncontroller-matchers)
  - [Routing matchers](#routing-matchers)
  - [Independent matchers](#independent-matchers)
- [Extensions](#extensions)
- [Contributing](#contributing)
- [Compatibility](#compatibility)
- [Versioning](#versioning)
- [Team](#team)
- [Copyright/License](#copyrightlicense)
- [About thoughtbot](#about-thoughtbot)

## Getting started

### RSpec

Start by including `shoulda-matchers` in your Gemfile:

```ruby
group :test do
  gem 'shoulda-matchers', '~> 8.0'
end
```

Then run `bundle install`.

Now you need to configure the gem by telling it:

- which matchers you want to use in your tests
- that you're using RSpec so that it can make those matchers available in
  your example groups

#### Rails apps

If you're working on a Rails app, simply place this at the bottom of
`spec/rails_helper.rb` (or in a support file if you so choose):

```ruby
Shoulda::Matchers.configure do |config