New Rule: EnsureAttributeBetweenBackticksInContent

Author: MrYamous

docs/rules.md

@@ -19,6 +19,7 @@
 * [deprecated_directive_major_version](#deprecated_directive_major_version)
 * [deprecated_directive_min_version](#deprecated_directive_min_version)
 * [deprecated_directive_should_have_version](#deprecated_directive_should_have_version)
+* [ensure_attribute_between_backticks_in_content](#ensure_attribute_between_backticks_in_content)
 * [ensure_bash_prompt_before_composer_command](#ensure_bash_prompt_before_composer_command)
 * [ensure_class_constant](#ensure_class_constant)
 * [ensure_correct_format_for_phpfunction](#ensure_correct_format_for_phpfunction)
@@ -403,6 +404,22 @@ Name | Required
 - Rule class: [App\Rule\DeprecatedDirectiveShouldHaveVersion](https://github.com/OskarStark/doctor-rst/blob/develop/src/Rule/DeprecatedDirectiveShouldHaveVersion.php)
 - Test class: [App\Tests\Rule\DeprecatedDirectiveShouldHaveVersionTest](https://github.com/OskarStark/doctor-rst/blob/develop/tests/Rule/DeprecatedDirectiveShouldHaveVersionTest.php)
 
+## `ensure_attribute_between_backticks_in_content`
+
+  > _Make sure to use backticks around attribute in content._
+
+##### Valid Examples :+1:
+
+```rst
+Use ``#[Route]`` to define route
+```
+
+##### Invalid Examples :-1:
+
+```rst
+Use #[Route] to define route
+```
+
 ## `ensure_bash_prompt_before_composer_command`
 
   > _Make sure Composer command in a terminal/bash code block is prefixed with a $._

src/Rule/EnsureAttributeBetweenBackticksInContent.php

@@ -0,0 +1,56 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of DOCtor-RST.
+ *
+ * (c) Oskar Stark <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Rule;
+
+use App\Attribute\Rule\Description;
+use App\Attribute\Rule\InvalidExample;
+use App\Attribute\Rule\ValidExample;
+use App\Rst\RstParser;
+use App\Value\Lines;
+use App\Value\NullViolation;
+use App\Value\Violation;
+use App\Value\ViolationInterface;
+
+#[Description('Make sure to use backticks around attributes in content')]
+#[InvalidExample('Use #[Route] to define route')]
+#[ValidExample('Use ``#[Route]`` to define route')]
+class EnsureAttributeBetweenBackticksInContent extends AbstractRule implements LineContentRule
+{
+    public function check(Lines $lines, int $number, string $filename): ViolationInterface
+    {
+        $lines->seek($number);
+        $line = $lines->current();
+
+        if (RstParser::codeBlockDirectiveIsTypeOf($line, RstParser::CODE_BLOCK_PHP)
+            || RstParser::codeBlockDirectiveIsTypeOf($line, RstParser::CODE_BLOCK_PHP_ANNOTATIONS, true)
+            || RstParser::codeBlockDirectiveIsTypeOf($line, RstParser::CODE_BLOCK_PHP_ATTRIBUTES, true)
+            || RstParser::codeBlockDirectiveIsTypeOf($line, RstParser::CODE_BLOCK_PHP_SYMFONY, true)
+            || RstParser::codeBlockDirectiveIsTypeOf($line, RstParser::CODE_BLOCK_PHP_STANDALONE, true)
+            || RstParser::codeBlockDirectiveIsTypeOf($line, RstParser::CODE_BLOCK_HTML_PHP, true)
+        ) {
+            return NullViolation::create();
+        }
+
+        if ($line->raw()->match('/(?<!`)#\[[^\]]*\](?!`)/')) {
+            return Violation::from(
+                \sprintf('Please ensure to use backticks "%s"', $line->raw()->toString()),
+                $filename,
+                $number + 1,
+                $line,
+            );
+        }
+
+        return NullViolation::create();
+    }
+}

tests/Rule/EnsureAttributeBetweenBackticksInContentTest.php

@@ -0,0 +1,65 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of DOCtor-RST.
+ *
+ * (c) Oskar Stark <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Tests\Rule;
+
+use App\Rule\EnsureAttributeBetweenBackticksInContent;
+use App\Rule\PhpOpenTagInCodeBlockPhpDirective;
+use App\Tests\RstSample;
+use App\Tests\UnitTestCase;
+use App\Value\NullViolation;
+use App\Value\Violation;
+use App\Value\ViolationInterface;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\Test;
+
+final class EnsureAttributeBetweenBackticksInContentTest extends UnitTestCase
+{
+    #[Test]
+    #[DataProvider('checkProvider')]
+    public function check(ViolationInterface $expected, RstSample $sample): void
+    {
+        self::assertEquals(
+            $expected,
+            (new EnsureAttributeBetweenBackticksInContent())->check($sample->lines, $sample->lineNumber, 'filename'),
+        );
+    }
+
+    public static function checkProvider(): iterable
+    {
+        foreach (self::phpCodeBlocks() as $codeBlock) {
+            yield \sprintf('No violation for code-block "%s"', $codeBlock) => [
+                NullViolation::create(),
+                new RstSample([
+                    $codeBlock,
+                    '#[AsEventListener]'
+                ]),
+            ];
+        }
+
+        yield \sprintf('Has violation without backticks') => [
+            Violation::from(
+                \sprintf('Please ensure to use backticks "use #[MapEntity] attributes"'),
+                'filename',
+                1,
+                'use #[MapEntity] attributes',
+            ),
+            new RstSample('use #[MapEntity] attributes')
+        ];
+
+        yield \sprintf('Has no violation') => [
+            NullViolation::create(),
+            new RstSample('use ``#[MapEntity]`` attributes')
+        ];
+    }
+}