chore: merge branch 'patch-api'

* patch-api: feat(api): add `fulfill` method to all http request classes refactor(api): change base http request abstract to interface
creasico · Oct 11, 2023 · 3bd952e · 3bd952e
2 parents cd7d138 + 304ccab
commit 3bd952e
Show file tree

Hide file tree

Showing 22 changed files with 112 additions and 56 deletions.
diff --git a/src/Contracts/FormRequest.php b/src/Contracts/FormRequest.php
@@ -0,0 +1,11 @@
+<?php
+
+namespace Creasi\Base\Contracts;
+
+/**
+ * @method \Creasi\Base\Models\User|null user()
+ */
+interface FormRequest
+{
+    // .
+}
diff --git a/src/Http/Controllers/AddressController.php b/src/Http/Controllers/AddressController.php
@@ -32,7 +32,7 @@ public function index(Entity $entity)
      */
     public function store(StoreRequest $request, Entity $entity)
     {
-        $item = $request->storeFor($entity);
+        $item = $request->fulfill($entity);
 
         return $this->show($item, $request)->setStatusCode(201);
     }
@@ -52,9 +52,9 @@ public function show(Address $model, Request $request, int $address = null)
      */
     public function update(UpdateRequest $request, Address $model, int $address = null)
     {
-        $address = $model->newQuery()->findOrFail($address);
-
-        $address->update($request->validated());
+        $request->fulfill(
+            $address = $model->newQuery()->findOrFail($address)
+        );
 
         return $this->show($address, $request);
     }

diff --git a/src/Http/Controllers/CompanyController.php b/src/Http/Controllers/CompanyController.php
@@ -33,8 +33,7 @@ public function index(Company $company)
      */
     public function store(StoreRequest $request, Company $company)
     {
-        /** @var Company $item */
-        $item = $company->create($request->validated());
+        $item = $request->fulfill($company);
 
         return $this->show($item, $request)->setStatusCode(201);
     }
@@ -52,7 +51,7 @@ public function show(Company $company, Request $request)
      */
     public function update(UpdateRequest $request, Company $company)
     {
-        $company->update($request->validated());
+        $request->fulfill($company);
 
         return $this->show($company, $request);
     }

diff --git a/src/Http/Controllers/EmployeeController.php b/src/Http/Controllers/EmployeeController.php
@@ -33,7 +33,7 @@ public function index(Company $company)
     public function store(StoreRequest $request, Company $company)
     {
         /** @var Employee */
-        $item = $company->employees()->create($request->validated());
+        $item = $request->fulfill($company);
 
         return $this->show($item, $request)->setStatusCode(201);
     }
@@ -51,7 +51,7 @@ public function show(Employee $employee, Request $request)
      */
     public function update(UpdateRequest $request, Employee $employee)
     {
-        $employee->update($request->validated());
+        $request->fulfill($employee);
 
         return $this->show($employee, $request);
     }

diff --git a/src/Http/Controllers/FileUploadController.php b/src/Http/Controllers/FileUploadController.php
@@ -32,7 +32,7 @@ public function index(Entity $entity)
      */
     public function store(StoreRequest $request, Entity $entity)
     {
-        $item = $request->storeFor($entity);
+        $item = $request->fulfill($entity);
 
         return $this->show($item, $request)->setStatusCode(201);
     }
@@ -52,9 +52,9 @@ public function show(FileUpload $model, Request $request, string $file = null)
      */
     public function update(UpdateRequest $request, FileUpload $model, string $file = null)
     {
-        $file = $model->newQuery()->findOrFail($file);
-
-        $file->update($request->validated());
+        $request->fulfill(
+            $file = $model->newQuery()->findOrFail($file)
+        );
 
         return $this->show($file, $request);
     }

diff --git a/src/Http/Controllers/StakeholderController.php b/src/Http/Controllers/StakeholderController.php
@@ -55,7 +55,7 @@ public function show(Stakeholder $stakeholder, Request $request)
      */
     public function update(UpdateRequest $request, Stakeholder $stakeholder)
     {
-        $stakeholder->update($request->validated());
+        $request->fulfill($stakeholder);
 
         return $this->show($stakeholder, $request);
     }

diff --git a/src/Http/Requests/Address/StoreRequest.php b/src/Http/Requests/Address/StoreRequest.php
@@ -2,13 +2,14 @@
 
 namespace Creasi\Base\Http\Requests\Address;
 
-use Creasi\Base\Http\Requests\FormRequest;
+use Creasi\Base\Contracts\FormRequest as FormRequestContract;
 use Creasi\Base\Models\Address;
 use Creasi\Base\Models\Enums\AddressType;
 use Creasi\Nusa\Contracts\HasAddresses;
+use Illuminate\Foundation\Http\FormRequest;
 use Illuminate\Validation\Rule;
 
