Merge pull request #3 from justbetter/feature/refactor

Refactor

Author: VincentBean

UPGRADE.md

@@ -0,0 +1,13 @@
+# Upgrade guide
+
+## 4.1.x to 4.2.x
+
+The 4.2.x release adds support for `justbetter/laravel-magento-stock` version `^2.0`.
+
+### Refactor
+
+A few classes like the resource have been renamed. The resource `Stock` is now `StockResource`. Make sure to update all references if you make use of it manually.
+
+### Configuration file
+
+The configuration file has been removed. If you wish to customize the fields in the resource, you can create your own resource.

composer.json

@@ -3,20 +3,43 @@
     "description": "Nova integration for justbetter/laravel-magento-stock",
     "type": "package",
     "license": "MIT",
+    "authors": [
+        {
+            "name": "Vincent Boon",
+            "email": "[email protected]",
+            "role": "Developer"
+        },
+        {
+            "name": "Ramon Rietdijk",
+            "email": "[email protected]",
+            "role": "Developer"
+        }
+    ],
     "require": {
         "php": "^8.1",
         "laravel/nova": "^4.0",
-        "justbetter/nova-error-logger": "^4.1.0",
-        "justbetter/laravel-magento-stock": "^1.2.0",
+        "justbetter/laravel-magento-stock": "^2.0",
         "bolechen/nova-activitylog": "^0.4.0"
     },
+    "require-dev": {
+        "laravel/pint": "^1.16",
+        "orchestra/testbench": "^9.1",
+        "phpunit/phpunit": "^11.2",
+        "larastan/larastan": "^2.9",
+        "phpstan/phpstan-mockery": "^1.1"
+    },
     "autoload": {
         "psr-4": {
             "JustBetter\\MagentoStockNova\\": "src"
         }
     },
-    "config": {
-        "sort-packages": true
+    "scripts": {
+        "analyse": "phpstan",
+        "style": "pint --test",
+        "quality": [
+            "@analyse",
+            "@style"
+        ]
     },
     "extra": {
         "laravel": {
@@ -25,8 +48,11 @@
             ]
         }
     },
+    "config": {
+        "sort-packages": true
+    },
     "minimum-stability": "dev",
-    "prefer-stable": false,
+    "prefer-stable": true,
     "repositories": [
         {
             "type": "composer",

config/magento-stock-nova.php

@@ -0,0 +1,11 @@
+includes:
+    - ./vendor/larastan/larastan/extension.neon
+    - ./vendor/phpstan/phpstan-mockery/extension.neon
+
+parameters:
+    paths:
+        - src
+    level: 8
+    ignoreErrors:
+        - identifier: missingType.iterableValue
+        - identifier: missingType.generics

phpstan.neon

@@ -6,7 +6,7 @@
 use Illuminate\Queue\InteractsWithQueue;
 use Illuminate\Queue\SerializesModels;
 use Illuminate\Support\Collection;
-use JustBetter\MagentoStock\Jobs\DispatchComparisonsJob;
+use JustBetter\MagentoStock\Jobs\Comparison\DispatchComparisonsJob;
 use Laravel\Nova\Actions\Action;
 use Laravel\Nova\Actions\ActionResponse;
 use Laravel\Nova\Fields\ActionFields;
@@ -17,14 +17,17 @@ class Compare extends Action
     use Queueable;
     use SerializesModels;
 
-    public $name = 'Compare Stock between Nova and Magento';
-
-    public $standalone = true;
+    public function __construct()
+    {
+        $this
+            ->withName(__('Compare Stock between Nova and Magento'))
+            ->standalone();
+    }
 
     public function handle(ActionFields $fields, Collection $models): ActionResponse
     {
         DispatchComparisonsJob::dispatch();
 
-        return ActionResponse::message(__('Starting compare'));
+        return ActionResponse::message(__('Comparing...'));
     }
 }

src/Nova/Actions/Compare.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace JustBetter\MagentoStockNova\Nova\Actions;
+
+use Illuminate\Bus\Queueable;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Queue\SerializesModels;
+use Illuminate\Support\Collection;
+use JustBetter\MagentoStock\Jobs\ProcessStocksJob;
+use Laravel\Nova\Actions\Action;
+use Laravel\Nova\Actions\ActionResponse;
+use Laravel\Nova\Fields\ActionFields;
+
+class Process extends Action
+{
+    use InteractsWithQueue;
+    use Queueable;
+    use SerializesModels;
+
+    public function __construct()
+    {
+        $this
+            ->withName(__('Process pending stock retrievals and updates'))
+            ->standalone();
+    }
+
+    public function handle(ActionFields $fields, Collection $models): ActionResponse
+    {
+        ProcessStocksJob::dispatch();
+
+        return ActionResponse::message(__('Processing...'));
+    }
+}

src/Nova/Actions/Process.php

@@ -6,27 +6,32 @@
 use Illuminate\Queue\InteractsWithQueue;
 use Illuminate\Queue\SerializesModels;
 use Illuminate\Support\Collection;
-use JustBetter\MagentoStock\Models\MagentoStock;
+use JustBetter\MagentoStock\Models\Stock;
 use Laravel\Nova\Actions\Action;
 use Laravel\Nova\Actions\ActionResponse;
 use Laravel\Nova\Fields\ActionFields;
 
 class ResetFailures extends Action
 {
-    use InteractsWithQueue, Queueable, SerializesModels;
+    use InteractsWithQueue;
+    use Queueable;
+    use SerializesModels;
 
-    public $name = 'Reset failures';
+    public function __construct()
+    {
+        $this->withName(__('Reset failures'));
+    }
 
+    /** @param Collection<int, Stock> $models */
     public function handle(ActionFields $fields, Collection $models): ActionResponse
     {
-        /** @var MagentoStock $model */
         foreach ($models as $model) {
             $model->update([
                 'fail_count' => 0,
-                'sync' => true
+                'sync' => true,
             ]);
         }
 
-        return ActionResponse::message(__('Finished'));
+        return ActionResponse::message(__('Failures reset!'));
     }
 }

src/Nova/Actions/ResetFailures.php

@@ -7,7 +7,7 @@
 use Illuminate\Queue\InteractsWithQueue;
 use Illuminate\Queue\SerializesModels;
 use Illuminate\Support\Collection;
-use JustBetter\MagentoStock\Jobs\RetrieveStockJob;
+use JustBetter\MagentoStock\Jobs\Retrieval\RetrieveStockJob;
 use Laravel\Nova\Actions\Action;
 use Laravel\Nova\Actions\ActionResponse;
 use Laravel\Nova\Fields\ActionFields;
@@ -20,27 +20,27 @@ class Retrieve extends Action implements ShouldQueue
     use Queueable;
     use SerializesModels;
 
-    public $name = 'Retrieve from source';
-
     public function __construct()
     {
-        $this->onQueue(config('magento-stock.queue'));
+        $this
+            ->withName(__('Retrieve from source'))
+            ->onQueue(config('magento-stock.queue'));
     }
 
     public function handle(ActionFields $fields, Collection $models): ActionResponse
     {
         foreach ($models as $model) {
-            RetrieveStockJob::dispatch($model->sku, $fields->force ?? false);
+            RetrieveStockJob::dispatch($model->sku, $fields->get('force', false));
         }
 
-        return ActionResponse::message(__('Retrieving :count stocks', ['count' => $models->count()]));
+        return ActionResponse::message(__('Retrieving :count stocks...', ['count' => $models->count()]));
     }
 
     public function fields(NovaRequest $request): array
     {
         return [
-            Boolean::make('Force')
-                ->help('Forces an update in Magento. Even if the stock hasn\'t changed')
+            Boolean::make(__('Force'), 'force')
+                ->help(__('Forces an update in Magento, even if the stock hasn\'t changed.')),
         ];
     }
 }

