Add renderer option: outputTagAsString

Signed-off-by: Jack Cherng <[email protected]>

Author: jfcherng

README.md

@@ -73,6 +73,9 @@ $templateOptions = [
     'spacesToNbsp' => false,
     // HTML template tab width (negative = do not convert into spaces)
     'tabSize' => 4,
+    // internally, ops (tags) are all int type but this is not good for human reading.
+    // set this to "true" to convert them into string form before outputting.
+    'outputTagAsString' => true,
 ];
 
 // one-line simple usage

UPGRADING_v5.md

@@ -15,3 +15,6 @@
 
   - `<th class="f-num">` (from-number) becomes `<th class="n-new">` (number-new).
   - `<th class="t-num">` (to-number) becomes `<th class="n-old">` (number-old).
+
+- The `tag` in `Json` template is now in `int` form by default.
+  To get previous behavior, set the renderer option `outputTagAsString` to `true`.

example/demo.php

@@ -40,6 +40,9 @@
                 'spacesToNbsp' => false,
                 // HTML template tab width (negative = do not convert into spaces)
                 'tabSize' => 4,
+                // internally, ops (tags) are all int type but this is not good for human reading.
+                // set this to "true" to convert them into string form before outputting.
+                'outputTagAsString' => false,
             ];
 
         ?>
@@ -181,7 +184,7 @@
                 $new_file,
                 'Json',
                 $diffOptions,
-                $templateOptions
+                ['outputTagAsString' => true] + $templateOptions
             );
 
             $beautified = \json_encode(

src/Renderer/AbstractRenderer.php

@@ -50,6 +50,9 @@ abstract class AbstractRenderer implements RendererInterface
         // the frontend HTML could use CSS "white-space: pre;" to visualize consecutive whitespaces
         // but if you want to visualize them in the backend with " ", you can set this to true
         'spacesToNbsp' => false,
+        // internally, ops (tags) are all int type but this is not good for human reading.
+        // set this to "true" to convert them into string form before outputting.
+        'outputTagAsString' => false,
     ];
 
     /**

src/Renderer/Html/Json.php

@@ -4,6 +4,8 @@
 
 namespace Jfcherng\Diff\Renderer\Html;
 
+use Jfcherng\Diff\SequenceMatcher;
+
 /**
  * Json diff generator.
  */
@@ -26,12 +28,32 @@ final class Json extends AbstractHtml
      */
     public function render(): string
     {
+        $changes = $this->getChanges();
+
+        if ($this->options['outputTagAsString']) {
+            $this->convertTagToString($changes);
+        }
+
         return \json_encode(
-            $this->getChanges(),
+            $changes,
             \JSON_UNESCAPED_UNICODE | \JSON_UNESCAPED_SLASHES
         );
     }
 
+    /**
+     * Convert tags of changes to their string form for better readability.
+     *
+     * @param array $changes the changes
+     */
+    protected function convertTagToString(array &$changes): void
+    {
+        foreach ($changes as &$blocks) {
+            foreach ($blocks as &$change) {
+                $change['tag'] = SequenceMatcher::opIntToStr($change['tag']);
+            }
+        }
+    }
+
     /**
      * {@inheritdoc}
      */

tests/DiffTest.php

@@ -5,6 +5,7 @@
 namespace Jfcherng\Diff\Test;
 
 use Jfcherng\Diff\Diff;
+use Jfcherng\Diff\SequenceMatcher;
 use PHPUnit\Framework\TestCase;
 
 /**
@@ -37,10 +38,10 @@ public function getGroupedOpcodesDataProvider(): array
                 ,
                 [
                     [
-                        ['eq', 0, 1, 0, 1],
-                        ['del', 1, 2, 1, 1],
-                        ['eq', 2, 4, 1, 3],
-                        ['ins', 4, 4, 3, 4],
+                        [SequenceMatcher::OP_EQ, 0, 1, 0, 1],
+                        [SequenceMatcher::OP_DEL, 1, 2, 1, 1],
+                        [SequenceMatcher::OP_EQ, 2, 4, 1, 3],
+                        [SequenceMatcher::OP_INS, 4, 4, 3, 4],
                     ],
                 ],
             ],