Merge pull request #6 from phpbench/2023-update

2023 update

Author: dantleech

.github/workflows/ci.yaml

@@ -20,7 +20,7 @@ jobs:
         strategy:
             matrix:
                 php-version:
-                    - '7.2'
+                    - '7.3'
 
         steps:
             -
@@ -50,7 +50,7 @@ jobs:
         strategy:
             matrix:
                 php-version:
-                    - '7.2'
+                    - '7.4'
 
         steps:
             -
@@ -87,7 +87,7 @@ jobs:
         strategy:
             matrix:
                 php-version:
-                    - '7.2'
+                    - '7.4'
 
         steps:
             -
@@ -126,7 +126,6 @@ jobs:
         strategy:
             matrix:
                 php-version:
-                    - '7.2'
                     - '7.3'
                     - '7.4'
                     - '8.0'
@@ -136,7 +135,7 @@ jobs:
                 with-examples: ['yes']
                 allow-failures: [false]
                 include:
-                    - php-version: '7.2'
+                    - php-version: '7.3'
                       dependency: 'lowest'
                       with-examples: 'no'
                       allow-failures: false

.gitignore

@@ -1,4 +1,4 @@
 composer.lock
 vendor
 .phpunit.result.cache
-.php_cs.cache
+.php-cs-fixer.cache

.php_cs.dist renamed to .php-cs-fixer.dist.php

@@ -1,28 +1,31 @@
 <?php
 
-$finder = PhpCsFixer\Finder::create()
+use PhpCsFixer\Finder;
+use PhpCsFixer\Config;
+
+$finder = Finder::create()
     ->in([
         __DIR__ . '/lib',
         __DIR__ . '/tests',
     ])
-    ->exclude([
-        'Attributes'
-    ])
 ;
 
