Add ReturnTypeWillChange attributes and add workflows for PHP8.0 and …

…PHP8.1 (#55)

* Add PHP8.0 and 8.1 to test matrix

* Add ReturnTypeWillChange attributes to methods with incompatible return types to support PHP8.1

* Update phpunit requirement to allow for phpunit to be installed on PHP8.0 and PHP8.1

* Replace deprecated and now removed @ExpectedException annotation necessary for upgrade to new phpunit version

.github/workflows/tests.yml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        php: [7.1, 7.2, 7.3, 7.4]
+        php: [7.1, 7.2, 7.3, 7.4, 8.0, 8.1]
         stability: [prefer-lowest, prefer-stable]
 
     name: PHP ${{ matrix.php }} - ${{ matrix.stability }}

composer.json

@@ -30,7 +30,7 @@
     "ext-json": "*"
   },
   "require-dev": {
-    "phpunit/phpunit": "^7.3",
+    "phpunit/phpunit": ">=7.3",
     "friendsofphp/php-cs-fixer": "^2.17",
     "justinrainbow/json-schema": "^5.2"
   },

src/Utilities/Extensions.php

@@ -26,6 +26,7 @@ class Extensions implements ArrayAccess
      * @param mixed $offset
      * @return bool
      */
+    #[\ReturnTypeWillChange]
     public function offsetExists($offset)
     {
         return isset($this->items[$this->normalizeOffset($offset)]);
@@ -39,6 +40,7 @@ public function offsetExists($offset)
      * @throws \GoldSpecDigital\ObjectOrientedOAS\Exceptions\ExtensionDoesNotExistException
      * @return mixed can return all value types
      */
+    #[\ReturnTypeWillChange]
     public function offsetGet($offset)
     {
         if (!$this->offsetExists($offset)) {
@@ -55,6 +57,7 @@ public function offsetGet($offset)
      * @param mixed $offset
      * @param mixed $value
      */
+    #[\ReturnTypeWillChange]
     public function offsetSet($offset, $value)
     {
         if ($value === static::X_EMPTY_VALUE) {
@@ -72,6 +75,7 @@ public function offsetSet($offset, $value)
      * @link https://php.net/manual/en/arrayaccess.offsetunset.php
      * @param mixed $offset
      */
+    #[\ReturnTypeWillChange]
     public function offsetUnset($offset)
     {
         if (!$this->offsetExists($offset)) {

tests/Objects/ExtensionsTest.php

@@ -2,6 +2,7 @@
 
 namespace GoldSpecDigital\ObjectOrientedOAS\Tests\Objects;
 
+use GoldSpecDigital\ObjectOrientedOAS\Exceptions\PropertyDoesNotExistException;
 use GoldSpecDigital\ObjectOrientedOAS\Objects\Components;
 use GoldSpecDigital\ObjectOrientedOAS\Objects\Operation;
 use GoldSpecDigital\ObjectOrientedOAS\Objects\PathItem;
@@ -69,14 +70,15 @@ public function get_single_extension($schema)
 
     /**
      * @test
-     * @expectedException \GoldSpecDigital\ObjectOrientedOAS\Exceptions\PropertyDoesNotExistException
      * @dataProvider schemasDataProvider
      * @param string|\GoldSpecDigital\ObjectOrientedOAS\Objects\Schema $schema
      */
     public function get_single_extension_does_not_exist($schema)
     {
         $object = $schema::create()->x('foo', 'bar');
 
+        $this->expectException(PropertyDoesNotExistException::class);
+        $this->expectExceptionMessage('[x-key] is not a valid property');
         $this->assertEquals('bar', $object->{'x-key'});
     }