Merge pull request #298 from ray-di/psalm6

koriym · web-flow · commit 33a4a686f995 · 2025-02-26T15:40:21.000+09:00
diff --git a/composer.json b/composer.json
@@ -14,7 +14,7 @@
         "koriym/attributes": "^1.0.4",
         "koriym/null-object": "^1.0",
         "koriym/param-reader": "^1.0",
-        "ray/aop": "^2.16",
+        "ray/aop": "^2.18",
         "ray/compiler": "^1.10.3"
     },
     "require-dev": {
@@ -47,10 +47,11 @@
         "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 -m -c psalm.xml --show-info=true", "phpstan analyse -c phpstan.neon --no-progress "],
+        "sa": ["psalm -m -c psalm.xml --show-info=false", "phpstan analyse -c phpstan.neon --no-progress "],
         "metrics": ["@test", "phpmetrics --report-html=build/metrics --exclude=Exception --log-junit=build/junit.xml --junit=build/junit.xml src"],
         "phpmd": ["phpmd src/di text ./phpmd.xml"],
-        "build": ["@cs", "@sa", "@pcov", "@metrics"]
+        "build": ["@cs", "@sa", "@pcov", "@metrics"],
+        "baseline": ["phpstan analyse -c phpstan.neon --generate-baseline", "psalm --set-baseline=psalm-baseline.xml"]
     },
     "extra": {
         "bamarni-bin": {
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -0,0 +1,7 @@
+parameters:
+	ignoreErrors:
+		-
+			message: '#^Negated boolean expression is always false\.$#'
+			identifier: booleanNot.alwaysFalse
+			count: 1
+			path: src/di/AnnotatedClassMethods.php
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<files psalm-version="4.30.0@d0bc6e25d89f649e4f36a534f330f8bb4643dd69">
+  <file src="src/di/AnnotatedClassMethods.php">
+    <DocblockTypeContradiction occurrences="2">
+      <code>! $constructor</code>
+      <code>$constructor</code>
+    </DocblockTypeContradiction>
+  </file>
+  <file src="src/di/AspectBind.php">
+    <MixedArrayOffset occurrences="1">
+      <code>$instantiatedBindings[$methodName]</code>
+    </MixedArrayOffset>
+    <MixedAssignment occurrences="3">
+      <code>$interceptorClassName</code>
+      <code>$interceptorClassNames</code>
+      <code>$methodName</code>
+    </MixedAssignment>
+    <MixedReturnTypeCoercion occurrences="2">
+      <code>$instantiatedBindings</code>
+      <code>array&lt;non-empty-string, list&lt;MethodInterceptor&gt;&gt;</code>
+    </MixedReturnTypeCoercion>
+  </file>
+  <file src="src/di/Dependency.php">
+    <InvalidArgument occurrences="1">
+      <code>$pointcuts</code>
+    </InvalidArgument>
+  </file>
+  <file src="src/di/NewInstance.php">
+    <InvalidArgument occurrences="1">
+      <code>$this-&gt;bind-&gt;inject($container)</code>
+    </InvalidArgument>
+  </file>
+</files>
diff --git a/psalm.xml b/psalm.xml
@@ -4,12 +4,15 @@
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns="https://getpsalm.org/schema/config"
     xsi:schemaLocation="https://getpsalm.org/schema/config https://psalm.dev/schema/config"
+    findUnusedCode="false"
 >
     <projectFiles>
         <directory name="src/di"/>
-        <directory name="tests/type"/>
     </projectFiles>
     <stubs>
         <file name="tests/stub/BindInterface.phpstub"/>
     </stubs>
-<plugins><pluginClass class="Psalm\PhpUnitPlugin\Plugin"/></plugins></psalm>
+    <issueHandlers>
+        <MissingOverrideAttribute errorLevel="suppress"/>
+    </issueHandlers>
+</psalm>
diff --git a/src/di/AnnotatedClassMethods.php b/src/di/AnnotatedClassMethods.php
@@ -9,6 +9,8 @@
 use Ray\Di\Di\InjectInterface;
 use Ray\Di\Di\Named;
 
+use function assert;
+
 use const PHP_VERSION_ID;
 
 final class AnnotatedClassMethods
@@ -38,6 +40,7 @@ public function getConstructorName(ReflectionClass $class): Name
             }
         }
 
