Skip to content

Implement spaceMatching config to detect space changes in HTML diffs #141

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Copilot wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

Implement spaceMatching config to detect space changes in HTML diffs #141

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1f02ccb
Initial plan
Copilot Dec 27, 2025
efb742d
Initial analysis complete
Copilot Dec 27, 2025
d8ed29f
Implement spaceMatching configuration to detect space changes
Copilot Dec 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .phpunit.result.cache
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"version":1,"defects":{"Caxy\\Tests\\HtmlDiff\\Functional\\HtmlDiffFunctionalTest::testHtmlDiff with data set \"nbsp-spaces-added.html\"":3},"times":{"Caxy\\Tests\\HtmlDiff\\Functional\\HtmlDiffFunctionalTest::testHtmlDiff with data set \"ICC-5136.html\"":0.013,"Caxy\\Tests\\HtmlDiff\\Functional\\HtmlDiffFunctionalTest::testHtmlDiff with data set \"first-and-last.html\"":0.009,"Caxy\\Tests\\HtmlDiff\\Functional\\HtmlDiffFunctionalTest::testHtmlDiff with data set \"issue-28-link-changes.html\"":0.005,"Caxy\\Tests\\HtmlDiff\\Functional\\HtmlDiffFunctionalTest::testHtmlDiff with data set \"keep-newlines-test.html\"":0.003,"Caxy\\Tests\\HtmlDiff\\Functional\\HtmlDiffFunctionalTest::testHtmlDiff with data set \"multibyte.html\"":0.001,"Caxy\\Tests\\HtmlDiff\\Functional\\HtmlDiffFunctionalTest::testHtmlDiff with data set \"multiline-tag.html\"":0,"Caxy\\Tests\\HtmlDiff\\Functional\\HtmlDiffFunctionalTest::testHtmlDiff with data set \"new-paragraph-and-list.html\"":0.071,"Caxy\\Tests\\HtmlDiff\\Functional\\HtmlDiffFunctionalTest::testHtmlDiff with data set \"override-2.html\"":0.008,"Caxy\\Tests\\HtmlDiff\\Functional\\HtmlDiffFunctionalTest::testHtmlDiff with data set \"override-3.html\"":0.026,"Caxy\\Tests\\HtmlDiff\\Functional\\HtmlDiffFunctionalTest::testHtmlDiff with data set \"override-4.html\"":0.026,"Caxy\\Tests\\HtmlDiff\\Functional\\HtmlDiffFunctionalTest::testHtmlDiff with data set \"override-5.html\"":0.059,"Caxy\\Tests\\HtmlDiff\\Functional\\HtmlDiffFunctionalTest::testHtmlDiff with data set \"override-6.html\"":0.031,"Caxy\\Tests\\HtmlDiff\\Functional\\HtmlDiffFunctionalTest::testHtmlDiff with data set \"override-8.html\"":0.016,"Caxy\\Tests\\HtmlDiff\\Functional\\HtmlDiffFunctionalTest::testHtmlDiff with data set \"override-9.html\"":0.005,"Caxy\\Tests\\HtmlDiff\\Functional\\HtmlDiffFunctionalTest::testHtmlDiff with data set \"simple-list.html\"":0.018,"Caxy\\Tests\\HtmlDiff\\Functional\\HtmlDiffFunctionalTest::testHtmlDiff with data set \"space-inside-isolated-tag.html\"":0.003,"Caxy\\Tests\\HtmlDiff\\Functional\\HtmlDiffFunctionalTest::testHtmlDiff with data set \"spaces-added.html\"":0.001,"Caxy\\Tests\\HtmlDiff\\Functional\\HtmlDiffFunctionalTest::testHtmlDiff with data set \"spaces-removed-inside-tag.html\"":0.003,"Caxy\\Tests\\HtmlDiff\\Functional\\HtmlDiffFunctionalTest::testHtmlDiff with data set \"table-whitespace-issue.html\"":0.011,"Caxy\\Tests\\HtmlDiff\\Functional\\HtmlDiffFunctionalTest::testHtmlDiff with data set \"nbsp-spaces-added.html\"":0.002,"Caxy\\Tests\\HtmlDiff\\Functional\\HtmlDiffFunctionalTest::testHtmlDiff with data set \"nbsp-spaces-default-behavior.html\"":0.001,"Caxy\\Tests\\HtmlDiff\\Functional\\HTMLPurifierConfigTest::testHtmlDiffConfigTraditional":0.026,"Caxy\\Tests\\HtmlDiff\\Functional\\HTMLPurifierConfigTest::testHtmlDiffConfigStatic":0.005}}
13 changes: 10 additions & 3 deletions lib/Caxy/HtmlDiff/AbstractDiff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -430,8 +430,10 @@ protected function convertHtmlToListOfWords(string $text) : array
$specialCharacters .= '\\' . $char;
}

// Normalize no-break-spaces to regular spaces
$text = str_replace("\xc2\xa0", ' ', $text);
// Normalize no-break-spaces to regular spaces (unless space matching is enabled)
if (!$this->config->isSpaceMatching()) {
$text = str_replace("\xc2\xa0", ' ', $text);
}

preg_match_all('/<.+?>|[^<]+/mus', $text, $sentencesAndTags, PREG_SPLIT_NO_EMPTY);

Expand Down Expand Up @@ -480,7 +482,12 @@ protected function normalizeWhitespaceInHtmlSentence(string $sentence) : string
return $sentence;
}

$sentence = preg_replace('/\s\s+|\r+|\n+|\r\n+/', ' ', $sentence);
// When space matching is enabled, preserve multiple spaces
if ($this->config->isSpaceMatching()) {
$sentence = preg_replace('/\r+|\n+|\r\n+/', ' ', $sentence);
} else {
$sentence = preg_replace('/\s\s+|\r+|\n+|\r\n+/', ' ', $sentence);
}


$sentenceLength = $this->stringUtil->strlen($sentence);
Expand Down
6 changes: 6 additions & 0 deletions tests/fixtures/HtmlDiff/nbsp-spaces-added.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<options>
<option type="boolean" name="setSpaceMatching" value="true" />
</options>
<oldtext><p>Just a simple text   </p></oldtext>
<newtext><p>Just a simple text         </p></newtext>
<expected><p>Just a simple text   <ins class="diffins">      </ins></p></expected>
5 changes: 5 additions & 0 deletions tests/fixtures/HtmlDiff/nbsp-spaces-default-behavior.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<options>
</options>
<oldtext><p>Just a simple text&nbsp; &nbsp;</p></oldtext>
<newtext><p>Just a simple text&nbsp; &nbsp; &nbsp; &nbsp; &nbsp;</p></newtext>
<expected><p>Just a simple text </p></expected>