API Resources

src/Illuminate/Contracts/Database/CastsToResource.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Illuminate\Contracts\Database;
+
+interface CastsToResource
+{
+    /**
+     * Cast the given model into a resource.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @param  mixed  $model
+     * @return mixed
+     */
+    public static function castToResource($request, $model);
+
+    /**
+     * Cast the given paginator or collection into a resource.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @param  mixed  $collection
+     * @return mixed
+     */
+    public static function castCollectionToResource($request, $collection);
+}

src/Illuminate/Database/Eloquent/DetectsResource.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace Illuminate\Database\Eloquent;
+
+use Exception;
+
+trait DetectsResource
+{
+    /**
+     * Cast the given model into a resource.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @param  mixed  $model
+     * @return mixed
+     */
+    public static function castToResource($request, $model)
+    {
+        $class = $model->detectResourceName();
+
+        return new $class($model);
+    }
+
+    /**
+     * Cast the given paginator or collection into a resource.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @param  \Illuminate\Support\Collection  $collection
+     * @return mixed
+     */
+    public static function castCollectionToResource($request, $collection)
+    {
+        $class = $collection->first()->detectResourceName('Collection');
+
+        return new $class($collection);
+    }
+
+    /**
+     * Detect the resource name for the model.
+     *
+     * @param  string  $suffix
+     * @return string
+     */
+    public function detectResourceName($suffix = '')
+    {
+        $segments = explode('\\', get_class($this));
+
+        $base = array_pop($segments);
+
+        if (class_exists($class = implode('\\', $segments).'\\Http\\Resources\\'.$base.$suffix)) {
+            return $class;
+        }
+
+        throw new Exception(
+            "Unable to detect the resource for the [".get_class($this)."] model."
+        );
+    }
+}

src/Illuminate/Foundation/Console/ResourceMakeCommand.php

@@ -0,0 +1,91 @@
+<?php
+
+namespace Illuminate\Foundation\Console;
+
+use Illuminate\Support\Str;
+use Illuminate\Console\GeneratorCommand;
+use Symfony\Component\Console\Input\InputOption;
+
+class ResourceMakeCommand extends GeneratorCommand
+{
+    /**
+     * The console command name.
+     *
+     * @var string
+     */
+    protected $name = 'make:resource';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Create a new resource';
+
+    /**
+     * The type of class being generated.
+     *
+     * @var string
+     */
+    protected $type = 'Resource';
+
+    /**
+     * Execute the console command.
+     *
+     * @return bool|null
+     */
+    public function handle()
+    {
+        if ($this->collection()) {
+            $this->type = 'Resource collection';
+        }
+
+        parent::handle();
+    }
+
+    /**
+     * Get the stub file for the generator.
+     *
+     * @return string
+     */
+    protected function getStub()
+    {
+        return $this->collection()
+                    ? __DIR__.'/stubs/resource-collection.stub'
+                    : __DIR__.'/stubs/resource.stub';
+    }
+
+    /**
+     * Determine if the command is generating a resource collection.
+     *
+     * @return bool
+     */
+    protected function collection()
+    {
+        return $this->option('collection') ||
+               Str::endsWith($this->argument('name'), 'Collection');
+    }
+
+    /**
+     * Get the default namespace for the class.
+     *
+     * @param  string  $rootNamespace
+     * @return string
+     */
+    protected function getDefaultNamespace($rootNamespace)
+    {
+        return $rootNamespace.'\Http\Resources';
+    }
+
+    /**
+     * Get the console command options.
+     *
+     * @return array
+     */
+    protected function getOptions()
+    {
+        return [
+            ['collection', 'c', InputOption::VALUE_NONE, 'Create a resource collection.'],
+        ];
+    }
+}

src/Illuminate/Foundation/Console/stubs/resource-collection.stub

@@ -0,0 +1,19 @@
+<?php
+
+namespace DummyNamespace;
+
+use Illuminate\Http\Resources\Json\ResourceCollection;
+
+class DummyClass extends ResourceCollection
+{
+    /**
+     * Transform the resource collection into an array.
+     *
+     * @param  \Illuminate\Http\Request
+     * @return array
+     */
+    public function toArray($request)
+    {
+        return parent::toArray($request);
+    }
+}

src/Illuminate/Foundation/Console/stubs/resource.stub

@@ -0,0 +1,19 @@
+<?php
+
+namespace DummyNamespace;
+
+use Illuminate\Http\Resources\Json\Resource;
+
+class DummyClass extends Resource
+{
+    /**
+     * Transform the resource into an array.
+     *
+     * @param  \Illuminate\Http\Request
+     * @return array
+     */
+    public function toArray($request)
+    {
+        return parent::toArray($request);
+    }
+}

src/Illuminate/Foundation/Providers/ArtisanServiceProvider.php

