Merge pull request #12 from Lomkit/feature/changes-and-fixes

♻️ 🐛 fixes and changes suggested

Author: GautierDele

README.md

@@ -6,7 +6,7 @@ Laravel Rest Api is an elegant way to expose your app through an API, it takes f
 
 ## Requirements
 
-PHP 7.3+ and Laravel 8.0+
+PHP 8.0+ and Laravel 8.0+
 
 # BETA
 Please note that this package is under beta and is not recommended to use for production environment for now. End of beta should be by October 2023.
@@ -69,7 +69,7 @@ Here is a quick look at what you can do using API search method:
             "type": "max",
             "field": "rate",
             "filters": [
-                {"field": "approved', "value": true}
+                {"field": "approved", "value": true}
             ]
         },
     ],

composer.json

@@ -10,7 +10,7 @@
     }
   ],
   "require": {
-    "php": "^7.3|^8.0",
+    "php": "^8.0",
     "ext-json": "*",
     "illuminate/contracts": "^8.37|^9.0|^10.0",
     "illuminate/http": "^8.37|^9.0|^10.0",

src/Concerns/Resource/ConfiguresRestParameters.php

@@ -9,7 +9,7 @@
 
 trait ConfiguresRestParameters
 {
-    public function exposedFields(RestRequest $request) {
+    public function exposedFields(RestRequest $request): array {
         return [];
     }
 
@@ -47,11 +47,11 @@ function ($exposedField) use ($prefix) {
         return $exposedFields;
     }
 
-    public function exposedScopes(RestRequest $request) {
+    public function exposedScopes(RestRequest $request): array {
         return [];
     }
 
-    public function exposedLimits(RestRequest $request) {
+    public function exposedLimits(RestRequest $request): array {
         return [
             10,
             25,

src/Concerns/Resource/Relationable.php

@@ -53,7 +53,7 @@ public function nestedRelations(RestRequest $request, string $prefix = '', array
         return $relations;
     }
 
-    public function relations(RestRequest $request) {
+    public function relations(RestRequest $request): array {
         return [];
     }
 

src/Console/Commands/ControllerCommand.php

@@ -8,6 +8,7 @@
 use Illuminate\Support\Composer;
 use Illuminate\Support\Str;
 use Lomkit\Rest\Console\ResolvesStubPath;
+use Lomkit\Rest\Tests\Support\Rest\Resources\ModelResource;
 
 class ControllerCommand extends GeneratorCommand implements PromptsForMissingInput
 {
@@ -58,7 +59,7 @@ protected function buildClass($name)
         $resourceNamespace = $this->getResourceNamespace();
 
         if (is_null($resource)) {
-            $resource = $resourceNamespace.str_replace('/', '\\', $this->argument('name'));
+            $resource = $resourceNamespace.'ModelResource';
         } elseif (! Str::startsWith($resource, [
             $resourceNamespace, '\\',
         ])) {

src/Console/Commands/QuickStartCommand.php

@@ -33,7 +33,7 @@ public function handle()
     {
         $this->comment('Generating User Resource...');
         $this->callSilent('rest:resource', ['name' => 'UserResource']);
-        copy($this->resolveStubPath('../stubs/user-resource.stub'), app_path('Rest/Resources/UserResource.php'));
+        copy($this->resolveStubPath('/stubs/user-resource.stub'), app_path('Rest/Resources/UserResource.php'));
 
         if (file_exists(app_path('Models/User.php'))) {
             file_put_contents(
@@ -44,7 +44,7 @@ public function handle()
 
         $this->comment('Generating User Controller...');
         $this->callSilent('rest:controller', ['name' => 'UsersController']);
-        copy($this->resolveStubPath('../stubs/user-controller.stub'), app_path('Http/Controllers/UsersController.php'));
+        copy($this->resolveStubPath('/stubs/user-controller.stub'), app_path('Http/Controllers/UsersController.php'));
 
         if (file_exists(app_path('Models/User.php'))) {
             file_put_contents(
@@ -75,7 +75,7 @@ protected function setAppNamespace()
     {
         $namespace = $this->laravel->getNamespace();
 
-        $this->setAppNamespaceOn(app_path('Rest/Resource/UserResource.php'), $namespace);
+        $this->setAppNamespaceOn(app_path('Rest/Resources/UserResource.php'), $namespace);
         $this->setAppNamespaceOn(app_path('Http/Controllers/UsersController.php'), $namespace);
     }
 

src/Console/Commands/ResourceCommand.php

@@ -53,7 +53,7 @@ public function handle()
      */
     protected function buildClass($name)
     {
-        $model = $this->option('model');
+        $model = $this->option('model') ?? 'App\\Models\\Model';
 
         $modelNamespace = $this->getModelNamespace();
 

src/Console/stubs/base-resource.stub

@@ -10,21 +10,21 @@ abstract class Resource extends RestResource
      * Build a query for fetching resource.
      *
      * @param  \Lomkit\Rest\Http\Requests\RestRequest  $request
-     * @param  \Illuminate\Database\Eloquent\Builder  $query
-     * @return \Illuminate\Database\Eloquent\Builder
+     * @param  \Illuminate\Contracts\Database\Eloquent\Builder  $query
+     * @return \Illuminate\Contracts\Database\Eloquent\Builder
      */
-    public function fetchQuery(\Lomkit\Rest\Http\Requests\RestRequest $request, \Illuminate\Database\Eloquent\Builder $query) {
+    public function fetchQuery(\Lomkit\Rest\Http\Requests\RestRequest $request, \Illuminate\Contracts\Database\Eloquent\Builder $query) {
         return $query;
     }
 
     /**
      * Build a "destroy" query for the given resource.
      *
      * @param  \Lomkit\Rest\Http\Requests\RestRequest  $request
-     * @param  \Illuminate\Database\Eloquent\Builder  $query
-     * @return \Illuminate\Database\Eloquent\Builder
+     * @param  \Illuminate\Contracts\Database\Eloquent\Builder  $query
+     * @return \Illuminate\Contracts\Database\Eloquent\Builder
      */
-    public function destroyQuery(\Lomkit\Rest\Http\Requests\RestRequest $request, \Illuminate\Database\Eloquent\Builder $query)
+    public function destroyQuery(\Lomkit\Rest\Http\Requests\RestRequest $request, \Illuminate\Contracts\Database\Eloquent\Builder $query)
     {
         return $query;
     }
@@ -33,10 +33,10 @@ abstract class Resource extends RestResource
      * Build a "restore" query for the given resource.
      *
      * @param  \Lomkit\Rest\Http\Requests\RestRequest  $request
-     * @param  \Illuminate\Database\Eloquent\Builder  $query
-     * @return \Illuminate\Database\Eloquent\Builder
+     * @param  \Illuminate\Contracts\Database\Eloquent\Builder  $query
+     * @return \Illuminate\Contracts\Database\Eloquent\Builder
      */
-    public function restoreQuery(\Lomkit\Rest\Http\Requests\RestRequest $request, \Illuminate\Database\Eloquent\Builder $query)
+    public function restoreQuery(\Lomkit\Rest\Http\Requests\RestRequest $request, \Illuminate\Contracts\Database\Eloquent\Builder $query)
     {
         return $query;
     }
@@ -45,10 +45,10 @@ abstract class Resource extends RestResource
      * Build a "forceDelete" query for the given resource.
      *
      * @param  \Lomkit\Rest\Http\Requests\RestRequest  $request
-     * @param  \Illuminate\Database\Eloquent\Builder  $query
-     * @return \Illuminate\Database\Eloquent\Builder
+     * @param  \Illuminate\Contracts\Database\Eloquent\Builder  $query
+     * @return \Illuminate\Contracts\Database\Eloquent\Builder
      */
-    public function forceDeleteQuery(\Lomkit\Rest\Http\Requests\RestRequest $request, \Illuminate\Database\Eloquent\Builder $query)
+    public function forceDeleteQuery(\Lomkit\Rest\Http\Requests\RestRequest $request, \Illuminate\Contracts\Database\Eloquent\Builder $query)
     {
         return $query;
     }

src/Console/stubs/resource.stub

@@ -4,7 +4,7 @@ namespace {{ namespace }};
 
 use App\Rest\Resource as RestResource;
 
-class {{ class }} extends Resource
+class {{ class }} extends RestResource
 {
     /**
      * The model the resource corresponds to.
@@ -13,23 +13,25 @@ class {{ class }} extends Resource
      */
     public static $model = \{{ namespacedModel }}::class;
 
-    public function exposedFields(\Lomkit\Rest\Http\Requests\RestRequest $request)
+    public function exposedFields(\Lomkit\Rest\Http\Requests\RestRequest $request): array
     {
         return [
             'id'
         ];
     }
 
-    public function relations(\Lomkit\Rest\Http\Requests\RestRequest $request)
+    public function relations(\Lomkit\Rest\Http\Requests\RestRequest $request): array
     {
         return [];
     }
 
-    public function exposedScopes(\Lomkit\Rest\Http\Requests\RestRequest $request) {
+    public function exposedScopes(\Lomkit\Rest\Http\Requests\RestRequest $request): array
+    {
         return [];
     }
 
-    public function exposedLimits(\Lomkit\Rest\Http\Requests\RestRequest $request) {
+    public function exposedLimits(\Lomkit\Rest\Http\Requests\RestRequest $request): array
+    {
         return [
             10,
             25,

src/Console/stubs/user-controller.stub

@@ -11,5 +11,5 @@ class UsersController extends RestController
      *
      * @var class-string<\Lomkit\Rest\Http\Resource>
      */
-    public static $resource = \App\User::class;
+    public static $resource = \App\Rest\Resources\UserResource::class;
 }