+        assert($constructor instanceof ReflectionMethod);
         $named = $constructor->getAnnotation(Named::class);
         if ($named instanceof Named) {
             return new Name($named->value);
diff --git a/src/di/AspectBind.php b/src/di/AspectBind.php
@@ -22,7 +22,7 @@ public function __construct(AopBind $bind)
     /**
      * Instantiate interceptors
      *
-     * @return array<string, list<MethodInterceptor>>
+     * @return array<non-empty-string, list<MethodInterceptor>>
      */
     public function inject(Container $container): array
     {
diff --git a/src/di/AssistedInjectModule.php b/src/di/AssistedInjectModule.php
@@ -9,7 +9,7 @@
 /**
  * Assisted module for php8 attributes
  */
-class AssistedInjectModule extends AbstractModule
+final class AssistedInjectModule extends AbstractModule
 {
     protected function configure(): void
     {
diff --git a/src/di/AssistedModule.php b/src/di/AssistedModule.php
@@ -9,7 +9,7 @@
 
 use const PHP_VERSION_ID;
 
-class AssistedModule extends AbstractModule
+final class AssistedModule extends AbstractModule
 {
     protected function configure(): void
     {
diff --git a/src/di/Bind.php b/src/di/Bind.php
@@ -117,7 +117,7 @@ public function toConstructor(string $class, $name, ?InjectionPoints $injectionP
         }
 
         $this->untarget = null;
-        $postConstructRef = $postConstruct ? new ReflectionMethod($class, $postConstruct) : null;
+        $postConstructRef = $postConstruct !== null ? new ReflectionMethod($class, $postConstruct) : null;
         /** @var ReflectionClass<object> $reflection */
         $reflection = new ReflectionClass($class);
         $this->bound = (new DependencyFactory())->newToConstructor($reflection, $name, $injectionPoints, $postConstructRef);
diff --git a/src/di/BindValidator.php b/src/di/BindValidator.php
@@ -42,7 +42,7 @@ public function to(string $interface, string $class): ReflectionClass
             throw new InvalidType("[{$class}] is no implemented [{$interface}] interface");
         }
 
-        return new ReflectionClass($class); // @phpstan-ignore-line
+        return new ReflectionClass($class);
     }
 
     /**
diff --git a/src/di/Container.php b/src/di/Container.php
@@ -94,6 +94,7 @@ public function getInstanceWithArgs(string $interface, array $params)
             throw new BadMethodCallException($interface);
         }
 
+        /** @psalm-suppress ArgumentTypeCoercion */
         return $dependency->injectWithArgs($this, $params);
     }
 
diff --git a/src/di/Dependency.php b/src/di/Dependency.php
@@ -67,15 +67,15 @@ public function register(array &$container, Bind $bind): void
     public function inject(Container $container)
     {
         // singleton ?
-        if ($this->isSingleton === true && $this->instance) {
+        if ($this->isSingleton === true && $this->instance !== null) {
             return $this->instance;
         }
 
         // create dependency injected instance
         $this->instance = ($this->newInstance)($container);
 
         // @PostConstruct
-        if ($this->postConstruct) {
+        if ($this->postConstruct !== null) {
             assert(method_exists($this->instance, $this->postConstruct));
             $this->instance->{$this->postConstruct}();
         }
@@ -91,15 +91,15 @@ public function inject(Container $container)
     public function injectWithArgs(Container $container, array $params)
     {
         // singleton ?
-        if ($this->isSingleton === true && $this->instance) {
+        if ($this->isSingleton === true && $this->instance !== null) {
             return $this->instance;
         }
 
         // create dependency injected instance
         $this->instance = $this->newInstance->newInstanceArgs($container, $params);
 
         // @PostConstruct
-        if ($this->postConstruct) {
+        if ($this->postConstruct !== null) {
             assert(method_exists($this->instance, $this->postConstruct));
             $this->instance->{$this->postConstruct}();
         }
diff --git a/src/di/DependencyProvider.php b/src/di/DependencyProvider.php
@@ -60,7 +60,7 @@ public function register(array &$container, Bind $bind): void
      */
     public function inject(Container $container)
     {
-        if ($this->isSingleton && $this->instance) {
+        if ($this->isSingleton && $this->instance !== null) {
             return $this->instance;
         }
 
diff --git a/src/di/Exception.php b/src/di/Exception.php
@@ -4,6 +4,6 @@
 
 namespace Ray\Di;
 
-class Exception extends \Exception
+final class Exception extends \Exception
 {
 }
diff --git a/src/di/Exception/DirectoryNotWritable.php b/src/di/Exception/DirectoryNotWritable.php
@@ -6,6 +6,6 @@
 
 use RuntimeException;
 
-class DirectoryNotWritable extends RuntimeException implements ExceptionInterface
+final class DirectoryNotWritable extends RuntimeException implements ExceptionInterface
 {
 }
diff --git a/src/di/Exception/InvalidContext.php b/src/di/Exception/InvalidContext.php
@@ -6,6 +6,6 @@
 
 use InvalidArgumentException;
 
-class InvalidContext extends InvalidArgumentException implements ExceptionInterface
+final class InvalidContext extends InvalidArgumentException implements ExceptionInterface
 {
 }
diff --git a/src/di/Exception/InvalidProvider.php b/src/di/Exception/InvalidProvider.php
@@ -6,6 +6,6 @@
 
 use InvalidArgumentException;
 
-class InvalidProvider extends InvalidArgumentException implements ExceptionInterface
+final class InvalidProvider extends InvalidArgumentException implements ExceptionInterface
 {
 }
diff --git a/src/di/Exception/InvalidToConstructorNameParameter.php b/src/di/Exception/InvalidToConstructorNameParameter.php
@@ -9,6 +9,6 @@
 /**
  * @see https://github.com/ray-di/Ray.Di#constructor-bindings
  */
-class InvalidToConstructorNameParameter extends InvalidArgumentException implements ExceptionInterface
+final class InvalidToConstructorNameParameter extends InvalidArgumentException implements ExceptionInterface
 {
 }
diff --git a/src/di/Exception/InvalidType.php b/src/di/Exception/InvalidType.php
@@ -6,6 +6,6 @@
 
 use InvalidArgumentException;
 
-class InvalidType extends InvalidArgumentException implements ExceptionInterface
+final class InvalidType extends InvalidArgumentException implements ExceptionInterface
 {
 }
diff --git a/src/di/Exception/MethodInvocationNotAvailable.php b/src/di/Exception/MethodInvocationNotAvailable.php
@@ -4,6 +4,6 @@
 
 namespace Ray\Di\Exception;
 
-class MethodInvocationNotAvailable extends Unbound
+final class MethodInvocationNotAvailable extends Unbound
 {
 }
diff --git a/src/di/Exception/NotFound.php b/src/di/Exception/NotFound.php
@@ -6,6 +6,6 @@
 
 use LogicException;
 
-class NotFound extends LogicException implements ExceptionInterface
+final class NotFound extends LogicException implements ExceptionInterface
 {
 }
diff --git a/src/di/Exception/SetNotFound.php b/src/di/Exception/SetNotFound.php
@@ -6,6 +6,6 @@
 
 use LogicException;
 
-class SetNotFound extends LogicException implements ExceptionInterface
+final class SetNotFound extends LogicException implements ExceptionInterface
 {
 }
diff --git a/src/di/Exception/Untargeted.php b/src/di/Exception/Untargeted.php
@@ -4,6 +4,6 @@
 
 namespace Ray\Di\Exception;
 
-class Untargeted extends Unbound
+final class Untargeted extends Unbound
 {
 }
diff --git a/src/di/InjectionPoint.php b/src/di/InjectionPoint.php
@@ -32,7 +32,7 @@ final class InjectionPoint implements InjectionPointInterface, Serializable
     public function __construct(ReflectionParameter $parameter)
     {
         $this->parameter = $parameter;
-        $this->pFunction = (string) $parameter->getDeclaringFunction()->name;
+        $this->pFunction = $parameter->getDeclaringFunction()->name;
         $class = $parameter->getDeclaringClass();
         $this->pClass = $class instanceof ReflectionClass ? $class->name : '';
         $this->pName = $parameter->name;
diff --git a/src/di/Injector.php b/src/di/Injector.php
@@ -18,7 +18,7 @@
 use function str_replace;
 use function sys_get_temp_dir;
 
-class Injector implements InjectorInterface
+final class Injector implements InjectorInterface
 {
     /** @var non-empty-string */
     private $classDir;
diff --git a/src/di/MultiBinding/MultiBindingModule.php b/src/di/MultiBinding/MultiBindingModule.php
@@ -9,7 +9,7 @@
 use Ray\Di\AbstractModule;
 use Ray\Di\Scope;
 
-class MultiBindingModule extends AbstractModule
+final class MultiBindingModule extends AbstractModule
 {
     protected function configure(): void
     {
diff --git a/src/di/Name.php b/src/di/Name.php
@@ -12,7 +12,6 @@
 use ReflectionMethod;
 use ReflectionParameter;
 
-use function assert;
 use function class_exists;
 use function explode;
 use function get_class;
@@ -153,12 +152,11 @@ private function parseName(string $name): array
             if (isset($exploded[1])) {
                 [$key, $value] = $exploded;
                 if (isset($key[0]) && $key[0] === '$') {
-                    assert(is_string($key)); // @phpstan-ignore-line
                     $key = substr($key, 1);
                 }
 
                 /** @psalm-suppress MixedArgument */
-                $names[trim($key)] = trim($value);
+                $names[trim((string) $key)] = trim($value);
             }
         }
 
diff --git a/src/di/NewInstance.php b/src/di/NewInstance.php
@@ -5,6 +5,7 @@
 namespace Ray\Di;
 
 use Ray\Aop\Bind as AopBind;
+use Ray\Aop\WeavedInterface;
 use ReflectionClass;
 use ReflectionException;
 
@@ -47,7 +48,7 @@ public function __construct(
      */
     public function __invoke(Container $container): object
     {
-        /** @psalm-suppress MixedMethodCall */
+        /** @psalm-suppress MixedMethodCall, ArgumentTypeCoercion */
         $instance = $this->arguments instanceof Arguments ? (new ReflectionClass($this->class))->newInstanceArgs($this->arguments->inject($container)) : new $this->class();
 
         return $this->postNewInstance($container, $instance);
@@ -68,6 +69,7 @@ public function __toString()
      */
     public function newInstanceArgs(Container $container, array $params): object
     {
+        /** @psalm-suppress ArgumentTypeCoercion */
         $instance = (new ReflectionClass($this->class))->newInstanceArgs($params);
 
         return $this->postNewInstance($container, $instance);
@@ -94,15 +96,22 @@ public function accept(VisitorInterface $visitor): void
 
     private function postNewInstance(Container $container, object $instance): object
     {
-        // bind dependency injected interceptors
-        if ($this->bind instanceof AspectBind) {
-            assert(isset($instance->bindings));
-            $instance->bindings = $this->bind->inject($container);
-        }
+        $this->enableAop($instance, $container);
 
         // setter injection
         ($this->setterMethods)($instance, $container);
 
         return $instance;
     }
+
+    public function enableAop(object $instance, Container $container): void
+    {
+        if (! $this->bind instanceof AspectBind) {
+            return;
+        }
+
+        assert($instance instanceof WeavedInterface);
+
+        $instance->_setBindings($this->bind->inject($container));  // Ray.Aop ^2.18
+    }
 }
diff --git a/src/di/NullModule.php b/src/di/NullModule.php
@@ -4,7 +4,7 @@
 
 namespace Ray\Di;
 
-class NullModule extends AbstractModule
+final class NullModule extends AbstractModule
 {
     protected function configure(): void
     {
diff --git a/src/di/ProviderSetModule.php b/src/di/ProviderSetModule.php
@@ -4,7 +4,7 @@
 
 namespace Ray\Di;
 
-class ProviderSetModule extends AbstractModule
+final class ProviderSetModule extends AbstractModule
 {
     protected function configure(): void
     {
diff --git a/tests/di/AnnotatedClassTest.php b/tests/di/AnnotatedClassTest.php
diff --git a/tests/di/InjectorTest.php b/tests/di/InjectorTest.php
diff --git a/tests/di/ModuleTest.php b/tests/di/ModuleTest.php
diff --git a/tests/type/InjectorInterfaceTest.php b/tests/type/InjectorInterfaceTest.php
diff --git a/vendor-bin/tools/composer.json b/vendor-bin/tools/composer.json
diff --git a/vendor-bin/tools/composer.lock b/vendor-bin/tools/composer.lock

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,8 @@`
`9`	`9`	`use Ray\Di\Di\InjectInterface;`
`10`	`10`	`use Ray\Di\Di\Named;`
`11`	`11`
	`12`	`+use function assert;`
	`13`	`+`
`12`	`14`	`use const PHP_VERSION_ID;`
`13`	`15`
`14`	`16`	`final class AnnotatedClassMethods`
`@@ -38,6 +40,7 @@ public function getConstructorName(ReflectionClass $class): Name`
`38`	`40`	`}`
`39`	`41`	`}`
`40`	`42`
	`43`	`+ assert($constructor instanceof ReflectionMethod);`
`41`	`44`	`$named = $constructor->getAnnotation(Named::class);`
`42`	`45`	`if ($named instanceof Named) {`
`43`	`46`	`return new Name($named->value);`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ public function __construct(AopBind $bind)`
`22`	`22`	`/**`
`23`	`23`	`* Instantiate interceptors`
`24`	`24`	`*`
`25`		`- * @return array<string, list<MethodInterceptor>>`
	`25`	`+ * @return array<non-empty-string, list<MethodInterceptor>>`
`26`	`26`	`*/`
`27`	`27`	`public function inject(Container $container): array`
`28`	`28`	`{`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`	`/**`
`10`	`10`	`* Assisted module for php8 attributes`
`11`	`11`	`*/`
`12`		`-class AssistedInjectModule extends AbstractModule`
	`12`	`+final class AssistedInjectModule extends AbstractModule`
`13`	`13`	`{`
`14`	`14`	`protected function configure(): void`
`15`	`15`	`{`
Original file line number	Diff line number	Diff line change
`@@ -117,7 +117,7 @@ public function toConstructor(string $class, $name, ?InjectionPoints $injectionP`
`117`	`117`	`}`
`118`	`118`
`119`	`119`	`$this->untarget = null;`
`120`		`- $postConstructRef = $postConstruct ? new ReflectionMethod($class, $postConstruct) : null;`
	`120`	`+ $postConstructRef = $postConstruct !== null ? new ReflectionMethod($class, $postConstruct) : null;`
`121`	`121`	`/** @var ReflectionClass<object> $reflection */`
`122`	`122`	`$reflection = new ReflectionClass($class);`
`123`	`123`	`$this->bound = (new DependencyFactory())->newToConstructor($reflection, $name, $injectionPoints, $postConstructRef);`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ public function to(string $interface, string $class): ReflectionClass`
`42`	`42`	`throw new InvalidType("[{$class}] is no implemented [{$interface}] interface");`
`43`	`43`	`}`
`44`	`44`
`45`		`- return new ReflectionClass($class); // @phpstan-ignore-line`
	`45`	`+ return new ReflectionClass($class);`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`/**`