From 7ff64540a64ec8bda987dab2501f0dc6165dae2f Mon Sep 17 00:00:00 2001 From: luke Date: Wed, 16 Jun 2021 20:48:23 +0100 Subject: [PATCH 1/8] Adds nested Higher Order Expectations. --- src/Concerns/Extendable.php | 4 +- src/Concerns/RetrievesValues.php | 29 +++++++ src/Expectation.php | 26 +++++- src/HigherOrderExpectation.php | 79 ++++++++----------- tests/.snapshots/success.txt | 5 +- tests/Features/Expect/HigherOrder/methods.php | 13 +++ .../HigherOrder/methodsAndProperties.php | 15 ++++ .../Expect/HigherOrder/properties.php | 10 +++ 8 files changed, 128 insertions(+), 53 deletions(-) create mode 100644 src/Concerns/RetrievesValues.php diff --git a/src/Concerns/Extendable.php b/src/Concerns/Extendable.php index 36c39243..ee87f9ab 100644 --- a/src/Concerns/Extendable.php +++ b/src/Concerns/Extendable.php @@ -4,8 +4,8 @@ declare(strict_types=1); namespace Pest\Concerns; +use BadMethodCallException; use Closure; -use Pest\HigherOrderExpectation; /** * @internal @@ -43,7 +43,7 @@ trait Extendable public function __call(string $method, array $parameters) { if (!static::hasExtend($method)) { - return new HigherOrderExpectation($this, $method, $parameters); + throw new BadMethodCallException("$method is not a callable method name."); } /** @var Closure $extend */ diff --git a/src/Concerns/RetrievesValues.php b/src/Concerns/RetrievesValues.php new file mode 100644 index 00000000..c38f5abd --- /dev/null +++ b/src/Concerns/RetrievesValues.php @@ -0,0 +1,29 @@ +|object $value + * @param mixed $default + * + * @return mixed + */ + private function retrieve(string $key, $value, $default = null) + { + if (is_array($value)) { + return $value[$key] ?? $default; + } + + // @phpstan-ignore-next-line + return $value->$key ?? $default; + } +} diff --git a/src/Expectation.php b/src/Expectation.php index e35acc5f..11d7c579 100644 --- a/src/Expectation.php +++ b/src/Expectation.php @@ -6,6 +6,7 @@ namespace Pest; use BadMethodCallException; use Pest\Concerns\Extendable; +use Pest\Concerns\RetrievesValues; use PHPUnit\Framework\Assert; use PHPUnit\Framework\Constraint\Constraint; use SebastianBergmann\Exporter\Exporter; @@ -18,7 +19,10 @@ use SebastianBergmann\Exporter\Exporter; */ final class Expectation { - use Extendable; + use Extendable { + __call as __extendsCall; + } + use RetrievesValues; /** * The expectation value. @@ -696,6 +700,24 @@ final class Expectation return $this->exporter->export($value); } + /** + * Dynamically handle calls to the class or + * creates a new higher order expectation. + * + * @param array $parameters + * + * @return mixed + */ + public function __call(string $method, array $parameters) + { + if (!static::hasExtend($method)) { + /* @phpstan-ignore-next-line */ + return new HigherOrderExpectation($this, $this->value->$method(...$parameters)); + } + + return $this->__extendsCall($method, $parameters); + } + /** * Dynamically calls methods on the class without any arguments * or creates a new higher order expectation. @@ -705,7 +727,7 @@ final class Expectation public function __get(string $name) { if (!method_exists($this, $name) && !static::hasExtend($name)) { - return new HigherOrderExpectation($this, $name); + return new HigherOrderExpectation($this, $this->retrieve($name, $this->value)); } /* @phpstan-ignore-next-line */ diff --git a/src/HigherOrderExpectation.php b/src/HigherOrderExpectation.php index 90044d6a..d2710ecc 100644 --- a/src/HigherOrderExpectation.php +++ b/src/HigherOrderExpectation.php @@ -5,6 +5,7 @@ declare(strict_types=1); namespace Pest; use Pest\Concerns\Expectable; +use Pest\Concerns\RetrievesValues; /** * @internal @@ -14,6 +15,7 @@ use Pest\Concerns\Expectable; final class HigherOrderExpectation { use Expectable; + use RetrievesValues; /** * @var Expectation @@ -30,6 +32,11 @@ final class HigherOrderExpectation */ private $opposite = false; + /** + * @var bool + */ + private $shouldReset = false; + /** * @var string */ @@ -38,45 +45,12 @@ final class HigherOrderExpectation /** * Creates a new higher order expectation. * - * @param array|null $parameters - * @phpstan-ignore-next-line + * @param mixed $value */ - public function __construct(Expectation $original, string $name, ?array $parameters = null) + public function __construct(Expectation $original, $value) { - $this->original = $original; - $this->name = $name; - - $this->expectation = $this->expect( - is_null($parameters) ? $this->getPropertyValue() : $this->getMethodValue($parameters) - ); - } - - /** - * Retrieves the property value from the original expectation. - * - * @return mixed - */ - private function getPropertyValue() - { - if (is_array($this->original->value)) { - return $this->original->value[$this->name]; - } - - // @phpstan-ignore-next-line - return $this->original->value->{$this->name}; - } - - /** - * Retrieves the value of the method from the original expectation. - * - * @param array $arguments - * - * @return mixed - */ - private function getMethodValue(array $arguments) - { - // @phpstan-ignore-next-line - return $this->original->value->{$this->name}(...$arguments); + $this->original = $original; + $this->expectation = $this->expect($value); } /** @@ -96,8 +70,9 @@ final class HigherOrderExpectation */ public function __call(string $name, array $arguments): self { - if (!$this->originalHasMethod($name)) { - return new self($this->original, $name, $arguments); + if (!$this->expectationHasMethod($name)) { + /* @phpstan-ignore-next-line */ + return new self($this->original, $this->getValue()->$name(...$arguments)); } return $this->performAssertion($name, $arguments); @@ -112,8 +87,8 @@ final class HigherOrderExpectation return $this->not(); } - if (!$this->originalHasMethod($name)) { - return new self($this->original, $name); + if (!$this->expectationHasMethod($name)) { + return new self($this->original, $this->retrieve($name, $this->getValue())); } return $this->performAssertion($name, []); @@ -122,11 +97,21 @@ final class HigherOrderExpectation /** * Determines if the original expectation has the given method name. */ - private function originalHasMethod(string $name): bool + private function expectationHasMethod(string $name): bool { return method_exists($this->original, $name) || $this->original::hasExtend($name); } + /** + * Retrieve the applicable value based on the current reset condition. + * + * @return mixed + */ + private function getValue() + { + return $this->shouldReset ? $this->original->value : $this->expectation->value; + } + /** * Performs the given assertion with the current expectation. * @@ -134,13 +119,11 @@ final class HigherOrderExpectation */ private function performAssertion(string $name, array $arguments): self { - $expectation = $this->opposite - ? $this->expectation->not() - : $this->expectation; + /* @phpstan-ignore-next-line */ + $this->expectation = ($this->opposite ? $this->expectation->not() : $this->expectation)->{$name}(...$arguments); - $this->expectation = $expectation->{$name}(...$arguments); // @phpstan-ignore-line - - $this->opposite = false; + $this->opposite = false; + $this->shouldReset = true; return $this; } diff --git a/tests/.snapshots/success.txt b/tests/.snapshots/success.txt index 9f57d4fa..e6496067 100644 --- a/tests/.snapshots/success.txt +++ b/tests/.snapshots/success.txt @@ -111,9 +111,11 @@ ✓ it works inside of each ✓ it works with sequence ✓ it can compose complex expectations + ✓ it can handle nested method calls PASS Tests\Features\Expect\HigherOrder\methodsAndProperties ✓ it can access methods and properties + ✓ it can handle nested methods and properties PASS Tests\Features\Expect\HigherOrder\properties ✓ it allows properties to be accessed from the value @@ -124,6 +126,7 @@ ✓ it works with sequence ✓ it can compose complex expectations ✓ it works with objects + ✓ it works with nested properties PASS Tests\Features\Expect\each ✓ an exception is thrown if the the type is not iterable @@ -554,5 +557,5 @@ ✓ it is a test ✓ it uses correct parent class - Tests: 4 incompleted, 7 skipped, 340 passed + Tests: 4 incompleted, 7 skipped, 343 passed \ No newline at end of file diff --git a/tests/Features/Expect/HigherOrder/methods.php b/tests/Features/Expect/HigherOrder/methods.php index 7f340f4a..66329b73 100644 --- a/tests/Features/Expect/HigherOrder/methods.php +++ b/tests/Features/Expect/HigherOrder/methods.php @@ -59,6 +59,14 @@ it('can compose complex expectations', function () { ); }); +it('can handle nested method calls', function () { + expect(new HasMethods()) + ->newInstance()->newInstance()->name()->toEqual('Has Methods')->toBeString() + ->newInstance()->name()->toEqual('Has Methods')->not->toBeInt + ->name()->toEqual('Has Methods') + ->books()->each->toBeArray(); +}); + class HasMethods { public function name() @@ -97,4 +105,9 @@ class HasMethods ], ]; } + + public function newInstance() + { + return new static(); + } } diff --git a/tests/Features/Expect/HigherOrder/methodsAndProperties.php b/tests/Features/Expect/HigherOrder/methodsAndProperties.php index 34ce09b4..f75f698a 100644 --- a/tests/Features/Expect/HigherOrder/methodsAndProperties.php +++ b/tests/Features/Expect/HigherOrder/methodsAndProperties.php @@ -14,10 +14,20 @@ it('can access methods and properties', function () { ); }); +it('can handle nested methods and properties', function () { + expect(new HasMethodsAndProperties()) + ->meta->foo->bar->toBeString()->toEqual('baz')->not->toBeInt + ->newInstance()->meta->foo->toBeArray() + ->newInstance()->multiply(2, 2)->toEqual(4)->not->toEqual(5) + ->newInstance()->books()->toBeArray(); +}); + class HasMethodsAndProperties { public $name = 'Has Methods and Properties'; + public $meta = ['foo' => ['bar' => 'baz']]; + public $posts = [ [ 'is_published' => true, @@ -47,4 +57,9 @@ class HasMethodsAndProperties { return $x * $y; } + + public function newInstance() + { + return new static(); + } } diff --git a/tests/Features/Expect/HigherOrder/properties.php b/tests/Features/Expect/HigherOrder/properties.php index c73e3d03..154d17e4 100644 --- a/tests/Features/Expect/HigherOrder/properties.php +++ b/tests/Features/Expect/HigherOrder/properties.php @@ -58,6 +58,12 @@ it('works with objects', function () { ); }); +it('works with nested properties', function () { + expect(new HasProperties()) + ->nested->foo->bar->toBeString()->toEqual('baz') + ->posts->toBeArray()->toHaveCount(2); +}); + class HasProperties { public $name = 'foo'; @@ -72,4 +78,8 @@ class HasProperties 'title' => 'Bar', ], ]; + + public $nested = [ + 'foo' => ['bar' => 'baz'], + ]; } From d96a2485b67a265c773c42eee03154324756a65b Mon Sep 17 00:00:00 2001 From: luke Date: Thu, 17 Jun 2021 00:18:12 +0100 Subject: [PATCH 2/8] Updates snapshot --- tests/.snapshots/success.txt | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/tests/.snapshots/success.txt b/tests/.snapshots/success.txt index 05d2cc3a..75333e28 100644 --- a/tests/.snapshots/success.txt +++ b/tests/.snapshots/success.txt @@ -111,9 +111,11 @@ ✓ it works inside of each ✓ it works with sequence ✓ it can compose complex expectations + ✓ it can handle nested method calls PASS Tests\Features\Expect\HigherOrder\methodsAndProperties ✓ it can access methods and properties + ✓ it can handle nested methods and properties PASS Tests\Features\Expect\HigherOrder\properties ✓ it allows properties to be accessed from the value @@ -124,6 +126,7 @@ ✓ it works with sequence ✓ it can compose complex expectations ✓ it works with objects + ✓ it works with nested properties PASS Tests\Features\Expect\each ✓ an exception is thrown if the the type is not iterable @@ -569,5 +572,5 @@ ✓ it is a test ✓ it uses correct parent class - Tests: 4 incompleted, 7 skipped, 355 passed + Tests: 4 incompleted, 7 skipped, 358 passed \ No newline at end of file From 3d7b6426a1ea9be0660b3f369ab2ab60b1ef205a Mon Sep 17 00:00:00 2001 From: luke Date: Fri, 18 Jun 2021 21:49:38 +0100 Subject: [PATCH 3/8] Updates snapshots --- tests/.snapshots/success.txt | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/tests/.snapshots/success.txt b/tests/.snapshots/success.txt index 422bfc2f..ebe6ffe9 100644 --- a/tests/.snapshots/success.txt +++ b/tests/.snapshots/success.txt @@ -111,9 +111,11 @@ ✓ it works inside of each ✓ it works with sequence ✓ it can compose complex expectations + ✓ it can handle nested method calls PASS Tests\Features\Expect\HigherOrder\methodsAndProperties ✓ it can access methods and properties + ✓ it can handle nested methods and properties PASS Tests\Features\Expect\HigherOrder\properties ✓ it allows properties to be accessed from the value @@ -124,6 +126,7 @@ ✓ it works with sequence ✓ it can compose complex expectations ✓ it works with objects + ✓ it works with nested properties PASS Tests\Features\Expect\each ✓ an exception is thrown if the the type is not iterable @@ -573,5 +576,5 @@ ✓ it is a test ✓ it uses correct parent class - Tests: 4 incompleted, 7 skipped, 357 passed + Tests: 4 incompleted, 7 skipped, 360 passed \ No newline at end of file From 4b55de27f1f3306165a37a5329c42761321dcde0 Mon Sep 17 00:00:00 2001 From: luke Date: Fri, 18 Jun 2021 21:52:24 +0100 Subject: [PATCH 4/8] Adds generics --- src/Concerns/RetrievesValues.php | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/Concerns/RetrievesValues.php b/src/Concerns/RetrievesValues.php index c38f5abd..e0c93bbc 100644 --- a/src/Concerns/RetrievesValues.php +++ b/src/Concerns/RetrievesValues.php @@ -10,12 +10,14 @@ namespace Pest\Concerns; trait RetrievesValues { /** + * @template TValue + * * Safely retrieve the value at the given key from an object or array. * - * @param array|object $value - * @param mixed $default + * @param array|object $value + * @param TValue|null $default * - * @return mixed + * @return TValue|null */ private function retrieve(string $key, $value, $default = null) { From 27de6106ab343bcea5ae9261a4d960ef31ba214b Mon Sep 17 00:00:00 2001 From: luke Date: Fri, 18 Jun 2021 22:01:16 +0100 Subject: [PATCH 5/8] Adds type hinting --- src/Concerns/Expectable.php | 5 ++++- src/Concerns/RetrievesValues.php | 8 ++++---- src/Expectation.php | 9 ++++++--- src/HigherOrderExpectation.php | 4 ++-- 4 files changed, 16 insertions(+), 10 deletions(-) diff --git a/src/Concerns/Expectable.php b/src/Concerns/Expectable.php index 371bf8d4..5087572f 100644 --- a/src/Concerns/Expectable.php +++ b/src/Concerns/Expectable.php @@ -12,9 +12,12 @@ use Pest\Expectation; trait Expectable { /** + * @template TValue + * * Creates a new expectation. * - * @param mixed $value + * @param TValue $value + * @return Expectation */ public function expect($value): Expectation { diff --git a/src/Concerns/RetrievesValues.php b/src/Concerns/RetrievesValues.php index e0c93bbc..1d789e9d 100644 --- a/src/Concerns/RetrievesValues.php +++ b/src/Concerns/RetrievesValues.php @@ -10,14 +10,14 @@ namespace Pest\Concerns; trait RetrievesValues { /** - * @template TValue + * @template TRetrievableValue * * Safely retrieve the value at the given key from an object or array. * - * @param array|object $value - * @param TValue|null $default + * @param array|object $value + * @param TRetrievableValue|null $default * - * @return TValue|null + * @return TRetrievableValue|null */ private function retrieve(string $key, $value, $default = null) { diff --git a/src/Expectation.php b/src/Expectation.php index 73b78508..d9519f00 100644 --- a/src/Expectation.php +++ b/src/Expectation.php @@ -16,6 +16,8 @@ use SebastianBergmann\Exporter\Exporter; /** * @internal * + * @template TValue + * * @property Expectation $not Creates the opposite expectation. * @property Each $each Creates an expectation on each element on the traversable value. */ @@ -47,7 +49,7 @@ final class Expectation /** * Creates a new expectation. * - * @param mixed $value + * @param TValue $value */ public function __construct($value) { @@ -57,7 +59,8 @@ final class Expectation /** * Creates a new expectation. * - * @param mixed $value + * @param TValue $value + * @return Expectation */ public function and($value): Expectation { @@ -722,7 +725,7 @@ final class Expectation * * @param array $parameters * - * @return mixed + * @return HigherOrderExpectation|mixed */ public function __call(string $method, array $parameters) { diff --git a/src/HigherOrderExpectation.php b/src/HigherOrderExpectation.php index d2710ecc..8d29aa3d 100644 --- a/src/HigherOrderExpectation.php +++ b/src/HigherOrderExpectation.php @@ -66,7 +66,7 @@ final class HigherOrderExpectation /** * Dynamically calls methods on the class with the given arguments. * - * @param array $arguments + * @param array $arguments */ public function __call(string $name, array $arguments): self { @@ -115,7 +115,7 @@ final class HigherOrderExpectation /** * Performs the given assertion with the current expectation. * - * @param array $arguments + * @param array $arguments */ private function performAssertion(string $name, array $arguments): self { From 99bcf98617efd775dd58620a069053d964e8ec14 Mon Sep 17 00:00:00 2001 From: luke Date: Fri, 18 Jun 2021 22:03:01 +0100 Subject: [PATCH 6/8] Rebuilds snapshots --- tests/.snapshots/success.txt | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/tests/.snapshots/success.txt b/tests/.snapshots/success.txt index 3dd36cae..e7ecc1a0 100644 --- a/tests/.snapshots/success.txt +++ b/tests/.snapshots/success.txt @@ -111,9 +111,11 @@ ✓ it works inside of each ✓ it works with sequence ✓ it can compose complex expectations + ✓ it can handle nested method calls PASS Tests\Features\Expect\HigherOrder\methodsAndProperties ✓ it can access methods and properties + ✓ it can handle nested methods and properties PASS Tests\Features\Expect\HigherOrder\properties ✓ it allows properties to be accessed from the value @@ -124,6 +126,7 @@ ✓ it works with sequence ✓ it can compose complex expectations ✓ it works with objects + ✓ it works with nested properties PASS Tests\Features\Expect\each ✓ an exception is thrown if the the type is not iterable @@ -575,5 +578,5 @@ ✓ it is a test ✓ it uses correct parent class - Tests: 4 incompleted, 7 skipped, 359 passed + Tests: 4 incompleted, 7 skipped, 362 passed \ No newline at end of file From 3a20696da4a3e1e2a352e93844a7394a4af7a53b Mon Sep 17 00:00:00 2001 From: luke Date: Fri, 18 Jun 2021 22:03:51 +0100 Subject: [PATCH 7/8] CS --- src/Concerns/Expectable.php | 1 + src/Concerns/RetrievesValues.php | 2 +- src/Expectation.php | 1 + src/HigherOrderExpectation.php | 4 ---- 4 files changed, 3 insertions(+), 5 deletions(-) diff --git a/src/Concerns/Expectable.php b/src/Concerns/Expectable.php index 5087572f..981e443d 100644 --- a/src/Concerns/Expectable.php +++ b/src/Concerns/Expectable.php @@ -17,6 +17,7 @@ trait Expectable * Creates a new expectation. * * @param TValue $value + * * @return Expectation */ public function expect($value): Expectation diff --git a/src/Concerns/RetrievesValues.php b/src/Concerns/RetrievesValues.php index 1d789e9d..a8d832b1 100644 --- a/src/Concerns/RetrievesValues.php +++ b/src/Concerns/RetrievesValues.php @@ -15,7 +15,7 @@ trait RetrievesValues * Safely retrieve the value at the given key from an object or array. * * @param array|object $value - * @param TRetrievableValue|null $default + * @param TRetrievableValue|null $default * * @return TRetrievableValue|null */ diff --git a/src/Expectation.php b/src/Expectation.php index 6477b3d6..32299dc2 100644 --- a/src/Expectation.php +++ b/src/Expectation.php @@ -60,6 +60,7 @@ final class Expectation * Creates a new expectation. * * @param TValue $value + * * @return Expectation */ public function and($value): Expectation diff --git a/src/HigherOrderExpectation.php b/src/HigherOrderExpectation.php index 8d29aa3d..14c8504c 100644 --- a/src/HigherOrderExpectation.php +++ b/src/HigherOrderExpectation.php @@ -65,8 +65,6 @@ final class HigherOrderExpectation /** * Dynamically calls methods on the class with the given arguments. - * - * @param array $arguments */ public function __call(string $name, array $arguments): self { @@ -114,8 +112,6 @@ final class HigherOrderExpectation /** * Performs the given assertion with the current expectation. - * - * @param array $arguments */ private function performAssertion(string $name, array $arguments): self { From 22a1aac84a08a863d26adefe285b7c97da76a016 Mon Sep 17 00:00:00 2001 From: luke Date: Fri, 18 Jun 2021 22:08:47 +0100 Subject: [PATCH 8/8] Fixes types --- src/Expectation.php | 4 ++-- src/HigherOrderExpectation.php | 4 ++++ 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/src/Expectation.php b/src/Expectation.php index 32299dc2..e41f21d0 100644 --- a/src/Expectation.php +++ b/src/Expectation.php @@ -138,9 +138,9 @@ final class Expectation /** * Allows you to specify a sequential set of expectations for each item in a iterable "value". * - * @template TValue + * @template TSequenceValue * - * @param callable(self, self): void|TValue ...$callbacks + * @param callable(self, self): void|TSequenceValue ...$callbacks */ public function sequence(...$callbacks): Expectation { diff --git a/src/HigherOrderExpectation.php b/src/HigherOrderExpectation.php index 14c8504c..6e2ed23f 100644 --- a/src/HigherOrderExpectation.php +++ b/src/HigherOrderExpectation.php @@ -65,6 +65,8 @@ final class HigherOrderExpectation /** * Dynamically calls methods on the class with the given arguments. + * + * @param array $arguments */ public function __call(string $name, array $arguments): self { @@ -112,6 +114,8 @@ final class HigherOrderExpectation /** * Performs the given assertion with the current expectation. + * + * @param array $arguments */ private function performAssertion(string $name, array $arguments): self {