bug #211 Improve Mismatch branch when there is markdown comment (alamirault)

This PR was squashed before being merged into the master branch.

Discussion
----------

Improve Mismatch branch when there is markdown comment

Sometime, contributors don't remove all the line and  keep markdown comment (default in MR template)

```
| Q             | A
| ------------- | ---
| Branch?       | 6.2 <!-- see below -->
| Bug fix?      | yes/no
```

This PR take care of comments and  no publish in this cas

Examples:
symfony/symfony#48451 (comment)
symfony/symfony#48447 (comment)

Commits
-------

75e3578 Improve Mismatch branch when there is markdown comment

Author: weaverryan

src/Subscriber/MismatchBranchDescriptionSubscriber.php

@@ -72,13 +72,14 @@ public static function getSubscribedEvents(): array
     private function extractDescriptionBranchFromBody(string $body): ?string
     {
         $s = new UnicodeString($body);
+        $bodyWithoutComment = $s->replaceMatches('/<!--\s*.*\s*-->/', '');
 
         // @see symfony/symfony/.github/PULL_REQUEST_TEMPLATE.md
-        if (!$s->containsAny('Branch?')) {
+        if (!$bodyWithoutComment->containsAny('Branch?')) {
             return null;
         }
 
-        $rowsDescriptionBranch = $s->match('/.*Branch.*/');
+        $rowsDescriptionBranch = $bodyWithoutComment->match('/.*Branch.*/');
 
         $rowDescriptionBranch = $rowsDescriptionBranch[0]; // row matching
 

tests/Controller/WebhookControllerTest.php

@@ -87,7 +87,7 @@ public function getTests()
             'On pull request opened with target branch' => [
                 'pull_request',
                 'pull_request.opened_target_branch.json',
-                ['pull_request' => 3, 'status_change' => 'needs_review', 'pr_labels' => ['Bug'], 'milestone' => '4.4', 'approved_run' => true],
+                ['pull_request' => 3, 'status_change' => 'needs_review', 'pr_labels' => ['Bug'], 'milestone' => '4.4', 'unsupported_branch' => '4.4', 'approved_run' => true],
             ],
             'On issue labeled bug' => [
                 'issues',

tests/Subscriber/MismatchBranchDescriptionSubscriberTest.php

@@ -69,6 +69,35 @@ public function testOnPullRequestOpenMatch()
         $this->assertCount(0, $responseData);
     }
 
+    public function testOnPullRequestOpenMatchWithComment()
+    {
+        $this->issueApi->expects($this->never())
+            ->method('commentOnIssue');
+
+        $body = <<<TXT
+| Q             | A
+| ------------- | ---
+| Branch?       | 6.2 <!-- see below -->
+| Bug fix?      | yes/no
+TXT;
+
+        $event = new GitHubEvent([
+            'action' => 'opened',
+            'pull_request' => [
+                'number' => 1234,
+                'body' => $body,
+                'base' => [
+                    'ref' => '6.2',
+                ],
+            ],
+        ], $this->repository);
+
+        $this->dispatcher->dispatch($event, GitHubEvents::PULL_REQUEST);
+        $responseData = $event->getResponseData();
+
+        $this->assertCount(0, $responseData);
+    }
+
     public function testOnPullRequestOpenNotMatch()
     {
         $this->issueApi->expects($this->once())