feat(assertion): Enhanced the assertion error messaging and added new test cases.

2025-03-04 12:20:06 +00:00
parent 5f5628f647
commit f0ab180902
8 changed files with 1627 additions and 1524 deletions
--- a/readme.md
+++ b/readme.md
@ -1,5 +1,5 @@
 # @push.rocks/smartexpect
-manage expectations in code
+Manage expectations in code with precise, readable assertions

 ## Install

@ -30,14 +30,16 @@ You can employ `expect` to create synchronous assertions:
 ```typescript
 import { expect } from '@push.rocks/smartexpect';

-// String type assertion
+// Type assertions
 expect('hello').toBeTypeofString();
-
-// Negated String type assertion
-expect(1).not.toBeTypeofString();
-
-// Boolean type assertion
+expect(42).toBeTypeofNumber();
 expect(true).toBeTypeofBoolean();
+expect(() => {}).toBeTypeOf('function');
+expect({}).toBeTypeOf('object');
+
+// Negated assertions
+expect(1).not.toBeTypeofString();
+expect('string').not.toBeTypeofNumber();

 // Equality assertion
 expect('hithere').toEqual('hithere');
@ -61,68 +63,184 @@ const asyncStringFetcher = async (): Promise<string> => {
 };

 const asyncTest = async () => {
-  await expectAsync(asyncStringFetcher()).toBeTypeofString();
+  // Add a timeout to prevent hanging tests
+  await expectAsync(asyncStringFetcher()).timeout(5000).toBeTypeofString();
  await expectAsync(asyncStringFetcher()).toEqual('async string');
 };

 asyncTest();
 ```

-### Advanced Usage
+### Navigating Complex Objects

- **Properties and Deep Properties:** Assert the existence of properties and their values.
-  
-  ```typescript
-  const testObject = { level1: { level2: 'value' } };
+You can navigate complex objects using the `property()` and `arrayItem()` methods:

-  // Property existence
-  expect(testObject).toHaveProperty('level1');
-  
-  // Deep Property existence
-  expect(testObject).toHaveDeepProperty(['level1', 'level2']);
-  ```
+```typescript
+const complexObject = {
+  users: [
+    { id: 1, name: 'Alice', permissions: { admin: true } },
+    { id: 2, name: 'Bob', permissions: { admin: false } }
+  ]
+};

- **Conditions and Comparisons:** Allow more intricate assertions like greater than, less than, or matching specific conditions.
+// Navigate to a nested property
+expect(complexObject)
+  .property('users')
+  .arrayItem(0)
+  .property('name')
+  .toEqual('Alice');

-  ```typescript
-  // Greater Than
-  expect(5).toBeGreaterThan(3);
+// Check nested permission
+expect(complexObject)
+  .property('users')
+  .arrayItem(0)
+  .property('permissions')
+  .property('admin')
+  .toBeTrue();
+```

-  // Less Than
-  expect(3).toBeLessThan(5);
+### Advanced Assertions

-  // Custom conditions
-  expect(7).customAssertion(value => value > 5, 'Value is not greater than 5');
-  ```
+#### Properties and Deep Properties

- **Arrays and Objects:** Work seamlessly with arrays and objects, checking for containment, length, or specific values.
+Assert the existence of properties and their values:

-  ```typescript
-  const testArray = [1, 2, 3];
+```typescript
+const testObject = { level1: { level2: 'value' } };

-  // Containment
-  expect(testArray).toContain(2);
+// Property existence
+expect(testObject).toHaveProperty('level1');

-  // Array length
-  expect(testArray).toHaveLength(3);
+// Property with specific value
+expect(testObject).toHaveProperty('level1.level2', 'value');

-  // Object matching
-  expect({ name: 'Test', value: 123 }).toMatchObject({ name: 'Test' });
-  ```
+// Deep Property existence
+expect(testObject).toHaveDeepProperty(['level1', 'level2']);
+```

-### Handling Promises and Async Operations
+#### Conditions and Comparisons

-`@push.rocks/smartexpect` gracefully integrates with asynchronous operations, providing a `expectAsync` function that handles promise-based assertions. This keeps your tests clean and readable, irrespective of the nature of the code being tested.
+Perform more intricate assertions:

-### Best Practices
+```typescript
+// Numeric comparisons
+expect(5).toBeGreaterThan(3);
+expect(3).toBeLessThan(5);
+expect(5).toBeGreaterThanOrEqual(5);
+expect(5).toBeLessThanOrEqual(5);
+expect(0.1 + 0.2).toBeCloseTo(0.3, 10); // Floating point comparison with precision

- **Readability:** Favor clarity and readability by explicitly stating your expectations. `@push.rocks/smartexpect`'s API is designed to be fluent and expressive, making your tests easy to write and, more importantly, easy to read.
+// Truthiness checks
+expect(true).toBeTrue();
+expect(false).toBeFalse();
+expect('non-empty').toBeTruthy();
+expect(0).toBeFalsy();

- **Comprehensive Coverage:** Utilize the full spectrum of assertions provided to cover a broad set of use cases, ensuring your code behaves as expected not just in ideal conditions but across various edge cases.
+// Null/Undefined checks
+expect(null).toBeNull();
+expect(undefined).toBeUndefined();
+expect(null).toBeNullOrUndefined();

- **Maintainability:** Group related assertions together to improve test maintainability. This makes it easier to update tests as your codebase evolves.
+// Custom conditions
+expect(7).customAssertion(value => value % 2 === 1, 'Value is not odd');
+```

-Through judicious use of `@push.rocks/smartexpect`, you can enhance the reliability and maintainability of your test suite, making your codebase more robust and your development workflow more efficient.
+#### Arrays and Collections
+
+Work seamlessly with arrays and collections:
+
+```typescript
+const testArray = [1, 2, 3];
+
+// Array checks
+expect(testArray).toBeArray();
+expect(testArray).toHaveLength(3);
+expect(testArray).toContain(2);
+expect(testArray).toContainAll([1, 3]);
+expect(testArray).toExclude(4);
+expect([]).toBeEmptyArray();
+expect(testArray).toHaveLengthGreaterThan(2);
+expect(testArray).toHaveLengthLessThan(4);
+
+// Deep equality in arrays
+expect([{ id: 1 }, { id: 2 }]).toContainEqual({ id: 1 });
+```
+
+#### Strings
+
+String-specific checks:
+
+```typescript
+expect('hello world').toStartWith('hello');
+expect('hello world').toEndWith('world');
+expect('hello world').toInclude('lo wo');
+expect('options').toBeOneOf(['choices', 'options', 'alternatives']);
+```
+
+#### Functions and Exceptions
+
+Test function behavior and exceptions:
+
+```typescript
+const throwingFn = () => { throw new Error('test error'); };
+expect(throwingFn).toThrow();
+expect(throwingFn).toThrow(Error);
+
+const safeFn = () => 'result';
+expect(safeFn).not.toThrow();
+```
+
+#### Date Assertions
+
+Work with dates:
+
+```typescript
+const now = new Date();
+const past = new Date(Date.now() - 10000);
+const future = new Date(Date.now() + 10000);
+
+expect(now).toBeDate();
+expect(now).toBeAfterDate(past);
+expect(now).toBeBeforeDate(future);
+```
+
+### Debugging Assertions
+
+The `log()` method is useful for debugging complex assertions:
+
+```typescript
+expect(complexObject)
+  .property('users')
+  .log() // Logs the current value in the assertion chain
+  .arrayItem(0)
+  .log() // Logs the first user
+  .property('permissions')
+  .log() // Logs the permissions object
+  .property('admin')
+  .toBeTrue();
+```
+
+### Customizing Error Messages
+
+You can provide custom error messages for more meaningful test failures:
+
+```typescript
+expect(user.age)
+  .setFailMessage('User age must be at least 18 for adult content')
+  .toBeGreaterThanOrEqual(18);
+```
+
+## Best Practices
+
+- **Human-readable assertions**: The fluent API is designed to create tests that read like natural language sentences.
+
+- **Precise error messages**: When tests fail, the error messages provide detailed information about what went wrong, including expected vs. actual values.
+
+- **Property path navigation**: Use the property path methods to navigate complex objects without creating temporary variables.
+
+- **Comprehensive testing**: Take advantage of the wide range of assertion methods to test various aspects of your code.
+
+- **Debugging with log()**: Use the `log()` method to see intermediate values in the assertion chain during test development.

 ## License and Legal Information

@ -141,4 +259,4 @@ Registered at District court Bremen HRB 35230 HB, Germany

 For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.

-By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
+By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.