[Feature] Add YouTrack issue link rule

* Add HasLinkToYouTrackIssueRule

* Add source_branch and target_branch

* OnTargetBranchRule

* add output example

* Update readme.md

* update changelog

Author: ArtARTs36

CHANGELOG.MD

@@ -9,3 +9,10 @@ v0.1.0
 v0.1.1
 --------------------
 * [Feature] Add rule "Has link to Jira task"
+
+v0.1.2
+--------------------
+* [Feature] Add rule "Has link to YouTrack issue"
+* [Feature] Add rule "OnTargetBranchRule"
+* Add property "sourceBranch" to MergeRequest object
+* Add property "targetBranch" to MergeRequest object

README.MD

@@ -2,9 +2,8 @@
 
 ![PHP Composer](https://github.com/ArtARTs36/php-merge-request-linter/workflows/PHP%20Composer/badge.svg?branch=master)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-<a href="https://poser.pugx.org/artarts36/merge-request-linter/d/total.svg">
-<img src="https://poser.pugx.org/artarts36/merge-request-linter/d/total.svg" alt="Total Downloads">
-</a>
+![Latest Version](https://img.shields.io/packagist/v/artarts36/merge-request-linter)
+![Total Downloads](https://poser.pugx.org/artarts36/merge-request-linter/d/total.svg)
 
 This package provides tools for validating merge requests
 
@@ -71,3 +70,7 @@ Add new script into your composer.json (section **scripts**):
 | composer lint  | Run lint (via PHPCsFixer)  |
 | composer doc-rules | Build rules doc page  |
 | composer build | Build PHAR of source |
+
+## Console output example
+
+![Example](docs/output_example.png)

docs/output_example.png

@@ -12,7 +12,9 @@ Currently is available that rules:
 | 5 | ArtARTs36\MergeRequestLinter\Rule\HasAnyLabelsOfRule | Merge Request must have any {labels}. |
 | 6 | ArtARTs36\MergeRequestLinter\Rule\HasAnyLabelsRule | Merge Request must have any labels. |
 | 7 | ArtARTs36\MergeRequestLinter\Rule\HasLinkToJiraTaskRule | The description must have a link to Jira on a {domain} with {projectCode}. |
-| 8 | ArtARTs36\MergeRequestLinter\Rule\TitleMatchesExpressionRule | The title must match the expression: {regex} |
-| 9 | ArtARTs36\MergeRequestLinter\Rule\TitleStartsWithAnyPrefixRule | The title must starts with any {prefixes} |
-| 10 | ArtARTs36\MergeRequestLinter\Rule\WhenHasLabelMustDescriptionContainsLinkOfAnyDomainsRule | When has label must description contains link of any {domains}. |
-| 11 | ArtARTs36\MergeRequestLinter\Rule\WhenHasLabelMustTitleStartsWithRule | When has label must title starts with {prefix}. |
+| 8 | ArtARTs36\MergeRequestLinter\Rule\HasLinkToYouTrackIssueRule | The description must have a link to YouTrack issue on a {domain} with {projectCode}. |
+| 9 | ArtARTs36\MergeRequestLinter\Rule\OnTargetBranchRule | Apply another rule if the target branch equals {targetBranch}. |
+| 10 | ArtARTs36\MergeRequestLinter\Rule\TitleMatchesExpressionRule | The title must match the expression: {regex} |
+| 11 | ArtARTs36\MergeRequestLinter\Rule\TitleStartsWithAnyPrefixRule | The title must starts with any {prefixes} |
+| 12 | ArtARTs36\MergeRequestLinter\Rule\WhenHasLabelMustDescriptionContainsLinkOfAnyDomainsRule | When has label must description contains link of any {domains}. |
+| 13 | ArtARTs36\MergeRequestLinter\Rule\WhenHasLabelMustTitleStartsWithRule | When has label must title starts with {prefix}. |

docs/rules.md

@@ -18,6 +18,8 @@ public function createMergeRequest(array $pullRequest): MergeRequest
             'description' => $pullRequest['bodyText'],
             'labels' => array_map(fn (array $item) => $item['name'], $pullRequest['labels']['nodes']),
             'has_conflicts' => $pullRequest['mergeable'] !== self::MERGEABLE_STATE_CONFLICTING,
+            'source_branch' => $pullRequest['headRefName'],
+            'target_branch' => $pullRequest['baseRefName'],
         ]);
     }
 
