refacto: structure

src/Expectations/EachExpectation.php

@@ -0,0 +1,85 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pest\Expectations;
+
+use function expect;
+use Pest\Expectation;
+
+/**
+ * @internal
+ *
+ * @template TValue
+ *
+ * @mixin Expectation<TValue>
+ */
+final class EachExpectation
+{
+    private bool $opposite = false;
+
+    /**
+     * Creates an expectation on each item of the iterable "value".
+     *
+     * @param Expectation<TValue> $original
+     */
+    public function __construct(private Expectation $original)
+    {
+    }
+
+    /**
+     * Creates a new expectation.
+     *
+     * @template TAndValue
+     *
+     * @param TAndValue $value
+     *
+     * @return Expectation<TAndValue>
+     */
+    public function and(mixed $value): Expectation
+    {
+        return $this->original->and($value);
+    }
+
+    /**
+     * Creates the opposite expectation for the value.
+     *
+     * @return self<TValue>
+     */
+    public function not(): EachExpectation
+    {
+        $this->opposite = true;
+
+        return $this;
+    }
+
+    /**
+     * Dynamically calls methods on the class with the given arguments on each item.
+     *
+     * @param array<int|string, mixed> $arguments
+     *
+     * @return self<TValue>
+     */
+    public function __call(string $name, array $arguments): EachExpectation
+    {
+        foreach ($this->original->value as $item) {
+            /* @phpstan-ignore-next-line */
+            $this->opposite ? expect($item)->not()->$name(...$arguments) : expect($item)->$name(...$arguments);
+        }
+
+        $this->opposite = false;
+
+        return $this;
+    }
+
+    /**
+     * Dynamically calls methods on the class without any arguments on each item.
+     *
+     * @return self<TValue>
+     */
+    public function __get(string $name): EachExpectation
+    {
+        /* @phpstan-ignore-next-line */
+        return $this->$name();
+    }
+}

src/Expectations/HigherOrderExpectation.php

@@ -0,0 +1,156 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pest\Expectations;
+
+use Pest\Concerns\Retrievable;
+use Pest\Expectation;
+
+/**
+ * @internal
+ *
+ * @template TOriginalValue
+ * @template TValue
+ *
+ * @mixin Expectation<TOriginalValue>
+ */
+final class HigherOrderExpectation
+{
+    use Retrievable;
+
+    /**
+     * @var Expectation<TValue>|EachExpectation<TValue>
+     */
+    private Expectation|EachExpectation $expectation;
+
+    private bool $opposite = false;
+
+    private bool $shouldReset = false;
+
+    /**
+     * Creates a new higher order expectation.
+     *
+     * @param Expectation<TOriginalValue> $original
+     * @param TValue                      $value
+     */
+    public function __construct(private Expectation $original, mixed $value)
+    {
+        $this->expectation  = $this->expect($value);
+    }
+
+    /**
+     * Creates the opposite expectation for the value.
+     *
+     * @return self<TOriginalValue, TValue>
+     */
+    public function not(): HigherOrderExpectation
+    {
+        $this->opposite = !$this->opposite;
+
+        return $this;
+    }
+
+    /**
+     * Creates a new Expectation.
+     *
+     * @template TExpectValue
+     *
+     * @param TExpectValue $value
+     *
+     * @return Expectation<TExpectValue>
+     */
+    public function expect(mixed $value): Expectation
+    {
+        return new Expectation($value);
+    }
+
+    /**
+     * Creates a new expectation.
+     *
+     * @template TExpectValue
+     *
+     * @param TExpectValue $value
+     *
+     * @return Expectation<TExpectValue>
+     */
+    public function and(mixed $value): Expectation
+    {
+        return $this->expect($value);
+    }
+
+    /**
+     * Dynamically calls methods on the class with the given arguments.
+     *
+     * @param array<int, mixed> $arguments
+     *
+     * @return self<TOriginalValue, mixed>|self<TOriginalValue, TValue>
+     */
+    public function __call(string $name, array $arguments): self
+    {
+        if (!$this->expectationHasMethod($name)) {
+            /* @phpstan-ignore-next-line */
+            return new self($this->original, $this->getValue()->$name(...$arguments));
+        }
+
+        return $this->performAssertion($name, $arguments);
+    }
+
+    /**
+     * Accesses properties in the value or in the expectation.
+     *
+     * @return self<TOriginalValue, mixed>|self<TOriginalValue, TValue>
+     */
+    public function __get(string $name): self
+    {
+        if ($name === 'not') {
+            return $this->not();
+        }
+
+        if (!$this->expectationHasMethod($name)) {
+            /** @var array<string, mixed>|object $value */
+            $value = $this->getValue();
+
+            return new self($this->original, $this->retrieve($name, $value));
+        }
+
+        return $this->performAssertion($name, []);
+    }
+
+    /**
+     * Determines if the original expectation has the given method name.
+     */
+    private function expectationHasMethod(string $name): bool
+    {
+        return method_exists($this->original, $name) || $this->original::hasMethod($name) || $this->original::hasExtend($name);
+    }
+
+    /**
+     * Retrieve the applicable value based on the current reset condition.
+     *
+     * @return TOriginalValue|TValue
+     */
+    private function getValue(): mixed
+    {
+        // @phpstan-ignore-next-line
+        return $this->shouldReset ? $this->original->value : $this->expectation->value;
+    }
+
+    /**
+     * Performs the given assertion with the current expectation.
+     *
+     * @param array<int, mixed> $arguments
+     *
+     * @return self<TOriginalValue, TValue>
+     */
+    private function performAssertion(string $name, array $arguments): self
+    {
+        /* @phpstan-ignore-next-line */
+        $this->expectation = ($this->opposite ? $this->expectation->not() : $this->expectation)->{$name}(...$arguments);
+
+        $this->opposite    = false;
+        $this->shouldReset = true;
+
+        return $this;
+    }
+}

