Merge pull request #2 from justbetter/feature/laravel-12

VincentBean · web-flow · commit c741dbb937c7 · 2025-06-23T08:21:59.000+02:00
diff --git a/.github/workflows/analyse.yml b/.github/workflows/analyse.yml
@@ -9,14 +9,12 @@ jobs:
             fail-fast: true
             matrix:
                 os: [ubuntu-latest]
-                php: [8.3]
-                laravel: [10.*, 11.*]
+                php: [8.4]
+                laravel: [12]
                 stability: [prefer-stable]
                 include:
-                    - laravel: 10.*
-                      testbench: 8.*
-                    - laravel: 11.*
-                      testbench: 9.*
+                    - laravel: 12.*
+                      testbench: 10.*
 
         name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.stability }} - ${{ matrix.os }}
 
diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
@@ -9,14 +9,12 @@ jobs:
             fail-fast: true
             matrix:
                 os: [ubuntu-latest]
-                php: [8.3]
-                laravel: [10.*, 11.*]
+                php: [8.4]
+                laravel: [12.*]
                 stability: [prefer-stable]
                 include:
-                    - laravel: 10.*
-                      testbench: 8.*
-                    - laravel: 11.*
-                      testbench: 9.*
+                    - laravel: 12.*
+                      testbench: 10.*
 
         name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.stability }} - ${{ matrix.os }}
 
@@ -36,5 +34,5 @@ jobs:
                   composer config allow-plugins.pestphp/pest-plugin true
                   composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" pestphp/pest --no-interaction --no-update
                   composer update --${{ matrix.stability }} --prefer-dist --no-interaction
-            - name: Execute tests
-              run: XDEBUG_MODE=coverage php vendor/bin/pest --coverage --min=100
+            - name: Coverage
+              run: composer coverage
diff --git a/.github/workflows/style.yml b/.github/workflows/style.yml
@@ -1,9 +1,7 @@
 name: style
 
-on:
-    push:
-        branches:
-            - main
+on: ['push', 'pull_request']
+
 jobs:
     style:
         name: Style
@@ -16,17 +14,12 @@ jobs:
             -   name: Setup PHP
                 uses: shivammathur/setup-php@v2
                 with:
-                    php-version: 8.3
+                    php-version: 8.4
                     extensions: dom, curl, libxml, mbstring, zip, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick, fileinfo
                     coverage: none
 
             -   name: Install dependencies
                 run: composer install
 
             -   name: Style
-                run: composer fix-style
-
-            -   name: Commit Changes
-                uses: stefanzweifel/git-auto-commit-action@v4
-                with:
-                    commit_message: Fix styling changes
+                run: composer style
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -9,17 +9,14 @@ jobs:
             fail-fast: true
             matrix:
                 os: [ubuntu-latest]
-                php: [8.2, 8.3]
-                laravel: [10.*, 11.*]
+                php: [8.3, 8.4]
+                laravel: [11.*, 12.*]
                 stability: [prefer-stable]
                 include:
-                    - laravel: 10.*
-                      testbench: 8.*
                     - laravel: 11.*
                       testbench: 9.*
-                exclude:
-                    - laravel: 11.*
-                      php: 8.1
+                    - laravel: 12.*
+                      testbench: 10.*
 
         name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.stability }} - ${{ matrix.os }}
 