@@ -29,6 +31,8 @@ public function createGraphqlForPullRequest(string $owner, string $repo, int $re
       title
       bodyText
       mergeable
+      baseRefName
+      headRefName
       labels(first: 100) {
         totalCount
         nodes {

src/Ci/System/Schema/GithubPullRequestSchema.php

@@ -13,6 +13,8 @@ class MergeRequest
         'description' => 'string',
         'labels' => 'array',
         'has_conflicts' => 'bool',
+        'source_branch' => 'string',
+        'target_branch' => 'string',
     ];
 
     /**
@@ -23,6 +25,8 @@ public function __construct(
         public Str $description,
         public Map $labels,
         public bool $hasConflicts,
+        public Str $sourceBranch,
+        public Str $targetBranch,
     ) {
         //
     }
@@ -45,6 +49,8 @@ public static function fromArray(
             Str::make($request['description']),
             Map::fromList($request['labels']),
             (bool) $request['has_conflicts'],
+            Str::make($request['source_branch']),
+            Str::make($request['target_branch']),
         );
     }
 }

src/Request/MergeRequest.php

@@ -11,7 +11,7 @@ class HasLinkToJiraTaskRule extends SimpleRule
 {
     public function __construct(protected string $domain, protected string $projectCode)
     {
-        parent::__construct('The Description must have a link to jira on '. $this->domain);
+        parent::__construct('The description must have a link to Jira on '. $this->domain);
     }
 
     protected function doLint(MergeRequest $request): bool|array|null

src/Rule/HasLinkToJiraTaskRule.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace ArtARTs36\MergeRequestLinter\Rule;
+
+use ArtARTs36\MergeRequestLinter\Request\MergeRequest;
+
+/**
+ * The description must have a link to YouTrack issue on a {domain} with {projectCode}.
+ */
+class HasLinkToYouTrackIssueRule extends SimpleRule
+{
+    public function __construct(protected string $domain, protected string $projectCode)
+    {
+        parent::__construct('The description must have a link to YouTrack on ' . $this->domain);
+    }
+
+    protected function doLint(MergeRequest $request): bool|array|null
+    {
+        $domain = str_replace(['.'], ['\.'], $this->domain);
+
+        return $request->description->match("#$domain\/issue/$this->projectCode-\d#")->isNotEmpty();
+    }
+}

src/Rule/HasLinkToYouTrackIssueRule.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace ArtARTs36\MergeRequestLinter\Rule;
+
+use ArtARTs36\MergeRequestLinter\Contracts\Rule;
+use ArtARTs36\MergeRequestLinter\Contracts\RuleDefinition;
+use ArtARTs36\MergeRequestLinter\Request\MergeRequest;
+
+/**
+ * Apply another rule if the target branch equals {targetBranch}.
+ */
+class OnTargetBranchRule implements Rule
+{
+    public function __construct(protected string $targetBranch, protected Rule $decorateRule)
+    {
+        //
+    }
+
+    public function lint(MergeRequest $request): array
+    {
+        return $request->targetBranch->equals($this->targetBranch) ?
+            $this->decorateRule->lint($request) :
+            [];
+    }
+
+    public function getDefinition(): RuleDefinition
+    {
+        return new Definition('Apply another rule if the target branch equals: ' . $this->targetBranch);
+    }
+}

src/Rule/OnTargetBranchRule.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace ArtARTs36\MergeRequestLinter\Tests\Mocks;
+
+use ArtARTs36\MergeRequestLinter\Contracts\Rule;
+use ArtARTs36\MergeRequestLinter\Contracts\RuleDefinition;
+use ArtARTs36\MergeRequestLinter\Request\MergeRequest;
+use ArtARTs36\MergeRequestLinter\Rule\Definition;
+
+final class FailRule implements Rule
+{
+    public function lint(MergeRequest $request): array
+    {
+        return [new EmptyNote()];
+    }
+
+    public function getDefinition(): RuleDefinition
+    {
+        return new Definition('');
+    }
+}