Merge pull request #235 from carlosas/has-attribute

Add hasAttribute() selector

ci/psalm.xml

@@ -55,5 +55,10 @@
         <ArgumentTypeCoercion>
             <errorLevel type="suppress"><directory name="../src/Selector/" /></errorLevel>
         </ArgumentTypeCoercion>
+
+        <UndefinedDocblockClass>
+            <errorLevel type="suppress"><file name="../src/Selector/HasAttribute.php" /></errorLevel>
+            <errorLevel type="suppress"><file name="../src/Rule/Extractor/Relation/ClassAttributeExtractor.php" /></errorLevel>
+        </UndefinedDocblockClass>
     </issueHandlers>
 </psalm>

docs/documentation/selectors.md

@@ -35,14 +35,17 @@ The first selector will select all classes in the `App\User\Domain` namespace.
 The second one will select all classes in a namespace matching the regular expression.
 
 ## Selector::implements()
-Select classes that implement a given interface.
+Select classes that implement the given interface.
 
 ## Selector::extends()
-Select classes that extend a given class.
+Select classes that extend the given class.
 
 ## Selector::interface()
 Select all interfaces.
 
+## Selector::hasAttribute()
+Select classes that has the given attribute.
+
 ## Selector::enum()
 Select all enums.
 

src/Rule/Assertion/Assertion.php

@@ -8,6 +8,4 @@
 /**
  * @extends PHPStanRule<Node>
  */
-interface Assertion extends PHPStanRule
-{
-}
+interface Assertion extends PHPStanRule {}

src/Selector/HasAttribute.php

