Added PHP 8.0 compatibility

grizz-it · Feb 23, 2021 · 3481c3e · 3481c3e
1 parent c3b0bee
commit 3481c3e
Show file tree

Hide file tree

Showing 14 changed files with 98 additions and 82 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -1,11 +1,8 @@
 language: php
 php:
-    - '7.2'
-    - '7.3'
-    - '7.4'
+    - '8.0'
 
 before_script:
-    - yes '' | pecl install yaml
     - composer install
 
 script:

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 1.2.0 - 2021-02-23
+### Added
+- Compatibility for PHP 8.0
+
 ## 1.1.0 - 2020-06-08
 ### Added
 - Separate method reflector.
@@ -15,5 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Initial implementation of the object factory package.
 
-- [1.1.0 > Unreleased](https://github.com/grizz-it/object-factory/compare/1.1.0...HEAD)
+# Versions
+- [1.2.0 > Unreleased](https://github.com/grizz-it/object-factory/compare/1.2.0...HEAD)
+- [1.1.0 > 1.2.0](https://github.com/grizz-it/object-factory/compare/1.1.0...1.2.0)
 - [1.0.0 > 1.1.0](https://github.com/grizz-it/object-factory/compare/1.0.0...1.1.0)
diff --git a/composer.json b/composer.json
@@ -1,56 +1,51 @@
 {
-    "name": "grizz-it/object-factory",
-    "description": "An object factory for PHP applications.",
-    "keywords": ["object-factory"],
-    "type": "library",
-    "license": "MIT",
-    "prefer-stable": true,
-    "minimum-stability": "stable",
-    "require":
+  "name": "grizz-it/object-factory",
+  "description": "An object factory for PHP applications.",
+  "keywords": [
+    "object-factory"
+  ],
+  "type": "library",
+  "license": "MIT",
+  "prefer-stable": true,
+  "minimum-stability": "stable",
+  "require": {
+    "php": "^8.0",
+    "grizz-it/storage": "^1.1"
+  },
+  "authors": [
     {
-        "php": "^7.2",
-        "grizz-it/storage": "^1.0"
-    },
-    "authors": [
-    {
-        "name": "GrizzIT",
-        "homepage": "https://www.grizzit.com/",
-        "role": "Developer"
-    }],
-    "config":
-    {
-        "sort-packages": true
-    },
-    "autoload":
-    {
-        "psr-4":
-        {
-            "GrizzIt\\ObjectFactory\\": "src/"
-        }
-    },
-    "autoload-dev":
-    {
-        "psr-4":
-        {
-            "GrizzIt\\ObjectFactory\\Tests\\": "tests/"
-        }
-    },
-    "archive":
-    {
-        "exclude": [
-            "/tests",
-            "/.gitignore",
-            "/.travis.yml",
-            "/phpunit.xml",
-            "/phpcs.xml",
-            "/PULL_REQUEST_TEMPLATE.md",
-            "/CODE_OF_CONDUCT.md",
-            "/CONTRIBUTING.md"
-        ]
-    },
-    "require-dev":
-    {
-        "phpunit/phpunit": "^8.0",
-        "squizlabs/php_codesniffer": "^3.4"
+      "name": "GrizzIT",
+      "homepage": "https://www.grizzit.com/",
+      "role": "Developer"
+    }
+  ],
+  "config": {
+    "sort-packages": true
+  },
+  "autoload": {
+    "psr-4": {
+      "GrizzIt\\ObjectFactory\\": "src/"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "GrizzIt\\ObjectFactory\\Tests\\": "tests/"
     }
-}
+  },
+  "archive": {
+    "exclude": [
+      "/tests",
+      "/.gitignore",
+      "/.travis.yml",
+      "/phpunit.xml",
+      "/phpcs.xml",
+      "/PULL_REQUEST_TEMPLATE.md",
+      "/CODE_OF_CONDUCT.md",
+      "/CONTRIBUTING.md"
+    ]
+  },
+  "require-dev": {
+    "phpunit/phpunit": "^9.5",
+    "squizlabs/php_codesniffer": "^3.5"
+  }
+}
diff --git a/phpcs.xml b/phpcs.xml
@@ -8,5 +8,7 @@
     <arg name="colors" />
     <arg value="s" />
 
-    <rule ref="PSR12" />
+    <rule ref="PSR12">
+        <exclude name="PSR1.Files.SideEffects.FoundWithSymbols"/>
+    </rule>
 </ruleset>
diff --git a/phpunit.xml b/phpunit.xml
@@ -1,15 +1,16 @@
+<?xml version="1.0"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
          bootstrap="vendor/autoload.php"
          cacheResult="false">
-    <testsuites>
-        <testsuite name="default">
-            <directory>tests</directory>
-        </testsuite>
-    </testsuites>
-    <filter>
-        <whitelist processUncoveredFilesFromWhitelist="true">
-            <directory suffix=".php">src</directory>
-        </whitelist>
-    </filter>
+  <coverage processUncoveredFiles="true">
+    <include>
+      <directory suffix=".php">src</directory>
+    </include>
+  </coverage>
+  <testsuites>
+    <testsuite name="default">
+      <directory>tests</directory>
+    </testsuite>
+  </testsuites>
 </phpunit>
diff --git a/src/Common/ClassAnalyserInterface.php b/src/Common/ClassAnalyserInterface.php
@@ -12,6 +12,8 @@ interface ClassAnalyserInterface
     /**
      * Analyses the constructor of a class and returns a configuration array.
      *
+     * @param string $class
+     *
      * @return array
      */
     public function analyse(string $class): array;

diff --git a/src/Common/MethodReflectorInterface.php b/src/Common/MethodReflectorInterface.php
@@ -12,6 +12,9 @@ interface MethodReflectorInterface
     /**
      * Analyses a method of a class and returns a configuration array.
      *
+     * @param string $class
+     * @param string $method
+     *
      * @return array
      */
     public function reflect(string $class, string $method): array;

diff --git a/src/Common/ObjectFactoryInterface.php b/src/Common/ObjectFactoryInterface.php
@@ -12,6 +12,9 @@ interface ObjectFactoryInterface
     /**
      * Creates an instance of an object.
      *
+     * @param string $class
+     * @param array $parameters
+     *
      * @return object
      */
     public function create(string $class, array $parameters): object;

diff --git a/src/Component/Analyser/ClassAnalyser.php b/src/Component/Analyser/ClassAnalyser.php
@@ -21,14 +21,14 @@ class ClassAnalyser implements ClassAnalyserInterface
      *
      * @var StorageInterface
      */
-    private $analysisStorage;
+    private StorageInterface $analysisStorage;
 
     /**
      * Contains the method reflector.
      *
      * @var MethodReflectorInterface
      */
-    private $methodReflector;
+    private MethodReflectorInterface $methodReflector;
 
     /**
      * Constructor
@@ -49,6 +49,8 @@ public function __construct(
     /**
      * Analyses the constructor of a class and returns a configuration array.
      *
+     * @param string $class
+     *
      * @return array
      *
      * @throws NonInstantiableClassException When the analysed class is not instantiable.

diff --git a/src/Component/Reflector/MethodReflector.php b/src/Component/Reflector/MethodReflector.php
@@ -18,7 +18,7 @@ class MethodReflector implements MethodReflectorInterface
      *
      * @var array
      */
-    private $translations = [
+    private array $translations = [
         'bool' => 'boolean',
         'int' => 'integer',
         'float' => 'double',
@@ -30,7 +30,7 @@ class MethodReflector implements MethodReflectorInterface
      *
      * @var StorageInterface
      */
-    private $analysisStorage;
+    private StorageInterface $analysisStorage;
 
     /**
      * Constructor
@@ -45,6 +45,9 @@ public function __construct(StorageInterface $analysisStorage)
     /**
      * Analyses a method of a class and returns a configuration array.
      *
+     * @param string $class
+     * @param string $method
+     *
      * @return array
      */
     public function reflect(string $class, string $method): array

diff --git a/src/Exception/InvalidParameterTypeException.php b/src/Exception/InvalidParameterTypeException.php
@@ -21,7 +21,7 @@ class InvalidParameterTypeException extends Exception
      */
     public function __construct(
         array $parameterConfig,
-        $parameter,
+        mixed $parameter,
         Throwable $previous = null
     ) {
         parent::__construct(

diff --git a/src/Exception/MissingParameterException.php b/src/Exception/MissingParameterException.php
@@ -16,7 +16,6 @@ class MissingParameterException extends Exception
      * Constructor.
      *
      * @param array $parameterConfig
-     * @param mixed $parameter
      * @param Throwable $previous
      */
     public function __construct(

diff --git a/src/Exception/NonInstantiableClassException.php b/src/Exception/NonInstantiableClassException.php
@@ -15,8 +15,6 @@ class NonInstantiableClassException extends Exception
      * Constructor.
      *
      * @param array $parameterConfig
-     * @param mixed $parameter
-     * @param Throwable $previous
      */
     public function __construct(
         string $class

diff --git a/src/Factory/ObjectFactory.php b/src/Factory/ObjectFactory.php
@@ -21,7 +21,7 @@ class ObjectFactory implements ObjectFactoryInterface
      *
      * @var ClassAnalyserInterface
      */
-    private $classAnalyser;
+    private ClassAnalyserInterface $classAnalyser;
 
     /**
      * Constructor.
@@ -78,6 +78,9 @@ public function create(string $class, array $parameters): object
      * Converts the parameter order based on the configuration and returns a
      * array which can be passed variadically.
      *
+     * @param array $config
+     * @param array $parameters
+     *
      * @return array
      */
     private function translate(array $config, array $parameters): array
@@ -117,7 +120,7 @@ private function translate(array $config, array $parameters): array
         return $invokeParameters;
     }
 
-        /**
+    /**
      * Checks the parameter type.
      *
      * @param array $parameterConfig
@@ -127,8 +130,10 @@ private function translate(array $config, array $parameters): array
      *
      * @throws InvalidParameterTypeException When the type can not be resolved.
      */
-    private function parameterByType(array $parameterConfig, $parameter)
-    {
+    private function parameterByType(
+        array $parameterConfig,
+        mixed $parameter
+    ): mixed {
         if ($parameterConfig['builtin']) {
             if (
                 gettype(