Merge pull request #220 from MarcinOrlowski/dev

Release v9.3.2
MarcinOrlowski · Feb 13, 2022 · 4964aa6 · 4964aa6
2 parents 0ddaae2 + 3337222
commit 4964aa6
Show file tree

Hide file tree

Showing 86 changed files with 151 additions and 127 deletions.
diff --git a/.codecov.yml b/.codecov.yml
@@ -5,7 +5,7 @@
 # @package   MarcinOrlowski\ResponseBuilder
 #
 # @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
-# @copyright 2016-2021 Marcin Orlowski
+# @copyright 2016-2022 Marcin Orlowski
 # @license   http://www.opensource.org/licenses/mit-license.php MIT
 # @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
 #

diff --git a/.config/composer-laravel-9.x.json b/.config/composer-laravel-9.x.json
@@ -0,0 +1,22 @@
+{
+  "name": "marcin-orlowski/laravel-api-response-builder",
+  "autoload": {
+    "psr-4": {
+      "MarcinOrlowski\\ResponseBuilder\\": "src/",
+      "MarcinOrlowski\\ResponseBuilder\\Tests\\Traits\\": "tests/Traits/",
+      "MarcinOrlowski\\ResponseBuilder\\Tests\\": "tests/phpunit"
+    }
+  },
+  "require": {
+    "php": "^8.0",
+    "laravel/framework": "^9.0"
+  },
+  "require-dev": {
+    "marcin-orlowski/coding-standard": "^2.2",
+    "marcin-orlowski/phpunit-extra-asserts": "^1.2",
+    "orchestra/testbench": "^6.0",
+    "phpunit/phpunit": "^9.0",
+    "phpunit/php-code-coverage": "^9.0",
+    "nunomaduro/larastan": "^0.7.6"
+  }
+}
diff --git a/.github/workflows/coding-standards.yml b/.github/workflows/coding-standards.yml
@@ -5,7 +5,7 @@
 # @package   MarcinOrlowski\ResponseBuilder
 #
 # @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
-# @copyright 2016-2021 Marcin Orlowski
+# @copyright 2016-2022 Marcin Orlowski
 # @license   http://www.opensource.org/licenses/mit-license.php MIT
 # @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
 #
@@ -27,7 +27,7 @@ jobs:
       matrix:
         # quotes are needed it is treated as a number and zero at decimal part is gone at runtime
         laravel: ["8.x"]
-        php: ["8.0"]
+        php: ["8.0", "8.1"]
 
     runs-on: ubuntu-latest
 

diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
@@ -5,7 +5,7 @@
 # @package   MarcinOrlowski\ResponseBuilder
 #
 # @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
-# @copyright 2016-2021 Marcin Orlowski
+# @copyright 2016-2022 Marcin Orlowski
 # @license   http://www.opensource.org/licenses/mit-license.php MIT
 # @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
 #
@@ -30,7 +30,7 @@ jobs:
       matrix:
         # quotes are needed it is treated as a number and zero at decimal part is gone at runtime
         laravel: ["8.x"]
-        php: ["8.0"]
+        php: ["8.0", "8.1"]
 
     runs-on: ubuntu-latest
 

diff --git a/.github/workflows/phpstan.yml b/.github/workflows/phpstan.yml
@@ -5,7 +5,7 @@
 # @package   MarcinOrlowski\ResponseBuilder
 #
 # @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
-# @copyright 2016-2021 Marcin Orlowski
+# @copyright 2016-2022 Marcin Orlowski
 # @license   http://www.opensource.org/licenses/mit-license.php MIT
 # @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
 #
@@ -30,7 +30,7 @@ jobs:
       matrix:
         # quotes are needed it is treated as a number and zero at decimal part is gone at runtime
         laravel: ["8.x"]
-        php: ["7.4", "8.0"]
+        php: ["7.4", "8.0", "8.1"]
 
     runs-on: ubuntu-latest
 
@@ -50,6 +50,7 @@ jobs:
           php_version: "${{ matrix.php }}"
           dev: yes
 
+      # https://github.com/marketplace/actions/phpstan-php-actions
       - name: "Running PHPStan..."
         uses: php-actions/phpstan@v3
         with:

diff --git a/.github/workflows/phpunit.yml b/.github/workflows/phpunit.yml
@@ -5,7 +5,7 @@
 # @package   MarcinOrlowski\ResponseBuilder
 #
 # @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
-# @copyright 2016-2021 Marcin Orlowski
+# @copyright 2016-2022 Marcin Orlowski
 # @license   http://www.opensource.org/licenses/mit-license.php MIT
 # @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
 #
@@ -30,11 +30,13 @@ jobs:
       matrix:
         # quotes are needed it is treated as a number and zero at decimal part is gone at runtime
         laravel: ["6.x", "7.x", "8.x"]
