Beautify the Release Manager

- Use only function names that "tell a story" in main delegate().
- Add test for failed update to README.md.

Author: alexander-nitsche

build/classes/ReleaseManager.php

@@ -109,9 +109,8 @@ public function delegate()
         try {
             $this->getContext();
             $this->checkPrerequisites();
-            $this->info(sprintf('Create release %s.', $this->releaseTag));
+            $this->getReleaseTag();
             $this->updateReadme();
-            $this->checkPostConditions();
             $this->createCommit();
         } catch (Exception $exception) {
             $this->error($exception->getMessage());
@@ -132,7 +131,6 @@ protected function getContext()
     {
         $this->branch = $this->git->getBranch();
         $this->tag = $this->git->getTag();
-        $this->releaseTag = $this->semanticVersioning->getNextReleaseTag($this->tag, $this->releaseType);
     }
 
     /**
@@ -157,6 +155,12 @@ protected function checkPrerequisites()
         }
     }
 
+    protected function getReleaseTag()
+    {
+        $this->releaseTag = $this->semanticVersioning->getNextReleaseTag($this->tag, $this->releaseType);
+        $this->info(sprintf('Create release %s.', $this->releaseTag));
+    }
+
     /**
      * @throws Exception
      *
@@ -173,29 +177,33 @@ protected function updateReadme()
 
         $readme = file($this->readmeFile);
         $readmeContent = '';
+        $readmeState = 0;
         foreach ($readme as $line) {
             if (strpos($line, "Version $this->tag") === 0) {
                 $readmeContent .= str_replace($this->tag, $this->releaseTag, $line);
+                $readmeState += 1;
             } elseif (strpos($line, $this->tag) === 0) {
                 $readmeContent .= str_replace($this->tag, "$changelog\n$this->tag", $line);
+                $readmeState += 2;
             } else {
                 $readmeContent .= $line;
             }
         }
         file_put_contents($this->readmeFile, $readmeContent);
-    }
 
-    /**
-     * @throws Exception
-     *
-     * @return void
-     */
-    protected function checkPostConditions()
-    {
-        if ($this->git->hasCleanWorkingTree()) {
-            throw new Exception(
-                'Could not update README.md. The format has probably changed.'
-            );
+        if ($readmeState < 3) {
+            if (!($readmeState & 1)) {
+                $errors[] = sprintf("Missing note 'Version %s' of the last release below the title.", $this->tag);
+            }
+            if (!($readmeState & 2)) {
+                $errors[] = sprintf("Missing changelog entry '%s: ..' from the last release.", $this->tag);
+            }
+            if (isset($errors)) {
+                throw new Exception(sprintf(
+                    "Could not update README.md. The format has probably changed:\n%s",
+                    json_encode($errors, JSON_PRETTY_PRINT)
+                ));
+            }
         }
     }
 

tests/build/ReleaseManagerTest.php

@@ -56,9 +56,9 @@ public function delegateSucceeds()
 -   Fixed PHP 7.4 compatibility (#37) by @Dargmuesli.
         ');
 
-        // Stub only the minimum required. We rely here for the most part on an existing Git
-        // API that is available in most test environments. We only specify that the latest
-        // version is the real existing 1.5.3 to be able to control the test flow.
+        // Replace only the minimum required with a test double. We rely here mainly on an
+        // existing Git API - which is available in most test environments. We only pretend
+        // that the latest release is 1.5.3, and we expect 1.5.4 to be released now.
         $gitStub = $this->getMockBuilder(Git::class)
             ->setMethods(['getTag'])
             ->getMock();
@@ -102,4 +102,57 @@ public function delegateSucceeds()
         $this->expectOutputRegex($expectedOutputRegex);
         $this->assertStringMatchesFormat($expectedReadme, file_get_contents($readmeFile));
     }
+
+    /**
+     * @test
+     */
+    public function delegateFailsIfReadmeFormatChanges()
+    {
+        $readme = trim('
+Syllable
+========
+Version v1.5.3
+
+..
+
+Changes
+-------
+v1.5.3
+-   Fixed PHP 7.4 compatibility (#37) by @Dargmuesli.
+        ');
+
+        // Replace only the minimum required with a test double. We rely here mainly on an
+        // existing Git API - which is available in most test environments. We only pretend
+        // that the latest release is 1.5.3, and we expect 1.5.4 to be released now.
+        $gitStub = $this->getMockBuilder(Git::class)
+            ->setMethods(['getTag'])
+            ->getMock();
+        $gitStub->expects($this->any())->method('getTag')->willReturn('1.5.3');
+
+        $expectedOutput = trim('
+Create release 1.5.4.
+Could not update README.md. The format has probably changed:
+[
+    "Missing note \'Version 1.5.3\' of the last release below the title.",
+    "Missing changelog entry \'1.5.3: ..\' from the last release."
+]
+Aborting.
+        ')."\n";
+        $expectedReadme = $readme;
+
+        $this->addFileToTestDirectory('README.md', $readme);
+
+        $releaseType = SemanticVersioning::PATCH_RELEASE;
+        $readmeFile = $this->getPathOfTestDirectoryFile('README.md');
+
+        $releaseManager = new ReleaseManager();
+        $releaseManager->setReleaseType($releaseType);
+        $releaseManager->setReadmeFile($readmeFile);
+        $releaseManager->setGit($gitStub);
+        $result = $releaseManager->delegate();
+
+        $this->assertFalse($result);
+        $this->expectOutputString($expectedOutput);
+        $this->assertEquals($expectedReadme, file_get_contents($readmeFile));
+    }
 }