@@ -37,6 +37,7 @@
 use Illuminate\Foundation\Console\StorageLinkCommand;
 use Illuminate\Routing\Console\ControllerMakeCommand;
 use Illuminate\Routing\Console\MiddlewareMakeCommand;
+use Illuminate\Foundation\Console\ResourceMakeCommand;
 use Illuminate\Foundation\Console\ListenerMakeCommand;
 use Illuminate\Foundation\Console\ProviderMakeCommand;
 use Illuminate\Foundation\Console\ClearCompiledCommand;
@@ -145,6 +146,7 @@ class ArtisanServiceProvider extends ServiceProvider
         'QueueFailedTable' => 'command.queue.failed-table',
         'QueueTable' => 'command.queue.table',
         'RequestMake' => 'command.request.make',
+        'ResourceMake' => 'command.resource.make',
         'RuleMake' => 'command.rule.make',
         'SeederMake' => 'command.seeder.make',
         'SessionTable' => 'command.session.table',
@@ -727,6 +729,18 @@ protected function registerRequestMakeCommand()
         });
     }
 
+    /**
+     * Register the command.
+     *
+     * @return void
+     */
+    protected function registerResourceMakeCommand()
+    {
+        $this->app->singleton('command.resource.make', function ($app) {
+            return new ResourceMakeCommand($app['files']);
+        });
+    }
+
     /**
      * Register the command.
      *

src/Illuminate/Http/Middleware/CastToResource.php

@@ -0,0 +1,89 @@
+<?php
+
+namespace Illuminate\Http\Middleware;
+
+use Closure;
+use Illuminate\Support\Collection;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Pagination\AbstractPaginator;
+use Illuminate\Contracts\Database\CastsToResource;
+
+class CastToResource
+{
+    /**
+     * Handle an incoming request.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @param  \Closure  $next
+     * @return mixed
+     */
+    public function handle($request, Closure $next)
+    {
+        $response = $next($request);
+
+        if (! isset($response->original)) {
+            return $response;
+        }
+
+        if ($response->original instanceof Model &&
+            $response->original instanceof CastsToResource) {
+            return $this->castModelToResource($request, $response);
+        }
+
+        if ($response->original instanceof Collection &&
+            $response->original->first() instanceof CastsToResource) {
+            return $this->castCollectionToResource($request, $response);
+        }
+
+        if ($response->original instanceof AbstractPaginator &&
+            $response->original->getCollection()->first() instanceof CastsToResource) {
+            return $this->castPaginatorToResource($request, $response);
+        }
+
+        return $response;
+    }
+
+    /**
+     * Cast the model sent within the response to a resource response.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @param  \Illuminate\Http\Response  $response
+     * @return \Illuminate\Http\Response
+     */
+    protected function castModelToResource($request, $response)
+    {
+        return $response->original->castToResource(
+            $request, $response->original
+        )->toResponse($request);
+    }
+
+    /**
+     * Cast the collection sent within the response to a resource response.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @param  \Illuminate\Http\Response  $response
+     * @return \Illuminate\Http\Response
+     */
+    protected function castCollectionToResource($request, $response)
+    {
+        return $response->original->first()->castCollectionToResource(
+            $request, $response->original
+        )->toResponse($request);
+    }
+
+    /**
+     * Cast the collection sent within the response to a resource response.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @param  \Illuminate\Http\Response  $response
+     * @return \Illuminate\Http\Response
+     */
+    protected function castPaginatorToResource($request, $response)
+    {
+        $collection = $response->original->getCollection();
+
+        return $collection->first()->castCollectionToResource(
+            $request, $response->original
+        )->toResponse($request);
+    }
+}

src/Illuminate/Http/Resources/CollectsResources.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace Illuminate\Http\Resources;
+
+use Illuminate\Support\Str;
+use Illuminate\Support\Collection;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Pagination\AbstractPaginator;
+use Illuminate\Database\Eloquent\Collection as EloquentCollection;
+
+trait CollectsResources
+{
+    /**
+     * Map the given collection resource into its individual resources.
+     *
+     * @param  mixed  $resource
+     * @return mixed
+     */
+    protected function collectResource($resource)
+    {
+        $this->collection = $resource->mapInto($this->collects());
+
+        return $resource instanceof AbstractPaginator
+                    ? $resource->setCollection($this->collection)
+                    : $this->collection;
+    }
+
+    /**
+     * Get the resource that this resource collects.
+     *
+     * @return string
+     */
+    protected function collects()
+    {
+        if ($this->collects) {
+            return $this->collects;
+        }
+
+        if (Str::endsWith(class_basename($this), 'Collection') &&
+            class_exists($class = Str::replaceLast('Collection', '', get_class($this)))) {
+            return $class;
+        }
+
+        throw new UnknownCollectionException($this);
+    }
+
+    /**
+     * Get an iterator for the resource collection.
+     *
+     * @return \ArrayIterator
+     */
+    public function getIterator()
+    {
+        return $this->collection->getIterator();
+    }
+}