wip

Author: d8vjork

.gitignore

@@ -0,0 +1,3 @@
+/vendor/
+composer.lock
+.phpunit.result.cache

README.md

@@ -1,2 +1,4 @@
 # laravel-json-api
-Integrate JSON:API resources on Laravel
+Integrate JSON:API resources on Laravel.
+
+**Note: This package is under active development and initial stage, please DON'T use it for production purposes.**

composer.json

@@ -0,0 +1,22 @@
+{
+    "name": "skore-labs/laravel-json-api",
+    "description": "Integrate JSON:API resources on Laravel",
+    "type": "library",
+    "license": "MIT",
+    "minimum-stability": "stable",
+    "require": {
+        "php": "^7.1",
+        "illuminate/http": "~5.6.34|~5.7.0|~5.8.0",
+        "illuminate/support": "~5.6.34|~5.7.0|~5.8.0"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^7.0|^8.0",
+        "orchestra/testbench": "~3.6.0|~3.7.0|~3.8.0",
+        "ext-json": "*"
+    },
+    "autoload": {
+        "psr-4": {
+            "SkoreLabs\\JsonApi\\": "src"
+        }
+    }
+}

phpunit.xml.dist

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit bootstrap="vendor/autoload.php"
+         backupGlobals="false"
+         backupStaticAttributes="false"
+         colors="true"
+         verbose="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="true"
+         stopOnFailure="false">
+    <testsuites>
+        <testsuite name="Skore Test Suite">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist>
+            <directory suffix=".php">src/</directory>
+        </whitelist>
+    </filter>
+    <php>
+        <env name="DB_CONNECTION" value="testing"/>
+    </php>
+</phpunit>

src/Http/Resources/CollectsWithRelationships.php

@@ -0,0 +1,88 @@
+<?php
+
+namespace SkoreLabs\JsonApi\Http\Resources;
+
+use Illuminate\Database\Eloquent\{Model, Collection};
+use Illuminate\Support\{Str, Collection as SupportCollection};
+
+trait CollectsWithRelationships
+{
+    /**
+     * Included relations on the response.
+     *
+     * @var array
+     */
+    protected $included = [];
+
+    /**
+     * Process resources relationships to included/relationship attributes.
+     *
+     * @return void
+     */
+    protected function processRelations() 
+    {
+        $this->collection->map(function (JsonApiResource $jsonResource) {
+            $relations = $jsonResource->resource->getRelations();
+
+            foreach ($relations as $relation => $relationObj) {
+                if ($relationObj instanceof Collection) {
+                    foreach ($relationObj->all() as $relationModel) {
+                        $jsonResource->with['relationships'][$relation]['data'][] = $this->processModelRelation(
+                            $relationModel
+                        );
+                    }
+                }
+
+                if ($relationObj instanceof Model) {
+                    $jsonResource->with['relationships'][$relation]['data'] = $this->processModelRelation(
+                        $relationObj
+                    );
+                }
+
+                $jsonResource->resource->unsetRelation($relation);
+            }
+
+            return $jsonResource;
+        });
+
+        $this->removeRepeateds();
+    }
+
+    public function with()
+    {
+        return $this->included;
+    }
+
+    /**
+     * Process a model relation attaching to its model additional attributes.
+     *
+     * @param \Illuminate\Database\Eloquent\Model $relation
+     * @return void
+     */
+    protected function processModelRelation(Model $relation)
+    {
+        $relatedModelType = Str::lower(class_basename($relation));
+
+        $this->included[] = [
+            'id' => (string) $relation->getKey(),
+            'type' => $relatedModelType,
+            'attributes' => array_filter($relation->toArray(), function ($key) {
+                return ! Str::endsWith($key, '_id') && $key !== 'id';
+            }, ARRAY_FILTER_USE_KEY),
+        ];
+
+        return [
+            $relation->getKeyName() => (string) $relation->getKey(),
+            'type' => $relatedModelType,
+        ];
+    }
+
+    public function removeRepeateds()
+    {
+        $filtered = SupportCollection::make($this->included)->unique(function ($item) {
+            return $item['id'] . $item['type'];
+        });
+
+        $this->included = $filtered->values()->all();
+    }
+}

