Add (private) Diff::finalize() to help maintain cache vadility

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

Author: jfcherng

src/Diff.php

@@ -17,6 +17,13 @@
  */
 final class Diff
 {
+    /**
+     * @var array cached properties and their default values
+     */
+    private const CACHED_PROPERTIES = [
+        'groupedCodes' => null,
+    ];
+
     /**
      * @var array array of the options that have been applied for generating the diff
      */
@@ -32,6 +39,11 @@ final class Diff
      */
     private $new = [];
 
+    /**
+     * @var bool is any of cached properties dirty?
+     */
+    private $isCacheDirty = true;
+
     /**
      * @var null|SequenceMatcher the sequence matcher
      */
@@ -94,8 +106,7 @@ public function setOld(array $old): self
     {
         if ($this->old !== $old) {
             $this->old = $old;
-            $this->sequenceMatcher->setSeq1($old);
-            $this->resetCachedResults();
+            $this->isCacheDirty = true;
         }
 
         return $this;
@@ -112,8 +123,7 @@ public function setNew(array $new): self
     {
         if ($this->new !== $new) {
             $this->new = $new;
-            $this->sequenceMatcher->setSeq2($new);
-            $this->resetCachedResults();
+            $this->isCacheDirty = true;
         }
 
         return $this;
@@ -128,10 +138,12 @@ public function setNew(array $new): self
      */
     public function setOptions(array $options): self
     {
-        $this->options = $options + static::$defaultOptions;
+        $mergedOptions = $options + static::$defaultOptions;
 
-        $this->sequenceMatcher->setOptions($this->options);
-        $this->resetCachedResults();
+        if ($this->options !== $mergedOptions) {
+            $this->options = $mergedOptions;
+            $this->isCacheDirty = true;
+        }
 
         return $this;
     }
@@ -198,22 +210,12 @@ public static function getInstance(): self
      */
     public function getGroupedOpcodes(): array
     {
+        $this->finalize();
+
         return $this->groupedCodes = $this->groupedCodes ??
             $this->sequenceMatcher->getGroupedOpcodes($this->options['context']);
     }
 
-    /**
-     * Reset cached results.
-     *
-     * @return self
-     */
-    public function resetCachedResults(): self
-    {
-        $this->groupedCodes = null;
-
-        return $this;
-    }
-
     /**
      * Render a diff using the supplied rendering class and return it.
      *
@@ -223,6 +225,8 @@ public function resetCachedResults(): self
      */
     public function render(AbstractRenderer $renderer): string
     {
+        $this->finalize();
+
         $renderer->setDiff($this);
 
         // the "no difference" situation may happen frequently
@@ -232,6 +236,43 @@ public function render(AbstractRenderer $renderer): string
             : $renderer->render();
     }
 
+    /**
+     * Claim this class is all set.
+     *
+     * Properties will be propagated to other classes. You must re-call
+     * this method after any property changed before doing calculation.
+     *
+     * @return self
+     */
+    private function finalize(): self
+    {
+        if ($this->isCacheDirty) {
+            $this->resetCachedResults();
+
+            $this->sequenceMatcher
+                ->setOptions($this->options)
+                ->setSequences($this->old, $this->new);
+        }
+
+        return $this;
+    }
+
+    /**
+     * Reset cached results.
+     *
+     * @return self
+     */
+    private function resetCachedResults(): self
+    {
+        foreach (static::CACHED_PROPERTIES as $property => $value) {
+            $this->$property = $value;
+        }
+
+        $this->isCacheDirty = false;
+
+        return $this;
+    }
+
     /**
      * The work horse of getA() and getB().
      *