Merge pull request #58: Normalize assertions and expectations

Author: roxblnfk

src/Assert.php

@@ -12,17 +12,18 @@
 use Testo\Assert\Api\Builtin\ObjectType;
 use Testo\Assert\Api\Builtin\StringType;
 use Testo\Assert\Api\Json\JsonAbstract;
+use Testo\Assert\Internal\Assertion\AssertArray;
 use Testo\Assert\Internal\Assertion\AssertFloat;
 use Testo\Assert\Internal\Assertion\AssertInt;
+use Testo\Assert\Internal\Assertion\AssertIterable;
 use Testo\Assert\Internal\Assertion\AssertJson;
 use Testo\Assert\Internal\Assertion\AssertObject;
 use Testo\Assert\Internal\Assertion\AssertString;
-use Testo\Assert\Internal\Assertion\AssertArray;
 use Testo\Assert\State\AssertException;
-use Testo\Assert\State\AssertTypeFailure;
+use Testo\Assert\State\Assertion\AssertionException;
+use Testo\Assert\State\Test\Fail;
 use Testo\Assert\StaticState;
 use Testo\Assert\Support;
-use Testo\Assert\Internal\Assertion\AssertIterable;
 
 /**
  * Assertion utilities.
@@ -40,7 +41,7 @@ final class Assert
     public static function same(mixed $expected, mixed $actual, string $message = ''): void
     {
         $actual === $expected
-            ? StaticState::log('Assert same: `' . Support::stringify($expected) . '`', $message)
+            ? StaticState::success($actual, 'is the same', $message)
             : StaticState::fail(AssertException::compare($expected, $actual, $message));
     }
 
@@ -55,7 +56,7 @@ public static function same(mixed $expected, mixed $actual, string $message = ''
     public static function notSame(mixed $expected, mixed $actual, string $message = ''): void
     {
         $actual !== $expected
-            ? StaticState::log('Assert not same: `' . Support::stringify($expected) . '`', $message)
+            ? StaticState::success($actual, 'is not same as `' . Support::stringify($expected) . '`', $message)
             : StaticState::fail(AssertException::compare(
                 $expected,
                 $actual,
@@ -76,7 +77,7 @@ public static function notSame(mixed $expected, mixed $actual, string $message =
     public static function equals(mixed $expected, mixed $actual, string $message = ''): void
     {
         $actual == $expected
-            ? StaticState::log('Assert equals: `' . Support::stringify($expected) . '`', $message)
+            ? StaticState::success($actual, 'equals to `' . Support::stringify($expected) . '`', $message)
             : StaticState::fail(AssertException::compare(
                 $expected,
                 $actual,
@@ -96,7 +97,7 @@ public static function equals(mixed $expected, mixed $actual, string $message =
     public static function notEquals(mixed $expected, mixed $actual, string $message = ''): void
     {
         $actual != $expected
-            ? StaticState::log('Assert not equals: `' . Support::stringify($expected) . '`', $message)
+            ? StaticState::success($actual, 'is not equals to `' . Support::stringify($expected) . '`', $message)
             : StaticState::fail(AssertException::compare(
                 $expected,
                 $actual,
@@ -107,38 +108,38 @@ public static function notEquals(mixed $expected, mixed $actual, string $message
     }
 
     /**
-     * Asserts that the condition is true.
+     * Asserts that the value is true.
      *
-     * @param bool $condition The condition asserting to be true.
+     * @param mixed $actual The actual value to check.
      * @param string $message Short description about what exactly is being asserted.
      * @throws AssertException when the assertion fails.
      */
-    public static function true(bool $condition, string $message = ''): void
+    public static function true(mixed $actual, string $message = ''): void
     {
-        $condition === true
-            ? StaticState::log('Assert true', $message)
+        $actual === true
+            ? StaticState::success($actual, 'is exactly `true`', $message)
             : StaticState::fail(AssertException::compare(
                 true,
-                $condition,
+                $actual,
                 $message,
                 'Failed asserting that value `%2$s` is `%1$s`',
             ));
     }
 
     /**
-     * Asserts that the condition is false.
+     * Asserts that the value is false.
      *
-     * @param bool $condition The condition asserting to be false.
+     * @param mixed $actual The actual value to check.
      * @param string $message Short description about what exactly is being asserted.
      * @throws AssertException when the assertion fails.
      */
