From 2de9031c477e1eabe9e26c3412610a45c9b6b14d Mon Sep 17 00:00:00 2001
From: Greg Bowler <greg.bowler@g105b.com>
Date: Thu, 2 Jan 2025 23:56:16 +0000
Subject: [PATCH] Static analysis compatibility with PHP 8.1 and PHP 8.4

* tweak: php 8.1 support

* tweak: php 8.4 support

* tweak: inherit integers from parent node class

* tweak: inherit integers from parent node class

* tweak: class definition

* tweak: fix node extension issue

* tweak: php 8.4 changes

* tweak: phpcs ignore node files

* tweak: phpstan ignore node files

* tweak: phpstan ignore node files

* tweak: phpstan ignore node files

* tweak: phpstan ignore node files

* tweak: phpstan ignore node files

* tweak: phpstan ignore node files

* tweak: phpstan ignore node files

* tweak: phpstan ignore node files
---
 .github/workflows/ci.yml         | 11 ++++----
 phpstan.neon                     |  7 ++++++
 src/Node.php                     | 43 ++++++--------------------------
 src/Node83.php                   | 40 +++++++++++++++++++++++++++++
 src/Node84.php                   | 40 +++++++++++++++++++++++++++++
 test/phpunit/NodeTest.php        | 11 +++++---
 test/phpunit/XMLDocumentTest.php |  7 +++++-
 7 files changed, 115 insertions(+), 44 deletions(-)
 create mode 100644 phpstan.neon
 create mode 100644 src/Node83.php
 create mode 100644 src/Node84.php

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 9a3e201e..6bf1a0b9 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php: [ 8.1, 8.2, 8.3 ]
+        php: [ 8.1, 8.2, 8.3, 8.4 ]
 
     steps:
       - uses: actions/checkout@v3
@@ -37,7 +37,7 @@ jobs:
     needs: [ composer ]
     strategy:
       matrix:
-        php: [ 8.1, 8.2, 8.3 ]
+        php: [ 8.1, 8.2, 8.3, 8.4 ]
 
     outputs:
       coverage: ${{ steps.store-coverage.outputs.coverage_text }}
@@ -90,7 +90,7 @@ jobs:
     needs: [ composer ]
     strategy:
       matrix:
-        php: [ 8.1, 8.2, 8.3 ]
+        php: [ 8.1, 8.2, 8.3, 8.4 ]
 
     steps:
       - uses: actions/download-artifact@v3
@@ -106,13 +106,14 @@ jobs:
         with:
           php_version: ${{ matrix.php }}
           path: src/
+          configuration: phpstan.neon
 
   phpmd:
     runs-on: ubuntu-latest
     needs: [ composer ]
     strategy:
       matrix:
-        php: [ 8.1, 8.2, 8.3 ]
+        php: [ 8.1, 8.2, 8.3, 8.4 ]
 
     steps:
       - uses: actions/download-artifact@v3
@@ -136,7 +137,7 @@ jobs:
     needs: [ composer ]
     strategy:
       matrix:
-        php: [ 8.1, 8.2, 8.3 ]
+        php: [ 8.1, 8.2, 8.3, 8.4 ]
 
     steps:
       - uses: actions/download-artifact@v3
diff --git a/phpstan.neon b/phpstan.neon
new file mode 100644
index 00000000..5582cf57
--- /dev/null
+++ b/phpstan.neon
@@ -0,0 +1,7 @@
+parameters:
+    level: 6
+    paths:
+        - src/
+    excludePaths:
+        - src/Node83.php
+        - src/Node84.php
diff --git a/src/Node.php b/src/Node.php
index 712fd411..47ddcda2 100644
--- a/src/Node.php
+++ b/src/Node.php
@@ -1,39 +1,12 @@
 <?php
+// phpcs:ignoreFile
 namespace Gt\Dom;
 
