Merge pull request #47 from smeghead/phpstan

smeghead · web-flow · commit a618bfe9d7ba · 2023-07-29T18:28:06.000+09:00
introduced PHPStan.
diff --git a/composer.json b/composer.json
@@ -13,7 +13,8 @@
     },
     "require-dev": {
         "phpunit/phpunit": "^9.5",
-        "clue/phar-composer": "^1.2"
+        "clue/phar-composer": "^1.2",
+        "phpstan/phpstan": "^1.10"
     },
     "license": "Apache-2.0",
     "autoload": {
diff --git a/dogfood-model.png b/dogfood-model.png
diff --git a/dogfood.png b/dogfood.png
diff --git a/phpstan.neon b/phpstan.neon
@@ -0,0 +1,5 @@
+parameters:
+	level: 6
+	paths:
+		- src
+		- tests
diff --git a/src/Config/Options.php b/src/Config/Options.php
@@ -6,17 +6,21 @@
 
 class Options
 {
+    /** @var array<string, mixed> */
     private array $opt;
 
-    const PHP5 = 'php5';
-    const PHP7 = 'php7';
-    const PHP8 = 'php8';
+    public const PHP5 = 'php5';
+    public const PHP7 = 'php7';
+    public const PHP8 = 'php8';
 
-    const DIAGRAM_CLASS = 'class';
-    const DIAGRAM_PACKAGE = 'package';
-    const DIAGRAM_JIG = 'jig';
-    const DIAGRAM_DIVSION = 'division';
+    public const DIAGRAM_CLASS = 'class';
+    public const DIAGRAM_PACKAGE = 'package';
+    public const DIAGRAM_JIG = 'jig';
+    public const DIAGRAM_DIVSION = 'division';
 
+    /**
+     * @param array<string, mixed> $opt Option array
+     */
     public function __construct(array $opt)
     {
         $this->opt = $opt;
diff --git a/src/DiagramElement/Division/DivisionColor.php b/src/DiagramElement/Division/DivisionColor.php
@@ -6,7 +6,7 @@
 
 class DivisionColor
 {
-    private static $gen;
+    private static \Generator $gen;
     public static function nextColor(): string
     {
         if (empty(self::$gen)) {
@@ -27,6 +27,7 @@ function generateDivisionColorGenerator(): \Generator
         '#ccffff',
         '#ffccff',
     ];
+    // @phpstan-ignore-next-line
     while (true) {
         foreach ($COLORS as $c) {
             yield $c;
diff --git a/src/DiagramElement/Entry.php b/src/DiagramElement/Entry.php
@@ -42,7 +42,10 @@ public function getClass(): PhpClass
         return $this->class;
     }
 
-    public function dump($level = 0): array
+    /**
+     * @return string[] diagram lines.
+     */
+    public function dump(int $level = 0): array
     {
         $indent = str_repeat('  ', $level);
         $lines = [];
@@ -78,7 +81,10 @@ public function dump($level = 0): array
         return $lines;
     }
 
-    public function dumpDivisions($level = 0): array
+    /**
+     * @return string[] diagram lines.
+     */
+    public function dumpDivisions(int $level = 0): array
     {
         $indent = str_repeat('  ', $level);
         $lines = [];
@@ -125,6 +131,9 @@ private function modifier(PhpAccessModifier $modifier): string
         return implode(' ', $expressions);
     }
 
+    /**
+     * @return Arrow[] arrows
+     */
     public function getArrows(): array
     {
         $arrows = [];
diff --git a/src/DiagramElement/Package.php b/src/DiagramElement/Package.php
@@ -20,6 +20,9 @@ class Package
     /** @var Entry[] entries */
     public array $entries = [];
 
+    /**
+     * @param string[] $parents
+     */
     public function __construct(array $parents, string $name, Options $options)
     {
         $this->parents = $parents;
@@ -32,6 +35,9 @@ public function getLogicalName(): string
         return implode('.', array_merge(array_slice($this->parents, 1), [$this->name]));
     }
 
+    /**
+     * @param string[] $paths Paths
+     */
     public function addEntry(array $paths, Entry $entry): string
     {
         if (count($paths) === 0) {
@@ -68,7 +74,10 @@ private function findChild(string $dir): Package
         return end($this->children);
     }
 
-    public function dump($level = 0): array
+    /**
+     * @return string[] diagram lines.
+     */
+    public function dump(int $level = 0): array
     {
         $indent = str_repeat('  ', $level);
         $lines = [];
@@ -92,7 +101,10 @@ public function dump($level = 0): array
         return $lines;
     }
 
-    public function dumpPackages($level = 1): array
+    /**
+     * @return string[] diagram lines.
+     */
+    public function dumpPackages(int $level = 1): array
     {
         $indent = str_repeat('  ', $level);
         $lines = [];
@@ -147,9 +159,10 @@ public function getEntries(): array
     }
 
     /**
-     * @return array useの一覧
+     * @param array<string, \Smeghead\PhpClassDiagram\Php\PhpType[]> $acc list of uses.
+     * @return array<string, \Smeghead\PhpClassDiagram\Php\PhpType[]> list of uses.
      */
-    public function getUses($acc): array
+    public function getUses(array $acc): array
     {
         $uses = [];
         foreach ($this->entries as $e) {
@@ -165,8 +178,10 @@ public function getUses($acc): array
 
     /**
      * 解析対象になっているpackage一覧を取得する。
+     * @param array<string, string> $acc
+     * @return array<string, string>
      */
-    public function getTargetPackages($acc = [])
+    public function getTargetPackages(array $acc = []): array
     {
         $acc[$this->package] = $this->getLogicalName();
         foreach ($this->children as $n) {
@@ -205,7 +220,10 @@ private function recFindPackage(string $package): ?Package
         return null;
     }
 
-    public function dumpDivisions($level = 0): array
+    /**
+     * @return string[] diagram lines.
+     */
+    public function dumpDivisions(int $level = 0): array
     {
         $indent = str_repeat('  ', $level);
         $lines = [];
diff --git a/src/DiagramElement/PackageArrow.php b/src/DiagramElement/PackageArrow.php
@@ -16,12 +16,12 @@ public function __construct(string $from, string $to)
         $this->to = $to;
     }
 
-    public function bothSideArrow()
+    public function bothSideArrow(): void
     {
         $this->bothSideArrow = true;
     }
 
-    public function isOpposite(self $other)
+    public function isOpposite(self $other): bool
     {
         if ($this->from !== $other->to) {
             return false;
diff --git a/src/DiagramElement/PackageRelations.php b/src/DiagramElement/PackageRelations.php
@@ -34,6 +34,9 @@ private function displayPackage(string $package): string
         return $package; //外部のpackageはpackage表示
     }
 
+    /**
+     * @return string[] arrows.
+     */
     public function getArrows(): array
     {
         $lines = [];
@@ -74,6 +77,10 @@ public function getArrows(): array
         return $lines;
     }
 
+    /**
+     * @param PackageArrow[] $arrows arrows.
+     * @return PackageArrow[] merged arrows.
+     */
     private function mergeBothSideArrow(array $arrows): array
     {
         $merged = [];
@@ -98,6 +105,9 @@ private function mergeBothSideArrow(array $arrows): array
         return $merged;
     }
 
+    /**
+     * @param PackageArrow[] $arrows arrows
+     */
     private function existsUpsidedown(array $arrows, PackageArrow $arrow): bool
     {
         foreach ($arrows as $a) {
diff --git a/src/DiagramElement/Relation.php b/src/DiagramElement/Relation.php
@@ -28,6 +28,9 @@ public function getPackage(): Package
         return $this->package;
     }
 
+    /**
+     * @return string[] diagram lines.
+     */
     public function dump(): array
     {
         $lines = ['@startuml class-diagram'];
@@ -41,6 +44,9 @@ public function dump(): array
         return $lines;
     }
 
+    /**
+     * @return string[] diagram lines.
+     */
     public function getRelations(): array
     {
         $entities = $this->package->getEntries();
@@ -57,6 +63,9 @@ public function getRelations(): array
         return array_unique($relation_expressions);
     }
 
+    /**
+     * @return string[] diagram lines.
+     */
     public function dumpPackages(): array
     {
         $lines = ['@startuml package-related-diagram'];
@@ -70,11 +79,17 @@ public function dumpPackages(): array
         return $lines;
     }
 
+    /**
+     * @return array<string, \Smeghead\PhpClassDiagram\Php\PhpType[]> uses.
+     */
     public function getUses(): array
     {
         return $this->package->getUses([]);
     }
 
+    /**
+     * @return string[] diagram lines.
+     */
     public function dumpDivisions(): array
     {
         $lines = ['@startuml division-diagram'];
diff --git a/src/Php/Doc/PhpDocComment.php b/src/Php/Doc/PhpDocComment.php
@@ -9,6 +9,7 @@
 class PhpDocComment
 {
     private string $text = '';
+
     public function __construct(Stmt $stmt)
     {
         $doc = $stmt->getDocComment();
diff --git a/src/Php/Finders/FindConstructerProperties.php b/src/Php/Finders/FindConstructerProperties.php
@@ -13,13 +13,14 @@
 
 class FindConstructerProperties
 {
+    /** @var \PhpParser\Node\Param[] */
     private array $properties = [];
     private ?ClassMethod $constructer;
 
     public function __construct(ClassLike $class)
     {
         $finder = new NodeFinder();
-        /** @var ClassMethod $constructer */
+        /** @var ClassMethod|null $constructer */
         $constructer = $finder->findFirst($class, function (Node $node) {
             return $node instanceof ClassMethod && $node->name->toString() === '__construct';
         });
diff --git a/src/Php/PhpClass.php b/src/Php/PhpClass.php
@@ -24,9 +24,13 @@ class PhpClass
     /** @var string[] directory parts */
     private array $dirs;
     private ClassLike $syntax;
+    /** @var \PhpParser\Node[] */
     private array $full;
 
-    public function __construct(string $filename, Stmt $syntax, array $full)
+    /**
+     * @param \PhpParser\Node[] $full
+     */
+    public function __construct(string $filename, ClassLike $syntax, array $full)
     {
         $relativePath = dirname($filename);
         if ($relativePath === '.') {
@@ -39,6 +43,9 @@ public function __construct(string $filename, Stmt $syntax, array $full)
         $this->full = $full;
     }
 
+    /**
+     * @return string[] parts of the name.
+     */
     public function getNamespace(): array
     {
         foreach ($this->full as $stmt) {
@@ -76,9 +83,6 @@ public function getClassType(): PhpType
         foreach ($this->full as $stmt) {
             if ($stmt instanceof Namespace_) {
                 $namespace = $stmt->name->parts;
-                if ($namespace === null) {
-                    var_dump($stmt);
-                }
                 break;
             }
         }
@@ -119,7 +123,12 @@ public function getUses(): array
         return $this->getUsesRec($this->full);
     }
 
-    private function getUsesRec($stmts, $uses = [])
+    /**
+     * @param \PhpParser\Node[] $stmts Stmts
+     * @param PhpType[] $uses
+     * @return PhpType[]
+     */
+    private function getUsesRec($stmts, array $uses = []): array
     {
         foreach ($stmts as $stmt) {
             if ($stmt instanceof GroupUse) {
diff --git a/src/Php/PhpReader.php b/src/Php/PhpReader.php
@@ -6,7 +6,6 @@
 
 use PhpParser\Error;
 use PhpParser\ParserFactory;
-use PhpParser\Node\Stmt;
 use PhpParser\Node\Stmt\{
     Namespace_,
     ClassLike,
@@ -17,14 +16,10 @@
 
 class PhpReader
 {
-    private string $directory;
-    private string $filename;
     private PhpClass $class;
 
-    private function __construct(string $directory, string $filename, PhpClass $class)
+    private function __construct(PhpClass $class)
     {
-        $this->directory = $directory;
-        $this->filename = $filename;
         $this->class = $class;
     }
 
@@ -64,15 +59,16 @@ public static function parseFile(string $directory, string $filename, Options $o
         $relativePath = mb_substr($filename, mb_strlen($directory) + 1);
         $classes = [];
         foreach (self::getClasses($relativePath, $ast) as $class) {
-            $classes[] = new self($directory, $filename, $class);
+            $classes[] = new self($class);
         }
         return $classes;
     }
 
     /**
-     * @return PhpClass[]
+     * @param \PhpParser\Node[] $ast
+     * @return PhpClass[]|null
      */
-    private static function getClasses(string $relativePath, array $ast): array
+    private static function getClasses(string $relativePath, array $ast): ?array
     {
         if (count($ast) === 0) {
             return null;
diff --git a/src/Php/PhpType.php b/src/Php/PhpType.php
diff --git a/src/Php/PhpTypeExpression.php b/src/Php/PhpTypeExpression.php
diff --git a/test/fixtures/phpdoc/product/Product.php b/test/fixtures/phpdoc/product/Product.php

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +parameters:
 +	level: 6
 +	paths:
 +		- src
 +		- tests
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,10 @@ public function getClass(): PhpClass`
`42`	`42`	`return $this->class;`
`43`	`43`	`}`
`44`	`44`
`45`		`- public function dump($level = 0): array`
	`45`	`+ /**`
	`46`	`+ * @return string[] diagram lines.`
	`47`	`+ */`
	`48`	`+ public function dump(int $level = 0): array`
`46`	`49`	`{`
`47`	`50`	`$indent = str_repeat(' ', $level);`
`48`	`51`	`$lines = [];`
`@@ -78,7 +81,10 @@ public function dump($level = 0): array`
`78`	`81`	`return $lines;`
`79`	`82`	`}`
`80`	`83`
`81`		`- public function dumpDivisions($level = 0): array`
	`84`	`+ /**`
	`85`	`+ * @return string[] diagram lines.`
	`86`	`+ */`
	`87`	`+ public function dumpDivisions(int $level = 0): array`
`82`	`88`	`{`
`83`	`89`	`$indent = str_repeat(' ', $level);`
`84`	`90`	`$lines = [];`
`@@ -125,6 +131,9 @@ private function modifier(PhpAccessModifier $modifier): string`
`125`	`131`	`return implode(' ', $expressions);`
`126`	`132`	`}`
`127`	`133`
	`134`	`+ /**`
	`135`	`+ * @return Arrow[] arrows`
	`136`	`+ */`
`128`	`137`	`public function getArrows(): array`
`129`	`138`	`{`
`130`	`139`	`$arrows = [];`
Original file line number	Diff line number	Diff line change
`@@ -16,12 +16,12 @@ public function __construct(string $from, string $to)`
`16`	`16`	`$this->to = $to;`
`17`	`17`	`}`
`18`	`18`
`19`		`- public function bothSideArrow()`
	`19`	`+ public function bothSideArrow(): void`
`20`	`20`	`{`
`21`	`21`	`$this->bothSideArrow = true;`
`22`	`22`	`}`
`23`	`23`
`24`		`- public function isOpposite(self $other)`
	`24`	`+ public function isOpposite(self $other): bool`
`25`	`25`	`{`
`26`	`26`	`if ($this->from !== $other->to) {`
`27`	`27`	`return false;`
Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,9 @@ private function displayPackage(string $package): string`
`34`	`34`	`return $package; //外部のpackageはpackage表示`
`35`	`35`	`}`
`36`	`36`
	`37`	`+ /**`
	`38`	`+ * @return string[] arrows.`
	`39`	`+ */`
`37`	`40`	`public function getArrows(): array`
`38`	`41`	`{`
`39`	`42`	`$lines = [];`
`@@ -74,6 +77,10 @@ public function getArrows(): array`
`74`	`77`	`return $lines;`
`75`	`78`	`}`
`76`	`79`
	`80`	`+ /**`
	`81`	`+ * @param PackageArrow[] $arrows arrows.`
	`82`	`+ * @return PackageArrow[] merged arrows.`
	`83`	`+ */`
`77`	`84`	`private function mergeBothSideArrow(array $arrows): array`
`78`	`85`	`{`
`79`	`86`	`$merged = [];`
`@@ -98,6 +105,9 @@ private function mergeBothSideArrow(array $arrows): array`
`98`	`105`	`return $merged;`
`99`	`106`	`}`
`100`	`107`
	`108`	`+ /**`
	`109`	`+ * @param PackageArrow[] $arrows arrows`
	`110`	`+ */`
`101`	`111`	`private function existsUpsidedown(array $arrows, PackageArrow $arrow): bool`
`102`	`112`	`{`
`103`	`113`	`foreach ($arrows as $a) {`