Code Optimization, cleanup, refactoring and commenting.

DigiLive · DigiLive · commit c29a8aa09efc · 2020-01-29T13:59:55.000+01:00
diff --git a/example/example.php b/example/example.php
@@ -18,14 +18,13 @@
 
 // Options for generating the diff.
 $options = [
-    //'ignoreWhitespace' => true,
-    //'ignoreCase'       => true,
-    //'context'          => 2,    /* Remove // to see text collapse in action */
+    'ignoreWhitespace' => true,
+    'ignoreCase'       => true,
+    'context'          => 2,
 ];
 
 // Initialize the diff class.
-// \jblond\diff
-$diff = new Diff($a, $b, $options);
+$diff = new Diff($a, $b /*, $options */);
 ?><!DOCTYPE html>
 <html lang="en">
     <head>
@@ -43,8 +42,8 @@
         // Generate a side by side diff.
         // \jblond\Diff\Renderer\Html
         $renderer = new SideBySide([
-            'title_a' => 'Custom title for OLD version',
-            'title_b' => 'Custom title for NEW version',
+            'title1' => 'Custom title for version1',
+            'title2' => 'Custom title for version2',
         ]);
         echo $diff->Render($renderer);
         ?>
diff --git a/lib/jblond/Diff.php b/lib/jblond/Diff.php
@@ -16,29 +16,29 @@
  *
  * PHP version 7.2 or greater
  *
