Add PHP 8-only Support (v3) (#162)

* require PHP 8+, PHPUnit 9.5+

* drop PHP 7.x support

* update/add dot files from spatie/package-skeleton-php

* update phpunit config

* use PHP 8 syntax, add typehints, drop unneeded docblocks

* update changelog

* update readme with minor adjustments from skeleton

Author: patinthehat

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+indent_size = 4
+indent_style = space
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{yml,yaml}]
+indent_size = 2

.gitattributes

@@ -1,11 +1,13 @@
-
 # Path-based git attributes
 # https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
 
 # Ignore all test and documentation with "export-ignore".
 /.gitattributes     export-ignore
 /.gitignore         export-ignore
-/.travis.yml        export-ignore
 /phpunit.xml.dist   export-ignore
-/.scrutinizer.yml   export-ignore
-/tests              export-ignore
+/tests              export-ignore
+/.editorconfig      export-ignore
+/.php_cs            export-ignore
+/.github            export-ignore
+/psalm.xml          export-ignore
+

.github/workflows/run-tests.yml

@@ -9,7 +9,7 @@ jobs:
       fail-fast: true
       matrix:
         os: [ubuntu-latest]
-        php: [8.0, 7.4]
+        php: [8.0]
         stability: [prefer-lowest, prefer-stable]
 
     name: P${{ matrix.php }} - ${{ matrix.stability }} - ${{ matrix.os }}
@@ -24,7 +24,7 @@ jobs:
           php-version: ${{ matrix.php }}
           extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick
           coverage: none
-          
+
       - name: Setup problem matchers
         run: |
           echo "::add-matcher::${{ runner.tool_cache }}/php.json"

.gitignore

@@ -1,5 +1,11 @@
+.idea
+.php_cs
+.php_cs.cache
+.phpunit.result.cache
 build
 composer.lock
+coverage
 docs
+phpunit.xml
+psalm.xml
 vendor
-.php_cs.cache

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to `array-to-xml` will be documented in this file
 
+## 3.0.0 - unreleased
+
+- require PHP 8+
+- drop support for PHP 7.x
+- convert syntax to PHP 8
+
 ## 2.16.0 - 2020-11-18
 
 - add escapable colons in custom keys (#151)

README.md

@@ -483,17 +483,17 @@ This will result in:
 vendor/bin/phpunit
 ```
 
-### Changelog
+## Changelog
 
-Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
+Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
 
 ## Contributing
 
-Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
+Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
 
-## Security
+## Security Vulnerabilities
 
-If you discover any security related issues, please email [email protected] instead of using the issue tracker.
+Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
 
 ## Postcardware
 

composer.json

@@ -17,11 +17,11 @@
         }
     ],
     "require": {
-        "php" : "^7.4|^8.0",
+        "php" : "^8.0",
         "ext-dom": "*"
     },
     "require-dev": {
-        "phpunit/phpunit" : "^9.0",
+        "phpunit/phpunit" : "^9.5",
         "mockery/mockery": "^1.2",
         "spatie/phpunit-snapshot-assertions": "^4.2"
     },

phpunit.xml

@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+    backupGlobals="false"
+    backupStaticAttributes="false"
+    bootstrap="vendor/autoload.php"
+    colors="true"
+    convertErrorsToExceptions="true"
+    convertNoticesToExceptions="true"
+    convertWarningsToExceptions="true"
+    processIsolation="false"
+    stopOnFailure="false"
+    executionOrder="random"
+    failOnWarning="true"
+    failOnRisky="true"
+    failOnEmptyTestSuite="true"
+    beStrictAboutOutputDuringTests="true"
+    verbose="true"
+>
+    <testsuites>
+        <testsuite name="Spatie Test Suite">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+    <coverage>
+        <include>
+            <directory suffix=".php">./src</directory>
+        </include>
+        <report>
+            <html outputDirectory="build/coverage"/>
+            <text outputFile="build/coverage.txt"/>
+            <clover outputFile="build/logs/clover.xml"/>
+        </report>
+    </coverage>
+    <logging>
+        <junit outputFile="build/report.junit.xml"/>
+    </logging>
+</phpunit>

phpunit.xml.dist

@@ -9,25 +9,22 @@
 
 class ArrayToXml
 {
-    protected $document;
+    protected DOMDocument $document;
 
-    protected $replaceSpacesByUnderScoresInKeyNames = true;
+    protected bool $replaceSpacesByUnderScoresInKeyNames = true;
 
-    protected $addXmlDeclaration = true;
+    protected bool $addXmlDeclaration = true;
 
-    protected $numericTagNamePrefix = 'numeric_';
+    protected string $numericTagNamePrefix = 'numeric_';
 
-    /**
-     * @param mixed[] $array
-     */
     public function __construct(
         array $array,
-        $rootElement = '',
-        $replaceSpacesByUnderScoresInKeyNames = true,
-        $xmlEncoding = null,
-        $xmlVersion = '1.0',
-        $domProperties = [],
-        $xmlStandalone = null
+        string | array $rootElement = '',
+        bool $replaceSpacesByUnderScoresInKeyNames = true,
+        ?string $xmlEncoding = null,
+        string $xmlVersion = '1.0',
+        array $domProperties = [],
+        ?bool $xmlStandalone = null
     ) {
         $this->document = new DOMDocument($xmlVersion, $xmlEncoding);
 
@@ -57,9 +54,6 @@ public function setNumericTagNamePrefix(string $prefix): void
         $this->numericTagNamePrefix = $prefix;
     }
 
-    /**
-     * @param mixed[] $array
-     */
     public static function convert(
         array $array,
         $rootElement = '',
@@ -162,7 +156,7 @@ private function convertElement(DOMElement $element, $value): void
                     $element->appendChild($fragment);
                 } elseif ($key === '__numeric') {
                     $this->addNumericNode($element, $data);
-                } elseif (substr($key, 0, 9) === '__custom:') {
+                } elseif (str_starts_with($key, '__custom:')) {
                     $this->addNode($element, str_replace('\:', ':', preg_split('/(?<!\\\):/', $key)[1]), $data);
                 } else {
                     $this->addNode($element, $key, $data);
@@ -206,7 +200,7 @@ protected function addCollectionNode(DOMElement $element, $value): void
         $this->convertElement($child, $value);
     }
 
-    protected function addSequentialNode(DOMElement $element, $value)
+    protected function addSequentialNode(DOMElement $element, $value): void
     {
         if (empty($element->nodeValue) && ! is_numeric($element->nodeValue)) {
             $element->nodeValue = htmlspecialchars($value);
@@ -220,10 +214,9 @@ protected function addSequentialNode(DOMElement $element, $value)
     }
 
     /**
-     * @param mixed[] $value
      * @return bool|mixed[]
      */
-    protected function isArrayAllKeySequential($value)
+    protected function isArrayAllKeySequential(array | string $value): mixed
     {
         if (! is_array($value)) {
             return false;