Improve typing

Author: kylekatarnls

.phan/config.php

@@ -0,0 +1,26 @@
+<?php
+
+/**
+ * This configuration will be read and overlaid on top of the
+ * default configuration. Command-line arguments will be applied
+ * after this file is read.
+ */
+return [
+    'target_php_version' => '7.3',
+    'directory_list' => [
+        'src',
+        'vendor',
+    ],
+    'exclude_file_regex' => '@^vendor/.*/(tests?|Tests?)/@',
+    'exclude_analysis_directory_list' => [
+        'vendor'
+    ],
+    'plugins' => [
+        'AlwaysReturnPlugin',
+        'UnreachableCodePlugin',
+        'DollarDollarPlugin',
+        'DuplicateArrayKeyPlugin',
+        'PregRegexCheckerPlugin',
+        'PrintfCheckerPlugin',
+    ],
+];

composer.json

@@ -27,6 +27,7 @@
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^2.15.0",
+        "phan/phan": "^2.3",
         "phpunit/phpunit": "^8.0",
         "phpmd/phpmd": "^2.7",
         "phpstan/phpstan": "^0.11.15",
@@ -51,11 +52,15 @@
         ],
         "style-check": [
             "@phpcs",
+            "@phpcsf",
             "@phpstan",
-            "@phpmd"
+            "@phpmd",
+            "@psalm"
         ],
         "phpunit": "phpunit --verbose",
-        "phpcs": "php-cs-fixer fix -v --diff --dry-run",
+        "phan": "phan",
+        "phpcs": "phpcs",
+        "phpcsf": "php-cs-fixer fix -v --diff --dry-run",
         "phpstan": "phpstan analyse src tests",
         "phpmd": "phpmd src text phpmd.xml",
         "psalm": "psalm"

src/Phug/Split.php

@@ -8,6 +8,11 @@
 use Phug\Split\Command\Update;
 use SimpleCli\SimpleCli;
 
+/**
+ * Class Split: main CLI program to manage split packages in a mono-repository.
+ *
+ * @psalm-suppress PropertyNotSetInConstructor
+ */
 class Split extends SimpleCli
 {
     public function getCommands(): array
@@ -20,12 +25,12 @@ public function getCommands(): array
         ];
     }
 
-    public function gray()
+    public function gray(): void
     {
         $this->write($this->getColorCode('dark_gray'));
     }
 
-    public function discolor()
+    public function discolor(): void
     {
         $this->write($this->escapeCharacter.'[0m');
     }
@@ -44,7 +49,7 @@ public function warning(string $error): bool
         return false;
     }
 