-use DOMNode;
-
-class Node extends DOMNode {
-	use NonDocumentTypeChildNode;
-	use ChildNode;
-	use ParentNode;
-	use RegisteredNodeClass;
-
-	const TYPE_ELEMENT = XML_ELEMENT_NODE;
-	const TYPE_ATTR = XML_ATTRIBUTE_NODE;
-	const TYPE_TEXT = XML_TEXT_NODE;
-	const TYPE_CDATA = XML_CDATA_SECTION_NODE;
-	const TYPE_ENTITY_REF = XML_ENTITY_REF_NODE;
-	const TYPE_ENTITY = XML_ENTITY_NODE;
-	const TYPE_PI = XML_PI_NODE;
-	const TYPE_COMMENT = XML_COMMENT_NODE;
-	const TYPE_DOCUMENT = XML_DOCUMENT_NODE;
-	const TYPE_DOCUMENT_TYPE = XML_DOCUMENT_TYPE_NODE;
-	const TYPE_DOCUMENT_FRAGMENT = XML_DOCUMENT_FRAG_NODE;
-	const TYPE_NOTATION = XML_NOTATION_NODE;
-	const TYPE_HTML_DOCUMENT = XML_HTML_DOCUMENT_NODE;
-	const TYPE_DTD = XML_DTD_NODE;
-	const TYPE_ELEMENT_DECL = XML_ELEMENT_DECL_NODE;
-	const TYPE_ATTRIBUTE_DECL = XML_ATTRIBUTE_DECL_NODE;
-	const TYPE_ENTITY_DECL = XML_ENTITY_DECL_NODE;
-	const TYPE_NAMESPACE_DECL = XML_NAMESPACE_DECL_NODE;
-
-	public const DOCUMENT_POSITION_DISCONNECTED = 0b000001;
-	public const DOCUMENT_POSITION_PRECEDING = 0b000010;
-	public const DOCUMENT_POSITION_FOLLOWING = 0b000100;
-	public const DOCUMENT_POSITION_CONTAINS = 0b001000;
-	public const DOCUMENT_POSITION_CONTAINED_BY = 0b010000;
-	public const DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC = 0b100000;
-
-	private function __construct() {}
+if (version_compare(PHP_VERSION, '8.4', '>=')) {
+	class Node extends Node84 {
+	}
+}
+else {
+	class Node extends Node83 {
+	}
 }
diff --git a/src/Node83.php b/src/Node83.php
new file mode 100644
index 00000000..91a2a683
--- /dev/null
+++ b/src/Node83.php
@@ -0,0 +1,40 @@
+<?php
+// phpcs:ignoreFile
+namespace Gt\Dom;
+
+use DOMNode;
+
+class Node83 extends DOMNode {
+	use NonDocumentTypeChildNode;
+	use ChildNode;
+	use ParentNode;
+	use RegisteredNodeClass;
+
+	const TYPE_ELEMENT = XML_ELEMENT_NODE;
+	const TYPE_ATTR = XML_ATTRIBUTE_NODE;
+	const TYPE_TEXT = XML_TEXT_NODE;
+	const TYPE_CDATA = XML_CDATA_SECTION_NODE;
+	const TYPE_ENTITY_REF = XML_ENTITY_REF_NODE;
+	const TYPE_ENTITY = XML_ENTITY_NODE;
+	const TYPE_PI = XML_PI_NODE;
+	const TYPE_COMMENT = XML_COMMENT_NODE;
+	const TYPE_DOCUMENT = XML_DOCUMENT_NODE;
+	const TYPE_DOCUMENT_TYPE = XML_DOCUMENT_TYPE_NODE;
+	const TYPE_DOCUMENT_FRAGMENT = XML_DOCUMENT_FRAG_NODE;
+	const TYPE_NOTATION = XML_NOTATION_NODE;
+	const TYPE_HTML_DOCUMENT = XML_HTML_DOCUMENT_NODE;
+	const TYPE_DTD = XML_DTD_NODE;
+	const TYPE_ELEMENT_DECL = XML_ELEMENT_DECL_NODE;
+	const TYPE_ATTRIBUTE_DECL = XML_ATTRIBUTE_DECL_NODE;
+	const TYPE_ENTITY_DECL = XML_ENTITY_DECL_NODE;
+	const TYPE_NAMESPACE_DECL = XML_NAMESPACE_DECL_NODE;
+
+	public const DOCUMENT_POSITION_DISCONNECTED = 0b000001;
+	public const DOCUMENT_POSITION_PRECEDING = 0b000010;
+	public const DOCUMENT_POSITION_FOLLOWING = 0b000100;
+	public const DOCUMENT_POSITION_CONTAINS = 0b001000;
+	public const DOCUMENT_POSITION_CONTAINED_BY = 0b010000;
+	public const DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC = 0b100000;
+
+	private function __construct() {}
+}
diff --git a/src/Node84.php b/src/Node84.php
new file mode 100644
index 00000000..bb227791
--- /dev/null
+++ b/src/Node84.php
@@ -0,0 +1,40 @@
+<?php
+// phpcs:ignoreFile
+namespace Gt\Dom;
+
+use DOMNode;
+
+class Node84 extends DOMNode {
+	use NonDocumentTypeChildNode;
+	use ChildNode;
+	use ParentNode;
+	use RegisteredNodeClass;
+
+	const TYPE_ELEMENT = XML_ELEMENT_NODE;
+	const TYPE_ATTR = XML_ATTRIBUTE_NODE;
+	const TYPE_TEXT = XML_TEXT_NODE;
+	const TYPE_CDATA = XML_CDATA_SECTION_NODE;
+	const TYPE_ENTITY_REF = XML_ENTITY_REF_NODE;
+	const TYPE_ENTITY = XML_ENTITY_NODE;
+	const TYPE_PI = XML_PI_NODE;
+	const TYPE_COMMENT = XML_COMMENT_NODE;
+	const TYPE_DOCUMENT = XML_DOCUMENT_NODE;
+	const TYPE_DOCUMENT_TYPE = XML_DOCUMENT_TYPE_NODE;
+	const TYPE_DOCUMENT_FRAGMENT = XML_DOCUMENT_FRAG_NODE;
+	const TYPE_NOTATION = XML_NOTATION_NODE;
+	const TYPE_HTML_DOCUMENT = XML_HTML_DOCUMENT_NODE;
+	const TYPE_DTD = XML_DTD_NODE;
+	const TYPE_ELEMENT_DECL = XML_ELEMENT_DECL_NODE;
+	const TYPE_ATTRIBUTE_DECL = XML_ATTRIBUTE_DECL_NODE;
+	const TYPE_ENTITY_DECL = XML_ENTITY_DECL_NODE;
+	const TYPE_NAMESPACE_DECL = XML_NAMESPACE_DECL_NODE;
+
+	public const int DOCUMENT_POSITION_DISCONNECTED = 0b000001;
+	public const int DOCUMENT_POSITION_PRECEDING = 0b000010;
+	public const int DOCUMENT_POSITION_FOLLOWING = 0b000100;
+	public const int DOCUMENT_POSITION_CONTAINS = 0b001000;
+	public const int DOCUMENT_POSITION_CONTAINED_BY = 0b010000;
+	public const int DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC = 0b100000;
+
+	private function __construct() {}
+}
diff --git a/test/phpunit/NodeTest.php b/test/phpunit/NodeTest.php
index 023b6df4..dac9f98d 100644
--- a/test/phpunit/NodeTest.php
+++ b/test/phpunit/NodeTest.php
@@ -1,7 +1,6 @@
 <?php
 namespace Gt\Dom\Test;
 
-use Gt\Dom\Exception\ClientSideOnlyFunctionalityException;
 use Gt\Dom\Exception\NotFoundErrorException;
 use Gt\Dom\HTMLDocument;
 use Gt\Dom\Node;
@@ -13,7 +12,7 @@
 class NodeTest extends TestCase {
 	public function testCanNotConstruct():void {
 		self::expectException(\Error::class);
-		self::expectExceptionMessage("Call to private Gt\Dom\Node::__construct()");
+		self::expectExceptionMessageMatches("/Call to private Gt.Dom.Node[0-9]*::__construct()/");
 		$className = Node::class;
 		/** @phpstan-ignore-next-line */
 		new $className();
@@ -22,7 +21,13 @@ public function testCanNotConstruct():void {
 	public function testBaseURIClientSideOnly():void {
 		$document = new XMLDocument();
 		$sut = $document->createElement("example");
-		self::assertNull($sut->baseURI);
+
+		if(version_compare(PHP_VERSION, "8.4", ">=")) {
+			self::assertEquals(getcwd() . "/", $sut->baseURI);
+		}
+		else {
+			self::assertNull($sut->baseURI);
+		}
 	}
 
 	public function testChildNodesEmpty():void {
diff --git a/test/phpunit/XMLDocumentTest.php b/test/phpunit/XMLDocumentTest.php
index f31d7712..7d1dffa1 100644
--- a/test/phpunit/XMLDocumentTest.php
+++ b/test/phpunit/XMLDocumentTest.php
@@ -24,7 +24,12 @@ public function testBodyNullOnXML():void {
 
 	public function testToStringEmptyXML():void {
 		$sut = new XMLDocument();
-		self::assertEquals("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<xml/>\n", (string)$sut);
+		if(version_compare(PHP_VERSION, "8.4", ">=")) {
+			self::assertEquals("<?xml version=\"1.0\"?>\n<xml/>\n", (string)$sut);
+		}
+		else {
+			self::assertEquals("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<xml/>\n", (string)$sut);
+		}
 	}
 
 	public function testPropContentTypeEmpty():void {