From d410a8164bea1a6b4eb22d3a4f9e4681a892870a Mon Sep 17 00:00:00 2001
From: Mohammad Alavi <Mohammad.alavi1990@gmail.com>
Date: Sat, 8 Jun 2024 16:17:17 +0330
Subject: [PATCH] refactor: rename

---
 src/Facades/Response.php                      |  2 +-
 .../Accepted.php                              |  6 +--
 .../CreateFrom.php                            |  8 ++--
 .../Created.php                               |  6 +--
 .../GetRequestedIncludes.php                  |  2 +-
 .../GetTransformer.php                        |  6 +--
 .../NoContent.php                             |  6 +--
 .../{ResponseTransformer => Response}/Ok.php  |  6 +--
 src/Providers/ApiatoServiceProvider.php       |  4 +-
 .../ResponseMacroServiceProvider.php          | 38 +++++++++++++++++++
 ...esponseTransformerMacroServiceProvider.php | 38 -------------------
 .../{ResponseTransformer.php => Response.php} |  2 +-
 src/Traits/CanEagerLoadTrait.php              |  4 +-
 13 files changed, 64 insertions(+), 64 deletions(-)
 rename src/Macros/{ResponseTransformer => Response}/Accepted.php (76%)
 rename src/Macros/{ResponseTransformer => Response}/CreateFrom.php (65%)
 rename src/Macros/{ResponseTransformer => Response}/Created.php (76%)
 rename src/Macros/{ResponseTransformer => Response}/GetRequestedIncludes.php (92%)
 rename src/Macros/{ResponseTransformer => Response}/GetTransformer.php (71%)
 rename src/Macros/{ResponseTransformer => Response}/NoContent.php (76%)
 rename src/Macros/{ResponseTransformer => Response}/Ok.php (76%)
 create mode 100644 src/Providers/MacroProviders/ResponseMacroServiceProvider.php
 delete mode 100644 src/Providers/MacroProviders/ResponseTransformerMacroServiceProvider.php
 rename src/Services/{ResponseTransformer.php => Response.php} (96%)

diff --git a/src/Facades/Response.php b/src/Facades/Response.php
index 115da672..34c0b488 100644
--- a/src/Facades/Response.php
+++ b/src/Facades/Response.php
@@ -8,7 +8,7 @@
 use Spatie\Fractal\Facades\Fractal;
 
 /**
- * @method static \Apiato\Core\Services\ResponseTransformer createFrom(mixed $data = null, callable|TransformerAbstract|null $transformer = null, SerializerAbstract|null $serializer = null)
+ * @method static \Apiato\Core\Services\Response createFrom(mixed $data = null, callable|TransformerAbstract|null $transformer = null, SerializerAbstract|null $serializer = null)
  * @method static JsonResponse ok()
  * @method static JsonResponse created()
  * @method static JsonResponse noContent()
diff --git a/src/Macros/ResponseTransformer/Accepted.php b/src/Macros/Response/Accepted.php
similarity index 76%
rename from src/Macros/ResponseTransformer/Accepted.php
rename to src/Macros/Response/Accepted.php
index 93d50c34..10bfb8e4 100644
--- a/src/Macros/ResponseTransformer/Accepted.php
+++ b/src/Macros/Response/Accepted.php
@@ -1,10 +1,10 @@
 <?php
 
-namespace Apiato\Core\Macros\ResponseTransformer;
+namespace Apiato\Core\Macros\Response;
 
 use Apiato\Core\Abstracts\Transformers\Transformer;
 use Illuminate\Http\JsonResponse;
-use Apiato\Core\Services\ResponseTransformer;
+use Apiato\Core\Services\Response;
 
 class Accepted {
     public function __invoke(): callable
@@ -14,7 +14,7 @@ public function __invoke(): callable
              * Returns a 202 Accepted response.
              */
             function (): JsonResponse {
-                /** @var ResponseTransformer $this */
+                /** @var Response $this */
                 if (is_null($this->getTransformer())) {
                     $this->transformWith(Transformer::empty());
                 }
diff --git a/src/Macros/ResponseTransformer/CreateFrom.php b/src/Macros/Response/CreateFrom.php
similarity index 65%
rename from src/Macros/ResponseTransformer/CreateFrom.php
rename to src/Macros/Response/CreateFrom.php
index cab276c9..32e6db4c 100644
--- a/src/Macros/ResponseTransformer/CreateFrom.php
+++ b/src/Macros/Response/CreateFrom.php
@@ -1,8 +1,8 @@
 <?php
 
-namespace Apiato\Core\Macros\ResponseTransformer;
+namespace Apiato\Core\Macros\Response;
 
-use Apiato\Core\Services\ResponseTransformer;
+use Apiato\Core\Services\Response;
 use League\Fractal\Serializer\SerializerAbstract;
 use League\Fractal\TransformerAbstract;
 
@@ -13,8 +13,8 @@ public function __invoke(): callable
             /**
              * Create a new Response instance.
              */
-            function (mixed $data = null, callable|TransformerAbstract|null $transformer = null, SerializerAbstract|null $serializer = null): ResponseTransformer {
-                return ResponseTransformer::create($data, $transformer, $serializer);
+            function (mixed $data = null, callable|TransformerAbstract|null $transformer = null, SerializerAbstract|null $serializer = null): Response {
+                return Response::create($data, $transformer, $serializer);
             };
     }
 }
