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.

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

support serializing DocumentFragment #6705

Merged
merged 4 commits into from
Aug 8, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

- `[jest-runner]` print stack trace when `process.exit` is called from user code ([#6714](https://github.com/facebook/jest/pull/6714))
- `[jest-each]` introduces `%#` option to add index of the test to its title ([#6414](https://github.com/facebook/jest/pull/6414))
- `[pretty-format]` Support serializing `DocumentFragment` ([#6705](https://github.com/facebook/jest/pull/6705))

### Fixes

Expand Down
39 changes: 39 additions & 0 deletions packages/pretty-format/src/__tests__/dom_element.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,45 @@ Testing.`;
);
});

it('supports fragment node', () => {
const fragment = document.createDocumentFragment();
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

const browsers = [
'Firefox',
'Chrome',
'Opera',
'Safari',
'Internet Explorer',
];

browsers.forEach(browser => {
const li = document.createElement('li');
li.textContent = browser;
fragment.appendChild(li);
});

expect(fragment).toPrettyPrintTo(
[
'<DocumentFragment>',
' <li>',
' Firefox',
' </li>',
' <li>',
' Chrome',
' </li>',
' <li>',
' Opera',
' </li>',
' <li>',
' Safari',
' </li>',
' <li>',
' Internet Explorer',
' </li>',
'</DocumentFragment>',
].join('\n'),
);
});

describe('matches constructor name of SVG elements', () => {
// Too bad, so sad, element.constructor.name of SVG elements
// is HTMLUnknownElement in jsdom v9 and v10
Expand Down
22 changes: 16 additions & 6 deletions packages/pretty-format/src/plugins/dom_element.js
Original file line number Diff line number Diff line change
Expand Up @@ -37,17 +37,23 @@ type Comment = {
data: string,
nodeType: 8,
};
type DocumentFragment = {
children: Array<Element>,
nodeType: 11,
};

const ELEMENT_NODE = 1;
const TEXT_NODE = 3;
const COMMENT_NODE = 8;
const FRAGMENT_NODE = 11;

const ELEMENT_REGEXP = /^((HTML|SVG)\w*)?Element$/;

const testNode = (nodeType: any, name: any) =>
(nodeType === ELEMENT_NODE && ELEMENT_REGEXP.test(name)) ||
(nodeType === TEXT_NODE && name === 'Text') ||
(nodeType === COMMENT_NODE && name === 'Comment');
(nodeType === COMMENT_NODE && name === 'Comment') ||
(nodeType === FRAGMENT_NODE && name === 'DocumentFragment');

export const test = (val: any) =>
val &&
Expand All @@ -63,7 +69,7 @@ const propsReducer = (props, attribute) => {
};

export const serialize = (
node: Element | Text | Comment,
node: Element | Text | Comment | DocumentFragment,
config: Config,
indentation: string,
depth: number,
Expand All @@ -78,24 +84,28 @@ export const serialize = (
return printComment(node.data, config);
}

const type = node.tagName.toLowerCase();
const type =
node.nodeType === FRAGMENT_NODE
? `DocumentFragment`
: node.tagName.toLowerCase();

if (++depth > config.maxDepth) {
return printElementAsLeaf(type, config);
}

return printElement(
type,
printProps(
Array.prototype.map.call(node.attributes, keysMapper).sort(),
Array.prototype.reduce.call(node.attributes, propsReducer, {}),
Array.prototype.map.call(node.attributes || [], keysMapper).sort(),
Array.prototype.reduce.call(node.attributes || [], propsReducer, {}),
config,
indentation + config.indent,
depth,
refs,
printer,
),
printChildren(
Array.prototype.slice.call(node.childNodes),
Array.prototype.slice.call(node.childNodes || node.children),
config,
indentation + config.indent,
depth,
Expand Down