Merge pull request #266 from sebastianlarisch/feature/add-pattern-option

add new pattern option

Author: sebastianfeldmann

src/Hook/Message/Action/InjectIssueKeyFromBranch.php

@@ -107,10 +107,11 @@ private function createNewCommitMessage(Options $options, CommitMessage $msg, st
         $target = $options->get('into', 'body');
         $mode   = $options->get('mode', 'append');
         $prefix = $options->get('prefix', ' ');
+        $pattern = $options->get('pattern', '');
 
         // overwrite either subject or body
         $newMsgData          = ['subject' => $msg->getSubject(), 'body' => $msg->getBody()];
-        $newMsgData[$target] = $this->injectIssueId($issueID, $newMsgData[$target], $mode, $prefix);
+        $newMsgData[$target] = $this->injectIssueId($issueID, $newMsgData[$target], $mode, $prefix, $pattern);
 
         $comments = '';
         foreach ($msg->getLines() as $line) {
@@ -132,10 +133,21 @@ private function createNewCommitMessage(Options $options, CommitMessage $msg, st
      * @param  string $msg
      * @param  string $mode
      * @param  string $prefix
+     * @param  string $pattern
      * @return string
      */
-    private function injectIssueId(string $issueID, string $msg, string $mode, string $prefix): string
+    private function injectIssueId(string $issueID, string $msg, string $mode, string $prefix, string $pattern): string
     {
+        if (!empty($pattern)) {
+            $issueID = preg_replace_callback(
+                '/\$(\d+)/',
+                function ($matches) use ($issueID) {
+                    return $matches[1] === '1' ? $issueID : '';
+                },
+                $pattern
+            );
+        }
+
         return ltrim($mode === 'prepend' ? $prefix . $issueID . ' ' . $msg : $msg . $prefix . $issueID);
     }
 }

tests/unit/Hook/Message/Action/InjectIssueKeyFromBranchTest.php

@@ -17,8 +17,8 @@
 use CaptainHook\App\Exception\ActionFailed;
 use CaptainHook\App\Mockery as CHMockery;
 use CaptainHook\App\RepoMock;
-use SebastianFeldmann\Git\CommitMessage;
 use PHPUnit\Framework\TestCase;
+use SebastianFeldmann\Git\CommitMessage;
 
 class InjectIssueKeyFromBranchTest extends TestCase
 {
@@ -44,7 +44,7 @@ public function testConstraint(): void
     public function testPrependSubject(): void
     {
         $repo = new RepoMock();
-        $info = $this->createGitInfoOperator('5.0.0', 'freature/ABCD-12345-foo-bar-baz');
+        $info = $this->createGitInfoOperator('5.0.0', 'feature/ABCD-12345-foo-bar-baz');
 
         $repo->setCommitMsg(new CommitMessage('foo' . PHP_EOL . PHP_EOL . 'bar'));
         $repo->setInfoOperator($info);
@@ -71,7 +71,7 @@ public function testPrependSubject(): void
     public function testAppendSubject(): void
     {
         $repo = new RepoMock();
-        $info = $this->createGitInfoOperator('5.0.0', 'freature/ABCD-12345-foo-bar-baz');
+        $info = $this->createGitInfoOperator('5.0.0', 'feature/ABCD-12345-foo-bar-baz');
 
         $repo->setCommitMsg(new CommitMessage('foo' . PHP_EOL . PHP_EOL . 'bar'));
         $repo->setInfoOperator($info);
@@ -98,7 +98,7 @@ public function testAppendSubject(): void
     public function testAppendBodyWithPrefix(): void
     {
         $repo = new RepoMock();
-        $info = $this->createGitInfoOperator('5.0.0', 'freature/ABCD-12345-foo-bar-baz');
+        $info = $this->createGitInfoOperator('5.0.0', 'feature/ABCD-12345-foo-bar-baz');
 
         $repo->setCommitMsg(new CommitMessage('foo' . PHP_EOL . PHP_EOL . 'bar'));
         $repo->setInfoOperator($info);
@@ -130,7 +130,7 @@ public function testAppendBodyWithPrefix(): void
     public function testAppendBodyWithPrefixWithComments(): void
     {
         $repo = new RepoMock();
-        $info = $this->createGitInfoOperator('5.0.0', 'freature/ABCD-12345-foo-bar-baz');
+        $info = $this->createGitInfoOperator('5.0.0', 'feature/ABCD-12345-foo-bar-baz');
 
         $repo->setCommitMsg(
             new CommitMessage(
@@ -221,7 +221,7 @@ public function testFailIssueKeyNotFound(): void
     public function testIssueKeyAlreadyInMSG(): void
     {
         $repo = new RepoMock();
-        $info = $this->createGitInfoOperator('5.0.0', 'freature/ABCD-12345-foo-bar-baz');
+        $info = $this->createGitInfoOperator('5.0.0', 'feature/ABCD-12345-foo-bar-baz');
 
         $repo->setCommitMsg(new CommitMessage('ABCD-12345 foo' . PHP_EOL . PHP_EOL . 'bar'));
         $repo->setInfoOperator($info);
@@ -238,4 +238,60 @@ public function testIssueKeyAlreadyInMSG(): void
 
         $this->assertEquals('ABCD-12345 foo', $repo->getCommitMsg()->getSubject());
     }
+
+    /**
+     * Tests InjectIssueKeyFromBranch::execute
+     *
+     * @throws \Exception
+     */
+    public function testSubjectWithPattern(): void
+    {
+        $repo = new RepoMock();
+        $info = $this->createGitInfoOperator('5.0.0', 'feature/ABCD-12345-foo-bar-baz');
+
+        $repo->setCommitMsg(new CommitMessage('foo' . PHP_EOL . PHP_EOL . 'bar'));
+        $repo->setInfoOperator($info);
+
+        $io      = $this->createIOMock();
+        $config  = $this->createConfigMock();
+        $action  = $this->createActionConfigMock();
+        $action->method('getOptions')->willReturn(new Options([
+            'into' => 'subject',
+            'pattern' => '$1:',
+            'mode' => 'prepend',
+        ]));
+
+        $hook = new InjectIssueKeyFromBranch();
+        $hook->execute($config, $io, $repo, $action);
+
+        $this->assertEquals('ABCD-12345: foo', $repo->getCommitMsg()->getSubject());
+    }
+
+    /**
+     * Tests InjectIssueKeyFromBranch::execute
+     *
+     * @throws \Exception
+     */
+    public function testSubjectWithEmptyPattern(): void
+    {
+        $repo = new RepoMock();
+        $info = $this->createGitInfoOperator('5.0.0', 'feature/ABCD-12345-foo-bar-baz');
+
+        $repo->setCommitMsg(new CommitMessage('foo' . PHP_EOL . PHP_EOL . 'bar'));
+        $repo->setInfoOperator($info);
+
+        $io      = $this->createIOMock();
+        $config  = $this->createConfigMock();
+        $action  = $this->createActionConfigMock();
+        $action->method('getOptions')->willReturn(new Options([
+            'into' => 'subject',
+            'pattern' => '',
+            'mode' => 'prepend',
+        ]));
+
+        $hook = new InjectIssueKeyFromBranch();
+        $hook->execute($config, $io, $repo, $action);
+
+        $this->assertEquals('ABCD-12345 foo', $repo->getCommitMsg()->getSubject());
+    }
 }