-    public function chdir($directory): bool
+    public function chdir(string $directory): bool
     {
         if ($directory !== getcwd()) {
             $this->writeLine("cd $directory", 'light_blue');

src/Phug/Split/Command/Analyze.php

@@ -32,7 +32,7 @@ class Analyze extends CommandBase
     /**
      * Last AST of projects.
      *
-     * @var array[]
+     * @var ?iterable<array>
      */
     protected $ast;
 
@@ -43,6 +43,8 @@ class Analyze extends CommandBase
      */
     public function run(SimpleCli $cli): bool
     {
+        $cli = $this->getSplitCli($cli);
+
         return $this->calculatePackagesTree($cli) &&
             $this->dumpPackagesTree($cli, $this->getPackages());
     }
@@ -82,11 +84,12 @@ protected function getPackages(): iterable
             $this->ast = iterator_to_array($this->ast);
         }
 
-        return $this->ast;
+        return $this->ast ?: [];
     }
 
     protected function dumpPackagesTree(Split $cli, iterable $packages, int $level = 0): bool
     {
+        /** @psalm-suppress InvalidArgument */
         $count = count($packages);
 
         foreach ($packages as $index => $package) {

src/Phug/Split/Command/CommandBase.php

@@ -3,16 +3,35 @@
 namespace Phug\Split\Command;
 
 use Exception;
+use Phug\Split;
 use Phug\Split\Git\Commit;
 use Phug\Split\Git\Log;
+use Phug\Split\InvalidCli;
 use SimpleCli\CommandBase as Command;
+use SimpleCli\SimpleCli;
 
 /**
  * @property-read string $gitProgram Git program path.
  * @property-read string $hashPrefix Prefix for split linked commit hashes.
  */
 abstract class CommandBase extends Command
 {
+    /**
+     * Assert the given CLI instance is a Split CLI instance.
+     *
+     * @param SimpleCli $cli
+     *
+     * @return Split
+     */
+    protected function getSplitCli(SimpleCli $cli): Split
+    {
+        if ($cli instanceof Split) {
+            return $cli;
+        }
+
+        throw new InvalidCli($cli);
+    }
+
     /**
      * Escape a value for git command argument or option.
      *
@@ -69,11 +88,11 @@ protected function git(string $command, array $options = [], string $redirect =
      *
      * @suppressWarnings(PHPMD.StaticAccess)
      *
-     * @return Log|Commit[]
+     * @return Log
      */
     protected function latest($count = 1, string $directory = ''): Log
     {
-        return Log::fromGitLogString($this->git("log --pretty=fuller --max-count=$count $directory"));
+        return Log::fromGitLogString($this->git("log --pretty=fuller --max-count=$count $directory") ?: '');
     }
 
     /**

src/Phug/Split/Command/Copy.php

@@ -10,6 +10,8 @@
 
 /**
  * Copy files from the mono-repository to a sub-package at the current linked revision.
+ *
+ * @psalm-suppress MissingConstructor
  */
 class Copy extends CommandBase
 {
@@ -51,6 +53,8 @@ class Copy extends CommandBase
      */
     public function run(SimpleCli $cli): bool
     {
+        $cli = $this->getSplitCli($cli);
+
         if (!$this->repository) {
             return $cli->error('Please provide an input repository URL.');
         }

src/Phug/Split/Command/Dist.php

@@ -50,7 +50,7 @@ class Dist extends Analyze
      */
     public function run(SimpleCli $cli): bool
     {
-        return $this->distribute($cli);
+        return $this->distribute($this->getSplitCli($cli));
     }
 
     protected function info(Split $cli, string $message): void

src/Phug/Split/Command/Update.php

@@ -60,7 +60,7 @@ protected function getReplayLog(Split $cli, string $hash): Log
         $log = $this->latest($max, '.');
         $commits = [];
 
-        foreach ($log as $commit) {
+        foreach ($log as /* @var Commit $commit */ $commit) {
             if ($commit->getHash() === $hash) {
                 return new Log($commits);
             }
@@ -120,6 +120,23 @@ protected function getLocalUserConfig(): array
         return $localUser;
     }
 
+    /**
+     * Set a git config.
+     *
+     * @param string $name
+     * @param string|null $value
+     *
+     * @return string|null
+     */
+    protected function setGitConfig(string $name, ?string $value): ?string
+    {
+        $config = $value === null
+            ? "--unset $name"
+            : "$name ".$this->gitEscape($value);
+
+        return $this->git('config '.$config);
+    }
+
     /**
      * Apply the given commit in the current repository.
      *
@@ -169,10 +186,7 @@ protected function cherryPickCommit(
         $localUser = $this->getLocalUserConfig();
 
         foreach (['name', 'email'] as $userConfig) {
-            $config = empty($localUser[$userConfig])
-                ? "--unset user.$userConfig"
-                : "user.$userConfig ".$this->gitEscape($localUser[$userConfig]);
-            $this->git('config '.$config);
+            $this->setGitConfig("user.$userConfig", $localUser[$userConfig] ?? null);
         }
     }
 

src/Phug/Split/InvalidCli.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Phug\Split;
+
+use InvalidArgumentException;
+use Phug\Split;
+use Throwable;
+
+class InvalidCli extends InvalidArgumentException
+{
+    public function __construct(object $cli, int $code = 0, Throwable $previous = null)
+    {
+        $class = get_class($cli);
+
+        parent::__construct("Invalid cli class given: $class, ".Split::class.' expected', $code, $previous);
+    }
+}

tests/Phug/Split/Command/CommandBaseTest.php

@@ -4,12 +4,15 @@
 
 use Nette\Utils\FileSystem;
 use PHPUnit\Framework\TestCase;
+use Phug\Split;
 use Phug\Split\Command\CommandBase;
 use Phug\Split\Command\Copy;
 use Phug\Split\Git\Commit;
 use Phug\Split\Git\Log;
+use Phug\Split\InvalidCli;
 use ReflectionException;
 use ReflectionMethod;
+use SimpleCli\SimpleCli;
 
 /**
  * @coversDefaultClass \Phug\Split\Command\CommandBase
@@ -233,4 +236,28 @@ public function testRemove()
 
         $this->assertFalse($remove->invoke($copy, "//////\nnot/writable"));
     }
+
+    /**
+     * @covers ::getSplitCli
+     */
+    public function testCheckCliClass()
+    {
+        $copy = new Copy();
+        $getSplitCli = new ReflectionMethod(CommandBase::class, 'getSplitCli');
+        $getSplitCli->setAccessible(true);
+        $split = new Split();
+        $this->assertSame($split, $getSplitCli->invoke($copy, $split));
+    }
+
+    /**
+     * @covers ::getSplitCli
+     * @covers \Phug\Split\InvalidCli::<public>
+     */
+    public function testCheckCliClassException()
+    {
+        $this->expectException(InvalidCli::class);
+
+        (new Copy())->run(new class extends SimpleCli{
+        });
+    }
 }