Auto exclude (#253)

Co-authored-by: Simon White <simon@icon-creative.com>

Author: simondotwhite

README.md

@@ -133,6 +133,20 @@ return [
          */
         'request_key' => 'include',
     ],
+    
+    'auto_excludes' => [
+
+        /*
+         * If enabled Fractal will automatically add the excludes who's
+         * names are present in the `include` request parameter.
+         */
+        'enabled' => true,
+
+        /*
+         * The name of key in the request to where we should look for the excludes to exclude.
+         */
+        'request_key' => 'exclude',
+    ],
 ```
 
 ## Usage

config/fractal.php

@@ -39,4 +39,18 @@
          */
         'request_key' => 'include',
     ],
+
+    'auto_excludes' => [
+
+        /*
+         * If enabled Fractal will automatically add the excludes who's
+         * names are present in the `exclude` request parameter.
+         */
+        'enabled' => true,
+
+        /*
+         * The name of key in the request to where we should look for the excludes to exclude.
+         */
+        'request_key' => 'exclude',
+    ],
 ];

src/Fractal.php

@@ -43,6 +43,14 @@ public static function create($data = null, $transformer = null, $serializer = n
             }
         }
 
+        if (config('fractal.auto_excludes.enabled')) {
+            $requestKey = config('fractal.auto_excludes.request_key');
+
+            if ($exclude = app('request')->get($requestKey)) {
+                $fractal->parseExcludes($exclude);
+            }
+        }
+
         if (empty($serializer)) {
             $serializer = config('fractal.default_serializer');
         }

tests/AutoExcludeTest.php

@@ -0,0 +1,46 @@
+<?php
+
+it('excludes can be passed as array', function () {
+    $response = $this->call('GET', '/auto-includes', [
+        'include' => [
+        'characters',
+        'publisher',
+        ],
+        'exclude' => [
+        'publisher',
+        ],
+    ]);
+    $response->assertStatus(200);
+    $response->assertJsonStructure([
+        'data' => [
+        ['id', 'author', 'characters'],
+        ],
+    ]);
+});
+
+it('excludes can be passed as string', function () {
+    $response = $this->call('GET', '/auto-includes', [
+        'include' => 'characters,publisher',
+        'exclude' => 'publisher',
+    ]);
+    $response->assertStatus(200);
+    $response->assertJsonStructure([
+        'data' => [
+        ['id', 'author', 'characters'],
+        ],
+    ]);
+});
+
+it('excludes are missing when parameter is not passed', function () {
+    $response = $this->call('GET', '/auto-includes');
+    $response->assertStatus(200);
+    $response->assertJsonStructure([
+        'data' => [
+        ['id', 'author'],
+        ],
+    ]);
+
+    foreach ($response->json()['data'] as $book) {
+        expect($book)->not->toHaveKeys(['characters', 'publisher']);
+    }
+});