release: v2.11.0

Add `toBeInvokable` arch expectation

CHANGELOG.md

@@ -2,6 +2,28 @@
 
 ## Unreleased
 
+## [v2.10.1 (2023-07-31)](https://github.com/pestphp/pest/compare/v2.10.0...v2.10.1)
+
+### Fixed
+
+- `not->toHaveSuffix` and `toHavePrefix` expectations ([#888](https://github.com/pestphp/pest/pull/888))
+
+## [v2.10.0 (2023-07-31)](https://github.com/pestphp/pest/compare/v2.9.5...v2.10.0)
+
+### Added
+
+- `repeat` feature ([f3f35a2](https://github.com/pestphp/pest/commit/f3f35a2ed119f63eefd323a8c66d3387e908df3f))
+
+### Fixed
+
+- `-v` option ([86a6b32](https://github.com/pestphp/pest/commit/86a6b3271518742dc39761228687a5107551d279))
+
+## [v2.9.5 (2023-07-22)](https://github.com/pestphp/pest/compare/v2.9.4...v2.9.5)
+
+### Fixed
+
+- Assertions count on arch expectations ([632ffc2](https://github.com/pestphp/pest/commit/632ffc2f8e1fe45f739b12b818426ae14700079e))
+
 ## [v2.9.4 (2023-07-22)](https://github.com/pestphp/pest/compare/v2.9.3...v2.9.4)
 
 ### Fixed

bin/worker.php

@@ -46,6 +46,7 @@ $bootPest = (static function (): void {
     ];
 
     foreach ($composerAutoloadFiles as $file) {
+
         if (file_exists($file)) {
             require_once $file;
             define('PHPUNIT_COMPOSER_INSTALL', $file);

composer.json

@@ -42,6 +42,7 @@
         "psr-4": {
             "Tests\\Fixtures\\Covers\\": "tests/Fixtures/Covers",
             "Tests\\Fixtures\\Inheritance\\": "tests/Fixtures/Inheritance",
+            "Tests\\Fixtures\\Arch\\": "tests/Fixtures/Arch",
             "Tests\\": "tests/PHPUnit/"
         },
         "files": [

src/Expectation.php

@@ -430,7 +430,7 @@ final class Expectation
     {
         return Targeted::make(
             $this,
-            fn (ObjectDescription $object): bool => ! enum_exists($object->name) && $object->reflectionClass->isReadOnly(),
+            fn (ObjectDescription $object): bool => ! enum_exists($object->name) && $object->reflectionClass->isReadOnly() && assert(true), // @phpstan-ignore-line
             'to be readonly',
             FileLineFinder::where(fn (string $line): bool => str_contains($line, 'class')),
         );
@@ -595,12 +595,12 @@ final class Expectation
     /**
      * Asserts that the given expectation target to have the given suffix.
      */
-    public function toHavePrefix(string $suffix): ArchExpectation
+    public function toHavePrefix(string $prefix): ArchExpectation
     {
         return Targeted::make(
             $this,
-            fn (ObjectDescription $object): bool => str_starts_with($object->reflectionClass->getName(), $suffix),
+            fn (ObjectDescription $object): bool => str_starts_with($object->reflectionClass->getShortName(), $prefix),
-            "to have prefix '{$suffix}'",
+            "to have prefix '{$prefix}'",
             FileLineFinder::where(fn (string $line): bool => str_contains($line, 'class')),
         );
     }
@@ -693,4 +693,17 @@ final class Expectation
     {
         return ToBeUsedInNothing::make($this);
     }
+
+    /**
+     * Asserts that the given expectation dependency is an invokable class.
+     */
+    public function toBeInvokable(): ArchExpectation
+    {
+        return Targeted::make(
+            $this,
+            fn (ObjectDescription $object): bool => $object->reflectionClass->hasMethod('__invoke'),
+            'to be invokable',
+            FileLineFinder::where(fn (string $line): bool => str_contains($line, 'class'))
+        );
+    }
 }

src/Expectations/OppositeExpectation.php

@@ -109,7 +109,7 @@ final class OppositeExpectation
     {
         return Targeted::make(
             $this->original,
-            fn (ObjectDescription $object): bool => ! enum_exists($object->name) && ! $object->reflectionClass->isReadOnly(),
+            fn (ObjectDescription $object): bool => ! enum_exists($object->name) && ! $object->reflectionClass->isReadOnly() && assert(true), // @phpstan-ignore-line
             'not to be readonly',
             FileLineFinder::where(fn (string $line): bool => str_contains($line, 'class')),
         );
@@ -291,17 +291,27 @@ final class OppositeExpectation
     /**
      * Not supported.
      */
-    public function toHavePrefix(string $suffix): never
+    public function toHavePrefix(string $prefix): ArchExpectation
     {
-        throw InvalidExpectation::fromMethods(['not', 'toHavePrefix']);
+        return Targeted::make(
+            $this->original,
+            fn (ObjectDescription $object): bool => ! str_starts_with($object->reflectionClass->getShortName(), $prefix),
+            "not to have prefix '{$prefix}'",
+            FileLineFinder::where(fn (string $line): bool => str_contains($line, 'class')),
+        );
     }
 
     /**
      * Not supported.
      */
-    public function toHaveSuffix(string $suffix): never
+    public function toHaveSuffix(string $suffix): ArchExpectation
     {
-        throw InvalidExpectation::fromMethods(['not', 'toHaveSuffix']);
+        return Targeted::make(
+            $this->original,
+            fn (ObjectDescription $object): bool => ! str_ends_with($object->reflectionClass->getName(), $suffix),
+            "not to have suffix '{$suffix}'",
+            FileLineFinder::where(fn (string $line): bool => str_contains($line, 'class')),
+        );
     }
 
     /**
@@ -355,6 +365,19 @@ final class OppositeExpectation
         throw InvalidExpectation::fromMethods(['not', 'toBeUsedInNothing']);
     }
 
+    /**
+     * Asserts that the given expectation dependency is not an invokable class.
+     */
+    public function toBeInvokable(): ArchExpectation
+    {
+        return Targeted::make(
+            $this->original,
+            fn (ObjectDescription $object): bool => ! $object->reflectionClass->hasMethod('__invoke'),
+            'to not be invokable',
+            FileLineFinder::where(fn (string $line): bool => str_contains($line, 'class'))
+        );
+    }
+
     /**
      * Handle dynamic method calls into the original expectation.
      *

src/Pest.php

@@ -6,7 +6,7 @@ namespace Pest;
 
 function version(): string
 {
-    return '2.10.0';
+    return '2.11.0';
 }
 
 function testDirectory(string $file = ''): string

tests/.pest/snapshots/Visual/Help/visual_snapshot_of_help_command_output.snap

@@ -1,5 +1,5 @@
 
-  Pest Testing Framework 2.10.0.  
+  Pest Testing Framework 2.11.0.  
 
   USAGE: pest <file> [options]  
 

tests/.pest/snapshots/Visual/Version/visual_snapshot_of_help_command_output.snap

@@ -1,3 +1,3 @@
 
-  Pest Testing Framework 2.10.0.  
+  Pest Testing Framework 2.11.0.  
 

tests/.snapshots/success.txt

@@ -411,6 +411,14 @@
   ✓ failures with custom message
   ✓ not failures
 
+   PASS  Tests\Features\Expect\toBeInvokable
+  ✓ class is invokable
+  ✓ opposite class is invokable
+  ✓ class is invokable via a parent class
+  ✓ class is invokable via a trait
+  ✓ failure when the class is not invokable
+  ✓ class is not invokable
+
    PASS  Tests\Features\Expect\toBeIterable
   ✓ pass
   ✓ failures
@@ -629,6 +637,12 @@
   ✓ failures with custom message
   ✓ not failures
 
+   PASS  Tests\Features\Expect\toHavePrefix
+  ✓ missing prefix
+  ✓ has prefix
+  ✓ opposite missing prefix
+  ✓ opposite has prefix
+
    PASS  Tests\Features\Expect\toHaveProperties
   ✓ pass
   ✓ failures
@@ -642,6 +656,12 @@
   ✓ failures with message and Any matcher
   ✓ not failures
 
+   PASS  Tests\Features\Expect\toHaveSuffix
+  ✓ missing suffix
+  ✓ has suffix
+  ✓ opposite missing suffix
+  ✓ opposite has suffix
+
    PASS  Tests\Features\Expect\toMatch
   ✓ pass
   ✓ failures
@@ -1174,4 +1194,4 @@
    WARN  Tests\Visual\Version
   - visual snapshot of help command output
 
-  Tests:    2 deprecated, 4 warnings, 5 incomplete, 2 notices, 13 todos, 19 skipped, 830 passed (1927 assertions)
+  Tests:    2 deprecated, 4 warnings, 5 incomplete, 2 notices, 13 todos, 19 skipped, 844 passed (1947 assertions)

tests/Features/Expect/toBeInvokable.php

@@ -0,0 +1,29 @@
+<?php
+
+use Pest\Arch\Exceptions\ArchExpectationFailedException;
+
+test('class is invokable')
+    ->expect('Tests\\Fixtures\\Arch\\ToBeInvokable\\IsInvokable\\InvokableClass')
+    ->toBeInvokable();
+
+test('opposite class is invokable')
+    ->throws(ArchExpectationFailedException::class)
+    ->expect('Tests\\Fixtures\\Arch\\ToBeInvokable\\IsInvokable\\InvokableClass')
+    ->not->toBeInvokable();
+
+test('class is invokable via a parent class')
+    ->expect('Tests\\Fixtures\\Arch\\ToBeInvokable\\IsInvokable\\InvokableClassViaParent')
+    ->toBeInvokable();
+
+test('class is invokable via a trait')
+    ->expect('Tests\\Fixtures\\Arch\\ToBeInvokable\\IsInvokable\\InvokableClassViaTrait')
+    ->toBeInvokable();
+
+test('failure when the class is not invokable')
+    ->throws(ArchExpectationFailedException::class)
+    ->expect('Tests\\Fixtures\\Arch\\ToBeInvokable\\IsNotInvokable\\IsNotInvokableClass')
+    ->toBeInvokable();
+
+test('class is not invokable')
+    ->expect('Tests\\Fixtures\\Arch\\ToBeInvokable\\IsNotInvokable\\IsNotInvokableClass')
+    ->not->toBeInvokable();

tests/Features/Expect/toHavePrefix.php

@@ -0,0 +1,21 @@
+<?php
+
+use Pest\Arch\Exceptions\ArchExpectationFailedException;
+
+test('missing prefix')
+    ->throws(ArchExpectationFailedException::class)
+    ->expect('Tests\\Fixtures\\Arch\\ToHavePrefix\\HasNoPrefix')
+    ->toHavePrefix('Prefix');
+
+test('has prefix')
+    ->expect('Tests\\Fixtures\\Arch\\ToHavePrefix\\HasPrefix')
+    ->toHavePrefix('Prefix');
+
+test('opposite missing prefix')
+    ->throws(ArchExpectationFailedException::class)
+    ->expect('Tests\\Fixtures\\Arch\\ToHavePrefix\\HasPrefix')
+    ->not->toHavePrefix('Prefix');
+
+test('opposite has prefix')
+    ->expect('Tests\\Fixtures\\Arch\\ToHavePrefix\\HasNoPrefix')
+    ->not->toHavePrefix('Prefix');

tests/Features/Expect/toHaveSuffix.php

@@ -0,0 +1,21 @@
+<?php
+
+use Pest\Arch\Exceptions\ArchExpectationFailedException;
+
+test('missing suffix')
+    ->throws(ArchExpectationFailedException::class)
+    ->expect('Tests\\Fixtures\\Arch\\ToHaveSuffix\\HasNoSuffix')
+    ->toHaveSuffix('Suffix');
+
+test('has suffix')
+    ->expect('Tests\\Fixtures\\Arch\\ToHaveSuffix\\HasSuffix')
+    ->toHaveSuffix('Suffix');
+
+test('opposite missing suffix')
+    ->throws(ArchExpectationFailedException::class)
+    ->expect('Tests\\Fixtures\\Arch\\ToHaveSuffix\\HasSuffix')
+    ->not->toHaveSuffix('Suffix');
+
+test('opposite has suffix')
+    ->expect('Tests\\Fixtures\\Arch\\ToHaveSuffix\\HasNoSuffix')
+    ->not->toHaveSuffix('Suffix');

tests/Fixtures/Arch/ToBeInvokable/IsInvokable/InvokableClass.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Fixtures\Arch\ToBeInvokable\IsInvokable;
+
+class InvokableClass
+{
+    public function __invoke(): void
+    {
+
+    }
+}

tests/Fixtures/Arch/ToBeInvokable/IsInvokable/InvokableClassViaParent.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Fixtures\Arch\ToBeInvokable\IsInvokable;
+
+class InvokableClassViaParent extends ParentInvokableClass
+{
+    //
+}

tests/Fixtures/Arch/ToBeInvokable/IsInvokable/InvokableClassViaTrait.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Fixtures\Arch\ToBeInvokable\IsInvokable;
+
+class InvokableClassViaTrait
+{
+    use InvokableTrait;
+}

tests/Fixtures/Arch/ToBeInvokable/IsInvokable/InvokableTrait.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Fixtures\Arch\ToBeInvokable\IsInvokable;
+
+trait InvokableTrait
+{
+    public function __invoke(): void
+    {
+        //
+    }
+}

tests/Fixtures/Arch/ToBeInvokable/IsInvokable/ParentInvokableClass.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Fixtures\Arch\ToBeInvokable\IsInvokable;
+
+class ParentInvokableClass
+{
+    public function __invoke(): void
+    {
+
+    }
+}

tests/Fixtures/Arch/ToBeInvokable/IsNotInvokable/IsNotInvokableClass.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Fixtures\Arch\ToBeInvokable\IsNotInvokable;
+
+class IsNotInvokableClass
+{
+    public function handle(): void
+    {
+
+    }
+}

tests/Fixtures/Arch/ToHavePrefix/HasNoPrefix/ClassWithout.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Fixtures\Arch\ToHavePrefix\HasNoPrefix;
+
+class ClassWithout
+{
+}

tests/Fixtures/Arch/ToHavePrefix/HasPrefix/PrefixClassWith.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Fixtures\Arch\ToHavePrefix\HasPrefix;
+
+class PrefixClassWith
+{
+}

tests/Fixtures/Arch/ToHaveSuffix/HasNoSuffix/ClassWithout.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Fixtures\Arch\ToHaveSuffix\HasNoSuffix;
+
+class ClassWithout
+{
+}

tests/Fixtures/Arch/ToHaveSuffix/HasSuffix/ClassWithSuffix.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Fixtures\Arch\ToHaveSuffix\HasSuffix;
+
+class ClassWithSuffix
+{
+}

tests/Visual/Parallel.php

@@ -16,7 +16,7 @@ $run = function () {
 
 test('parallel', function () use ($run) {
     expect($run('--exclude-group=integration'))
-        ->toContain('Tests:    1 deprecated, 4 warnings, 5 incomplete, 2 notices, 13 todos, 15 skipped, 819 passed (1912 assertions)')
+        ->toContain('Tests:    1 deprecated, 4 warnings, 5 incomplete, 2 notices, 13 todos, 15 skipped, 833 passed (1932 assertions)')
         ->toContain('Parallel: 3 processes');
 })->skipOnWindows();