Removed special case tags behaviour

While inserting the <ins> or <del> tags we looked at a list of special tags, and tried to also wrap those in extra <ins> or <del> tags.

This behaviour is inherited from the library that this library is based on, and seems to have some bugs in it.

We got some reports in GitHub about this, and intially I tried to fix the feature.

After realizing the use-case for this is not documented, not in this library or the source library, and the use-case for it is vague, and it being more trouble then it's worth, maybe its best to just completely remove it, reducing the code complexity in the process and also fixing the issues all at the same time.

Author: SavageTiger

lib/Caxy/HtmlDiff/HtmlDiff.php

@@ -530,73 +530,44 @@ protected function findIsolatedDiffTagsInOld($operation, $posInNew)
      */
     protected function insertTag($tag, $cssClass, &$words)
     {
-        while (true) {
-            if (count($words) === 0) {
-                break;
-            }
-
+        while (count($words) > 0) {
             $nonTags = $this->extractConsecutiveWords($words, 'noTag');
 
-            $specialCaseTagInjection = '';
-            $specialCaseTagInjectionIsBefore = false;
-
-            if (count($nonTags) !== 0) {
+            if (count($nonTags) > 0) {
                 $this->content .= $this->wrapText(implode('', $nonTags), $tag, $cssClass);
-            } else {
-                $firstOrDefault = false;
-                foreach ($this->config->getSpecialCaseOpeningTags() as $x) {
-                    if (preg_match($x, $words[ 0 ])) {
-                        $firstOrDefault = $x;
-                        break;
-                    }
-                }
-                if ($firstOrDefault) {
-                    $specialCaseTagInjection = '<ins class="mod">';
-                    if ($tag === 'del') {
-                        unset($words[ 0 ]);
-                    }
-                } elseif (array_search($words[ 0 ], $this->config->getSpecialCaseClosingTags()) !== false) {
-                    $specialCaseTagInjection = '</ins>';
-                    $specialCaseTagInjectionIsBefore = true;
-                    if ($tag === 'del') {
-                        unset($words[ 0 ]);
-                    }
-                }
             }
-            if (count($words) == 0 && $this->stringUtil->strlen($specialCaseTagInjection) == 0) {
+
+            if (count($words) === 0) {
                 break;
             }
-            if ($specialCaseTagInjectionIsBefore) {
-                $this->content .= $specialCaseTagInjection . implode('', $this->extractConsecutiveWords($words, 'tag'));
-            } else {
-                $workTag = $this->extractConsecutiveWords($words, 'tag');
 
-                if (
-                    isset($workTag[0]) === true &&
-                    $this->isOpeningTag($workTag[0]) === true &&
-                    $this->isClosingTag($workTag[0]) === false
-                ) {
-                    if ($this->stringUtil->strpos($workTag[0], 'class=')) {
-                        $workTag[0] = str_replace('class="', 'class="diffmod ', $workTag[0]);
-                    } else {
-                        $isSelfClosing = $this->stringUtil->strpos($workTag[0], '/>') !== false;
+            $workTag = $this->extractConsecutiveWords($words, 'tag');
+
+            if (
+                isset($workTag[0]) === true &&
+                $this->isOpeningTag($workTag[0]) === true &&
+                $this->isClosingTag($workTag[0]) === false
+            ) {
+                if ($this->stringUtil->strpos($workTag[0], 'class=')) {
+                    $workTag[0] = str_replace('class="', 'class="diffmod ', $workTag[0]);
+                } else {
+                    $isSelfClosing = $this->stringUtil->strpos($workTag[0], '/>') !== false;
 
-                        if ($isSelfClosing === true) {
-                            $workTag[0] = str_replace('/>', ' class="diffmod" />', $workTag[0]);
-                        } else {
-                            $workTag[0] = str_replace('>', ' class="diffmod">', $workTag[0]);
-                        }
+                    if ($isSelfClosing === true) {
+                        $workTag[0] = str_replace('/>', ' class="diffmod" />', $workTag[0]);
+                    } else {
+                        $workTag[0] = str_replace('>', ' class="diffmod">', $workTag[0]);
                     }
                 }
+            }
 
-                $appendContent = implode('', $workTag) . $specialCaseTagInjection;
+            $appendContent = implode('', $workTag);
 
-                if (isset($workTag[0]) === true && $this->stringUtil->stripos($workTag[0], '<img') !== false) {
-                    $appendContent = $this->wrapText($appendContent, $tag, $cssClass);
-                }
-
-                $this->content .= $appendContent;
+            if (isset($workTag[0]) === true && $this->stringUtil->stripos($workTag[0], '<img') !== false) {
+                $appendContent = $this->wrapText($appendContent, $tag, $cssClass);
             }
+
+            $this->content .= $appendContent;
         }
     }