Shoulda

Shoulda helps you write more understandable, maintainable Rails-specific tests under Minitest and Test::Unit.

Quick links

📢 See what's changed in recent versions.

Overview

As a meta gem, the shoulda gem doesn't contain any code of its own but rather brings in behavior from two other gems:

For instance:

require "test_helper"

class UserTest < ActiveSupport::TestCase
  context "associations" do
    should have_many(:posts)
  end

  context "validations" do
    should validate_presence_of(:email)
    should allow_value("[email protected]").for(:email)
    should_not allow_value("not-an-email").for(:email)
  end

  context "#name" do
    should "consist of first and last name" do
      user = User.new(first_name: "John", last_name: "Smith")
      assert_equal "John Smith", user.name
    end
  end
end

Here, the context and should methods come from Shoulda Context; matchers (e.g. have_many, allow_value) come from Shoulda Matchers.

See the READMEs for these projects for more information.

Compatibility

Shoulda Matchers is tested and supported against Ruby 2.4+, Rails 4.2.x+, RSpec 3.x, and Minitest 5.x.

Contributing

Shoulda is open source, and we are grateful for everyone who's contributed so far.

If you'd like to contribute, please take a look at the instructions for installing dependencies and crafting a good pull request.

Versioning

Shoulda follows Semantic Versioning 2.0 as defined at http://semver.org.

License

About thoughtbot

thoughtbot

Shoulda is maintained and funded by thoughtbot, inc. The names and logos for thoughtbot are trademarks of thoughtbot, inc.

We love open source software! See our other projects or hire us to design, develop, and grow your product.