Compatibility with PHP 8.1 & 8.2 (#7)

Speicher210 · May 11, 2023 · c784361 · c784361
1 parent 6046370
commit c784361
Show file tree

Hide file tree

Showing 15 changed files with 55 additions and 68 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -12,12 +12,12 @@ jobs:
     strategy:
       matrix:
         php-versions:
-          - 5.6
-          - 7.1
           - 7.2
           - 7.3
           - 7.4
           - 8.0
+          - 8.1
+          - 8.2
     name: PHP ${{ matrix.php-versions }}
     steps:
       - name: Checkout code

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -25,7 +25,7 @@ We accept contributions via Pull Requests on [Github](https://github.com/Speiche
 ## Running Tests
 
 ``` bash
-$ phpunit
+$ vendor/bin/simple-phpunit
 ```
 
 

diff --git a/README.md b/README.md
@@ -24,7 +24,7 @@ Please see [USAGE](docs/usage.md) for details.
 ## Testing
 
 ``` bash
-$ phpunit
+$ vendor/bin/simple-phpunit
 ```
 
 ## Contributing

diff --git a/composer.json b/composer.json
@@ -17,10 +17,10 @@
     }
   ],
   "require": {
-    "php": ">=5.4"
+    "php": ">=7.2"
   },
   "require-dev": {
-    "symfony/phpunit-bridge": "^5.0",
+    "symfony/phpunit-bridge": "^6.0",
     "scrutinizer/ocular": "~1.1"
   },
   "autoload": {

diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,29 +1,21 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit bootstrap="vendor/autoload.php"
-         backupGlobals="false"
-         backupStaticAttributes="false"
-         colors="true"
-         verbose="true"
-         convertErrorsToExceptions="true"
-         convertNoticesToExceptions="true"
-         convertWarningsToExceptions="true"
-         processIsolation="false"
-         stopOnFailure="false">
-    <testsuites>
-        <testsuite name="Wingu OctopusCore Test Suite">
-            <directory>tests</directory>
-        </testsuite>
-    </testsuites>
-    <filter>
-        <whitelist>
-            <directory suffix=".php">src/</directory>
-        </whitelist>
-    </filter>
-    <logging>
-        <log type="tap" target="build/report.tap"/>
-        <log type="junit" target="build/report.junit.xml"/>
-        <log type="coverage-html" target="build/coverage"/>
-        <log type="coverage-text" target="build/coverage.txt"/>
-        <log type="coverage-clover" target="build/logs/clover.xml"/>
-    </logging>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/autoload.php" backupGlobals="false" backupStaticAttributes="false" colors="true" verbose="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" processIsolation="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+  <coverage>
+    <include>
+      <directory suffix=".php">src/</directory>
+    </include>
+    <report>
+      <clover outputFile="build/logs/clover.xml"/>
+      <html outputDirectory="build/coverage"/>
+      <text outputFile="build/coverage.txt"/>
+    </report>
+  </coverage>
+  <testsuites>
+    <testsuite name="Wingu OctopusCore Test Suite">
+      <directory>tests</directory>
+    </testsuite>
+  </testsuites>
+  <logging>
+    <junit outputFile="build/report.junit.xml"/>
+  </logging>
 </phpunit>
diff --git a/src/Annotation/Tags/BaseTag.php b/src/Annotation/Tags/BaseTag.php
@@ -45,11 +45,11 @@ public function __construct(AnnotationDefinition $definition)
     /**
      * Initialize the annotation tag.
      */
-    protected function initTag()
+    protected function initTag(): void
     {
         $this->tagName = $this->definition->getTag();
 
-        $description = trim($this->definition->getDescription());
+        $description = trim(($this->definition->getDescription())??'');
         if ($description !== '') {
             $this->description = trim($this->definition->getDescription());
         }

diff --git a/src/Annotation/Tags/ParamTag.php b/src/Annotation/Tags/ParamTag.php
@@ -51,11 +51,11 @@ public function __construct(AnnotationDefinition $definition)
     /**
      * Initialize the annotation tag.
      */
-    protected function initTag()
+    protected function initTag(): void
     {
         parent::initTag();
 
-        $value = preg_split('/[\s]+/', $this->description, 3);
+        $value = preg_split('/[\s]+/', $this->description??'', 3);
 
         if (isset($value[0]) === true && trim($value[0]) !== '') {
             $this->paramType = trim($value[0]);

diff --git a/src/Annotation/Tags/ReturnTag.php b/src/Annotation/Tags/ReturnTag.php
@@ -43,11 +43,11 @@ public function __construct(AnnotationDefinition $definition)
     /**
      * Initialize the annotation tag.
      */
-    protected function initTag()
+    protected function initTag(): void
     {
         parent::initTag();
 
-        $value = preg_split('/[\s]+/', $this->description, 2);
+        $value = preg_split('/[\s]+/', $this->description??'', 2);
         if (isset($value[0]) === true && trim($value[0]) !== '') {
             $this->returnType = $value[0];
         }

diff --git a/src/ReflectionClass.php b/src/ReflectionClass.php
@@ -46,7 +46,7 @@ public function getBody()
      *
      * @return \Wingu\OctopusCore\Reflection\ReflectionClass[]
      */
-    public function getInterfaces()
+    public function getInterfaces(): array
     {
         $return = array();
 
@@ -78,7 +78,7 @@ public function getOwnInterfaces()
      * @param string $name The method name.
      * @return \Wingu\OctopusCore\Reflection\ReflectionMethod
      */
-    public function getMethod($name)
+    public function getMethod($name): ReflectionMethod
     {
         return new ReflectionMethod($this->getName(), $name);
     }
@@ -89,7 +89,7 @@ public function getMethod($name)
      * @param integer $filter Filter for method types. This is an OR filter only.
      * @return \Wingu\OctopusCore\Reflection\ReflectionMethod[]
      */
-    public function getMethods($filter = -1)
+    public function getMethods($filter = -1): array
     {
         $return = parent::getMethods($filter);
         foreach ($return as $key => $val) {
@@ -135,7 +135,7 @@ public function getOwnMethods($filter = -1)
      *
      * @return \Wingu\OctopusCore\Reflection\ReflectionMethod
      */
-    public function getConstructor()
+    public function getConstructor(): ?ReflectionMethod
     {
         if ($this->hasMethod('__construct') === true) {
             return $this->getMethod('__construct');
@@ -164,6 +164,7 @@ public function hasOwnMethod($name)
      *
      * @return \Wingu\OctopusCore\Reflection\ReflectionClass
      */
+    #[\ReturnTypeWillChange]
     public function getParentClass()
     {
         $parent = parent::getParentClass();
@@ -177,7 +178,7 @@ public function getParentClass()
      * @param string $name Name of the property.
      * @return \Wingu\OctopusCore\Reflection\ReflectionProperty
      */
-    public function getProperty($name)
+    public function getProperty($name): ReflectionProperty
     {
         return new ReflectionProperty($this->getName(), $name);
     }
@@ -188,7 +189,7 @@ public function getProperty($name)
      * @param integer $filter Filter for the properties.
      * @return \Wingu\OctopusCore\Reflection\ReflectionProperty[]
      */
-    public function getProperties($filter = -1)
+    public function getProperties($filter = -1): array
     {
         $properties = parent::getProperties($filter);
         foreach ($properties as $key => $val) {
@@ -231,7 +232,7 @@ public function getOwnProperties($filter = -1)
      *
      * @return \Wingu\OctopusCore\Reflection\ReflectionConstant[] the array of constants
      */
-    public function getConstants($filter = null)
+    public function getConstants($filter = null): array
     {
         $constants = parent::getConstants();
         $returnConstants = array();
@@ -261,7 +262,7 @@ public function getOwnConstants()
      *
      * @return \Wingu\OctopusCore\Reflection\ReflectionClass[]
      */
-    public function getTraits()
+    public function getTraits(): array
     {
         $return = parent::getTraits();
         if ($return !== null) {
@@ -293,7 +294,7 @@ public function getUses()
      *
      * @return \Wingu\OctopusCore\Reflection\ReflectionExtension
      */
-    public function getExtension()
+    public function getExtension(): ?ReflectionExtension
     {
         $extensionName = $this->getExtensionName();
         if ($extensionName !== false) {

diff --git a/src/ReflectionFunction.php b/src/ReflectionFunction.php
@@ -42,7 +42,7 @@ public function getBody()
      *
      * @return \Wingu\OctopusCore\Reflection\ReflectionExtension
      */
-    public function getExtension()
+    public function getExtension(): ?ReflectionExtension
     {
         $extensionName = $this->getExtensionName();
         if ($extensionName !== false) {
@@ -57,7 +57,7 @@ public function getExtension()
      *
      * @return \Wingu\OctopusCore\Reflection\ReflectionParameter[]
      */
-    public function getParameters()
+    public function getParameters(): array
     {
         $res = parent::getParameters();
 

diff --git a/src/ReflectionMethod.php b/src/ReflectionMethod.php
@@ -17,7 +17,7 @@ class ReflectionMethod extends \ReflectionMethod
      *
      * @return \Wingu\OctopusCore\Reflection\ReflectionClass
      */
-    public function getDeclaringClass()
+    public function getDeclaringClass(): ReflectionClass
     {
         return new ReflectionClass(parent::getDeclaringClass()->getName());
     }
@@ -27,7 +27,7 @@ public function getDeclaringClass()
      *
      * @return \Wingu\OctopusCore\Reflection\ReflectionMethod
      */
-    public function getPrototype()
+    public function getPrototype(): ReflectionMethod
     {
         $prototype = parent::getPrototype();
 
@@ -68,7 +68,7 @@ public function getBody()
      *
      * @return \Wingu\OctopusCore\Reflection\ReflectionParameter[]
      */
-    public function getParameters()
+    public function getParameters(): array
     {
         $function = array($this->getDeclaringClass()->getName(), $this->getName());
         $res = parent::getParameters();
@@ -85,7 +85,7 @@ public function getParameters()
      *
      * @return \Wingu\OctopusCore\Reflection\ReflectionExtension
      */
-    public function getExtension()
+    public function getExtension(): ?ReflectionExtension
     {
         $extensionName =  $this->getExtensionName();
         if ($extensionName !== false) {

diff --git a/src/ReflectionParameter.php b/src/ReflectionParameter.php
@@ -32,7 +32,7 @@ public function __construct($function, $parameter)
      *
      * @return \Wingu\OctopusCore\Reflection\ReflectionClass
      */
-    public function getClass()
+    public function getClass(): ?ReflectionClass
     {
         $class = null;
         if (PHP_VERSION_ID < 80000) {
@@ -55,7 +55,7 @@ public function getClass()
      *
      * @return \Wingu\OctopusCore\Reflection\ReflectionClass
      */
-    public function getDeclaringClass()
+    public function getDeclaringClass(): ?ReflectionClass
     {
         $class = parent::getDeclaringClass();
         if ($class !== null) {
@@ -70,7 +70,7 @@ public function getDeclaringClass()
      *
      * @return \Wingu\OctopusCore\Reflection\ReflectionMethod|\Wingu\OctopusCore\Reflection\ReflectionFunction
      */
-    public function getDeclaringFunction()
+    public function getDeclaringFunction(): \ReflectionFunctionAbstract
     {
         if (is_array($this->function) === true) {
             return new ReflectionMethod($this->function[0], $this->function[1]);

diff --git a/src/ReflectionProperty.php b/src/ReflectionProperty.php
@@ -15,7 +15,7 @@ class ReflectionProperty extends \ReflectionProperty
      *
      * @return \Wingu\OctopusCore\Reflection\ReflectionClass
      */
-    public function getDeclaringClass()
+    public function getDeclaringClass(): ReflectionClass
     {
         return new ReflectionClass(parent::getDeclaringClass()->getName());
     }
@@ -25,6 +25,7 @@ public function getDeclaringClass()
      *
      * @return mixed
      */
+    #[\ReturnTypeWillChange]
     public function getDefaultValue()
     {
         return $this->getDeclaringClass()->getDefaultProperties()[$this->name];

diff --git a/tests/Unit/ReflectionConstantTest.php b/tests/Unit/ReflectionConstantTest.php
@@ -55,9 +55,7 @@ public function testGetDocCommentWithValidCommentReturnTheDocComment()
             'CONSTANT2'
         );
         $actual = $reflectionConstant->getDocComment();
-        $expected = '/**
-     * This is *a comment* {};
-     */';
+        $expected = "/**\n     * This is *a comment* {};\n     */";
         $this->assertEquals($expected, $actual);
     }
 
@@ -68,9 +66,7 @@ public function testGetDocCommentWithValidCommentInheritedReturnTheDocComment()
             'CONSTANT3'
             );
         $actual = $reflectionConstant->getDocComment();
-        $expected = '/**
-     * This is *another comment*
-     */';
+        $expected = "/**\n     * This is *another comment*\n     */";
         $this->assertEquals($expected, $actual);
     }
 

diff --git a/tests/Unit/ReflectionMethodTest.php b/tests/Unit/ReflectionMethodTest.php
@@ -93,10 +93,7 @@ public function testGetBodyWithBodyReturnString()
         $reflection = new ReflectionMethod('\Wingu\OctopusCore\Reflection\Tests\Unit\Fixtures\ImplementorClass3',
             'methodWithNormalBody');
         $actual = $reflection->getBody();
-        $expected = "        echo 'test';
-        echo 'test';
-        echo 'test';
-        return 1;";
+        $expected = "        echo 'test';\n        echo 'test';\n        echo 'test';\n        return 1;";
         $this->assertEquals($expected, $actual);
     }