Merge branch 'develop'

* develop: Fixed matching directives ending in newline (#1414) Perf optimize `Line::isDirective()` (#1412) Move method call out of hot loop (#1413)
OskarStark · May 22, 2023 · cd3d809 · cd3d809
2 parents 89a672d + 5b6fa08
commit cd3d809
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 10 deletions.
diff --git a/src/Analyzer/RstAnalyzer.php b/src/Analyzer/RstAnalyzer.php
@@ -88,13 +88,14 @@ public function analyze(\SplFileInfo $file, array $rules): array
          */
         foreach ($lines->toIterator() as $no => $line) {
             \assert(\is_int($no));
+            $lineIsBlank = $line->isBlank();
 
             foreach ($lineContentRules as $rule) {
                 if ($lines->isProcessedBy($no, $rule::class)) {
                     continue;
                 }
 
-                if (!$rule::runOnlyOnBlankline() && $line->isBlank()) {
+                if (!$rule::runOnlyOnBlankline() && $lineIsBlank) {
                     continue;
                 }
 

diff --git a/src/Value/Line.php b/src/Value/Line.php
@@ -75,17 +75,29 @@ public function isHeadline(): bool
         return $this->headline;
     }
 
-    /**
-     * @todo use regex here
-     */
     public function isDirective(): bool
     {
         if (null === $this->isDirective) {
-            $this->isDirective = (
-                str_starts_with(ltrim($this->raw->toString()), '.. ')
-                    && !str_starts_with(ltrim($this->raw->toString()), '.. _`')
-                    && str_contains($this->raw->toString(), '::')
-            ) || $this->isDefaultDirective();
+            $string = ltrim($this->raw->toString());
+            $len = strlen($string);
+
+            if ($len >= 2
+                && $string[0] === '.'
+                && $string[1] === '.'
+            ) {
+                if (
+                    !str_starts_with($string, '.. _`')
+                    && str_contains($string, '::'))
+                {
+                    return $this->isDirective = true;
+                }
+            }
+
+            if ($this->isDefaultDirective()) {
+                return $this->isDirective = true;
+            }
+
+            $this->isDirective = false;
         }
 
         return $this->isDirective;
@@ -94,7 +106,7 @@ public function isDirective(): bool
     public function isDefaultDirective(): bool
     {
         if (null === $this->isDefaultDirective) {
-            $string = $this->raw->toString();
+            $string = rtrim($this->raw->toString());
             $len = strlen($string);
 
             if ($len < 2 || $string[$len - 1] !== ':' || $string[$len - 2] !== ':') {

diff --git a/tests/Rst/Value/LineTest.php b/tests/Rst/Value/LineTest.php
@@ -194,6 +194,7 @@ public static function isDefaultDirectiveProvider(): \Generator
     {
         yield [true, 'this is using the default directive::'];
         yield [true, 'prefixed classes included in doc block comments (``/** ... */``). For example::'];
+        yield [true, "this is using the default directive::\n"];
 
         yield [false, ''];
         yield [false, '.. code-block:: php'];