merge from master

src/Support/Arr.php

@@ -5,19 +5,14 @@ declare(strict_types=1);
 namespace Pest\Support;
 
 /**
- * Credits: most of this class methods and implementations
- * belongs to the Arr helper of laravel/framework project
- * (https://github.com/laravel/framework).
- *
  * @internal
  */
 final class Arr
 {
     /**
-     * @param array<mixed> $array
-     * @param string|int   $key
+     * Checks if the given array has the given key.
      */
-    public static function has(array $array, $key): bool
+    public static function has(array $array, string|int $key): bool
     {
         $key = (string) $key;
 
@@ -37,13 +32,9 @@ final class Arr
     }
 
     /**
-     * @param array<mixed> $array
-     * @param string|int   $key
-     * @param null         $default
-     *
-     * @return array|mixed|null
+     * Gets the given key value.
      */
-    public static function get(array $array, $key, $default = null)
+    public static function get(array $array, string|int $key, mixed $default = null): mixed
     {
         $key = (string) $key;
 
@@ -51,7 +42,7 @@ final class Arr
             return $array[$key];
         }
 
-        if (strpos($key, '.') === false) {
+        if (!str_contains($key, '.')) {
             return $array[$key] ?? $default;
         }
 

src/Support/Backtrace.php

@@ -26,7 +26,7 @@ final class Backtrace
         $current = null;
 
         foreach (debug_backtrace(self::BACKTRACE_OPTIONS) as $trace) {
-            if (Str::endsWith($trace[self::FILE], (string) realpath('vendor/phpunit/phpunit/src/Util/FileLoader.php'))) {
+            if (Str::endsWith($trace[self::FILE], 'overrides/Runner/TestSuiteLoader.php')) {
                 break;
             }
 

src/Support/ChainableClosure.php

@@ -5,6 +5,7 @@ declare(strict_types=1);
 namespace Pest\Support;
 
 use Closure;
+use Pest\Exceptions\ShouldNotHappen;
 
 /**
  * @internal
@@ -17,10 +18,12 @@ final class ChainableClosure
     public static function from(Closure $closure, Closure $next): Closure
     {
         return function () use ($closure, $next): void {
-            /* @phpstan-ignore-next-line */
-            call_user_func_array(Closure::bind($closure, $this, get_class($this)), func_get_args());
-            /* @phpstan-ignore-next-line */
-            call_user_func_array(Closure::bind($next, $this, get_class($this)), func_get_args());
+            if (!is_object($this)) { // @phpstan-ignore-line
+                throw ShouldNotHappen::fromMessage('$this not bound to chainable closure.');
+            }
+
+            call_user_func_array(Closure::bind($closure, $this, $this::class), func_get_args());
+            call_user_func_array(Closure::bind($next, $this, $this::class), func_get_args());
         };
     }
 
@@ -30,9 +33,7 @@ final class ChainableClosure
     public static function fromStatic(Closure $closure, Closure $next): Closure
     {
         return static function () use ($closure, $next): void {
-            /* @phpstan-ignore-next-line */
             call_user_func_array(Closure::bind($closure, null, self::class), func_get_args());
-            /* @phpstan-ignore-next-line */
             call_user_func_array(Closure::bind($next, null, self::class), func_get_args());
         };
     }

src/Support/Container.php

@@ -13,15 +13,12 @@ use ReflectionParameter;
  */
 final class Container
 {
-    /**
-     * @var self
-     */
-    private static $instance;
+    private static ?Container $instance = null;
 
     /**
      * @var array<string, mixed>
      */
-    private $instances = [];
+    private array $instances = [];
 
     /**
      * Gets a new or already existing container.
@@ -66,7 +63,6 @@ final class Container
      */
     private function build(string $id): object
     {
-        /** @phpstan-ignore-next-line */
         $reflectionClass = new ReflectionClass($id);
 
         if ($reflectionClass->isInstantiable()) {

src/Support/Coverage.php

@@ -30,14 +30,21 @@ final class Coverage
     }
 
     /**
-     * Runs true there is any code
-     * coverage driver available.
+     * Runs true there is any code coverage driver available.
      */
     public static function isAvailable(): bool
     {
         return (new Runtime())->canCollectCodeCoverage();
     }
 
+    /**
+     * If the user is using Xdebug.
+     */
+    public static function usingXdebug(): bool
+    {
+        return (new Runtime())->hasXdebug();
+    }
+
     /**
      * Reports the code coverage report to the
      * console and returns the result in float.
@@ -45,6 +52,14 @@ final class Coverage
     public static function report(OutputInterface $output): float
     {
         if (!file_exists($reportPath = self::getPath())) {
+            if (self::usingXdebug()) {
+                $output->writeln(
+                    "  <fg=black;bg=yellow;options=bold> WARN </> Unable to get coverage using Xdebug. Did you set <href=https://xdebug.org/docs/code_coverage#mode>Xdebug's coverage mode</>?</>",
+                );
+
+                return 0.0;
+            }
+
             throw ShouldNotHappen::fromMessage(sprintf('Coverage not found in path: %s.', $reportPath));
         }
 
@@ -147,7 +162,7 @@ final class Coverage
 
             $lastKey = count($array) - 1;
 
-            if (array_key_exists($lastKey, $array) && strpos($array[$lastKey], '..') !== false) {
+            if (array_key_exists($lastKey, $array) && str_contains($array[$lastKey], '..')) {
                 [$from]          = explode('..', $array[$lastKey]);
                 $array[$lastKey] = $line > $from ? sprintf('%s..%s', $from, $line) : sprintf('%s..%s', $line, $from);
 

src/Support/Extendable.php

@@ -8,19 +8,13 @@ use Closure;
 
 final class Extendable
 {
-    /**
-     * The extendable class.
-     *
-     * @var string
-     */
-    private $extendableClass;
-
     /**
      * Creates a new extendable instance.
      */
-    public function __construct(string $extendableClass)
-    {
-        $this->extendableClass = $extendableClass;
+    public function __construct(
+        private string $extendableClass
+    ) {
+        // ..
     }
 
     /**

src/Support/HigherOrderCallables.php

@@ -6,8 +6,6 @@ namespace Pest\Support;
 
 use Closure;
 use Pest\Expectation;
-use Pest\PendingObjects\TestCall;
-use PHPUnit\Framework\TestCase;
 
 /**
  * @internal
@@ -15,13 +13,11 @@ use PHPUnit\Framework\TestCase;
 final class HigherOrderCallables
 {
     /**
-     * @var object
+     * Creates a new Higher Order Callables instances.
      */
-    private $target;
-
-    public function __construct(object $target)
+    public function __construct(private object $target)
     {
-        $this->target = $target;
+        // ..
     }
 
     /**
@@ -29,11 +25,11 @@ final class HigherOrderCallables
      *
      * Create a new expectation. Callable values will be executed prior to returning the new expectation.
      *
-     * @param callable|TValue $value
+     * @param (callable():TValue)|TValue $value
      *
      * @return Expectation<TValue>
      */
-    public function expect($value)
+    public function expect(mixed $value): Expectation
     {
         return new Expectation($value instanceof Closure ? Reflection::bindCallableWithData($value) : $value);
     }
@@ -47,17 +43,15 @@ final class HigherOrderCallables
      *
      * @return Expectation<TValue>
      */
-    public function and($value)
+    public function and(mixed $value)
     {
         return $this->expect($value);
     }
 
     /**
      * Tap into the test case to perform an action and return the test case.
-     *
-     * @return TestCall|TestCase|object
      */
-    public function tap(callable $callable)
+    public function tap(callable $callable): object
     {
         Reflection::bindCallableWithData($callable);
 

src/Support/HigherOrderMessage.php

@@ -15,70 +15,32 @@ final class HigherOrderMessage
 {
     public const UNDEFINED_METHOD = 'Method %s does not exist';
 
-    /**
-     * The filename where the function was originally called.
-     *
-     * @readonly
-     *
-     * @var string
-     */
-    public $filename;
-
-    /**
-     * The line where the function was originally called.
-     *
-     * @readonly
-     *
-     * @var int
-     */
-    public $line;
-
-    /**
-     * The method or property name to access.
-     *
-     * @readonly
-     *
-     * @var string
-     */
-    public $name;
-
-    /**
-     * The arguments.
-     *
-     * @var array<int, mixed>|null
-     *
-     * @readonly
-     */
-    public $arguments;
-
     /**
      * An optional condition that will determine if the message will be executed.
      *
-     * @var callable(): bool|null
+     * @var (Closure(): bool)|null
      */
-    public $condition = null;
+    public ?Closure $condition = null;
 
     /**
      * Creates a new higher order message.
      *
-     * @param array<int, mixed>|null $arguments
+     * @param array<int, mixed> $arguments
      */
-    public function __construct(string $filename, int $line, string $methodName, $arguments)
-    {
-        $this->filename   = $filename;
-        $this->line       = $line;
-        $this->name       = $methodName;
-        $this->arguments  = $arguments;
+    public function __construct(
+        public string $filename,
+        public int $line,
+        public string $name,
+        public ?array $arguments
+    ) {
+        // ..
     }
 
     /**
      * Re-throws the given `$throwable` with the good line and filename.
-     *
-     * @return mixed
      */
-    public function call(object $target)
+    public function call(object $target): mixed
     {
-        /* @phpstan-ignore-next-line */
         if (is_callable($this->condition) && call_user_func(Closure::bind($this->condition, $target)) === false) {
             return $target;
         }
@@ -122,10 +84,8 @@ final class HigherOrderMessage
 
     /**
      * Determines whether or not there exists a higher order callable with the message name.
-     *
-     * @return bool
      */
-    private function hasHigherOrderCallable()
+    private function hasHigherOrderCallable(): bool
     {
         return in_array($this->name, get_class_methods(HigherOrderCallables::class), true);
     }
@@ -133,7 +93,7 @@ final class HigherOrderMessage
     private static function getUndefinedMethodMessage(object $target, string $methodName): string
     {
         if (\PHP_MAJOR_VERSION >= 8) {
-            return sprintf(sprintf(self::UNDEFINED_METHOD, sprintf('%s::%s()', get_class($target), $methodName)));
+            return sprintf(sprintf(self::UNDEFINED_METHOD, sprintf('%s::%s()', $target::class, $methodName)));
         }
 
         return sprintf(self::UNDEFINED_METHOD, $methodName);

src/Support/HigherOrderMessageCollection.php

@@ -12,14 +12,14 @@ final class HigherOrderMessageCollection
     /**
      * @var array<int, HigherOrderMessage>
      */
-    private $messages = [];
+    private array $messages = [];
 
     /**
      * Adds a new higher order message to the collection.
      *
      * @param array<int, mixed>|null $arguments
      */
-    public function add(string $filename, int $line, string $name, array $arguments = null): void
+    public function add(string $filename, int $line, string $name, ?array $arguments): void
     {
         $this->messages[] = new HigherOrderMessage($filename, $line, $name, $arguments);
     }
@@ -29,7 +29,7 @@ final class HigherOrderMessageCollection
      *
      * @param array<int, mixed>|null $arguments
      */
-    public function addWhen(callable $condition, string $filename, int $line, string $name, array $arguments = null): void
+    public function addWhen(callable $condition, string $filename, int $line, string $name, ?array $arguments): void
     {
         $this->messages[] = (new HigherOrderMessage($filename, $line, $name, $arguments))->when($condition);
     }
@@ -63,9 +63,7 @@ final class HigherOrderMessageCollection
     {
         return array_reduce(
             $this->messages,
-            static function (int $total, HigherOrderMessage $message) use ($name): int {
-                return $total + (int) ($name === $message->name);
-            },
+            static fn (int $total, HigherOrderMessage $message): int => $total + (int) ($name === $message->name),
             0,
         );
     }

src/Support/HigherOrderTapProxy.php

@@ -13,21 +13,15 @@ use Throwable;
  */
 final class HigherOrderTapProxy
 {
-    private const UNDEFINED_PROPERTY = 'Undefined property: P\\';
-
-    /**
-     * The target being tapped.
-     *
-     * @var TestCase
-     */
-    public $target;
+    private const UNDEFINED_PROPERTY = 'Undefined property: P\\';  // @phpstan-ignore-line
 
     /**
      * Create a new tap proxy instance.
      */
-    public function __construct(TestCase $target)
-    {
-        $this->target = $target;
+    public function __construct(
+        public TestCase $target
+    ) {
+        // ..
     }
 
     /**
@@ -37,8 +31,7 @@ final class HigherOrderTapProxy
      */
     public function __set(string $property, $value): void
     {
-        // @phpstan-ignore-next-line
-        $this->target->{$property} = $value;
+        $this->target->{$property} = $value; // @phpstan-ignore-line
     }
 
     /**
@@ -49,9 +42,8 @@ final class HigherOrderTapProxy
     public function __get(string $property)
     {
         try {
-            // @phpstan-ignore-next-line
-            return $this->target->{$property};
-        } catch (Throwable $throwable) {
+            return $this->target->{$property}; // @phpstan-ignore-line
+        } catch (Throwable $throwable) {  // @phpstan-ignore-line
             Reflection::setPropertyValue($throwable, 'file', Backtrace::file());
             Reflection::setPropertyValue($throwable, 'line', Backtrace::line());
 

src/Support/Reflection.php

@@ -193,9 +193,7 @@ final class Reflection
             }
 
             $arguments[$parameter->getName()] = implode('|', array_map(
-                static function (ReflectionNamedType $type): string {
-                    return $type->getName();
-                },
+                static fn (ReflectionNamedType $type): string => $type->getName(),
                 ($types instanceof ReflectionNamedType)
                     ? [$types] // NOTE: normalize as list of to handle unions
                     : $types->getTypes(),

src/Support/Str.php

@@ -33,7 +33,7 @@ final class Str
      */
     public static function startsWith(string $target, string $search): bool
     {
-        return substr($target, 0, strlen($search)) === $search;
+        return str_starts_with($target, $search);
     }
 
     /**
@@ -48,4 +48,14 @@ final class Str
 
         return substr($target, -$length) === $search;
     }
+
+    /**
+     * Makes the given string evaluable by an `eval`.
+     */
+    public static function evaluable(string $code): string
+    {
+        $code = str_replace(' ', '_', $code);
+
+        return (string) preg_replace('/[^A-Z_a-z0-9\\\\]/', '', $code);
+    }
 }