shoulda-matchers 3.1.3 → 4.0.0.rc1

data/.python-version

@@ -0,0 +1 @@
+2.7.15

data/.rubocop.yml

@@ -1,5 +1,7 @@
 inherit_from: .hound/ruby.yml
-Style/AlignParameters:
+AllCops:
+  TargetRubyVersion: 2.4
+Layout/AlignParameters:
   EnforcedStyle: with_fixed_indentation
 Style/CollectionMethods:
   PreferredMethods:

data/.travis.yml

@@ -9,12 +9,13 @@ env:
   - DATABASE_ADAPTER=postgresql
 
 rvm:
-  - 2.0
-  - 2.1
-  - 2.2
+  - 2.5.1
+  - 2.4.4
+  - 2.3.7
+  - 2.2.8
 
 gemfile:
-  - gemfiles/4.0.0.gemfile
-  - gemfiles/4.0.1.gemfile
-  - gemfiles/4.1.gemfile
   - gemfiles/4.2.gemfile
+  - gemfiles/5.0.gemfile
+  - gemfiles/5.1.gemfile
+  - gemfiles/5.2.gemfile

data/Appraisals

@@ -1,10 +1,9 @@
-ruby_version = Gem::Version.new(RUBY_VERSION + '')
+# Note: All of the dependencies here were obtained by running `rails new` with
+# various versions of Rails and copying lines from the generated Gemfile. It's
+# best to keep the gems here in the same order as they're listed there so you
+# can compare them more easily.
 
-shared_dependencies = proc do
-  gem 'rspec-rails', '>= 3.2.0', '< 4'
-  gem 'shoulda-context', '~> 1.2.0'
-  gem 'sqlite3', platform: :ruby
-  gem 'pg', platform: :ruby
+shared_jruby_dependencies = proc do
   gem 'activerecord-jdbc-adapter', platform: :jruby
   gem 'activerecord-jdbcsqlite3-adapter', platform: :jruby
   gem 'jdbc-sqlite3', platform: :jruby
@@ -12,62 +11,95 @@ shared_dependencies = proc do
   gem 'therubyrhino', platform: :jruby
 end
 
-spring = proc do
+shared_rails_dependencies = proc do
+  gem 'sqlite3', platform: :ruby
+  gem 'pg', platform: :ruby
+end
+
+shared_spring_dependencies = proc do
   gem 'spring'
   gem 'spring-commands-rspec'
 end
 
-rails_4 = proc do
+shared_test_dependencies = proc do
+  gem 'minitest-reporters'
+  # gem 'nokogiri', '~> 1.8'
+  gem 'rspec-rails', '~> 3.6'
+  gem 'shoulda-context', '~> 1.2.0'
+end
+
+shared_dependencies = proc do
+  instance_eval(&shared_jruby_dependencies)
+  instance_eval(&shared_rails_dependencies)
+  instance_eval(&shared_spring_dependencies)
+  instance_eval(&shared_test_dependencies)
+end
+
+appraise '4.2' do
   instance_eval(&shared_dependencies)
-  instance_eval(&spring)
+
+  gem 'rails', '~> 4.2.9'
+  gem 'sass-rails', '~> 5.0'
   gem 'uglifier', '>= 1.3.0'
-  gem 'coffee-rails', '~> 4.0.0'
+  gem 'coffee-rails', '~> 4.1.0'
   gem 'jquery-rails'
   gem 'turbolinks'
-  gem 'sdoc'
+  gem 'jbuilder', '~> 2.0'
+  gem 'sdoc', '~> 0.4.0', group: :doc
+  gem 'bcrypt', '~> 3.1.7'
+
+  # Other dependencies we use
   gem 'activeresource', '4.0.0'
-  # Test suite makes heavy use of attr_accessible
-  gem 'protected_attributes'
-  gem 'minitest-reporters'
+  gem 'json', '~> 1.4'
+  gem 'protected_attributes', '~> 1.0.6'
 end
 
-#---
+appraise '5.0' do
+  instance_eval(&shared_dependencies)
 
-appraise '4.0.0' do
-  instance_eval(&rails_4)
-  gem 'rails', '4.0.0'
-  gem 'jbuilder', '~> 1.2'
-  gem 'sass-rails', '~> 4.0.0'
-  gem 'bcrypt-ruby', '~> 3.0.0'
+  gem 'rails', '~> 5.0.6'
+  gem 'rails-controller-testing', '>= 1.0.1'
+  gem 'puma', '~> 3.0'
+  gem 'sass-rails', '~> 5.0'
+  gem 'jquery-rails'
+  gem 'turbolinks', '~> 5'
+  gem 'jbuilder', '~> 2.5'
+  gem 'bcrypt', '~> 3.1.7'
+  gem 'listen', '~> 3.0.5'
+  gem 'spring-watcher-listen', '~> 2.0.0'
 end
 
