Merge pull request #11 from snebes/docs

readme update and namespace change
snebes · Jan 30, 2019 · dd46161 · dd46161
2 parents 0d07bf0 + 8003f47
commit dd46161
Show file tree

Hide file tree

Showing 86 changed files with 235 additions and 203 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,42 @@
-## PHP DaisyDiff
+# php-daisydiff
 
 [![PHP Version](https://img.shields.io/packagist/php-v/snebes/php-daisydiff.svg?maxAge=3600)](https://packagist.org/packages/snebes/php-daisydiff)
 [![Latest Version](https://img.shields.io/packagist/v/snebes/php-daisydiff.svg?maxAge=3600)](https://packagist.org/packages/snebes/php-daisydiff)
 [![Build Status](https://img.shields.io/scrutinizer/build/g/snebes/php-daisydiff.svg?maxAge=3600)](https://scrutinizer-ci.com/g/snebes/php-daisydiff)
 [![Code Quality](https://img.shields.io/scrutinizer/g/snebes/php-daisydiff.svg?maxAge=3600)](https://scrutinizer-ci.com/g/snebes/php-daisydiff)
 [![Test Coverage](https://img.shields.io/scrutinizer/coverage/g/snebes/php-daisydiff.svg?maxAge=3600)](https://scrutinizer-ci.com/g/snebes/php-daisydiff)
 
-PHP HTML Diff Engine - DaisyDiff Port
+Daisy Diff is a PHP implementation of the [Java library](https://github.com/DaisyDiff/DaisyDiff) that diffs (compares) HTML files. It highlights added and removed words and annotates changes to the styling.
+
+## Installation
+
+You can add this library as a local, per-project dependency to your project using [Composer](https://getcomposer.org/):
+
+```
+composer require snebes/php-daisydiff
+```
+
+### Usage
+
+The `DaisyDiff` class can be used to generate a textual representation of the difference between two HTML strings:
+
+```php
+<?php
+
+use SN\DaisyDiff\DaisyDiff;
+
+$daisyDiff = new DaisyDiff();
+\printf("%s\n", $daisyDiff->diff('<html><body>The original document</body></html>', '<html><body>The changed document</body></html>'));
+```
+
+The code above yields the output below:
+
+```html
+<html>The <del class="diff-html-removed">original </del><ins class="diff-html-added">changed </ins>document</html>
+```
+## Thanks
+
+Many thanks to:
+
+- [Java DaisyDiff](https://github.com/DaisyDiff/DaisyDiff), the original Java version of the DaisyDiff library.
+- [gdevanla/assist](https://github.com/gdevanla/assist) from which many of the tests of this library are extracted.
diff --git a/composer.json b/composer.json
@@ -10,20 +10,19 @@
     ],
     "autoload": {
         "psr-4": {
-            "DaisyDiff\\": "src/"
+            "SN\\DaisyDiff\\": "src/"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "DaisyDiff\\": "tests/"
+            "SN\\DaisyDiff\\": "tests/"
         }
     },
     "license": "MIT",
     "require": {
         "php": ">=7.1.0",
         "ext-mbstring": "*",
-        "ext-xml": "*",
-        "psr/log": "^1.0"
+        "ext-xml": "*"
     },
     "require-dev": {
         "phpunit/phpunit": "^7.5",

diff --git a/src/DaisyDiff.php b/src/DaisyDiff.php
@@ -8,14 +8,14 @@
 
 declare(strict_types=1);
 
-namespace DaisyDiff;
-
-use DaisyDiff\Html\ChangeText;
-use DaisyDiff\Html\Dom\DomTreeBuilder;
-use DaisyDiff\Html\HtmlDiffer;
-use DaisyDiff\Html\HtmlSaxDiffOutput;
-use DaisyDiff\Html\TextNodeComparator;
-use DaisyDiff\Xml\XMLReader;
+namespace SN\DaisyDiff;
+
+use SN\DaisyDiff\Html\ChangeText;
+use SN\DaisyDiff\Html\Dom\DomTreeBuilder;
+use SN\DaisyDiff\Html\HtmlDiffer;
+use SN\DaisyDiff\Html\HtmlSaxDiffOutput;
+use SN\DaisyDiff\Html\TextNodeComparator;
+use SN\DaisyDiff\Xml\XMLReader;
 
 /**
  * Daisy Diff is a library that diffs (compares) HTML.

diff --git a/src/Html/Ancestor/AncestorComparator.php b/src/Html/Ancestor/AncestorComparator.php
@@ -8,12 +8,12 @@
 
 declare(strict_types=1);
 
-namespace DaisyDiff\Html\Ancestor;
+namespace SN\DaisyDiff\Html\Ancestor;
 
-use DaisyDiff\Html\Dom\TagNode;
-use DaisyDiff\RangeDifferencer\RangeComparatorInterface;
-use DaisyDiff\RangeDifferencer\RangeDifference;
-use DaisyDiff\RangeDifferencer\RangeDifferencer;
+use SN\DaisyDiff\Html\Dom\TagNode;
+use SN\DaisyDiff\RangeDifferencer\RangeComparatorInterface;
+use SN\DaisyDiff\RangeDifferencer\RangeDifference;
+use SN\DaisyDiff\RangeDifferencer\RangeDifferencer;
 
 /**
  * A comparator used when calculating the difference in ancestry of two Nodes.

diff --git a/src/Html/Ancestor/AncestorComparatorResult.php b/src/Html/Ancestor/AncestorComparatorResult.php
@@ -8,9 +8,9 @@
 
 declare(strict_types=1);
 
-namespace DaisyDiff\Html\Ancestor;
+namespace SN\DaisyDiff\Html\Ancestor;
 
-use DaisyDiff\Html\Modification\HtmlLayoutChange;
+use SN\DaisyDiff\Html\Modification\HtmlLayoutChange;
 
 /**
  * AncestorComparatorResult model.

diff --git a/src/Html/Ancestor/ChangeTextGenerator.php b/src/Html/Ancestor/ChangeTextGenerator.php
@@ -8,13 +8,13 @@
 
 declare(strict_types=1);
 
-namespace DaisyDiff\Html\Ancestor;
+namespace SN\DaisyDiff\Html\Ancestor;
 
-use DaisyDiff\Html\Ancestor\TagToString\TagToStringFactory;
-use DaisyDiff\Html\ChangeText;
-use DaisyDiff\Html\Dom\TagNode;
-use DaisyDiff\Html\Modification\HtmlLayoutChange;
-use DaisyDiff\RangeDifferencer\RangeDifference;
+use SN\DaisyDiff\Html\Ancestor\TagToString\TagToStringFactory;
+use SN\DaisyDiff\Html\ChangeText;
+use SN\DaisyDiff\Html\Dom\TagNode;
+use SN\DaisyDiff\Html\Modification\HtmlLayoutChange;
+use SN\DaisyDiff\RangeDifferencer\RangeDifference;
 
 /**
  * ChangeTextGenerator

diff --git a/src/Html/Ancestor/TagChangeSemantic.php b/src/Html/Ancestor/TagChangeSemantic.php
@@ -8,7 +8,7 @@
 
 declare(strict_types=1);
 
-namespace DaisyDiff\Html\Ancestor;
+namespace SN\DaisyDiff\Html\Ancestor;
 
 /**
  * Semantic types.

diff --git a/src/Html/Ancestor/TagToString/AnchorToString.php b/src/Html/Ancestor/TagToString/AnchorToString.php
@@ -8,9 +8,9 @@
 
 declare(strict_types=1);
 
-namespace DaisyDiff\Html\Ancestor\TagToString;
+namespace SN\DaisyDiff\Html\Ancestor\TagToString;
 
-use DaisyDiff\Html\ChangeText;
+use SN\DaisyDiff\Html\ChangeText;
 
 /**
  * Anchor <a> tag to string.

diff --git a/src/Html/Ancestor/TagToString/NoContentTagToString.php b/src/Html/Ancestor/TagToString/NoContentTagToString.php
@@ -8,9 +8,9 @@
 
 declare(strict_types=1);
 
-namespace DaisyDiff\Html\Ancestor\TagToString;
+namespace SN\DaisyDiff\Html\Ancestor\TagToString;
 
-use DaisyDiff\Html\ChangeText;
+use SN\DaisyDiff\Html\ChangeText;
 
 /**
  * Image <img> tag to string.

diff --git a/src/Html/Ancestor/TagToString/TagToString.php b/src/Html/Ancestor/TagToString/TagToString.php
@@ -8,12 +8,12 @@
 
 declare(strict_types=1);
 
-namespace DaisyDiff\Html\Ancestor\TagToString;
+namespace SN\DaisyDiff\Html\Ancestor\TagToString;
 
-use DaisyDiff\Html\Ancestor\TagChangeSemantic;
-use DaisyDiff\Html\ChangeText;
-use DaisyDiff\Html\Dom\TagNode;
-use DaisyDiff\Html\Modification\HtmlLayoutChange;
+use SN\DaisyDiff\Html\Ancestor\TagChangeSemantic;
+use SN\DaisyDiff\Html\ChangeText;
+use SN\DaisyDiff\Html\Dom\TagNode;
+use SN\DaisyDiff\Html\Modification\HtmlLayoutChange;
 
 /**
  * TagToString

diff --git a/src/Html/Ancestor/TagToString/TagToStringFactory.php b/src/Html/Ancestor/TagToString/TagToStringFactory.php
@@ -8,10 +8,10 @@
 
 declare(strict_types=1);
 
-namespace DaisyDiff\Html\Ancestor\TagToString;
+namespace SN\DaisyDiff\Html\Ancestor\TagToString;
 
-use DaisyDiff\Html\Ancestor\TagChangeSemantic;
-use DaisyDiff\Html\Dom\TagNode;
+use SN\DaisyDiff\Html\Ancestor\TagChangeSemantic;
+use SN\DaisyDiff\Html\Dom\TagNode;
 
 /**
  * TagToString Factory

diff --git a/src/Html/Ancestor/TextOnlyComparator.php b/src/Html/Ancestor/TextOnlyComparator.php
@@ -8,13 +8,13 @@
 
 declare(strict_types=1);
 
-namespace DaisyDiff\Html\Ancestor;
+namespace SN\DaisyDiff\Html\Ancestor;
 
-use DaisyDiff\Html\Dom\TagNode;
-use DaisyDiff\Html\Dom\TextNode;
-use DaisyDiff\RangeDifferencer\Core\LCSSettings;
-use DaisyDiff\RangeDifferencer\RangeComparatorInterface;
-use DaisyDiff\RangeDifferencer\RangeDifferencer;
+use SN\DaisyDiff\Html\Dom\TagNode;
+use SN\DaisyDiff\Html\Dom\TextNode;
+use SN\DaisyDiff\RangeDifferencer\Core\LCSSettings;
+use SN\DaisyDiff\RangeDifferencer\RangeComparatorInterface;
+use SN\DaisyDiff\RangeDifferencer\RangeDifferencer;
 
 /**
  * A comparator that compares only the elements of text inside a given tag.

diff --git a/src/Html/ChangeText.php b/src/Html/ChangeText.php
@@ -8,9 +8,9 @@
 
 declare(strict_types=1);
 
-namespace DaisyDiff\Html;
+namespace SN\DaisyDiff\Html;
 
-use DaisyDiff\Xml\ContentHandlerInterface;
+use SN\DaisyDiff\Xml\ContentHandlerInterface;
 
 /**
  * ChangeText model.

diff --git a/src/Html/Dom/BodyNode.php b/src/Html/Dom/BodyNode.php
@@ -8,7 +8,7 @@
 
 declare(strict_types=1);
 
-namespace DaisyDiff\Html\Dom;
+namespace SN\DaisyDiff\Html\Dom;
 
 /**
  * Represents the root of a HTML document.

diff --git a/src/Html/Dom/DomTreeBuilder.php b/src/Html/Dom/DomTreeBuilder.php
@@ -8,7 +8,7 @@
 
 declare(strict_types=1);
 
-namespace DaisyDiff\Html\Dom;
+namespace SN\DaisyDiff\Html\Dom;
 
 /**
  * Creates a DOM tree from SAX-like events.

diff --git a/src/Html/Dom/Helper/LastCommonParentResult.php b/src/Html/Dom/Helper/LastCommonParentResult.php
@@ -8,9 +8,9 @@
 
 declare(strict_types=1);
 
-namespace DaisyDiff\Html\Dom\Helper;
+namespace SN\DaisyDiff\Html\Dom\Helper;
 
-use DaisyDiff\Html\Dom\TagNode;
+use SN\DaisyDiff\Html\Dom\TagNode;
 
 /**
  * When detecting the last common parent of two nodes, all results are stored as a LastCommonParentResult.

diff --git a/src/Html/Dom/ImageNode.php b/src/Html/Dom/ImageNode.php
@@ -8,7 +8,7 @@
 
 declare(strict_types=1);
 
-namespace DaisyDiff\Html\Dom;
+namespace SN\DaisyDiff\Html\Dom;
 
 /**
  * Represents an image in HTML. Even though images do not contain any text they are single visible objects on the page.

diff --git a/src/Html/Dom/Node.php b/src/Html/Dom/Node.php
@@ -8,9 +8,9 @@
 
 declare(strict_types=1);
 
-namespace DaisyDiff\Html\Dom;
+namespace SN\DaisyDiff\Html\Dom;
 
-use DaisyDiff\Html\Dom\Helper\LastCommonParentResult;
+use SN\DaisyDiff\Html\Dom\Helper\LastCommonParentResult;
 
 /**
  * Represents any element in the DOM tree of a HTML file.

diff --git a/src/Html/Dom/SeparatingNode.php b/src/Html/Dom/SeparatingNode.php
@@ -8,7 +8,7 @@
 
 declare(strict_types=1);
 
-namespace DaisyDiff\Html\Dom;
+namespace SN\DaisyDiff\Html\Dom;
 
 /**
  * This is an artificial text node whose sole purpose is to separate text nodes, so that they cannot be treated as a

diff --git a/src/Html/Dom/TagNode.php b/src/Html/Dom/TagNode.php
@@ -8,10 +8,10 @@
 
 declare(strict_types=1);
 
-namespace DaisyDiff\Html\Dom;
+namespace SN\DaisyDiff\Html\Dom;
 
 use ArrayIterator;
-use DaisyDiff\Html\Ancestor\TextOnlyComparator;
+use SN\DaisyDiff\Html\Ancestor\TextOnlyComparator;
 use IteratorAggregate;
 
 /**

diff --git a/src/Html/Dom/TextNode.php b/src/Html/Dom/TextNode.php
@@ -8,10 +8,10 @@
 
 declare(strict_types=1);
 
-namespace DaisyDiff\Html\Dom;
+namespace SN\DaisyDiff\Html\Dom;
 
-use DaisyDiff\Html\Modification\Modification;
-use DaisyDiff\Html\Modification\ModificationType;
+use SN\DaisyDiff\Html\Modification\Modification;
+use SN\DaisyDiff\Html\Modification\ModificationType;
 
 /**
  * Represents a piece of text in the HTML file.

diff --git a/src/Html/Dom/WhiteSpaceNode.php b/src/Html/Dom/WhiteSpaceNode.php
@@ -8,7 +8,7 @@
 
 declare(strict_types=1);
 
-namespace DaisyDiff\Html\Dom;
+namespace SN\DaisyDiff\Html\Dom;
 
 /**
  * Represents whitespace in the HTML file.

diff --git a/src/Html/HtmlDiffer.php b/src/Html/HtmlDiffer.php
@@ -8,13 +8,13 @@
 
 declare(strict_types=1);
 
-namespace DaisyDiff\Html;
+namespace SN\DaisyDiff\Html;
 
-use DaisyDiff\Html\Modification\ModificationType;
-use DaisyDiff\Output\DiffOutputInterface;
-use DaisyDiff\RangeDifferencer\Core\LCSSettings;
-use DaisyDiff\RangeDifferencer\RangeDifference;
-use DaisyDiff\RangeDifferencer\RangeDifferencer;
+use SN\DaisyDiff\Html\Modification\ModificationType;
+use SN\DaisyDiff\Output\DiffOutputInterface;
+use SN\DaisyDiff\RangeDifferencer\Core\LCSSettings;
+use SN\DaisyDiff\RangeDifferencer\RangeDifference;
+use SN\DaisyDiff\RangeDifferencer\RangeDifferencer;
 
 /**
  * Takes TextNodeComparator instances, computes the difference between them, marks the changes, and outputs a merged

diff --git a/src/Html/HtmlSaxDiffOutput.php b/src/Html/HtmlSaxDiffOutput.php
@@ -8,15 +8,15 @@
 
 declare(strict_types=1);
 
-namespace DaisyDiff\Html;
-
-use DaisyDiff\Html\Dom\ImageNode;
-use DaisyDiff\Html\Dom\TagNode;
-use DaisyDiff\Html\Dom\TextNode;
-use DaisyDiff\Html\Modification\Modification;
-use DaisyDiff\Html\Modification\ModificationType;
-use DaisyDiff\Output\DiffOutputInterface;
-use DaisyDiff\Xml\ContentHandlerInterface;
+namespace SN\DaisyDiff\Html;
+
+use SN\DaisyDiff\Html\Dom\ImageNode;
+use SN\DaisyDiff\Html\Dom\TagNode;
+use SN\DaisyDiff\Html\Dom\TextNode;
+use SN\DaisyDiff\Html\Modification\Modification;
+use SN\DaisyDiff\Html\Modification\ModificationType;
+use SN\DaisyDiff\Output\DiffOutputInterface;
+use SN\DaisyDiff\Xml\ContentHandlerInterface;
 
 /**
  * Takes a branch root and creates an HTML file for it.

diff --git a/src/Html/Modification/HtmlLayoutChange.php b/src/Html/Modification/HtmlLayoutChange.php
@@ -8,7 +8,7 @@
 
 declare(strict_types=1);
 
-namespace DaisyDiff\Html\Modification;
+namespace SN\DaisyDiff\Html\Modification;
 
 /**
  * This class holds the removal or addition of HTML tags around text. It contains the same information that is presented

diff --git a/src/Html/Modification/Modification.php b/src/Html/Modification/Modification.php
@@ -8,7 +8,7 @@
 
 declare(strict_types=1);
 
-namespace DaisyDiff\Html\Modification;
+namespace SN\DaisyDiff\Html\Modification;
 
 /**
  * Modification model.