phpdoc upgrades, compatibility layer

Philipp Handle · Philipp Handle · commit c4838adf7308 · 2025-12-02T19:10:05.000+01:00
diff --git a/bin/app.php b/bin/app.php
@@ -16,8 +16,11 @@
 
     return $version;
 })('bmitch/churn-php'));
-$application->add(AssessComplexityCommand::newInstance());
-$application->add($run = RunCommand::newInstance());
+$method = method_exists($application, 'addCommand')
+    ? 'addCommand'
+    : 'add';
+$application->{$method}(AssessComplexityCommand::newInstance());
+$application->{$method}($run = RunCommand::newInstance());
 $application->setDefaultCommand($run->getName());
 
 return $application;
diff --git a/composer.json b/composer.json
@@ -86,7 +86,7 @@
             "phpcs",
             "phpcs --standard=phpcs-tests.xml",
             "psalm",
-            "phpstan"
+            "phpstan --memory-limit=-1"
         ]
     }
 }
diff --git a/phpstan.neon b/phpstan.neon
@@ -12,6 +12,8 @@ parameters:
   reportUnmatchedIgnoredErrors: true
   ignoreErrors:
     - '/^Casting to .+ something that''s already/'
+    - "#Call to function method_exists\\(\\) with Symfony\\\\Component\\\\Console\\\\Application and 'addCommand' will always evaluate to true#"
+    - "#Variable method call on Symfony\\\\Component\\\\Console\\\\Application#"
 
   checkTooWideReturnTypesInProtectedAndPublicMethods: true
   checkUninitializedProperties: true
diff --git a/tests/EndToEnd/FossilTest.php b/tests/EndToEnd/FossilTest.php
@@ -16,21 +16,28 @@ final class FossilTest extends BaseTestCase
      */
     private $commandTester;
 
-    /** @return void */
+    /**
+     * Test setup
+     */
     #[\Override]
-    protected function setUp()
+    protected function setUp(): void
     {
         parent::setUp();
 
         $application = new Application('churn-php', 'test');
-        $application->add(RunCommand::newInstance());
+        $method = \method_exists($application, 'addCommand')
+            ? 'addCommand'
+            : 'add';
+        $application->{$method}(RunCommand::newInstance());
         $command = $application->find('run');
         $this->commandTester = new CommandTester($command);
     }
 
-    /** @return void */
+    /**
+     * Test teardown
+     */
     #[\Override]