src/Expectations/OppositeExpectation.php

@@ -0,0 +1,101 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pest\Expectations;
+
+use Pest\Expectation;
+use PHPUnit\Framework\ExpectationFailedException;
+use SebastianBergmann\Exporter\Exporter;
+
+/**
+ * @internal
+ *
+ * @template TValue
+ *
+ * @mixin Expectation<TValue>
+ */
+final class OppositeExpectation
+{
+    /**
+     * Creates a new opposite expectation.
+     *
+     * @param Expectation<TValue> $original
+     */
+    public function __construct(private Expectation $original)
+    {
+    }
+
+    /**
+     * Asserts that the value array not has the provided $keys.
+     *
+     * @param array<int, int|string> $keys
+     *
+     * @return Expectation<TValue>
+     */
+    public function toHaveKeys(array $keys): Expectation
+    {
+        foreach ($keys as $key) {
+            try {
+                $this->original->toHaveKey($key);
+            } catch (ExpectationFailedException) {
+                continue;
+            }
+
+            $this->throwExpectationFailedException('toHaveKey', [$key]);
+        }
+
+        return $this->original;
+    }
+
+    /**
+     * Handle dynamic method calls into the original expectation.
+     *
+     * @param array<int, mixed> $arguments
+     *
+     * @return Expectation<TValue>|Expectation<mixed>|never
+     */
+    public function __call(string $name, array $arguments): Expectation
+    {
+        try {
+            /* @phpstan-ignore-next-line */
+            $this->original->{$name}(...$arguments);
+        } catch (ExpectationFailedException) {
+            return $this->original;
+        }
+
+        $this->throwExpectationFailedException($name, $arguments);
+    }
+
+    /**
+     * Handle dynamic properties gets into the original expectation.
+     *
+     * @return Expectation<TValue>|Expectation<mixed>|never
+     */
+    public function __get(string $name): Expectation
+    {
+        try {
+            $this->original->{$name}; // @phpstan-ignore-line
+        } catch (ExpectationFailedException) {  // @phpstan-ignore-line
+            return $this->original;
+        }
+
+        $this->throwExpectationFailedException($name);
+    }
+
+    /**
+     * Creates a new expectation failed exception with a nice readable message.
+     *
+     * @param array<int, mixed> $arguments
+     *
+     * @return never
+     */
+    private function throwExpectationFailedException(string $name, array $arguments = []): void
+    {
+        $exporter = new Exporter();
+
+        $toString = fn ($argument): string => $exporter->shortenedExport($argument);
+
+        throw new ExpectationFailedException(sprintf('Expecting %s not %s %s.', $toString($this->original->value), strtolower((string) preg_replace('/(?<!\ )[A-Z]/', ' $0', $name)), implode(' ', array_map(fn ($argument): string => $toString($argument), $arguments))));
+    }
+}