-    public static function false(bool $condition, string $message = ''): void
+    public static function false(mixed $actual, string $message = ''): void
     {
-        $condition === false
-            ? StaticState::log('Assert false', $message)
+        $actual === false
+            ? StaticState::success($actual, 'is exactly `false`', $message)
             : StaticState::fail(AssertException::compare(
                 false,
-                $condition,
+                $actual,
                 $message,
                 'Failed asserting that value `%2$s` is `%1$s`',
             ));
@@ -174,7 +175,7 @@ public static function contains(mixed $needle, iterable $haystack, string $messa
     {
         foreach ($haystack as $element) {
             if ($needle === $element) {
-                StaticState::log('Assert contains', $message);
+                StaticState::success($haystack, 'contains `' . Support::stringify($needle) . '`', $message);
                 return;
             }
         }
@@ -198,7 +199,7 @@ public static function null(
         string $message = '',
     ): void {
         $actual === null
-            ? StaticState::log('Assert `null`', $message)
+            ? StaticState::success($actual, 'is exactly `null`', $message)
             : StaticState::fail(AssertException::compare(null, $actual, $message));
     }
 
@@ -221,7 +222,7 @@ public static function blank(
         if (
             $actual === null || $actual === '' || $actual === [] || ($actual instanceof \Countable && \count($actual) === 0)
         ) {
-            StaticState::log('Assert blank', $message);
+            StaticState::success($actual, 'is blank', $message);
             return;
         }
         StaticState::fail(AssertException::compare(
@@ -245,7 +246,7 @@ public static function string(mixed $actual): StringType
     /**
      * Asserts that the given value is of `int` data type.
      *
-     * @throws AssertTypeFailure
+     * @throws AssertionException
      */
     public static function int(mixed $actual): IntType
     {
@@ -255,7 +256,7 @@ public static function int(mixed $actual): IntType
     /**
      * Asserts that the given value is of `float` data type.
      *
-     * @throws AssertTypeFailure
+     * @throws AssertionException
      */
     public static function float(mixed $actual): FloatType
     {
@@ -267,7 +268,7 @@ public static function float(mixed $actual): FloatType
      *
      * Numeric type includes integer, float, and numeric strings.
      *
-     * @throws AssertTypeFailure
+     * @throws AssertionException
      *
      * @deprecated To be implemented
      */
@@ -295,7 +296,7 @@ public static function json(string $actual): JsonAbstract
      * Iterables include arrays and objects implementing iterable interface.
      * Does not work with Generators.
      *
-     * @throws AssertTypeFailure
+     * @throws AssertionException
      */
     public static function iterable(mixed $actual): IterableType
     {
@@ -305,7 +306,7 @@ public static function iterable(mixed $actual): IterableType
     /**
      * Asserts that the given value is of `array` data type.
      *
-     * @throws AssertTypeFailure
+     * @throws AssertionException
      */
     public static function array(mixed $actual): ArrayType
     {
@@ -315,7 +316,7 @@ public static function array(mixed $actual): ArrayType
     /**
      * Asserts that the given value is of `object` data type.
      *
-     * @throws AssertTypeFailure
+     * @throws AssertionException
      *
      * @deprecated To be implemented
      */
@@ -337,7 +338,7 @@ public static function object(mixed $actual): ObjectType
      */
     public static function fail(string $message = ''): never
     {
-        $exception = AssertException::fail($message);
+        $exception = new Fail($message);
         StaticState::expectFail($exception);
         StaticState::fail($exception);
     }

src/Assert/Api/Builtin/ArrayType.php

@@ -16,12 +16,10 @@ interface ArrayType extends IterableType
     /**
      * Asserts that the array contains given key.
      *
-     * @param int|string $key The key to check for in the array.
-     * @param string $message Optional message for the assertion.
+     * @param int|string ...$keys The keys to check for existence in the array.
      * @throws AssertException when the assertion fails.
-     *
      */
-    public function hasKey(int|string $key, string $message = ''): self;
+    public function hasKeys(int|string ...$keys): static;
 
     /**
      * Asserts that the array is a list.
@@ -31,7 +29,6 @@ public function hasKey(int|string $key, string $message = ''): self;
      *
      * @param string $message Optional message for the assertion.
      * @throws AssertException when the assertion fails.
-     *
      */
-    public function isList(string $message = ''): self;
+    public function isList(string $message = ''): static;
 }

src/Assert/Api/Builtin/IterableType.php

@@ -22,7 +22,7 @@ interface IterableType
      * @param string $message Optional message for the assertion.
      * @throws AssertException when the assertion fails.
      */
-    public function contains(mixed $needle, string $message = ''): self;
+    public function contains(mixed $needle, string $message = ''): static;
 
     /**
      * Asserts that the iterable has the same number of elements as the expected iterable.
@@ -31,15 +31,15 @@ public function contains(mixed $needle, string $message = ''): self;
      * @param string $message Optional message for the assertion.
      * @throws AssertException when the assertion fails.
      */
-    public function sameSizeAs(iterable $expected, string $message = ''): self;
+    public function sameSizeAs(iterable $expected, string $message = ''): static;
 
     /**
      * Asserts that the iterable has the expected number of elements.
      *
      * @param int $expected The expected count of elements.
      * @throws AssertException when the assertion fails.
      */
-    public function hasCount(int $expected): self;
+    public function hasCount(int $expected): static;
 
     /**
      * Asserts that all values in the iterable are of the specified type.
@@ -49,5 +49,5 @@ public function hasCount(int $expected): self;
      * @param string $message Optional message for the assertion.
      * @throws AssertException when the assertion fails.
      */
-    public function allOf(string $type, string $message = ''): self;
+    public function allOf(string $type, string $message = ''): static;
 }

src/Assert/Api/Builtin/NumericType.php

@@ -20,7 +20,7 @@ interface NumericType
      * @param string $message Optional message for the assertion.
      * @throws AssertException when the assertion fails.
      */
-    public function greaterThan(int|float $min, string $message = ''): self;
+    public function greaterThan(int|float $min, string $message = ''): static;
 
     /**
      * Asserts that the numeric value is greater than or equal to given minimum.
@@ -29,7 +29,7 @@ public function greaterThan(int|float $min, string $message = ''): self;
      * @param string $message Optional message for the assertion.
      * @throws AssertException when the assertion fails.
      */
-    public function greaterThanOrEqual(int|float $min, string $message = ''): self;
+    public function greaterThanOrEqual(int|float $min, string $message = ''): static;
 
     /**
      * Asserts that numeric value is less than the given maximum.
@@ -38,7 +38,7 @@ public function greaterThanOrEqual(int|float $min, string $message = ''): self;
      * @param string $message Optional message for the assertion.
      * @throws AssertException when the assertion fails.
      */
-    public function lessThan(int|float $max, string $message = ''): self;
+    public function lessThan(int|float $max, string $message = ''): static;
 
     /**
      * Asserts that the numeric value is less than or equal to given maximum.
@@ -47,5 +47,5 @@ public function lessThan(int|float $max, string $message = ''): self;
      * @param string $message Optional message for the assertion.
      * @throws AssertException when the assertion fails.
      */
-    public function lessThanOrEqual(int|float $max, string $message = ''): self;
+    public function lessThanOrEqual(int|float $max, string $message = ''): static;
 }

src/Assert/Api/Builtin/ObjectType.php

@@ -23,7 +23,7 @@ interface ObjectType
      * @psalm-assert ExpectedType $actual
      * @phpstan-assert ExpectedType $actual
      */
-    public function instanceOf(string $expected, string $message = ''): self;
+    public function instanceOf(string $expected, string $message = ''): static;
 
     /**
      * Asserts that the object has the given property.
@@ -34,5 +34,5 @@ public function instanceOf(string $expected, string $message = ''): self;
      *
      * @deprecated To be implemented
      */
-    public function hasProperty(string $propertyName, string $message = ''): self;
+    public function hasProperty(string $propertyName, string $message = ''): static;
 }

src/Assert/Interceptor/ExpectationsInterceptor.php

@@ -5,6 +5,7 @@
 namespace Testo\Assert\Interceptor;
 
 use Testo\Assert\State\AssertException;
+use Testo\Assert\State\Record;
 use Testo\Assert\StaticState;
 use Testo\Interceptor\TestRunInterceptor;
 use Testo\Test\Dto\Status;
@@ -28,7 +29,7 @@ public function runTest(TestInfo $info, callable $next): TestResult
         $result = $next($info);
 
         # Convert Error status to Failed if caused by an assertion failure
-        $result->status === Status::Error && $result->failure instanceof AssertException and $result = $result
+        $result->status === Status::Error && $result->failure instanceof Record and $result = $result
             ->with(status: Status::Failed);
 
         $state = StaticState::current();