-        php: ["7.2", "7.3", "7.4", "8.0"]
+        php: ["7.2", "7.3", "7.4", "8.0", "8.1"]
         exclude:
           # Laravel 8.x requires PHP 7.3+
           - laravel: "8.x"
             php: "7.2"
+          - laravel: "9.x"
+            php: ["7.2", "7.3", "7.4"]
 
     runs-on: ubuntu-latest
 

diff --git a/README.md b/README.md
@@ -66,5 +66,5 @@ Development branch:
 
 ## License ##
 
-* Written and copyrighted &copy;2016-2021 by Marcin Orlowski <mail (#) marcinorlowski (.) com>
+* Written and copyrighted &copy;2016-2022 by Marcin Orlowski <mail (#) marcinorlowski (.) com>
 * ResponseBuilder is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)
diff --git a/composer.json b/composer.json
@@ -2,7 +2,7 @@
   "name": "marcin-orlowski/laravel-api-response-builder",
   "description": "Helps building nice, normalized and easy to consume Laravel REST API.",
   "homepage": "https://github.com/MarcinOrlowski/laravel-api-response-builder",
-  "version": "9.3.1",
+  "version": "9.3.2",
   "keywords": [
     "laravel",
     "json",
@@ -11,6 +11,7 @@
     "rest",
     "helper",
     "php7",
+    "php8",
     "mobile",
     "android",
     "ios"

diff --git a/config/response_builder.php b/config/response_builder.php
@@ -7,7 +7,7 @@
  * See docs/config.md for detailed documentation
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2021 Marcin Orlowski
+ * @copyright 2016-2022 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  *

diff --git a/docs/CHANGES.md b/docs/CHANGES.md
@@ -9,6 +9,11 @@
 
 ## CHANGE LOG ##
 
+* v9.3.2 (2022-02-13)
+  * Laravel 9.x is now included in test matrices.
+  * PHP 8.1 is now included in test matrices.
+  * Simplified some logic by removing redundant checks.
+
 * v9.3.1 (2021-10-23)
   * Default `composer.json` also includes development packages now.
   * Updated examples in docs (thanks to @jcmcclorey).

diff --git a/phpcs.xml b/phpcs.xml
@@ -3,7 +3,7 @@
  * Laravel API Response Builder - PHP Code Sniffer config file
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2021 Marcin Orlowski
+ * @copyright 2016-2022 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  *

diff --git a/phpstan.neon b/phpstan.neon
@@ -5,7 +5,7 @@
 # @package   MarcinOrlowski\ResponseBuilder
 #
 # @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
-# @copyright 2016-2021 Marcin Orlowski
+# @copyright 2016-2022 Marcin Orlowski
 # @license   http://www.opensource.org/licenses/mit-license.php MIT
 # @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
 #

diff --git a/src/ApiCodesHelpers.php b/src/ApiCodesHelpers.php
@@ -9,7 +9,7 @@
  * @package   MarcinOrlowski\ResponseBuilder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2021 Marcin Orlowski
+ * @copyright 2016-2022 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/BaseApiCodes.php b/src/BaseApiCodes.php
@@ -9,7 +9,7 @@
  * @package   MarcinOrlowski\ResponseBuilder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2021 Marcin Orlowski
+ * @copyright 2016-2022 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/Contracts/ConverterContract.php b/src/Contracts/ConverterContract.php
@@ -9,7 +9,7 @@
  * @package   MarcinOrlowski\ResponseBuilder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2021 Marcin Orlowski
+ * @copyright 2016-2022 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/Contracts/ExceptionHandlerContract.php b/src/Contracts/ExceptionHandlerContract.php
@@ -9,7 +9,7 @@
  * @package   MarcinOrlowski\ResponseBuilder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2021 Marcin Orlowski
+ * @copyright 2016-2022 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/Contracts/InvalidTypeExceptionContract.php b/src/Contracts/InvalidTypeExceptionContract.php
@@ -9,7 +9,7 @@
  * @package   MarcinOrlowski\ResponseBuilder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2021 Marcin Orlowski
+ * @copyright 2016-2022 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/Converter.php b/src/Converter.php
@@ -9,7 +9,7 @@
  * @package   MarcinOrlowski\ResponseBuilder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2021 Marcin Orlowski
+ * @copyright 2016-2022 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */
@@ -93,22 +93,20 @@ protected function getClassMappingConfigOrThrow(object $data): array
 
 		// check for exact class name match...
 		$cls = \get_class($data);
-		if (\is_string($cls)) {
-			if (\array_key_exists($cls, $this->classes)) {
-				$result = $this->classes[ $cls ];
-				$debug_result = 'exact config match';
-			} else {
-				// no exact match, then lets try with `instanceof`
-				foreach (\array_keys($this->classes) as $class_name) {
-					/** @var string $class_name */
-					if ($data instanceof $class_name) {
-						$result = $this->classes[ $class_name ];
-						$debug_result = "subclass of {$class_name}";
-						break;
-					}
-				}
-			}
-		}
+        if (\array_key_exists($cls, $this->classes)) {
+            $result = $this->classes[ $cls ];
+            $debug_result = 'exact config match';
+        } else {
+            // no exact match, then lets try with `instanceof`
+            foreach (\array_keys($this->classes) as $class_name) {
+                /** @var string $class_name */
+                if ($data instanceof $class_name) {
+                    $result = $this->classes[ $class_name ];
+                    $debug_result = "subclass of {$class_name}";
+                    break;
+                }
+            }
+        }
 
 		if ($result === null) {
 			throw new Ex\ConfigurationNotFoundException(

diff --git a/src/Converters/ArrayableConverter.php b/src/Converters/ArrayableConverter.php
@@ -9,7 +9,7 @@
  * @package   MarcinOrlowski\ResponseBuilder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2021 Marcin Orlowski
+ * @copyright 2016-2022 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/Converters/JsonSerializableConverter.php b/src/Converters/JsonSerializableConverter.php
@@ -9,7 +9,7 @@
  * @package   MarcinOrlowski\ResponseBuilder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2021 Marcin Orlowski
+ * @copyright 2016-2022 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/Converters/ToArrayConverter.php b/src/Converters/ToArrayConverter.php
@@ -9,7 +9,7 @@
  * @package   MarcinOrlowski\ResponseBuilder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2021 Marcin Orlowski
+ * @copyright 2016-2022 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/ExceptionHandlerHelper.php b/src/ExceptionHandlerHelper.php
@@ -9,7 +9,7 @@
  * @package   MarcinOrlowski\ResponseBuilder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2021 Marcin Orlowski
+ * @copyright 2016-2022 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */
@@ -348,24 +348,22 @@ protected static function getHandler(\Throwable $ex): ?array
 		$result = null;
 
 		$cls = \get_class($ex);
-		if (\is_string($cls)) {
-			$cfg = self::getExceptionHandlerConfig();
-
-			// check for exact class name match...
-			if (\array_key_exists($cls, $cfg)) {
-				$result = $cfg[ $cls ];
-			} else {
-				// no exact match, then lets try with `instanceof`
-				// Config entries are already sorted by priority.
-				foreach (\array_keys($cfg) as $class_name) {
-					/** @var string $class_name */
-					if ($ex instanceof $class_name) {
-						$result = $cfg[ $class_name ];
-						break;
-					}
-				}
-			}
-		}
+        $cfg = self::getExceptionHandlerConfig();
+
+        // check for exact class name match...
+        if (\array_key_exists($cls, $cfg)) {
+            $result = $cfg[ $cls ];
+        } else {
+            // no exact match, then lets try with `instanceof`
+            // Config entries are already sorted by priority.
+            foreach (\array_keys($cfg) as $class_name) {
+                /** @var string $class_name */
+                if ($ex instanceof $class_name) {
+                    $result = $cfg[ $class_name ];
+                    break;
+                }
+            }
+        }
 
 		return $result;
 	}

diff --git a/src/ExceptionHandlers/DefaultExceptionHandler.php b/src/ExceptionHandlers/DefaultExceptionHandler.php
@@ -9,7 +9,7 @@
  * @package   MarcinOrlowski\ResponseBuilder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2021 Marcin Orlowski
+ * @copyright 2016-2022 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/ExceptionHandlers/HttpExceptionHandler.php b/src/ExceptionHandlers/HttpExceptionHandler.php
@@ -9,7 +9,7 @@
  * @package   MarcinOrlowski\ResponseBuilder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2021 Marcin Orlowski
+ * @copyright 2016-2022 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/ExceptionHandlers/ValidationExceptionHandler.php b/src/ExceptionHandlers/ValidationExceptionHandler.php
@@ -9,7 +9,7 @@
  * @package   MarcinOrlowski\ResponseBuilder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2021 Marcin Orlowski
+ * @copyright 2016-2022 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/Exceptions/ArrayWithMixedKeysException.php b/src/Exceptions/ArrayWithMixedKeysException.php
@@ -9,7 +9,7 @@
  * @package   MarcinOrlowski\ResponseBuilder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2021 Marcin Orlowski
+ * @copyright 2016-2022 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/Exceptions/ClassNotFound.php b/src/Exceptions/ClassNotFound.php
@@ -9,7 +9,7 @@
  * @package   MarcinOrlowski\ResponseBuilder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2021 Marcin Orlowski
+ * @copyright 2016-2022 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */