Merge branch 'master' into php-diff-82

Author: JBlond

changelog.md

@@ -1,8 +1,12 @@
 # Changelog
 
-## 2.3.2 (2021-03-27)
+## 2.3.3 (2021-08-23)
 
-* Bump library version ([6e42d96](https://github.com/JBlond/php-diff/commit/6e42d96))
+* Fix Autoload test classes only in development ([31b4222](https://github.com/JBlond/php-diff/commit/31b4222))
+
+## v2.3.2 (2021-03-27)
+
+* Bump library version und update Changelog ([8a83b39](https://github.com/JBlond/php-diff/commit/8a83b39))
 * Fix [#90](https://github.com/JBlond/php-diff/issues/90) - Merged Diff shows result only partially ([acbfd7d](https://github.com/JBlond/php-diff/commit/acbfd7d))
 * Fix colors ([7eba340](https://github.com/JBlond/php-diff/commit/7eba340))
 * Fix repeating class assignment of line header ([fb32453](https://github.com/JBlond/php-diff/commit/fb32453))

composer.json

@@ -43,7 +43,11 @@
     },
     "autoload": {
         "psr-4": {
-            "jblond\\": "lib/jblond",
+            "jblond\\": "lib/jblond"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
             "Tests\\": "tests"
         }
     },

generateChangelog.php

@@ -5,8 +5,8 @@
 require 'vendor/autoload.php';
 
 $changelogOptions = [
-    'headTagName' => '2.3.2',
-    'headTagDate' => '2021-03-27',
+    'headTagName' => '2.3.3',
+    'headTagDate' => '2021-08-23',
     'titleOrder' => 'ASC',
 ];
 $changelogLabels = ['Add', 'Cut', 'Fix', 'Bump', 'Document','Optimize'];

lib/jblond/Diff.php

@@ -24,7 +24,7 @@
  * @author          Ferry Cools <[email protected]>
  * @copyright   (c) 2020 Mario Brandt
  * @license         New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version         2.3.2
+ * @version         2.3.3
  * @link            https://github.com/JBlond/php-diff
  */
 class Diff implements ConstantsInterface
@@ -89,7 +89,7 @@ class Diff implements ConstantsInterface
      * The values can be of type string or array.
      * If the type is string, it's split into array elements by line-end characters.
      *
-     * Options for comparison can be set by using the third parameter. The format of this value is expected to be a
+     * Options for comparison can be set by using the third parameter. The format of this value is expected to be an
      * 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.
@@ -112,7 +112,7 @@ public function __construct($version1, $version2, array $options = [])
     }
 
     /**
-     * Get the type of a variable.
+     * Get the kind of variable.
      *
      * The return value depend on the type of variable:
      * 0    If the type is 'array'
@@ -202,11 +202,11 @@ 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.
      *
-     * @return array Array containing all of the elements of the specified range.
+     * @return array Array containing all the elements of the specified range.
      * @throws OutOfRangeException When the value of start or end are invalid to define a range.
      *
      */
-    public function getArrayRange(array $array, int $start = 0, $end = null): array
+    public function getArrayRange(array $array, int $start = 0, ?int $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!');
@@ -276,7 +276,7 @@ public function getGroupedOpCodes(): array
      *
      * @return float Similarity ratio.
      */
-    public function getSimilarity($method = Similarity::CALC_DEFAULT): float
+    public function getSimilarity(int $method = Similarity::CALC_DEFAULT): float
     {
         if ($this->similarity !== null) {
             return $this->similarity;

lib/jblond/Diff/DiffUtils.php

@@ -11,7 +11,7 @@
  * @author          Mario Brandt <[email protected]>
  * @copyright   (c) 2020 Mario Brandt
  * @license         New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version        2.3.2
+ * @version         2.3.3
  * @link            https://github.com/JBlond/php-diff
  */
 class DiffUtils

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

@@ -14,15 +14,15 @@
  * @author          Ferry Cools <[email protected]>
  * @copyright   (c) 2020 Ferry Cools
  * @license         New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version        2.3.2
+ * @version         2.3.3
  * @link            https://github.com/JBlond/php-diff
  */
 class Merged extends MainRenderer implements SubRendererInterface
 {
     /**
      * @var array   Associative array containing the default options available for this renderer and their default
      *              value.
-     *              - format            Format of the texts.
+     *              - format            The Format of the texts.
      *              - insertMarkers     Markers for inserted text.
      *              - deleteMarkers     Markers for removed text.
      *              - title1            Title of the 1st version of text.

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

@@ -18,15 +18,15 @@
  * @author          Ferry Cools <[email protected]>
  * @copyright   (c) 2009 Chris Boulton
  * @license         New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version        2.3.2
+ * @version         2.3.3
  * @link            https://github.com/JBlond/php-diff
  */
 class SideBySide extends MainRenderer implements SubRendererInterface
 {
     /**
      * @var array   Associative array containing the default options available for this renderer and their default
      *              value.
-     *              - format            Format of the texts.
+     *              - format            The Format of the texts.
      *              - insertMarkers     Markers for inserted text.
      *              - deleteMarkers     Markers for removed text.
      *              - title1            Title of the 1st version of text.

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

@@ -18,15 +18,15 @@
  * @author        Ferry Cools <[email protected]>
  * @copyright (c) 2009 Chris Boulton
  * @license       New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version      2.3.2
+ * @version       2.3.3
  * @link          https://github.com/JBlond/php-diff
  */
 class Unified extends MainRenderer implements SubRendererInterface
 {
     /**
      * @var array   Associative array containing the default options available for this renderer and their default
      *              value.
-     *              - format            Format of the texts.
+     *              - format            The Format of the texts.
      *              - insertMarkers     Markers for inserted text.
      *              - deleteMarkers     Markers for removed text.
      *              - title1            Title of the 1st version of text.

lib/jblond/Diff/Renderer/MainRenderer.php

@@ -17,7 +17,7 @@
  * @author        Ferry Cools <[email protected]>
  * @copyright (c) 2009 Chris Boulton
  * @license       New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version      2.3.2
+ * @version       2.3.3
  * @link          https://github.com/JBlond/php-diff
  */
 class MainRenderer extends MainRendererAbstract
@@ -136,7 +136,7 @@ protected function renderSequences(): array
             foreach ($group as $code) {
                 [$tag, $startOld, $endOld, $startNew, $endNew] = $code;
                 /**
-                 * $code is an array describing a op-code which includes:
+                 * $code is an array describing an op-code which includes:
                  * 0 - The type of tag (as described below) for the op code.
                  * 1 - The beginning line in the first sequence.
                  * 2 - The end line in the first sequence.
@@ -373,7 +373,7 @@ private function getOuterChange(string $oldString, string $newString): array
         $limit = min(mb_strlen($oldString), mb_strlen($newString));
 
         // Find the position of the first character which is different between old and new.
-        // Starts at the begin of the strings.
+        // Starts at the beginning of the strings.
         // Stops at the end of the shortest string.
         while ($start < $limit && mb_substr($oldString, $start, 1) == mb_substr($newString, $start, 1)) {
             ++$start;
@@ -397,7 +397,7 @@ private function getOuterChange(string $oldString, string $newString): array
 
     /**
      * Helper function that will fill the changes-array for the renderer with default values.
-     * Every time a operation changes (specified by $tag) , a new element will be appended to this array.
+     * Every time an operation changes (specified by $tag) , a new element will be appended to this array.
      *
      * The index of the last element of the array is always returned.
      *

lib/jblond/Diff/Renderer/MainRendererAbstract.php

@@ -16,7 +16,7 @@
  * @author          Ferry Cools <[email protected]>
  * @copyright   (c) 2020 Ferry Cools
  * @license         New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version        2.3.2
+ * @version         2.3.3
  * @link            https://github.com/JBlond/php-diff
  */
 abstract class MainRendererAbstract

lib/jblond/Diff/Renderer/SubRendererInterface.php

@@ -13,7 +13,7 @@
  * @author          Ferry Cools <[email protected]>
  * @copyright   (c) 2020 Ferry Cools
  * @license         New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version        2.3.2
+ * @version         2.3.3
  * @link            https://github.com/JBlond/php-diff
  */
 interface SubRendererInterface

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

@@ -17,7 +17,7 @@
  * @author          Ferry Cools <[email protected]>
  * @copyright   (c) 2009 Chris Boulton
  * @license         New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version        2.3.2
+ * @version         2.3.3
  * @link            https://github.com/JBlond/php-diff
  */
 class Context extends MainRendererAbstract

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

@@ -17,7 +17,7 @@
  * @author          Ferry Cools <[email protected]>
  * @copyright   (c) 2020 Ferry Cools
  * @license         New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version        2.3.2
+ * @version         2.3.3
  * @link            https://github.com/JBlond/php-diff
  */
 class InlineCli extends MainRenderer implements SubRendererInterface
@@ -198,10 +198,6 @@ private function mergeChanges(
             max($this->maxLineMarkerWidth - strlen($this->options['equalityMarkers'][1]), 0)
         );
 
-        if ($this->options['cliColor']) {
-            $colorize = new CliColors();
-        }
-
         foreach ($baseLines as $lineKey => $line) {
             $iterator         = 0;
             $baselineParts    = preg_split('/\x00(.*?)\x01/', $line, -1, PREG_SPLIT_DELIM_CAPTURE);
@@ -220,7 +216,7 @@ private function mergeChanges(
                     }
 
                     if ($this->options['cliColor']) {
-                        // Colorize the changed part. $colorize is defined above.
+                        $colorize = new CliColors();
                         $basePart = $colorize->getColoredString($basePart, ...$deleteColors);
                         if (!empty($changedPart)) {
                             $changedPart = $colorize->getColoredString($changedPart, ...$insertColors);

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

@@ -16,7 +16,7 @@
  * @author          Mario Brandt <[email protected]>
  * @copyright   (c) 2020 Mario Brandt
  * @license         New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version        2.3.2
+ * @version         2.3.3
  * @link            https://github.com/JBlond/php-diff
  */
 

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

@@ -15,7 +15,7 @@
  * @author          Mario Brandt <[email protected]>
  * @copyright (c)   2020 Mario Brandt
  * @license         New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version        2.3.2
+ * @version         2.3.3
  * @link            https://github.com/JBlond/php-diff
  */
 class UnifiedCli extends MainRendererAbstract
@@ -112,12 +112,12 @@ private function output(): string
     }
 
     /**
-     * @param           $string
-     * @param   string  $color
+     * @param string $string
+     * @param string $color
      *
      * @return string
      */
-    private function colorizeString($string, $color = ''): string
+    private function colorizeString(string $string, string $color = ''): string
     {
         if ($this->options['cliColor']) {
             return $this->colors->getColoredString($string, $color);

lib/jblond/Diff/SequenceMatcher.php

@@ -17,7 +17,7 @@
  * @author          Ferry Cools <[email protected]>
  * @copyright   (c) 2020 Mario Brandt
  * @license         New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version         2.3.2
+ * @version         2.3.3
  * @link            https://github.com/JBlond/php-diff
  */
 class SequenceMatcher implements ConstantsInterface
@@ -80,8 +80,9 @@ class SequenceMatcher implements ConstantsInterface
     ];
 
     /**
-     * The constructor. With the sequences being passed, they'll be set for the sequence matcher and it will perform a
-     * basic cleanup & calculate junk elements.
+     * The constructor. With the sequences being passed, they'll be set for the
+     * sequence matcher, and it will perform a basic cleanup & calculate junk
+     * elements.
      *
      * @param   string|array       $old           A string or array containing the lines to compare against.
      * @param   string|array       $new           A string or array containing the lines to compare.
@@ -222,7 +223,7 @@ private function chainB()
      * content of the different files but can still provide context as to where the
      * changes are.
      *
-     * @return array Nested array of all of the grouped op codes.
+     * @return array Nested array of all the grouped op codes.
      */
     public function getGroupedOpCodes(): array
     {
@@ -302,7 +303,8 @@ public function getGroupedOpCodes(): array
     }
 
     /**
-     * Return a list of all of the op codes for the differences between the two strings.
+     * Return a list of all the op codes for the differences between the
+     * two strings.
      *
      * The nested array returned contains an array describing the op code which includes:
      * 0 - The type of tag (as described below) for the op code.
@@ -399,7 +401,8 @@ function (&$line) {
     }
 
     /**
-     * Return a nested set of arrays for all of the matching sub-sequences in compared strings $a and $b.
+     * Return a nested set of arrays for all the matching sub-sequences
+     * in the strings $a and $b.
      *
      * Each block contains the lower constraint of the block in $a, the lower constraint of the block in $b and finally
      * the number of lines that the block continues for.
@@ -510,7 +513,7 @@ function ($aArray, $bArray) {
      * lower and upper constraints for each sequence. (for the first sequence,
      * $alo - $ahi and for the second sequence, $blo - $bhi)
      *
-     * Essentially, of all of the maximal matching blocks, return the one that
+     * Essentially, of all the maximal matching blocks, return the one that
      * starts earliest in $a, and all of those maximal matching blocks that
      * start earliest in $a, return the one that starts earliest in $b.
      *

lib/jblond/Diff/Similarity.php

@@ -16,7 +16,7 @@
  * @author          Ferry Cools <[email protected]>
  * @copyright   (c) 2020 Ferry Cools
  * @license         New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version        2.3.2
+ * @version         2.3.3
  * @link            https://github.com/JBlond/php-diff
  */
 class Similarity extends SequenceMatcher

tests/Diff/Renderer/Html/HtmlRenderersTest.php

@@ -20,7 +20,7 @@
  * @author          Ferry Cools <[email protected]>
  * @copyright   (c) 2020 Mario Brandt
  * @license         New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version        2.3.2
+ * @version        2.3.3
  * @link            https://github.com/JBlond/php-diff
  */
 class HtmlRenderersTest extends TestCase

tests/Diff/Renderer/MainRendererTest.php

@@ -22,7 +22,7 @@
  * @author          Ferry Cools <[email protected]>
  * @copyright   (c) 2009 Mario Brandt
  * @license         New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version        2.3.2
+ * @version        2.3.3
  * @link            https://github.com/JBlond/php-diff
  */
 

tests/Diff/Renderer/Text/TextRenderersTest.php

@@ -19,7 +19,7 @@
  * @author          Ferry Cools <[email protected]>
  * @copyright   (c) 2019 Mario Brandt
  * @license         New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version        2.3.2
+ * @version        2.3.3
  * @link            https://github.com/JBlond/php-diff
  */
 class TextRenderersTest extends TestCase

tests/Diff/SequenceMatcherTest.php

@@ -15,7 +15,7 @@
  * @author          Ferry Cools <[email protected]>
  * @copyright   (c) 2009 Mario Brandt
  * @license         New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version        2.3.2
+ * @version         2.3.3
  * @link            https://github.com/JBlond/php-diff
  */
 class SequenceMatcherTest extends TestCase
@@ -73,7 +73,7 @@ public function testGetGroupedOpCodesIgnoreWhitespaceTrue()
     {
         // Test with ignoreWhitespace enabled. Both sequences are considered to be the same.
         // Note: The sequenceMatcher evaluates the string character by character. Option ignoreWhitespace will ignore
-        //       if the difference if the character is a tab in one sequence and a space in the other.
+        //       if the difference is the character or is a tab in one sequence and a space in the other.
         $sequenceMatcher = new SequenceMatcher(
             "\t54321ABXDE12345 ",
             " 54321ABXDE12345\t",

tests/Diff/SimilarityTest.php

@@ -14,7 +14,7 @@
  * @author          Ferry Cools <[email protected]>
  * @copyright   (c) 2020 Ferry Cools
  * @license         New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version        2.3.2
+ * @version         2.3.3
  * @link            https://github.com/JBlond/php-diff
  */
 class SimilarityTest extends TestCase