feat: PHP 8 attributes (#150)

sigwinhq · Dec 2, 2021 · 589588c · 589588c
1 parent b8ea305
commit 589588c
Show file tree

Hide file tree

Showing 13 changed files with 260 additions and 9 deletions.
diff --git a/7.3-phpstan.neon.dist b/7.3-phpstan.neon.dist
@@ -1,5 +1,21 @@
 includes:
-    - phpstan.neon.dist
+    - /tools/.composer/vendor-bin/phpstan/vendor/phpstan/phpstan-deprecation-rules/rules.neon
+    - /tools/.composer/vendor-bin/phpstan/vendor/phpstan/phpstan-strict-rules/rules.neon
+    - /tools/.composer/vendor-bin/phpstan/vendor/phpstan/phpstan-phpunit/extension.neon
 parameters:
+    checkMissingIterableValueType: false
+    checkGenericClassInNonGenericObjectType: false
+    tmpDir: %currentWorkingDirectory%/var/phpstan
+    level: max
+    paths:
+        - ./
     excludePaths:
+        - var/
+        - vendor/
         - Test/Model/ProductWithAttributes.php
+
+        # false positive: PHPStan loads the first file from this one (?) 
+        - Test/Functional/FunctionalTestCase.php
+    ignoreErrors:
+        # PHPStan does not process version guards correctly
+        - '#Call to an undefined method.*getAttributes#'
diff --git a/7.3-psalm.xml.dist b/7.3-psalm.xml.dist
@@ -0,0 +1,60 @@
+<?xml version="1.0"?>
+<psalm xmlns="https://getpsalm.org/schema/config"
+       cacheDirectory="var/psalm"
+       errorLevel="1"
+       findUnusedVariablesAndParams="true">
+    <projectFiles>
+        <directory name="."/>
+        <ignoreFiles>
+            <directory name="var/"/>
+            <directory name="vendor/"/>
+        </ignoreFiles>
+    </projectFiles>
+
+    <issueHandlers>
+        <!-- TODO: false positive -->
+        <MixedArgument>
+            <errorLevel type="suppress">
+                <file name="Metadata/Annotation/AnnotationDriver.php"/>
+            </errorLevel>
+        </MixedArgument>
+        <MixedInferredReturnType>
+            <errorLevel type="suppress">
+                <file name="Metadata/Annotation/AnnotationDriver.php"/>
+            </errorLevel>
+        </MixedInferredReturnType>
+        <MixedMethodCall>
+            <errorLevel type="suppress">
+                <file name="Metadata/Annotation/AnnotationDriver.php"/>
+            </errorLevel>
+        </MixedMethodCall>
+        <MixedReturnStatement>
+            <errorLevel type="suppress">
+                <file name="Metadata/Annotation/AnnotationDriver.php"/>
+            </errorLevel>
+        </MixedReturnStatement>
+        <UndefinedMethod>
+            <errorLevel type="suppress">
+                <file name="Metadata/Annotation/AnnotationDriver.php"/>
+            </errorLevel>
+        </UndefinedMethod>
+        <!-- /TODO: false positive -->
+
+        <MissingConstructor>
+            <errorLevel type="info">
+                <directory name="Annotation/" />
+                <directory name="Test/" />
+            </errorLevel>
+        </MissingConstructor>
+        <RedundantCondition>
+            <errorLevel type="info">
+                <file name="Metadata/Annotation/AnnotationDriver.php" />
+            </errorLevel>
+        </RedundantCondition>
+        <PropertyNotSetInConstructor>
+            <errorLevel type="info">
+                <directory name="Test/" />
+            </errorLevel>
+        </PropertyNotSetInConstructor>
+    </issueHandlers>
+</psalm>
diff --git a/7.4-phpstan.neon.dist b/7.4-phpstan.neon.dist
@@ -0,0 +1,8 @@
+includes:
+    - phpstan.neon.dist
+parameters:
+    ignoreErrors:
+        # PHPStan does not process version guards correctly
+        - '#Call to an undefined method.*getAttributes#'
+    excludePaths:
+        - Test/Model/ProductWithAttributes.php
diff --git a/7.4-psalm.xml.dist b/7.4-psalm.xml.dist
@@ -0,0 +1,60 @@
+<?xml version="1.0"?>
+<psalm xmlns="https://getpsalm.org/schema/config"
+       cacheDirectory="var/psalm"
+       errorLevel="1"
+       findUnusedVariablesAndParams="true">
+    <projectFiles>
+        <directory name="."/>
+        <ignoreFiles>
+            <directory name="var/"/>
+            <directory name="vendor/"/>
+        </ignoreFiles>
+    </projectFiles>
+
+    <issueHandlers>
+        <!-- TODO: false positive -->
+        <MixedArgument>
+            <errorLevel type="suppress">
+                <file name="Metadata/Annotation/AnnotationDriver.php"/>
+            </errorLevel>
+        </MixedArgument>
+        <MixedInferredReturnType>
+            <errorLevel type="suppress">
+                <file name="Metadata/Annotation/AnnotationDriver.php"/>
+            </errorLevel>
+        </MixedInferredReturnType>
+        <MixedMethodCall>
+            <errorLevel type="suppress">
+                <file name="Metadata/Annotation/AnnotationDriver.php"/>
+            </errorLevel>
+        </MixedMethodCall>
+        <MixedReturnStatement>
+            <errorLevel type="suppress">
+                <file name="Metadata/Annotation/AnnotationDriver.php"/>
+            </errorLevel>
+        </MixedReturnStatement>
+        <UndefinedMethod>
+            <errorLevel type="suppress">
+                <file name="Metadata/Annotation/AnnotationDriver.php"/>
+            </errorLevel>
+        </UndefinedMethod>
+        <!-- /TODO: false positive -->
+
+        <MissingConstructor>
+            <errorLevel type="info">
+                <directory name="Annotation/" />
+                <directory name="Test/" />
+            </errorLevel>
+        </MissingConstructor>
+        <RedundantCondition>
+            <errorLevel type="info">
+                <file name="Metadata/Annotation/AnnotationDriver.php" />
+            </errorLevel>
+        </RedundantCondition>
+        <PropertyNotSetInConstructor>
+            <errorLevel type="info">
+                <directory name="Test/" />
+            </errorLevel>
+        </PropertyNotSetInConstructor>
+    </issueHandlers>
+</psalm>
diff --git a/Annotation/ArrayReference.php b/Annotation/ArrayReference.php
@@ -15,6 +15,7 @@
 
 /**
  * @Annotation
+ * @Target({"PROPERTY"})
  */
 final class ArrayReference
 {

diff --git a/Annotation/ColumnReference.php b/Annotation/ColumnReference.php
@@ -15,11 +15,19 @@
 
 /**
  * @Annotation
+ * @Target({"ANNOTATION", "PROPERTY"})
+ * @NamedArgumentConstructor
  */
+#[\Attribute(\Attribute::TARGET_PROPERTY)]
 final class ColumnReference implements Reference
 {
     /**
      * @var string
      */
     public $column;
+
+    public function __construct(string $column)
+    {
+        $this->column = $column;
+    }
 }
diff --git a/Annotation/HeaderReference.php b/Annotation/HeaderReference.php
@@ -15,11 +15,19 @@
 
 /**
  * @Annotation
+ * @Target({"ANNOTATION", "PROPERTY"})
+ * @NamedArgumentConstructor
  */
+#[\Attribute(\Attribute::TARGET_PROPERTY)]
 final class HeaderReference implements Reference
 {
     /**
      * @var string
      */
     public $header;
+
+    public function __construct(string $header)
+    {
+        $this->header = $header;
+    }
 }
diff --git a/Annotation/Options.php b/Annotation/Options.php
@@ -15,7 +15,10 @@
 
 /**
  * @Annotation
+ * @Target({"CLASS"})
+ * @NamedArgumentConstructor
  */
+#[\Attribute(\Attribute::TARGET_CLASS)]
 final class Options
 {
     /**
@@ -37,4 +40,12 @@ final class Options
      * @var bool
      */
     public $reverse;
+
+    public function __construct(int $start = 0, int $end = \PHP_INT_MAX, int $header = 0, bool $reverse = false)
+    {
+        $this->start = $start;
+        $this->end = $end;
+        $this->header = $header;
+        $this->reverse = $reverse;
+    }
 }
diff --git a/Metadata/Annotation/AnnotationDriver.php b/Metadata/Annotation/AnnotationDriver.php
@@ -66,15 +66,15 @@ private function getColumns(\ReflectionClass $reflectionClass): array
     {
         $columns = [];
         foreach ($reflectionClass->getProperties() as $reflectionProperty) {
-            $arrayAnnotation = $this->reader->getPropertyAnnotation(
+            $arrayAnnotation = $this->getPropertyAnnotationOrAttribute(
                 $reflectionProperty,
                 Annotation\ArrayReference::class
             );
-            $columnAnnotation = $this->reader->getPropertyAnnotation(
+            $columnAnnotation = $this->getPropertyAnnotationOrAttribute(
                 $reflectionProperty,
                 Annotation\ColumnReference::class
             );
-            $headerAnnotation = $this->reader->getPropertyAnnotation(
+            $headerAnnotation = $this->getPropertyAnnotationOrAttribute(
                 $reflectionProperty,
                 Annotation\HeaderReference::class
             );
@@ -115,7 +115,7 @@ private function getColumns(\ReflectionClass $reflectionClass): array
 
     private function getOptions(\ReflectionClass $reflectionClass, ?array $additionalOptions = null): array
     {
-        $options = (array) $this->reader->getClassAnnotation($reflectionClass, Annotation\Options::class);
+        $options = $this->getClassAnnotationOrAttribute($reflectionClass, Annotation\Options::class);
         if (null !== $additionalOptions) {
             $options = array_replace($options, $additionalOptions);
         }
@@ -141,4 +141,40 @@ private function createReference(Annotation\Reference $annotation)
 
         return $reference;
     }
+
+    /**
+     * @template T
+     *
+     * @param class-string<T> $name
+     */
+    private function getClassAnnotationOrAttribute(\ReflectionClass $reflection, string $name): array
+    {
+        if (\PHP_VERSION_ID >= 80000) {
+            $attribute = current($reflection->getAttributes($name));
+            if ($attribute !== false) {
+                return $attribute->getArguments();
+            }
+        }
+
+        return (array) $this->reader->getClassAnnotation($reflection, $name);
+    }
+
+    /**
+     * @template T
+     *
+     * @param class-string<T> $name
+     *
+     * @phpstan-return T|null
+     */
+    private function getPropertyAnnotationOrAttribute(\ReflectionProperty $reflection, string $name)
+    {
+        if (\PHP_VERSION_ID >= 80000) {
+            $attribute = current($reflection->getAttributes($name));
+            if ($attribute !== false) {
+                return $attribute->newInstance();
+            }
+        }
+
+        return $this->reader->getPropertyAnnotation($reflection, $name);
+    }
 }
diff --git a/Test/Functional/FunctionalTestCase.php b/Test/Functional/FunctionalTestCase.php
@@ -29,6 +29,7 @@
 use Xezilaires\Test\FixtureTrait;
 use Xezilaires\Test\IteratorMatcherTrait;
 use Xezilaires\Test\Model\Product;
+use Xezilaires\Test\Model\ProductWithAttributes;
 
 /**
  * @internal
@@ -111,6 +112,9 @@ public function testCanLoadFlatFixtureWithArrayReference(): void
         ], $iterator);
     }
 
+    /**
+     * @uses \Xezilaires\Annotation\HeaderReference
+     */
     public function testCanLoadSparseFixtureWithHeaderReference(): void
     {
         $iterator = $this->createIterator(
@@ -137,6 +141,9 @@ public function testCanLoadSparseFixtureWithHeaderReference(): void
 
     /**
      * @uses \Xezilaires\Metadata\Annotation\AnnotationDriver
+     * @uses \Xezilaires\Annotation\ColumnReference
+     * @uses \Xezilaires\Annotation\HeaderReference
+     * @uses \Xezilaires\Annotation\Options
      *
      * @throws \ReflectionException
      * @throws \RuntimeException
@@ -159,6 +166,37 @@ public function testCanLoadSparseFixtureWithAnnotations(): void
         ], $iterator);
     }
 
+    /**
+     * @uses \Xezilaires\Metadata\Annotation\AnnotationDriver
+     * @uses \Xezilaires\Annotation\ColumnReference
+     * @uses \Xezilaires\Annotation\HeaderReference
+     * @uses \Xezilaires\Annotation\Options
+     *
+     * @throws \ReflectionException
+     * @throws \RuntimeException
+     * @throws \ReflectionException
+     */
+    public function testCanLoadSparseFixtureWithNativeAttributes(): void
+    {
+        if (\PHP_VERSION_ID < 80000) {
+            static::markTestSkipped('Native PHP attributes available since PHP 8.0.0');
+        }
+
+        $driver = new AnnotationDriver();
+        $mapping = $driver->getMetadataMapping(ProductWithAttributes::class);
+
+        $iterator = $this->createIterator(
+            $this->getSpreadsheet($this->fixture('products-sparse.xlsx')),
+            $mapping
+        );
+
+        self::assertIteratorMatches([
+            2 => ['name' => 'The Very Hungry Caterpillar', 'price' => 6.59],
+            3 => ['name' => 'Brown Bear, Brown Bear, What Do You See?', 'price' => 6.51],
+            4 => ['name' => 'Stillhouse Lake', 'price' => 1.99],
+        ], $iterator);
+    }
+
     public function testCannotLoadFixtureWithAmbiguousHeaderReference(): void
     {
         $this->expectException(MappingException::class);
@@ -265,7 +303,7 @@ public function testCanFetchCurrentIteratorItem(): void
 
         $current = new Product();
         $current->name = 'Brown Bear, Brown Bear, What Do You See?';
-        $current->price = '6.51';
+        $current->price = 6.51;
         static::assertEquals($current, $iterator->current());
     }
 
@@ -291,7 +329,7 @@ public function testCanRewindIterator(): void
         $iterator->rewind();
         $current = new Product();
         $current->name = 'The Very Hungry Caterpillar';
-        $current->price = '6.59';
+        $current->price = 6.59;
         static::assertEquals($current, $iterator->current());
         static::assertEquals(2, $iterator->key());
     }

diff --git a/Test/IteratorMatcherTrait.php b/Test/IteratorMatcherTrait.php
@@ -19,7 +19,7 @@
 trait IteratorMatcherTrait
 {
     /**
-     * @param array<int, array<string, array<string>|string>> $expected
+     * @param array<int, array<string, array<float|string>|float|string>> $expected
      */
     private static function assertIteratorMatches(array $expected, \Iterator $iterator): void
     {

diff --git a/Test/Model/Product.php b/Test/Model/Product.php
@@ -41,7 +41,7 @@ final class Product
     public $name;
 
     /**
-     * @var float|string
+     * @var float
      *
      * @Groups({"header", "product"})
      * @XLS\HeaderReference(header="Price USD")
-Original file line number
+Diff line change
@@ Expand Up / @@ -15,6 +15,7 @@ @@
     /**
      * @Annotation
+     * @Target({"PROPERTY"})
      */
     final class ArrayReference
     {
@@ Expand Down @@