src/Http/Resources/ConditionallyLoadsResources.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace SkoreLabs\JsonApi\Http\Resources;
+
+use Illuminate\Http\Resources\MissingValue;
+
+trait ConditionallyLoadsAttributes
+{
+    /**
+     * Retrieve an attribute if it has been appended.
+     *
+     * @param  string  $attribute
+     * @param  mixed  $value
+     * @param  mixed  $default
+     * @return \Illuminate\Http\Resources\MissingValue|mixed
+     */
+    protected function whenAppended($attribute, $value = null, $default = null)
+    {
+        if (func_num_args() < 3) {
+            $default = new MissingValue();
+        }
+
+        if (! $this->resource->getAppends('flags')) {
+            return value($default);
+        }
+
+        if (func_num_args() === 1) {
+            return $this->resource->{$attribute};
+        }
+
+        if ($this->resource->{$attribute} === null) {
+            return;
+        }
+
+        return value($value);
+    }
+}

src/Http/Resources/JsonApiCollection.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace SkoreLabs\JsonApi\Http\Resources;
+
+use Illuminate\Http\Resources\Json\ResourceCollection;
+
+class JsonApiCollection extends ResourceCollection
+{
+    use CollectsWithRelationships;
+
+    /**
+     * Create a new resource instance.
+     *
+     * @param  mixed  $resource
+     * @return void
+     */
+    public function __construct($resource)
+    {
+        $this->collects = JsonApiResource::class;
+
+        parent::__construct($resource);
+        
+        $this->processRelations();
+    }
+
+    /**
+     * Transform the resource into an array.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @return array
+     */
+    public function toArray($request)
+    {
+        // 
+
+        return JsonApiResource::collection(
+            $this->collection
+        );
+    }
+
+    /**
+     * Get any additional data that should be returned with the resource array.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @return array
+     */
+    public function with($request)
+    {
+        return [
+            'included' => $this->when(
+                $this->included, $this->included
+            ),
+        ];
+    }
+}

src/Http/Resources/JsonApiResource.php

@@ -0,0 +1,108 @@
+<?php
+
+namespace SkoreLabs\JsonApi\Http\Resources;
+
+use Illuminate\Http\Resources\Json\JsonResource;
+use Illuminate\Http\Resources\MissingValue;
+use Illuminate\Support\Facades\Auth;
+use Illuminate\Support\Str;
+
+class JsonApiResource extends JsonResource
+{
+    use RelationshipsWithIncludes, ConditionallyLoadsAttributes;
+
+    /**
+     * The resource instance.
+     *
+     * @var \Illuminate\Database\Eloquent\Model
+     */
+    public $resource;
+
+    /**
+     * Specify if show any pivot table data.
+     *
+     * @var bool
+     */
+    protected $showPivot = false;
+
+    /**
+     * Determine whether authorize to view this resource.
+     *
+     * @var bool
+     */
+    protected $authorize;
+
+    /**
+     * Authorize to view this resource.
+     *
+     * @return bool
+     */
+    protected function authorize()
+    {
+        $strClass = get_class($this->resource);
+
+        return $this->authorize
+            ?: is_string($strClass)
+            ?: Auth::user()->can('viewAny', $strClass)
+            ?: Auth::user()->can('view', $this->resource);
+    }
+
+    /**
+     * Set authorization bypassing automatic authorization.
+     *
+     * @param bool $value
+     * @return void
+     */
+    public function setAuthorize($value = true)
+    {
+        $this->authorize = $value;
+    }
+
+    /**
+     * Transform the resource into an array.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @return array
+     */
+    public function toArray($request)
+    {
+        if ($this->authorize() === false) {
+            return new MissingValue();
+        }
+
+        if (is_null($this->resource)) {
+            return [];
+        }
+
+        return (is_array($this->resource))
+            ? $this->resource
+            : $this->formatResponse();
+    }
+
+    /**
+     * Format model response to array.
+     *
+     * @return array
+     */
+    protected function formatResponse()
+    {
+        $hiddenAttrs = [
+            $this->resource->getKeyName(),
+        ];
+
+        if (! $this->showPivot) {
+            $hiddenAttrs[] = 'pivot';
+        }
+
+        $this->resource->addHidden($hiddenAttrs);
+
+        return [
+            $this->resource->getKeyName() => (string) $this->resource->getKey(),
+            'type' => Str::lower(class_basename($this->resource)),
+            'attributes' => $this->resource->toArray(),
+            'relationships' => $this->when(
+                $this->relationships, $this->relationships
+            ),
+        ];
+    }
+}