fixing tests for updated highlighting rules

weaverryan · weaverryan · commit d75a661180f5 · 2019-08-04T15:07:55.000-04:00
Also fixing a bug where the `::` was not matching strongly enough, which
was causing `::class` to be seen as a `::` operator (correct) but then
the `class` was seen as a class declaration.
diff --git a/src/Templates/highlight.php/README.md b/src/Templates/highlight.php/README.md
@@ -0,0 +1,30 @@
+# Custom Highlight Templates
+
+The highlight.php library takes its highlighting metadata/rules
+from highlight.js. That library builds the highlighting metadata/rules
+in Node and then outputs them as JSON:
+
+* Source Language files: https://github.com/highlightjs/highlight.js/tree/master/src/languages
+* Final Language files: https://github.com/scrivo/highlight.php/tree/master/Highlight/languages
+
+In a few cases, we've extended the language rules, which (in theory)
+should make it back upstream to highlight.js. These files began
+as copies of the .json files (which were then prettified) then extended.
+
+A few things we've learned about how the language files work:
+
+* `begin` is the regex that marks the beginning of something
+* `end` is optional. Without it, `begin` will be used, and as
+    soon as it finds a non-matching character, it will stop.
+    If you have a situation where using begin is causing
+    over-matching, then you can use end to tell it exactly where
+    to stop.
+* `excludeEnd` can be used to match an entire string with `begin`
+    and `end`, but then only apply the class name to the part
+    matched by `start`. This was useful with `::` where we wanted
+    to match `::` THEN some valid string (to avoid over-matching
+    `::` in other situations). But, we only wanted the class name
+    applied to the `start` part (the `::` part).
+* `contains` the way for building embedded rules. `function` is
+    a nice example, which outlines the `start` and `end` and then
+    also outlines some items that will be embedded inside of it.
diff --git a/src/Templates/highlight.php/php.json b/src/Templates/highlight.php/php.json
@@ -117,7 +117,9 @@
         },
         {
             "className": "operator",
-            "begin": "(::|->)"
+            "begin": "(::|->)",
+            "end": "[a-zA-Z_\\x7f-\\xff][a-zA-Z0-9_\\x7f-\\xff]*",
+            "excludeEnd": true
         },
         {
             "className": "function",
diff --git a/tests/IntegrationTest.php b/tests/IntegrationTest.php
@@ -50,7 +50,7 @@ public function testIntegration(string $folder)
             ->files()
             ->depth('>=0');
 
-        $indenter = new Indenter();
+        $indenter = $this->createIndenter();
         foreach ($finder as $expectedFile) {
             $relativePath   = $expectedFile->getRelativePathname();
             $actualFilename = __DIR__.'/_output/'.$relativePath;
@@ -126,7 +126,7 @@ public function testParseUnitBlock(string $blockName)
 
         $document = $parser->parseFile($sourceFile)->renderDocument();
 
-        $indenter = new Indenter();
+        $indenter = $this->createIndenter();
 
         $expectedFile = sprintf('%s/fixtures/expected/blocks/%s.html', __DIR__, $blockName);
         $this->assertSame(
@@ -291,4 +291,13 @@ private function createBuildContext(string $sourceDir): BuildContext
 
         return $buildContext;
     }
+
+    private function createIndenter(): Indenter
+    {
+        $indenter = new Indenter();
+        // indent spans - easier to debug failures
+        $indenter->setElementType('span', Indenter::ELEMENT_TYPE_BLOCK);
+
+        return $indenter;
+    }
 }
diff --git a/tests/fixtures/expected/blocks/code-blocks/php-annotations.html b/tests/fixtures/expected/blocks/code-blocks/php-annotations.html
@@ -27,7 +27,7 @@
 </span>
                                     {
                                     <span class="hljs-comment">/** * <span class="hljs-doctag">@Assert</span>\Iban( * message="This is not a valid International Bank Account Number (IBAN)." * ) */</span>
-                                    <span class="hljs-keyword">protected</span> $bankAccountNumber;
+                                    <span class="hljs-keyword">protected</span> <span class="hljs-variable">$bankAccountNumber</span>;
 }
                                 </pre>
                     </div>
diff --git a/tests/fixtures/expected/blocks/code-blocks/php.html b/tests/fixtures/expected/blocks/code-blocks/php.html
@@ -24,8 +24,11 @@
                         <pre class="hljs php">
                                     <span class="hljs-comment">// config/routes.php</span>
 <span class="hljs-keyword">namespace</span> <span class="hljs-title">Symfony</span>\<span class="hljs-title">Component</span>\<span class="hljs-title">Routing</span>\<span class="hljs-title">Loader</span>\<span class="hljs-title">Configurator</span>; <span class="hljs-keyword">return</span>
-                                    <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-params">(RoutingConfigurator $routes)</span> </span>
-                                    { $routes-&gt;add(<span class="hljs-string">'about_us'</span>, [<span class="hljs-string">'nl'</span> =&gt; <span class="hljs-string">'/over-ons'</span>, <span class="hljs-string">'en'</span> =&gt; <span class="hljs-string">'/about-us'</span>]) -&gt;controller(<span class="hljs-string">'App\Controller\CompanyController::about'</span>);
+                                    <span class="hljs-function">
+                                        <span class="hljs-keyword">function</span>
+                                        <span class="hljs-params">(RoutingConfigurator <span class="hljs-variable">$routes</span>)</span>
+                                    </span>
+                                    { <span class="hljs-variable">$routes</span><span class="hljs-operator">-&gt;</span>add(<span class="hljs-string">'about_us'</span>, [<span class="hljs-string">'nl'</span> =&gt; <span class="hljs-string">'/over-ons'</span>, <span class="hljs-string">'en'</span> =&gt; <span class="hljs-string">'/about-us'</span>]) <span class="hljs-operator">-&gt;</span>controller(<span class="hljs-string">'App\Controller\CompanyController::about'</span>);
 };</pre>
                     </div>
                 </td>
diff --git a/tests/fixtures/expected/blocks/nodes/literal.html b/tests/fixtures/expected/blocks/nodes/literal.html
@@ -25,8 +25,8 @@
                         <pre class="hljs php">
                                     <span class="hljs-comment">// config/routes.php</span>
 <span class="hljs-keyword">namespace</span> <span class="hljs-title">Symfony</span>\<span class="hljs-title">Component</span>\<span class="hljs-title">Routing</span>\<span class="hljs-title">Loader</span>\<span class="hljs-title">Configurator</span>; <span class="hljs-keyword">return</span>
-                                    <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-params">(RoutingConfigurator $routes)</span> </span>
-                                    { $routes-&gt;add(<span class="hljs-string">'about_us'</span>, [<span class="hljs-string">'nl'</span> =&gt; <span class="hljs-string">'/over-ons'</span>, <span class="hljs-string">'en'</span> =&gt; <span class="hljs-string">'/about-us'</span>]) -&gt;controller(<span class="hljs-string">'App\Controller\CompanyController::about'</span>);
+                                    <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-params">(RoutingConfigurator <span class="hljs-variable">$routes</span>)</span> </span>
+                                    { <span class="hljs-variable">$routes</span><span class="hljs-operator">-&gt;</span>add(<span class="hljs-string">'about_us'</span>, [<span class="hljs-string">'nl'</span> =&gt; <span class="hljs-string">'/over-ons'</span>, <span class="hljs-string">'en'</span> =&gt; <span class="hljs-string">'/about-us'</span>]) <span class="hljs-operator">-&gt;</span>controller(<span class="hljs-string">'App\Controller\CompanyController::about'</span>);
 };</pre>
                     </div>
                 </td>
diff --git a/tests/fixtures/expected/main/datetime.html b/tests/fixtures/expected/main/datetime.html
@@ -113,7 +113,7 @@ <h3>placeholder<a class="headerlink" href="#placeholder" title="Permalink to thi
                 </td>
                 <td class="code">
                     <div class="highlight">
-                         <pre class="hljs php"><span class="hljs-keyword">use</span> <span class="hljs-title">Symfony</span>\<span class="hljs-title">Component</span>\<span class="hljs-title">Form</span>\<span class="hljs-title">Extension</span>\<span class="hljs-title">Core</span>\<span class="hljs-title">Type</span>\<span class="hljs-title">DateTimeType</span>; $builder-&gt;add(<span class="hljs-string">'startDateTime'</span>, DateTimeType::class, <span class="hljs-keyword">array</span>( <span class="hljs-string">'placeholder'</span> =&gt; <span class="hljs-string">'Select a value'</span>,
+                         <pre class="hljs php"><span class="hljs-keyword">use</span> <span class="hljs-title">Symfony</span>\<span class="hljs-title">Component</span>\<span class="hljs-title">Form</span>\<span class="hljs-title">Extension</span>\<span class="hljs-title">Core</span>\<span class="hljs-title">Type</span>\<span class="hljs-title">DateTimeType</span>; <span class="hljs-variable">$builder</span><span class="hljs-operator">-&gt;</span>add(<span class="hljs-string">'startDateTime'</span>, DateTimeType<span class="hljs-operator">::</span>class, <span class="hljs-keyword">array</span>( <span class="hljs-string">'placeholder'</span> =&gt; <span class="hljs-string">'Select a value'</span>,
 ));</pre>
                     </div>
                 </td>
@@ -307,7 +307,7 @@ <h3>error_bubbling<a class="headerlink" href="#error-bubbling" title="Permalink
                             <td class="code">
                                 <div class="highlight">
                                     <pre class="hljs php"><span class="hljs-comment">// app/config/config.php</span>
-$container-&gt;loadFromExtension(<span class="hljs-string">'framework'</span>, <span class="hljs-keyword">array</span>( <span class="hljs-string">'secret'</span> =&gt; <span class="hljs-string">'%secret%'</span>, <span class="hljs-string">'router'</span> =&gt; <span class="hljs-keyword">array</span>( <span class="hljs-string">'resource'</span> =&gt; <span class="hljs-string">'%kernel.root_dir%/config/routing.php'</span>, ), <span class="hljs-comment">// ...</span>
+                                        <span class="hljs-variable">$container</span><span class="hljs-operator">-&gt;</span>loadFromExtension(<span class="hljs-string">'framework'</span>, <span class="hljs-keyword">array</span>( <span class="hljs-string">'secret'</span> =&gt; <span class="hljs-string">'%secret%'</span>, <span class="hljs-string">'router'</span> =&gt; <span class="hljs-keyword">array</span>( <span class="hljs-string">'resource'</span> =&gt; <span class="hljs-string">'%kernel.root_dir%/config/routing.php'</span>, ), <span class="hljs-comment">// ...</span>
 )); <span class="hljs-comment">// ...</span></pre>
                                 </div>
                             </td>

Original file line number	Diff line number	Diff line change
`@@ -117,7 +117,9 @@`
`117`	`117`	`},`
`118`	`118`	`{`
`119`	`119`	`"className": "operator",`
`120`		`- "begin": "(::\|->)"`
	`120`	`+ "begin": "(::\|->)",`
	`121`	`+ "end": "[a-zA-Z_\\x7f-\\xff][a-zA-Z0-9_\\x7f-\\xff]*",`
	`122`	`+ "excludeEnd": true`
`121`	`123`	`},`
`122`	`124`	`{`
`123`	`125`	`"className": "function",`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@`
`27`	`27`	`</span>`
`28`	`28`	`{`
`29`	`29`	`<span class="hljs-comment">/** * <span class="hljs-doctag">@Assert</span>\Iban( * message="This is not a valid International Bank Account Number (IBAN)." * ) */</span>`
`30`		`- <span class="hljs-keyword">protected</span> $bankAccountNumber;`
	`30`	`+ <span class="hljs-keyword">protected</span> <span class="hljs-variable">$bankAccountNumber</span>;`
`31`	`31`	`}`
`32`	`32`	`</pre>`
`33`	`33`	`</div>`