-class StoreRequest extends FormRequest
+class StoreRequest extends FormRequest implements FormRequestContract
 {
     /**
      * @return array<string, array>
@@ -31,7 +32,7 @@ public function rules(): array
         ];
     }
 
-    public function storeFor(HasAddresses $entity)
+    public function fulfill(HasAddresses $entity)
     {
         $address = Address::query()->make($this->validated());
 

diff --git a/src/Http/Requests/Address/UpdateRequest.php b/src/Http/Requests/Address/UpdateRequest.php
@@ -2,10 +2,12 @@
 
 namespace Creasi\Base\Http\Requests\Address;
 
-use Creasi\Base\Http\Requests\FormRequest;
+use Creasi\Base\Contracts\FormRequest as FormRequestContract;
+use Creasi\Base\Models\Address;
+use Illuminate\Foundation\Http\FormRequest;
 use Illuminate\Validation\Rule;
 
-class UpdateRequest extends FormRequest
+class UpdateRequest extends FormRequest implements FormRequestContract
 {
     /**
      * @return array<string, array>
@@ -27,4 +29,9 @@ public function rules(): array
             'summary' => ['nullable', 'string', 'max:200'],
         ];
     }
+
+    public function fulfill(Address $address)
+    {
+        return $address->update($this->validated());
+    }
 }
diff --git a/src/Http/Requests/Company/StoreRequest.php b/src/Http/Requests/Company/StoreRequest.php
@@ -2,10 +2,12 @@
 
 namespace Creasi\Base\Http\Requests\Company;
 
-use Creasi\Base\Http\Requests\FormRequest;
+use Creasi\Base\Contracts\Company;
+use Creasi\Base\Contracts\FormRequest as FormRequestContract;
+use Illuminate\Foundation\Http\FormRequest;
 use Illuminate\Validation\Rule;
 
-class StoreRequest extends FormRequest
+class StoreRequest extends FormRequest implements FormRequestContract
 {
     /**
      * @return array<string, array>
@@ -20,4 +22,9 @@ public function rules(): array
             'summary' => ['nullable', 'string', 'max:200'],
         ];
     }
+
+    public function fulfill(Company $company)
+    {
+        return $company->create($this->validated());
+    }
 }
diff --git a/src/Http/Requests/Company/UpdateRequest.php b/src/Http/Requests/Company/UpdateRequest.php
@@ -2,9 +2,11 @@
 
 namespace Creasi\Base\Http\Requests\Company;
 
-use Creasi\Base\Http\Requests\FormRequest;
+use Creasi\Base\Contracts\Company;
+use Creasi\Base\Contracts\FormRequest as FormRequestContract;
+use Illuminate\Foundation\Http\FormRequest;
 
-class UpdateRequest extends FormRequest
+class UpdateRequest extends FormRequest implements FormRequestContract
 {
     /**
      * @return array<string, array>
@@ -19,4 +21,9 @@ public function rules(): array
             'summary' => ['nullable', 'string', 'max:200'],
         ];
     }
+
+    public function fulfill(Company $company)
+    {
+        return $company->update($this->validated());
+    }
 }
diff --git a/src/Http/Requests/Employee/StoreRequest.php b/src/Http/Requests/Employee/StoreRequest.php
@@ -2,11 +2,13 @@
 
 namespace Creasi\Base\Http\Requests\Employee;
 
-use Creasi\Base\Http\Requests\FormRequest;
+use Creasi\Base\Contracts\Company;
+use Creasi\Base\Contracts\FormRequest as FormRequestContract;
 use Creasi\Base\Models\Enums\Gender;
+use Illuminate\Foundation\Http\FormRequest;
 use Illuminate\Validation\Rule;
 
-class StoreRequest extends FormRequest
+class StoreRequest extends FormRequest implements FormRequestContract
 {
     /**
      * @return array<string, array>
@@ -22,4 +24,9 @@ public function rules(): array
             'summary' => ['nullable', 'string', 'max:200'],
         ];
     }
+
+    public function fulfill(Company $company)
+    {
+        return $company->employees()->create($this->validated());
+    }
 }
diff --git a/src/Http/Requests/Employee/UpdateRequest.php b/src/Http/Requests/Employee/UpdateRequest.php
@@ -2,9 +2,11 @@
 
 namespace Creasi\Base\Http\Requests\Employee;
 
-use Creasi\Base\Http\Requests\FormRequest;
+use Creasi\Base\Contracts\Employee;
+use Creasi\Base\Contracts\FormRequest as FormRequestContract;
+use Illuminate\Foundation\Http\FormRequest;
 
-class UpdateRequest extends FormRequest
+class UpdateRequest extends FormRequest implements FormRequestContract
 {
     /**
      * @return array<string, array>
@@ -19,4 +21,9 @@ public function rules(): array
             'summary' => ['nullable', 'string', 'max:200'],
         ];
     }
+
+    public function fulfill(Employee $employee)
+    {
+        return $employee->update($this->validated());
+    }
 }
diff --git a/src/Http/Requests/FileUpload/StoreRequest.php b/src/Http/Requests/FileUpload/StoreRequest.php
@@ -2,12 +2,13 @@
 
 namespace Creasi\Base\Http\Requests\FileUpload;
 
+use Creasi\Base\Contracts\FormRequest as FormRequestContract;
 use Creasi\Base\Contracts\HasFileUploads;
-use Creasi\Base\Http\Requests\FormRequest;
 use Creasi\Base\Models\Enums\FileUploadType;
+use Illuminate\Foundation\Http\FormRequest;
 use Illuminate\Validation\Rule;
 
-class StoreRequest extends FormRequest
+class StoreRequest extends FormRequest implements FormRequestContract
 {
     /**
      * @return array<string, array>
@@ -22,7 +23,7 @@ public function rules(): array
         ];
     }
 
-    public function storeFor(HasFileUploads $entity)
+    public function fulfill(HasFileUploads $entity)
     {
         /** @var FileUploadType */
         $type = $this->enum('type', FileUploadType::class);

diff --git a/src/Http/Requests/FileUpload/UpdateRequest.php b/src/Http/Requests/FileUpload/UpdateRequest.php
@@ -2,9 +2,11 @@
 
 namespace Creasi\Base\Http\Requests\FileUpload;
 
-use Creasi\Base\Http\Requests\FormRequest;
+use Creasi\Base\Contracts\FormRequest as FormRequestContract;
+use Creasi\Base\Models\FileUpload;
+use Illuminate\Foundation\Http\FormRequest;
 
-class UpdateRequest extends FormRequest
+class UpdateRequest extends FormRequest implements FormRequestContract
 {
     /**
      * @return array<string, array>
@@ -18,4 +20,9 @@ public function rules(): array
             'upload' => ['nullable', 'file'],
         ];
     }
+
+    public function fulfill(FileUpload $file)
+    {
+        return $file->update($this->validated());
+    }
 }
diff --git a/src/Http/Requests/FormRequest.php b/src/Http/Requests/FormRequest.php
diff --git a/src/Http/Requests/ProfileRequest.php b/src/Http/Requests/ProfileRequest.php
@@ -2,11 +2,13 @@
 
 namespace Creasi\Base\Http\Requests;
 
+use Creasi\Base\Contracts\FormRequest as FormRequestContract;
 use Creasi\Base\Models\Enums\Education;
 use Creasi\Base\Models\Enums\TaxStatus;
+use Illuminate\Foundation\Http\FormRequest;
 use Illuminate\Validation\Rule;
 
-class ProfileRequest extends FormRequest
+class ProfileRequest extends FormRequest implements FormRequestContract
 {
     /**
      * @return array<string, array>

diff --git a/src/Http/Requests/SettingRequest.php b/src/Http/Requests/SettingRequest.php
@@ -2,7 +2,10 @@
 
 namespace Creasi\Base\Http\Requests;
 
-class SettingRequest extends FormRequest
+use Creasi\Base\Contracts\FormRequest as FormRequestContract;
+use Illuminate\Foundation\Http\FormRequest;
+
+class SettingRequest extends FormRequest implements FormRequestContract
 {
     /**
      * @return array<string, array>

diff --git a/src/Http/Requests/Stakeholder/StoreRequest.php b/src/Http/Requests/Stakeholder/StoreRequest.php
@@ -3,11 +3,12 @@
 namespace Creasi\Base\Http\Requests\Stakeholder;
 
 use Creasi\Base\Contracts\Company;
-use Creasi\Base\Http\Requests\FormRequest;
+use Creasi\Base\Contracts\FormRequest as FormRequestContract;
 use Creasi\Base\Models\Enums\BusinessRelativeType;
+use Illuminate\Foundation\Http\FormRequest;
 use Illuminate\Validation\Rule;
 
-class StoreRequest extends FormRequest
+class StoreRequest extends FormRequest implements FormRequestContract
 {
     /**
      * @return array<string, array>

diff --git a/src/Http/Requests/Stakeholder/UpdateRequest.php b/src/Http/Requests/Stakeholder/UpdateRequest.php
@@ -2,9 +2,11 @@
 
 namespace Creasi\Base\Http\Requests\Stakeholder;
 
-use Creasi\Base\Http\Requests\FormRequest;
+use Creasi\Base\Contracts\FormRequest as FormRequestContract;
+use Creasi\Base\Contracts\Stakeholder;
+use Illuminate\Foundation\Http\FormRequest;
 
-class UpdateRequest extends FormRequest
+class UpdateRequest extends FormRequest implements FormRequestContract
 {
     /**
      * @return array<string, array>
@@ -19,4 +21,9 @@ public function rules(): array
             'summary' => ['nullable', 'string', 'max:200'],
         ];
     }
+
+    public function fulfill(Stakeholder $stakeholder)
+    {
+        return $stakeholder->update($this->validated());
+    }
 }
diff --git a/src/Repository.php b/src/Repository.php
@@ -76,7 +76,7 @@ public function resolveBusinessRelativeType(): BusinessRelativeType
 
     private function currentRoutePrefix(string $prefix = null)
     {
-        $name = \explode('.', $this->router->currentRouteName())[0];
+        $name = \explode('.', $this->router->currentRouteName())[1];
 
         return $prefix ? $name === $prefix : $name;
     }