assert.propContains API Implementation & Tests

[izelnakri]

I think this is a good addition to the existing QUnit public API. It is rather too common that I need to partially check object values. Also includes notPropContains.

Example:

assert.propContains(new User({ id: 1, firstName: 'Izel' }), { firstName: 'Izel' });
assert.notPropContains(new User({ id: 1, firstName: 'Izel' }), { firstName: 'Timo' });

[linux-foundation-easycla]

The committers are authorized under a signed CLA.

• ✅ Izel Nakri (078d2ea, 0638166)

[Krinkle]

Thanks @izelnakri, I support inclusion of a method like this. In terms of semantics, I believe this would be most useful as sibling to propEqual rather than deepEqual. In other words, own properties only (ignore constructor) and non-recursive, which I believe is how you've implemented it as well.

I'd propose a slightly different name that incorporates the term "prop" for consistency with propEqual. I note that in other frameworks, a partial assertion like this is often named with "contain" or "include" as the verb. Perhaps assert.propContain() would work here.

[izelnakri]

In other words, own properties only (ignore constructor) and non-recursive, which I believe is how you've implemented it as well.

Yes.

I'd propose a slightly different name that incorporates the term "prop" for consistency with propEqual. I note that in other frameworks, a partial assertion like this is often named with "contain" or "include" as the verb. Perhaps assert.propContain() would work here.

I agree propContains sounds more explicit, probably a better name. I'm creating a new commit with name changes now!

[Krinkle]

LGTM. I'll probably land/release next weekend. Would you be interested in adding a doc page as well?

[izelnakri]

I'm going for a holiday tomorrow, but I'll see if I can do it during my trip :)

[Krinkle]

@izelnakri I've landed this now to simplify unrelated code changes I'm doing today.

I made a few judgement calls that I think will align with your intent, but I'd love to hear from you prior to releasing this, I'm open to changing or reconsidering any aspect of it! Thanks again for the PR.