feat: add make and url methods to programmatically generate unsigned URLs

Author: ace-of-aces

src/Facades/ImageTransformUrl.php

@@ -7,10 +7,12 @@
 use Illuminate\Support\Facades\Facade;
 
 /**
- * @see \AceOfAces\LaravelImageTransformUrl\LaravelImageTransformUrl;
- *
+ * @method static string make(string $path, array|string $options = [], ?string $pathPrefix = null)
+ * @method static string url(string $path, array|string $options = [], ?string $pathPrefix = null)
  * @method static string signedUrl(string $path, array|string $options = [], ?string $pathPrefix = null, \DateTimeInterface|\DateInterval|int|null $expiration = null, ?bool $absolute = true)
  * @method static string temporarySignedUrl(string $path, array|string $options = [], \DateTimeInterface|\DateInterval|int $expiration, ?string $pathPrefix = null, ?bool $absolute = true)
+ *
+ * @see \AceOfAces\LaravelImageTransformUrl\ImageTransformUrl
  */
 class ImageTransformUrl extends Facade
 {

src/ImageTransformUrl.php

@@ -11,11 +11,43 @@
 
 class ImageTransformUrl
 {
+    /**
+     * Generate a regular URL for the image transformation.
+     *
+     * @param  string  $path  The path to the image.
+     * @param  array|string  $options  The transformation options.
+     * @param  string|null  $pathPrefix  The path prefix to use. Defaults to the default path prefix.
+     * @return string The generated URL.
+     */
+    public function make(string $path, array|string $options = [], ?string $pathPrefix = null): string
+    {
+        $options = $this->optionsToString($options);
+
+        if (empty($pathPrefix)) {
+            return URL::route('image.transform.default', ['options' => $options, 'path' => $path]);
+        }
+
+        return URL::route('image.transform', ['pathPrefix' => $pathPrefix, 'options' => $options, 'path' => $path]);
+    }
+
+    /**
+     * Generate a regular URL for the image transformation.
+     *
+     * @param  string  $path  The path to the image.
+     * @param  array|string  $options  The transformation options.
+     * @param  string|null  $pathPrefix  The path prefix to use. Defaults to the default path prefix.
+     * @return string The generated URL.
+     */
+    public function url(string $path, array|string $options = [], ?string $pathPrefix = null): string
+    {
+        return $this->make($path, $options, $pathPrefix);
+    }
+
     /**
      * Generate a signed URL for the image transformation.
      *
      * @param  string  $path  The path to the image.
-     * @param  array  $options  The transformation options.
+     * @param  array|string  $options  The transformation options.
      * @param  string|null  $pathPrefix  The path prefix to use. Defaults to the default path prefix.
      * @param  DateTimeInterface|\DateInterval|int|null  $expiration  The expiration time for the signed URL.
      * @return string The signed URL.
@@ -28,11 +60,7 @@ public function signedUrl(string $path, array|string $options = [], ?string $pat
             throw new InvalidConfigurationException('Signed URLs are not enabled. Please check your configuration.');
         }
 
-        if (is_array($options)) {
-            $options = collect($options)
-                ->map(fn ($value, $key) => "$key=$value")
-                ->implode(',');
-        }
+        $options = $this->optionsToString($options);
 
         if (empty($pathPrefix)) {
             return URL::signedRoute(
@@ -52,7 +80,7 @@ public function signedUrl(string $path, array|string $options = [], ?string $pat
     }
 
     /**
-     * Create a temporary signed URL for the image transformation.
+     * Generate a temporary signed URL for the image transformation.
      *
      * @param  string  $path  The path to the image.
      * @param  array|string  $options  The transformation options.
@@ -67,4 +95,18 @@ public function temporarySignedUrl(string $path, array|string $options, DateTime
     {
         return $this->signedUrl($path, $options, $pathPrefix, $expiration, $absolute);
     }
+
+    /**
+     * Convert array options to a string format suitable for URL generation.
+     */
+    protected function optionsToString(array|string $options): string
+    {
+        if (is_array($options)) {
+            return collect($options)
+                ->map(fn ($value, $key) => "$key=$value")
+                ->implode(',');
+        }
+
+        return $options;
+    }
 }

tests/Feature/FacadeTest.php

@@ -5,6 +5,7 @@
 use AceOfAces\LaravelImageTransformUrl\Exceptions\InvalidConfigurationException;
 use AceOfAces\LaravelImageTransformUrl\Facades\ImageTransformUrl;
 use AceOfAces\LaravelImageTransformUrl\Tests\TestCase;
+use Illuminate\Support\Facades\URL;
 
 it('produces identical signed URLs for the signedUrl and temporarySignedUrl methods when given the same parameters', function () {
     /** @var TestCase $this */
@@ -33,3 +34,21 @@
 
     ImageTransformUrl::signedUrl('path/to/image.jpg', ['width' => 100, 'height' => 200]);
 })->throws(InvalidConfigurationException::class, 'Signed URLs are not enabled. Please check your configuration.');
+
+it('can use the make method to generate a regular unsigned URL', function () {
+    /** @var TestCase $this */
+    $url = ImageTransformUrl::make('path/to/image.jpg', ['width' => 100, 'height' => 200], 'images');
+
+    expect($url)->toBe(URL::route('image.transform', [
+        'pathPrefix' => 'images',
+        'options' => 'width=100,height=200',
+        'path' => 'path/to/image.jpg',
+    ]));
+});
+
+it('can use the url method as an alias for make', function () {
+    /** @var TestCase $this */
+    $url = ImageTransformUrl::url('path/to/image.jpg', ['width' => 100, 'height' => 200], 'images');
+
+    expect($url)->toBe(ImageTransformUrl::make('path/to/image.jpg', ['width' => 100, 'height' => 200], 'images'));
+});