PHP8 Compatibility

PHP8 Compatibility

Author: Sven Hagemann

.scrutinizer.yml

@@ -3,17 +3,22 @@ imports:
 tools:
     js_hint: true
     php_code_sniffer: true
-    php_cs_fixer:
-        config: { level: psr2 }
-        enabled: true
+
 build:
-    tests:
-        override:
-            -
-                command: 'vendor/bin/phpunit --coverage-clover=code-coverage-file'
-                coverage:
-                    file: 'code-coverage-file'
-                    format: 'php-clover'
+    nodes:
+        analysis:
+            tests:
+                override:
+                    - phpcs-run
+        tests:
+            tests:
+                override:
+                    -
+                        command: 'vendor/bin/phpunit --coverage-clover=code-coverage-file'
+                        coverage:
+                            file: 'code-coverage-file'
+                            format: 'php-clover'
+
 filter:
     excluded_paths:
         - tests/*
@@ -130,4 +135,4 @@ checks:
         no_underscore_prefix_in_properties: true
         no_underscore_prefix_in_methods: true
         blank_line_after_namespace_declaration: true
-        verify_argument_usable_as_reference: true
+        verify_argument_usable_as_reference: true

composer.json

@@ -19,12 +19,12 @@
         "issues": "https://github.com/caxy/php-htmldiff/issues"
     },
     "require": {
-        "php": ">=5.3.3",
+        "php": ">=7.3",
         "ezyang/htmlpurifier": "^4.7",
         "kub-at/php-simple-html-dom-parser": "^1.7"
     },
     "require-dev": {
-        "phpunit/phpunit": "~5.0",
+        "phpunit/phpunit": "~9.0",
         "doctrine/cache": "~1.0"
     },
     "suggest": {

lib/Caxy/HtmlDiff/HtmlDiff.php

@@ -696,7 +696,7 @@ protected function operations()
         $operations = array();
 
         $matches   = $this->matchingBlocks();
-        $matches[] = new Match(count($this->oldWords), count($this->newWords), 0);
+        $matches[] = new MatchingBlock(count($this->oldWords), count($this->newWords), 0);
 
         foreach ($matches as $match) {
             $matchStartsAtCurrentPositionInOld = ($positionInOld === $match->startInOld);
@@ -728,7 +728,7 @@ protected function operations()
     }
 
     /**
-     * @return Match[]
+     * @return MatchingBlock[]
      */
     protected function matchingBlocks()
     {
@@ -784,7 +784,7 @@ protected function stripTagAttributes($word)
      * @param int $startInNew
      * @param int $endInNew
      *
-     * @return Match|null
+     * @return MatchingBlock|null
      */
     protected function findMatch($startInOld, $endInOld, $startInNew, $endInNew)
     {
@@ -837,7 +837,7 @@ protected function findMatch($startInOld, $endInOld, $startInNew, $endInNew)
                 !$this->isOnlyWhitespace($this->array_slice_cached($this->oldWords, $bestMatchInOld, $bestMatchSize))
             )
         ) {
-            return new Match($bestMatchInOld, $bestMatchInNew, $bestMatchSize);
+            return new MatchingBlock($bestMatchInOld, $bestMatchInNew, $bestMatchSize);
         }
 
         return null;

lib/Caxy/HtmlDiff/Match.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Caxy\HtmlDiff;
+
+/**
+ * A (string) block of text is the same between the two provided versions.
+ */
+class MatchingBlock implements \Countable
+{
+    public $startInOld;
+    public $startInNew;
+    public $size;
+
+    public function __construct(int $startInOld, int $startInNew, int $size)
+    {
+        $this->startInOld = $startInOld;
+        $this->startInNew = $startInNew;
+        $this->size       = $size;
+    }
+
+    public function endInOld() : int
+    {
+        return ($this->startInOld + $this->size);
+    }
+
+    public function endInNew() : int
+    {
+        return ($this->startInNew + $this->size);
+    }
+
+    public function count() : int
+    {
+        return (int)$this->size;
+    }
+}

lib/Caxy/HtmlDiff/MatchingBlock.php

@@ -0,0 +1,6 @@
+<?xml version="1.0"?>
+<ruleset>
+    <file>./lib</file>
+    <file>./tests</file>
+    <rule ref="PSR2" />
+</ruleset>

phpcs.xml

@@ -1,32 +1,22 @@
 <?xml version="1.0" encoding="utf-8"?>
-<phpunit backupGlobals="false"
-         backupStaticAttributes="false"
-         colors="true"
-         convertErrorsToExceptions="true"
-         convertNoticesToExceptions="true"
-         convertWarningsToExceptions="true"
-         processIsolation="false"
-         stopOnFailure="false"
-         syntaxCheck="false"
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" backupGlobals="false" backupStaticAttributes="false"
+         colors="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true" processIsolation="false" stopOnFailure="false"
          bootstrap="./tests/Caxy/Tests/TestInit.php"
->
-
-    <groups>
-        <exclude>
-            <group>performance</group>
-        </exclude>
-    </groups>
-
-    <testsuites>
-        <testsuite name="php-htmldiff Test Suite">
-            <directory>./tests/Caxy/Tests/HtmlDiff</directory>
-        </testsuite>
-    </testsuites>
-
-    <filter>
-        <whitelist processUncoveredFilesFromWhitelist="true">
-            <directory suffix=".php">./lib</directory>
-        </whitelist>
-    </filter>
-
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+  <coverage processUncoveredFiles="true">
+    <include>
+      <directory suffix=".php">./lib</directory>
+    </include>
+  </coverage>
+  <groups>
+    <exclude>
+      <group>performance</group>
+    </exclude>
+  </groups>
+  <testsuites>
+    <testsuite name="php-htmldiff Test Suite">
+      <directory>./tests/Caxy/Tests/HtmlDiff</directory>
+    </testsuite>
+  </testsuites>
 </phpunit>

phpunit.xml.dist

@@ -2,7 +2,9 @@
 
 namespace Caxy\Tests;
 
-abstract class AbstractTest extends \PHPUnit_Framework_TestCase
+use PHPUnit\Framework\TestCase;
+
+abstract class AbstractTest extends TestCase
 {
     protected function stripExtraWhitespaceAndNewLines($text)
     {
@@ -14,4 +16,4 @@ protected function stripExtraWhitespaceAndNewLines($text)
             )
         );
     }
-}
+}

tests/Caxy/Tests/AbstractTest.php

@@ -13,7 +13,7 @@ class HTMLPurifierConfigTest extends AbstractTest
      */
     protected $config;
 
-    public function setUp()
+    public function setUp() : void
     {
         $config = \HTMLPurifier_Config::createDefault();
 
@@ -73,4 +73,4 @@ public function testHtmlDiffConfigStatic()
         $diff->setHTMLPurifierConfig($this->config);
         $diff->build();
     }
-}
+}