Merge pull request #49 from smeghead/add-relations-from-method-code

smeghead · web-flow · commit e3b7b7aa36f6 · 2023-09-05T21:58:00.000+09:00
feat: search dependency from method code.
diff --git a/.github/workflows/php.yml b/.github/workflows/php.yml
@@ -15,7 +15,7 @@ jobs:
         php-versions: ['8.0', '8.1', '8.2']
     name: PHP ${{ matrix.php-versions }} Test
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     
     - name: Install PHP
       uses: shivammathur/setup-php@v2
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,7 @@
 ### Features
 
  * added to run PHPStan in GitHub Action flow.
+ * Until now, dependency information was obtained from class fields and method signatures, but now the dependency information is also obtained from within the method code.
 
 ## v1.1.1 (2023-07-30)
 
diff --git a/composer.json b/composer.json
@@ -31,7 +31,7 @@
     ],
     "scripts": {
         "test": [
-            "php vendor/phpunit/phpunit/phpunit test/"
+            "php vendor/phpunit/phpunit/phpunit --colors test/"
         ],
         "build": [
             "php -d phar.readonly=off ./vendor/bin/phar-composer build ./"
diff --git a/dogfood-model.png b/dogfood-model.png
diff --git a/dogfood-package.png b/dogfood-package.png
diff --git a/dogfood.png b/dogfood.png
diff --git a/src/DiagramElement/Entry.php b/src/DiagramElement/Entry.php
@@ -166,4 +166,16 @@ public function getArrows(): array
 
         return $arrows;
     }
+
+    /**
+     * @return Arrow[] using arrows.
+     */
+    public function getUsingArrows(): array
+    {
+        $arrows = [];
+        foreach ($this->getClass()->getUsingTypes() as $t) {
+            $arrows[] = new ArrowDependency($this->class, $t);
+        }
+        return $arrows;
+    }
 }
diff --git a/src/DiagramElement/Package.php b/src/DiagramElement/Package.php
@@ -143,6 +143,10 @@ public function getArrows(): array
         foreach ($this->children as $n) {
             $arrows = array_merge($arrows, $n->getArrows());
         }
+        foreach ($this->entries as $n) {
+            $arrows = array_merge($arrows, $n->getUsingArrows());
+        }
+
         return $arrows;
     }
 
