Support docblock tags

* Support DocBlock tags @Property, @property-read and @property-write. * Use phpstan/phpdoc-parser package for DocBlock parsing. * Add tests regarding DocBlock handling.
marguskaidja · Nov 4, 2022 · 596b99c · 596b99c
1 parent 74ea42a
commit 596b99c
Show file tree

Hide file tree

Showing 12 changed files with 521 additions and 271 deletions.
diff --git a/README.md b/README.md
diff --git a/composer.json b/composer.json
@@ -20,7 +20,8 @@
     ],
     "license": "MIT",
     "require": {
-        "php": "^8.0"
+        "php": "^8.0",
+        "phpstan/phpdoc-parser": "^1.13"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.5",

diff --git a/src/Accessible.php b/src/Accessible.php
@@ -16,6 +16,16 @@
 use margusk\Accessors\Exception\InvalidArgumentException;
 use ReflectionException;
 
+use function array_shift;
+use function count;
+use function current;
+use function in_array;
+use function is_array;
+use function is_string;
+use function strlen;
+use function strtolower;
+use function substr;
+
 trait Accessible
 {
     /**

diff --git a/src/Attr/ICase.php b/src/Attr/ICase.php
@@ -20,7 +20,6 @@ class ICase extends Attr
 {
     public function __construct()
     {
-        /** @noinspection PhpRedundantOptionalArgumentInspection */
-        parent::__construct(true);
+        parent::__construct();
     }
 }
diff --git a/src/Attr/Immutable.php b/src/Attr/Immutable.php
@@ -20,7 +20,6 @@ class Immutable extends Attr
 {
     public function __construct()
     {
-        /** @noinspection PhpRedundantOptionalArgumentInspection */
-        parent::__construct(true);
+        parent::__construct();
     }
 }
diff --git a/src/Attr/Mutator.php b/src/Attr/Mutator.php
@@ -15,6 +15,14 @@
 use Attribute;
 use margusk\Accessors\Attr;
 
+use function array_values;
+use function count;
+use function explode;
+use function is_array;
+use function is_string;
+use function preg_match;
+use function trim;
+
 #[Attribute(Attribute::TARGET_PROPERTY | Attribute::TARGET_CLASS)]
 class Mutator extends Attr
 {
@@ -56,4 +64,4 @@ public function mutator(): string|array|null
     {
         return $this->mutator;
     }
-}
+}
diff --git a/src/Attributes.php b/src/Attributes.php
@@ -13,10 +13,15 @@
 namespace margusk\Accessors;
 
 use margusk\Accessors\Attr\{Delete, Get, ICase, Immutable, Mutator, Set};
+use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode;
 use ReflectionAttribute;
 use ReflectionClass;
 use ReflectionProperty;
 
+use function array_fill_keys;
+use function array_key_exists;
+use function strtolower;
+
 class Attributes
 {
     /** @var class-string[] */
@@ -33,34 +38,12 @@ class Attributes
     /** @var array<class-string, Attr|null> */
     private array $attributes;
 
-    /**
-     * @param  ReflectionClass<object>|ReflectionProperty|null  $rfObject
-     */
-    public function __construct(ReflectionClass|ReflectionProperty|null $rfObject)
+    public function __construct()
     {
         $this->attributes = array_fill_keys(self::AVAILABLE_ATTR_NAMES, null);
-
-        /* $rfObject can be null to allow "empty" Attributes to be generated */
-        if (null !== $rfObject) {
-            // Read attributes from reflection object
-            foreach (
-                $rfObject->getAttributes(
-                    Attr::class,
-                    ReflectionAttribute::IS_INSTANCEOF
-                ) as $rfAttribute
-            ) {
-                $n = $rfAttribute->getName();
-
-                if (true === array_key_exists($n, $this->attributes)) {
-                    /** @var Attr $inst */
-                    $inst = $rfAttribute->newInstance();
-                    $this->attributes[$n] = $inst;
-                }
-            }
-        }
     }
 
-    public function mergeToParent(Attributes $parent): static
+    public function mergeWithParent(Attributes $parent): static
     {
         $new = clone $this;
 
@@ -77,4 +60,58 @@ public function get(string $name): ?Attr
     {
         return $this->attributes[$name] ?? null;
     }
+
+    /**
+     * @param  ReflectionClass<object>|ReflectionProperty  $rfObject
+     *
+     * @return self
+     */
+    public static function fromReflection(ReflectionClass|ReflectionProperty $rfObject): self
+    {
+        $that = new self();
+
+        foreach (
+            $rfObject->getAttributes(
+                Attr::class,
+                ReflectionAttribute::IS_INSTANCEOF
+            ) as $rfAttribute
+        ) {
+            $n = $rfAttribute->getName();
+
+            if (true === array_key_exists($n, $that->attributes)) {
+                /** @var Attr $inst */
+                $inst = $rfAttribute->newInstance();
+                $that->attributes[$n] = $inst;
+            }
+        }
+
+        return $that;
+    }
+
+    public static function fromDocBlock(PhpDocTagNode $tagNode): ?self
+    {
+        /** @var array<class-string<Attr>> $found */
+        $found = match(strtolower($tagNode->name)) {
+            '@property' => [Get::class, Set::class],
+            '@property-read' => [Get::class],
+            '@property-write' => [Set::class],
+            default => []
+        };
+
+        if (0 === count($found)) {
+            return null;
+        }
+
+        $that = new self();
+
+        foreach ($found as $n) {
+            if (true === array_key_exists($n, $that->attributes)) {
+                /** @var Attr $inst */
+                $inst = new $n(true);
+                $that->attributes[$n] = $inst;
+            }
+        }
+
+        return $that;
+    }
 }