@@ -0,0 +1,58 @@
+<?php declare(strict_types=1);
+
+namespace PHPat\Selector;
+
+use PHPStan\BetterReflection\Reflection\ReflectionAttribute;
+use PHPStan\Reflection\ClassReflection;
+
+final class HasAttribute implements SelectorInterface
+{
+    private string $classname;
+    private bool $isRegex;
+
+    /**
+     * @param class-string|string $classname
+     */
+    public function __construct(string $classname, bool $isRegex)
+    {
+        $this->classname = $classname;
+        $this->isRegex = $isRegex;
+    }
+
+    public function getName(): string
+    {
+        return $this->classname;
+    }
+
+    public function matches(ClassReflection $classReflection): bool
+    {
+        /** @var list<ReflectionAttribute> $attributes */
+        $attributes = $classReflection->getNativeReflection()->getAttributes();
+
+        if ($this->isRegex) {
+            return $this->matchesRegex($attributes);
+        }
+
+        foreach ($attributes as $attribute) {
+            if ($attribute->getName() === $this->classname) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * @param list<ReflectionAttribute> $attributes
+     */
+    private function matchesRegex(array $attributes): bool
+    {
+        foreach ($attributes as $attribute) {
+            if (preg_match($this->classname, $attribute->getName()) === 1) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+}

src/Selector/SelectorPrimitive.php

@@ -86,4 +86,12 @@ public static function extends(string $fqcn, bool $regex = false): ClassExtends
     {
         return new ClassExtends($fqcn, $regex);
     }
+
+    /**
+     * @param class-string|non-empty-string $fqcn
+     */
+    public static function hasAttribute(string $fqcn, bool $regex = false): HasAttribute
+    {
+        return new HasAttribute($fqcn, $regex);
+    }
 }

src/Test/Builder/BuildStep.php

@@ -2,6 +2,4 @@
 
 namespace PHPat\Test\Builder;
 
-class BuildStep extends AbstractStep
-{
-}
+class BuildStep extends AbstractStep {}

tests/fixtures/Simple/SimpleAbstractClass.php

@@ -2,6 +2,4 @@
 
 namespace Tests\PHPat\fixtures\Simple;
 
-abstract class SimpleAbstractClass
-{
-}
+abstract class SimpleAbstractClass {}

tests/fixtures/Simple/SimpleAbstractClassTwo.php

@@ -2,6 +2,4 @@
 
 namespace Tests\PHPat\fixtures\Simple;
 
-abstract class SimpleAbstractClassTwo
-{
-}
+abstract class SimpleAbstractClassTwo {}

tests/fixtures/Simple/SimpleAttribute.php

@@ -2,9 +2,5 @@
 
 namespace Tests\PHPat\fixtures\Simple;
 
-use Attribute;
-
 #[\Attribute(\Attribute::TARGET_CLASS)]
-class SimpleAttribute
-{
-}
+class SimpleAttribute {}

tests/fixtures/Simple/SimpleClass.php

@@ -2,6 +2,4 @@
 
 namespace Tests\PHPat\fixtures\Simple;
 
-class SimpleClass
-{
-}
+class SimpleClass {}

tests/fixtures/Simple/SimpleClassFive.php

@@ -2,6 +2,4 @@
 
 namespace Tests\PHPat\fixtures\Simple;
 
-class SimpleClassFive
-{
-}
+class SimpleClassFive {}

tests/fixtures/Simple/SimpleClassFour.php

@@ -2,6 +2,4 @@
 
 namespace Tests\PHPat\fixtures\Simple;
 
-class SimpleClassFour
-{
-}
+class SimpleClassFour {}

tests/fixtures/Simple/SimpleClassSix.php

@@ -2,6 +2,4 @@
 
 namespace Tests\PHPat\fixtures\Simple;
 
-class SimpleClassSix
-{
-}
+class SimpleClassSix {}

tests/fixtures/Simple/SimpleClassThree.php

@@ -2,6 +2,4 @@
 
 namespace Tests\PHPat\fixtures\Simple;
 
-class SimpleClassThree
-{
-}
+class SimpleClassThree {}

tests/fixtures/Simple/SimpleClassTwo.php

@@ -2,6 +2,4 @@
 
 namespace Tests\PHPat\fixtures\Simple;
 
-class SimpleClassTwo
-{
-}
+class SimpleClassTwo {}

tests/fixtures/Simple/SimpleException.php

@@ -2,6 +2,4 @@
 
 namespace Tests\PHPat\fixtures\Simple;
 
-class SimpleException extends \Exception
-{
-}
+class SimpleException extends \Exception {}

tests/fixtures/Simple/SimpleExceptionTwo.php

@@ -2,6 +2,4 @@
 
 namespace Tests\PHPat\fixtures\Simple;
 
-class SimpleExceptionTwo extends \Exception
-{
-}
+class SimpleExceptionTwo extends \Exception {}

tests/fixtures/Simple/SimpleFinalClass.php

@@ -2,6 +2,4 @@
 
 namespace Tests\PHPat\fixtures\Simple;
 
-final class SimpleFinalClass
-{
-}
+final class SimpleFinalClass {}

tests/fixtures/Simple/SimpleInterface.php

@@ -2,6 +2,4 @@
 
 namespace Tests\PHPat\fixtures\Simple;
 
-interface SimpleInterface
-{
-}
+interface SimpleInterface {}

tests/fixtures/Simple/SimpleInterfaceTwo.php

@@ -2,6 +2,4 @@
 
 namespace Tests\PHPat\fixtures\Simple;
 
-interface SimpleInterfaceTwo
-{
-}
+interface SimpleInterfaceTwo {}

tests/fixtures/Simple/SimpleTrait.php

@@ -2,6 +2,4 @@
 
 namespace Tests\PHPat\fixtures\Simple;
 
-trait SimpleTrait
-{
-}
+trait SimpleTrait {}

tests/fixtures/Special/ClassImplementing.php

@@ -4,6 +4,4 @@
 
 use Tests\PHPat\fixtures\Simple\SimpleInterface;
 
-class ClassImplementing implements SimpleInterface
-{
-}
+class ClassImplementing implements SimpleInterface {}

tests/fixtures/Special/ClassWithStaticMethod.php

@@ -4,7 +4,5 @@
 
 class ClassWithStaticMethod
 {
-    public static function staticMethod(): void
-    {
-    }
+    public static function staticMethod(): void {}
 }

tests/fixtures/Special/ClassWithStaticMethodTwo.php

@@ -4,7 +4,5 @@
 
 class ClassWithStaticMethodTwo
 {
-    public static function staticMethod(): void
-    {
-    }
+    public static function staticMethod(): void {}
 }