Merge pull request #286 from koriym/remove_doctrine_annotation

Remove doctrine/annotation

.github/workflows/continuous-integration.yml

@@ -9,6 +9,6 @@ jobs:
   ci:
     uses: ray-di/.github/.github/workflows/continuous-integration.yml@v1
     with:
-      old_stable: '["8.0", "8.1"]'
-      current_stable: 8.2
+      old_stable: '["8.0", "8.1", "8.2"]'
+      current_stable: 8.3
       script: demo/run.php

composer.json

@@ -12,7 +12,6 @@
     "require": {
         "php": "^8.0",
         "ext-filter": "*",
-        "doctrine/annotations": "^1.12",
         "justinrainbow/json-schema": "^5.2.10",
         "koriym/attributes": "^1.0",
         "koriym/http-constants": "^1.1",
@@ -66,16 +65,16 @@
         "files": ["tests/Fake/AppInjector.php"]
     },
     "scripts" :{
-        "test": ["./vendor/bin/phpunit"],
+        "test": ["phpunit"],
         "tests": ["@cs", "@test", "@sa"],
         "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": ["./vendor/bin/phpcs --standard=./phpcs.xml src tests"],
-        "cs-fix": ["./vendor/bin/phpcbf src tests"],
-        "clean": ["./vendor/bin/phpstan clear-result-cache", "./vendor/bin/psalm --clear-cache", "rm -rf tests/tmp/*.php"],
-        "sa": ["./vendor/bin/psalm --monochrome --show-info=true", "./vendor/bin/phpstan --memory-limit=-1 analyse -c phpstan.neon"],
-        "metrics": ["./vendor/bin/phpmetrics --report-html=build/metrics --exclude=Exception --log-junit=build/junit.xml --junit=build/junit.xml src"],
-        "phpmd": ["./vendor/bin/phpmd --exclude src/Annotation src text ./phpmd.xml"],
+        "cs": ["phpcs --standard=phpcs.xml src tests"],
+        "cs-fix": ["phpcbf src tests"],
+        "clean": ["phpstan clear-result-cache", "psalm --clear-cache", "rm -rf tests/tmp/*.php"],
+        "sa": ["psalm --monochrome --show-info=true", "phpstan --memory-limit=-1 analyse -c phpstan.neon"],
+        "metrics": ["phpmetrics --report-html=build/metrics --exclude=Exception --log-junit=build/junit.xml --junit=build/junit.xml src"],
+        "phpmd": ["phpmd --exclude src/Annotation src text ./phpmd.xml"],
         "build": ["@cs", "@sa", "@pcov", "@metrics"]
     },
     "config": {

php-require-checker.config.json

@@ -4,6 +4,7 @@
     "static", "self", "parent",
     "array", "string", "int", "float", "bool", "iterable", "callable", "void", "object",
     "Attribute", "ReflectionAttribute", "Stringable",
-    "BEAR\\Resource\\HalLink", "BEAR\\Resource\\NullReverseLink", "BEAR\\Resource\\ReverseLinkInterface"
+    "BEAR\\Resource\\HalLink", "BEAR\\Resource\\NullReverseLink", "BEAR\\Resource\\ReverseLinkInterface",
+    "Doctrine\\Common\\Annotations\\Reader", "Doctrine\\Common\\Annotations\\AnnotationReader"
   ]
 }

src/Module/AnnotationModule.php → src-deprecated/Module/AnnotationModule.php

@@ -17,6 +17,8 @@
  *
  * Reader-annotation
  * Reader-attribute
