Add RendererInterface::getResultForIdenticals()

Replacement for the deprecated AbstractRenderer::getIdenticalResult().

Signed-off-by: Jack Cherng <jfcherng@gmail.com>

Author: jfcherng

UPGRADING/UPGRADING_v6.md

@@ -34,6 +34,12 @@ there is no breaking change for you so you do not have to do anything.
 - If you call `Differ::getGroupedOpcodes()` by yourself,
   you must call `Differ::finalize()` before it.
 
+- Add `RendererInterface::getResultForIdenticals()`.
+  `AbstractRenderer::getResultForIdenticals()` returns an empty string by default.
+
+- Remove the deprecated `AbstractRenderer::getIdenticalResult()`.
+  Use/implement the `AbstractRenderer::getResultForIdenticals()` instead.
+
 
 ### Internal Breaking Changes
 

src/Renderer/AbstractRenderer.php

@@ -101,11 +101,9 @@ public function getOptions(): array
     }
 
     /**
-     * Get the renderer result when the old and the new are the same.
-     *
-     * @return string
+     * {@inheritdoc}
      */
-    public static function getIdenticalResult(): string
+    public function getResultForIdenticals(): string
     {
         return '';
     }
@@ -119,7 +117,7 @@ public function render(Differ $differ): string
 
         // the "no difference" situation may happen frequently
         return $differ->getOldNewComparison() === 0
-            ? static::getIdenticalResult()
+            ? $this->getResultForIdenticals()
             : $this->renderWoker($differ);
     }
 

src/Renderer/Html/Inline.php

@@ -28,7 +28,7 @@ protected function renderWoker(Differ $differ): string
         $changes = $this->getChanges($differ);
 
         if (empty($changes)) {
-            return self::getIdenticalResult();
+            return $this->getResultForIdenticals();
         }
 
         $html = '<table class="diff diff-html diff-inline">';

src/Renderer/Html/Json.php

@@ -28,7 +28,7 @@ final class Json extends AbstractHtml
     /**
      * {@inheritdoc}
      */
-    public static function getIdenticalResult(): string
+    public function getResultForIdenticals(): string
     {
         return '[]';
     }

src/Renderer/Html/SideBySide.php

@@ -28,7 +28,7 @@ protected function renderWoker(Differ $differ): string
         $changes = $this->getChanges($differ);
 
         if (empty($changes)) {
-            return self::getIdenticalResult();
+            return $this->getResultForIdenticals();
         }
 
         $html = '<table class="diff diff-html diff-side-by-side">';

src/Renderer/RendererInterface.php

@@ -11,6 +11,13 @@
  */
 interface RendererInterface
 {
+    /**
+     * Get the renderer result when the old and the new are the same.
+     *
+     * @return string
+     */
+    public function getResultForIdenticals(): string;
+
     /**
      * Render the differ and return the result.
      *