Code Optimization, cleanup, refactoring and commenting.

Author: DigiLive

example/example.php

@@ -47,7 +47,6 @@
             'title_b' => 'Custom title for NEW version',
         ]);
         echo $diff->Render($renderer);
-
         ?>
 
         <h2>HTML Inline Diff</h2>

lib/jblond/Diff.php

@@ -4,7 +4,9 @@
 
 namespace jblond;
 
+use InvalidArgumentException;
 use jblond\Diff\SequenceMatcher;
+use OutOfRangeException;
 
 /**
  * Diff
@@ -63,7 +65,7 @@ class Diff
     /**
      * The constructor.
      *
-     * The first two parameters define the data to compare to eachother.
+     * The first two parameters define the data to compare to each other.
      * The values can be of type string or array.
      * If the type is string, it's split into array elements by line-end characters.
      *
@@ -89,13 +91,15 @@ public function __construct($old, $new, array $options = [])
 
     /**
      * Set the options to be used by the sequence matcher, called by this class.
-     * @see Diff::getGroupedOpcodes()
+     *
+     * @param array $options User defined option names and values.
+     *
+     *@see Diff::$defaultOptions
+     *
+     * @see Diff::getGroupedOpCodes()
      *
      * 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) will be added as an option, but will not be used if not implemented.
-     * @see Diff::$defaultOptions
-     *
-     * @param array $options User defined option names and values.
      */
     public function setOptions(array $options)
     {
@@ -152,14 +156,14 @@ public function render(object $renderer)
      * @param int|null  $end    The last element of the range to get.
      *                          If not supplied, only the element at start will be returned.
      *
-     * @throws \OutOfRangeException When the value of start or end are invalid to define a 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
     {
         if ($start < 0 || $end < 0 || $end < $start) {
-            throw new \OutOfRangeException('Start parameter must be lower than End parameter while both are positive!');
+            throw new OutOfRangeException('Start parameter must be lower than End parameter while both are positive!');
         }
 
         if ($start == 0 && $end === null) {
@@ -187,7 +191,7 @@ public function getArrayRange(array $array, int $start = 0, $end = null): array
      *
      * @param mixed $var    Variable to get type from.
      *
-     * @throws \InvalidArgumentException    When the type isn't 'array' or 'string'.
+     * @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.
      */
@@ -199,7 +203,7 @@ public function getArgumentType($var): int
             case (is_string($var)):
                 return 1;
             default:
-                throw new \InvalidArgumentException('Invalid argument type! Argument must be of type array or string.');
+                throw new InvalidArgumentException('Invalid argument type! Argument must be of type array or string.');
         }
     }
 
@@ -212,15 +216,15 @@ public function getArgumentType($var): int
      *
      * @return array Array of the grouped op-codes for the generated diff.
      */
-    public function getGroupedOpcodes(): array
+    public function getGroupedOpCodes(): array
     {
         if ($this->groupedCodes !== null) {
             //Return the cached results.
             return $this->groupedCodes;
         }
 
         //Get and cache the grouped op-codes.
-        $sequenceMatcher    = new SequenceMatcher($this->old, $this->new, $this->options, null);
+        $sequenceMatcher    = new SequenceMatcher($this->old, $this->new, $this->options);
         $this->groupedCodes = $sequenceMatcher->getGroupedOpCodes($this->options['context']);
 
         return $this->groupedCodes;

lib/jblond/Diff/Renderer/Html/HtmlArray.php

@@ -111,7 +111,7 @@ public function render()
 
         $changes = [];
 
-        foreach ($this->diff->getGroupedOpcodes() as $group) {
+        foreach ($this->diff->getGroupedOpCodes() as $group) {
             $blocks        = [];
             $this->lastTag = null;
 

lib/jblond/Diff/Renderer/Html/SideBySide.php

@@ -169,11 +169,10 @@ public function generateTableRowsReplace(array $changes): string
         //TODO: Is below comparison result ever false?
         if (count($changes['base']['lines']) >= count($changes['changed']['lines'])) {
             foreach ($changes['base']['lines'] as $lineNo => $line) {
-                $fromLine = $changes['base']['offset'] + $lineNo + 1;
-                if (!isset($changes['changed']['lines'][$lineNo])) {
-                    $toLine      = " ";
-                    $changedLine = " ";
-                } else {
+                $fromLine    = $changes['base']['offset'] + $lineNo + 1;
+                $toLine      = " ";
+                $changedLine = " ";
+                if (isset($changes['changed']['lines'][$lineNo])) {
                     $toLine      = $changes['changed']['offset'] + $lineNo + 1;
                     $changedLine = $changes['changed']['lines'][$lineNo];
                 }
@@ -196,11 +195,10 @@ public function generateTableRowsReplace(array $changes): string
         }
 
         foreach ($changes['changed']['lines'] as $lineNo => $changedLine) {
-            $toLine = $changes['changed']['offset'] + $lineNo + 1;
-            if (!isset($changes['base']['lines'][$lineNo])) {
-                $fromLine = " ";
-                $line     = " ";
-            } else {
+            $toLine   = $changes['changed']['offset'] + $lineNo + 1;
+            $fromLine = " ";
+            $line     = " ";
+            if (isset($changes['base']['lines'][$lineNo])) {
                 $fromLine = $changes['base']['offset'] + $lineNo + 1;
                 $line     = $changes['base']['lines'][$lineNo];
             }

lib/jblond/Diff/Renderer/Text/Context.php

@@ -38,7 +38,7 @@ class Context extends RendererAbstract
     public function render(): string
     {
         $diff       = '';
-        $opCodes    = $this->diff->getGroupedOpcodes();
+        $opCodes    = $this->diff->getGroupedOpCodes();
 
         foreach ($opCodes as $group) {
             $diff       .= "***************\n";

lib/jblond/Diff/Renderer/Text/Unified.php

@@ -32,7 +32,7 @@ class Unified extends RendererAbstract
     public function render(): string
     {
         $diff = '';
-        $opCodes = $this->diff->getGroupedOpcodes();
+        $opCodes = $this->diff->getGroupedOpCodes();
         foreach ($opCodes as $group) {
             $lastItem = count($group) - 1;
             $i1 = $group['0']['1'];