Add Laravel 5.5 compatibility (#141)

* auto includes (#114)

* auto includes

* auto includes

* polish auto includes

* edit readme

* Laravel 5.5. compatibility (#122)

* make compatible with laravel 5.5

* rename config file

* Apply fixes from StyleCI (#134)

* add php 7.2

* add  to config file

* Update README.md (#137)

Discovery

Author: freekmurze

.travis.yml

@@ -1,7 +1,6 @@
 language: php
 
 php:
-  - 5.6
   - 7.0
   - 7.1
   - 7.2
@@ -16,7 +15,4 @@ before_script:
   - travis_retry composer update ${COMPOSER_FLAGS} --no-interaction --prefer-source
 
 script:
-  - vendor/bin/phpunit --testdox --coverage-text --coverage-clover=coverage.clover
-
-after_script:
-  - php vendor/bin/ocular code-coverage:upload --format=php-clover coverage.clover
+  - vendor/bin/phpunit --testdox --coverage-text --coverage-clover=coverage.clover

CHANGELOG.md

@@ -2,6 +2,17 @@
 
 All notable changes to `laravel-fractal` will be documented in this file
 
+
+## 5.0.0 - 2017-XX-XX
+
+- Laravel 5.5 support, dropped support for all older versions
+- renamed config file from `laravel-fractal` to `fractal`
+- added auto-includes
+
+## 4.5.0 - 2017-08-20
+- add `default_paginator` to config file
+
+
 ## 4.4.0 - 2017-08-20
 - add `fractal_class` to config file
 

README.md

@@ -69,16 +69,7 @@ You can pull in the package via composer:
 $ composer require spatie/laravel-fractal
 ```
 
-Next up, the service provider must be registered:
-
-```php
-// config/app.php
-'providers' => [
-    ...
-    Spatie\Fractal\FractalServiceProvider::class,
-
-];
-```
+The package will automatically register itself.
 
 If you want to make use of the facade you must install it as well:
 
@@ -103,56 +94,43 @@ This is the contents of the published file:
 
 ```php
 return [
-
-    /*
-    |--------------------------------------------------------------------------
-    | Default Serializer
-    |--------------------------------------------------------------------------
-    |
-    | The default serializer to be used when performing a transformation. It
-    | may be left empty to use Fractal's default one. This can either be a
-    | string or a League\Fractal\Serializer\SerializerAbstract subclass.
-    |
-    */
-
+     /*
+     * The default serializer to be used when performing a transformation. It
+     * may be left empty to use Fractal's default one. This can either be a
+     * string or a League\Fractal\Serializer\SerializerAbstract subclass.
+     */
     'default_serializer' => '',
-    
-    /*
-    |--------------------------------------------------------------------------
-    | Default Paginator
-    |--------------------------------------------------------------------------
-    |
-    | The default paginator to be used when performing a transformation. It
-    | may be left empty to use Fractal's default one. This can either be a
-    | string or a League\Fractal\Paginator\PaginatorInterface subclass.
-    |
-    */
 
+    /* The default paginator to be used when performing a transformation. It
+     * may be left empty to use Fractal's default one. This can either be a
+     * string or a League\Fractal\Paginator\PaginatorInterface subclass.*/
     'default_paginator' => '',
 
     /*
-    |--------------------------------------------------------------------------
-    | JsonApiSerializer links support
-    |--------------------------------------------------------------------------
-    |
-    | League\Fractal\Serializer\JsonApiSerializer will use this value to 
-    | as a prefix for generated links. Set to `null` to disable this.
-    |
-    */
+     * League\Fractal\Serializer\JsonApiSerializer will use this value to
+     * as a prefix for generated links. Set to `null` to disable this.
+     */
     'base_url' => null,
 
     /*
-    |--------------------------------------------------------------------------
-    | Fractal Class
-    |--------------------------------------------------------------------------
-    |
-    | If you wish to override or extend the default Spatie\Fractal\Fractal
-    | instance provide the name of the class you want to use.
-    |
-    */
-    'fractal_class' => 'Spatie\Fractal\Fractal',
-
-];
+     * If you wish to override or extend the default Spatie\Fractal\Fractal
+     * instance provide the name of the class you want to use.
+     */
+    'fractal_class' => Spatie\Fractal\Fractal::class,
+
+    'auto_includes' => [
+
+        /*
+         * If enabled Fractal will automatically add the includes 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 includes to include.
+         */
+        'request_key' => 'include',
+    ],
 ```
 
 ## Usage

composer.json

@@ -21,14 +21,14 @@
         }
     ],
     "require": {
-        "php" : "^5.6|^7.0",
-        "illuminate/contracts": "~5.1.0|~5.2.0|~5.3.0|~5.4.0",
-        "illuminate/support": "~5.1.0|~5.2.0|~5.3.0|~5.4.0",
+        "php" : "^7.0",
+        "illuminate/contracts": "5.5.x-dev",
+        "illuminate/support": "5.5.x-dev",
         "spatie/fractalistic": "^2.5"
     },
     "require-dev": {
-        "orchestra/testbench": "~3.2.0|3.3.0|~3.4.0",
-        "phpunit/phpunit" : "^5.7.5"
+        "orchestra/testbench": "3.5.x-dev",
+        "phpunit/phpunit" : "^6.2"
     },
     "autoload": {
         "psr-4": {
@@ -58,5 +58,8 @@
                 "Fractal": "Spatie\\Fractal\\FractalFacade"
             }
         }
-    }
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true
+
 }

config/fractal.php

@@ -0,0 +1,41 @@
+<?php
+
+return [
+    /*
+     * The default serializer to be used when performing a transformation. It
+     * may be left empty to use Fractal's default one. This can either be a
+     * string or a League\Fractal\Serializer\SerializerAbstract subclass.
+     */
+    'default_serializer' => '',
+
+    /* The default paginator to be used when performing a transformation. It
+     * may be left empty to use Fractal's default one. This can either be a
+     * string or a League\Fractal\Paginator\PaginatorInterface subclass.*/
+    'default_paginator' => '',
+
+    /*
+     * League\Fractal\Serializer\JsonApiSerializer will use this value to
+     * as a prefix for generated links. Set to `null` to disable this.
+     */
+    'base_url' => null,
+
+    /*
+     * If you wish to override or extend the default Spatie\Fractal\Fractal
+     * instance provide the name of the class you want to use.
+     */
+    'fractal_class' => Spatie\Fractal\Fractal::class,
+
+    'auto_includes' => [
+
+        /*
+         * If enabled Fractal will automatically add the includes 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 includes to include.
+         */
+        'request_key' => 'include',
+    ],
+];

resources/config/laravel-fractal.php

@@ -4,6 +4,7 @@
 
 use Closure;
 use League\Fractal\Manager;
+use Illuminate\Http\Request;
 use Illuminate\Http\JsonResponse;
 use League\Fractal\Serializer\JsonApiSerializer;
 use Spatie\Fractalistic\Fractal as Fractalistic;
@@ -30,12 +31,21 @@ public static function create($data = null, $transformer = null, $serializer = n
     {
         $fractal = parent::create($data, $transformer, $serializer);
 
+        if (config('fractal.auto_includes.enabled')) {
+            $requestKey = config('fractal.auto_includes.request_key');
+
+            if (request()->query($requestKey)) {
+                $fractal->parseIncludes(explode(',', request()->query($requestKey)));
+            }
+        }
+
         if (empty($serializer)) {
-            $serializer = config('laravel-fractal.default_serializer');
+            $serializer = config('fractal.default_serializer');
         }
 
         if ($data instanceof LengthAwarePaginator) {
-            $paginator = config('laravel-fractal.default_paginator');
+            $paginator = config('fractal.default_paginator');
+
             if (empty($paginator)) {
                 $paginator = IlluminatePaginatorAdapter::class;
             }
@@ -56,7 +66,7 @@ public static function create($data = null, $transformer = null, $serializer = n
         }
 
         if ($serializer == JsonApiSerializer::class) {
-            $baseUrl = config('laravel-fractal.base_url');
+            $baseUrl = config('fractal.base_url');
 
             return $fractal->serializeWith(new $serializer($baseUrl));
         }

src/Fractal.php

@@ -16,6 +16,6 @@ class FractalFacade extends Facade
      */
     protected static function getFacadeAccessor()
     {
-        return 'laravel-fractal';
+        return 'fractal';
     }
 }

src/FractalFacade.php

@@ -28,23 +28,23 @@ public function boot()
      */
     public function register()
     {
-        $this->app->singleton('laravel-fractal', function (...$arguments) {
+        $this->app->singleton('fractal', function (...$arguments) {
             return fractal(...$arguments);
         });
 
-        $this->app->alias('laravel-fractal', Fractal::class);
+        $this->app->alias('fractal', Fractal::class);
     }
 
     protected function setupConfig()
     {
-        $source = realpath(__DIR__.'/../resources/config/laravel-fractal.php');
+        $source = realpath(__DIR__.'/../config/fractal.php');
 
         if ($this->app instanceof LaravelApplication) {
-            $this->publishes([$source => config_path('laravel-fractal.php')]);
+            $this->publishes([$source => config_path('fractal.php')]);
         } elseif ($this->app instanceof LumenApplication) {
-            $this->app->configure('laravel-fractal');
+            $this->app->configure('fractal');
         }
 
-        $this->mergeConfigFrom($source, 'laravel-fractal');
+        $this->mergeConfigFrom($source, 'fractal');
     }
 }

src/FractalServiceProvider.php

@@ -12,7 +12,7 @@
      */
     function fractal($data = null, $transformer = null, $serializer = null)
     {
-        $fractalClass = config('laravel-fractal.fractal_class') ?: Fractal::class;
+        $fractalClass = config('fractal.fractal_class') ?? Fractal::class;
 
         return $fractalClass::create($data, $transformer, $serializer);
     }

src/helpers.php

@@ -25,6 +25,7 @@ public function it_uses_the_default_paginator_when_it_is_specified()
             new TestTransformer()
         )->toArray();
 
+
         $expectedArray = [
             'data' => [
                 ['id' => 1, 'author' => 'Philip K Dick'],

tests/ConfigPaginatorTest.php

@@ -30,7 +30,7 @@ public function it_can_transform_the_given_array_with_the_given_closure()
     /** @test */
     public function it_will_use_the_configured_serializer()
     {
-        $this->app['config']->set('laravel-fractal.default_serializer', ArraySerializer::class);
+        $this->app['config']->set('fractal.default_serializer', ArraySerializer::class);
 
         $response = FractalFacade::create()
             ->item($this->testBooks[0])
@@ -43,7 +43,7 @@ public function it_will_use_the_configured_serializer()
     /** @test */
     public function it_will_use_the_provided_serializer_instead_of_the_configured_serializer()
     {
-        $this->app['config']->set('laravel-fractal.default_serializer', DataArraySerializer::class);
+        $this->app['config']->set('fractal.default_serializer', DataArraySerializer::class);
 
         $actualArray = FractalFacade::create($this->testBooks, new TestTransformer, new ArraySerializer)->toArray();
 

tests/FractalFacadeTest.php

@@ -23,9 +23,9 @@ public function it_returns_a_default_instance_when_resolving_fractal_using_the_c
     /** @test */
     public function it_returns_a_configured_instance_when_resolving_fractal_using_the_container()
     {
-        $this->app->forgetInstance('laravel-fractal');
+        $this->app->forgetInstance('fractal');
 
-        app('config')->set('laravel-fractal.fractal_class', FractalExtensionClass::class);
+        app('config')->set('fractal.fractal_class', FractalExtensionClass::class);
 
         $this->assertInstanceOf(FractalExtensionClass::class, $this->app->make(Fractal::class));
     }