Merge pull request #178 from koriym/serializable

Use service location to get annotation reader in AnnotatedWithMatcher

.github/workflows/continuous-integration.yml

@@ -47,11 +47,11 @@ jobs:
 
       - name: Install lowest dependencies
         if: ${{ matrix.dependencies == 'lowest' }}
-        run: composer update --prefer-lowest --no-interaction --no-progress --no-suggest
+        run: composer update --prefer-lowest --no-interaction --no-progress
 
       - name: Install highest dependencies
         if: ${{ matrix.dependencies == 'highest' }}
-        run: composer update --no-interaction --no-progress --no-suggest
+        run: composer update --no-interaction --no-progress
 
       - name: Run test suite
         run: ./vendor/bin/phpunit --coverage-clover=coverage.xml

.gitignore

@@ -7,3 +7,4 @@
 /composer.lock
 /coverage.xml
 /vendor-bin/**/vendor
+/.phpunit-cache

composer.json

@@ -11,7 +11,7 @@
     ],
     "require": {
         "php": "^7.3 || ^8.0",
-        "doctrine/annotations": "^1.11",
+        "doctrine/annotations": "^1.12",
         "koriym/attributes": "^1.0",
         "nikic/php-parser": "^4.2"
     },
@@ -43,7 +43,7 @@
         "post-update-cmd": ["@composer bin all update --ansi"],
         "test": ["./vendor/bin/phpunit"],
         "tests": ["@cs", "@test", "@sa"],
-        "coverage": ["php -dzend_extension=xdebug.so ./vendor/bin/phpunit --coverage-text --coverage-html=build/coverage"],
+        "coverage": ["php -dzend_extension=xdebug.so -dxdebug.mode=coverage ./vendor/bin/phpunit --coverage-text --coverage-html=build/coverage"],
         "pcov": ["php -dextension=pcov.so -d pcov.enabled=1 ./vendor/bin/phpunit --coverage-text --coverage-html=build/coverage  --coverage-clover=coverage.xml"],
         "cs": ["phpcs --standard=./phpcs.xml src tests"],
         "cs-fix": ["./vendor/bin/phpcbf src tests"],

phpcs.xml

@@ -1,14 +1,17 @@
 <?xml version="1.0"?>
 <ruleset
-    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="bearcs"
-    xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/squizlabs/PHP_CodeSniffer/master/phpcs.xsd">
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="Ray.Aop coding standard"
+    xsi:noNamespaceSchemaLocation="./vendor-bin/tools/vendor/squizlabs/php_codesniffer/phpcs.xsd">
 
     <arg name="basepath" value="."/>
     <arg name="extensions" value="php"/>
     <arg name="parallel" value="80"/>
     <arg name="cache" value=".phpcs-cache"/>
     <arg name="colors"/>
 
+    <!-- Compatibility with PHP 7.3.0 -->
+    <config name="php_version" value="70300"/>
+com
     <!-- Ignore warnings, show progress of the run and show sniff names -->
     <arg value="nps"/>
 
@@ -51,6 +54,15 @@
             </property>
         </properties>
     </rule>
