shoulda-matchers 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2fe80273c48fdbadb3d479406470fa875abfcf61
-  data.tar.gz: 3cac554e34d73023e1e3cd5a65bc23291159ff87
+  metadata.gz: 958afbf8d323fd9b923340fdffc6156b7a3249cc
+  data.tar.gz: d20c30587592682f62e4b061619d32254625de23
 SHA512:
-  metadata.gz: df7679b9a7384f93e221a7a9a07411bd6e6f93cd3dc267e262e803b3c7359b3272b4adb037039e09662bf7bb6e9b31d094748109dec3e9050967df8d3691f8f8
-  data.tar.gz: f5c6cea2751c9cf331b96447af1d8f70c6ecd1edae2aac4c587361e438a14caa8cd8da563873135b0421450f28663e1c1b7c4f542182b9a5311cee1480d29520
+  metadata.gz: b2141dd710f58fa62201e4fa3de70c324bbb9e6d225f41d88ecef413c401a10f1426f59025849e466c58d7c58bf6f94b0330b6e82c7577e3797f6bd0f91d97a2
+  data.tar.gz: d22c37a1994c433c9213b1a3090f6cd06201a49d19fbc7cdbeca7bc826fec4b0853a7a216e8977df578b1627011eb23786fe276dc12e2a906116822dd88f0f1b

data/.gitignore

@@ -8,4 +8,5 @@ build
 doc
 pkg
 source
+spec/examples.txt
 tmp

data/.travis.yml

@@ -8,9 +8,9 @@ env:
   - DATABASE_ADAPTER=postgresql
 
 rvm:
-  - 2.0.0
-  - 2.1.4
-  - 2.2.0
+  - 2.0
+  - 2.1
+  - 2.2
 
 gemfile:
   - gemfiles/4.0.0.gemfile

data/CONTRIBUTING.md

@@ -1,24 +1,56 @@
+# Contributing to shoulda-matchers
+
 We love contributions from the community! Here's a quick guide to making a pull
 request.
 
-## Overview
+1. If you haven't contributed before, please read and understand the [Code of
+   Conduct].
+
+1. Ensure that you have a [working Ruby environment].
+
+1. Fork the repo on GitHub, then clone it to your machine.
+
+1. Now that you've cloned the repo, navigate to it and install dependencies by
+   running:
 
-0. If you haven't contributed before, please read and understand the [Code of
-Conduct].
+   ```
+   bundle install
+   ```
 
-1. Fork the repo.
+1. All tests should be passing, but it's a good idea to run them anyway
+   before starting any work:
+   
+   ```
+   bundle exec rake
+   ```
 
