Fix comment nodes being specified as children in a satisfy spec.

[alexjeffburke]

This is a backwards compatible version of the previous PR that ensures that any DOMNode present in the children property of an object spec is converted before comparison.

Fixes #217.

[coveralls]

Pull Request Test Coverage Report for Build 822

• 7 of 8 (87.5%) changed or added relevant lines in 1 file are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage decreased (-0.06%) to 91.499%

---

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
lib/index.js	7	8	87.5%

Totals
Change from base Build 808:	-0.06%
Covered Lines:	525
Relevant Lines:	555

---

💛 - Coveralls

[sunesimonsen]

Mhh I never thought of using ignore in an object spec context, in that case you can just use expect.it. Can you point me to the problem in unexpected-reaction. The ignore comment was just syntactic sugar for ignoring with expect.it.

[alexjeffburke]

@sunesimonsen I've documented it here: unexpectedjs/unexpected-reaction#5. Let me know what you think :)

[sunesimonsen]

Shouldn't we always convertChildrenToSatisfySpec, what if I'm providing a DOM tree as a single items? Maybe I don't have the full overview 🤔

[alexjeffburke]

I don't believe so - based on my understanding of the rest of the assertions, I believe it is possible for a DOMNodeList object to be supplied as the value of children and the comparison should still work. If individual DOM nodes are supplied they'd be in an array which would need the conversion :)

[sunesimonsen]

I realize that I should probably have written more tests for ignore, it was sort of an experiment that got shipped to production - as all prototypes :-)

Sorry about that.

[sunesimonsen]

It would be great to get @papandreou take a lot at this as well. I'll take a deeper look at it tomorrow.

[alexjeffburke]

This is definitely the one to consider.

What this change specifically allows is full DOM nodes to be supplied as the elements of the children array. It runs them through a conversion to satisfy specs which means all the matching done by that function gets picked up (for example the expect.it('to be an', 'DOMNode') in the case of a DOMCommentNode containing ignore).

It also maintains the invariant of plain strings resulting in a text based comparison of the nodes which should mean that it is backwards compatible, something I did not intend to undermine.

[papandreou]

I'd like to get <!-- ignore --> to work in all situations, not just when you satisfy against <object>. Added some more tests and got it to work by adding a new type: #220

[sunesimonsen]

Released as [email protected]