shoulda-matchers 3.0.0.rc1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8fecf73ca944b0663a84b697138602dee5030c7
-  data.tar.gz: 6daabcb4fb64b55438d4db5d6058cf2911f6cbda
+  metadata.gz: 4d2511e64aa43fb787466f5a74f3988cbd42b3ff
+  data.tar.gz: d8ca90b46025cb37d4acd8111b1686902837257e
 SHA512:
-  metadata.gz: c5d7162d77f4c392caf7c797c1cdbe543fd83a358fea4a63a3a376d1801b8cfb7ea7e20b0576a557bac6e1e6d62b4acfc18f273741ac11fbdf71a0a3429aff5b
-  data.tar.gz: f7fe158ff1ea7bfb57f2914a149d0db943f21f0f1704adb2e17777a3ce9aba62cbbf9c463d763c27d7891c12c8f1e50a176b35ebee7b98c5f27b4a8a5ff49001
+  metadata.gz: 57e1a16493c88afaedc21664cd8725e140b4c5528941de796543a53086644d60c43aa980229bdbed70bd4340e415bf9e66c9825ac3bffdd74d2d8c281933363e
+  data.tar.gz: 7e8e7a91c8073833e9f1ee756201eebea1e67037c141d2d4602be1656407e192fea3c254177f8c05072625235c24d8d9f171d14bd1d4a5b9e7b6d086634e023e

data/Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'appraisal', '~> 1.0'
+gem 'appraisal', '~> 2.0'
 gem 'bundler', '~> 1.1'
 gem 'pry', github: 'pry/pry'
 gem 'pry-byebug'
@@ -12,5 +12,4 @@ gem 'rspec-expectations', '>= 3.2.0', '< 4'
 gem 'yard'
 gem 'redcarpet'
 gem 'pygments.rb'
-gem 'guard'
-gem 'guard-yard'
+gem 'fssm'

data/Gemfile.lock

@@ -10,42 +10,17 @@ GIT
 GEM
   remote: https://rubygems.org/
   specs:
-    appraisal (1.0.2)
+    appraisal (2.1.0)
       bundler
       rake
       thor (>= 0.14.0)
     byebug (4.0.4)
       columnize (= 0.9.0)
-    celluloid (0.16.0)
-      timers (~> 4.0.0)
     coderay (1.1.0)
     columnize (0.9.0)
     diff-lcs (1.2.5)
-    ffi (1.9.8)
-    formatador (0.2.5)
-    guard (2.12.5)
-      formatador (>= 0.2.4)
-      listen (~> 2.7)
-      lumberjack (~> 1.0)
-      nenv (~> 0.1)
-      notiffany (~> 0.0)
-      pry (>= 0.9.12)
-      shellany (~> 0.0)
-      thor (>= 0.18.1)
-    guard-yard (2.1.4)
-      guard (>= 1.1.0)
-      yard (>= 0.7.0)
-    hitimes (1.2.2)
-    listen (2.10.0)
-      celluloid (~> 0.16.0)
-      rb-fsevent (>= 0.9.3)
-      rb-inotify (>= 0.9)
-    lumberjack (1.0.9)
+    fssm (0.2.10)
     method_source (0.8.2)
-    nenv (0.2.0)
-    notiffany (0.0.6)
-      nenv (~> 0.1)
-      shellany (~> 0.0)
     posix-spawn (0.3.8)
     pry-byebug (3.1.0)
       byebug (~> 4.0)
@@ -54,21 +29,15 @@ GEM
       posix-spawn (~> 0.3.6)
       yajl-ruby (~> 1.1.0)
     rake (10.4.2)
-    rb-fsevent (0.9.4)
-    rb-inotify (0.9.5)
-      ffi (>= 0.5.0)
     redcarpet (3.0.0)
