Improve failure message when has_many is missing
#588
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When test driving, writing an expectation such as
```ruby
it { should have_many(:children).through(:relationships).source(:child) }
```
used to provide the not-so-helpful error message
```
Failure/Error: it { should have_many(:children).through(:relationships).source(:child) }
NoMethodError:
undefined method `options' for nil:NilClass
```
The improved error message is
```
Expected Parent to have a has_many association called children (no association
called children, children does not have any relationship to relationships,
children should have child as source option)
```
| @@ -325,6 +325,18 @@ def belonging_to_non_existent_class(model_name, assoc_name, options = {}) | |||
| expect(matcher.failure_message).to match(/through relationships, but got it through conceptions/) | |||
| end | |||
|
|
|||
| it 'rejects an association that is chained by a missing :through option' do | |||
There was a problem hiding this comment.
It seems to me that it's not so much that the :through is missing from the association, it's that the association doesn't exist.
A check for this should be taken care of by this line: https://github.com/thoughtbot/shoulda-matchers/blob/master/lib/shoulda/matchers/active_record/association_matcher.rb#L845. So by the time we get to this point, the reflection should exist. I wonder why that isn't happening...
There was a problem hiding this comment.
Is this is an accurate reflection of the test you were writing? Can I see the backtrace?
There was a problem hiding this comment.
Failures:
1) Shoulda::Matchers::ActiveRecord::AssociationMatcher have_many rejects an association that is chained by a missing :through option
Failure/Error: expect(matcher.failure_message).to match(
NoMethodError:
undefined method `options' for nil:NilClass
# ./lib/shoulda/matchers/active_record/association_matchers/option_verifier.rb:39:in `actual_value_for'
# ./lib/shoulda/matchers/active_record/association_matchers/option_verifier.rb:54:in `correct_for?'
# ./lib/shoulda/matchers/active_record/association_matchers/option_verifier.rb:16:in `correct_for_string?'
# ./lib/shoulda/matchers/active_record/association_matchers/source_matcher.rb:22:in `matches?'
# ./lib/shoulda/matchers/active_record/association_matcher.rb:898:in `block in failing_submatchers'
# ./lib/shoulda/matchers/active_record/association_matcher.rb:897:in `reject'
# ./lib/shoulda/matchers/active_record/association_matcher.rb:897:in `failing_submatchers'
# ./lib/shoulda/matchers/active_record/association_matcher.rb:892:in `missing_options'
# ./lib/shoulda/matchers/active_record/association_matcher.rb:834:in `failure_message'
# ./spec/shoulda/matchers/active_record/association_matcher_spec.rb:335:in `block (3 levels) in <top (required)>'
|
Merged in aa97369, with some slight tweaks. Thanks! |
jsonn
pushed a commit
to jsonn/pkgsrc
that referenced
this pull request
Jun 12, 2015
pkgsrc change: allow build on Ruby 2.2.
# 2.8.0
### Deprecations
* `ensure_length_of` has been renamed to `validate_length_of`.
`ensure_length_of` is deprecated and will be removed in 3.0.0.
* `set_the_flash` has been renamed to `set_flash`. `set_the_flash` is
deprecated and will be removed in 3.0.0.
* `set_session(:foo)` is deprecated in favor of `set_session[:foo]`.
`set_session(:foo)` will be invalid syntax in 3.0.0.
* Using `should set_session[:key].to(nil)` to assert that that a value has not
been set is deprecated. Please use `should_not set_session[:key]` instead.
In 3.0.0, `should set_session[:key].to(nil)` will only pass if the value is
truly nil.
### Bug fixes
* Fix `delegate_method` so that it works again with shoulda-context. ([#591])
* Fix `validate_uniqueness_of` when used with `scoped_to` so that when one of
the scope attributes is a polymorphic `*_type` attribute and the model has
another validation on the same attribute, the matcher does not fail with an
error. ([#592])
* Fix `has_many` used with `through` so that when the association does not
exist, and the matcher fails, it does not raise an error when producing the
failure message. ([#588])
* Fix `have_and_belong_to_many` used with `join_table` so that it does not fail
when `foreign_key` and/or `association_foreign_key` was specified on the
association as a symbol instead of a string. ([#584])
* Fix `allow_value` when an i18n translation key is passed to `with_message` and
the `:against` option is used to specify an alternate attribute. A bug here
also happened to affect `validate_confirmation_of` when an i18n translation
key is passed to `with_message`. ([#593])
* Fix `class_name` qualifier for association matchers so that if the model being
referenced is namespaced, the matcher will correctly resolve the class before
checking it against the association's `class_name`. ([#537])
* Fix `validate_inclusion_of` used with `with_message` so that it fails if given
a message that does not match the message on the validation. ([#598])
* Fix `route` matcher so that when controller and action are specified in hash
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])
* Add `allow_blank` qualifier to `validate_uniqueness_of` to complement
the `allow_blank` option. ([#543])
* Change `set_session` so that #[] and #to qualifiers are optional, similar to
`set_flash`. That is, you can now say `should set_session` to assert that any
flash value has been set, or `should set_session.to('value')` to assert that
any value in the session is 'value'.
* Change `set_session` so that its #to qualifier supports regexps, similar to
`set_flash`.
* Add `with_prefix` qualifier to `delegate_method` to correspond to the `prefix`
option for Rails's `delegate` macro. ([#622])
* Add support for Rails 4.2, especially fixing `serialize` matcher to remove
warning about `serialized_attributes` being deprecated. ([#627])
* Update `dependent` qualifier on association matchers to support `:destroy`,
`:delete`, `:nullify`, `:restrict`, `:restrict_with_exception`, and
`:restrict_with_error`. You can also pass `true` or `false` to assert that
the association has (or has not) been declared with *any* dependent option.
([#631])
### Improvements
* Tweak `allow_value` failure message so that it reads a bit nicer when listing
existing errors.
[#591]: thoughtbot/shoulda-matchers#591
[#592]: thoughtbot/shoulda-matchers#592
[#588]: thoughtbot/shoulda-matchers#588
[#584]: thoughtbot/shoulda-matchers#584
[#593]: thoughtbot/shoulda-matchers#593
[#597]: thoughtbot/shoulda-matchers#597
[#537]: thoughtbot/shoulda-matchers#537
[#598]: thoughtbot/shoulda-matchers#598
[#602]: thoughtbot/shoulda-matchers#602
[#543]: thoughtbot/shoulda-matchers#543
[#622]: thoughtbot/shoulda-matchers#622
[#627]: thoughtbot/shoulda-matchers#627
[#631]: thoughtbot/shoulda-matchers#631
[#634]: thoughtbot/shoulda-matchers#634
[#637]: thoughtbot/shoulda-matchers#637
[#642]: thoughtbot/shoulda-matchers#642
# 2.7.0
### Deprecations
* `ensure_inclusion_of` has been renamed to `validate_inclusion_of`.
`ensure_inclusion_of` is deprecated and will be removed in 3.0.0.
* `ensure_exclusion_of` has been renamed to `validate_exclusion_of`.
`ensure_exclusion_of` is deprecated and will be removed in 3.0.0.
### Bug fixes
* Fix `delegate_method` so that it does not raise an error if the method that
returns the delegate object is private.
* Warn when `ensure_inclusion_of` is chained with `.in_array([false, true])`
as well as with `.in_array([true, false])`.
* Fix `set_session` so that the `to` qualifier if given nil checks that the
session variable in question was set to nil (previously this actually did
nothing).
* Fix `filter_param` so that it works when `config.filter_parameters` contains
regexes.
* Fix `delegate_method` so that it can be required independent of Active
Support.
* Fix `validate_uniqueness_of`. When used against an unpersisted record whose
model contained a non-nullable column other than the one being validated, the
matcher would break. Even if the test set that column to a value beforehand,
the record had to be persisted in order for the matcher to work. Now this is
no longer the case and the record can remain unpersisted.
* Fix `validate_absence_of`: it required that a string be passed as the
attribute name rather than a symbol (which is the usual and documented usage).
### Improvements
* `have_and_belongs_to_many` now checks to make sure that the join table
contains the correct columns for the left- and right-hand side of the
association.
* Reword failure message for `delegate_method` so that it's a little more
helpful.
### Features
* Add new matcher `define_enum_for` to test usage of the `enum` macro introduced
in Rails 4.1.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When test driving, writing an expectation such as
used to provide the not-so-helpful error message
The improved error message is