+ *
+ * @deprecated See https://github.com/bearsunday/BEAR.Resource/wiki/Doctrine-annotation-deprecation-notice
  */
 final class AnnotationModule extends AbstractModule
 {

src/Module/AttributeModule.php → src-deprecated/Module/AttributeModule.php

@@ -9,6 +9,10 @@
 use Ray\Di\AbstractModule;
 
 /** @codeCoverageIgnore */
+
+/**
+ * @deprecated See https://github.com/bearsunday/BEAR.Resource/wiki/Doctrine-annotation-deprecation-notice
+ */
 final class AttributeModule extends AbstractModule
 {
     /**

src/Anchor.php

@@ -6,8 +6,7 @@
 
 use BEAR\Resource\Annotation\Link as LinkAnnotation;
 use BEAR\Resource\Exception\LinkException;
-use Doctrine\Common\Annotations\Reader;
-use ReflectionMethod;
+use Ray\Aop\ReflectionMethod;
 
 use function array_merge;
 use function assert;
@@ -17,11 +16,6 @@
 
 final class Anchor implements AnchorInterface
 {
-    public function __construct(
-        private Reader $reader,
-    ) {
-    }
-
     /**
      * {@inheritDoc}
      *
@@ -30,8 +24,7 @@ public function __construct(
     public function href(string $rel, AbstractRequest $request, array $query): array
     {
         $classMethod = 'on' . ucfirst($request->method);
-        /** @var list<object> $annotations */
-        $annotations = $this->reader->getMethodAnnotations(new ReflectionMethod($request->resourceObject::class, $classMethod));
+        $annotations = (new ReflectionMethod($request->resourceObject::class, $classMethod))->getAnnotations();
         foreach ($annotations as $annotation) {
             if ($this->isValidLinkAnnotation($annotation, $rel)) {
                 assert($annotation instanceof LinkAnnotation);

src/AssistedParam.php

@@ -10,6 +10,8 @@ final class AssistedParam implements ParamInterface
 {
     /**
      * {@inheritDoc}
+     *
+     * @codeCoverageIgnore
      */
     public function __invoke(string $varName, array $query, InjectorInterface $injector): void
     {

src/EmbedInterceptor.php

@@ -8,7 +8,6 @@
 use BEAR\Resource\Exception\BadRequestException;
 use BEAR\Resource\Exception\EmbedException;
 use BEAR\Resource\Exception\LinkException;
-use Doctrine\Common\Annotations\Reader;
 use Ray\Aop\MethodInterceptor;
 use Ray\Aop\MethodInvocation;
 
@@ -23,7 +22,6 @@ final class EmbedInterceptor implements MethodInterceptor
 
     public function __construct(
         ResourceInterface $resource,
-        private Reader $reader,
     ) {
         $this->resource = clone $resource;
     }
@@ -37,9 +35,8 @@ public function invoke(MethodInvocation $invocation)
     {
         $ro = $invocation->getThis();
         assert($ro instanceof ResourceObject);
-        $method = $invocation->getMethod();
         $query = $this->getArgsByInvocation($invocation);
-        $embeds = $this->reader->getMethodAnnotations($method);
+        $embeds = $invocation->getMethod()->getAnnotations();
         $this->embedResource($embeds, $ro, $query);
 
         return $invocation->proceed();

src/HalRenderer.php

@@ -4,9 +4,8 @@
 
 namespace BEAR\Resource;
 
-use Doctrine\Common\Annotations\Reader;
 use Nocarrier\Hal;
-use ReflectionMethod;
+use Ray\Aop\ReflectionMethod;
 use RuntimeException;
 
 use function assert;
@@ -28,7 +27,6 @@
 final class HalRenderer implements RenderInterface
 {
     public function __construct(
-        private Reader $reader,
         private HalLinker $linker,
     ) {
     }
@@ -54,8 +52,7 @@ public function renderHal(ResourceObject $ro): void
         [$ro, $body] = $this->valuate($ro);
         $method = 'on' . ucfirst($ro->uri->method);
         $hasMethod = method_exists($ro, $method);
-        /** @var list<object> $annotations */
-        $annotations = $hasMethod ? $this->reader->getMethodAnnotations(new ReflectionMethod($ro, $method)) : [];
+        $annotations = $hasMethod ? (new ReflectionMethod($ro, $method))->getAnnotations() : [];
         $hal = $this->getHal($ro->uri, $body, $annotations);
         $json = $hal->asJson(true);
         assert(is_string($json));

src/JsonSchema/Annotation/JsonSchema.php

@@ -11,6 +11,7 @@
  * @Annotation
  * @Target("METHOD")
  * @NamedArgumentConstructor
+ * @codeCoverageIgnore
  */
 #[Attribute(Attribute::TARGET_METHOD)]
 final class JsonSchema

src/Linker.php

@@ -9,8 +9,7 @@
 use BEAR\Resource\Exception\LinkRelException;
 use BEAR\Resource\Exception\MethodException;
 use BEAR\Resource\Exception\UriException;
-use Doctrine\Common\Annotations\Reader;
-use ReflectionMethod;
+use Ray\Aop\ReflectionMethod;
 
 use function array_filter;
 use function array_key_exists;
@@ -33,7 +32,6 @@ final class Linker implements LinkerInterface
     private array $cache = [];
 
     public function __construct(
-        private Reader $reader,
         private InvokerInterface $invoker,
         private FactoryInterface $factory,
     ) {
@@ -110,7 +108,7 @@ private function annotationLink(LinkType $link, ResourceObject $current, Abstrac
 
         $classMethod = 'on' . ucfirst($request->method);
         /** @var list<Link> $annotations */
-        $annotations = $this->reader->getMethodAnnotations(new ReflectionMethod($current::class, $classMethod));
+        $annotations = (new ReflectionMethod($current::class, $classMethod))->getAnnotations();
         if ($link->type === LinkType::CRAWL_LINK) {
             return $this->annotationCrawl($annotations, $link, $current);
         }

src/Module/ResourceModule.php

@@ -36,9 +36,12 @@ public function __construct(
     protected function configure(): void
     {
         $this->install(new ResourceClientModule());
-        $this->install(new AnnotationModule());
         $this->install(new EmbedResourceModule());
         $this->install(new HttpClientModule());
         $this->bind()->annotatedWith(AppName::class)->toInstance($this->appName);
+
+        // Backward compatibility
+        /** @psalm-suppress DeprecatedClass */
+        $this->install(new AnnotationModule());
     }
 }

src/NamedParamMetas.php

@@ -6,21 +6,15 @@
 
 use BEAR\Resource\Annotation\RequestParamInterface;
 use BEAR\Resource\Annotation\ResourceParam;
-use Doctrine\Common\Annotations\Reader;
+use Ray\Aop\ReflectionMethod;
 use Ray\Di\Di\Assisted;
 use Ray\WebContextParam\Annotation\AbstractWebContextParam;
 use ReflectionAttribute;
-use ReflectionMethod;
 use ReflectionNamedType;
 use ReflectionParameter;
 
 final class NamedParamMetas implements NamedParamMetasInterface
 {
-    public function __construct(
-        private Reader $reader,
-    ) {
-    }
-
     /**
      * {@inheritDoc}
      */
@@ -41,7 +35,7 @@ public function __invoke(callable $callable): array
     private function getAnnotationParamMetas(ReflectionMethod $method): array
     {
         $parameters = $method->getParameters();
-        $annotations = $this->reader->getMethodAnnotations($method);
+        $annotations = $method->getAnnotations();
         $assistedNames = $this->getAssistedNames($annotations);
         $webContext = $this->getWebContext($annotations);
 
@@ -71,9 +65,8 @@ private function getAttributeParamMetas(ReflectionMethod $method): array
             $refWebContext = $parameter->getAttributes(AbstractWebContextParam::class, ReflectionAttribute::IS_INSTANCEOF);
             if ($refWebContext) {
                 $webParam = $refWebContext[0]->newInstance();
-                /** @psalm-suppress MixedAssignment */
-                $defaultValue = $parameter->isDefaultValueAvailable() ? $parameter->getDefaultValue() : null;
-                $param = new AssistedWebContextParam($webParam, new DefaultParam($defaultValue));
+                $default = $this->getDefault($parameter);
+                $param = new AssistedWebContextParam($webParam, $default);
                 $names[$parameter->name] = $param;
                 continue;
             }
@@ -103,7 +96,9 @@ private function getAssistedNames(array $annotations): array
                 continue;
             }
 
-            $names = $this->setAssistedAnnotation($names, $annotation);
+            // @codeCoverageIgnoreStart
+            $names = $this->setAssistedAnnotation($names, $annotation); // BC for annotation
+            // @codeCoverageIgnoreEnd
         }
 
         return $names;
@@ -132,6 +127,8 @@ private function getWebContext(array $annotations): array
      * @param array<string, ParamInterface> $names
      *
      * @return array<string, ParamInterface>
+     *
+     * @codeCoverageIgnore BC for annotation
      */
     private function setAssistedAnnotation(array $names, Assisted $assisted): array
     {

src/NamedParameter.php

@@ -23,7 +23,7 @@ public function getParameters(callable $callable, array $query): array
         $parameters = [];
         foreach ($metas as $varName => $param) {
             /** @psalm-suppress all */
-            $parameters[] = $param($varName, $query, $this->injector);
+            $parameters[$varName] = $param($varName, $query, $this->injector);
         }
 
         return $parameters;

src/NamedParameterInterface.php

@@ -11,7 +11,7 @@ interface NamedParameterInterface
      *
      * @param array<string, mixed> $query
      *
-     * @return list<mixed>
+     * @return array<string, mixed>
      */
     public function getParameters(callable $callable, array $query): array;
 }

src/OptionsMethods.php

@@ -7,7 +7,7 @@
 use BEAR\Resource\Annotation\Embed;
 use BEAR\Resource\Annotation\JsonSchema;
 use BEAR\Resource\Annotation\Link;
-use Doctrine\Common\Annotations\Reader;
+use Ray\Aop\ReflectionMethod;
 use Ray\Di\Di\Named;
 use Ray\WebContextParam\Annotation\AbstractWebContextParam;
 use Ray\WebContextParam\Annotation\CookieParam;
@@ -16,7 +16,6 @@
 use Ray\WebContextParam\Annotation\FormParam;
 use Ray\WebContextParam\Annotation\QueryParam;
 use Ray\WebContextParam\Annotation\ServerParam;
-use ReflectionMethod;
 
 use function assert;
 use function class_exists;
@@ -41,7 +40,6 @@ final class OptionsMethods
     ];
 
     public function __construct(
-        private Reader $reader,
         #[Named('json_schema_dir')]
         private string $schemaDir = '',
     ) {
@@ -82,7 +80,7 @@ public function __invoke(ResourceObject $ro, string $requestMethod): array
     private function getMethodExtras(ReflectionMethod $method): array
     {
         $extras = [];
-        $annotations = $this->reader->getMethodAnnotations($method);
+        $annotations = $method->getAnnotations();
         foreach ($annotations as $annotation) {
             if ($annotation instanceof Link) {
                 $extras['links'][] = $annotation;
@@ -102,11 +100,15 @@ private function getMethodExtras(ReflectionMethod $method): array
     private function getInMap(ReflectionMethod $method): array
     {
         $ins = [];
-        $annotations = $this->reader->getMethodAnnotations($method);
-        $ins = $this->getInsFromMethodAnnotations($annotations, $ins);
+        bc_for_annotation: {
+            // @codeCoverageIgnoreStart
+            $annotations = $method->getAnnotations();
+            $ins = $this->getInsFromMethodAnnotations($annotations, $ins);
         if ($ins) {
             return $ins;
         }
+            // @codeCoverageIgnoreEnd
+        }
 
         /** @var array<string, string> $insParam */
         $insParam = $this->getInsFromParameterAttributes($method, $ins);
@@ -117,7 +119,7 @@ private function getInMap(ReflectionMethod $method): array
     /** @return array<string, mixed> */
     private function getJsonSchema(ReflectionMethod $method): array
     {
-        $schema = $this->reader->getMethodAnnotation($method, JsonSchema::class);
+        $schema = $method->getAnnotation(JsonSchema::class);
         if (! $schema instanceof JsonSchema) {
             return [];
         }
@@ -135,6 +137,8 @@ private function getJsonSchema(ReflectionMethod $method): array
      * @param array<string, string> $ins
      *
      * @return array<string, string>
+     *
+     * @codeCoverageIgnore BC for annotation
      */
     public function getInsFromMethodAnnotations(array $annotations, array $ins): array
     {