Merge pull request #176 from MarcinOrlowski/dev

Release 9.1.0

Author: MarcinOrlowski

CHANGES.md

@@ -8,9 +8,16 @@ before doing major upgrade!
 
 ## CHANGE LOG ##
 
+* v9.1.0 (2020-10-29)
+   * [RB-175] `Paginator` and `LengthAwarePaginator` support is now included in default converter 
+     configuration (reported by @kcaj-burr) 
+   * Fixed `testConfigClassesMappingEntriesUnwantedConfigKeys()` testing trait not supporting
+     `null` keys in converter config.
+
 * v9.0.3 (2020-10-27)
    * `Validator` type related exceptions must now implement `InvalidTypeExceptionContract`.
-   * `converter` config `key` element now accepts `null` to indicate you want no key to be used.
+   * The `converter` config `key` element now accepts `null` to indicate you want no key to
+     be used (patch by Raja)
 
 * v9.0.2 (2020-10-24)
    * Corrected tests to use regular ServiceProvider.
@@ -32,7 +39,7 @@ before doing major upgrade!
 
 * v8.1.1 (2020-10-15)
    * [RB-155] Fixed `ResponseBuilder` internals preventing exdending class code from
-     being invoked, thus making response object structure manipulation ineffective (reported by krek95).
+     being invoked, thus making response object structure manipulation ineffective (reported by @krek95).
 
 * v8.1.0 (2020-09-17)
    * Added logging (`.env` controllable) for payload Converter to help debugging inproper data conversion.

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.0.3",
+  "version": "9.1.0",
   "keywords": [
     "laravel",
     "json",

config/response_builder.php

@@ -79,6 +79,23 @@
 	            'pri'     => 0,
 	        ],
 
+	        /*
+			|-----------------------------------------------------------------------------------------------------------
+			| Paginators converts to objects already, so we do not array wrapping here, hence setting `key` to null
+			|-----------------------------------------------------------------------------------------------------------
+			*/
+
+	        \Illuminate\Pagination\LengthAwarePaginator::class => [
+		        'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ArrayableConverter::class,
+		        'key'     => null,
+		        'pri'     => 0,
+	        ],
+	        \Illuminate\Pagination\Paginator::class => [
+		        'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ArrayableConverter::class,
+		        'key'     => null,
+		        'pri'     => 0,
+	        ],
+
 	        /*
 	        |-----------------------------------------------------------------------------------------------------------
 	        | Generic converters should have lower pri to allow dedicated ones to kick in first when class matches

docs/config.md

@@ -67,15 +67,15 @@ php artisan vendor:publish
 
 ```php
 'converter' => [
-    \Illuminate\Database\Eloquent\Model::class          => [
+    \Illuminate\Database\Eloquent\Model::class => [
         'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ToArrayConverter::class,
         'key'     => 'items',
-        // 'pri'     => 0,
+        'pri'     => 0,
     ],
-    \Illuminate\Database\Eloquent\Collection::class     => [
-        'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ToArrayConverter::class,
-        'key'     => 'items',
-        // 'pri'     => 0,
+    \Illuminate\Pagination\Paginator::class => [
+        'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ArrayableConverter::class,
+        'key'     => null,
+        'pri'     => 0,
     ],
 ],
 ```