-return PhpCsFixer\Config::create()
+return (new Config())
     ->setRiskyAllowed(true)
     ->setRules([
-        '@PSR2' => true,
+        '@PSR12' => true,
         'void_return' => true,
-        'binary_operator_spaces' => [ 'align_double_arrow' => false ],
+        'binary_operator_spaces' => [
+            'operators' => [
+                '=>' => null
+            ],
+        ],
         'blank_line_before_statement' => [
             'statements' => [
                 'break',
                 'continue',
                 'declare',
                 'default',
-                'die',
                 'do',
                 'exit',
                 'for',
@@ -41,11 +44,8 @@
                 'yield',
             ],
         ],
-        'ordered_imports' => true,
         'concat_space' => false,
-        'method_argument_space' => false,
         'no_unused_imports' => true,
-        'ordered_imports' => true,
         'php_unit_set_up_tear_down_visibility' => true,
         'phpdoc_align' => [],
         'phpdoc_indent' => false,

composer.json

@@ -9,13 +9,13 @@
         }
     ],
     "require": {
-        "php": "^7.2||^8.0",
+        "php": "^7.3||^8.0",
         "ext-dom": "*"
     },
     "require-dev": {
+        "friendsofphp/php-cs-fixer": "^3.14",
         "phpunit/phpunit": "^8.0||^9.0",
-        "phpstan/phpstan": "^0.12.83",
-        "friendsofphp/php-cs-fixer": "^2.18"
+        "phpstan/phpstan": "^1.10"
     },
     "autoload": {
         "psr-4": {

lib/Document.php

@@ -27,7 +27,7 @@ class Document extends \DOMDocument implements XPathAware
 
     /**
      * @param string $version
-     * @param mixed  $encoding
+     * @param string $encoding
      */
     public function __construct($version = '1.0', $encoding = null)
     {
@@ -79,13 +79,13 @@ public function query($query, DOMNode $context = null): DOMNodeList
     /**
      * {@inheritdoc}
      */
-    public function queryOne($query, DOMNode $context = null)
+    public function queryOne($query, DOMNode $context = null): ?Element
     {
         return $this->xpath()->queryOne($query, $context);
     }
 
     /**
-     * {@inheritdoc}
+     * @return mixed
      */
     public function evaluate($expression, DOMNode $context = null)
     {
@@ -99,7 +99,7 @@ public function evaluate($expression, DOMNode $context = null)
     public function dump(): string
     {
         $this->formatOutput = true;
-        $result = $this->saveXml();
+        $result = $this->saveXML();
         $this->formatOutput = false;
 
         if (false === $result) {
@@ -112,9 +112,12 @@ public function dump(): string
     public function duplicate(): Document
     {
         $dom = new self();
-        $firstChild = $dom->importNode($this->firstChild, true);
 
-        $dom->appendChild($firstChild);
+        if ($this->firstChild) {
+            $firstChild = $dom->importNode($this->firstChild, true);
+            $dom->appendChild($firstChild);
+        }
+
 
         return $dom;
     }

lib/Element.php

@@ -21,36 +21,26 @@ class Element extends \DOMElement implements XPathAware
 {
     /**
      * Create and append a text-node with the given name and value.
-     *
-     * @param string $name
-     * @param string $value
-     *
-     * @return Element
      */
-    public function appendTextNode($name, $value)
+    public function appendTextNode(string $name, ?string $value): Element
     {
         $el = new self($name);
         $element = $this->appendChild($el);
         assert($element instanceof Element);
-        
+
         $element->appendChild(
-            $this->owner()->createTextNode($value)
+            $this->owner()->createTextNode($value ?? '')
         );
 
         return $element;
     }
-    
+
     /**
      * Create and append an element with the given name and optionally given value.
      *
      * Note: The value will not be escaped. Use DOMDocument::createTextNode() to create a text node with escaping support.
-     *
-     * @param string $name
-     * @param mixed  $value
-     *
-     * @return Element
      */
-    public function appendElement($name, $value = null)
+    public function appendElement(string $name, ?string $value = null): Element
     {
         $element = $this->appendChild(new self($name, $value));
         assert($element instanceof Element);
@@ -66,13 +56,13 @@ public function query($xpath, DOMNode $context = null): DOMNodeList
         return $this->owner()->xpath()->query($xpath, $context ?: $this);
     }
 
-    public function queryOne($xpath, DOMNode $context = null)
+    public function queryOne($xpath, DOMNode $context = null): ?Element
     {
         return $this->owner()->xpath()->queryOne($xpath, $context ?: $this);
     }
 
     /**
-     * {@inheritdoc}
+     * @return mixed
      */
     public function evaluate($expression, DOMNode $context = null)
     {

lib/XPath.php

@@ -22,6 +22,9 @@ class XPath extends \DOMXPath
 {
     /**
      * {@inheritdoc}
+     *
+     * @param mixed $contextnode
+     * @param bool $registerNodeNS
      */
     #[\ReturnTypeWillChange]
     public function evaluate($expression, $contextnode = null, $registerNodeNS = true)
@@ -32,12 +35,21 @@ public function evaluate($expression, $contextnode = null, $registerNodeNS = tru
     }
 
     /**
+     * @param bool $registerNodeNS
+     * @param mixed $contextnode
+     *
      * @return DOMNodeList<DOMNode>
      */
     #[\ReturnTypeWillChange]
-    public function query($expression, $contextnode = null, $registerNodeNS = true)
+    public function query($expression, $contextnode = null, $registerNodeNS = true): DOMNodeList
     {
-        return $this->execute('query', 'query', $expression, $contextnode, $registerNodeNS);
+        $list = $this->execute('query', 'query', $expression, $contextnode, $registerNodeNS);
+
+        if (!$list instanceof DOMNodeList) {
+            throw new RuntimeException(sprintf('Expected XPAth expression to return DOMNodeList, got "%s"', is_object($list) ? get_class($list) : gettype($list)));
+        }
+
+        return $list;
     }
 
     public function queryOne(string $expr, DOMNode $contextEl = null, bool $registerNodeNs = false): ?Element
@@ -54,7 +66,7 @@ public function queryOne(string $expr, DOMNode $contextEl = null, bool $register
             throw new RuntimeException(sprintf(
                 'Expected "%s" but got "%s"',
                 Element::class,
-                get_class($node)
+                $node ? get_class($node) : gettype($node)
             ));
         }
 
@@ -64,10 +76,12 @@ public function queryOne(string $expr, DOMNode $contextEl = null, bool $register
     /**
      * Execute the given xpath method and cactch any errors.
      *
+     * @param mixed $contextEl
+     *
      * @return mixed
      */
     #[\ReturnTypeWillChange]
-    private function execute(string $method, string $context, string $query, DOMNode $contextEl = null, bool $registerNodeNs = false)
+    private function execute(string $method, string $context, string $query, $contextEl = null, bool $registerNodeNs = false)
     {
         libxml_use_internal_errors(true);
 
@@ -85,7 +99,10 @@ private function execute(string $method, string $context, string $query, DOMNode
 
             throw new Exception\InvalidQueryException(sprintf(
                 'Errors encountered when evaluating XPath %s "%s": %s%s',
-                $context, $query, PHP_EOL, implode(PHP_EOL, $errors)
+                $context,
+                $query,
+                PHP_EOL,
+                implode(PHP_EOL, $errors)
             ));
         }
 

phpstan.neon

@@ -0,0 +1,4 @@
+parameters:
+    level: max
+    paths:
+        - lib

tests/Unit/ElementTest.php

@@ -35,7 +35,7 @@ public function testAppendElement(): void
         $this->assertInstanceOf('PhpBench\Dom\Element', $element);
         $this->assertEquals(1, $result);
     }
-    
+
     /**
      * It should create and append text.
      */
@@ -106,7 +106,7 @@ public function testDumpNode(): void
 </test>
 
 EOT
-        , $dump);
+            , $dump);
     }
 
     private function getXml()