diff --git a/src/Macros/ResponseTransformer/Created.php b/src/Macros/Response/Created.php
similarity index 76%
rename from src/Macros/ResponseTransformer/Created.php
rename to src/Macros/Response/Created.php
index a0d50140..e67c1c19 100644
--- a/src/Macros/ResponseTransformer/Created.php
+++ b/src/Macros/Response/Created.php
@@ -1,10 +1,10 @@
 <?php
 
-namespace Apiato\Core\Macros\ResponseTransformer;
+namespace Apiato\Core\Macros\Response;
 
 use Apiato\Core\Abstracts\Transformers\Transformer;
 use Illuminate\Http\JsonResponse;
-use Apiato\Core\Services\ResponseTransformer;
+use Apiato\Core\Services\Response;
 
 class Created {
     public function __invoke(): callable
@@ -14,7 +14,7 @@ public function __invoke(): callable
              * Returns a 201 Created response.
              */
             function (): JsonResponse {
-                /** @var ResponseTransformer $this */
+                /** @var Response $this */
                 if (is_null($this->getTransformer())) {
                     $this->transformWith(Transformer::empty());
                 }
diff --git a/src/Macros/ResponseTransformer/GetRequestedIncludes.php b/src/Macros/Response/GetRequestedIncludes.php
similarity index 92%
rename from src/Macros/ResponseTransformer/GetRequestedIncludes.php
rename to src/Macros/Response/GetRequestedIncludes.php
index 9006d4ac..5600d548 100644
--- a/src/Macros/ResponseTransformer/GetRequestedIncludes.php
+++ b/src/Macros/Response/GetRequestedIncludes.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Apiato\Core\Macros\ResponseTransformer;
+namespace Apiato\Core\Macros\Response;
 
 use Illuminate\Support\Facades\Config;
 use Illuminate\Support\Facades\Request;
diff --git a/src/Macros/ResponseTransformer/GetTransformer.php b/src/Macros/Response/GetTransformer.php
similarity index 71%
rename from src/Macros/ResponseTransformer/GetTransformer.php
rename to src/Macros/Response/GetTransformer.php
index 8da5bc55..e81913c7 100644
--- a/src/Macros/ResponseTransformer/GetTransformer.php
+++ b/src/Macros/Response/GetTransformer.php
@@ -1,8 +1,8 @@
 <?php
 
-namespace Apiato\Core\Macros\ResponseTransformer;
+namespace Apiato\Core\Macros\Response;
 
-use Apiato\Core\Services\ResponseTransformer;
+use Apiato\Core\Services\Response;
 use League\Fractal\TransformerAbstract;
 
 class GetTransformer
@@ -10,7 +10,7 @@ class GetTransformer
     public function __invoke(): callable
     {
         return function (): string|callable|TransformerAbstract|null {
-            /** @var ResponseTransformer $this */
+            /** @var Response $this */
             // The warning is false positive. We will be in the context of Fractal class when this is called.
             return $this->transformer;
         };
diff --git a/src/Macros/ResponseTransformer/NoContent.php b/src/Macros/Response/NoContent.php
similarity index 76%
rename from src/Macros/ResponseTransformer/NoContent.php
rename to src/Macros/Response/NoContent.php
index 04035345..636418fa 100644
--- a/src/Macros/ResponseTransformer/NoContent.php
+++ b/src/Macros/Response/NoContent.php
@@ -1,10 +1,10 @@
 <?php
 
-namespace Apiato\Core\Macros\ResponseTransformer;
+namespace Apiato\Core\Macros\Response;
 
 use Apiato\Core\Abstracts\Transformers\Transformer;
 use Illuminate\Http\JsonResponse;
-use Apiato\Core\Services\ResponseTransformer;
+use Apiato\Core\Services\Response;
 
 class NoContent {
     public function __invoke(): callable
@@ -14,7 +14,7 @@ public function __invoke(): callable
              * Returns a 204 No Content response.
              */
             function (): JsonResponse {
-                /** @var ResponseTransformer $this */
+                /** @var Response $this */
                 if (is_null($this->getTransformer())) {
                     $this->transformWith(Transformer::empty());
                 }
diff --git a/src/Macros/ResponseTransformer/Ok.php b/src/Macros/Response/Ok.php
similarity index 76%
rename from src/Macros/ResponseTransformer/Ok.php
rename to src/Macros/Response/Ok.php
index 986a5432..37859e36 100644
--- a/src/Macros/ResponseTransformer/Ok.php
+++ b/src/Macros/Response/Ok.php
@@ -1,10 +1,10 @@
 <?php
 
-namespace Apiato\Core\Macros\ResponseTransformer;
+namespace Apiato\Core\Macros\Response;
 
 use Apiato\Core\Abstracts\Transformers\Transformer;
 use Illuminate\Http\JsonResponse;
-use Apiato\Core\Services\ResponseTransformer;
+use Apiato\Core\Services\Response;
 
 class Ok {
     public function __invoke(): callable
@@ -14,7 +14,7 @@ public function __invoke(): callable
              * Returns a 200 OK response.
              */
             function (): JsonResponse {
-                /** @var ResponseTransformer $this */
+                /** @var Response $this */
                 if (is_null($this->getTransformer())) {
                     $this->transformWith(Transformer::empty());
                 }
diff --git a/src/Providers/ApiatoServiceProvider.php b/src/Providers/ApiatoServiceProvider.php
index 183d2fc5..78cfa6cc 100644
--- a/src/Providers/ApiatoServiceProvider.php
+++ b/src/Providers/ApiatoServiceProvider.php
@@ -6,7 +6,7 @@
 use Apiato\Core\Foundation\Apiato;
 use Apiato\Core\Loaders\AutoLoaderTrait;
 use Apiato\Core\Providers\MacroProviders\ConfigMacroServiceProvider;
-use Apiato\Core\Providers\MacroProviders\ResponseTransformerMacroServiceProvider;
+use Apiato\Core\Providers\MacroProviders\ResponseMacroServiceProvider;
 use Apiato\Core\Traits\ValidationTrait;
 use Illuminate\Support\Facades\Schema;
 
@@ -17,7 +17,7 @@ class ApiatoServiceProvider extends AbstractMainServiceProvider
 
     public array $serviceProviders = [
         ConfigMacroServiceProvider::class,
-        ResponseTransformerMacroServiceProvider::class,
+        ResponseMacroServiceProvider::class,
     ];
 
     public function register(): void
diff --git a/src/Providers/MacroProviders/ResponseMacroServiceProvider.php b/src/Providers/MacroProviders/ResponseMacroServiceProvider.php
new file mode 100644
index 00000000..1f0b6188
--- /dev/null
+++ b/src/Providers/MacroProviders/ResponseMacroServiceProvider.php
@@ -0,0 +1,38 @@
+<?php
+
+namespace Apiato\Core\Providers\MacroProviders;
+
+use Apiato\Core\Macros\Response\GetRequestedIncludes;
+use Apiato\Core\Services\Response;
+use Apiato\Core\Macros\Response\Accepted;
+use Apiato\Core\Macros\Response\Created;
+use Apiato\Core\Macros\Response\CreateFrom;
+use Apiato\Core\Macros\Response\GetTransformer;
+use Apiato\Core\Macros\Response\NoContent;
+use Apiato\Core\Macros\Response\Ok;
+use Apiato\Core\Abstracts\Providers\MainServiceProvider as AbstractMainServiceProvider;
+use Illuminate\Support\Collection;
+
+final class ResponseMacroServiceProvider extends AbstractMainServiceProvider {
+    public function boot(): void
+    {
+        parent::boot();
+
+        Collection::make($this->macros())
+            ->reject(static fn ($class, $macro) => Response::hasMacro($macro))
+            ->each(static fn ($class, $macro) => Response::macro($macro,  app($class)()));
+    }
+
+    private function macros(): array
+    {
+        return [
+            'ok' => Ok::class,
+            'created' => Created::class,
+            'noContent' => NoContent::class,
+            'accepted' => Accepted::class,
+            'createFrom' => CreateFrom::class,
+            'getTransformer' => GetTransformer::class,
+            'getRequestedIncludes' => GetRequestedIncludes::class,
+        ];
+    }
+}
diff --git a/src/Providers/MacroProviders/ResponseTransformerMacroServiceProvider.php b/src/Providers/MacroProviders/ResponseTransformerMacroServiceProvider.php
deleted file mode 100644
index 48b0ae11..00000000
--- a/src/Providers/MacroProviders/ResponseTransformerMacroServiceProvider.php
+++ /dev/null
@@ -1,38 +0,0 @@
-<?php
-
-namespace Apiato\Core\Providers\MacroProviders;
-
-use Apiato\Core\Macros\ResponseTransformer\GetRequestedIncludes;
-use Apiato\Core\Services\ResponseTransformer;
-use Apiato\Core\Macros\ResponseTransformer\Accepted;
-use Apiato\Core\Macros\ResponseTransformer\Created;
-use Apiato\Core\Macros\ResponseTransformer\CreateFrom;
-use Apiato\Core\Macros\ResponseTransformer\GetTransformer;
-use Apiato\Core\Macros\ResponseTransformer\NoContent;
-use Apiato\Core\Macros\ResponseTransformer\Ok;
-use Apiato\Core\Abstracts\Providers\MainServiceProvider as AbstractMainServiceProvider;
-use Illuminate\Support\Collection;
-
-final class ResponseTransformerMacroServiceProvider extends AbstractMainServiceProvider {
-    public function boot(): void
-    {
-        parent::boot();
-
-        Collection::make($this->macros())
-            ->reject(static fn ($class, $macro) => ResponseTransformer::hasMacro($macro))
-            ->each(static fn ($class, $macro) => ResponseTransformer::macro($macro,  app($class)()));
-    }
-
-    private function macros(): array
-    {
-        return [
-            'ok' => Ok::class,
-            'created' => Created::class,
-            'noContent' => NoContent::class,
-            'accepted' => Accepted::class,
-            'createFrom' => CreateFrom::class,
-            'getTransformer' => GetTransformer::class,
-            'getRequestedIncludes' => GetRequestedIncludes::class,
-        ];
-    }
-}
diff --git a/src/Services/ResponseTransformer.php b/src/Services/Response.php
similarity index 96%
rename from src/Services/ResponseTransformer.php
rename to src/Services/Response.php
index 91d30545..e2405665 100644
--- a/src/Services/ResponseTransformer.php
+++ b/src/Services/Response.php
@@ -13,7 +13,7 @@
  *
  * @see \Spatie\Fractal\Fractal
  */
-class ResponseTransformer extends SpatieFractal
+class Response extends SpatieFractal
 {
     public function createData(): Scope
     {
diff --git a/src/Traits/CanEagerLoadTrait.php b/src/Traits/CanEagerLoadTrait.php
index 80c0f7fc..0f66e858 100644
--- a/src/Traits/CanEagerLoadTrait.php
+++ b/src/Traits/CanEagerLoadTrait.php
@@ -2,7 +2,7 @@
 
 namespace Apiato\Core\Traits;
 
-use Apiato\Core\Services\ResponseTransformer;
+use Apiato\Core\Services\Response;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Facades\Request;
@@ -20,7 +20,7 @@ protected function eagerLoadRequestedRelations(): void
         $this->scopeQuery(function (Builder|Model $model) {
             if (Request::has(config('apiato.requests.params.include', 'include'))) {
                 $validIncludes = [];
-                foreach (ResponseTransformer::getRequestedIncludes() as $includeName) {
+                foreach (Response::getRequestedIncludes() as $includeName) {
                     $relationParts = explode('.', $includeName);
                     $camelCasedIncludeName = $this->validateNestedRelations($this->model, $relationParts);
                     if ($camelCasedIncludeName) {