diff --git a/src/DiagramElement/Relation.php b/src/DiagramElement/Relation.php
@@ -49,9 +49,9 @@ public function dump(): array
      */
     public function getRelations(): array
     {
-        $entities = $this->package->getEntries();
-        $relation_expressions = array_map(function (Arrow $x) use ($entities) {
-            foreach ($entities as $e) {
+        $entries = $this->package->getEntries();
+        $relation_expressions = array_map(function (Arrow $x) use ($entries) {
+            foreach ($entries as $e) {
                 if ($e->getClass()->getClassType()->equals($x->getTo())) {
                     return $x->toString($e->getClass());
                 }
@@ -60,7 +60,7 @@ public function getRelations(): array
         }, $this->package->getArrows());
         $relation_expressions = array_filter($relation_expressions);
         sort($relation_expressions);
-        return array_unique($relation_expressions);
+        return array_values(array_unique($relation_expressions));
     }
 
     /**
diff --git a/src/Php/Doc/PhpDocComment.php b/src/Php/Doc/PhpDocComment.php
@@ -4,7 +4,7 @@
 
 namespace Smeghead\PhpClassDiagram\Php\Doc;
 
-use PhpParser\Node\Stmt;
+use PhpParser\Node;
 use PHPStan\PhpDocParser\Ast\PhpDoc\ParamTagValueNode;
 use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocNode;
 use PHPStan\PhpDocParser\Lexer\Lexer;
@@ -17,7 +17,7 @@ class PhpDocComment
 {
     private string $text = '';
 
-    public function __construct(Stmt $stmt)
+    public function __construct(Node $stmt)
     {
         $doc = $stmt->getDocComment();
         if (!empty($doc)) {
diff --git a/src/Php/Finders/FindConstructerProperties.php b/src/Php/Finders/FindConstructerProperties.php
@@ -11,7 +11,7 @@
 use PhpParser\Node\Stmt\ClassMethod;
 use PhpParser\NodeFinder;
 
-class FindConstructerProperties
+final class FindConstructerProperties
 {
     /** @var \PhpParser\Node\Param[] */
     private array $properties = [];
diff --git a/src/Php/Finders/FindUsePhpTypes.php b/src/Php/Finders/FindUsePhpTypes.php
@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Smeghead\PhpClassDiagram\Php\Finders;
+
+use PhpParser\Node;
+use PhpParser\Node\Name\FullyQualified;
+use PhpParser\Node\Param;
+use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\Stmt\ClassLike;
+use PhpParser\Node\Stmt\ClassMethod;
+use PhpParser\NodeFinder;
+use Smeghead\PhpClassDiagram\Php\PhpType;
+
+final class FindUsePhpTypes
+{
+    private ClassLike $class;
+
+    public function __construct(ClassLike $class)
+    {
+        $this->class = $class;
+    }
+
+    /**
+     * @return PhpType[] use class types.
+     */
+    public function collectTypes(): array
+    {
+        $finder = new NodeFinder();
+        $methods = $finder->find($this->class, function (Node $node) {
+            return $node instanceof ClassMethod;
+        });
+        /** @var FullyQualified[] */
+        $useClasses = [];
+        foreach ($methods as $m) {
+            $useClasses = array_merge($useClasses, $finder->find($m, function (Node $node) {
+                return $node instanceof FullyQualified;
+            }));
+        }
+        // @phpstan-ignore-next-line
+        return array_map(function(FullyQualified $x): PhpType {
+            $parts = $x->parts;
+            $name = array_pop($parts);
+            return new PhpType($parts, '', $name);
+        }, $useClasses);
+    }
+}
diff --git a/src/Php/PhpClass.php b/src/Php/PhpClass.php
@@ -18,6 +18,7 @@
 };
 use Smeghead\PhpClassDiagram\Php\Doc\PhpDocComment;
 use Smeghead\PhpClassDiagram\Php\Finders\FindConstructerProperties;
+use Smeghead\PhpClassDiagram\Php\Finders\FindUsePhpTypes;
 
 class PhpClass
 {
@@ -221,4 +222,13 @@ public function getDescription(): string
         $doc = new PhpDocComment($this->syntax);
         return $doc->getDescription();
     }
+
+    /**
+     * @return PhpType[] using types.
+     */
+    public function getUsingTypes(): array
+    {
+        $finder = new FindUsePhpTypes($this->syntax);
+        return $finder->collectTypes();
+    }
 }
diff --git a/src/Php/PhpTypeExpression.php b/src/Php/PhpTypeExpression.php
@@ -4,6 +4,7 @@
 
 namespace Smeghead\PhpClassDiagram\Php;
 
+use PhpParser\Node;
 use PhpParser\Node\Identifier;
 use PhpParser\Node\Name;
 use PhpParser\Node\Name\FullyQualified;
@@ -28,13 +29,13 @@ class PhpTypeExpression
     private array $uses;
 
     /**
-     * @param Param|Property|ClassMethod|Name $stmt 対象のツリー
+     * @param Node|Param|Property|ClassMethod|Name $stmt 対象のツリー
      * @param string $targetType 
      * @param string[] $currentNamespace
      * @param string $docString
      * @param PhpType[] $uses
      */
-    private function __construct(NodeAbstract $stmt, string $targetType, array $currentNamespace, string $docString, array $uses)
+    private function __construct(Node $stmt, string $targetType, array $currentNamespace, string $docString, array $uses)
     {
         if (!in_array($targetType, [self::VAR, self::PARAM, self::RETURN_TYPE, self::FOR_TEST])) {
             throw new \Exception('invalid tag.');
@@ -44,6 +45,7 @@ private function __construct(NodeAbstract $stmt, string $targetType, array $curr
         }
         $this->uses = $uses;
 
+        // @phpstan-ignore-next-line
         $type = $stmt->{$targetType === self::RETURN_TYPE ? 'returnType' : 'type'};
         if (!empty($docString)) {
             $docString = preg_replace('/^\((.*)\)$/', '$1', $docString);
@@ -63,13 +65,13 @@ private function __construct(NodeAbstract $stmt, string $targetType, array $curr
     }
 
     /**
-     * @param Param|Property|ClassMethod $stmt 対象のツリー
+     * @param Node|Param|Property|ClassMethod $stmt 対象のツリー
      * @param string[] $currentNamespace
      * @param PhpType[] $uses
      * @return self
      */
     public static function buildByVar(
-        NodeAbstract $stmt,
+        Node $stmt,
         array $currentNamespace,
         array $uses
     ): self {
@@ -79,16 +81,16 @@ public static function buildByVar(
     }
 
     /**
-     * @param Param|Property|ClassMethod $stmt 対象のツリー
+     * @param Node|Param|Property|ClassMethod $stmt 対象のツリー
      * @param string[] $currentNamespace
      * @param ClassMethod $method
      * @param PhpType[] $uses
      * @return self
      */
     public static function buildByMethodParam(
-        NodeAbstract $stmt,
+        Node $stmt,
         array $currentNamespace,
-        ClassMethod $method,
+        Node $method,
         string $paramName,
         array $uses
     ): self {
@@ -104,7 +106,7 @@ public static function buildByMethodParam(
      * @return self
      */
     public static function buildByMethodReturn(
-        NodeAbstract $stmt,
+        Node $stmt,
         array $currentNamespace,
         array $uses
     ): self {
diff --git a/test/FindUsePhpTypesTest.php b/test/FindUsePhpTypesTest.php
@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+use PHPUnit\Framework\TestCase;
+use Smeghead\PhpClassDiagram\Config\Options;
+use Smeghead\PhpClassDiagram\Php\PhpReader;
+
+final class FindUsePhpTypesTest extends TestCase
+{
+    private string $fixtureDir;
+    public function setUp(): void
+    {
+        $this->fixtureDir = sprintf('%s/fixtures', __DIR__);
+    }
+
+    public function testMainUseProduct(): void
+    {
+        $directory = sprintf('%s/namespace', $this->fixtureDir);
+        $filename = sprintf('%s/%s', $directory, 'product/Main.php');
+        $options = new Options([]);
+        $classes = PhpReader::parseFile($directory, $filename, $options);
+
+        $class = $classes[0]->getInfo();
+        $types = $class->getUsingTypes();
+        $this->assertSame(['hoge', 'fuga', 'product'], $types[0]->getNamespace());
+        $this->assertSame('Product', $types[0]->getName());
+    }
+
+}
diff --git a/test/PackageTest.php b/test/PackageTest.php
@@ -14,7 +14,7 @@
 
 final class PackageTest extends TestCase
 {
-    private $fixtureDir;
+    private string $fixtureDir;
 
     public function setUp(): void
     {
diff --git a/test/PhpDocCommentTest.php b/test/PhpDocCommentTest.php
@@ -15,7 +15,7 @@
 
 final class PhpDocCommentTest extends TestCase
 {
-    private $fixtureDir;
+    private string $fixtureDir;
     public function setUp(): void
     {
         $this->fixtureDir = sprintf('%s/fixtures', __DIR__);
diff --git a/test/PhpReflectionTest.php b/test/PhpReflectionTest.php
@@ -10,7 +10,7 @@
 
 final class PhpReflectionTest extends TestCase
 {
-    private $fixtureDir;
+    private string $fixtureDir;
     public function setUp(): void
     {
         $this->fixtureDir = sprintf('%s/fixtures', __DIR__);
diff --git a/test/PhpTypeExpressionTest.php b/test/PhpTypeExpressionTest.php
@@ -14,7 +14,7 @@
 
 final class PhpTypeExpressionTest extends TestCase
 {
-    private $fixtureDir;
+    private string $fixtureDir;
     public function setUp(): void
     {
         $this->fixtureDir = sprintf('%s/fixtures', __DIR__);
diff --git a/test/RelationTest.php b/test/RelationTest.php
@@ -13,7 +13,7 @@
 
 final class RelationTest extends TestCase
 {
-    private $fixtureDir;
+    private string $fixtureDir;
     public function setUp(): void
     {
         $this->fixtureDir = sprintf('%s/fixtures', __DIR__);
@@ -66,6 +66,28 @@ public function testGetRelations1(): void
         $this->assertSame('  product_Product ..> product_Price', $relations[1], 'relation 2');
         $this->assertSame('  product_Product ..> product_Product', $relations[2], 'relation 3');
     }
+    public function testGetRelations_in_code_dependency(): void
+    {
+        $directory = sprintf('%s/namespace', $this->fixtureDir);
+        $options = new Options([]);
+        $files = [
+            'product/Product.php',
+            'product/Main.php',
+        ];
+        $entries = [];
+        foreach ($files as $f) {
+            $filename = sprintf('%s/%s', $directory, $f);
+            $classes = PhpReader::parseFile($directory, $filename, $options);
+            foreach ($classes as $c) {
+                $entries = array_merge($entries, [new Entry(dirname($f), $c->getInfo(), $options)]);
+            }
+        }
+        $rel = new Relation($entries, $options);
+        $relations = $rel->getRelations();
+
+        $this->assertSame(2, count($relations), 'count');
+        $this->assertSame('  product_Main ..> product_Product', $relations[0], 'relation 0');
+    }
 
     public function testGetRelations2(): void
     {
diff --git a/test/fixtures/namespace/product/Main.php b/test/fixtures/namespace/product/Main.php
@@ -0,0 +1,15 @@
+<?php
+namespace hoge\fuga\product;
+
+use hoge\fuga\product\ {
+    Product,
+};
+
+class Main {
+ 
+    public function __construct()
+    {
+        $product = new Product();
+        $product->method1('test');
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -143,6 +143,10 @@ public function getArrows(): array`
`143`	`143`	`foreach ($this->children as $n) {`
`144`	`144`	`$arrows = array_merge($arrows, $n->getArrows());`
`145`	`145`	`}`
	`146`	`+ foreach ($this->entries as $n) {`
	`147`	`+ $arrows = array_merge($arrows, $n->getUsingArrows());`
	`148`	`+ }`
	`149`	`+`
`146`	`150`	`return $arrows;`
`147`	`151`	`}`
`148`	`152`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`
`5`	`5`	`namespace Smeghead\PhpClassDiagram\Php\Doc;`
`6`	`6`
`7`		`-use PhpParser\Node\Stmt;`
	`7`	`+use PhpParser\Node;`
`8`	`8`	`use PHPStan\PhpDocParser\Ast\PhpDoc\ParamTagValueNode;`
`9`	`9`	`use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocNode;`
`10`	`10`	`use PHPStan\PhpDocParser\Lexer\Lexer;`
`@@ -17,7 +17,7 @@ class PhpDocComment`
`17`	`17`	`{`
`18`	`18`	`private string $text = '';`
`19`	`19`
`20`		`- public function __construct(Stmt $stmt)`
	`20`	`+ public function __construct(Node $stmt)`
`21`	`21`	`{`
`22`	`22`	`$doc = $stmt->getDocComment();`
`23`	`23`	`if (!empty($doc)) {`