Merge branch 'master' of github.com:/JBlond/php-diff

Author: JBlond

README.md

@@ -1,12 +1,11 @@
-PHP Diff Class
---------------
+# PHP Diff Class
 
 [![SensioLabsInsight](https://insight.sensiolabs.com/projects/aa609edb-cdb1-45cf-ad51-afbdab48f6a1/mini.png)](https://insight.sensiolabs.com/projects/aa609edb-cdb1-45cf-ad51-afbdab48f6a1) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/db5f8d57b1234502aeb852afc87e0dfe)](https://www.codacy.com/app/leet31337/php-diff)
 
 [![Latest Version](https://img.shields.io/github/release/JBlond/php-diff.svg?style=flat-square&label=Release)](https://github.com/JBlond/php-diff/releases)
 
-Introduction
-------------
+## 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:
@@ -19,69 +18,46 @@ 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.
 
-Example Use
------------
+
+## Install
+
+```
+composer require jblond/php-diff
+```
+
+## Example Use
+
 A quick usage example can be found in the example/ directory and under
 example.php.
 
-![Example Image](https://github.com/jblond/php-diff/raw/master/readme.png "Example")
+![Example Image](readme.png "Example")
 
-![Example 2 Image](https://github.com/jblond/php-diff/raw/master/readme2.png "Example2")
+![Example 2 Image](readme2.png "Example2")
+
+## Requirements
 
-Requirements
------------
 - PHP 7.1 or greater
 - PHP Multibyte String 
 
-Merge files using jQuery
-------------------------
+## Merge files using jQuery
+
 Xiphe has build a jQuery plugin with that you can merge the compared
 files. Have a look at [jQuery-Merge-for-php-diff](https://github.com/Xiphe/jQuery-Merge-for-php-diff).
 
-Todo
-----
+## Todo
+
  * Ability to ignore blank line changes
  * 3 way diff support
  * Performance optimizations
 
- Contributors
----------------------
+##  Contributors
+
 Contributors since I forked the repo.
 
 - maxxer
 - Creris
 - jfcherng
 
-License (BSD License)
----------------------
-Copyright (c) 2009 Chris Boulton <chris.boulton@interspire.com>
-
-Copyright (c) 2015 Mario Brandt <leet31337@web.de>
-
-All rights reserved.
+### License (BSD License)
 
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
- - Redistributions of source code must retain the above copyright notice,
-   this list of conditions and the following disclaimer.
- - 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
-   may be used to endorse or promote products derived from this software
-   without specific prior written permission.
-
-```
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
-LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-POSSIBILITY OF SUCH DAMAGE.
-```
+see [License](LICENSE)

example/a.txt

@@ -14,5 +14,6 @@
 		<pre>
 		另外我覺得那個評價的白色櫃子有點沒有必要欸。外觀我就不說了 ，怎麼連空間都那麼狹隘。不過倒是從這個地方看出所謂的“改革” 😅😅
 		</pre>
+		<p>Do you know in Chinese, "金槍魚罐頭" means tuna can.</p>
 	</body>
 </html>

example/b.txt

@@ -14,6 +14,7 @@
 		<pre>
 		另外我覺得那個評鑑的白色櫃子有點沒有必要欸。外觀我就不說了 ，怎麼連空間都那麼狹隘。不過倒是從這個地方看出所謂的“改革” 😅😅
 		</pre>
+		<p>Do you know in Japanese, "魚の缶詰" means fish can.</p>
 		<p>Just a small amount of new text...</p>
 	</body>
-</html>
+</html>

lib/jblond/Diff.php

@@ -10,7 +10,7 @@
  * A comprehensive library for generating differences between two strings
  * in multiple formats (unified, side by side HTML etc)
  *
- * PHP version 5
+ * PHP version 7.1 or greater
  *
  * Copyright (c) 2009 Chris Boulton <chris.boulton@interspire.com>
  *
@@ -40,24 +40,24 @@
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  *
- * @package Diff
+ * @package jblond
  * @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.6
+ * @version 1.10
  * @link https://github.com/JBlond/php-diff
  */
 class Diff
 {
     /**
      * @var array The "old" sequence to use as the basis for the comparison.
      */
-    private $a = null;
+    private $old = null;
 
     /**
      * @var array The "new" sequence to generate the changes for.
      */
-    private $b = null;
+    private $new = null;
 
     /**
      * @var array Array containing the generated op codes for the differences between the two items.
@@ -83,14 +83,14 @@ class Diff
     /**
      * The constructor.
      *
-     * @param array $a Array containing the lines of the first string to compare.
-     * @param array $b Array containing the lines for the second string to compare.
+     * @param array $oldArray Array containing the lines of the first string to compare.
+     * @param array $newArray Array containing the lines for the second string to compare.
      * @param array $options Array for the options
      */
-    public function __construct($a, $b, $options = array())
+    public function __construct(array $oldArray, array $newArray, array $options = array())
     {
-        $this->a = $a;
-        $this->b = $b;
+        $this->old = $oldArray;
+        $this->new = $newArray;
 
         if (is_array($options)) {
             $this->options = array_merge($this->defaultOptions, $options);
@@ -119,22 +119,21 @@ public function render($renderer)
      * that line.
      *
      * @param int $start The starting number.
-     * @param int $end The ending number. If not supplied, only the item in $start will be returned.
+     * @param int|null $end The ending number. If not supplied, only the item in $start will be returned.
      * @return array Array of all of the lines between the specified range.
      */
-    public function getA($start = 0, $end = null) : array
+    public function getOld(int $start = 0, $end = null) : array
     {
         if ($start == 0 && $end === null) {
-            return $this->a;
+            return $this->old;
         }
 
         if ($end === null) {
-            $length = 1;
-        } else {
-            $length = $end - $start;
+            return array_slice($this->old, $start, 1);
         }
 
-        return array_slice($this->a, $start, $length);
+        $length = $end - $start;
+        return array_slice($this->old, $start, $length);
     }
 
     /**
@@ -144,22 +143,21 @@ public function getA($start = 0, $end = null) : array
      * that line.
      *
      * @param int $start The starting number.
-     * @param int $end The ending number. If not supplied, only the item in $start will be returned.
+     * @param int|null $end The ending number. If not supplied, only the item in $start will be returned.
      * @return array Array of all of the lines between the specified range.
      */
-    public function getB($start = 0, $end = null) : array
+    public function getNew(int $start = 0, $end = null) : array
     {
         if ($start == 0 && $end === null) {
-            return $this->b;
+            return $this->new;
         }
 
         if ($end === null) {
-            $length = 1;
-        } else {
-            $length = $end - $start;
+            return array_slice($this->new, $start, 1);
         }
 
-        return array_slice($this->b, $start, $length);
+        $length = $end - $start;
+        return array_slice($this->new, $start, $length);
     }
 
     /**
@@ -176,7 +174,7 @@ public function getGroupedOpcodes() : array
             return $this->groupedCodes;
         }
 
-        $sequenceMatcher = new SequenceMatcher($this->a, $this->b, $this->options, null);
+        $sequenceMatcher = new SequenceMatcher($this->old, $this->new, $this->options, null);
         $this->groupedCodes = $sequenceMatcher->getGroupedOpcodes($this->options['context']);
         return $this->groupedCodes;
     }