- * @package jblond
- * @author Chris Boulton <chris.boulton@interspire.com>
+ * @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.15
- * @link https://github.com/JBlond/php-diff
+ * @license       New BSD License http://www.opensource.org/licenses/bsd-license.php
+ * @version       1.15
+ * @link          https://github.com/JBlond/php-diff
  */
 class Diff
 {
     /**
-     * @var array   The "old" string to compare to.
+     * @var array   The first version to compare.
      *              Each element contains a line of this string.
      */
-    private $old;
+    private $version1;
 
     /**
-     * @var array   The "new" string to compare.
+     * @var array   The second version to compare.
      *              Each element contains a line of this string.
      */
-    private $new;
+    private $version2;
 
     /**
-     * @var array   Contains generated op-codes which represent the differences between "old" and "new".
+     * @var array   Contains generated op-codes which represent the differences between version1 and version2.
      */
     private $groupedCodes;
 
@@ -47,18 +47,20 @@ class Diff
      *              value.
      *              - context           The amount of lines to include around blocks that differ.
      *              - ignoreWhitespace  When true, tabs and spaces are ignored while comparing.
+     *                                  The spacing of version1 is leading.
      *              - ignoreCase        When true, character casing is ignored while comparing.
+     *                                  The casing of version1 is leading.
      */
     private $defaultOptions = [
-        'context'           => 3,
-        'ignoreWhitespace'  => false,
-        'ignoreCase'        => false,
+        'context'          => 3,
+        'ignoreWhitespace' => false,
+        'ignoreCase'       => false,
     ];
 
     /**
      * @var array   Associative array containing the options that will be applied for generating the diff.
      *              The key-value pairs are set at the constructor of this class.
-     *              @see Diff::setOptions()
+     * @see Diff::setOptions()
      */
     private $options = [];
 
@@ -73,28 +75,55 @@ class Diff
      * associative array where each key-value pair represents an option and its value (E.g. ['context' => 3], ...).
      * When a keyName matches the name of a default option, that option's value will be overridden by the key's value.
      * Any other keyName (and it's value) can be added as an option, but will not be used if not implemented.
+     *
+     * @param string|array $version1 Data to compare to.
+     * @param string|array $version2 Data to compare.
+     * @param array        $options  User defined option values.
+     *
      * @see Diff::$defaultOptions
      *
-     * @param string|array  $old        Data to compare to.
-     * @param string|array  $new        Data to compare.
-     * @param array         $options    User defined option values.
      */
-    public function __construct($old, $new, array $options = [])
+    public function __construct($version1, $version2, array $options = [])
     {
         //Convert "old" and "new" into an array of lines when they are strings.
-        $this->old = $this->getArgumentType($old) ? preg_split("/\r\n|\n|\r/", $old) : $old;
-        $this->new = $this->getArgumentType($new) ? preg_split("/\r\n|\n|\r/", $new) : $new;
+        $this->version1 = $this->getArgumentType($version1) ? preg_split("/\r\n|\n|\r/", $version1) : $version1;
+        $this->version2 = $this->getArgumentType($version2) ? preg_split("/\r\n|\n|\r/", $version2) : $version2;
 
         //Override the default options, define others.
         $this->setOptions($options);
     }
 
+    /**
+     * Get the type of a variable.
+     *
+     * The return value depend on the type of variable:
+     * 0    If the type is 'array'
+     * 1    if the type is 'string'
+     *
+     * @param mixed $var Variable to get type from.
+     *
+     * @return int  Number indicating the type of the variable. 0 for array type and 1 for string type.
+     * @throws InvalidArgumentException    When the type isn't 'array' or 'string'.
+     *
+     */
+    public function getArgumentType($var): int
+    {
+        switch (true) {
+            case (is_array($var)):
+                return 0;
+            case (is_string($var)):
+                return 1;
+            default:
+                throw new InvalidArgumentException('Invalid argument type! Argument must be of type array or string.');
+        }
+    }
+
     /**
      * Set the options to be used by the sequence matcher, called by this class.
      *
      * @param array $options User defined option names and values.
      *
-     *@see Diff::$defaultOptions
+     * @see Diff::$defaultOptions
      *
      * @see Diff::getGroupedOpCodes()
      *
@@ -111,22 +140,21 @@ public function setOptions(array $options)
      *
      * @return array Contains the lines of the "old" string to compare to.
      */
-    public function getOld(): array
+    public function getVersion1(): array
     {
-        return $this->old;
+        return $this->version1;
     }
 
     /**
      * Get the lines of "new".
      *
      * @return array Contains the lines of the "new" string to compare.
      */
-    public function getNew(): array
+    public function getVersion2(): array
     {
-        return $this->new;
+        return $this->version2;
     }
 
-
     /**
      * Render a diff-view using a rendering class and get its results.
      *
@@ -151,14 +179,14 @@ public function render(object $renderer)
      * If the arguments for both parameters are omitted, the entire array will be returned.
      * If the argument for the second parameter is ommitted, the element defined as start will be returned.
      *
-     * @param array     $array  The source array.
-     * @param int       $start  The first element of the range to get.
-     * @param int|null  $end    The last element of the range to get.
+     * @param array    $array   The source array.
+     * @param int      $start   The first element of the range to get.
+     * @param int|null $end     The last element of the range to get.
      *                          If not supplied, only the element at start will be returned.
      *
+     * @return array Array containing all of the elements of the specified range.
      * @throws OutOfRangeException When the value of start or end are invalid to define a range.
      *
-     * @return array Array containing all of the elements of the specified range.
      */
     public function getArrayRange(array $array, int $start = 0, $end = null): array
     {
@@ -182,31 +210,6 @@ public function getArrayRange(array $array, int $start = 0, $end = null): array
         return array_slice($array, $start, $length);
     }
 
-    /**
-     * Get the type of a variable.
-     *
-     * The return value depend on the type of variable:
-     * 0    If the type is 'array'
-     * 1    if the type is 'string'
-     *
-     * @param mixed $var    Variable to get type from.
-     *
-     * @throws InvalidArgumentException    When the type isn't 'array' or 'string'.
-     *
-     * @return int  Number indicating the type of the variable. 0 for array type and 1 for string type.
-     */
-    public function getArgumentType($var): int
-    {
-        switch (true) {
-            case (is_array($var)):
-                return 0;
-            case (is_string($var)):
-                return 1;
-            default:
-                throw new InvalidArgumentException('Invalid argument type! Argument must be of type array or string.');
-        }
-    }
-
     /**
      * Generate a list of the compiled and grouped op-codes for the differences between two strings.
      *
@@ -224,7 +227,7 @@ public function getGroupedOpCodes(): array
         }
 
         //Get and cache the grouped op-codes.
-        $sequenceMatcher    = new SequenceMatcher($this->old, $this->new, $this->options);
+        $sequenceMatcher    = new SequenceMatcher($this->version1, $this->version2, $this->options);
         $this->groupedCodes = $sequenceMatcher->getGroupedOpCodes($this->options['context']);
 
         return $this->groupedCodes;
diff --git a/lib/jblond/Diff/Renderer/Html/HtmlArray.php b/lib/jblond/Diff/Renderer/Html/HtmlArray.php
@@ -29,8 +29,8 @@ class HtmlArray extends RendererAbstract
      */
     protected $defaultOptions = [
         'tabSize' => 4,
-        'title_a' => 'Old Version',
-        'title_b' => 'New Version',
+        'title1'  => 'Version1',
+        'title2'  => 'Version2',
     ];
 
     /**
@@ -106,8 +106,8 @@ public function renderHtml(array $changes, object $htmlRenderer): string
     public function render()
     {
         // The old and New texts are copied so change markers can be added without modifying the original sequences.
-        $oldText = $this->diff->getOld();
-        $newText = $this->diff->getNew();
+        $oldText = $this->diff->getVersion1();
+        $newText = $this->diff->getVersion2();
 
         $changes = [];
 
@@ -116,7 +116,7 @@ public function render()
             $this->lastTag = null;
 
             foreach ($group as $code) {
-                list($tag, $startOld, $endOld, $startNew, $endNew) = $code;
+                [$tag, $startOld, $endOld, $startNew, $endNew] = $code;
                 /**
                  * $code is an array describing a op-code which includes:
                  * 0 - The type of tag (as described below) for the op code.
@@ -203,7 +203,7 @@ private function markInlineChange(array &$oldText, array &$newText, $startOld, $
             $newString = $newText[$startNew + $i];
 
             // Determine the start and end position of the line difference.
-            list($start, $end) = $this->getInlineChange($oldString, $newString);
+            [$start, $end] = $this->getInlineChange($oldString, $newString);
             if ($start != 0 || $end != 0) {
                 // Changes between the lines exist.
                 // Add markers around the changed character sequence in the old string.
@@ -265,7 +265,7 @@ private function getInlineChange(string $oldString, string $newString): array
 
         return [
             $start,
-            $end + 1
+            $end + 1,
         ];
     }
 
@@ -292,12 +292,12 @@ private function appendChangesArray(array &$blocks, string $tag, int $lineInOld,
             'tag'     => $tag,
             'base'    => [
                 'offset' => $lineInOld,
-                'lines'  => []
+                'lines'  => [],
             ],
             'changed' => [
                 'offset' => $lineInNew,
-                'lines'  => []
-            ]
+                'lines'  => [],
+            ],
         ];
 
         $this->lastTag = $tag;
diff --git a/lib/jblond/Diff/Renderer/Html/Inline.php b/lib/jblond/Diff/Renderer/Html/Inline.php
@@ -42,8 +42,8 @@ public function generateTableHeader(): string
 <table class="Differences DifferencesInline">
     <thead>
         <tr>
-            <th>{$this->options['title_a']}</th>
-            <th>{$this->options['title_b']}</th>
+            <th>{$this->options['title1']}</th>
+            <th>{$this->options['title2']}</th>
             <th>Differences</th>
         </tr>
     </thead>
diff --git a/lib/jblond/Diff/Renderer/Html/SideBySide.php b/lib/jblond/Diff/Renderer/Html/SideBySide.php
@@ -41,8 +41,8 @@ public function generateTableHeader(): string
 <table class="Differences DifferencesSideBySide">
     <thead>
         <tr>
-            <th colspan="2">{$this->options['title_a']}</th>
-            <th colspan="2">{$this->options['title_b']}</th>
+            <th colspan="2">{$this->options['title1']}</th>
+            <th colspan="2">{$this->options['title2']}</th>
         </tr>
     </thead>
 HTML;
diff --git a/lib/jblond/Diff/Renderer/RendererAbstract.php b/lib/jblond/Diff/Renderer/RendererAbstract.php
@@ -30,8 +30,8 @@ abstract class RendererAbstract
      * @var array Array of the default options that apply to this renderer.
      */
     protected $defaultOptions = array(
-        'title_a' => 'Old Version',
-        'title_b' => 'New Version',
+        'title1' => 'Version1',
+        'title2' => 'Version2',
     );
 
     /**
diff --git a/lib/jblond/Diff/Renderer/Text/Context.php b/lib/jblond/Diff/Renderer/Text/Context.php
@@ -77,7 +77,7 @@ public function render(): string
                     $diff .= $this->tagMap[$tag] . ' ' .
                         implode(
                             "\n" . $this->tagMap[$tag] . ' ',
-                            $this->diff->getArrayRange($this->diff->getOld(), $i1, $i2)
+                            $this->diff->getArrayRange($this->diff->getVersion1(), $i1, $i2)
                         ) . "\n";
                 }
             }
@@ -101,7 +101,7 @@ public function render(): string
                     $diff .= $this->tagMap[$tag] . ' ' .
                         implode(
                             "\n" . $this->tagMap[$tag] . ' ',
-                            $this->diff->getArrayRange($this->diff->getNew(), $j1, $j2)
+                            $this->diff->getArrayRange($this->diff->getVersion2(), $j1, $j2)
                         ) . "\n";
                 }
             }
diff --git a/lib/jblond/Diff/Renderer/Text/Unified.php b/lib/jblond/Diff/Renderer/Text/Unified.php
@@ -51,22 +51,22 @@ public function render(): string
                     $diff .= ' ' .
                         implode(
                             "\n ",
-                            $this->diff->getArrayRange($this->diff->getOld(), $i1, $i2)
+                            $this->diff->getArrayRange($this->diff->getVersion1(), $i1, $i2)
                         ) . "\n";
                 } else {
                     if ($tag == 'replace' || $tag == 'delete') {
                         $diff .= '-' .
                             implode(
                                 "\n-",
-                                $this->diff->getArrayRange($this->diff->getOld(), $i1, $i2)
+                                $this->diff->getArrayRange($this->diff->getVersion1(), $i1, $i2)
                             ) . "\n";
                     }
 
                     if ($tag == 'replace' || $tag == 'insert') {
                         $diff .= '+' .
                             implode(
                                 "\n+",
-                                $this->diff->getArrayRange($this->diff->getNew(), $j1, $j2)
+                                $this->diff->getArrayRange($this->diff->getVersion2(), $j1, $j2)
                             ) . "\n";
                     }
                 }
diff --git a/tests/Diff/Renderer/Html/HtmlRenderersTest.php b/tests/Diff/Renderer/Html/HtmlRenderersTest.php
diff --git a/tests/Diff/Renderer/Text/TextRenderersTest.php b/tests/Diff/Renderer/Text/TextRenderersTest.php
diff --git a/tests/resources/htmlInline.txt b/tests/resources/htmlInline.txt
diff --git a/tests/resources/htmlSideBySide.txt b/tests/resources/htmlSideBySide.txt

Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ public function render(): string`
`77`	`77`	`$diff .= $this->tagMap[$tag] . ' ' .`
`78`	`78`	`implode(`
`79`	`79`	`"\n" . $this->tagMap[$tag] . ' ',`
`80`		`- $this->diff->getArrayRange($this->diff->getOld(), $i1, $i2)`
	`80`	`+ $this->diff->getArrayRange($this->diff->getVersion1(), $i1, $i2)`
`81`	`81`	`) . "\n";`
`82`	`82`	`}`
`83`	`83`	`}`
`@@ -101,7 +101,7 @@ public function render(): string`
`101`	`101`	`$diff .= $this->tagMap[$tag] . ' ' .`
`102`	`102`	`implode(`
`103`	`103`	`"\n" . $this->tagMap[$tag] . ' ',`
`104`		`- $this->diff->getArrayRange($this->diff->getNew(), $j1, $j2)`
	`104`	`+ $this->diff->getArrayRange($this->diff->getVersion2(), $j1, $j2)`
`105`	`105`	`) . "\n";`
`106`	`106`	`}`
`107`	`107`	`}`