Allow codependent Dash attributes to initialize #437
Merged
+37
−2
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
dblock
reviewed
Feb 6, 2018
lib/hashie/dash.rb
Outdated
| def initialize_attributes(attributes, options = {}) | ||
| return unless attributes | ||
|
|
||
| set_nils = options.delete(:set_nils) |
There was a problem hiding this comment.
This modifies the calling hash, so probably not a great idea?
There was a problem hiding this comment.
It's an internal function so it's unused data, but I see your point.
There was a problem hiding this comment.
Since we're purists here, never make assumptions about the caller, things change fast ;)
dblock
reviewed
Feb 6, 2018
lib/hashie/dash.rb
Outdated
| self[att] = value | ||
| end if attributes | ||
| end | ||
| end |
There was a problem hiding this comment.
I think you should break up this function instead in two and kill the option, since it's used very differently in different places.
Definition: Codependent properties
A set of two or more properties who have "required" validations that are based
on each other.
Example:
```ruby
class OneOrMore < Hashie::Dash
property :a, required: -> { b.nil? }
property :b, required: -> { a.nil? }
end
```
When constructing a Dash via the merge initializer, codependent properties have
their "required" validation run too early when their values are set to `nil`,
which causes an `ArgumentError` to be raised in the case that the first property
is set to `nil`.
This is an order-dependence bug that is fixed by this commit. By pruning off
`nil` values only during initialization via the merge initializer, we can
prevent this problem from occurring for the case of `nil` values.
However, this is an indication of a larger problem with the architecture of
Dash. We should be setting all the properties before running the validations.
Rearchitecting this will be quite an undertaking.
michaelherold
force-pushed
the
codependent-properties
branch
from
76e81e0 to
0bd18ee
Compare
|
Refreshed! What do you think? |
|
👏 very very nice solution, naming things really clearly, love it |
netbsd-srcmastr
pushed a commit
to NetBSD/pkgsrc
that referenced
this pull request
Sep 23, 2018
## [3.6.0] - 2018-08-13 [3.6.0]: hashie/hashie@v3.5.7...v3.6.0 ### Added * [#455](hashie/hashie#455): Allow overriding methods when passing in a hash - [@lnestor](https://github.com/lnestor). ### Fixed * [#435](hashie/hashie#435): Mash `default_proc`s are now propagated down to nested sub-Hashes - [@michaelherold](https://github.com/michaelherold). * [#436](hashie/hashie#436): Ensure that `Hashie::Extensions::IndifferentAccess` injects itself after a non-destructive merge - [@michaelherold](https://github.com/michaelherold). * [#437](hashie/hashie#437): Allow codependent properties to be set on Dash - [@michaelherold](https://github.com/michaelherold). * [#438](hashie/hashie#438): Fix: `NameError (uninitialized constant Hashie::Extensions::Parsers::YamlErbParser::Pathname)` in `Hashie::Mash.load` - [@onk](https://github.com/onk). * [#457](hashie/hashie#457): Fix `Trash` to allow it to copy properties from other properties - [@michaelherold](https://github.com/michaelherold). ### Miscellaneous * [#433](hashie/hashie#433): Update Rubocop to the most recent version - [@michaelherold](https://github.com/michaelherold). * [#434](hashie/hashie#434): Add documentation around Mash sub-Hashes - [@michaelherold](https://github.com/michaelherold). * [#439](hashie/hashie#439): Add an integration spec for Elasticsearch - [@michaelherold](https://github.com/michaelherold).
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.
Definition: Codependent properties
A set of two or more properties who have "required" validations that are based
on each other.
Example:
When constructing a Dash via the merge initializer, codependent properties have
their "required" validation run too early when their values are set to
nil,which causes an
ArgumentErrorto be raised in the case that the first propertyis set to
nil.This is an order-dependence bug that is fixed by this commit. By pruning off
nilvalues only during initialization via the merge initializer, we canprevent this problem from occurring for the case of
nilvalues.However, this is an indication of a larger problem with the architecture of
Dash. We should be setting all the properties before running the validations.
Rearchitecting this will be quite an undertaking.
Fixes #431