-    rspec-core (3.2.0)
-      rspec-support (~> 3.2.0)
-    rspec-expectations (3.2.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-support (3.2.1)
-    shellany (0.0.1)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
     slop (3.6.0)
     thor (0.19.1)
-    timers (4.0.1)
-      hitimes
     yajl-ruby (1.1.0)
     yard (0.8.7.3)
 
@@ -76,10 +45,9 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  appraisal (~> 1.0)
+  appraisal (~> 2.0)
   bundler (~> 1.1)
-  guard
-  guard-yard
+  fssm
   pry!
   pry-byebug
   pygments.rb
@@ -88,3 +56,6 @@ DEPENDENCIES
   rspec-core (>= 3.2.0, < 4)
   rspec-expectations (>= 3.2.0, < 4)
   yard
+
+BUNDLED WITH
+   1.10.6

data/NEWS.md

@@ -1,12 +1,9 @@
-# HEAD
+# 3.0.0
 
 ### Backward-incompatible changes
 
 * We've dropped support for Rails 3.x, Ruby 1.9.2, and Ruby 1.9.3, and RSpec 2.
-  All of these things have been end-of-lifed. This doesn't mean that the gem
-  will stop working immediately, but we won't accept any pull requests to fix
-  any compatibility issues, so you're encouraged to upgrade.
-  ([a4045a1], [b7fe87a])
+  All of these have been end-of-lifed. ([a4045a1], [b7fe87a], [32c0e62])
 
 * The gem no longer detects the test framework you're using or mixes itself into
   that framework automatically. [History][no-auto-integration-1] has
@@ -41,26 +38,117 @@
 
   ([1900071])
 
+* Previously, under RSpec, all of the matchers were mixed into all of the
+  example groups. This created a problem because some gems, such as
+  [active_model_serializers-matchers], provide matchers that share the same
+  name as some of our own matchers. Now, matchers are only mixed into whichever
+  example group they belong to:
+
+    * ActiveModel and ActiveRecord matchers are available only in model example
+      groups.
+    * ActionController matchers are available only in controller example groups.
+    * The `route` matcher is available only in routing example groups.
+
+  ([af98a23], [8cf449b])
+
 * There are two changes to `allow_value`:
 
-  * The negative form of the matcher has been changed so that instead of
+  * The negative form of `allow_value` has been changed so that instead of
     asserting that any of the given values is an invalid value (allowing good
     values to pass through), assert that *all* values are invalid values
     (allowing good values not to pass through). This means that this test which
     formerly passed will now fail:
 
-        expect(record).not_to allow_value('good value', *bad_values)
+    ``` ruby
+    expect(record).not_to allow_value('good value', *bad_values)
+    ```
 
     ([19ce8a6])
 
-  * The matcher may raise an error if the attribute in question contains
-    custom logic to ignore certain values, resulting in a discrepancy between
-    the value you provide and the value that the attribute is actually set to.
-    Specifically, if the attribute cannot be changed from a non-nil value to a
-    nil value, or vice versa, then you'll get a CouldNotSetAttributeError. The
-    current behavior (which is to permit this) is misleading, as the test that
-    you're writing under the hood by using `allow_value` could be different from
-    the test that actually ends up getting run. ([eaaa2d8])
+  * `allow_value` now raises a CouldNotSetAttributeError if in setting the
+    attribute, the value of the attribute from reading the attribute back is
+    different from the one used to set it.
+
+    This would happen if the writer method for that attribute has custom logic
+    to ignore certain incoming values or change them in any way. Here are three
+    examples we've seen:
+
+    * You're attempting to assert that an attribute should not allow nil, yet
+      the attribute's writer method contains a conditional to do nothing if
+      the attribute is set to nil:
+
+      ``` ruby
+      class Foo
+        include ActiveModel::Model
+
+        attr_reader :bar
+
+        def bar=(value)
+          return if value.nil?
+          @bar = value
+        end
+      end
+
+      describe Foo do
+        it do
+          foo = Foo.new
+          foo.bar = "baz"
+          # This will raise a CouldNotSetAttributeError since `foo.bar` is now "123"
+          expect(foo).not_to allow_value(nil).for(:bar)
+        end
+      end
+      ```
+
+    * You're attempting to assert that an numeric attribute should not allow a
+      string that contains non-numeric characters, yet the writer method for
+      that attribute strips out non-numeric characters:
+
+      ``` ruby
+      class Foo
+        include ActiveModel::Model
+
+        attr_reader :bar
+
+        def bar=(value)
+          @bar = value.gsub(/\D+/, '')
+        end
+      end
+
+      describe Foo do
+        it do
+          foo = Foo.new
+          # This will raise a CouldNotSetAttributeError since `foo.bar` is now "123"
+          expect(foo).not_to allow_value("abc123").for(:bar)
+        end
+      end
+      ```
+
+    * You're passing a value to `allow_value` that the model typecasts into
+      another value:
+
+      ``` ruby
+      describe Foo do
+        # Assume that `attr` is a string
+        # This will raise a CouldNotSetAttributeError since `attr` typecasts `[]` to `"[]"`
+        it { should_not allow_value([]).for(:attr) }
+      end
+      ```
+
+    With all of these failing examples, why are we making this change? We want
+    to guard you (as the developer) from writing a test that you think acts one
+    way but actually acts a different way, as this could lead to a confusing
+    false positive or negative.
+
+    If you understand the problem and wish to override this behavior so that
+    you do not get a CouldNotSetAttributeError, you can add the
+    `ignoring_interference_by_writer` qualifier like so. Note that this will not
+    always cause the test to pass.
+
+    ``` ruby
+    it { should_not allow_value([]).for(:attr).ignoring_interference_by_writer }
+    ```
+
+    ([9d9dc4e])
 
 * `validate_uniqueness_of` is now properly case-insensitive by default, to match
   the default behavior of the validation itself. This is a backward-incompatible
@@ -89,6 +177,11 @@
   * `set_session['key'].to(nil)` will no longer pass when the key in question
     has not been set yet. ([535fe05])
 
+* Change `set_flash` so that `set_flash[:foo].now` is no longer valid syntax.
+  You'll want to use `set_flash.now[:foo]` instead. This was changed in order to
+  more closely align with how `flash.now` works when used in a controller.
+  ([#755], [#752])
+
 * Change behavior of `validate_uniqueness_of` when the matcher is not
   qualified with any scopes, but your validation is. Previously the following
   test would pass when it now fails:
@@ -105,6 +198,7 @@
 
   ([6ac7b81])
 
+[active_model_serializers-matchers]: https://github.com/adambarber/active_model_serializers-matchers
 [no-auto-integration-1]: https://github.com/freerange/mocha/commit/049080c673ee3f76e76adc1e1a6122c7869f1648
 [no-auto-integration-2]: https://github.com/rr/rr/issues/29
 [1900071]: https://github.com/thoughtbot/shoulda-matchers/commit/190007155e0676aae84d08d8ed8eed3beebc3a06
@@ -116,8 +210,11 @@
 [55c8d09]: https://github.com/thoughtbot/shoulda-matchers/commit/55c8d09bf2af886540924efa83c3b518d926a770
 [801f2c7]: https://github.com/thoughtbot/shoulda-matchers/commit/801f2c7c1eab3b2053244485c9800f850959cfef
 [535fe05]: https://github.com/thoughtbot/shoulda-matchers/commit/535fe05be8686fdafd8b22f2ed5c4192bd565d50
-[eaaa2d8]: https://github.com/thoughtbot/shoulda-matchers/commit/eaaa2d83e5cd31a3ca0a1aaa65441ea1a4fffa49
 [6ac7b81]: https://github.com/thoughtbot/shoulda-matchers/commit/6ac7b8158cfba3b518eb3da3c24345e4473b416f
+[#755]: https://github.com/thoughtbot/shoulda-matchers/pull/755
+[#752]: https://github.com/thoughtbot/shoulda-matchers/pull/752
+[9d9dc4e]: https://github.com/thoughtbot/shoulda-matchers/commit/9d9dc4e6b9cf2c19df66a1b4ba432ad8d3e5dded
+[32c0e62]: https://github.com/thoughtbot/shoulda-matchers/commit/32c0e62596b87e37a301f87bbe21cfcc77750552
 
 ### Bug fixes
 
@@ -157,6 +254,9 @@
 * Fix failure message for `validate_numericality_of` as it sometimes didn't
   provide the reason for failure. ([#699])
 
+* Fix `shoulda/matchers/independent` so that it can be required
+  independently, without having to require all of the gem. ([#746], [e0a0200])
+
 ### Features
 
 * Add `on` qualifier to `permit`. This allows you to make an assertion that
@@ -200,6 +300,8 @@
 [#694]: https://github.com/thoughtbot/shoulda-matchers/pull/694
 [#692]: https://github.com/thoughtbot/shoulda-matchers/pull/692
 [#699]: https://github.com/thoughtbot/shoulda-matchers/pull/699
+[#746]: https://github.com/thoughtbot/shoulda-matchers/pull/746
+[e0a0200]: https://github.com/thoughtbot/shoulda-matchers/commit/e0a0200fe47157c161fb206043540804bdad664e
 
 # 2.8.0
 
@@ -252,13 +354,6 @@
   notation (e.g. `posts#show`), route parameters such as `id` do not need to be
   specified as a string but may be specified as a number as well. ([#602])
 
-* Fix `allow_value`, `validate_numericality_of` and `validate_inclusion_of` so
-  that they handle RangeErrors emitted from ActiveRecord 4.2. These exceptions
-  arise whenever we attempt to set an attribute using a value that lies outside
-  the range of the column (assuming the column is an integer). RangeError is now
-  treated specially, failing the test instead of bubbling up as an error.
-  ([#634], [#637], [#642])
-
 ### Features
 
 * Add ability to test `:primary_key` option on associations. ([#597])
@@ -304,9 +399,6 @@
 [#622]: https://github.com/thoughtbot/shoulda-matchers/pull/622
 [#627]: https://github.com/thoughtbot/shoulda-matchers/pull/627
 [#631]: https://github.com/thoughtbot/shoulda-matchers/pull/631
-[#634]: https://github.com/thoughtbot/shoulda-matchers/pull/634
-[#637]: https://github.com/thoughtbot/shoulda-matchers/pull/637
-[#642]: https://github.com/thoughtbot/shoulda-matchers/pull/642
 
 # 2.7.0
 

data/README.md

@@ -16,9 +16,14 @@ interested in the README for 2.8.0 instead.][2.8.0-README]**
 * **[allow_mass_assignment_of](lib/shoulda/matchers/active_model/allow_mass_assignment_of_matcher.rb)**
   tests usage of Rails 3's `attr_accessible` and `attr_protected` macros.
 * **[allow_value](lib/shoulda/matchers/active_model/allow_value_matcher.rb)**
-  tests usage of the `validates_format_of` validation.
+  tests that an attribute is valid or invalid if set to one or more values.
+  *(Aliased as #allow_values.)*
 * **[have_secure_password](lib/shoulda/matchers/active_model/have_secure_password_matcher.rb)**
   tests usage of `has_secure_password`.
+* **[validate_absence_of](lib/shoulda/matchers/active_model/validate_absence_of_matcher.rb)**
+  tests usage of `validates_absence_of`.
+* **[validate_acceptance_of](lib/shoulda/matchers/active_model/validate_acceptance_of_matcher.rb)**
+  tests usage of `validates_acceptance_of`.
 * **[validate_confirmation_of](lib/shoulda/matchers/active_model/validate_confirmation_of_matcher.rb)**
   tests usage of `validates_confirmation_of`.
 * **[validate_exclusion_of](lib/shoulda/matchers/active_model/validate_exclusion_of_matcher.rb)**
@@ -80,14 +85,14 @@ interested in the README for 2.8.0 instead.][2.8.0-README]**
 * **[set_flash](lib/shoulda/matchers/action_controller/set_flash_matcher.rb)**
   makes assertions on the `flash` hash.
 * **[use_after_action](lib/shoulda/matchers/action_controller/callback_matcher.rb#L79)**
-  tests that a `after_action` callback is defined in your controller. (Aliased
-  as *use_after_filter*.)
+  tests that an `after_action` callback is defined in your controller. *(Aliased
+  as #use_after_filter.)*
 * **[use_around_action](lib/shoulda/matchers/action_controller/callback_matcher.rb#L129)**
-  tests that a `around_action` callback is defined in your controller. (Aliased
-  as *use_around_filter*.)
+  tests that an `around_action` callback is defined in your controller. *(Aliased
+  as #use_around_filter.)*
 * **[use_before_action](lib/shoulda/matchers/action_controller/callback_matcher.rb#L54)**
-  tests that a `before_action` callback is defined in your controller. (Aliased
-  as *use_before_filter*.)
+  tests that a `before_action` callback is defined in your controller. *(Aliased
+  as #use_before_filter.)*
 
 ### Independent matchers
 
@@ -118,7 +123,19 @@ describe Person do
 end
 ```
 
-### Minitest / Test::Unit
+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
+use it even when using the `expect` syntax. But if you prefer to use
+`is_expected.to`, you can do that too:
+
+``` ruby
+describe Person do
+  it { is_expected.to validate_presence_of(:name) }
+end
+```
+
+### Minitest
 
 Shoulda Matchers was originally a component of [Shoulda][shoulda], a gem that
 also provides `should` and `context` syntax via
@@ -184,10 +201,11 @@ You can preview changes you make to the documentation locally by running
 
 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:
+If you want to be able to regenerate the docs as you work without having to run
+`yard doc` over and over again, keep this command running in a separate terminal
+session:
 
-    bundle exec guard
+    rake docs:autogenerate
 
 ## Contributing
 
@@ -198,6 +216,11 @@ If you'd like to contribute, please take a look at the
 [instructions](CONTRIBUTING.md) for installing dependencies and crafting a good
 pull request.
 
+## Compatibility
+
+Shoulda Matchers is tested and supported against Rails 4.x, RSpec 3.x, Minitest
+5, and Ruby 2.x.
+
 ## Versioning
 
 Shoulda Matchers follows Semantic Versioning 2.0 as defined at

data/doc_config/yard/templates/default/fulldoc/html/css/style.css

@@ -214,6 +214,10 @@ h4 + h5 {
 }
 
 .method_details {}
+  .method_details .signature .aliases {
+    display: none;
+  }
+
   .method_details td {
     padding: 10px;
   }

data/gemfiles/4.0.0.gemfile

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "appraisal", "~> 1.0"
+gem "appraisal", "~> 2.0"
 gem "bundler", "~> 1.1"
 gem "pry", :github => "pry/pry"
 gem "pry-byebug"
@@ -12,8 +12,7 @@ gem "rspec-expectations", ">= 3.2.0", "< 4"
 gem "yard"
 gem "redcarpet"
 gem "pygments.rb"
-gem "guard"
-gem "guard-yard"
+gem "fssm"
 gem "rspec-rails", ">= 3.2.0", "< 4"
 gem "shoulda-context", "~> 1.2.0"
 gem "sqlite3", :platform => :ruby