-appraise '4.0.1' do
-  instance_eval(&rails_4)
-  gem 'rails', '4.0.1'
-  gem 'jbuilder', '~> 1.2'
-  gem 'sass-rails', '~> 4.0.0'
-  gem 'bcrypt-ruby', '~> 3.1.2'
-end
+appraise '5.1' do
+  instance_eval(&shared_dependencies)
 
-appraise '4.1' do
-  instance_eval(&rails_4)
-  gem 'rails', '~> 4.1.0'
-  gem 'jbuilder', '~> 2.0'
-  gem 'sass-rails', '~> 4.0.3'
-  gem 'sdoc', '~> 0.4.0'
+  gem 'rails', '~> 5.1.6'
+  gem 'rails-controller-testing', '>= 1.0.1'
+  gem 'puma', '~> 3.7'
+  gem 'sass-rails', '~> 5.0'
+  gem 'turbolinks', '~> 5'
+  gem 'jbuilder', '~> 2.5'
   gem 'bcrypt', '~> 3.1.7'
-  gem 'protected_attributes', "~> 1.0.6"
-  gem 'spring'
+  gem 'capybara', '~> 2.13'
+  gem 'selenium-webdriver'
+  gem 'listen', '>= 3.0.5', '< 3.2'
+  gem 'spring-watcher-listen', '~> 2.0.0'
 end
 
-appraise '4.2' do
-  instance_eval(&rails_4)
-  gem 'rails', '~> 4.2.0'
+
+appraise '5.2' do
+  instance_eval(&shared_dependencies)
+
+  gem 'rails', '~> 5.2.1'
+  gem 'rails-controller-testing', '>= 1.0.1'
+  gem 'puma', '~> 3.11'
+  gem 'bootsnap', '>= 1.1.0', require: false
   gem 'sass-rails', '~> 5.0'
-  gem 'coffee-rails', '~> 4.1.0'
-  gem 'jbuilder', '~> 2.0'
-  gem 'sdoc', '~> 0.4.0'
+  gem 'turbolinks', '~> 5'
+  gem 'jbuilder', '~> 2.5'
   gem 'bcrypt', '~> 3.1.7'
-  gem 'spring'
-  gem 'protected_attributes', "~> 1.0.6"
+  gem 'capybara', '~> 3.1.1'
+  gem 'selenium-webdriver'
+  gem 'chromedriver-helper'
+  gem 'listen', '>= 3.0.5', '< 3.2'
+  gem 'spring-watcher-listen', '~> 2.0.0'
 end

data/CONTRIBUTING.md

