Add Assert isInitialized. (#325)

Author: kkevindev

README.md

@@ -97,6 +97,7 @@ Method                                                   | Description
 `object($value, $message = '')`                          | Check that a value is an object
 `objectish($value, $message = '')`                       | Check that a value is an object or a string of a class that exists
 `resource($value, $type = null, $message = '')`          | Check that a value is a resource
+`isInitialized($value, $property, $message = '')`        | Check that a value has an initialized property
 `isCallable($value, $message = '')`                      | Check that a value is a callable
 `isArray($value, $message = '')`                         | Check that a value is an array
 `isIterable($value, $message = '')`                      | Check that a value is an array or a `\Traversable`

bin/generate.php

@@ -12,3 +12,5 @@
 require_once __DIR__.'/../vendor/autoload.php';
 
 file_put_contents(__DIR__.'/../src/Mixin.php', (new MixinGenerator())->generate());
+
+echo "Done.";

bin/src/MixinGenerator.php

@@ -42,6 +42,10 @@ final class MixinGenerator
         'allIsNonEmptyMap',     // not supported by psalm (https://github.com/vimeo/psalm/issues/3444)
     ];
 
+    private array $skipGenerateForMethods = [
+        'isInitialized',
+    ];
+
     /**
      * @psalm-var list<string>
      *
@@ -568,6 +572,10 @@ private function getMethods(ReflectionClass $assert): array
         $staticMethods = $assert->getMethods(ReflectionMethod::IS_STATIC);
 
         foreach ($staticMethods as $staticMethod) {
+            if (in_array($staticMethod->name, $this->skipGenerateForMethods)) {
+                continue;
+            }
+
             $modifiers = $staticMethod->getModifiers();
             if (0 === ($modifiers & ReflectionMethod::IS_PUBLIC)) {
                 continue;

composer.json

@@ -57,6 +57,7 @@
             "composer --working-dir=tools/psalm update",
             "composer --working-dir=tools/roave-bc-check update"
         ],
+        "generate-mixin": "php bin/generate.php",
         "bc-check": "./tools/roave-bc-check/vendor/bin/roave-backward-compatibility-check",
         "cs-check" : "./tools/php-cs-fixer/vendor/bin/php-cs-fixer check",
         "cs-fix": "./tools/php-cs-fixer/vendor/bin/php-cs-fixer fix",

src/Assert.php

@@ -17,6 +17,7 @@
 use Countable;
 use DateTime;
 use DateTimeImmutable;
+use ReflectionProperty;
 use Throwable;
 use Traversable;
 
@@ -302,6 +303,29 @@ public static function resource(mixed $value, ?string $type = null, string $mess
         return $value;
     }
 
+    /**
+     * @psalm-pure
+     *
+     * @psalm-assert object $value
+     *
+     * @throws InvalidArgumentException
+     */
+    public static function isInitialized(mixed $value, string $property, string $message = ''): object
+    {
+        Assert::object($value);
+
+        $reflectionProperty = new ReflectionProperty($value, $property);
+
+        if (!$reflectionProperty->isInitialized($value)) {
+            static::reportInvalidArgument(\sprintf(
+                $message ?: 'Expected property %s to be initialized.',
+                $property,
+            ));
+        }
+
+        return $value;
+    }
+
     /**
      * @psalm-pure
      *

tests/AssertTest.php

@@ -34,6 +34,10 @@
  */
 class AssertTest extends TestCase
 {
+    private const SKIP_MIXIN_ASSERTION_TESTS = array(
+        'isInitialized',
+    );
+
     public static function getResource()
     {
         static $resource;
@@ -116,6 +120,20 @@ public static function getTests(): array
             array('resource', array(self::getResource(), 'stream'), true),
             array('resource', array(self::getResource(), 'other'), false),
             array('resource', array(1), false),
+            array('isInitialized', array(new class {
+                public mixed $a = null;
+            }, 'a'), true),
+            array('isInitialized', array(new class {
+                public mixed $a;
+            }, 'a'), false),
+            array('isInitialized', array(new class {
+                public mixed $a;
+                public mixed $b = true;
+            }, 'a'), false),
+            array('isInitialized', array(new class {
+                public mixed $a;
+                public mixed $b = true;
+            }, 'b'), true),
             array('isCallable', array('strlen'), true),
             array('isCallable', array(array(self::class, 'getTests')), true),
             array('isCallable', array(function () {}), true),
@@ -614,6 +632,10 @@ public function testAssert(string $method, array $args, bool $success, bool $mul
     #[DataProvider('getTests')]
     public function testNullOr(string $method, array $args, bool $success, bool $multibyte = false): void
     {
+        if (in_array($method, self::SKIP_MIXIN_ASSERTION_TESTS)) {
+            $this->markTestSkipped("The method $method does not have nullOr Mixin.");
+        }
+
         if (in_array($method, array('null', 'notNull'))) {
             $this->markTestSkipped('Meaningless test of '.$method);
         }
@@ -633,6 +655,10 @@ public function testNullOr(string $method, array $args, bool $success, bool $mul
     #[DataProvider('getMethods')]
     public function testNullOrAcceptsNull(string $method): void
     {
+        if (in_array($method, self::SKIP_MIXIN_ASSERTION_TESTS)) {
+            $this->markTestSkipped("The method $method does not have nullOr Mixin.");
+        }
+
         if (in_array($method, array('null', 'notNull'))) {
             $this->markTestSkipped('Meaningless test of '.$method);
         }
@@ -644,6 +670,10 @@ public function testNullOrAcceptsNull(string $method): void
     #[DataProvider('getTests')]
     public function testAllArray(string $method, array $args, bool $success, bool $multibyte = false): void
     {
+        if (in_array($method, self::SKIP_MIXIN_ASSERTION_TESTS)) {
+            $this->markTestSkipped("The method $method does not have all Mixin.");
+        }
+
         if ($multibyte && !function_exists('mb_strlen')) {
             $this->markTestSkipped('The function mb_strlen() is not available');
         }
@@ -662,6 +692,10 @@ public function testAllArray(string $method, array $args, bool $success, bool $m
     #[DataProvider('getTests')]
     public function testAllNullOrArray(string $method, array $args, bool $success, bool $multibyte = false): void
     {
+        if (in_array($method, self::SKIP_MIXIN_ASSERTION_TESTS)) {
+            $this->markTestSkipped("The method $method does not have allNullOr Mixin.");
+        }
+
         if (in_array($method, array('null', 'notNull'))) {
             $this->markTestSkipped('Meaningless test of '.$method);
         }
@@ -691,6 +725,10 @@ public function testAllNullOrArray(string $method, array $args, bool $success, b
     #[DataProvider('getTests')]
     public function testAllTraversable(string $method, array $args, bool $success, bool $multibyte = false): void
     {
+        if (in_array($method, self::SKIP_MIXIN_ASSERTION_TESTS)) {
+            $this->markTestSkipped("The method $method does not have all Mixin.");
+        }
+
         if ($multibyte && !function_exists('mb_strlen')) {
             $this->markTestSkipped('The function mb_strlen() is not available');
         }

tests/ProjectCodeTest.php

@@ -19,6 +19,16 @@ class ProjectCodeTest extends TestCase
     private static string $assertDocComment;
     private static array $mixinMethodNames;
 
+    /** @var string[] */
+    private array $methodDoesNotHaveNullOrMixin = array(
+        'isInitialized',
+    );
+
+    /** @var string[] */
+    private array $methodDoesNotHaveAllMixin = array(
+        'isInitialized',
+    );
+
     #[BeforeClass]
     public static function scanStaticContent(): void
     {
@@ -36,6 +46,10 @@ public static function scanStaticContent(): void
     #[DataProvider('providesMethodNames')]
     public function testHasNullOr(string $method): void
     {
+        if (in_array($method, $this->methodDoesNotHaveNullOrMixin)) {
+            $this->markTestSkipped("The method $method does not have nullOr Mixin.");
+        }
+
         $fullMethodName = 'nullOr'.ucfirst($method);
 
         if ($method === 'notNull' || $method === 'null') {
@@ -61,6 +75,10 @@ public function testHasNullOr(string $method): void
     #[DataProvider('providesMethodNames')]
     public function testHasAll(string $method): void
     {
+        if (in_array($method, $this->methodDoesNotHaveAllMixin)) {
+            $this->markTestSkipped("The method $method does not have all Mixin.");
+        }
+
         $fullMethodName = 'all'.ucfirst($method);
 
         $correct = strpos((string) self::$assertDocComment, '@method static void '.$fullMethodName);

tests/static-analysis/assert-isInitialized.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Webmozart\Assert\Tests\StaticAnalysis;
+
+use Webmozart\Assert\Assert;
+
+/**
+ * @psalm-pure
+ *
+ * @param object $value
+ */
+function isInitialized(mixed $value, string $property): object
+{
+    Assert::isInitialized($value, $property);
+
+    return $value;
+}