diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 00000000..fdade2f6
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1,4 @@
+tests export-ignore
+.editorconfig export-ignore
+.gitattributes export-ignore
+phpcs.xml export-ignore
diff --git a/.gitignore b/.gitignore
index 9e1ec532..ddbe8d8f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -4,7 +4,11 @@
### Composer ###
composer.phar
+/codeCoverage
/vendor/
+/composer.lock
+/.phpunit.result.cache
+
# Commit your application's lock file https://getcomposer.org/doc/01-basic-usage.md#commit-your-composer-lock-file-to-version-control
# You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
@@ -72,4 +76,3 @@ local.properties
# End of https://www.gitignore.io/api/windows,eclipse,composer
-/composer.lock
diff --git a/LICENSE b/LICENSE
index 88d00098..78654c0d 100644
--- a/LICENSE
+++ b/LICENSE
@@ -12,7 +12,7 @@ modification, are permitted provided that the following conditions are met:
- Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
- - Neither the name of the Chris Boulton nor the names of its contributors
+ - Neither the name of the Mario Brandt nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
diff --git a/README.md b/README.md
index 67be32fa..349971fd 100644
--- a/README.md
+++ b/README.md
@@ -1,21 +1,25 @@
# PHP Diff Class
-[](https://insight.sensiolabs.com/projects/aa609edb-cdb1-45cf-ad51-afbdab48f6a1) [](https://www.codacy.com/app/leet31337/php-diff)
-
-[](https://github.com/JBlond/php-diff/releases) [](https://packagist.org/packages/jblond/php-diff)
+[](https://app.codacy.com/gh/JBlond/php-diff/dashboard)
+[](https://github.com/JBlond/php-diff/releases)
+[](https://packagist.org/packages/jblond/php-diff)
## Introduction
-A comprehensive library for generating differences between two hashable objects (strings or arrays).
-Generated differences can be rendered in all of the standard formats including:
+A comprehensive library for generating differences between two hashable
+objects (strings or arrays). Generated differences can be rendered in all the
+standard formats including:
+
* Unified
* Context
-* Inline HTML
* Side by Side HTML
* Unified HTML
+* Unified Commandline colored output
+* JSON
-The logic behind the core of the diff engine (ie, the sequence matcher) is primarily based on the Python difflib
-package. The reason for doing so is primarily because of its high degree of accuracy.
+The logic behind the core of the diff engine (ie, the sequence matcher) is
+primarily based on the Python difflib package. The reason for doing so is
+primarily because of its high degree of accuracy.
## Install
@@ -23,81 +27,131 @@ package. The reason for doing so is primarily because of its high degree of accu
composer require jblond/php-diff
```
+### Install for cli support
+
+For cli usage you need to install the suggested `jblond/php-cli` package.
+
+## Documentation
+
+See the [Wiki](https://github.com/JBlond/php-diff/wiki) for
+
+* [Getting started](https://github.com/JBlond/php-diff/wiki/1.-Getting-Started)
+* [Parameters and Options](https://github.com/JBlond/php-diff/wiki/2.-Parameters-and-Options)
+* [Custom Renderer](https://github.com/JBlond/php-diff/wiki/3.-Custom-Renderer)
+* [Styling](https://github.com/JBlond/php-diff/wiki/4.-Styling)
+
+## Changelog
+
+[Changelog](changelog.md)
+
## Example Use
```PHP
true,
'ignoreCase' => true,
'context' => 2,
+ 'cliColor' => true, // for cli output
+ 'ignoreLines' => Diff::DIFF_IGNORE_LINE_BLANK,
];
// Initialize the diff class.
-$diff = new Diff($a, $b /*, $options */);
+$diff = new Diff($sampleA, $sampleB /*, $options */);
// Choose Renderer.
$renderer = new SideBySide([
- 'title1' => 'Custom title for OLD version',
- 'title2' => 'Custom title for NEW version',
+ 'title1' => 'Custom title for sample A',
+ 'title2' => 'Custom title for sample B',
]);
-// Show it.
+// Show the output of the difference renderer.
echo $diff->Render($renderer);
+
+// Alternative
+// Show the differences or a message.
+echo $diff->isIdentical() ? 'No differences found.' : '' . htmlspecialchars($diff->render($renderer)) . ' ' ;
+
```
### Example Output
-A quick usage example can be found in the `example/` directory and under example.php.
+
+File `example.php` contains a quick demo and can be found in the `example/`
+directory. Included is a light and a dark theme.
#### HTML Side By Side Example
-
-#### HTML Inline Example
-
+
+
+
+More Example Pictures HTML Side By Side Dark Theme Example This line is removed from version2.
This line is also removed from version2.
This line is the same for both versions.
- This line has inline differences between both versions.
+ this line has inline differences between both versions.
This line is the same for both versions.
This line also has inline differences between both versions.
This line is the same for both versions.
diff --git a/example/cli.php b/example/cli.php
new file mode 100644
index 00000000..6c456acd
--- /dev/null
+++ b/example/cli.php
@@ -0,0 +1,75 @@
+';
+ echo 'Please execute it from a cli interpreter.';
+ throw new RuntimeException('Script for CLI use only!');
+}
+
+
+// Include and instantiate autoloader.
+require '../vendor/autoload.php';
+
+// Include two sample files for comparison.
+$sampleA = file_get_contents(__DIR__ . '/a.txt');
+$sampleB = file_get_contents(__DIR__ . '/b.txt');
+
+$customOptions = [
+ 'context' => 2,
+ 'trimEqual' => false,
+ 'ignoreWhitespace' => true,
+ 'ignoreCase' => true,
+];
+
+// Choose one of the initializations.
+$diff = new Diff($sampleA, $sampleB);
+//$diff = new Diff($a, $b, $customOptions); // Initialize the diff class with custom options.
+
+// Instantiate Cli wrapper
+$cli = new Cli();
+
+// Generate a unified diff.
+$renderer = new UnifiedCli();
+echo "-= Unified Default =-\n\n";
+$cli->output($diff->render($renderer));
+
+echo "\n\n-= Unified Colored =-\n\n";
+
+$renderer = new UnifiedCli(
+// Define renderer options.
+ [
+ 'cliColor' => true,
+ ]
+);
+
+$cli->output($diff->render($renderer));
+
+
+// Generate an inline diff.
+$renderer = new InlineCli(
+// Define renderer options.
+ [
+ 'deleteMarkers' => ['-', '-'],
+ 'insertMarkers' => ['+', '+'],
+ 'equalityMarkers' => ['=', 'x'],
+ ]
+);
+echo "-= Inline Marked =-\n\n";
+$cli->output($diff->render($renderer));
+
+echo "-= Inline Colored =-\n\n";
+
+$coloredRenderer = new InlineCli(
+// Define renderer options.
+ [
+ 'cliColor' => true,
+ ]
+);
+
+$cli->output($diff->render($coloredRenderer));
diff --git a/example/dark-theme.css b/example/dark-theme.css
index 1c0408bb..7fa98403 100644
--- a/example/dark-theme.css
+++ b/example/dark-theme.css
@@ -1,13 +1,13 @@
body {
background: #3A3B46;
- color: #F8F8F2;
+ color: #F8F8F2;
font-family: Arial, serif;
font-size: 12px;
}
pre {
- width: 100%;
overflow: auto;
+ width: 100%;
}
a, a:visited {
@@ -19,75 +19,77 @@ a, a:visited {
*/
.Differences {
- width: 100%;
border-collapse: collapse;
border-spacing: 0;
empty-cells: show;
+ width: 100%;
}
.Differences thead th {
- text-align: left;
- border-bottom: 1px solid #000000;
background: #AAAAAA;
+ border-bottom: 1px solid #000000;
color: #000000;
padding: 4px;
+ text-align: left;
}
.Differences tbody th {
- text-align: right;
background: #AAAAAA;
- color: #272822;
- width: 4em;
- padding: 1px 2px;
border-right: 1px solid #000000;
- vertical-align: top;
+ color: #272822;
font-size: 13px;
+ padding: 1px 2px;
+ text-align: right;
+ vertical-align: top;
+ width: 4em;
}
.Differences td {
- padding: 1px 2px;
font-family: Consolas, monospace;
font-size: 13px;
+ padding: 1px 2px;
}
.Differences .Skipped {
background: #F7F7F7;
+ color: #000000;
+ display: block;
+}
+
+.Differences ins,
+.Differences del {
+ text-decoration: none;
}
/*
* HTML Side by Side Diff
*/
.DifferencesSideBySide .ChangeInsert td.Left {
- background: green;
+ background: #DDFFDD;
}
.DifferencesSideBySide .ChangeInsert td.Right {
- background: green;
+ background: #008000;
}
.DifferencesSideBySide .ChangeDelete td.Left {
background: #FF8888;
- color: #272822;
+ color: #272822;
}
.DifferencesSideBySide .ChangeDelete td.Right {
background: #FFAAAA;
- color: #272822;
+ color: #272822;
}
.DifferencesSideBySide .ChangeReplace .Left {
- background: #FFEE99;
- color: #272822;
+ background: #FFDD88;
+ color: #272822;
}
.DifferencesSideBySide .ChangeReplace .Right {
background: #FFDD88;
- color: #272822;
-}
-
-.Differences ins,
-.Differences del {
- text-decoration: none;
+ color: #272822;
}
.DifferencesSideBySide .ChangeReplace ins,
@@ -95,92 +97,94 @@ a, a:visited {
background: #EEBB00;
}
+.DifferencesSideBySide .ChangeIgnore .Left,
+.DifferencesSideBySide .ChangeIgnore .Right {
+ background: #FBF2BF;
+}
+
+.DifferencesSideBySide .ChangeIgnore .Left.Ignore {
+ background: #4B4C57;
+}
+
+.DifferencesSideBySide .ChangeIgnore .Right.Ignore {
+ background: #4B4C57;
+}
+
/*
- * HTML Inline Diff
+ * HTML Unified Diff
*/
-.DifferencesInline .ChangeReplace {
+.DifferencesUnified .ChangeReplace {
color: #272822;
}
-.DifferencesInline .ChangeReplace .Left,
-.DifferencesInline .ChangeDelete .Left {
+.DifferencesUnified .ChangeReplace .Left,
+.DifferencesUnified .ChangeDelete .Left {
background: #FFDDDD;
- color: #272822;
+ color: #272822;
}
-.DifferencesInline .ChangeReplace .Right,
-.DifferencesInline .ChangeInsert .Right {
+.DifferencesUnified .ChangeReplace .Right,
+.DifferencesUnified .ChangeInsert .Right {
background: #DDFFDD;
+ color: #272822;
}
-.DifferencesInline .ChangeReplace ins {
- background: green;
-}
-
-.DifferencesInline .ChangeReplace del {
- background: #EE9999;
- color: #272822;
-}
-
-/*
- * HTML Unified Diff
- */
-
-/* Line removed in new */
-.DifferencesUnified .ChangeDelete .Left::before {
- content: "- \00a0";
+.DifferencesUnified .ChangeReplace ins {
+ background: #008000;
+ color: #272822;
}
-.DifferencesUnified .ChangeDelete .Left {
+.DifferencesUnified .ChangeReplace del {
background: #EE9999;
- color: #272822;
+ color: #272822;
}
-/* Line modified in old and new */
-.DifferencesUnified .ChangeReplace {
- background: #FFEE99;
- color: #272822;
- display: table;
+.DifferencesUnified .ChangeIgnore .Left,
+.DifferencesUnified .ChangeIgnore .Right {
+ background: #FBF2BF;
}
-/* Line in old replaced by line in new */
-.DifferencesUnified .ChangeReplace .Left:first-child:before {
- content: "\250C \00a0";
+.DifferencesUnified .ChangeIgnore .Left.Ignore {
+ background: #4B4C57;
}
-.DifferencesUnified .ChangeReplace .Left:before {
- content: "\251C \00a0";
+.DifferencesUnified .ChangeIgnore .Right.Ignore {
+ background: #4B4C57;
}
-.DifferencesUnified .ChangeReplace .Left {
- background: #FFEE99;
+/*
+ * HTML Merged Diff
+ */
+.DifferencesMerged td.ChangeReplace {
+ background: #FFDD88;
+ color: #272822;
}
-/* Line in new replaced line in old */
-.DifferencesUnified .ChangeReplace .Right:last-of-type:before {
- content: "\2514 \00a0";
+.DifferencesMerged .ChangeDelete {
+ background: #FFDDDD;
+ color: #272822;
}
-.DifferencesUnified .ChangeReplace .Right:before {
- content: "\251C \00a0";
+.DifferencesMerged .ChangeInsert {
+ background: #DDFFDD;
+ color: #272822;
}
-.DifferencesUnified .ChangeReplace .Right {
- background: #FFEE99;
+.DifferencesMerged .ChangeReplace ins {
+ background: #008000;
+ color: #272822;
}
-/* Line inserted in new */
-.DifferencesUnified .ChangeInsert .Right:before {
- content: "+ \00A0";
+.DifferencesMerged .ChangeReplace del {
+ background: #EE9999;
+ color: #272822;
}
-/* Character inserted in line of new */
-.DifferencesUnified .ChangeReplace ins {
- background: #99EE99;
+.DifferencesMerged th.ChangeDelete {
+ background-image: linear-gradient(-45deg, #AAAAAA 0%, #EE9999 100%);
}
-/* Character removed from line in old */
-.DifferencesUnified .ChangeReplace del {
- background: #EE9999;
+.DifferencesMerged th.ChangeReplace {
+ background-image: linear-gradient(-45deg, #CCCCCC 0%, #FFDD88 100%);
}
diff --git a/example/example.php b/example/example.php
index 681f6869..8b8b6cd8 100644
--- a/example/example.php
+++ b/example/example.php
@@ -1,105 +1,123 @@
2,
'trimEqual' => false,
'ignoreWhitespace' => true,
'ignoreCase' => true,
+ 'ignoreLines' => Diff::DIFF_IGNORE_LINE_EMPTY,
];
// Choose one of the initializations.
-$diff = new Diff($a, $b); // Initialize the diff class with default options.
-//$diff = new Diff($a, $b, $customOptions); // Initialize the diff class with custom options.
-?>
+$diff = new Diff($sampleA, $sampleB); // Initialize the diff class with default options.
+//$diff = new Diff($sampleA, $sampleB, $diffOptions); // Initialize the diff class with custom options.
+
+// Options for rendering the diff.
+$rendererOptions = [
+ 'inlineMarking' => $_GET['inlineMarking'] ?? Diff\Renderer\MainRenderer::CHANGE_LEVEL_LINE,
+]
+?>
+
-
- PHP LibDiff - Examples
- PHP LibDiff - Examples
+
+
+ Informational
+ Between the two versions, there's a
+ getStatistics();
+ echo round($diff->getSimilarity(), 2) * 100;
+ ?>% match.
+HTML Side by Side Diff
- var oldLink = document.getElementsByTagName("link").item(cssLinkIndex);
-
- var newLink = document.createElement("link");
- newLink.setAttribute("rel", "stylesheet");
- newLink.setAttribute("type", "text/css");
- newLink.setAttribute("href", cssFile);
-
- document.getElementsByTagName("head").item(0).replaceChild(newLink, oldLink);
- }
-
-
-
- PHP LibDiff - Examples
-
- HTML Side by Side Diff
-
- 'Custom title for version1',
- 'title2' => 'Custom title for version2',
- ]);
- echo $diff->Render($renderer);
- ?>
-
- HTML Inline Diff
-
- isIdentical() ? 'No differences found.' : $diff->Render($renderer);
+?>
- // Generate an inline diff.
- // \jblond\Diff\Renderer\Html
- $renderer = new Inline();
- echo $diff->render($renderer);
- ?>
+HTML Unified Diff
+isIdentical() ? 'No differences found.' : $diff->Render($renderer);
+?>
- HTML Unified Diff
- {$diff->render($renderer)}";
- ?>
+HTML Merged Diff
+isIdentical() ? 'No differences found.' : $diff->Render($renderer);
+?>
- Text Unified Diff
- ' . htmlspecialchars($diff->render($renderer)) . '';
- ?>
+Text Unified Diff
+isIdentical() ?
+ 'No differences found.' : '' . htmlspecialchars($diff->render($renderer)) . ' ';
+?>
- Text Context Diff
- ' . htmlspecialchars($diff->render($renderer)) . '';
- ?>
-
+Text Context Diff
+isIdentical() ?
+ 'No differences found.' : '' . htmlspecialchars($diff->render($renderer)) . ' ';
+?>
+