Skip to content

Support factory functions for children replace on assertion templates #413

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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
agubler merged 4 commits into from
Jun 25, 2019
Merged

Support factory functions for children replace on assertion templates #413

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9255840
Extend children API to support factory functions, warn on using Arrays
agubler Jun 25, 2019
6711127
Update readme
agubler Jun 25, 2019
f571411
change warning
agubler Jun 25, 2019
e6e24b2
Immediately warn for using array API
agubler Jun 25, 2019
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
14 changes: 7 additions & 7 deletions src/testing/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -320,13 +320,13 @@ Here we're using the `setChildren()` api on the baseAssertion, and we're using t
Assertion Template has the following api's:

```
insertBefore(selector: string, children: DNode[]): AssertionTemplateResult;
insertAfter(selector: string, children: DNode[]): AssertionTemplateResult;
insertSiblings(selector: string, children: DNode[], type?: 'before' | 'after'): AssertionTemplateResult;
append(selector: string, children: DNode[]): AssertionTemplateResult;
prepend(selector: string, children: DNode[]): AssertionTemplateResult;
replaceChildren(selector: string, children: DNode[]): AssertionTemplateResult;
setChildren(selector: string, children: DNode[], type?: 'prepend' | 'replace' | 'append'): AssertionTemplateResult;
insertBefore(selector: string, children: DNode[] | (() => DNode[])): AssertionTemplateResult;
insertAfter(selector: string, children: DNode[] | (() => DNode[])): AssertionTemplateResult;
insertSiblings(selector: string, children: DNode[] | (() => DNode[]), type?: 'before' | 'after'): AssertionTemplateResult;
append(selector: string, children: DNode[] | (() => DNode[])): AssertionTemplateResult;
prepend(selector: string, children: DNode[] | (() => DNode[])): AssertionTemplateResult;
replaceChildren(selector: string, children: DNode[] | (() => DNode[])): AssertionTemplateResult;
setChildren(selector: string, children: DNode[] | (() => DNode[]), type?: 'prepend' | 'replace' | 'append'): AssertionTemplateResult;
setProperty(selector: string, property: string, value: any): AssertionTemplateResult;
setProperties(selector: string, value: any | PropertiesComparatorFunction): AssertionTemplateResult;
getChildren(selector: string): DNode[];
Expand Down
50 changes: 36 additions & 14 deletions src/testing/assertionTemplate.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,21 @@ import WidgetBase from '../core/WidgetBase';

export type PropertiesComparatorFunction = (actualProperties: any) => any;

export type TemplateChildren = DNode[] | (() => DNode[]);

export interface AssertionTemplateResult {
(): DNode | DNode[];
append(selector: string, children: DNode[]): AssertionTemplateResult;
prepend(selector: string, children: DNode[]): AssertionTemplateResult;
replaceChildren(selector: string, children: DNode[]): AssertionTemplateResult;
insertBefore(selector: string, children: DNode[]): AssertionTemplateResult;
insertAfter(selector: string, children: DNode[]): AssertionTemplateResult;
insertSiblings(selector: string, children: DNode[], type?: 'before' | 'after'): AssertionTemplateResult;
setChildren(selector: string, children: DNode[], type?: 'prepend' | 'replace' | 'append'): AssertionTemplateResult;
append(selector: string, children: TemplateChildren): AssertionTemplateResult;
prepend(selector: string, children: TemplateChildren): AssertionTemplateResult;
replaceChildren(selector: string, children: TemplateChildren): AssertionTemplateResult;
insertBefore(selector: string, children: TemplateChildren): AssertionTemplateResult;
insertAfter(selector: string, children: TemplateChildren): AssertionTemplateResult;
insertSiblings(selector: string, children: TemplateChildren, type?: 'before' | 'after'): AssertionTemplateResult;
setChildren(
selector: string,
children: TemplateChildren,
type?: 'prepend' | 'replace' | 'append'
): AssertionTemplateResult;
setProperty(selector: string, property: string, value: any): AssertionTemplateResult;
setProperties(selector: string, value: any | PropertiesComparatorFunction): AssertionTemplateResult;
getChildren(selector: string): DNode[];
Expand Down Expand Up @@ -74,24 +80,32 @@ export function assertionTemplate(renderFunc: () => DNode | DNode[]) {
return render;
});
};
assertionTemplateResult.append = (selector: string, children: DNode[]) => {
assertionTemplateResult.append = (selector: string, children: TemplateChildren) => {
return assertionTemplateResult.setChildren(selector, children, 'append');
};
assertionTemplateResult.prepend = (selector: string, children: DNode[]) => {
assertionTemplateResult.prepend = (selector: string, children: TemplateChildren) => {
return assertionTemplateResult.setChildren(selector, children, 'prepend');
};
assertionTemplateResult.replaceChildren = (selector: string, children: DNode[]) => {
assertionTemplateResult.replaceChildren = (selector: string, children: TemplateChildren) => {
return assertionTemplateResult.setChildren(selector, children, 'replace');
};
assertionTemplateResult.setChildren = (
selector: string,
children: DNode[],
children: TemplateChildren,
type: 'prepend' | 'replace' | 'append' = 'replace'
) => {
if (Array.isArray(children)) {
console.warn(
'The array API (`children: DNode[]`) has been deprecated. Working with children should use a factory to avoid issues with mutation.'
);
}
return assertionTemplate(() => {
const render = renderFunc();
const node = findOne(render, selector);
node.children = node.children || [];
if (typeof children === 'function') {
children = children();
}
switch (type) {
case 'prepend':
node.children = [...children, ...node.children];
Expand All @@ -106,23 +120,31 @@ export function assertionTemplate(renderFunc: () => DNode | DNode[]) {
return render;
});
};
assertionTemplateResult.insertBefore = (selector: string, children: DNode[]) => {
assertionTemplateResult.insertBefore = (selector: string, children: TemplateChildren) => {
return assertionTemplateResult.insertSiblings(selector, children, 'before');
};
assertionTemplateResult.insertAfter = (selector: string, children: DNode[]) => {
assertionTemplateResult.insertAfter = (selector: string, children: TemplateChildren) => {
return assertionTemplateResult.insertSiblings(selector, children, 'after');
};
assertionTemplateResult.insertSiblings = (
selector: string,
children: DNode[],
children: TemplateChildren,
type: 'before' | 'after' = 'after'
) => {
if (Array.isArray(children)) {
console.warn(
'The array API (`children: DNode[]`) has been deprecated. Working with children should use a factory to avoid issues with mutation.'
);
}
return assertionTemplate(() => {
const render = renderFunc();
const node = findOne(render, selector);
const parent = (node as any).parent;
const index = parent.children.indexOf(node);
let newChildren = [...parent.children];
if (typeof children === 'function') {
children = children();
}
switch (type) {
case 'before':
newChildren.splice(index, 0, ...children);
Expand Down
79 changes: 78 additions & 1 deletion tests/testing/unit/assertionTemplate.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
const { describe, it } = intern.getInterface('bdd');
const { describe, it, after, afterEach } = intern.getInterface('bdd');
const { assert } = intern.getPlugin('chai');
import { stub } from 'sinon';

import { harness } from '../../../src/testing/harness';
import { WidgetBase } from '../../../src/core/WidgetBase';
Expand Down Expand Up @@ -78,7 +79,17 @@ const tsxAssertion = assertionTemplate(() => (
</div>
));

let consoleStub = stub(console, 'warn');

describe('assertionTemplate', () => {
afterEach(() => {
consoleStub.resetHistory();
});

after(() => {
consoleStub.restore();
});

it('can get a property', () => {
const classes = baseAssertion.getProperty('~root', 'classes');
assert.deepEqual(classes, ['root']);
Expand Down Expand Up @@ -134,36 +145,102 @@ describe('assertionTemplate', () => {
it('can set a child', () => {
const h = harness(() => w(MyWidget, { replaceChild: true }));
const childAssertion = baseAssertion.setChildren('~header', ['replace']);
assert.isTrue(consoleStub.calledOnce);
assert.strictEqual(
consoleStub.firstCall.args[0],
'The array API (`children: DNode[]`) has been deprecated. Working with children should use a factory to avoid issues with mutation.'
);
h.expect(childAssertion);
});

it('can set a child with a factory function', () => {
const h = harness(() => w(MyWidget, { replaceChild: true }));
const childAssertion = baseAssertion.setChildren('~header', () => ['replace']);
h.expect(childAssertion);
});

it('can set a child with replace', () => {
const h = harness(() => w(MyWidget, { replaceChild: true }));
const childAssertion = baseAssertion.replaceChildren('~header', ['replace']);
assert.isTrue(consoleStub.calledOnce);
assert.strictEqual(
consoleStub.firstCall.args[0],
'The array API (`children: DNode[]`) has been deprecated. Working with children should use a factory to avoid issues with mutation.'
);
h.expect(childAssertion);
});

it('can set a child with replace with a factory function', () => {
const h = harness(() => w(MyWidget, { replaceChild: true }));
const childAssertion = baseAssertion.replaceChildren('~header', () => ['replace']);
h.expect(childAssertion);
});

it('can set a child with prepend', () => {
const h = harness(() => w(MyWidget, { prependChild: true }));
const childAssertion = baseAssertion.prepend('~header', ['prepend']);
assert.isTrue(consoleStub.calledOnce);
assert.strictEqual(
consoleStub.firstCall.args[0],
'The array API (`children: DNode[]`) has been deprecated. Working with children should use a factory to avoid issues with mutation.'
);
h.expect(childAssertion);
});

it('can set a child with prepend with a factory function', () => {
const h = harness(() => w(MyWidget, { prependChild: true }));
const childAssertion = baseAssertion.prepend('~header', () => ['prepend']);
h.expect(childAssertion);
});

it('can set a child with append', () => {
const h = harness(() => w(MyWidget, { appendChild: true }));
const childAssertion = baseAssertion.append('~header', ['append']);
assert.isTrue(consoleStub.calledOnce);
assert.strictEqual(
consoleStub.firstCall.args[0],
'The array API (`children: DNode[]`) has been deprecated. Working with children should use a factory to avoid issues with mutation.'
);
h.expect(childAssertion);
});

it('can set a child with append with a factory function', () => {
const h = harness(() => w(MyWidget, { appendChild: true }));
const childAssertion = baseAssertion.append('~header', () => ['append']);
h.expect(childAssertion);
});

it('can set children after with insert', () => {
const h = harness(() => w(MyWidget, { after: true }));
const childAssertion = baseAssertion.insertAfter('ul', [v('span', ['after'])]);
assert.isTrue(consoleStub.calledOnce);
assert.strictEqual(
consoleStub.firstCall.args[0],
'The array API (`children: DNode[]`) has been deprecated. Working with children should use a factory to avoid issues with mutation.'
);
h.expect(childAssertion);
});

it('can set children after with insert with a factory function', () => {
const h = harness(() => w(MyWidget, { after: true }));
const childAssertion = baseAssertion.insertAfter('ul', () => [v('span', ['after'])]);
h.expect(childAssertion);
});

it('can set children before with insert', () => {
const h = harness(() => w(MyWidget, { before: true }));
const childAssertion = baseAssertion.insertBefore('ul', [v('span', ['before'])]);
assert.isTrue(consoleStub.calledOnce);
assert.strictEqual(
consoleStub.firstCall.args[0],
'The array API (`children: DNode[]`) has been deprecated. Working with children should use a factory to avoid issues with mutation.'
);
h.expect(childAssertion);
});

it('can set children before with insert with a factory function', () => {
const h = harness(() => w(MyWidget, { before: true }));
const childAssertion = baseAssertion.insertBefore('ul', () => [v('span', ['before'])]);
h.expect(childAssertion);
});

Expand Down