Merge pull request #15 from JBlond/development

v1.12
JBlond · Mar 18, 2019 · e2863c0 · e2863c0
2 parents d0431f1 + 2f11a9d
commit e2863c0
Show file tree

Hide file tree

Showing 12 changed files with 111 additions and 73 deletions.
diff --git a/README.md b/README.md
@@ -27,6 +27,36 @@ composer require jblond/php-diff
 
 ## Example Use
 
+```PHP
+<?php
+// installed via composer
+require 'vendor/autoload.php';
+
+// or installed manual
+require dirname(__FILE__).'/../lib/Autoloader.php';
+new \jblond\Autoloader(); 
+
+$a = explode("\n", file_get_contents(dirname(__FILE__).'/a.txt'));
+$b = explode("\n", file_get_contents(dirname(__FILE__).'/b.txt'));
+// Options for generating the diff
+$options = array(
+    //'ignoreWhitespace' => true,
+    //'ignoreCase' => true,
+);
+// Initialize the diff class
+$diff = new \jblond\Diff($a, $b, $options);
+
+//choose renderer
+$renderer = new \jblond\Diff\Renderer\Html\SideBySide(array(
+    'title_a' => 'Custom title for OLD version',
+    'title_b' => 'Custom title for NEW version',
+));
+
+//show it
+echo $diff->Render($renderer);
+```
+
+### Example Output
 A quick usage example can be found in the example/ directory and under
 example.php.
 
@@ -60,3 +90,11 @@ Contributors since I forked the repo.
 ### License (BSD License)
 
 see [License](LICENSE)
+
+## tests
+
+```BASH
+composer run-script phpunit
+composer run-script php_src
+composer run-script php_test
+```
diff --git a/composer.json b/composer.json
@@ -22,11 +22,17 @@
         "ext-mbstring": "*"
     },
     "require-dev": {
-        "phpunit/phpunit": "7.*"
+        "phpunit/phpunit": "7.*",
+        "squizlabs/php_codesniffer": "*"
     },
     "autoload": {
         "psr-4": {
            "jblond\\": "lib/jblond"
         }
+    },
+    "scripts": {
+        "phpunit": "phpunit ./tests/",
+        "php_src": "phpcs --standard=phpcs.xml -s -p --colors ./lib/",
+        "php_test": "phpcs --standard=phpcs.xml -s -p --colors ./tests/"
     }
 }
diff --git a/example/example.php b/example/example.php
@@ -1,67 +1,67 @@
-<!DOCTYPE html>
+<!DOCTYPE html>
 <html lang="en">
-	<head>
-		<meta charset="utf-8"/>
-		<title>PHP LibDiff - Examples</title>
-		<link rel="stylesheet" href="styles.css" type="text/css" charset="utf-8"/>
-	</head>
-	<body>
-		<h1>PHP LibDiff - Examples</h1>
-		<hr />
-		<?php
-		// include autoloader
-		require dirname(__FILE__).'/../lib/Autoloader.php';
-		new \jblond\Autoloader();
+    <head>
+        <meta charset="utf-8"/>
+        <title>PHP LibDiff - Examples</title>
+        <link rel="stylesheet" href="styles.css" type="text/css" charset="utf-8"/>
+    </head>
+    <body>
+        <h1>PHP LibDiff - Examples</h1>
+        <hr />
+        <?php
+        // include autoloader
+        require dirname(__FILE__).'/../lib/Autoloader.php';
+        new \jblond\Autoloader();
 
-		// Include two sample files for comparison
-		$a = explode("\n", file_get_contents(dirname(__FILE__).'/a.txt'));
-		$b = explode("\n", file_get_contents(dirname(__FILE__).'/b.txt'));
+        // Include two sample files for comparison
+        $a = explode("\n", file_get_contents(dirname(__FILE__).'/a.txt'));
+        $b = explode("\n", file_get_contents(dirname(__FILE__).'/b.txt'));
 
-		// Options for generating the diff
-		$options = array(
-			//'ignoreWhitespace' => true,
-			//'ignoreCase' => true,
-		);
+        // Options for generating the diff
+        $options = array(
+            //'ignoreWhitespace' => true,
+            //'ignoreCase' => true,
+        );
 
-		// Initialize the diff class
-		$diff = new \jblond\Diff($a, $b, $options);
+        // Initialize the diff class
+        $diff = new \jblond\Diff($a, $b, $options);
 
-		?>
-		<h2>Side by Side Diff</h2>
-		<?php
+        ?>
+        <h2>Side by Side Diff</h2>
+        <?php
 
-		// Generate a side by side diff
+        // Generate a side by side diff
         $renderer = new \jblond\Diff\Renderer\Html\SideBySide(array(
             'title_a' => 'Custom title for OLD version',
             'title_b' => 'Custom title for NEW version',
         ));
-		echo $diff->Render($renderer);
+        echo $diff->Render($renderer);
 
-		?>
-		<h2>Inline Diff</h2>
-		<?php
+        ?>
+        <h2>Inline Diff</h2>
+        <?php
 
-		// Generate an inline diff
-		$renderer = new \jblond\Diff\Renderer\Html\Inline;
-		echo $diff->render($renderer);
+        // Generate an inline diff
+        $renderer = new \jblond\Diff\Renderer\Html\Inline;
+        echo $diff->render($renderer);
 
-		?>
-		<h2>Unified Diff</h2>
-		<pre><?php
+        ?>
+        <h2>Unified Diff</h2>
+        <pre><?php
 
