Merge pull request #79 from JBlond/maintenance

maintenance

Author: JBlond

README.md

@@ -6,8 +6,9 @@
 
 ## Introduction
 
-A comprehensive library for generating differences between two hashable objects (strings or arrays).
-Generated differences can be rendered in all the standard formats including:
+A comprehensive library for generating differences between two hashable
+objects (strings or arrays). Generated differences can be rendered in all the
+standard formats including:
 
 * Unified
 * Context
@@ -16,8 +17,9 @@ Generated differences can be rendered in all the standard formats including:
 * Unified HTML
 * Unified Commandline colored output
 
-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.
+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.
 
 ## Install
 
@@ -31,7 +33,7 @@ For cli usage you need to install the suggested `jblond/php-cli` package.
 
 ## Documentation
 
-See the [Wiki](https://github.com/JBlond/php-diff/wiki) for 
+See the [Wiki](https://github.com/JBlond/php-diff/wiki) for
 
 * [Getting started](https://github.com/JBlond/php-diff/wiki/1.-Getting-Started)
 * [Parameters and Options](https://github.com/JBlond/php-diff/wiki/2.-Parameters-and-Options)
@@ -82,8 +84,9 @@ echo $diff->isIdentical() ? 'No differences found.' : '<pre>' . htmlspecialchars
 ```
 
 ### Example Output
-File `example.php` contains a quick demo and can be found in the `example/` directory.
-Included is a light and a dark theme.
+
+File `example.php` contains a quick demo and can be found in the `example/`
+directory. Included is a light and a dark theme.
 
 #### HTML Side By Side Example
 
@@ -115,7 +118,6 @@ Included is a light and a dark theme.
 
 <details><summary>HTML Side By Side Dark Theme Example</summary><br>
 
-
 ![HTML Side By Side Dark Theme Example](assets/htmlSidebySideDarkTheme.png "HTML Side By Side Dark Theme Example")
 
 </details>
@@ -128,16 +130,18 @@ Included is a light and a dark theme.
 
 ## Contribution, Issues and feature requests
 
-If you found a bug, or have an idea for new functionality, 
-feel free to report it on the issue tracker - just use search beforehand.
+If you found a bug, or have an idea for new functionality, feel free to report
+it on the issue tracker - just use search beforehand.
 [Issue tracker](https://github.com/JBlond/php-diff/issues)
 
 You can also fork this repository and open a PR.
 
 ## 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).
+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
 

changelog.md

@@ -2,120 +2,133 @@
 
 ## 2.3.0 (2020-11-19)
 
-- Add: Change log.
-- Fix: Html SideBySide renders equal lines of version 1 at both sides (Option ignoreCase).
-- Fix: Second parameter of string repeat function minimizes to 0.
-- Fix: #60 - Unified Cli renderer options incompatible with Main renderer options
-- Fix: #64 - Calculation of maxLineMarkerWidth independent of input format.
-- Add: Similarity calculation
-- Add: New marking levels for inline differences
-- Add: Html merged renderer
+* Add: Change log.
+  
+* Fix: Html SideBySide renders equal lines of version 1 at both sides (Option
+  ignoreCase).
+
+* Fix: Second parameter of string repeat function minimizes to 0.
+
+* Fix: #60 - Unified Cli renderer options incompatible with Main renderer
+  options
+
+* Fix: #64 - Calculation of maxLineMarkerWidth independent of input format.
+
+* Add: Similarity calculation
+
+* Add: New marking levels for inline differences
+
+* Add: Html merged renderer
 
 ## 2.2.1 (2020-08-06)
 
-- Fix: #58 - Side by side diff shows empty diff
+* Fix: #58 - Side by side diff shows empty diff
 
 ## 2.2.0 (2020-07-23)
 
-- Add: Option for a custom override renderer. #53
-- Add: No output when there are no differences between the compared strings / files. #52 #54
+* Add: Option for a custom override renderer. #53
+
+* Add: No output when there are no differences between the compared strings /
+  files. #52 #54
 
 ## 2.1.1 (2020-07-17)
 
-- Fix: #50 - Renderers produce output with equal texts, while they shouldn't.
+* Fix: #50 - Renderers produce output with equal texts, while they shouldn't.
 
 ## 2.1.0 (2020-07-13)
 
-- Add: Cli uncolored output. This allows it to be piped.
+* Add: Cli uncolored output. This allows it to be piped.
 
 ## 2.0.0 (2020-07-09)
 
-- Add: Unified Commandline colored output.
-- Change: switch to semantic versioning.
+* Add: Unified Commandline colored output.
+* Change: switch to semantic versioning.
 
 ## 1.18 (2020-07-01)
 
-- Add: A dark theme to the example.
-- Fix: Avoid variables with short names (some).
+* Add: A dark theme to the example.
+* Fix: Avoid variables with short names (some).
 
 ## 1.17 (2020-06-08)
 
-- Fix #32 - Side by side diff shows only partially all deleted lines.
+* Fix #32 - Side by side diff shows only partially all deleted lines.
 
 ## 1.16 (2020-03-02)
 
-- Features
-    - Add: option trimEqual.
+* Features
+  * Add: option trimEqual.
 
-- Fixes
-    - Fix PHPMD Violation.
-    - Code Optimization, cleanup, refactoring and commenting.
+* Fixes
+  * Fix PHPMD Violation.
+  * Code Optimization, cleanup, refactoring and commenting.
 
 ## 1.15 (2020-01-24)
 
-- Add: New Unified HTML.
-- Fix: Code clean up.
+* Add: New Unified HTML.
+* Fix: Code clean up.
 
 ## 1.14 (2019-12-03)
 
-- Fix: Remove some old dead code.
+* Fix: Remove some old dead code.
 
 ## 1.13 (2019-10-08)
 
-- Change: Switch to PSR12.
+* Change: Switch to PSR12.
 
 ## 1.12 (2019-03-18)
 
-- Change: Update Composer Configuration.
-- Fix: PSR-2 conventions.
+* Change: Update Composer Configuration.
+* Fix: PSR-2 conventions.
 
 ## 1.11 (2019-02-22)
 
-- Fix: Code clean up.
-- Fix: Composer autoloader for unit tests.
+* Fix: Code clean up.
+* Fix: Composer autoloader for unit tests.
 
 ## 1.10 (2019-02-20)
 
-- Fix: Code clean up.
+* Fix: Code clean up.
 
 ## 1.9 (2019-02-19)
 
-- Fix: Code clean up.
+* Fix: Code clean up.
 
 ## 1.8
 
-- Change: Update Readme and bumping versions.
-- Fix: Moved include of Autoloader from the constructor to global space for HtmlArray unit test.
+* Change: Update Readme and bumping versions.
+
+* Fix: Moved include of Autoloader from the constructor to global space for
+  HtmlArray unit test.
 
 ## 1.7
 
-- Fix: PSR-2 code alignment.
+* Fix: PSR-2 code alignment.
 
 ## 1.6
 
-- Change: Bump required version of PHP to v7.1.
-- Add: Return type hinting.
+* Change: Bump required version of PHP to v7.1.
+* Add: Return type hinting.
 
 ## 1.5 (2019-01-15)
 
-- Fix: Autoloader naming issues.
+* Fix: Autoloader naming issues.
 
 ## 1.4 (2019-01-14)
 
-- Add: PSR-4 namespace support.
+* Add: PSR-4 namespace support.
 
 ## 1.3 (2019-01-11)
 
-- Fix: PHP methods contained too much logic. That has been simplified.
+* Fix: PHP methods contained too much logic. That has been simplified.
 
 ## 1.2 (2018-01-23)
 
-- Add: Support for custom titles.
+* Add: Support for custom titles.
 
 ## 1.1 (2017-05-06)
 
-- Fix: Wrong highlight area for chinese characters.
+* Fix: Wrong highlight area for chinese characters.
 
-## 1.0 
+## 1.0
 
-- Initial version.
+* Initial version.

example/dark-theme.css

@@ -53,6 +53,7 @@ a, a:visited {
 .Differences .Skipped {
     background: #F7F7F7;
     color:      #000000;
+    display:    block;
 }
 
 .Differences ins,

example/example.php

@@ -70,7 +70,10 @@ function changeCSS(cssFile, cssLinkIndex) {
 <hr>
 <aside>
     <h2>Informational</h2>
-    Between the two versions, there's a <?php echo round($diff->getSimilarity(),2) * 100; ?>% match.
+    Between the two versions, there's a
+    <?php
+    echo round($diff->getSimilarity(), 2) * 100;
+    ?>% match.
 </aside>
 <hr>
 

example/styles.css

@@ -47,6 +47,7 @@ pre {
 
 .Differences .Skipped {
     background: #F7F7F7;
+    display:    block;
 }
 
 /*

lib/jblond/Diff/DiffUtils.php

@@ -7,19 +7,21 @@
  *
  * PHP version 7.2 or greater
  *
- * @package     jblond\Diff
- * @author      Mario Brandt <leet31337@web.de>
- * @license     New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version     2.3.0
- * @link        https://github.com/JBlond/php-diff
+ * @package         jblond\Diff
+ * @author          Mario Brandt <leet31337@web.de>
+ * @copyright   (c) 2020 Mario Brandt
+ * @license         New BSD License http://www.opensource.org/licenses/bsd-license.php
+ * @version         2.3.0
+ * @link            https://github.com/JBlond/php-diff
  */
 class DiffUtils
 {
     /**
      * Sort an array by the nested arrays it contains. Helper function for getMatchingBlocks
      *
-     * @param array $aArray First array to compare.
-     * @param array $bArray Second array to compare.
+     * @param   array  $aArray  First array to compare.
+     * @param   array  $bArray  Second array to compare.
+     *
      * @return int -1, 0 or 1, as expected by the usort function.
      */
     public static function tupleSort(array $aArray, array $bArray): int
@@ -39,6 +41,7 @@ public static function tupleSort(array $aArray, array $bArray): int
         if (count($aArray) < count($bArray)) {
             return -1;
         }
+
         return 1;
     }
 }