diff --git a/README.md b/README.md
@@ -79,6 +79,14 @@ php artisan akeneo-image:process {disk} {path} {--force}
 php artisan akeneo-image:upload {image-id}
 ```
 
+### Cleanup
+
+You may optionally run the cleanup command to remove images:
+
+```shell
+php artisan akeneo-image:cleanup --days=30
+```
+
 ## Quality
 
 To ensure the quality of this package, run the following command:
diff --git a/composer.json b/composer.json
@@ -11,16 +11,17 @@
         }
     ],
     "require": {
-        "php": "^8.1",
+        "php": "^8.3",
         "justbetter/laravel-akeneo-client": "^1.4",
-        "laravel/framework": "^10.0|^11.0"
+        "laravel/framework": "^11.0|^12.0"
     },
     "require-dev": {
-        "larastan/larastan": "^2.9",
-        "laravel/pint": "^1.10",
-        "orchestra/testbench": "^8.0|^9.0",
-        "phpstan/phpstan-mockery": "^1.1",
-        "phpunit/phpunit": "^10.2"
+        "larastan/larastan": "^3.0",
+        "laravel/pint": "^1.22",
+        "orchestra/testbench": "^10.0",
+        "phpstan/phpstan-mockery": "^2.0",
+        "phpunit/phpunit": "^11.5",
+        "pestphp/pest": "^3.7"
     },
     "autoload": {
         "psr-4": {
@@ -34,6 +35,7 @@
     },
     "scripts": {
         "test": "phpunit",
+        "coverage": "XDEBUG_MODE=coverage php vendor/bin/pest --coverage --min=100",
         "analyse": "phpstan",
         "style": "pint --test",
         "quality": [
@@ -45,7 +47,8 @@
     "config": {
         "sort-packages": true,
         "allow-plugins": {
-            "php-http/discovery": true
+            "php-http/discovery": true,
+            "pestphp/pest-plugin": true
         }
     },
     "extra": {
diff --git a/phpstan.neon b/phpstan.neon
@@ -7,4 +7,5 @@ parameters:
         - src
         - tests
     level: 8
-    checkMissingIterableValueType: false
+    ignoreErrors:
+        - identifier: missingType.iterableValue
diff --git a/src/Actions/CleanupImages.php b/src/Actions/CleanupImages.php
@@ -0,0 +1,29 @@
+<?php
+
+namespace JustBetter\AkeneoImages\Actions;
+
+use Illuminate\Support\Facades\Storage;
+use JustBetter\AkeneoImages\Contracts\CleansupImages;
+use JustBetter\AkeneoImages\Models\Image;
+
+class CleanupImages implements CleansupImages
+{
+    public function cleanup(int $days): void
+    {
+        Image::query()
+            ->where('created_at', '<=', now()->subDays($days))
+            ->get()
+            ->each(function (Image $image): void {
+                if (Storage::disk($image->disk)->exists($image->path)) {
+                    Storage::disk($image->disk)->delete($image->path);
+                }
+
+                $image->delete();
+            });
+    }
+
+    public static function bind(): void
+    {
+        app()->singleton(CleansupImages::class, static::class);
+    }
+}
diff --git a/src/Actions/UploadImage.php b/src/Actions/UploadImage.php
@@ -11,8 +11,7 @@ class UploadImage implements UploadsImage
 {
     public function __construct(
         protected Akeneo $akeneo
-    ) {
-    }
+    ) {}
 
     public function upload(Image $image): Image
     {
diff --git a/src/Commands/CleanupImagesCommand.php b/src/Commands/CleanupImagesCommand.php
@@ -0,0 +1,22 @@
+<?php
+
+namespace JustBetter\AkeneoImages\Commands;
+
+use Illuminate\Console\Command;
+use JustBetter\AkeneoImages\Jobs\CleanupImagesJob;
+
+class CleanupImagesCommand extends Command
+{
+    protected $signature = 'akeneo-image:cleanup {--days=}';
+
+    protected $description = 'Cleanup images that are older than the specified number of days.';
+
+    public function handle(): int
+    {
+        $days = (int) $this->option('days');
+
+        CleanupImagesJob::dispatch($days);
+
+        return static::SUCCESS;
+    }
+}
diff --git a/src/Contracts/CleansupImages.php b/src/Contracts/CleansupImages.php
@@ -0,0 +1,8 @@
+<?php
+
+namespace JustBetter\AkeneoImages\Contracts;
+
+interface CleansupImages
+{
+    public function cleanup(int $days): void;
+}
diff --git a/src/Jobs/CleanupImagesJob.php b/src/Jobs/CleanupImagesJob.php
@@ -0,0 +1,35 @@
+<?php
+
+namespace JustBetter\AkeneoImages\Jobs;
+
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldBeUnique;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Queue\InteractsWithQueue;
+use JustBetter\AkeneoImages\Contracts\CleansupImages;
+
+class CleanupImagesJob implements ShouldBeUnique, ShouldQueue
+{
+    use Dispatchable;
+    use InteractsWithQueue;
+    use Queueable;
+
+    public function __construct(
+        public int $days,
+    ) {
+        $this->onQueue(config('akeneo-images.queue'));
+    }
+
+    public function handle(CleansupImages $contract): void
+    {
+        $contract->cleanup($this->days);
+    }
+
+    public function tags(): array
+    {
+        return [
+            'days:'.$this->days,
+        ];
+    }
+}
diff --git a/src/ServiceProvider.php b/src/ServiceProvider.php
@@ -3,8 +3,10 @@
 namespace JustBetter\AkeneoImages;
 
 use Illuminate\Support\ServiceProvider as BaseServiceProvider;
+use JustBetter\AkeneoImages\Actions\CleanupImages;
 use JustBetter\AkeneoImages\Actions\ProcessImage;
 use JustBetter\AkeneoImages\Actions\UploadImage;
+use JustBetter\AkeneoImages\Commands\CleanupImagesCommand;
 use JustBetter\AkeneoImages\Commands\ProcessImageCommand;
 use JustBetter\AkeneoImages\Commands\UploadImageCommand;
 
@@ -28,6 +30,7 @@ protected function registerActions(): static
     {
         ProcessImage::bind();
         UploadImage::bind();
+        CleanupImages::bind();
 
         return $this;
     }
@@ -55,6 +58,7 @@ protected function bootCommands(): static
             $this->commands([
                 ProcessImageCommand::class,
                 UploadImageCommand::class,
+                CleanupImagesCommand::class,
             ]);
         }
 
diff --git a/tests/Actions/CleanupImagesTest.php b/tests/Actions/CleanupImagesTest.php
@@ -0,0 +1,42 @@
+<?php
+
+namespace JustBetter\AkeneoImages\Tests\Actions;
+
+use Illuminate\Support\Facades\Storage;
+use JustBetter\AkeneoImages\Actions\CleanupImages;
+use JustBetter\AkeneoImages\Models\Image;
+use JustBetter\AkeneoImages\Tests\TestCase;
+use PHPUnit\Framework\Attributes\Test;
+
+class CleanupImagesTest extends TestCase
+{
+    #[Test]
+    public function it_cleans_up_images(): void
+    {
+
+        Storage::fake('::disk::');
+        Storage::disk('::disk::')->put('::path_1::', '::content::');
+        Storage::disk('::disk::')->put('::path_2::', '::content::');
+
+        Image::query()->create([
+            'disk' => '::disk::',
+            'path' => '::path_1::',
+            'hash' => md5('::content::'),
+            'created_at' => now()->subDays(31),
+        ]);
+
+        Image::query()->create([
+            'disk' => '::disk::',
+            'path' => '::path_2::',
+            'hash' => md5('::content::'),
+            'created_at' => now()->subDays(29),
+        ]);
+
+        $action = app(CleanupImages::class);
+        $action->cleanup(30);
+
+        $this->assertDatabaseCount(Image::class, 1);
+
+        $this->assertFalse(Storage::disk('::disk::')->exists('::path_1::'));
+    }
+}
diff --git a/tests/Actions/ProcessImageTest.php b/tests/Actions/ProcessImageTest.php
@@ -8,6 +8,7 @@
 use JustBetter\AkeneoImages\Jobs\UploadImageJob;
 use JustBetter\AkeneoImages\Models\Image;
 use JustBetter\AkeneoImages\Tests\TestCase;
+use PHPUnit\Framework\Attributes\Test;
 
 class ProcessImageTest extends TestCase
 {
@@ -19,7 +20,7 @@ protected function setUp(): void
         Storage::fake('::disk::')->put('::path::', '::content::');
     }
 
-    /** @test */
+    #[Test]
     public function it_can_dispatch_upload_image_jobs(): void
     {
         /** @var ProcessImage $action */
@@ -32,7 +33,7 @@ public function it_can_dispatch_upload_image_jobs(): void
         $this->assertNotNull($image->hash);
     }
 
-    /** @test */
+    #[Test]
     public function it_can_skip_non_modified(): void
     {
         Image::query()->create([
@@ -48,7 +49,7 @@ public function it_can_skip_non_modified(): void
         Bus::assertNotDispatched(UploadImageJob::class);
     }
 
-    /** @test */
+    #[Test]
     public function it_can_force_non_modified(): void
     {
         Image::query()->create([
@@ -64,7 +65,7 @@ public function it_can_force_non_modified(): void
         Bus::assertDispatched(UploadImageJob::class, 1);
     }
 
-    /** @test */
+    #[Test]
     public function it_can_skip_non_existing_files(): void
     {
         /** @var ProcessImage $action */
diff --git a/tests/Actions/UploadImageTest.php b/tests/Actions/UploadImageTest.php
@@ -8,10 +8,11 @@
 use JustBetter\AkeneoImages\Actions\UploadImage;
 use JustBetter\AkeneoImages\Models\Image;
 use JustBetter\AkeneoImages\Tests\TestCase;
+use PHPUnit\Framework\Attributes\Test;
 
 class UploadImageTest extends TestCase
 {
-    /** @test */
+    #[Test]
     public function it_can_upload_images(): void
     {
         Storage::fake('::disk::')->put('::path::', '::content::');
diff --git a/tests/Commands/CleanupImagesCommandTest.php b/tests/Commands/CleanupImagesCommandTest.php
diff --git a/tests/Commands/ProcessImageCommandTest.php b/tests/Commands/ProcessImageCommandTest.php
diff --git a/tests/Commands/UploadImageCommandTest.php b/tests/Commands/UploadImageCommandTest.php
diff --git a/tests/Jobs/CleanupImagesJobTest.php b/tests/Jobs/CleanupImagesJobTest.php
diff --git a/tests/Jobs/ProcessImageJobTest.php b/tests/Jobs/ProcessImageJobTest.php
diff --git a/tests/Jobs/UploadImageJobTest.php b/tests/Jobs/UploadImageJobTest.php
diff --git a/tests/Models/ImageTest.php b/tests/Models/ImageTest.php

Original file line number	Diff line number	Diff line change
`@@ -11,8 +11,7 @@ class UploadImage implements UploadsImage`
`11`	`11`	`{`
`12`	`12`	`public function __construct(`
`13`	`13`	`protected Akeneo $akeneo`
`14`		`- ) {`
`15`		`- }`
	`14`	`+ ) {}`
`16`	`15`
`17`	`16`	`public function upload(Image $image): Image`
`18`	`17`	`{`