Merge #637 - Fix formatter spacing for JSON path operators (->, ->>)

Pull-request: #637
Signed-off-by: William Desportes <[email protected]>

Author: williamdes

src/Context.php

@@ -139,6 +139,8 @@ abstract class Context
         ')' => 16,
         '.' => 16,
         ',' => 16,
+        '->' => 16,
+        '->>' => 16,
         ';' => 16,
     ];
 

src/Utils/Formatter.php

@@ -533,19 +533,21 @@ public function formatList($list)
 
                     $lineEnded = false;
                 } else {
-                    // If the line ended there is no point in adding whitespaces.
+                    // If the line ended, there is no point in adding whitespaces.
                     // Also, some tokens do not have spaces before or after them.
                     if (
-                        // A space after delimiters that are longer than 2 characters.
                         $prev->keyword === 'DELIMITER'
                         || ! (
-                            ($prev->type === Token::TYPE_OPERATOR && ($prev->value === '.' || $prev->value === '('))
-                            // No space after . (
-                            || ($curr->type === Token::TYPE_OPERATOR
-                                && ($curr->value === '.' || $curr->value === ','
-                                    || $curr->value === '(' || $curr->value === ')'))
-                            // No space before . , ( )
-                            || $curr->type === Token::TYPE_DELIMITER && mb_strlen((string) $curr->value, 'UTF-8') < 2
+                        ($prev->type === Token::TYPE_OPERATOR
+                            && ($prev->value === '.' || $prev->value === '('
+                                || $prev->value === '->' || $prev->value === '->>'))
+                        // No space after punctuation and JSON operators.
+                        || ($curr->type === Token::TYPE_OPERATOR
+                            && ($curr->value === '.' || $curr->value === ','
+                                || $curr->value === '(' || $curr->value === ')'
+                                || $curr->value === '->' || $curr->value === '->>'))
+                        // No space before punctuation and JSON operators.
+                        || $curr->type === Token::TYPE_DELIMITER && mb_strlen((string) $curr->value, 'UTF-8') < 2
                         )
                     ) {
                         $ret .= ' ';

tests/Utils/FormatterTest.php

@@ -321,6 +321,36 @@ public static function formatQueriesProviders(): array
                     '<span class="sql-reserved">WHERE</span><br/>' .
                     '&nbsp;&nbsp;&nbsp;&nbsp;<span class="sql-number">1</span>',
             ],
+            'json operator' => [
+                'query' => 'SELECT details->\'$."first_name"\' FROM users',
+                'text' => 'SELECT' . "\n" .
+                    '    details->\'$."first_name"\'' . "\n" .
+                    'FROM' . "\n" .
+                    '    users',
+                'cli' => "\x1b[35mSELECT\n" .
+                    "    \x1b[39mdetails->\x1b[91m'$.\"first_name\"'\n" .
+                    "\x1b[35mFROM\n" .
+                    "    \x1b[39musers\x1b[0m",
+                'html' => '<span class="sql-reserved">SELECT</span><br/>' .
+                    '&nbsp;&nbsp;&nbsp;&nbsp;details-&gt;<span class="sql-string">\'$."first_name"\'</span><br/>' .
+                    '<span class="sql-reserved">FROM</span><br/>' .
+                    '&nbsp;&nbsp;&nbsp;&nbsp;users',
+            ],
+            'json operator (unquoted)' => [
+                'query' => 'SELECT metadata->>"$.url" FROM `alerts`;',
+                'text' => 'SELECT' . "\n" .
+                    '    metadata->>"$.url"' . "\n" .
+                    'FROM' . "\n" .
+                    '    `alerts`;',
+                'cli' => "\x1b[35mSELECT\n" .
+                    "    \x1b[39mmetadata->>\x1b[91m\"$.url\"\n" .
+                    "\x1b[35mFROM\n" .
+                    "    \x1b[36m`alerts`\x1b[39m;\x1b[0m",
+                'html' => '<span class="sql-reserved">SELECT</span><br/>' .
+                    '&nbsp;&nbsp;&nbsp;&nbsp;metadata-&gt;&gt;<span class="sql-string">"$.url"</span><br/>' .
+                    '<span class="sql-reserved">FROM</span><br/>' .
+                    '&nbsp;&nbsp;&nbsp;&nbsp;<span class="sql-variable">`alerts`</span>;',
+            ],
             'typical' => [
                 'query' => 'SELECT id, if(id=1,"Si","No") from `tbl` where id = 0 or ' .
                     'id = 1 group by id order by id desc limit 1 offset 0',