-2. Install [dependencies](#installing-dependencies).
+1. If you're adding functionality or fixing a bug, you'll want to add a
+   failing test for the issue first.
 
-3. Run the tests. We only take pull requests with passing tests, and it's great
-to know that you have a clean slate: `bundle && bundle exec rake`
+1. Now you can implement the feature or bugfix.
 
-4. If you're adding functionality or fixing a bug, add a failing test for the
-issue first.
+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:
 
-5. Make the test pass.
+   ```
+   appraisal 4.2 rspec <path of test file to run>
+   ```
 
-6. Finally, push to your fork and submit a pull request.
+   You can also run unit tests by running `zeus start` in one shell, and then
+   running the following in another:
+
+   ```
+   zeus rspec <path of test file to run>
+   ```
+
+   And to run the entire test suite again:
+   
+   ```
+   bundle exec rake
+   ```
+
+1. Finally, push to your fork and submit a pull request.
 
 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
@@ -26,35 +58,27 @@ 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!
 
-## Installing Dependencies
+## Addendum: Setting up your environment
 
-### On Debian/Ubuntu-based systems
+### Installing dependencies (Linux only)
 
-```
-sudo apt-get install -y ruby-dev libpq-dev libsqlite3-dev nodejs
-```
+#### Debian/Ubuntu
 
-Ubuntu, as of 14.04, ships with Ruby 1.9.2. shoulda-matchers is only compatible
-with Ruby 2, so use your Ruby version manager of choice to install the latest
-version of Ruby (2.2.1 at the time of this writing).
+Run this command to install necessary dependencies:
 
 ```
-# RVM
-rvm install 2.2
-rvm use 2.2
-
-# rbenv
-rbenv install 2.2.1
-rbenv shell 2.2.1
+sudo apt-get install -y ruby-dev libpq-dev libsqlite3-dev nodejs
 ```
 
-### On RedHat-based systems
+#### RedHat
+
+Run this command to install necessary dependencies:
 
 ```
 sudo yum install -y ruby-devel postgresql-devel sqlite-devel zlib-devel
 ```
 
-Also, install one of the JavaScript runtimes supported by [execjs]. For
+Then, install one of the JavaScript runtimes supported by [execjs]. For
 instance, to install node.js:
 
 ```
@@ -63,6 +87,14 @@ curl -sL https://rpm.nodesource.com/setup | bash -
 yum install -y nodejs
 ```
 
+### Installing Ruby (all platforms)
+
+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.
+
+[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

data/Gemfile

@@ -6,6 +6,7 @@ gem 'pry', github: 'pry/pry'
 gem 'pry-byebug'
 gem 'rake', '~> 10.0'
 gem 'rspec', '~> 3.2'
+gem 'zeus'
 
 # YARD
 gem 'yard'

data/Gemfile.lock

@@ -30,23 +30,25 @@ GEM
       yajl-ruby (~> 1.1.0)
     rake (10.4.2)
     redcarpet (3.0.0)
-    rspec (3.3.0)
-      rspec-core (~> 3.3.0)
-      rspec-expectations (~> 3.3.0)
-      rspec-mocks (~> 3.3.0)
-    rspec-core (3.3.2)
-      rspec-support (~> 3.3.0)
-    rspec-expectations (3.3.1)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-mocks (3.3.2)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-support (3.3.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
     slop (3.6.0)
     thor (0.19.1)
     yajl-ruby (1.1.0)
     yard (0.8.7.3)
+    zeus (0.15.4)
+      method_source (>= 0.6.7)
 
 PLATFORMS
   ruby
@@ -62,6 +64,7 @@ DEPENDENCIES
   redcarpet
   rspec (~> 3.2)
   yard
+  zeus
 
 BUNDLED WITH
-   1.10.6
+   1.11.1

data/NEWS.md

@@ -1,3 +1,114 @@
+# 3.1.0
+
+### Bug fixes
+
+* Update `validate_numericality_of` so that submatchers are applied lazily
+  instead of immediately. Previously, qualifiers were order-dependent, meaning
+  that if you used `strict` before you used, say, `odd`, then `strict` wouldn't
+  actually apply to `odd`. Now the order that you specify qualifiers doesn't
+  matter.
+
+  * *Source: [6c67a5e]*
+
+* Fix `allow_value` so that it does not raise an AttributeChangedValueError
+  (formerly CouldNotSetAttributeError) when used against an attribute that is an
+  enum in an ActiveRecord model.
+
+  * *Source: [9e8603e]*
+
+* Add a `ignoring_interference_by_writer` qualifier to all matchers, not just
+  `allow_value`. *This is enabled by default, which means that you should never
+  get a CouldNotSetAttributeError again.* (You may get some more information if
+  a test fails, however.)
+
+  * *Source: [1189934], [5532f43]*
+  * *Fixes: [#786], [#799], [#801], [#804], [#817], [#841], [#849], [#872],
+    [#873], and [#874]*
+
+* Fix `validate_numericality_of` so that it does not blow up when used against
+  a virtual attribute defined in an ActiveRecord model (that is, an attribute
+  that is not present in the database but is defined using `attr_accessor`).
+
+  * *Source: [#822]*
+
+* Update `validate_numericality_of` so that it no longer raises an
+  IneffectiveTestError if used against a numeric column.
+
+  * *Source: [5ed0362]*
+  * *Fixes: [#832]*
+
+[6c67a5e]: https://github.com/thoughtbot/shoulda-matchers/commit/6c67a5eb0df265d3a565aa7d1a7e2b645051eb5a
+[9e8603e]: https://github.com/thoughtbot/shoulda-matchers/commit/9e8603eb745bfa2a5aea6dfef85adf680d447151
+[1189934]: https://github.com/thoughtbot/shoulda-matchers/commit/118993480604d39c73687d069f7af3726f3e3f3e
+[5532f43]: https://github.com/thoughtbot/shoulda-matchers/commit/5532f4359aa332b10de7d46f876eaffd4a95b5b6
+[#786]: https://github.com/thoughtbot/shoulda-matchers/issues/786
+[#799]: https://github.com/thoughtbot/shoulda-matchers/issues/799
+[#801]: https://github.com/thoughtbot/shoulda-matchers/issues/801
+[#804]: https://github.com/thoughtbot/shoulda-matchers/issues/804
+[#817]: https://github.com/thoughtbot/shoulda-matchers/issues/817
+[#841]: https://github.com/thoughtbot/shoulda-matchers/issues/841
+[#849]: https://github.com/thoughtbot/shoulda-matchers/issues/849
+[#872]: https://github.com/thoughtbot/shoulda-matchers/issues/872
+[#873]: https://github.com/thoughtbot/shoulda-matchers/issues/873
+[#874]: https://github.com/thoughtbot/shoulda-matchers/issues/874
+[#822]: https://github.com/thoughtbot/shoulda-matchers/pull/822
+[5ed0362]: https://github.com/thoughtbot/shoulda-matchers/commit/5ed03624197314865ff5463e473e5e84bb91d9ea
+[#832]: https://github.com/thoughtbot/shoulda-matchers/issues/832
+
+### Features
+
+* Add a new qualifier, `ignoring_case_sensitivity`, to `validate_uniqueness_of`.
+  This provides a way to test uniqueness of an attribute whose case is
+  normalized, either in a custom writer method for that attribute, or in a
+  custom `before_validation` callback.
+
+  * *Source: [#840]*
+  * *Fixes: [#836]*
+
+[#840]: https://github.com/thoughtbot/shoulda-matchers/pull/840
+[#836]: https://github.com/thoughtbot/shoulda-matchers/issues/836
+
+### Improvements
+
+* Improve failure messages and descriptions of all matchers across the board so
+  that it is easier to understand what the matcher was doing when it failed.
+  (You'll see a huge difference in the output of the numericality and uniqueness
+  matchers in particular.)
+
+* Matchers now raise an error if any attributes that the matcher is attempting
+  to set do not exist on the model.
+
+  * *Source: [2962112]*
+
+* Update `validate_numericality_of` so that it doesn't always run all of the
+  submatchers, but stops on the first one that fails. Since failure messages
+  now contain information as to what value the matcher set on the attribute when
+  it failed, this change guarantees that the correct value will be shown.
+
+  * *Source: [8e24a6e]*
+
+* Continue to detect if attributes change incoming values, but now instead of
+  immediately seeing a CouldNotSetAttributeError, you will only be informed
+  about it if the test you've written fails.
+
+  * *Source: [1189934]*
+
+* Add an additional check to `define_enum_for` to ensure that the column that
+  underlies the enum attribute you're testing is an integer column.
+
+  * *Source: [68dd70a]*
+
+* Add a test for `validate_numericality_of` so that it officially supports money
+  columns.
+
+  * *Source: [a559713]*
+  * *Refs: [#841]*
+
+[2962112]: https://github.com/thoughtbot/shoulda-matchers/commit/296211211497e624dde87adae68b385ad4cdae3a
+[8e24a6e]: https://github.com/thoughtbot/shoulda-matchers/commit/8e24a6e9b2b147f2c51fb03aa02543f213acab34
+[68dd70a]: https://github.com/thoughtbot/shoulda-matchers/commit/68dd70a23d8997a490683adcd2108a4a5cadf8ba
+[a559713]: https://github.com/thoughtbot/shoulda-matchers/commit/a559713f96303414551c0bc1767fb11eb19bcc5d
+
 # 3.0.1
 
 ### Bug fixes

data/README.md

@@ -97,7 +97,7 @@ complex, and error-prone.
   tests that an object forwards messages to other, internal objects by way of
   delegation.
 
-## Installation
+## Getting started
 
 ### RSpec
 
@@ -120,6 +120,42 @@ describe Person do
 end
 ```
 
+#### Availability of matchers in various example groups
+
+Since shoulda-matchers provides four categories of matchers, there are four
+different levels where you can use these matchers:
+
+* ActiveRecord and ActiveModel matchers are available only in model example
+  groups, i.e., those tagged with `type: :model` or in files located under
+  `spec/models`.
+* ActionController matchers are available only in controller example groups,
+  i.e., those tagged with `type: :controller` or in files located under
+  `spec/controllers`.
+* The `route` matcher is available also in routing example groups, i.e., those
+  tagged with `type: :routing` or in files located under `spec/routing`.
+* Independent matchers are available in all example groups.
+
+**If you are using ActiveModel or ActiveRecord outside of Rails** and you want
+to use model matchers in certain example groups, you'll need to manually include
+them. Here's a good way of doing that:
+
+``` ruby
+RSpec.configure do |config|
+  config.include(Shoulda::Matchers::ActiveModel, type: :model)
+  config.include(Shoulda::Matchers::ActiveRecord, type: :model)
+end
+```
+
+Then you can say:
+
+``` ruby
+describe MyModel, type: :model do
+  # ...
+end
+```
+
+#### `should` vs `is_expected.to`
+
 Note that in this README and throughout the documentation we're using the
 `should` form of RSpec's one-liner syntax over `is_expected.to`. The `should`
 form works regardless of how you've configured RSpec -- meaning you can still
@@ -136,12 +172,15 @@ end
 
 Shoulda Matchers was originally a component of [Shoulda][shoulda], a gem that
 also provides `should` and `context` syntax via
-[`shoulda-context`][shoulda-context]. For this reason you'll want to include this
-gem in your Gemfile instead:
+[`shoulda-context`][shoulda-context].
+
+At the moment, `shoulda` has not been updated to support `shoulda-matchers` 3.0,
+so you'll want to add the following to your Gemfile:
 
 ```ruby
 group :test do
   gem 'shoulda', '~> 3.5'
+  gem 'shoulda-matchers', '~> 2.0'
 end
 ```
 
@@ -164,7 +203,8 @@ Before you can use Shoulda Matchers, you'll need to tell it a couple of things:
 * Which portion of the matchers you want to use
 
 You can supply this information by using a configuration block. Place the
-following in your test or spec helper:
+following in `rails_helper.rb` (if you're using RSpec) or `test_helper.rb` (if
+you're using Minitest):
 
 ``` ruby
 Shoulda::Matchers.configure do |config|
@@ -185,6 +225,52 @@ Shoulda::Matchers.configure do |config|
 end
 ```
 
+## Running tests
+
+### Unit tests
+
+Unit tests are the most common kind of tests in this gem, and the best way to
+run them is by using [Zeus].
+
+You'll want to run `zeus start` in one shell, then in another shell, instead of
+using `rspec` to run tests, you can use `zeus rspec`. So for instance, you might
+say:
+
+```
+zeus rspec spec/unit/shoulda/matchers/active_model/validate_inclusion_of_matcher_spec.rb
+```
+
+As a shortcut, you can also drop the initial part of the path and say this
+instead:
+
+```
+zeus rspec active_model/validate_inclusion_of_matcher_spec.rb
+```
+
+### Acceptance tests
+
+The gem uses [Appraisal] to test against multiple versions of Rails and Ruby.
+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:
+
+```
+rspec spec/acceptance/active_model_integration_spec.rb
+```
+
+Instead, you need to say
+
+```
+bundle exec appraisal 4.2 rspec spec/acceptance/active_model_integration_spec.rb
+```
+
+### All tests
+
+You can run all tests by saying:
+
+```
+bundle exec rake
+```
+
 ## Generating documentation
 
 YARD is used to generate documentation, which can be viewed [online][rubydocs].
@@ -212,7 +298,7 @@ pull request.
 ## Compatibility
 
 Shoulda Matchers is tested and supported against Rails 4.x, RSpec 3.x, Minitest
-5, and Ruby 2.x.
+5, Minitest 4, and Ruby 2.x.
 
 ## Versioning
 
@@ -221,7 +307,7 @@ Shoulda Matchers follows Semantic Versioning 2.0 as defined at
 
 ## License
 
-Shoulda Matchers is copyright © 2006-2015
+Shoulda Matchers is copyright © 2006-2016
 [thoughtbot, inc](https://thoughtbot.com/). It is free software,
 and may be redistributed under the terms specified in the
 [MIT-LICENSE](MIT-LICENSE) file.
@@ -248,3 +334,5 @@ We are [available for hire][hire].
 [contributors]: https://github.com/thoughtbot/shoulda-matchers/contributors
 [shoulda]: http://github.com/thoughtbot/shoulda
 [shoulda-context]: http://github.com/thoughtbot/shoulda-context
+[Zeus]: https://github.com/burke/zeus
+[Appraisal]: https://github.com/thoughtbot/appraisal