Skip to content

feat(object-assertion): Matchers use variadic arguments #89

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
JoseLion merged 1 commit into from
Jul 20, 2023
Merged

feat(object-assertion): Matchers use variadic arguments #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
48 changes: 28 additions & 20 deletions package/src/lib/ObjectAssertion.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ export class ObjectAssertion<T extends Struct> extends Assertion<T> {
public toBeEmpty(): this {
const error = new AssertionError({
actual: this.actual,
expected: { },
message: "Expected the value to be an empty object",
});
const invertedError = new AssertionError({
Expand Down Expand Up @@ -83,20 +84,21 @@ export class ObjectAssertion<T extends Struct> extends Assertion<T> {
*
* @example
* ```
* expect({ a: 1, b: 2, c: 3 }).toContainAllKeys(["a", "b"]);
* expect({ a: 1, b: 2, c: 3 }).toContainAllKeys("a", "b");
* ```
*
* @param keys the keys that the object should contain
* @returns the assertion instance
*/
public toContainAllKeys(keys: Array<keyof T>): this {
public toContainAllKeys(...keys: Array<keyof T>): this {
const error = new AssertionError({
actual: this.actual,
actual: Object.keys(this.actual),
expected: keys,
message: `Expected the object to contain all the provided keys <${prettify(keys)}>`,
});

const invertedError = new AssertionError({
actual: this.actual,
actual: Object.keys(this.actual),
message: `Expected the object NOT to contain all the provided keys <${prettify(keys)}>`,
});
return this.execute({
Expand All @@ -111,20 +113,21 @@ export class ObjectAssertion<T extends Struct> extends Assertion<T> {
*
* @example
* ```
* expect({ a: 1, b: 2, c: 3 }).toContainAnyKeys(["a", "b"]);
* expect({ a: 1, b: 2, c: 3 }).toContainAnyKeys("a", "b");
* ```
*
* @param keys the keys that the object may contain
* @returns the assertion instance
*/
public toContainAnyKeys(keys: Array<keyof T>): this {
public toContainAnyKeys(...keys: Array<keyof T>): this {
const error = new AssertionError({
actual: this.actual,
actual: Object.keys(this.actual),
expected: keys,
message: `Expected the object to contain at least one of the provided keys <${prettify(keys)}>`,
});

const invertedError = new AssertionError({
actual: this.actual,
actual: Object.keys(this.actual),
message: `Expected the object NOT to contain any of the provided keys <${prettify(keys)}>`,
});
return this.execute({
Expand Down Expand Up @@ -168,20 +171,21 @@ export class ObjectAssertion<T extends Struct> extends Assertion<T> {
*
* @example
* ```
* expect({ a: 1, b: 2, c: 3 }).toContainAllValues([1, 2]);
* expect({ a: 1, b: 2, c: 3 }).toContainAllValues(1, 2);
* ```
*
* @param values the property values that the object should contain
* @returns the assertion instance
*/
public toContainAllValues(values: Array<T[keyof T]>): this {
public toContainAllValues(...values: Array<T[keyof T]>): this {
const error = new AssertionError({
actual: this.actual,
actual: Object.values(this.actual),
expected: values,
message: `Expected the object to contain all the provided values <${prettify(values)}>`,
});

const invertedError = new AssertionError({
actual: this.actual,
actual: Object.values(this.actual),
message: `Expected the object NOT to contain all the provided values <${prettify(values)}>`,
});
return this.execute({
Expand All @@ -199,20 +203,21 @@ export class ObjectAssertion<T extends Struct> extends Assertion<T> {
*
* @example
* ```
* expect({ a: 1, b: 2, c: 3 }).toContainAnyValues([1, 5, 7]);
* expect({ a: 1, b: 2, c: 3 }).toContainAnyValues(1, 5, 7);
* ```
*
* @param values the property values that the object should contain
* @returns the assertion instance
*/
public toContainAnyValues(values: Array<T[keyof T]>): this {
public toContainAnyValues(...values: Array<T[keyof T]>): this {
const error = new AssertionError({
actual: this.actual,
actual: Object.values(this.actual),
expected: values,
message: `Expected the object to contain at least one of the provided values <${prettify(values)}>`,
});

const invertedError = new AssertionError({
actual: this.actual,
actual: Object.values(this.actual),
message: `Expected the object NOT to contain any of the provided values <${prettify(values)}>`,
});
return this.execute({
Expand Down Expand Up @@ -268,12 +273,13 @@ export class ObjectAssertion<T extends Struct> extends Assertion<T> {
*/
public toContainAllEntries(...entries: Array<Entry<T>>): this {
const error = new AssertionError({
actual: this.actual,
actual: Object.entries(this.actual),
expected: entries,
message: `Expected the object to contain all the provided entries <${prettify(entries)}>`,
});

const invertedError = new AssertionError({
actual: this.actual,
actual: Object.entries(this.actual),
message: `Expected the object NOT to contain all the provided entries <${prettify(entries)}>`,
});
return this.execute({
Expand Down Expand Up @@ -301,12 +307,13 @@ export class ObjectAssertion<T extends Struct> extends Assertion<T> {
*/
public toContainAnyEntries(...entries: Array<Entry<T>>): this {
const error = new AssertionError({
actual: this.actual,
actual: Object.entries(this.actual),
expected: entries,
message: `Expected the object to contain at least one of the provided entries <${prettify(entries)}>`,
});

const invertedError = new AssertionError({
actual: this.actual,
actual: Object.entries(this.actual),
message: `Expected the object NOT to contain any of the provided entries <${prettify(entries)}>`,
});
return this.execute({
Expand Down Expand Up @@ -334,6 +341,7 @@ export class ObjectAssertion<T extends Struct> extends Assertion<T> {
public toPartiallyMatch(other: Partial<T>): this {
const error = new AssertionError({
actual: this.actual,
expected: other,
message: "Expected the object to be a partial match",
});

Expand Down
34 changes: 17 additions & 17 deletions package/test/lib/ObjectAssertion.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,11 +78,11 @@ describe("[Unit] ObjectAssertion.test.ts", () => {
describe(".toContainAllKeys", () => {
context("when the object contains all the provided keys", () => {
it("returns the assertion instance", () => {
const keys: Array<"myKey" | 2> = ["myKey", 2];
const keys: Array<keyof typeof TEST_OBJ> = ["myKey", 2];
const test = new ObjectAssertion(TEST_OBJ);

assert.deepStrictEqual(test.toContainAllKeys(["myKey", 2]), test);
assert.throws(() => test.not.toContainAllKeys(keys), {
assert.deepStrictEqual(test.toContainAllKeys(...keys), test);
assert.throws(() => test.not.toContainAllKeys(...keys), {
message: `Expected the object NOT to contain all the provided keys <${keys}>`,
name: AssertionError.name,
});
Expand All @@ -94,11 +94,11 @@ describe("[Unit] ObjectAssertion.test.ts", () => {
const someKeys = ["truthy", "wrongKey"];
const test = new ObjectAssertion(RECORD);

assert.throws(() => test.toContainAllKeys(someKeys), {
assert.throws(() => test.toContainAllKeys(...someKeys), {
message: `Expected the object to contain all the provided keys <${someKeys}>`,
name: AssertionError.name,
});
assert.deepStrictEqual(test.not.toContainAllKeys(someKeys), test);
assert.deepStrictEqual(test.not.toContainAllKeys(...someKeys), test);
});
});
});
Expand All @@ -109,8 +109,8 @@ describe("[Unit] ObjectAssertion.test.ts", () => {
const someKeys = ["truthy", "wrongKey"];
const test = new ObjectAssertion(RECORD);

assert.deepStrictEqual(test.toContainAnyKeys(someKeys), test);
assert.throws(() => test.not.toContainAnyKeys(someKeys), {
assert.deepStrictEqual(test.toContainAnyKeys(...someKeys), test);
assert.throws(() => test.not.toContainAnyKeys(...someKeys), {
message: `Expected the object NOT to contain any of the provided keys <${someKeys}>`,
name: AssertionError.name,
});
Expand All @@ -122,11 +122,11 @@ describe("[Unit] ObjectAssertion.test.ts", () => {
const wrongKeys = ["wrongKey", "randomKey"];
const test = new ObjectAssertion(RECORD);

assert.throws(() => test.toContainAnyKeys(wrongKeys), {
assert.throws(() => test.toContainAnyKeys(...wrongKeys), {
message: `Expected the object to contain at least one of the provided keys <${wrongKeys}>`,
name: AssertionError.name,
});
assert.deepStrictEqual(test.not.toContainAnyKeys(wrongKeys), test);
assert.deepStrictEqual(test.not.toContainAnyKeys(...wrongKeys), test);
});
});
});
Expand Down Expand Up @@ -165,8 +165,8 @@ describe("[Unit] ObjectAssertion.test.ts", () => {
const allValues = [0, { innerObjKey: 1, message: "inner value" }];
const test = new ObjectAssertion(TEST_OBJ);

assert.deepStrictEqual(test.toContainAllValues(allValues), test);
assert.throws(() => test.not.toContainAllValues(allValues), {
assert.deepStrictEqual(test.toContainAllValues(...allValues), test);
assert.throws(() => test.not.toContainAllValues(...allValues), {
message: `Expected the object NOT to contain all the provided values <${allValues}>`,
name: AssertionError.name,
});
Expand All @@ -178,11 +178,11 @@ describe("[Unit] ObjectAssertion.test.ts", () => {
const someValues = [0, { innerObjKey: 1, message: "wrong inner value" }];
const test = new ObjectAssertion(TEST_OBJ);

assert.throws(() => test.toContainAllValues(someValues), {
assert.throws(() => test.toContainAllValues(...someValues), {
message: `Expected the object to contain all the provided values <${someValues}>`,
name: AssertionError.name,
});
assert.deepStrictEqual(test.not.toContainAllValues(someValues), test);
assert.deepStrictEqual(test.not.toContainAllValues(...someValues), test);
});
});
});
Expand All @@ -193,8 +193,8 @@ describe("[Unit] ObjectAssertion.test.ts", () => {
const someValues = [0, { innerObjKey: 1, message: "wrong inner value" }];
const test = new ObjectAssertion(TEST_OBJ);

assert.deepStrictEqual(test.toContainAnyValues(someValues), test);
assert.throws(() => test.not.toContainAnyValues(someValues), {
assert.deepStrictEqual(test.toContainAnyValues(...someValues), test);
assert.throws(() => test.not.toContainAnyValues(...someValues), {
message: `Expected the object NOT to contain any of the provided values <${someValues}>`,
name: AssertionError.name,
});
Expand All @@ -206,11 +206,11 @@ describe("[Unit] ObjectAssertion.test.ts", () => {
const wrongValues = [10, { innerObjKey: 1, message: "wrong inner value" }];
const test = new ObjectAssertion(TEST_OBJ);

assert.throws(() => test.toContainAnyValues(wrongValues), {
assert.throws(() => test.toContainAnyValues(...wrongValues), {
message: `Expected the object to contain at least one of the provided values <${wrongValues}>`,
name: AssertionError.name,
});
assert.deepStrictEqual(test.not.toContainAnyValues(wrongValues), test);
assert.deepStrictEqual(test.not.toContainAnyValues(...wrongValues), test);
});
});
});
Expand Down