Skip to content
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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: do not explicitly depend on jest assertion utils #250

Merged
merged 3 commits into from Aug 22, 2020
Merged

fix: do not explicitly depend on jest assertion utils #250

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6ddbe80
feat: do not explicitly depend on jest assertion utils
SimenB May 13, 2020
21b4c6f
Merge branch 'master' into use-assertion-utils
gnapse Aug 13, 2020
64fff15
migrate to new rules
SimenB Aug 22, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 0 additions & 2 deletions package.json
View file
Open in desktop
Expand Up @@ -37,8 +37,6 @@
"chalk": "^3.0.0",
"css": "^3.0.0",
"css.escape": "^1.5.1",
"jest-diff": "^25.1.0",
"jest-matcher-utils": "^25.1.0",
"lodash": "^4.17.15",
"redent": "^3.0.0"
},
Expand Down
26 changes: 19 additions & 7 deletions src/__tests__/utils.js
View file
Open in desktop
Expand Up @@ -22,10 +22,22 @@ test('deprecate', () => {
})

describe('checkHtmlElement', () => {
let assertionContext
beforeAll(() => {
expect.extend({
fakeMatcher() {
assertionContext = this

return {pass: true}
},
})

expect(true).fakeMatcher(true)
})
it('does not throw an error for correct html element', () => {
expect(() => {
const element = document.createElement('p')
checkHtmlElement(element, () => {}, {})
checkHtmlElement(element, () => {}, assertionContext)
}).not.toThrow()
})

Expand All @@ -35,25 +47,25 @@ describe('checkHtmlElement', () => {
'http://www.w3.org/2000/svg',
'rect',
)
checkHtmlElement(element, () => {}, {})
checkHtmlElement(element, () => {}, assertionContext)
}).not.toThrow()
})

it('does not throw for body', () => {
expect(() => {
checkHtmlElement(document.body, () => {}, {})
checkHtmlElement(document.body, () => {}, assertionContext)
}).not.toThrow()
})

it('throws for undefined', () => {
expect(() => {
checkHtmlElement(undefined, () => {}, {})
checkHtmlElement(undefined, () => {}, assertionContext)
}).toThrow(HtmlElementTypeError)
})

it('throws for document', () => {
expect(() => {
checkHtmlElement(document, () => {}, {})
checkHtmlElement(document, () => {}, assertionContext)
}).toThrow(HtmlElementTypeError)
})

Expand All @@ -62,7 +74,7 @@ describe('checkHtmlElement', () => {
checkHtmlElement(
() => {},
() => {},
{},
assertionContext,
)
}).toThrow(HtmlElementTypeError)
})
Expand All @@ -77,7 +89,7 @@ describe('checkHtmlElement', () => {
},
},
() => {},
{},
assertionContext,
)
}).toThrow(HtmlElementTypeError)
})
Expand Down
9 changes: 6 additions & 3 deletions src/to-be-checked.js
View file
Open in desktop
@@ -1,5 +1,4 @@
import {roles} from 'aria-query'
import {matcherHint, printReceived} from 'jest-matcher-utils'
import {checkHtmlElement, toSentence} from './utils'

