Resolve services defined by string & BaseObject configurations (proget-hq#38)

Author: przepompownia

src/ServiceMap.php

@@ -5,6 +5,7 @@
 namespace Proget\PHPStan\Yii2;
 
 use PhpParser\Node;
+use yii\base\BaseObject;
 
 final class ServiceMap
 {
@@ -33,18 +34,19 @@ public function __construct(string $configPath)
         foreach ($config['container']['singletons'] ?? [] as $id => $service) {
             $this->addServiceDefinition($id, $service);
         }
+
         foreach ($config['container']['definitions'] ?? [] as $id => $service) {
             $this->addServiceDefinition($id, $service);
         }
 
         foreach ($config['components'] ?? [] as $id => $component) {
-            if (is_object($component)) {
+            if (\is_object($component)) {
                 $this->components[$id] = \get_class($component);
                 continue;
             }
 
-            if (!is_array($component)) {
-                throw new \RuntimeException(sprintf('Invalid value for component with id %s. Expected object or array.', $id));
+            if (!\is_array($component)) {
+                throw new \RuntimeException(\sprintf('Invalid value for component with id %s. Expected object or array.', $id));
             }
 
             if (null !== $class = $component['class'] ?? null) {
@@ -70,19 +72,49 @@ public function getComponentClassById(string $id): ?string
     /**
      * @param string|\Closure|array<mixed> $service
      *
-     * @throws \ReflectionException
+     * @throws \RuntimeException|\ReflectionException
      */
     private function addServiceDefinition(string $id, $service): void
     {
+        $this->services[$id] = $this->guessServiceDefinition($id, $service);
+    }
+
+    /**
+     * @param string|\Closure|array<mixed> $service
+     *
+     * @throws \RuntimeException|\ReflectionException
+     */
+    private function guessServiceDefinition(string $id, $service): string
+    {
+        if (\is_string($service) && \class_exists($service)) {
+            return $service;
+        }
+
         if ($service instanceof \Closure || \is_string($service)) {
             $returnType = (new \ReflectionFunction($service))->getReturnType();
             if (!$returnType instanceof \ReflectionNamedType) {
-                throw new \RuntimeException(sprintf('Please provide return type for %s service closure', $id));
+                throw new \RuntimeException(\sprintf('Please provide return type for %s service closure', $id));
             }
 
-            $this->services[$id] = $returnType->getName();
-        } else {
-            $this->services[$id] = $service['class'] ?? $service[0]['class'];
+            return $returnType->getName();
         }
+
+        if (!\is_array($service)) {
+            throw new \RuntimeException(\sprintf('Unsupported service definition for %s', $id));
+        }
+
+        if (isset($service['class'])) {
+            return $service['class'];
+        }
+
+        if (isset($service[0]['class'])) {
+            return $service[0]['class'];
+        }
+
+        if (\is_subclass_of($id, BaseObject::class)) {
+            return $id;
+        }
+
+        throw new \RuntimeException(\sprintf('Cannot guess service definition for %s', $id));
     }
 }

tests/ServiceMapTest.php

@@ -27,6 +27,22 @@ public function testThrowExceptionWhenClosureServiceHasMissingReturnType(): void
         new ServiceMap(__DIR__.DIRECTORY_SEPARATOR.'assets'.DIRECTORY_SEPARATOR.'yii-config-invalid.php');
     }
 
+    public function testThrowExceptionWhenServiceHasUnsupportedType(): void
+    {
+        $this->expectException(\RuntimeException::class);
+        $this->expectExceptionMessage('Unsupported service definition for unsupported-type');
+
+        new ServiceMap(__DIR__.DIRECTORY_SEPARATOR.'assets'.DIRECTORY_SEPARATOR.'yii-config-invalid-unsupported-type.php');
+    }
+
+    public function testThrowExceptionWhenServiceHasUnsupportedArray(): void
+    {
+        $this->expectException(\RuntimeException::class);
+        $this->expectExceptionMessage('Cannot guess service definition for unsupported-array');
+
+        new ServiceMap(__DIR__.DIRECTORY_SEPARATOR.'assets'.DIRECTORY_SEPARATOR.'yii-config-invalid-unsupported-array.php');
+    }
+
     public function testThrowExceptionWhenComponentHasInvalidValue(): void
     {
         $this->expectException(\RuntimeException::class);
@@ -39,6 +55,8 @@ public function testItLoadsServicesAndComponents(): void
     {
         $serviceMap = new ServiceMap(__DIR__.DIRECTORY_SEPARATOR.'assets'.DIRECTORY_SEPARATOR.'yii-config-valid.php');
 
+        self::assertSame(MyActiveRecord::class, $serviceMap->getServiceClassFromNode(new String_('singleton-string')));
+        self::assertSame(MyActiveRecord::class, $serviceMap->getServiceClassFromNode(new String_(MyActiveRecord::class)));
         self::assertSame(\SplStack::class, $serviceMap->getServiceClassFromNode(new String_('singleton-closure')));
         self::assertSame(\SplObjectStorage::class, $serviceMap->getServiceClassFromNode(new String_('singleton-service')));
         self::assertSame(\SplFileInfo::class, $serviceMap->getServiceClassFromNode(new String_('singleton-nested-service-class')));

tests/assets/yii-config-invalid-unsupported-array.php

@@ -0,0 +1,7 @@
+<?php
+
+return [
+    'container' => ['singletons' => [
+        'unsupported-array' => [],
+    ]]
+];

tests/assets/yii-config-invalid-unsupported-type.php

@@ -0,0 +1,7 @@
+<?php
+
+return [
+    'container' => ['singletons' => [
+        'unsupported-type' => 1,
+    ]]
+];

tests/assets/yii-config-valid.php

@@ -11,6 +11,7 @@
     ],
     'container' => [
         'singletons' => [
+            'singleton-string' => MyActiveRecord::class,
             'singleton-closure' => function(): \SplStack {
                 return new \SplStack();
             },
@@ -26,7 +27,10 @@
             'service' => ['class' => \SplObjectStorage::class],
             'nested-service-class' => [
                 ['class' => \SplFileInfo::class]
-            ]
+            ],
+            MyActiveRecord::class => [
+                'flag' => 'foo',
+            ],
         ]
     ]
 ];