-
Notifications
You must be signed in to change notification settings - Fork 404
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: Depreciate toBeInTheDOM with replacement #40
Merged
gnapse
merged 16 commits into
testing-library:master
from
smacpherson64:pr/depreciate-to-be-in-the-dom
Jul 18, 2018
Merged
Changes from 15 commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
ea87915
#34: Added test for toBeInTheDocument
smacpherson64 ff4875e
#34: Added toBeInTheDocument functionality
smacpherson64 ab1a19f
#34: Added deprecate test and functionality
smacpherson64 a9e3eb6
#34: Updated toBeInTheDOM tests to hide console.warn for clarity
smacpherson64 c151c49
#34: Added deprecated notice to toBeInTheDOM
smacpherson64 9eaaaff
#34: Updated types (deprecated notice and toBeInTheDocument)
smacpherson64 d4d230d
#34: Updated documentation
smacpherson64 c4961a5
#34: Simplified deprecate util function
smacpherson64 a30bfaa
#34: Fixed grammar error
smacpherson64 6047eb3
#34: Added document validation
smacpherson64 0018069
#34: Cleaned up tests
smacpherson64 f304c07
#34: Updated test message for consistency
smacpherson64 9af1d22
#34: Added null and undefined tests
smacpherson64 a7e78e5
#34: Updated README.md with better examples and clearer notes
smacpherson64 45740d5
#34: Improved element selector in documentation
smacpherson64 2e7e70a
Merge branch 'master' into pr/depreciate-to-be-in-the-dom
gnapse File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
test('.toBeInTheDocument', () => { | ||
document.body.innerHTML = ` | ||
<span data-testid="html-element"><span>Html Element</span></span> | ||
<svg data-testid="svg-element"></svg>` | ||
|
||
const htmlElement = document.querySelector('[data-testid="html-element"]') | ||
const svgElement = document.querySelector('[data-testid="html-element"]') | ||
const detachedElement = document.createElement('div') | ||
const fakeElement = {thisIsNot: 'an html element'} | ||
const undefinedElement = undefined | ||
const nullElement = null | ||
|
||
expect(htmlElement).toBeInTheDocument() | ||
expect(svgElement).toBeInTheDocument() | ||
expect(detachedElement).not.toBeInTheDocument() | ||
|
||
// negative test cases wrapped in throwError assertions for coverage. | ||
expect(() => expect(htmlElement).not.toBeInTheDocument()).toThrowError() | ||
expect(() => expect(svgElement).not.toBeInTheDocument()).toThrowError() | ||
expect(() => expect(detachedElement).toBeInTheDocument()).toThrowError() | ||
expect(() => expect(fakeElement).toBeInTheDocument()).toThrowError() | ||
expect(() => expect(undefinedElement).toBeInTheDocument()).toThrowError() | ||
expect(() => expect(nullElement).toBeInTheDocument()).toThrowError() | ||
}) |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
import {checkDocumentKey, deprecate} from '../utils' | ||
|
||
function matcherMock() {} | ||
|
||
test('deprecate', () => { | ||
const spy = jest.spyOn(console, 'warn').mockImplementation(() => {}) | ||
const name = 'test' | ||
const replacement = 'test' | ||
const message = `Warning: ${name} has been deprecated and will be removed in future updates.` | ||
|
||
deprecate(name, replacement) | ||
expect(spy).toHaveBeenCalledWith(message, replacement) | ||
|
||
deprecate(name) | ||
expect(spy).toHaveBeenCalledWith(message, undefined) | ||
|
||
spy.mockRestore() | ||
}) | ||
|
||
test('checkDocumentKey', () => { | ||
const fakeKey = 'fakeKey' | ||
const realKey = 'documentElement' | ||
const badKeyMessage = `${fakeKey} is undefined on document but is required to use ${ | ||
matcherMock.name | ||
}.` | ||
|
||
const badDocumentMessage = `document is undefined on global but is required to use ${ | ||
matcherMock.name | ||
}.` | ||
|
||
expect(() => | ||
checkDocumentKey(document, realKey, matcherMock), | ||
).not.toThrowError() | ||
|
||
expect(() => { | ||
checkDocumentKey(document, fakeKey, matcherMock) | ||
}).toThrow(badKeyMessage) | ||
|
||
expect(() => { | ||
//eslint-disable-next-line no-undef | ||
checkDocumentKey(undefined, realKey, matcherMock) | ||
}).toThrow(badDocumentMessage) | ||
}) |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
import {matcherHint, printReceived} from 'jest-matcher-utils' | ||
import {checkHtmlElement, checkDocumentKey} from './utils' | ||
|
||
export function toBeInTheDocument(element) { | ||
checkHtmlElement(element, toBeInTheDocument, this) | ||
checkDocumentKey(global.document, 'documentElement', toBeInTheDocument) | ||
|
||
return { | ||
pass: document.documentElement.contains(element), | ||
message: () => { | ||
return [ | ||
matcherHint( | ||
`${this.isNot ? '.not' : ''}.toBeInTheDocument`, | ||
'element', | ||
'', | ||
), | ||
'', | ||
'Received:', | ||
` ${printReceived( | ||
element.hasChildNodes() ? element.cloneNode(false) : element, | ||
)}`, | ||
].join('\n') | ||
}, | ||
} | ||
} |
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we check whether
document
anddocument.documentElement
exist? I knowjsdom
will have them, but if I accidentally used this matcher in thenode
environment, it would be nice to get a descriptive error message rather than "cannot read property 'documentElement' of undefined".There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hrm, sounds good, agreed on developer experience. It would be nice to get a clear error. Does the following sound good @jgoz?
document is undefined on global but is required for the toBeInTheDocument matcher
.documentElement is undefined on document but is required for the toBeInTheDocument matcher.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 the first message should be good enough for both cases.