[New] shallow: add .dive()
#618
Merged
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
|
LGTM! |
|
(also, I like "dive"!) |
| @@ -207,3 +207,6 @@ Returns whether or not all of the nodes in the wrapper match the provided select | |||
|
|
|||
| #### [`.everyWhere(predicate) => Boolean`](ShallowWrapper/everyWhere.md) | |||
| Returns whether or not all of the nodes in the wrapper pass the provided predicate function. | |||
|
|
|||
| #### [`.dive([options]) => ShallowWrapper`](ShallowWrapper/dive.md) | |||
| Throws unless the wrapper contains only one non-DOM Component child; otherwise, returns a shallow wrapper around it. | |||
There was a problem hiding this comment.
I feel like we are focusing too much on the condition in which it throws. The fact that it throws should just be a note.
The description should be something like "shallow render the one child of the current wrapper, and return a wrapper around the result"
| @@ -0,0 +1,52 @@ | |||
| # `.dive([options]) => ShallowWrapper` | |||
|
|
|||
| Throws unless the wrapper contains only one non-DOM Component child; otherwise, returns a shallow wrapper around it. | |||
lelandrichardson
approved these changes
Oct 1, 2016
aweary
requested changes
Oct 1, 2016
|
@aweary doh! thanks, will add. |
ljharb
force-pushed
the
dive
branch
2 times, most recently
from
d52115b to
3dd8111
Compare
|
@aweary added :-) |
ljharb
force-pushed
the
dive
branch
2 times, most recently
from
15cd707 to
c2414ca
Compare
aweary
approved these changes
Oct 3, 2016
matthieuprat
reviewed
Oct 7, 2016
| const wrapper = shallow(<Foo />); | ||
| expect(wrapper.find('.in-bar')).to.have.length(0); | ||
| expect(wrapper.find(Bar)).to.have.length(1); | ||
| expect(wrapper.dive().find('.in-bar')).to.have.length(1); |
There was a problem hiding this comment.
I suspect this would fail because wrapper wraps a DOM element and by design, dive (currently?) throws in that case.
Don't you mean expect(wrapper.children().dive().find('.in-bar')).to.have.length(1); instead?
There was a problem hiding this comment.
Oops, thanks, I did mean that :-) fixed in e722625
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.
The goal of this method is to make testing of HOCs (higher-order components) easier - withStyles, flux-store-connected components, etc.
Typically, the workarounds are either:
wrapper.find('StringNameOfComponent').shallow(): brittle, because it's using strings (strings are bad); also annoying to type out.wrapper.childAt(0).shallow(): doesn't check if there's more than one child, and is annoying to type out.In addition, if suddenly there's a DOM element in there, you might suddenly start shallow-rendering it without knowing, and your tests might erroneously be passing.
This method allows
wrapper.dive()- ie, it requires there be one non-DOM child, and shallow-renders it for you.If you need multiples, you chain them -
wrapper.dive().dive()- for now we have intentionally omitted the ability to dive multiple levels at once, so that tight coupling to HTML structure is discouraged.Longer term, we have a much better solution in mind for HOCs, but this is still useful in the interim.