-		// Generate a unified diff
-		$renderer = new \jblond\Diff\Renderer\Text\Unified();
-		echo htmlspecialchars($diff->render($renderer));
+        // Generate a unified diff
+        $renderer = new \jblond\Diff\Renderer\Text\Unified();
+        echo htmlspecialchars($diff->render($renderer));
 
-		?>
-		</pre>
-		<h2>Context Diff</h2>
-		<pre><?php
+        ?>
+        </pre>
+        <h2>Context Diff</h2>
+        <pre><?php
 
-		// Generate a context diff
-		$renderer = new \jblond\Diff\Renderer\Text\Context;
-		echo htmlspecialchars($diff->render($renderer));
-		?>
-		</pre>
-	</body>
+        // Generate a context diff
+        $renderer = new \jblond\Diff\Renderer\Text\Context;
+        echo htmlspecialchars($diff->render($renderer));
+        ?>
+        </pre>
+    </body>
 </html>
diff --git a/lib/Autoloader.php b/lib/Autoloader.php
@@ -13,19 +13,13 @@ class Autoloader
      */
     public function __construct()
     {
-        spl_autoload_register(array($this, '__autoload'));
-    }
-
-    /**
-     * @param string $class
-     */
-    private function __autoload($class)
-    {
-        $class = str_replace('\\', '/', $class); // revert path for old PHP on Linux
-        $dir = str_replace('\\', '/', __DIR__);
-        if (file_exists($dir . '/' . $class . '.php')) {
-             /** @noinspection PhpIncludeInspection */
-            require_once $dir . '/' . $class . '.php';
-        }
+        spl_autoload_register(function ($class) {
+            $class = str_replace('\\', '/', $class); // revert path for old PHP on Linux
+            $dir = str_replace('\\', '/', __DIR__);
+            if (file_exists($dir . '/' . $class . '.php')) {
+                /** @noinspection PhpIncludeInspection */
+                require_once $dir . '/' . $class . '.php';
+            }
+        });
     }
 }
diff --git a/lib/jblond/Diff.php b/lib/jblond/Diff.php
@@ -16,7 +16,7 @@
  * @author Chris Boulton <chris.boulton@interspire.com>
  * @copyright (c) 2009 Chris Boulton
  * @license New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version 1.11
+ * @version 1.12
  * @link https://github.com/JBlond/php-diff
  */
 class Diff

diff --git a/lib/jblond/Diff/Renderer/Html/HtmlArray.php b/lib/jblond/Diff/Renderer/Html/HtmlArray.php
@@ -13,7 +13,7 @@
  * @author Chris Boulton <chris.boulton@interspire.com>
  * @copyright (c) 2009 Chris Boulton
  * @license New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version 1.11
+ * @version 1.12
  * @link https://github.com/JBlond/php-diff
  */
 class HtmlArray extends RendererAbstract

diff --git a/lib/jblond/Diff/Renderer/Html/Inline.php b/lib/jblond/Diff/Renderer/Html/Inline.php
@@ -11,7 +11,7 @@
  * @author Chris Boulton <chris.boulton@interspire.com>
  * @copyright (c) 2009 Chris Boulton
  * @license New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version 1.11
+ * @version 1.12
  * @link https://github.com/JBlond/php-diff
  */
 class Inline extends HtmlArray

diff --git a/lib/jblond/Diff/Renderer/Html/SideBySide.php b/lib/jblond/Diff/Renderer/Html/SideBySide.php
@@ -11,7 +11,7 @@
  * @author Chris Boulton <chris.boulton@interspire.com>
  * @copyright (c) 2009 Chris Boulton
  * @license New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version 1.11
+ * @version 1.12
  * @link https://github.com/JBlond/php-diff
  */
 class SideBySide extends HtmlArray

diff --git a/lib/jblond/Diff/Renderer/RendererAbstract.php b/lib/jblond/Diff/Renderer/RendererAbstract.php
@@ -13,7 +13,7 @@
  * @author Chris Boulton <chris.boulton@interspire.com>
  * @copyright (c) 2009 Chris Boulton
  * @license New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version 1.11
+ * @version 1.12
  * @link https://github.com/JBlond/php-diff
  */
 abstract class RendererAbstract

diff --git a/lib/jblond/Diff/Renderer/Text/Context.php b/lib/jblond/Diff/Renderer/Text/Context.php
@@ -13,7 +13,7 @@
  * @author Chris Boulton <chris.boulton@interspire.com>
  * @copyright (c) 2009 Chris Boulton
  * @license New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version 1.11
+ * @version 1.12
  * @link https://github.com/JBlond/php-diff
  */
 class Context extends RendererAbstract

diff --git a/lib/jblond/Diff/Renderer/Text/Unified.php b/lib/jblond/Diff/Renderer/Text/Unified.php
@@ -13,7 +13,7 @@
  * @author Chris Boulton <chris.boulton@interspire.com>
  * @copyright (c) 2009 Chris Boulton
  * @license New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version 1.11
+ * @version 1.12
  * @link https://github.com/JBlond/php-diff
  */
 

diff --git a/lib/jblond/Diff/SequenceMatcher.php b/lib/jblond/Diff/SequenceMatcher.php
@@ -11,7 +11,7 @@
  * @author Chris Boulton <chris.boulton@interspire.com>
  * @copyright (c) 2009 Chris Boulton
  * @license New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version 1.11
+ * @version 1.12
  * @link https://github.com/JBlond/php-diff
  */
 class SequenceMatcher