-    protected function tearDown()
+    protected function tearDown(): void
     {
         parent::tearDown();
 
diff --git a/tests/EndToEnd/MercurialTest.php b/tests/EndToEnd/MercurialTest.php
@@ -16,21 +16,28 @@ final class MercurialTest extends BaseTestCase
      */
     private $commandTester;
 
-    /** @return void */
+    /**
+     * Test setup
+     */
     #[\Override]
-    protected function setUp()
+    protected function setUp(): void
     {
         parent::setUp();
 
         $application = new Application('churn-php', 'test');
-        $application->add(RunCommand::newInstance());
+        $method = \method_exists($application, 'addCommand')
+            ? 'addCommand'
+            : 'add';
+        $application->{$method}(RunCommand::newInstance());
         $command = $application->find('run');
         $this->commandTester = new CommandTester($command);
     }
 
-    /** @return void */
+    /**
+     * Test teardown
+     */
     #[\Override]
-    protected function tearDown()
+    protected function tearDown(): void
     {
         parent::tearDown();
 
diff --git a/tests/EndToEnd/SubversionTest.php b/tests/EndToEnd/SubversionTest.php
@@ -16,21 +16,28 @@ final class SubversionTest extends BaseTestCase
      */
     private $commandTester;
 
-    /** @return void */
+    /**
+     * Test setup
+     */
     #[\Override]
-    protected function setUp()
+    protected function setUp(): void
     {
         parent::setUp();
 
         $application = new Application('churn-php', 'test');
-        $application->add(RunCommand::newInstance());
+        $method = \method_exists($application, 'addCommand')
+            ? 'addCommand'
+            : 'add';
+        $application->{$method}(RunCommand::newInstance());
         $command = $application->find('run');
         $this->commandTester = new CommandTester($command);
     }
 
-    /** @return void */
+    /**
+     * Test teardown
+     */
     #[\Override]
-    protected function tearDown()
+    protected function tearDown(): void
     {
         parent::tearDown();
 
diff --git a/tests/Integration/Command/AssessComplexityCommandTest.php b/tests/Integration/Command/AssessComplexityCommandTest.php
@@ -16,21 +16,28 @@ final class AssessComplexityCommandTest extends BaseTestCase
      */
     private $commandTester;
 
-    /** @return void */
+    /**
+     * Test setup
+     */
     #[\Override]
-    protected function setUp()
+    protected function setUp(): void
     {
         parent::setUp();
 
         $application = new Application('churn-php', 'test');
-        $application->add(AssessComplexityCommand::newInstance());
+        $method = \method_exists($application, 'addCommand')
+            ? 'addCommand'
+            : 'add';
+        $application->{$method}(AssessComplexityCommand::newInstance());
         $command = $application->find('assess-complexity');
         $this->commandTester = new CommandTester($command);
     }
 
-    /** @return void */
+    /**
+     * Test teardown
+     */
     #[\Override]
-    protected function tearDown()
+    protected function tearDown(): void
     {
         parent::tearDown();
 
diff --git a/tests/Integration/Command/RunCommandTest.php b/tests/Integration/Command/RunCommandTest.php
@@ -28,21 +28,28 @@ final class RunCommandTest extends BaseTestCase
      */
     private $tmpFile;
 
-    /** @return void */
+    /**
+     * Test setup
+     */
     #[\Override]
-    protected function setUp()
+    protected function setUp(): void
     {
         parent::setUp();
 
         $application = new Application('churn-php', 'test');
-        $application->add(RunCommand::newInstance());
+        $method = \method_exists($application, 'addCommand')
+            ? 'addCommand'
+            : 'add';
+        $application->{$method}(RunCommand::newInstance());
         $command = $application->find('run');
         $this->commandTester = new CommandTester($command);
     }
 
-    /** @return void */
+    /**
+     * Test teardown
+     */
     #[\Override]
-    protected function tearDown()
+    protected function tearDown(): void
     {
         parent::tearDown();
 
diff --git a/tests/Integration/File/FileFinderTest.php b/tests/Integration/File/FileFinderTest.php
@@ -15,9 +15,11 @@ final class FileFinderTest extends BaseTestCase
      */
     private $fileFinder;
 
-    /** @return void */
+    /**
+     * Test setup
+     */
     #[\Override]
-    public function setUp()
+    public function setUp(): void
     {
         parent::setUp();
 
diff --git a/tests/Integration/ManifestTest.php b/tests/Integration/ManifestTest.php
@@ -16,9 +16,11 @@ final class ManifestTest extends BaseTestCase
      */
     private $manifest;
 
-    /** @return void */
+    /**
+     * Test setup
+     */
     #[\Override]
-    public function setUp()
+    public function setUp(): void
     {
         parent::setUp();
 
diff --git a/tests/Unit/Configuration/Validator/CommitsSinceTest.php b/tests/Unit/Configuration/Validator/CommitsSinceTest.php
@@ -15,9 +15,11 @@ final class CommitsSinceTest extends ValidatorBaseTestCase
      */
     private $validator;
 
-    /** @return void */
+    /**
+     * Test setup
+     */
     #[\Override]
-    public function setUp()
+    public function setUp(): void
     {
         parent::setUp();
 
diff --git a/tests/Unit/Configuration/Validator/ValidatorBaseTestCase.php b/tests/Unit/Configuration/Validator/ValidatorBaseTestCase.php
@@ -43,16 +43,18 @@ abstract public static function provideValidValues(): iterable;
      */
     abstract public static function provideInvalidValues(): iterable;
 
-    /** @return void */
+    /**
+     * Test setup
+     */
     #[\Override]
-    public function setUp()
+    public function setUp(): void
     {
         parent::setUp();
 
         $this->config = new EditableConfig();
     }
 
-        /**
+    /**
      * @test
      */
     public function it_returns_the_default_value(): void
diff --git a/tests/Unit/File/FileFinderTest.php b/tests/Unit/File/FileFinderTest.php
@@ -16,9 +16,11 @@ final class FileFinderTest extends BaseTestCase
      */
     protected $fileFinder;
 
-    /** @return void */
+    /**
+     * Test setup
+     */
     #[\Override]
-    public function setUp()
+    public function setUp(): void
     {
         parent::setUp();
 
diff --git a/tests/Unit/File/FileHelperTest.php b/tests/Unit/File/FileHelperTest.php
@@ -16,9 +16,11 @@ final class FileHelperTest extends BaseTestCase
      */
     private static $filesToDelete = [];
 
-    /** @return void */
+    /**
+     * Test teardown
+     */
     #[\Override]
-    protected function tearDown()
+    protected function tearDown(): void
     {
         parent::tearDown();
 
diff --git a/tests/Unit/File/FileTest.php b/tests/Unit/File/FileTest.php
@@ -14,9 +14,11 @@ final class FileTest extends BaseTestCase
      **/
     private $file;
 
-    /** @return void */
+    /**
+     * Test setup
+     */
     #[\Override]
-    public function setUp()
+    public function setUp(): void
     {
         parent::setUp();
 
diff --git a/tests/Unit/Process/ChangesCount/NoVcsChangesCountProcessTest.php b/tests/Unit/Process/ChangesCount/NoVcsChangesCountProcessTest.php
@@ -15,9 +15,11 @@ final class NoVcsChangesCountProcessTest extends BaseTestCase
      */
     private $process;
 
-    /** @return void */
+    /**
+     * TEst setup
+     */
     #[\Override]
-    protected function setUp()
+    protected function setUp(): void
     {
         parent::setUp();
 
diff --git a/tests/Unit/Process/ConcreteProcessFactoryTest.php b/tests/Unit/Process/ConcreteProcessFactoryTest.php
@@ -20,9 +20,11 @@ final class ConcreteProcessFactoryTest extends BaseTestCase
      */
     private $processFactory;
 
-    /** @return void */
+    /**
+     * Test setup
+     */
     #[\Override]
-    public function setUp()
+    public function setUp(): void
     {
         parent::setUp();
 
diff --git a/tests/Unit/Result/ResultTest.php b/tests/Unit/Result/ResultTest.php
@@ -18,9 +18,11 @@ final class ResultTest extends BaseTestCase
      */
     protected $result;
 
-    /** @return void */
+    /**
+     * Test setup
+     */
     #[\Override]
-    public function setUp()
+    public function setUp(): void
     {
         parent::setUp();
 
diff --git a/tests/Unit/Result/ResultsRendererFactoryTest.php b/tests/Unit/Result/ResultsRendererFactoryTest.php
@@ -19,9 +19,11 @@ final class ResultsRendererFactoryTest extends BaseTestCase
      */
     private $factory;
 
-    /** @return void */
+    /**
+     * Test setup
+     */
     #[\Override]
-    public function setUp()
+    public function setUp(): void
     {
         parent::setUp();
 
diff --git a/tests/console-application.php b/tests/console-application.php
@@ -15,7 +15,10 @@
 use Symfony\Component\Console\Application;
 
 $application = new Application('churn-php', 'test');
-$application->add(AssessComplexityCommand::newInstance());
-$application->add(RunCommand::newInstance());
+$method = method_exists($application, 'addCommand')
+    ? 'addCommand'
+    : 'add';
+$application->{$method}(AssessComplexityCommand::newInstance());
+$application->{$method}(RunCommand::newInstance());
 
 return $application;

Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,7 @@`
`86`	`86`	`"phpcs",`
`87`	`87`	`"phpcs --standard=phpcs-tests.xml",`
`88`	`88`	`"psalm",`
`89`		`- "phpstan"`
	`89`	`+ "phpstan --memory-limit=-1"`
`90`	`90`	`]`
`91`	`91`	`}`
`92`	`92`	`}`