CS Fixes - Doc Comments & Nowdocs

- SlevomatCodingStandard.Commenting.RequireOneLineDocComment - SlevomatCodingStandard.PHP.RequireNowdoc Signed-off-by: George Steel <[email protected]>
laminas · Aug 29, 2022 · b6d38ba · b6d38ba
1 parent 6edfebc
commit b6d38ba
Show file tree

Hide file tree

Showing 23 changed files with 102 additions and 161 deletions.
diff --git a/src/Changelog/ChangelogExists.php b/src/Changelog/ChangelogExists.php
@@ -8,9 +8,7 @@
 
 interface ChangelogExists
 {
-    /**
-     * @param non-empty-string $repositoryDirectory
-     */
+    /** @param non-empty-string $repositoryDirectory */
     public function __invoke(
         BranchName $sourceBranch,
         string $repositoryDirectory,

diff --git a/src/Changelog/ChangelogExistsViaConsole.php b/src/Changelog/ChangelogExistsViaConsole.php
@@ -9,9 +9,7 @@
 
 class ChangelogExistsViaConsole implements ChangelogExists
 {
-    /**
-     * @param non-empty-string $repositoryDirectory
-     */
+    /** @param non-empty-string $repositoryDirectory */
     public function __invoke(
         BranchName $sourceBranch,
         string $repositoryDirectory,

diff --git a/src/Changelog/ChangelogReleaseNotes.php b/src/Changelog/ChangelogReleaseNotes.php
@@ -10,9 +10,7 @@
 use Psl\Str;
 use RuntimeException;
 
-/**
- * @psalm-immutable
- */
+/** @psalm-immutable */
 class ChangelogReleaseNotes
 {
     private const CONCATENATION_STRING = "\n\n-----\n\n";
@@ -22,9 +20,7 @@ class ChangelogReleaseNotes
     /** @psalm-var non-empty-string */
     private string $contents;
 
-    /**
-     * @psalm-param non-empty-string $changelogFile
-     */
+    /** @psalm-param non-empty-string $changelogFile */
     public static function writeChangelogFile(string $changelogFile, self $releaseNotes): void
     {
         // Nothing to do
@@ -44,9 +40,7 @@ public static function writeChangelogFile(string $changelogFile, self $releaseNo
         );
     }
 
-    /**
-     * @psalm-param non-empty-string $contents
-     */
+    /** @psalm-param non-empty-string $contents */
     public function __construct(
         string $contents,
         ?ChangelogEntry $changelogEntry = null,
@@ -59,9 +53,7 @@ public function __construct(
         $this->changelogEntry = $changelogEntry;
     }
 
-    /**
-     * @psalm-return non-empty-string
-     */
+    /** @psalm-return non-empty-string */
     public function contents(): string
     {
         return $this->contents;

diff --git a/src/Changelog/CommitReleaseChangelog.php b/src/Changelog/CommitReleaseChangelog.php
@@ -10,9 +10,7 @@
 
 interface CommitReleaseChangelog
 {
-    /**
-     * @psalm-param non-empty-string $repositoryDirectory
-     */
+    /** @psalm-param non-empty-string $repositoryDirectory */
     public function __invoke(
         ChangelogReleaseNotes $releaseNotes,
         string $repositoryDirectory,

diff --git a/src/Changelog/CommitReleaseChangelogViaKeepAChangelog.php b/src/Changelog/CommitReleaseChangelogViaKeepAChangelog.php
@@ -44,9 +44,7 @@ public function __construct(
         $this->logger          = $logger;
     }
 
-    /**
-     * @psalm-param non-empty-string $repositoryDirectory
-     */
+    /** @psalm-param non-empty-string $repositoryDirectory */
     public function __invoke(
         ChangelogReleaseNotes $releaseNotes,
         string $repositoryDirectory,

diff --git a/src/Git/CheckoutBranch.php b/src/Git/CheckoutBranch.php
@@ -8,9 +8,7 @@
 
 interface CheckoutBranch
 {
-    /**
-     * @psalm-param non-empty-string $repositoryDirectory
-     */
+    /** @psalm-param non-empty-string $repositoryDirectory */
     public function __invoke(
         string $repositoryDirectory,
         BranchName $branchName,

diff --git a/src/Github/Api/GraphQL/Query/GetMilestoneChangelog/Response/Milestone.php b/src/Github/Api/GraphQL/Query/GetMilestoneChangelog/Response/Milestone.php
@@ -116,9 +116,7 @@ public function url(): UriInterface
         return $this->url;
     }
 
-    /**
-     * @psalm-suppress ImpureFunctionCall the {@see \Psl\Iter\all()} API is conditionally pure
-     */
+    /** @psalm-suppress ImpureFunctionCall the {@see \Psl\Iter\all()} API is conditionally pure */
     public function assertAllIssuesAreClosed(): void
     {
         Psl\invariant(Iter\all($this->entries, static function (IssueOrPullRequest $entry): bool {

diff --git a/src/Github/CreateReleaseText.php b/src/Github/CreateReleaseText.php
@@ -12,9 +12,7 @@
 
 interface CreateReleaseText
 {
-    /**
-     * @psalm-param non-empty-string $repositoryDirectory
-     */
+    /** @psalm-param non-empty-string $repositoryDirectory */
     public function __invoke(
         Milestone $milestone,
         RepositoryName $repositoryName,

diff --git a/test/unit/Application/CreateMergeUpPullRequestTest.php b/test/unit/Application/CreateMergeUpPullRequestTest.php
@@ -77,18 +77,19 @@ protected function setUp(): void
             $this->createPullRequest,
         );
 
-        $this->event = MilestoneClosedEvent::fromEventJson(<<<'JSON'
-{
-    "milestone": {
-        "title": "1.2.3",
-        "number": 123
-    },
-    "repository": {
-        "full_name": "foo/bar"
-    },
-    "action": "closed"
-}
-JSON,
+        $this->event = MilestoneClosedEvent::fromEventJson(
+            <<<'JSON'
+            {
+                "milestone": {
+                    "title": "1.2.3",
+                    "number": 123
+                },
+                "repository": {
+                    "full_name": "foo/bar"
+                },
+                "action": "closed"
+            }
+            JSON,
         );
 
         $this->branches = MergeTargetCandidateBranches::fromAllBranches(
@@ -245,10 +246,10 @@ public function testWillSkipMergeUpPullRequestOnNoMergeUpCandidate(): void
         self::assertSame(0, $this->command->run(new ArrayInput([]), $output));
 
         self::assertSame(
-            <<<OUTPUT
-No merge-up candidate for release 1.2.3 - skipping pull request creation
-
-OUTPUT
+            <<<'OUTPUT'
+            No merge-up candidate for release 1.2.3 - skipping pull request creation
+            
+            OUTPUT
             ,
             $output->fetch(),
         );

diff --git a/test/unit/Application/CreateMilestonesTest.php b/test/unit/Application/CreateMilestonesTest.php
@@ -16,9 +16,7 @@
 use Symfony\Component\Console\Input\ArrayInput;
 use Symfony\Component\Console\Output\NullOutput;
 
-/**
- * @covers \Laminas\AutomaticReleases\Application\Command\CreateMilestones
- */
+/** @covers \Laminas\AutomaticReleases\Application\Command\CreateMilestones */
 final class CreateMilestonesTest extends TestCase
 {
     /** @var LoadCurrentGithubEvent&MockObject */
@@ -45,7 +43,8 @@ protected function setUp(): void
             $this->createMilestone,
         );
 
-        $this->event = MilestoneClosedEvent::fromEventJson(<<<'JSON'
+        $this->event = MilestoneClosedEvent::fromEventJson(
+            <<<'JSON'
             {
                 "milestone": {
                     "title": "1.2.3",
@@ -56,7 +55,7 @@ protected function setUp(): void
                 },
                 "action": "closed"
             }
-        JSON,
+            JSON,
         );
 
         $this->releaseVersion = SemVerVersion::fromMilestoneName('1.2.3');

diff --git a/test/unit/Application/ReleaseCommandTest.php b/test/unit/Application/ReleaseCommandTest.php
@@ -87,18 +87,19 @@ protected function setUp(): void
             $this->createRelease,
         );
 
-        $this->event = MilestoneClosedEvent::fromEventJson(<<<'JSON'
-{
-    "milestone": {
-        "title": "1.2.3",
-        "number": 123
-    },
-    "repository": {
-        "full_name": "foo/bar"
-    },
-    "action": "closed"
-}
-JSON,
+        $this->event = MilestoneClosedEvent::fromEventJson(
+            <<<'JSON'
+            {
+                "milestone": {
+                    "title": "1.2.3",
+                    "number": 123
+                },
+                "repository": {
+                    "full_name": "foo/bar"
+                },
+                "action": "closed"
+            }
+            JSON,
         );
 
         $this->branches = MergeTargetCandidateBranches::fromAllBranches(

diff --git a/test/unit/Application/SwitchDefaultBranchToNextMinorTest.php b/test/unit/Application/SwitchDefaultBranchToNextMinorTest.php
@@ -69,18 +69,19 @@ protected function setUp(): void
             $this->bumpChangelogVersion,
         );
 
-        $this->event = MilestoneClosedEvent::fromEventJson(<<<'JSON'
-{
-    "milestone": {
-        "title": "1.2.3",
-        "number": 123
-    },
-    "repository": {
-        "full_name": "foo/bar"
-    },
-    "action": "closed"
-}
-JSON,
+        $this->event = MilestoneClosedEvent::fromEventJson(
+            <<<'JSON'
+            {
+                "milestone": {
+                    "title": "1.2.3",
+                    "number": 123
+                },
+                "repository": {
+                    "full_name": "foo/bar"
+                },
+                "action": "closed"
+            }
+            JSON,
         );
 
         $key = (new ImportGpgKeyFromStringViaTemporaryFile())
@@ -239,10 +240,10 @@ public function testWillNotSwitchDefaultBranchIfNoBranchesExist(): void
         self::assertSame(0, $this->command->run(new ArrayInput([]), $output));
 
         self::assertSame(
-            <<<OUTPUT
-No stable branches found: cannot switch default branch
-
-OUTPUT
+            <<<'OUTPUT'
+            No stable branches found: cannot switch default branch
+            
+            OUTPUT
             ,
             $output->fetch(),
         );

diff --git a/test/unit/Changelog/BumpAndCommitChangelogVersionViaKeepAChangelogTest.php b/test/unit/Changelog/BumpAndCommitChangelogVersionViaKeepAChangelogTest.php
@@ -187,9 +187,7 @@ public function testAddsNewReleaseVersionUsingBumpTypeToChangelogFileAndCommitsA
         );
     }
 
-    /**
-     * @psalm-return non-empty-string
-     */
+    /** @psalm-return non-empty-string */
     private function createMockChangelog(): string
     {
         $repo = Filesystem\create_temporary_file(Env\temp_dir(), 'BumpAndCommitChangelogVersion');

diff --git a/test/unit/Changelog/ChangelogExistsViaConsoleTest.php b/test/unit/Changelog/ChangelogExistsViaConsoleTest.php
@@ -39,9 +39,7 @@ public function testReturnsTrueWhenChangelogIsPresentInBranch(): void
         );
     }
 
-    /**
-     * @psalm-return non-empty-string
-     */
+    /** @psalm-return non-empty-string */
     private function createMockRepositoryWithChangelog(): string
     {
         $repo = Filesystem\create_temporary_file(Env\temp_dir(), 'ChangelogExists');

diff --git a/test/unit/Changelog/ChangelogReleaseNotesTest.php b/test/unit/Changelog/ChangelogReleaseNotesTest.php
@@ -19,9 +19,7 @@
 use function Psl\File\read;
 use function Psl\File\write;
 
-/**
- * @covers \Laminas\AutomaticReleases\Changelog\ChangelogReleaseNotes
- */
+/** @covers \Laminas\AutomaticReleases\Changelog\ChangelogReleaseNotes */
 class ChangelogReleaseNotesTest extends TestCase
 {
     public function testInitialContentsAreThoseProvidedToConstructor(): void
@@ -150,9 +148,7 @@ public function releaseNotesProvider(): iterable
         ];
     }
 
-    /**
-     * @dataProvider releaseNotesProvider
-     */
+    /** @dataProvider releaseNotesProvider */
     public function testMergedInstanceContainsChangelogEntryFromTheInstanceThatHadOne(
         ChangelogReleaseNotes $original,
         ChangelogReleaseNotes $secondary,

diff --git a/test/unit/Changelog/ReleaseChangelogViaKeepAChangelogTest.php b/test/unit/Changelog/ReleaseChangelogViaKeepAChangelogTest.php
@@ -229,9 +229,7 @@ public function testWritesCommitsAndPushesChangelogWhenFoundAndReadyToRelease():
         $this->assertStringNotContainsString($existingChangelog, $contents);
     }
 
-    /**
-     * @psalm-return non-empty-string
-     */
+    /** @psalm-return non-empty-string */
     private function createMockRepositoryWithChangelog(
         string $template,
         string $filename = 'CHANGELOG.md',

diff --git a/test/unit/Git/Value/BranchNameTest.php b/test/unit/Git/Value/BranchNameTest.php
@@ -11,9 +11,7 @@
 
 final class BranchNameTest extends TestCase
 {
-    /**
-     * @dataProvider genericBranchNames
-     */
+    /** @dataProvider genericBranchNames */
     public function testAllowsAnyBranchName(string $inputName): void
     {
         $branch = BranchName::fromName($inputName);
@@ -44,9 +42,7 @@ public function testDisallowsEmptyBranchName(): void
         BranchName::fromName('');
     }
 
-    /**
-     * @dataProvider releaseBranches
-     */
+    /** @dataProvider releaseBranches */
     public function testDetectsReleaseBranchVersions(string $inputName, int $major, int $minor): void
     {
         $branch = BranchName::fromName($inputName);
@@ -75,9 +71,7 @@ public function testEquals(): void
         self::assertTrue(BranchName::fromName('foo')->equals(BranchName::fromName('foo')));
     }
 
-    /**
-     * @dataProvider versionEqualityProvider
-     */
+    /** @dataProvider versionEqualityProvider */
     public function testIsForVersion(string $milestoneName, string $branchName, bool $expected): void
     {
         self::assertSame(
@@ -104,9 +98,7 @@ public function versionEqualityProvider(): array
         ];
     }
 
-    /**
-     * @dataProvider newerVersionComparisonProvider
-     */
+    /** @dataProvider newerVersionComparisonProvider */
     public function testIsForNewerVersionThan(string $milestoneName, string $branchName, bool $expected): void
     {
         self::assertSame(
@@ -134,9 +126,7 @@ public function newerVersionComparisonProvider(): array
         ];
     }
 
-    /**
-     * @dataProvider targetVersionProvider
-     */
+    /** @dataProvider targetVersionProvider */
     public function testTargetMinorReleaseVersion(string $branchName, string $expectedVersion): void
     {
         self::assertEquals(