export function toBeChecked(element) {
Expand Down Expand Up @@ -37,10 +36,14 @@ export function toBeChecked(element) {
message: () => {
const is = isChecked() ? 'is' : 'is not'
return [
matcherHint(`${this.isNot ? '.not' : ''}.toBeChecked`, 'element', ''),
this.utils.matcherHint(
`${this.isNot ? '.not' : ''}.toBeChecked`,
'element',
'',
),
'',
`Received element ${is} checked:`,
` ${printReceived(element.cloneNode(false))}`,
` ${this.utils.printReceived(element.cloneNode(false))}`,
].join('\n')
},
}
Expand Down
17 changes: 12 additions & 5 deletions src/to-be-disabled.js
View file
Open in desktop
@@ -1,4 +1,3 @@
import {matcherHint, printReceived} from 'jest-matcher-utils'
import {checkHtmlElement, getTag} from './utils'

// form elements that support 'disabled'
Expand Down Expand Up @@ -70,10 +69,14 @@ export function toBeDisabled(element) {
message: () => {
const is = isDisabled ? 'is' : 'is not'
return [
matcherHint(`${this.isNot ? '.not' : ''}.toBeDisabled`, 'element', ''),
this.utils.matcherHint(
`${this.isNot ? '.not' : ''}.toBeDisabled`,
'element',
'',
),
'',
`Received element ${is} disabled:`,
` ${printReceived(element.cloneNode(false))}`,
` ${this.utils.printReceived(element.cloneNode(false))}`,
].join('\n')
},
}
Expand All @@ -89,10 +92,14 @@ export function toBeEnabled(element) {
message: () => {
const is = isEnabled ? 'is' : 'is not'
return [
matcherHint(`${this.isNot ? '.not' : ''}.toBeEnabled`, 'element', ''),
this.utils.matcherHint(
`${this.isNot ? '.not' : ''}.toBeEnabled`,
'element',
'',
),
'',
`Received element ${is} enabled:`,
` ${printReceived(element.cloneNode(false))}`,
` ${this.utils.printReceived(element.cloneNode(false))}`,
].join('\n')
},
}
Expand Down
5 changes: 2 additions & 3 deletions src/to-be-empty-dom-element.js
View file
Open in desktop
@@ -1,4 +1,3 @@
import {matcherHint, printReceived} from 'jest-matcher-utils'
import {checkHtmlElement} from './utils'

export function toBeEmptyDOMElement(element) {
Expand All @@ -8,14 +7,14 @@ export function toBeEmptyDOMElement(element) {
pass: element.innerHTML === '',
message: () => {
return [
matcherHint(
this.utils.matcherHint(
`${this.isNot ? '.not' : ''}.toBeEmptyDOMElement`,
'element',
'',
),
'',
'Received:',
` ${printReceived(element.innerHTML)}`,
` ${this.utils.printReceived(element.innerHTML)}`,
].join('\n')
},
}
Expand Down
9 changes: 6 additions & 3 deletions src/to-be-empty.js
View file
Open in desktop
@@ -1,4 +1,3 @@
import {matcherHint, printReceived} from 'jest-matcher-utils'
import {checkHtmlElement, deprecate} from './utils'

export function toBeEmpty(element) {
Expand All @@ -12,10 +11,14 @@ export function toBeEmpty(element) {
pass: element.innerHTML === '',
message: () => {
return [
matcherHint(`${this.isNot ? '.not' : ''}.toBeEmpty`, 'element', ''),
this.utils.matcherHint(
`${this.isNot ? '.not' : ''}.toBeEmpty`,
'element',
'',
),
'',
'Received:',
` ${printReceived(element.innerHTML)}`,
` ${this.utils.printReceived(element.innerHTML)}`,
].join('\n')
},
}
Expand Down
12 changes: 4 additions & 8 deletions src/to-be-in-the-document.js
View file
Open in desktop
@@ -1,8 +1,3 @@
import {
matcherHint,
stringify,
RECEIVED_COLOR as receivedColor,
} from 'jest-matcher-utils'
import {checkHtmlElement} from './utils'

export function toBeInTheDocument(element) {
Expand All @@ -14,7 +9,7 @@ export function toBeInTheDocument(element) {
element === null ? false : element.ownerDocument.contains(element)

const errorFound = () => {
return `expected document not to contain element, found ${stringify(
return `expected document not to contain element, found ${this.utils.stringify(
element.cloneNode(true),
)} instead`
}
Expand All @@ -26,13 +21,14 @@ export function toBeInTheDocument(element) {
pass,
message: () => {
return [
matcherHint(
this.utils.matcherHint(
`${this.isNot ? '.not' : ''}.toBeInTheDocument`,
'element',
'',
),
'',
receivedColor(this.isNot ? errorFound() : errorNotFound()),
// eslint-disable-next-line babel/new-cap
this.utils.RECEIVED_COLOR(this.isNot ? errorFound() : errorNotFound()),
].join('\n')
},
}
Expand Down
11 changes: 8 additions & 3 deletions src/to-be-in-the-dom.js
View file
Open in desktop
@@ -1,4 +1,3 @@
import {matcherHint, printReceived} from 'jest-matcher-utils'
import {checkHtmlElement, deprecate} from './utils'

export function toBeInTheDOM(element, container) {
Expand All @@ -19,10 +18,16 @@ export function toBeInTheDOM(element, container) {
pass: container ? container.contains(element) : !!element,
message: () => {
return [
matcherHint(`${this.isNot ? '.not' : ''}.toBeInTheDOM`, 'element', ''),
this.utils.matcherHint(
`${this.isNot ? '.not' : ''}.toBeInTheDOM`,
'element',
'',
),
'',
'Received:',
` ${printReceived(element ? element.cloneNode(false) : element)}`,
` ${this.utils.printReceived(
element ? element.cloneNode(false) : element,
)}`,
].join('\n')
},
}
Expand Down
17 changes: 12 additions & 5 deletions src/to-be-invalid.js
View file
Open in desktop
@@ -1,4 +1,3 @@
import {matcherHint, printReceived} from 'jest-matcher-utils'
import {checkHtmlElement, getTag} from './utils'

const FORM_TAGS = ['form', 'input', 'select', 'textarea']
Expand Down Expand Up @@ -33,10 +32,14 @@ export function toBeInvalid(element) {
message: () => {
const is = isInvalid ? 'is' : 'is not'
return [
matcherHint(`${this.isNot ? '.not' : ''}.toBeInvalid`, 'element', ''),
this.utils.matcherHint(
`${this.isNot ? '.not' : ''}.toBeInvalid`,
'element',
'',
),
'',
`Received element ${is} currently invalid:`,
` ${printReceived(element.cloneNode(false))}`,
` ${this.utils.printReceived(element.cloneNode(false))}`,
].join('\n')
},
}
Expand All @@ -52,10 +55,14 @@ export function toBeValid(element) {
message: () => {
const is = isValid ? 'is' : 'is not'
return [
matcherHint(`${this.isNot ? '.not' : ''}.toBeValid`, 'element', ''),
this.utils.matcherHint(
`${this.isNot ? '.not' : ''}.toBeValid`,
'element',
'',
),
'',
`Received element ${is} currently valid:`,
` ${printReceived(element.cloneNode(false))}`,
` ${this.utils.printReceived(element.cloneNode(false))}`,
].join('\n')
},
}
Expand Down
5 changes: 2 additions & 3 deletions src/to-be-partially-checked.js
View file
Open in desktop
@@ -1,4 +1,3 @@
import {matcherHint, printReceived} from 'jest-matcher-utils'
import {checkHtmlElement} from './utils'

export function toBePartiallyChecked(element) {
Expand Down Expand Up @@ -37,14 +36,14 @@ export function toBePartiallyChecked(element) {
message: () => {
const is = isPartiallyChecked() ? 'is' : 'is not'
return [
matcherHint(
this.utils.matcherHint(
`${this.isNot ? '.not' : ''}.toBePartiallyChecked`,
'element',
'',
),
'',
`Received element ${is} partially checked:`,
` ${printReceived(element.cloneNode(false))}`,
` ${this.utils.printReceived(element.cloneNode(false))}`,
].join('\n')
},
}
Expand Down
9 changes: 6 additions & 3 deletions src/to-be-required.js
View file
Open in desktop
@@ -1,4 +1,3 @@
import {matcherHint, printReceived} from 'jest-matcher-utils'
import {checkHtmlElement, getTag} from './utils'

// form elements that support 'required'
Expand Down Expand Up @@ -60,10 +59,14 @@ export function toBeRequired(element) {
message: () => {
const is = isRequired ? 'is' : 'is not'
return [
matcherHint(`${this.isNot ? '.not' : ''}.toBeRequired`, 'element', ''),
this.utils.matcherHint(
`${this.isNot ? '.not' : ''}.toBeRequired`,
'element',
'',
),
'',
`Received element ${is} required:`,
` ${printReceived(element.cloneNode(false))}`,
` ${this.utils.printReceived(element.cloneNode(false))}`,
].join('\n')
},
}
Expand Down
9 changes: 6 additions & 3 deletions src/to-be-visible.js
View file
Open in desktop
@@ -1,4 +1,3 @@
import {matcherHint, printReceived} from 'jest-matcher-utils'
import {checkHtmlElement} from './utils'

function isStyleVisible(element) {
Expand Down Expand Up @@ -39,10 +38,14 @@ export function toBeVisible(element) {
message: () => {
const is = isVisible ? 'is' : 'is not'
return [
matcherHint(`${this.isNot ? '.not' : ''}.toBeVisible`, 'element', ''),
this.utils.matcherHint(
`${this.isNot ? '.not' : ''}.toBeVisible`,
'element',
'',
),
'',
`Received element ${is} visible:`,
` ${printReceived(element.cloneNode(false))}`,
` ${this.utils.printReceived(element.cloneNode(false))}`,
].join('\n')
},
}
Expand Down
14 changes: 6 additions & 8 deletions src/to-contain-element.js
View file
Open in desktop
@@ -1,8 +1,3 @@
import {
matcherHint,
stringify,
RECEIVED_COLOR as receivedColor,
} from 'jest-matcher-utils'
import {checkHtmlElement} from './utils'

export function toContainElement(container, element) {
Expand All @@ -16,15 +11,18 @@ export function toContainElement(container, element) {
pass: container.contains(element),
message: () => {
return [
matcherHint(
this.utils.matcherHint(
`${this.isNot ? '.not' : ''}.toContainElement`,
'element',
'element',
),
'',
receivedColor(`${stringify(container.cloneNode(false))} ${
// eslint-disable-next-line babel/new-cap
this.utils.RECEIVED_COLOR(`${this.utils.stringify(
container.cloneNode(false),
)} ${
this.isNot ? 'contains:' : 'does not contain:'
} ${stringify(element ? element.cloneNode(false) : element)}
} ${this.utils.stringify(element ? element.cloneNode(false) : element)}
`),
].join('\n')
},
Expand Down