wip

Author: freekmurze

UPGRADE.md

@@ -1,5 +1,11 @@
 # Upgrade guide
 
+## From v5 to v6
+
+In most cases, you don't need to do anything to upgrade, the API has remained the same.
+
+The facade has been moved from `Spatie\Fractal\FractalFacade` to `Spatie\Fractal\Facades\Fractal`.
+
 ## From v4 to v5
 
 If you have a configuration file named `laravel-fractal.php`, rename it to `fractal.php` for it to still be used.

composer.json

@@ -21,10 +21,11 @@
         }
     ],
     "require": {
-        "php" : "^8.0",
+        "php": "^8.0",
         "illuminate/contracts": "^9.0",
         "illuminate/support": "^9.0",
-        "spatie/fractalistic": "^2.5"
+        "spatie/fractalistic": "^2.5",
+        "spatie/laravel-package-tools": "^1.11"
     },
     "require-dev": {
         "orchestra/testbench": "^7.0",
@@ -56,7 +57,7 @@
                 "Spatie\\Fractal\\FractalServiceProvider"
             ],
             "aliases": {
-                "Fractal": "Spatie\\Fractal\\FractalFacade"
+                "Fractal": "Spatie\\Fractal\\Facades\\Fractal"
             }
         }
     },

src/Console/Commands/TransformerMakeCommand.php

