Make object "has" matcher recursive

[mareq]

Purpose (TL;DR)

Enable matching properties of embedded objects using sinon.match.has matcher.

Background (Problem in detail)

"test should assert fuzzy": function () {
    var book = {
        pages: 42,
        author: {
            name: "cj"
            surname: "no" 
        }
    };
    var spy = sinon.spy();
    spy(book);

    // currently, this will NOT match (entire object has to be passed as value)
    sinon.assert.calledWith(spy, sinon.match.has("author", { name: "cj" } ));

    // this pull request enable this to match
    sinon.assert.calledWith(spy, sinon.match.has("author.name", "cj" ));
}

Solution

createPropertyMatcher has been modified such that:

• existence of "dot.separated.embedded.property" is checked using recursive helper function
• deepEqual is run only on the value of the requested property, not on the whole top-level object

How to verify - mandatory

1. Check out this branch (see github instructions below)
2. npm install
3. npm test (test case for the new functionality has been added)

[coveralls]

Coverage decreased (-0.1%) to 94.755% when pulling d04f7af on mareq:mareq/recursive-object-has-matcher into 15871b2 on sinonjs:master.

[mantoni]

I can see how this simplifies the notation when testing details in large objects. However, there is already a way to do the same thing, and I'm not sure if @sinonjs/sinon-core wants to introduce an alternative.

sinon.assert.calledWith(spy, sinon.match.has("author", sinon.match.has("name", "cj")));

Also, consider using calledWithMatch:

sinon.assert.calledWithMatch(spy, {
  author: sinon.match.has("name", "cj")
});

[coveralls]

Coverage remained the same at 94.896% when pulling 1035e77 on mareq:mareq/recursive-object-has-matcher into 15871b2 on sinonjs:master.

[coveralls]

Coverage remained the same at 94.896% when pulling 0d9c367 on mareq:mareq/recursive-object-has-matcher into 15871b2 on sinonjs:master.

[mareq]

@mantoni: Thanks for hint, I did not know about the functionality already existed (actually tried that composition way first, but because of my mistake it did not work - I like the composition more in fact).

One of the reasons (apart of me trying to match stuff on serialised string instead of real object) why I did not know the feature is already present is that I did not find unit test nor documentation for it, so I have added both. Also reverted my original changes.

[mantoni]

@mareq Nice, thank you! You've added the documentation specifically for the v17 release. Can you add the documentation changes also to /docs/release-source/release so that it's part of the current docs and in every future release?

[coveralls]

Coverage remained the same at 94.896% when pulling a0115f8 on mareq:mareq/recursive-object-has-matcher into 15871b2 on sinonjs:master.

[mareq]

@mantoni Done: amended my last commit to move it from v17 to /docs/release-source/release

[coveralls]

Coverage remained the same at 94.896% when pulling 13b93e1 on mareq:mareq/recursive-object-has-matcher into 15871b2 on sinonjs:master.

[mantoni]

Thank you!