Merge pull request #31 from fezfez/php8.4

Add support for PHP 8.4 and Upgrade Laminas coding standard to ^3.0
laminas · Nov 17, 2024 · b79e7db · b79e7db
2 parents a63590b + c87b931
commit b79e7db
Show file tree

Hide file tree

Showing 29 changed files with 563 additions and 597 deletions.
diff --git a/.laminas-ci.json b/.laminas-ci.json
@@ -1,5 +1,5 @@
 {
     "ignore_php_platform_requirements": {
-        "8.3": true
+        "8.4": true
     }
 }
diff --git a/composer.json b/composer.json
@@ -21,21 +21,21 @@
             "dealerdirect/phpcodesniffer-composer-installer": true
         },
         "platform": {
-            "php": "8.0.99"
+            "php": "8.1.99"
         }
     },
     "require": {
-        "php": "~8.0.0 || ~8.1.0 || ~8.2.0 || ~8.3.0",
+        "php": "~8.1.0 || ~8.2.0 || ~8.3.0 || ~8.4.0",
         "ext-json": "*",
         "laminas/laminas-stdlib": "^3.6",
         "psr/container": "^1.0"
     },
     "require-dev": {
-        "laminas/laminas-coding-standard": "~2.4.0",
-        "laminas/laminas-filter": "~2.23.0",
-        "laminas/laminas-i18n": "~2.19.0",
-        "laminas/laminas-servicemanager": "~3.19.0",
-        "phpunit/phpunit": "~9.5.25"
+        "laminas/laminas-coding-standard": "^3.0.1",
+        "laminas/laminas-filter": "^2.39.0",
+        "laminas/laminas-i18n": "^2.29.0",
+        "laminas/laminas-servicemanager": "^3.23.0",
+        "phpunit/phpunit": "^10.5.38"
     },
     "conflict": {
         "container-interop/container-interop": "<1.2.0",

diff --git a/composer.lock b/composer.lock
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,25 +1,32 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit
-    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
-    bootstrap="vendor/autoload.php"
-    colors="true">
-    <coverage processUncoveredFiles="true">
-        <include>
-            <directory suffix=".php">./src</directory>
-        </include>
-    </coverage>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+         bootstrap="./vendor/autoload.php"
+         colors="true"
+         cacheDirectory=".phpunit.cache"
+         failOnDeprecation="true"
+         failOnNotice="true"
+         failOnWarning="true"
+         failOnPhpunitDeprecation="false"
+         displayDetailsOnPhpunitDeprecations="true"
+         displayDetailsOnTestsThatTriggerDeprecations="true"
+         displayDetailsOnTestsThatTriggerNotices="true"
+         displayDetailsOnTestsThatTriggerWarnings="true">
 
-    <testsuites>
-        <testsuite name="laminas-config Test Suite">
-            <directory>./test</directory>
-        </testsuite>
-    </testsuites>
-
-    <php>
-        <env name="TESTS_LAMINAS_CONFIG_YAML_ENABLED" value="false"/>
-        <env name="TESTS_LAMINAS_CONFIG_YAML_LIB_INCLUDE" value=""/>
-        <env name="TESTS_LAMINAS_CONFIG_WRITER_YAML_CALLBACK" value=""/>
-        <env name="TESTS_LAMINAS_CONFIG_READER_YAML_CALLBACK" value=""/>
-    </php>
+  <testsuites>
+    <testsuite name="laminas-config Test Suite">
+      <directory>./test</directory>
+    </testsuite>
+  </testsuites>
+  <php>
+    <env name="TESTS_LAMINAS_CONFIG_YAML_ENABLED" value="false"/>
+    <env name="TESTS_LAMINAS_CONFIG_YAML_LIB_INCLUDE" value=""/>
+    <env name="TESTS_LAMINAS_CONFIG_WRITER_YAML_CALLBACK" value=""/>
+    <env name="TESTS_LAMINAS_CONFIG_READER_YAML_CALLBACK" value=""/>
+  </php>
+  <source>
+    <include>
+      <directory suffix=".php">./src</directory>
+    </include>
+  </source>
 </phpunit>
diff --git a/src/AbstractConfigFactory.php b/src/AbstractConfigFactory.php
@@ -81,7 +81,6 @@ public function createServiceWithName(ServiceLocatorInterface $serviceLocator, $
      * Create service with name (SM v3)
      *
      * @param string $requestedName
-     * @param array $options
      * @return string|mixed|array
      */
     public function __invoke(Containerinterface $container, $requestedName, ?array $options = null)

diff --git a/src/Config.php b/src/Config.php
@@ -53,7 +53,6 @@ class Config implements Countable, Iterator, ArrayAccess
      * Data is read-only unless $allowModifications is set to true
      * on construction.
      *
-     * @param  array   $array
      * @param  bool $allowModifications
      */
     public function __construct(array $array, $allowModifications = false)

diff --git a/src/Factory.php b/src/Factory.php
@@ -145,7 +145,6 @@ public static function fromFile($filename, $returnConfigObject = false, $useIncl
     /**
      * Read configuration from multiple files and merge them.
      *
-     * @param  array   $files
      * @param  bool $returnConfigObject
      * @param  bool $useIncludePath
      * @return array|Config

diff --git a/src/Processor/Constant.php b/src/Processor/Constant.php
@@ -97,7 +97,6 @@ public function getTokens()
      * the class constant value; otherwise, delegates to the parent.
      *
      * @param mixed $value
-     * @param array $replacements
      * @return mixed
      */
     protected function doProcess($value, array $replacements)

diff --git a/src/Processor/Token.php b/src/Processor/Token.php
@@ -250,7 +250,6 @@ public function processValue($value)
      * Applies replacement map to the given value by modifying the value itself
      *
      * @param mixed $value
-     * @param array $replacements
      * @return mixed
      * @throws Exception\InvalidArgumentException If the provided value is a read-only {@see Config}.
      */

diff --git a/src/Reader/Ini.php b/src/Reader/Ini.php
@@ -214,7 +214,6 @@ function ($error, $message = '') {
     /**
      * Process data from the parsed ini file.
      *
-     * @param  array $data
      * @return array
      */
     protected function process(array $data)
@@ -261,7 +260,6 @@ private function buildNestedSection($sections, $value)
     /**
      * Process a section.
      *
-     * @param  array $section
      * @return array
      */
     protected function processSection(array $section)
@@ -280,7 +278,6 @@ protected function processSection(array $section)
      *
      * @param  string $key
      * @param  string $value
-     * @param  array  $config
      * @throws Exception\RuntimeException
      */
     protected function processKey($key, $value, array &$config)

diff --git a/src/Reader/JavaProperties.php b/src/Reader/JavaProperties.php
@@ -120,7 +120,6 @@ public function fromString($string)
     /**
      * Process the array for @include
      *
-     * @param  array $data
      * @return array
      * @throws Exception\RuntimeException If an @include key is found.
      */

diff --git a/src/Reader/Json.php b/src/Reader/Json.php
@@ -80,7 +80,6 @@ public function fromString($string)
     /**
      * Process the array for @include
      *
-     * @param  array $data
      * @return array
      * @throws Exception\RuntimeException
      */

diff --git a/src/Reader/Yaml.php b/src/Reader/Yaml.php
@@ -142,7 +142,6 @@ public function fromString($string)
     /**
      * Process the array for @include
      *
-     * @param  array $data
      * @return array
      * @throws Exception\RuntimeException
      */

diff --git a/src/Writer/AbstractWriter.php b/src/Writer/AbstractWriter.php
@@ -81,7 +81,6 @@ public function toString($config)
     }
 
     /**
-     * @param array $config
      * @return string
      */
     abstract protected function processConfig(array $config);

diff --git a/src/Writer/Ini.php b/src/Writer/Ini.php
@@ -79,7 +79,6 @@ public function shouldRenderWithoutSections()
     /**
      * processConfig(): defined by AbstractWriter.
      *
-     * @param  array $config
      * @return string
      */
     public function processConfig(array $config)
@@ -111,7 +110,6 @@ public function processConfig(array $config)
     /**
      * Add a branch to an INI string recursively.
      *
-     * @param  array $config
      * @param  array $parents
      * @return string
      */
@@ -163,7 +161,6 @@ protected function prepareValue($value)
      * Root elements that are not assigned to any section needs to be on the
      * top of config.
      *
-     * @param  array $config
      * @return array
      */
     protected function sortRootElements(array $config)

diff --git a/src/Writer/JavaProperties.php b/src/Writer/JavaProperties.php
@@ -41,7 +41,6 @@ public function __construct($delimiter = self::DELIMITER_DEFAULT)
     /**
      * processConfig(): defined by AbstractWriter.
      *
-     * @param  array $config
      * @return string
      * @throws Exception\UnprocessableConfigException For non-scalar values in the $config array.
      */

diff --git a/src/Writer/Json.php b/src/Writer/Json.php
@@ -15,7 +15,6 @@ class Json extends AbstractWriter
     /**
      * processConfig(): defined by AbstractWriter.
      *
-     * @param  array $config
      * @return string
      * @throws Exception\RuntimeException If encoding errors occur.
      */

diff --git a/src/Writer/PhpArray.php b/src/Writer/PhpArray.php
@@ -43,7 +43,6 @@ class PhpArray extends AbstractWriter
     /**
      * processConfig(): defined by AbstractWriter.
      *
-     * @param  array $config
      * @return string
      */
     public function processConfig(array $config)
@@ -142,8 +141,6 @@ function ($error, $message = '') use ($filename) {
     /**
      * Recursively processes a PHP config array structure into a readable format.
      *
-     * @param  array $config
-     * @param  array $arraySyntax
      * @param  int   $indentLevel
      * @return string
      */

diff --git a/src/Writer/Xml.php b/src/Writer/Xml.php
@@ -14,7 +14,6 @@ class Xml extends AbstractWriter
     /**
      * processConfig(): defined by AbstractWriter.
      *
-     * @param  array $config
      * @return string
      */
     public function processConfig(array $config)
@@ -45,7 +44,6 @@ public function processConfig(array $config)
      * Add a branch to an XML object recursively.
      *
      * @param  string    $branchName
-     * @param  array     $config
      * @return void
      * @throws Exception\RuntimeException
      */

diff --git a/src/Writer/Yaml.php b/src/Writer/Yaml.php
@@ -62,7 +62,6 @@ public function setYamlEncoder($yamlEncoder)
     /**
      * processConfig(): defined by AbstractWriter.
      *
-     * @param  array $config
      * @return string
      * @throws Exception\RuntimeException
      */

diff --git a/test/ConfigTest.php b/test/ConfigTest.php
@@ -22,6 +22,14 @@
  */
 class ConfigTest extends TestCase
 {
+    private array $all;
+    private array $numericData;
+    private array $menuData1;
+    private array $toCombineA;
+    private array $toCombineB;
+    private array $leadingdot;
+    private array $invalidkey;
+
     protected function setUp(): void
     {
         // Arrays representing common config configurations

diff --git a/test/FactoryTest.php b/test/FactoryTest.php
@@ -14,7 +14,7 @@
 use Laminas\Config\WriterPluginManager;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
-use ReflectionProperty;
+use ReflectionClass;
 use RuntimeException;
 
 use function chmod;
@@ -43,10 +43,10 @@ class FactoryTest extends TestCase
      */
     protected function getTestAssetFileName($ext)
     {
-        if (empty($this->tmpfiles[$ext])) {
-            $this->tmpfiles[$ext] = tempnam(sys_get_temp_dir(), 'laminas-config-writer') . '.' . $ext;
+        if (empty($this->tmpFiles[$ext])) {
+            $this->tmpFiles[$ext] = tempnam(sys_get_temp_dir(), 'laminas-config-writer') . '.' . $ext;
         }
-        return $this->tmpfiles[$ext];
+        return $this->tmpFiles[$ext];
     }
 
     protected function setUp(): void
@@ -74,11 +74,9 @@ protected function tearDown(): void
 
     public function resetPluginManagers()
     {
-        foreach (['readers', 'writers'] as $pluginManager) {
-            $r = new ReflectionProperty(Factory::class, $pluginManager);
-            $r->setAccessible(true);
-            $r->setValue(null);
-        }
+        $reflectionClass = new ReflectionClass(Factory::class);
+        $reflectionClass->setStaticPropertyValue('writers', null);
+        $reflectionClass->setStaticPropertyValue('readers', null);
     }
 
     public function testFromIni()

diff --git a/test/Processor/ConstantTest.php b/test/Processor/ConstantTest.php
@@ -21,7 +21,7 @@ class ConstantTest extends TestCase
     /**
      * @return array
      */
-    public function constantProvider()
+    public static function constantProvider()
     {
         if (! defined('LAMINAS_CONFIG_PROCESSOR_CONSTANT_TEST')) {
             define('LAMINAS_CONFIG_PROCESSOR_CONSTANT_TEST', 'test-key');

diff --git a/test/Reader/JavaPropertiesTest.php b/test/Reader/JavaPropertiesTest.php
@@ -90,7 +90,7 @@ public function testAllowsSpecifyingAlternateKeyValueDelimiter()
     /**
      * @return array
      */
-    public function invalidDelimiters()
+    public static function invalidDelimiters()
     {
         return [
             'null'         => [null],

diff --git a/test/ReaderPluginManagerCompatibilityTest.php b/test/ReaderPluginManagerCompatibilityTest.php
@@ -18,7 +18,7 @@ class ReaderPluginManagerCompatibilityTest extends TestCase
     /**
      * @return ReaderPluginManager
      */
-    protected function getPluginManager()
+    protected static function getPluginManager()
     {
         return new ReaderPluginManager(new ServiceManager());
     }

diff --git a/test/StandaloneReaderPluginManagerTest.php b/test/StandaloneReaderPluginManagerTest.php
@@ -16,7 +16,7 @@ class StandaloneReaderPluginManagerTest extends TestCase
     /**
      * @return string[][]
      */
-    public function supportedConfigExtensions()
+    public static function supportedConfigExtensions()
     {
         return [
             'ini'            => ['ini', Reader\Ini::class],
@@ -53,7 +53,7 @@ public function testCanRetrieveReaderByExtension($extension, $expectedType)
     /**
      * @return string[][]
      */
-    public function supportedConfigClassNames()
+    public static function supportedConfigClassNames()
     {
         return [
             Reader\Ini::class            => [Reader\Ini::class],

diff --git a/test/StandaloneWriterPluginManagerTest.php b/test/StandaloneWriterPluginManagerTest.php
@@ -16,7 +16,7 @@ class StandaloneWriterPluginManagerTest extends TestCase
     /**
      * @return string[][]
      */
-    public function supportedConfigTypes()
+    public static function supportedConfigTypes()
     {
         return [
             'ini'      => ['ini', Writer\Ini::class],
@@ -55,7 +55,7 @@ public function testCanRetrieveWriterByType($type, $expectedType)
     /**
      * @return string[][]
      */
-    public function supportedConfigClassNames()
+    public static function supportedConfigClassNames()
     {
         return [
             Writer\Ini::class      => [Writer\Ini::class],

diff --git a/test/Writer/TestAssets/DummyWriter.php b/test/Writer/TestAssets/DummyWriter.php
@@ -11,7 +11,6 @@
 class DummyWriter extends AbstractWriter
 {
     /**
-     * @param array $config
      * @return string
      */
     public function processConfig(array $config)
-Original file line number
+Diff line change
@@ Expand Up / @@ -81,7 +81,6 @@ public function toString($config) @@
         }
         /**
-         * @param array $config
          * @return string
          */
         abstract protected function processConfig(array $config);
@@ Expand Down @@