@@ -6,43 +6,17 @@
 
 class TransformerMakeCommand extends GeneratorCommand
 {
-    /**
-     * The name and signature of the console command.
-     *
-     * @var string
-     */
     protected $name = 'make:transformer';
 
-    /**
-     * The console command description.
-     *
-     * @var string
-     */
     protected $description = 'Create a new Fractal transformer class';
 
-    /**
-     * The type of class being generated.
-     *
-     * @var string
-     */
     protected $type = 'Transformer';
 
-    /**
-     * Get the stub file for the generator.
-     *
-     * @return string
-     */
     protected function getStub()
     {
         return __DIR__.'/../stubs/transformer.stub';
     }
 
-    /**
-     * Get the default namespace for the class.
-     *
-     * @param  string  $rootNamespace
-     * @return string
-     */
     protected function getDefaultNamespace($rootNamespace)
     {
         return $rootNamespace.'\Transformers';

src/Facades/Fractal.php

@@ -9,12 +9,7 @@
  */
 class Fractal extends Facade
 {
-    /**
-     * Get the registered name of the component.
-     *
-     * @return string
-     */
-    protected static function getFacadeAccessor()
+    protected static function getFacadeAccessor(): string
     {
         return 'fractal';
     }

src/Fractal.php

@@ -10,6 +10,7 @@
 use League\Fractal\Pagination\IlluminatePaginatorAdapter;
 use League\Fractal\Serializer\JsonApiSerializer;
 use League\Fractal\Serializer\SerializerAbstract;
+use League\Fractal\TransformerAbstract;
 use Spatie\Fractalistic\Fractal as Fractalistic;
 
 class Fractal extends Fractalistic
@@ -78,16 +79,11 @@ public static function create($data = null, $transformer = null, $serializer = n
         return $fractal->serializeWith(new $serializer());
     }
 
-    /**
-     * Return a new JSON response.
-     *
-     * @param  callable|int $statusCode
-     * @param  callable|array $headers
-     * @param  callable|int $options
-     *
-     * @return \Illuminate\Http\JsonResponse
-     */
-    public function respond($statusCode = 200, $headers = [], $options = 0)
+    public function respond(
+        callable|int $statusCode = 200,
+        callable|array $headers = [],
+        callable|int $options = 0
+    ): JsonResponse
     {
         $response = new JsonResponse();
 

src/FractalFacade.php

@@ -7,57 +7,32 @@
 use Illuminate\Support\ServiceProvider;
 use Laravel\Lumen\Application as LumenApplication;
 use Spatie\Fractal\Console\Commands\TransformerMakeCommand;
+use Spatie\LaravelPackageTools\Package;
+use Spatie\LaravelPackageTools\PackageServiceProvider;
 
-class FractalServiceProvider extends ServiceProvider
+class FractalServiceProvider extends PackageServiceProvider
 {
-    /**
-     * Bootstrap the application services.
-     */
-    public function boot()
+    public function configurePackage(Package $package): void
     {
-        $this->setupConfig();
-
-        if ($this->app->runningInConsole()) {
-            $this->commands([
-                TransformerMakeCommand::class,
-            ]);
-        }
+        $package
+            ->name('laravel-fractal')
+            ->hasConfigFile()
+            ->hasCommand(TransformerMakeCommand::class);
+    }
 
-        $this->setupMacro();
+    public function packageBooted()
+    {
+        Collection::macro('transformWith', function ($transformer) {
+            return fractal($this, $transformer);
+        });
     }
 
-    /**
-     * Register the application services.
-     */
-    public function register()
+    public function packageRegistered()
     {
         $this->app->singleton('fractal', function ($app, $arguments) {
             return fractal(...$arguments);
         });
 
         $this->app->alias('fractal', Fractal::class);
     }
-
-    protected function setupConfig()
-    {
-        $source = realpath(__DIR__.'/../config/fractal.php');
-
-        if ($this->app instanceof LaravelApplication) {
-            $this->publishes([$source => config_path('fractal.php')]);
-        } elseif ($this->app instanceof LumenApplication) {
-            $this->app->configure('fractal');
-        }
-
-        $this->mergeConfigFrom($source, 'fractal');
-    }
-
-    /**
-     * Add a 'transformWith' macro to Laravel's collection.
-     */
-    protected function setupMacro()
-    {
-        Collection::macro('transformWith', function ($transformer) {
-            return fractal($this, $transformer);
-        });
-    }
 }

src/FractalServiceProvider.php

@@ -2,24 +2,23 @@
 
 namespace Spatie\Fractal\Test;
 
-use Fractal as FractalFacade;
 use League\Fractal\Serializer\DataArraySerializer;
 use Spatie\Fractalistic\ArraySerializer;
-use Spatie\Fractalistic\Fractal;
+use Spatie\Fractalistic\Fractal as FractalClass;
+use Spatie\Fractal\Facades\Fractal;
 
 class FractalFacadeTest extends TestCase
 {
     /** @test */
     public function it_returns_an_instance_of_fractal()
     {
-        $this->assertInstanceOf(Fractal::class, FractalFacade::collection([]));
-        $this->assertInstanceOf(Fractal::class, \Spatie\Fractal\Facades\Fractal::collection([]));
+        $this->assertInstanceOf(FractalClass::class, Fractal::collection([]));
     }
 
     /** @test */
     public function it_can_transform_the_given_array_with_the_given_closure()
     {
-        $transformedData = FractalFacade::collection(['item1', 'item2'], function ($item) {
+        $transformedData = Fractal::collection(['item1', 'item2'], function ($item) {
             return ['item' => $item.'-transformed'];
         })->toArray();
 
@@ -33,7 +32,7 @@ public function it_will_use_the_configured_serializer()
     {
         $this->app['config']->set('fractal.default_serializer', ArraySerializer::class);
 
-        $response = FractalFacade::create()
+        $response = Fractal::create()
             ->item($this->testBooks[0])
             ->transformWith(new TestTransformer())
             ->respond(200);
@@ -46,7 +45,7 @@ public function it_will_use_the_provided_serializer_instead_of_the_configured_se
     {
         $this->app['config']->set('fractal.default_serializer', DataArraySerializer::class);
 
-        $actualArray = FractalFacade::create($this->testBooks, new TestTransformer(), new ArraySerializer())->toArray();
+        $actualArray = Fractal::create($this->testBooks, new TestTransformer(), new ArraySerializer())->toArray();
 
         $expectedArray = [
             ['id' => 1, 'author' => 'Philip K Dick'],