@@ -1,101 +1,172 @@
-# Contributing to shoulda-matchers
+# Contributing to Shoulda Matchers
+
+We've put a lot of work into making improvements to Shoulda Matchers, but we
+always welcome changes and improvements from the community!
+
+If you'd like to propose a change to the gem, whether it's a fix for a problem
+you've been running into or an idea for a new feature you think would be useful,
+here's how the process works:
+
+1. [Read and understand the Code of Conduct](#code-of-conduct).
+1. Fork this repo and clone your fork to somewhere on your machine.
+1. [Ensure that you have a working environment](#setting-up-your-environment).
+1. Read up on the [architecture of the gem](#architecture), [how to run
+   tests](#running-tests), and [the code style we use in this
+   project](#code-style).
+1. Cut a new branch and write a failing test for the feature or bugfix you plan
+   on implementing.
+1. [Make sure your branch is well managed as you go
+   along](#managing-your-branch).
+1. [Update the inline documentation if you're making a change to the
+   API](#documentation).
+1. [Refrain from updating the changelog.](#a-word-on-the-changelog)
+1. Finally, push to your fork and submit a pull request.
 
-We love contributions from the community! Here's a quick guide to making a pull
-request.
+Although we maintain the gem in our free time, we try to respond within a day or
+so. After submitting your PR, we may give you feedback. For instance, we may
+suggest some changes to make to your code to fit within the project style or
+discuss alternate ways of addressing the issue in question. Assuming we're happy
+with everything, we'll bring your changes into master!
 
-1. If you haven't contributed before, please read and understand the [Code of
-   Conduct].
+---
 
-1. Ensure that you have a [working Ruby environment].
+## Code of Conduct
 
-1. Fork the repo on GitHub, then clone it to your machine.
+If this is your first time contributing, please read the [Code of Conduct]. We
+want to create a space in which everyone is allowed to contribute, and we
+enforce the policies outline in this document.
 
-1. Now that you've cloned the repo, navigate to it and install dependencies by
-   running:
+[Code of Conduct]: https://thoughtbot.com/open-source-code-of-conduct
 
-   ```
-   bundle install
-   ```
+## Setting up your environment
 
-1. All tests should be passing, but it's a good idea to run them anyway
-   before starting any work:
-   
-   ```
-   bundle exec rake
-   ```
+The setup script will install all dependencies necessary for working on the
+project:
 
-1. If you're adding functionality or fixing a bug, you'll want to add a
-   failing test for the issue first.
+```bash
+bin/setup
+```
 
-1. Now you can implement the feature or bugfix.
+## Architecture
 
-1. Since we only accept pull requests with passing tests, it's a good idea to
-   run the tests again. Since you're probably working on a single file, you can
-   run the tests for that file with the following command:
+This project follows the typical structure for a gem: code is located in `lib`
+and tests are in `spec`.
 
-   ```
-   appraisal 4.2 rspec <path of test file to run>
-   ```
+All of the matchers are broken up by the type of example group they apply to:
 
-   You can also run unit tests by running `zeus start` in one shell, and then
-   running the following in another:
+* `{lib,spec/unit}/shoulda/matchers/action_controller*` for ActionController
+  matchers
+* `{lib,spec/unit}/shoulda/matchers/active_model*` for ActiveModel matchers
+* `{lib,spec/unit}/shoulda/matchers/active_record*` for ActiveRecord matchers
+* `{lib,spec/unit}/shoulda/matchers/independent*` for matchers that can be used
+  in any example group
 
-   ```
-   zeus rspec <path of test file to run>
-   ```
+There are other files in the project, of course, but there are likely the ones
+that you'll be interested in.
 
-   And to run the entire test suite again:
-   
-   ```
-   bundle exec rake
-   ```
+In addition, tests are broken up into two categories:
 
-1. Finally, push to your fork and submit a pull request.
+* `spec/unit`
+* `spec/acceptance`
+
+A word about the tests, by the way: they're admittedly the most complicated part
+of this gem, and there are a few different strategies that we've introduced at
+various points in time to set up objects for tests across all specs, some of
+which are old and some of which are new. The best approach for writing tests is
+probably to copy an existing test in the same file as where you want to add a
+new test.
+
+## Code style
+
+We follow a derivative of the [unofficial Ruby style guide] created by the
+Rubocop developers. You can view our Rubocop configuration [here], but here are
+some key differences:
+
+* Use single quotes for strings.
+* When breaking up methods across multiple lines, place the `.` at the end of
+  the line instead of the beginning.
+* Don't use conditional modifiers (i.e. `x if y`); place the beginning and
+  ending of conditionals on their own lines.
+* Use an 80-character line-length except for `describe`, `context`, `it`, and
+  `specify` lines in tests.
+* For arrays, hashes, and method arguments that span multiple lines, place a
+  trailing comma at the end of the last item.
+* Collection methods are spelled `detect`, `inject`, `map`, and `select`.
+
+[unofficial Ruby style guide]: https://github.com/rubocop-hq/ruby-style-guide
+[here]: .rubocop.yml
 
-At this point you're waiting on us. We try to respond to issues and pull
-requests within a few business days. We may suggest some changes to make to your
-code to fit with our [code style] or the project style, or discuss alternate
-ways of addressing the issue in question. When we're happy with everything,
-we'll bring your changes into master. Now you're a contributor!
+## Running tests
 
-## Addendum: Setting up your environment
+### Unit tests
 
-### Installing dependencies (Linux only)
+Unit tests are the most common kind of tests in the gem. They exercise matcher
+code file by file in the context of a real Rails application. This application
+is created and loaded every time you run `rspec`. Because of this, it can be
+expensive to run individual tests. To save time, the best way to run unit tests
+is by using [Zeus].
 
-#### Debian/Ubuntu
+[Zeus]: https://github.com/burke/zeus
 
-Run this command to install necessary dependencies:
+You'll want to start by running `zeus start` in one shell. Then in another
+shell, instead of using `bundle exec rspec` to run tests, you'll use `bundle
+exec zeus rspec`. So for instance, you might say:
 
 ```
-sudo apt-get install -y ruby-dev libpq-dev libsqlite3-dev nodejs
+bundle exec zeus rspec spec/unit/shoulda/matchers/active_model/validate_inclusion_of_matcher_spec.rb
 ```
 
-#### RedHat
+### Acceptance tests
 
-Run this command to install necessary dependencies:
+The acceptance tests exercise matchers in the context of a real Ruby or Rails
+application. Unlike unit tests, this application is set up and torn down for
+each test.
+
+Whereas you make use of Zeus to run unit tests, you make use of Appraisal for
+acceptance tests. [Appraisal] lets you run tests against multiple versions of
+Rails and Ruby, and in fact, this is baked into the test suite. This means that
+if you're trying to run a single test file, you'll need to specify which
+appraisal to use. For instance, you can't simply say:
+
+[Appraisal]: https://github.com/thoughtbot/appraisal
 
 ```
-sudo yum install -y ruby-devel postgresql-devel sqlite-devel zlib-devel
+bundle exec rspec spec/acceptance/active_model_integration_spec.rb
 ```
 
-Then, install one of the JavaScript runtimes supported by [execjs]. For
-instance, to install node.js:
+Instead, you need to say
 
 ```
-sudo su
-curl -sL https://rpm.nodesource.com/setup | bash -
-yum install -y nodejs
+bundle exec appraisal 5.1 rspec spec/acceptance/active_model_integration_spec.rb
 ```
 
-### Installing Ruby (all platforms)
+## Managing your branch
 
-shoulda-matchers is only compatible with Ruby 2.x. A `.ruby-version` is included
-in the repo, so if you're using one of the Ruby version manager tools, then you
-should be using (or have been prompted to install) the latest version of Ruby.
-If not, you'll want to do that.
+* Use well-crafted commit messages, providing context if possible. [tpope's
+  guide] was a wonderful piece on this topic when it came out and we still find
+  it to be helpful even today.
+* Squash "WIP" commits and remove merge commits by rebasing. We try to keep our
+  commit history as clean as possible.
 
-[working Ruby environment]: #addendum-setting-up-your-environment
-[Code of Conduct]: https://thoughtbot.com/open-source-code-of-conduct
-[code style]: https://github.com/thoughtbot/guides/tree/master/style
-[execjs]: https://github.com/sstephenson/execjs
-[install rvm]: https://rvm.io/rvm/install
+[tpope's guide]: https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+
+## Documentation
+
+As you navigate the codebase, you may notice that each class and method in the
+public API is prefaced with inline documentation, which can be viewed
+[online][rubydocs]. This documentation is written and generated using
+[YARD][yard].
+
+[rubydocs]: https://matchers.shoulda.io/docs
+[yard]: https://github.com/lsegal/yard
+
+We ensure that the documentation is up to date before we issue a release, but
+sometimes we don't catch everything. So if your changes end up extending or
+updating the API, it's a big help if you can update the documentation to match
+and submit those changes in your PR.
+
+## A word on the changelog
+
+You may also notice that we have a changelog in the form of [NEWS.md](NEWS.md).
+You may be tempted to include changes to this in your branch, but don't worry
+about this -- we'll take care of it!

data/Gemfile

@@ -1,12 +1,12 @@
 source 'https://rubygems.org'
 
-gem 'appraisal', '~> 2.0'
+gem 'appraisal', '2.2.0'
 gem 'bundler', '~> 1.1'
-gem 'pry', git: 'https://github.com/pry/pry.git'
+gem 'pry'
 gem 'pry-byebug'
-gem 'rake', '>= 10.5.0', '< 11'
-gem 'rspec', '~> 3.2'
-gem 'zeus'
+gem 'rake', '12.3.0'
+gem 'rspec', '~> 3.6'
+gem 'zeus', require: false
 
 # YARD
 gem 'yard'

data/Gemfile.lock

@@ -1,64 +1,59 @@
-GIT
-  remote: https://github.com/pry/pry.git
-  revision: 1f64463184e0a160d0b41d1a1f92b8e2f230278c
-  specs:
-    pry (0.10.4)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-
 GEM
   remote: https://rubygems.org/
   specs:
-    appraisal (2.1.0)
+    appraisal (2.2.0)
       bundler
       rake
       thor (>= 0.14.0)
-    byebug (9.0.6)
-    coderay (1.1.1)
-    diff-lcs (1.2.5)
+    byebug (9.1.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
     fssm (0.2.10)
-    method_source (0.8.2)
+    method_source (0.9.0)
     multi_json (1.12.1)
-    pry-byebug (3.4.2)
-      byebug (~> 9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.5.1)
+      byebug (~> 9.1)
       pry (~> 0.10)
     pygments.rb (1.1.1)
       multi_json (>= 1.0.0)
-    rake (10.5.0)
+    rake (12.3.0)
     redcarpet (3.4.0)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.4)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
-    thor (0.19.4)
-    yard (0.9.6)
-    zeus (0.15.12)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    thor (0.20.0)
+    yard (0.9.12)
+    zeus (0.15.14)
       method_source (>= 0.6.7)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  appraisal (~> 2.0)
+  appraisal (= 2.2.0)
   bundler (~> 1.1)
   fssm
-  pry!
+  pry
   pry-byebug
   pygments.rb
-  rake (>= 10.5.0, < 11)
+  rake (= 12.3.0)
   redcarpet
-  rspec (~> 3.2)
+  rspec (~> 3.6)
   yard
   zeus
 
 BUNDLED WITH
-   1.13.6
+   1.16.1