src/Nova/Actions/Retrieve.php

@@ -2,22 +2,32 @@
 
 namespace JustBetter\MagentoStockNova\Nova\Actions;
 
+use Illuminate\Bus\Queueable;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Queue\SerializesModels;
 use Illuminate\Support\Collection;
-use JustBetter\MagentoStock\Jobs\RetrieveAllStockJob;
+use JustBetter\MagentoStock\Jobs\Retrieval\RetrieveAllStockJob;
 use Laravel\Nova\Actions\Action;
 use Laravel\Nova\Actions\ActionResponse;
 use Laravel\Nova\Fields\ActionFields;
 
 class RetrieveAll extends Action
 {
-    public $name = 'Retrieve all from source';
+    use InteractsWithQueue;
+    use Queueable;
+    use SerializesModels;
 
-    public $standalone = true;
+    public function __construct()
+    {
+        $this
+            ->withName(__('Retrieve all from source'))
+            ->standalone();
+    }
 
     public function handle(ActionFields $fields, Collection $models): ActionResponse
     {
         RetrieveAllStockJob::dispatch();
 
-        return ActionResponse::message(__('Retrieving'));
+        return ActionResponse::message(__('Retrieving...'));
     }
 }

src/Nova/Actions/RetrieveAll.php

@@ -6,21 +6,26 @@
 use Illuminate\Queue\InteractsWithQueue;
 use Illuminate\Queue\SerializesModels;
 use Illuminate\Support\Collection;
-use JustBetter\MagentoStock\Models\MagentoStock;
+use JustBetter\MagentoStock\Models\Stock;
 use Laravel\Nova\Actions\Action;
 use Laravel\Nova\Actions\ActionResponse;
 use Laravel\Nova\Fields\ActionFields;
 
 class Retry extends Action
 {
-    use InteractsWithQueue, Queueable, SerializesModels;
+    use InteractsWithQueue;
+    use Queueable;
+    use SerializesModels;
 
-    public $name = 'Retry Stock';
+    public function __construct()
+    {
+        $this->withName(__('Retry stock'));
+    }
 
     public function handle(ActionFields $fields, Collection $models): ActionResponse
     {
-        $models->each(fn(MagentoStock $stock) => $stock->update(['sync' => true, 'update' => true, 'fail_count' => 0]));
+        $models->each(fn (Stock $stock) => $stock->update(['sync' => true, 'update' => true, 'fail_count' => 0]));
 
-        return ActionResponse::message(__('Retrying'));
+        return ActionResponse::message(__('Retrying...'));
     }
 }