Feature/pint

.github/workflows/ci.yml

@@ -21,4 +21,8 @@ jobs:
             -v "${{ github.workspace }}":/var/www/html \
             -w /var/www/html \
             laravelsail/php84-composer:latest \
-            sh -lc "composer install --no-interaction --prefer-dist && vendor/bin/phpunit"
+            sh -lc "
+              composer install --no-interaction --prefer-dist &&
+              vendor/bin/phpunit &&
+              vendor/bin/pint --test
+            "

composer.json

@@ -25,7 +25,8 @@
         "ext-openssl": "*"
     },
     "require-dev": {
-        "orchestra/testbench": "^10.4"
+        "orchestra/testbench": "^10.4",
+        "laravel/pint": "^1.22"
     },
     "autoload-dev": {
         "psr-4": {
@@ -49,4 +50,4 @@
             "@php vendor/bin/testbench serve --ansi"
         ]
     }
-}
+}

config/image-proxy.php

@@ -3,19 +3,19 @@
 return [
     'route_prefix' => env('IMAGE_PROXY_ROUTE_PREFIX', 'img'),
     'route_names' => [
-        'image.proxy.short' => env('IMAGE_PROXY_ROUTE_SHORT',    'image.proxy.short'),
+        'image.proxy.short' => env('IMAGE_PROXY_ROUTE_SHORT', 'image.proxy.short'),
         'image.proxy.filename' => env('IMAGE_PROXY_ROUTE_FILENAME', 'image.proxy.filename'),
     ],
     'route_middleware' => [],
     'disks' => [
         'source' => env('IMAGE_PROXY_DISK_SOURCE', 'local'),
-        'cache'  => env('IMAGE_PROXY_DISK_CACHE',  'local'),
+        'cache' => env('IMAGE_PROXY_DISK_CACHE', 'local'),
     ],
     'encryptor' => Bst27\ImageProxy\Services\OpenSslPayloadEncryptor::class,
     'token_encoder' => Bst27\ImageProxy\Services\Base64UrlTokenEncoder::class,
     'manipulation_strategy' => [
         'default' => [
-            'class'  => \Bst27\ImageProxy\Services\ImageManipulator\DefaultManipulator::class,
+            'class' => \Bst27\ImageProxy\Services\ImageManipulator\DefaultManipulator::class,
             'params' => [],
         ],
     ],

routes/web.php

@@ -4,13 +4,13 @@
 use Illuminate\Support\Facades\Route;
 
 $prefix = config('image-proxy.route_prefix');
-$names  = config('image-proxy.route_names');
+$names = config('image-proxy.route_names');
 $middleware = config('image-proxy.route_middleware');
 
 Route::group([
-    'prefix'     => $prefix,
+    'prefix' => $prefix,
     'middleware' => $middleware,
-], function() use ($names) {
+], function () use ($names) {
     Route::get('{token}.{ext}', [ImageProxyController::class, 'serveShort'])
         ->where('token', '[A-Za-z0-9\-_]+')
         ->where('ext', '[A-Za-z0-9]+')

src/Contracts/ImageManipulator.php

@@ -7,10 +7,6 @@ interface ImageManipulator
     /**
      * This function has to return the content of the manipulated file as string.
      * It is given the original file content and any additional parameters if available.
-     *
-     * @param string $fileContent
-     * @param array $params
-     * @return string
      */
     public function manipulate(string $fileContent, array $params): string;
 }

src/Contracts/PayloadEncryptor.php

@@ -5,5 +5,6 @@
 interface PayloadEncryptor
 {
     public function encrypt(string $payload): string;
+
     public function decrypt(string $cipher): string;
 }

src/Contracts/TokenEncoder.php

@@ -5,5 +5,6 @@
 interface TokenEncoder
 {
     public function encode(string $cipher): string;
+
     public function decode(string $token): string;
 }

src/Http/Controllers/ImageProxyController.php

@@ -38,10 +38,10 @@ public function serveFilename(string $token, string $filename): Response
 
     private function decryptPayload(string $token): array
     {
-        $encoder   = app(TokenEncoder::class);
-        $cipher    = $encoder->decode($token);
+        $encoder = app(TokenEncoder::class);
+        $cipher = $encoder->decode($token);
         $encryptor = app(PayloadEncryptor::class);
-        $json      = $encryptor->decrypt($cipher);
+        $json = $encryptor->decrypt($cipher);
 
         $data = json_decode($json, true);
         if (! $data || ! isset($data['path'], $data['v'])) {
@@ -54,11 +54,11 @@ private function decryptPayload(string $token): array
     private function processAndDeliver(array $data): Response
     {
         $sourceDisk = Storage::disk(config('image-proxy.disks.source'));
-        $cacheDisk  = Storage::disk(config('image-proxy.disks.cache'));
+        $cacheDisk = Storage::disk(config('image-proxy.disks.cache'));
 
         $sourcePath = $data['path'];
 
-        if (!$sourceDisk->exists($sourcePath)) {
+        if (! $sourceDisk->exists($sourcePath)) {
             abort(404);
         }
 
@@ -69,23 +69,23 @@ private function processAndDeliver(array $data): Response
         }
 
         $strategyKey = $data['strategy'];
-        $strategies  = config('image-proxy.manipulation_strategy');
+        $strategies = config('image-proxy.manipulation_strategy');
 
         if (! isset($strategies[$strategyKey])) {
             abort(500, "Unknown image-proxy strategy: {$strategyKey}");
         }
 
-        $conf         = $strategies[$strategyKey];
-        $class        = $conf['class'];
-        $default      = $conf['params'] ?? [];
-        $mergeParams  = $data['mergeParams'] ?? [];
-        $params       = array_merge($default, $mergeParams);
+        $conf = $strategies[$strategyKey];
+        $class = $conf['class'];
+        $default = $conf['params'] ?? [];
+        $mergeParams = $data['mergeParams'] ?? [];
+        $params = array_merge($default, $mergeParams);
 
-        $ext       = pathinfo($sourcePath, PATHINFO_EXTENSION);
-        $cacheHash = $fileHash . '-' . md5(json_encode($params));
-        $cacheKey  = $cacheHash . '.' . $ext;
+        $ext = pathinfo($sourcePath, PATHINFO_EXTENSION);
+        $cacheHash = $fileHash.'-'.md5(json_encode($params));
+        $cacheKey = $cacheHash.'.'.$ext;
 
-        if (!$cacheDisk->exists($cacheKey)) {
+        if (! $cacheDisk->exists($cacheKey)) {
             /** @var ImageManipulator $manipulator */
             $manipulator = app($class);
             $fileContent = $manipulator->manipulate($fileContent, $params);
@@ -94,10 +94,11 @@ private function processAndDeliver(array $data): Response
         }
 
         $stream = $cacheDisk->readStream($cacheKey);
-        return new StreamedResponse(function() use ($stream) {
+
+        return new StreamedResponse(function () use ($stream) {
             fpassthru($stream);
         }, 200, [
-            'Content-Type'  => $cacheDisk->mimeType($cacheKey),
+            'Content-Type' => $cacheDisk->mimeType($cacheKey),
             'Cache-Control' => 'public, max-age=31536000, immutable',
         ]);
     }

src/ImageProxyServiceProvider.php

@@ -4,7 +4,6 @@
 
 use Bst27\ImageProxy\Contracts\PayloadEncryptor;
 use Bst27\ImageProxy\Contracts\TokenEncoder;
-use Illuminate\Support\Facades\Route;
 use Illuminate\Support\ServiceProvider;
 
 class ImageProxyServiceProvider extends ServiceProvider

src/Services/Base64UrlTokenEncoder.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace Bst27\ImageProxy\Services;
 
 use Bst27\ImageProxy\Contracts\TokenEncoder;
@@ -13,6 +14,7 @@ public function encode(string $cipher): string
     public function decode(string $token): string
     {
         $b64 = strtr($token, '-_', '+/');
+
         return (string) base64_decode($b64);
     }
 }

src/Services/ImageManipulator/DefaultManipulator.php

@@ -9,7 +9,7 @@ class DefaultManipulator implements ImageManipulator
 {
     public function manipulate(string $fileContent, array $params): string
     {
-        $tmpFile  = tempnam(sys_get_temp_dir(), 'img');
+        $tmpFile = tempnam(sys_get_temp_dir(), 'img');
         file_put_contents($tmpFile, $fileContent);
 
         try {

src/Services/OpenSslPayloadEncryptor.php

@@ -1,11 +1,13 @@
 <?php
+
 namespace Bst27\ImageProxy\Services;
 
 use Bst27\ImageProxy\Contracts\PayloadEncryptor;
 
 class OpenSslPayloadEncryptor implements PayloadEncryptor
 {
     private const HASH_ALGORITHM = 'sha256';
+
     private const CIPHER_ALGORITHM = 'AES-256-ECB';
 
     public function encrypt(string $payload): string

src/helpers.php

@@ -2,7 +2,6 @@
 
 use Bst27\ImageProxy\Contracts\PayloadEncryptor;
 use Bst27\ImageProxy\Contracts\TokenEncoder;
-use Illuminate\Support\Facades\File;
 use Illuminate\Support\Facades\Storage;
 use Illuminate\Support\Facades\URL;
 
@@ -13,8 +12,7 @@ function proxy_image(
         ?string $strategyKey = 'default',
         false|string $fileName = false,
         array $mergeParams = []
-    ): string
-    {
+    ): string {
         $sourceDisk = Storage::disk(config('image-proxy.disks.source'));
 
         if (! $sourceDisk->exists($path)) {
@@ -25,20 +23,20 @@ function proxy_image(
         $fileHash = md5($fileContent);
 
         $payload = [
-            'path'     => $path,
+            'path' => $path,
             'strategy' => $strategyKey,
-            'mergeParams'   => $mergeParams,
-            'v'        => $fileHash,
+            'mergeParams' => $mergeParams,
+            'v' => $fileHash,
             'filename' => $fileName,
         ];
 
-        $json      = json_encode($payload, JSON_UNESCAPED_SLASHES);
+        $json = json_encode($payload, JSON_UNESCAPED_SLASHES);
         $encryptor = app(PayloadEncryptor::class);
-        $cipher    = $encryptor->encrypt($json);
-        $encoder   = app(TokenEncoder::class);
-        $token     = $encoder->encode($cipher);
+        $cipher = $encryptor->encrypt($json);
+        $encoder = app(TokenEncoder::class);
+        $token = $encoder->encode($cipher);
 
-        $ext       = pathinfo($path, PATHINFO_EXTENSION);
+        $ext = pathinfo($path, PATHINFO_EXTENSION);
         $routeName = $fileName === false
             ? 'image.proxy.short'
             : 'image.proxy.filename';

tests/Feature/ImageProxyControllerTest.php

@@ -6,7 +6,7 @@
 
 class ImageProxyControllerTest extends TestCase
 {
-    public function testServeFilenameRejectsWrongFilename()
+    public function test_serve_filename_rejects_wrong_filename()
     {
         $good = proxy_image('images/60x40.png', 'default', 'bar.png', []);
         $bad = preg_replace('/bar\.png$/', 'baz.png', $good);
@@ -15,7 +15,7 @@ public function testServeFilenameRejectsWrongFilename()
         $this->get($good)->assertStatus(200);
     }
 
-    public function testServeShortRejectsWrongExtension()
+    public function test_serve_short_rejects_wrong_extension()
     {
         $good = proxy_image('images/60x40.png');
         $bad = preg_replace('/\.png$/', '.dat', $good);
@@ -24,7 +24,7 @@ public function testServeShortRejectsWrongExtension()
         $this->get($good)->assertStatus(200);
     }
 
-    public function testInvalidTokenReturns404()
+    public function test_invalid_token_returns404()
     {
         $this->get('/img/invalid-token-123.png')->assertStatus(404);
     }

tests/Feature/ProxyImageHelperTest.php

@@ -6,7 +6,7 @@
 
 class ProxyImageHelperTest extends TestCase
 {
-    public function testHelperAndDefaultManipulatorIntegration()
+    public function test_helper_and_default_manipulator_integration()
     {
         $url = proxy_image('images/60x40.jpg', 'default', false, []);
 

tests/TestCase.php

@@ -20,7 +20,7 @@ protected function getEnvironmentSetUp($app): void
         $app['config']->set('image-proxy.disks.source', 'fixtures');
         $app['config']->set('filesystems.disks.fixtures', [
             'driver' => 'local',
-            'root'   => __DIR__ . '/Fixtures',
+            'root' => __DIR__.'/Fixtures',
         ]);
     }
 }