Refactor to resolver strategies

Author: sunchayn

src/APIResourceManager.php

@@ -4,11 +4,11 @@
 
 use Exception;
 use Illuminate\Http\Resources\Json\JsonResource;
-use Illuminate\Session\Store;
 use Illuminate\Support\Facades\Storage;
 use Illuminate\Support\Str;
 use Juampi92\APIResources\Exceptions\ResourceNotFoundException;
 use Juampi92\APIResources\Exceptions\WrongConfigurationException;
+use Juampi92\APIResources\Resolvers\ResolverFactory;
 
 class APIResourceManager
 {
@@ -170,40 +170,9 @@ public function getBasePath(): string
         return $this->path;
     }
 
-    /**
-     * Returns the classname of the versioned resource,
-     * or it's latest version if it doesn't exist.
-     *
-     * Throws an exception if it cannot find it.
-     *
-     * @param string $classname
-     *
-     * @return string
-     * @throws ResourceNotFoundException
-     */
-    public function resolveClassname(string $classname)
+    public function getResourcesPath(): string
     {
-        $path = $this->parseClassname($classname);
-
-        // Check if the resource was found
-        if (class_exists($path)) {
-            return $path;
-        }
-
-        // If we are on the latest version, stop searching
-        if ($this->isLatest()) {
-            throw new Exceptions\ResourceNotFoundException($classname, $path);
-        }
-
-        // Search on the latest version
-        $path = $this->parseClassname($classname, true);
-
-        // If still does not exists, fail
-        if (! class_exists($path)) {
-            throw new Exceptions\ResourceNotFoundException($classname, $path);
-        }
-
-        return $path;
+        return $this->resources;
     }
 
     /**
@@ -212,6 +181,7 @@ public function resolveClassname(string $classname)
      * @param bool $forceLatest Set to true if last version is required
      *
      * @return class-string<JsonResource>
+     * @deprecated
      */
     protected function parseClassname(string $classname, bool $forceLatest = false): string
     {
@@ -255,26 +225,15 @@ protected function resolveClassnameFromFilesystem(string $classname, string $ver
      */
     public function resolve(string $classname): APIResource
     {
-        $path = $this->resolveClassname($classname);
-
-        // Check if the resource was found
-        if (! class_exists($path)) {
-
-            // If we are on the latest version, stop searching
-            if ($this->isLatest()) {
-                throw new Exceptions\ResourceNotFoundException($classname, $path);
-            }
-
-            // Search on the latest version
-            $path = $this->resolveClassname($classname, true);
-
-            // If still does not exists, fail
-            if (! class_exists($path)) {
-                throw new Exceptions\ResourceNotFoundException($classname, $path);
-            }
-        }
+        return ResolverFactory::make($classname)->run();
+    }
 
-        return new APIResource($path);
+    /**
+     * @throws ResourceNotFoundException
+     */
+    public function resolveClassname(string $classname): string
+    {
+        return ResolverFactory::make($classname)->dryRun();
     }
 
     /**

src/Facades/APIResource.php

@@ -7,13 +7,16 @@
 /**
  * @method static \Juampi92\APIResources\APIResourceManager setVersion(string $version, string $apiName = null)
  * @method static string getVersion()
+ * @method static string getLatestVersion()
  * @method static bool isLatest(string $c = null)
  * @method static string resolveClassname(string $classname, bool $forceLatest = null) Returns formatted classname using current version
  * @method static \Juampi92\APIResources\APIResource resolve(string $classname)
  * @method static \Illuminate\Http\Resources\Json\Resource make(string $classname, ...$args) Resolves the classname and instantiates the resource
  * @method static \Illuminate\Http\Resources\Json\Resource collection(string $classname, ...$args) Resolves the classname and instantiates the resource as a collection
  * @method static string getRoute(string $name, array $parameters, bool $absolute)
  * @method static string getRouteName(string $name)
+ * @method static string getBasePath()
+ * @method static string getResourcesPath()
  *
  * @see \Juampi92\APIResources\APIResourceManager
  */

src/Resolvers/CacheResolver.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Juampi92\APIResources\Resolvers;
+
+use Illuminate\Http\Resources\Json\JsonResource;
+use Illuminate\Http\Resources\Json\ResourceCollection;
+use Illuminate\Support\Facades\Storage;
+
+class CacheResolver extends Resolver
+{
+    protected function resolve(): ?string
+    {
+        $routingManifest = json_decode(Storage::get(config('api.routing_manifest_path')), true);
+
+        if (! $routingManifest) {
+            return null;
+        }
+
+        /** @var ?class-string<JsonResource|ResourceCollection> $classPath */
+        $classPath = $routingManifest[$this->classname][$this->version] ?? null;
+
+        if ($classPath && ! class_exists($classPath)) {
+            return null;
+        }
+
+        return $classPath;
+    }
+}

src/Resolvers/PathResolver.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace Juampi92\APIResources\Resolvers;
+
+use Illuminate\Http\Resources\Json\JsonResource;
+use Illuminate\Http\Resources\Json\ResourceCollection;
+use Illuminate\Support\Str;
+use Juampi92\APIResources\Facades\APIResource;
+
+class PathResolver extends Resolver
+{
+    protected function resolve(): ?string
+    {
+        $basePath = APIResource::getBasePath();
+
+        $resourcePath = $this->guessResourcePath();
+
+        /** @var class-string<JsonResource|ResourceCollection> $fullPath */
+        $fullPath = "\\{$basePath}\\{$resourcePath}";
+
+        if (! class_exists($fullPath)) {
+            return null;
+        }
+
+        return $fullPath;
+    }
+
+    private function guessResourcePath(): string
+    {
+        $resourcesPath = APIResource::getResourcesPath();
+
+        if (empty($resourcesPath)) {
+            return "{$this->version}\\{$this->classname}";
+        }
+
+        return sprintf(
+            "%s\\%s\\%s",
+            $resourcesPath,
+            $this->version,
+            Str::after($this->classname, $resourcesPath . "\\")
+        );
+    }
+}

src/Resolvers/Resolver.php

@@ -0,0 +1,67 @@
+<?php
+
+namespace Juampi92\APIResources\Resolvers;
+
+use Illuminate\Http\Resources\Json\JsonResource;
+use Illuminate\Http\Resources\Json\ResourceCollection;
+use Juampi92\APIResources\APIResource;
+use Juampi92\APIResources\Exceptions\ResourceNotFoundException;
+
+abstract class Resolver
+{
+    protected string $classname;
+
+    protected string $version;
+
+    protected ?Resolver $fallback = null;
+
+    public function __construct(string $classname, string $version)
+    {
+        $this->version = $version;
+        $this->classname = $classname;
+    }
+
+    public function setFallback(Resolver $resolveStrategy): Resolver
+    {
+        $this->fallback = $resolveStrategy;
+
+        return $resolveStrategy;
+    }
+
+    /**
+     * @throws ResourceNotFoundException
+     */
+    public function run(): APIResource
+    {
+        if ($path = $this->resolve()) {
+            return new APIResource($path);
+        }
+
+        if ($this->fallback) {
+            return $this->fallback->run();
+        }
+
+        throw new ResourceNotFoundException($this->classname, $path ?? '--unresolved--');
+    }
+
+    /**
+     * @throws ResourceNotFoundException
+     */
+    public function dryRun(): string
+    {
+        if ($path = $this->resolve()) {
+            return $path;
+        }
+
+        if ($this->fallback) {
+            return $this->fallback->dryRun();
+        }
+
+        throw new ResourceNotFoundException($this->classname, $path ?? '--unresolved--');
+    }
+
+    /**
+     * @return class-string<JsonResource|ResourceCollection>
+     */
+    abstract protected function resolve(): ?string;
+}

src/Resolvers/ResolverFactory.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Juampi92\APIResources\Resolvers;
+
+use Illuminate\Support\Str;
+use Juampi92\APIResources\Facades\APIResource;
+
+class ResolverFactory
+{
+    public static function make(string $classname): Resolver
+    {
+        $version = Str::start(APIResource::getVersion(), 'v');
+
+        $cacheResolver = new CacheResolver($classname, $version);
+
+        $pathResolver = new PathResolver($classname, $version);
+
+        if (! APIResource::isLatest()) {
+            $latestVersion = Str::start(APIResource::getLatestVersion(), 'v');
+
+            $pathResolver->setFallback(
+                new PathResolver($classname, $latestVersion)
+            );
+        }
+
+        $cacheResolver->setFallback(
+            $pathResolver,
+        );
+
+        return $cacheResolver;
+    }
+}