+    <rule ref="SlevomatCodingStandard.Commenting.DocCommentSpacing">
+        <properties>
+            <property name="annotationsGroups" type="array">
+                <element value="@param, @psalm-param, @phpstan-param"/>
+                <element value="@return, @psalm-return, @phpstan-return"/>
+                <element value="@throws"/>
+            </property>
+        </properties>
+    </rule>
     <rule ref="SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingNativeTypeHint">
         <include-pattern>src/Module/*</include-pattern>
         <include-pattern>tests/*</include-pattern>

phpunit.xml.dist

@@ -1,6 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd" bootstrap="tests/bootstrap.php">
-  <coverage>
+<phpunit
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="./vendor/phpunit/phpunit/phpunit.xsd"
+        bootstrap="tests/bootstrap.php">
+  <coverage processUncoveredFiles="true" cacheDirectory="./.phpunit-cache">
     <include>
       <directory suffix=".php">src</directory>
     </include>

src/Matcher/AnnotatedWithMatcher.php

@@ -4,35 +4,21 @@
 
 namespace Ray\Aop\Matcher;
 
-use Doctrine\Common\Annotations\AnnotationException;
-use Doctrine\Common\Annotations\Reader;
 use Ray\Aop\AbstractMatcher;
 use Ray\ServiceLocator\ServiceLocator;
 use ReflectionClass;
 use ReflectionMethod;
 
 final class AnnotatedWithMatcher extends AbstractMatcher
 {
-    /** @var Reader */
-    private $reader;
-
-    /**
-     * @throws AnnotationException
-     */
-    public function __construct()
-    {
-        parent::__construct();
-        $this->reader = ServiceLocator::getReader();
-    }
-
     /**
      * {@inheritdoc}
      */
     public function matchesClass(ReflectionClass $class, array $arguments): bool
     {
         /** @var array<class-string> $arguments */
         [$annotation] = $arguments;
-        $annotation = $this->reader->getClassAnnotation($class, $annotation);
+        $annotation = ServiceLocator::getReader()->getClassAnnotation($class, $annotation);
 
         return (bool) $annotation;
     }
@@ -44,7 +30,7 @@ public function matchesMethod(ReflectionMethod $method, array $arguments): bool
     {
         /** @var array<class-string> $arguments */
         [$annotation] = $arguments;
-        $annotation = $this->reader->getMethodAnnotation($method, $annotation);
+        $annotation = ServiceLocator::getReader()->getMethodAnnotation($method, $annotation);
 
         return (bool) $annotation;
     }

tests/AnnotatedMatcherTest.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ray\Aop;
+
+use PHPUnit\Framework\TestCase;
+
+use function serialize;
+use function unserialize;
+
+class AnnotatedMatcherTest extends TestCase
+{
+    public function testSerialize(): void
+    {
+        $object = new AnnotatedMatcher('startsWith', ['a']);
+        $this->assertInstanceOf(AnnotatedMatcher::class, unserialize(serialize($object)));
+    }
+}

tests/Fake/Annotation/FakeMarker.php

@@ -5,19 +5,22 @@
 namespace Ray\Aop\Annotation;
 
 use Attribute;
+use Doctrine\Common\Annotations\Annotation\NamedArgumentConstructor;
+
 
 /**
  * @Annotation
  * @Target("METHOD")
+ * @NamedArgumentConstructor
  */
 #[Attribute(Attribute::TARGET_METHOD)]
 final class FakeMarker
 {
     /** @var int */
     public $value;
 
-    public function __construct($value)
+    public function __construct(int $value)
     {
-        $this->value['value'] ?? $value;
+        $this->value = $value;
     }
 }

tests/Fake/FakeAnnotateClassNoName.php

@@ -18,7 +18,7 @@ class FakeAnnotateClassNoName
     /**
      * @FakeMarker3
      * @FakeMarker2
-     * @FakeMarker
+     * @FakeMarker(1)
      */
     public function getDouble($a)
     {

tests/Fake/FakeClass.php

@@ -21,7 +21,7 @@ public function __toString()
     }
 
     /**
-     * @FakeMarker
+     * @FakeMarker(1)
      */
     public function add($n)
     {

tests/ReflectiveMethodInvocationTest.php

@@ -85,9 +85,6 @@ public function testGetNamedArguments(): void
         $this->assertSame((array) $args, ['n' => 1]);
     }
 
-    /**
-     * @covers ReflectiveMethodInvocation::getNamedArguments
-     */
     public function testGetNamedArgumentsWithDefaultValue(): void
     {
         $invocation = new ReflectiveMethodInvocation(new FakeWeavedClass(), 'defaultValue', [1, null], [new FakeInterceptor(), new FakeInterceptor()]);

vendor-bin/tools/composer.json

@@ -1,6 +1,6 @@
 {
-    "require": {
-        "doctrine/coding-standard": "^8.2",
+    "require-dev": {
+        "doctrine/coding-standard": "^9.0",
         "phpmd/phpmd": "^2.9",
         "phpmetrics/phpmetrics": "^2.7",
         "phpstan/phpstan": "^0.12",