Merge branch '2.x' into next

Signed-off-by: Mior Muhammad Zaki <[email protected]>
nova-kit · Dec 14, 2024 · f7b82fc · f7b82fc
2 parents 5309c4d + 4e88f5a
commit f7b82fc
Show file tree

Hide file tree

Showing 29 changed files with 377 additions and 299 deletions.
diff --git a/.github/workflows/analyse.yaml b/.github/workflows/analyse.yaml
@@ -35,10 +35,6 @@ jobs:
         run: |
           composer config http-basic.nova.laravel.com ${{ secrets.NOVA_USERNAME }} ${{ secrets.NOVA_PASSWORD }}
 
-      - name: Install Laravel Pint
-        run: |
-          composer require "laravel/pint:^1.1" --no-interaction --no-update
-
       - name: Install dependencies
         uses: "ramsey/composer-install@v3"
         with:

diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml
@@ -50,7 +50,7 @@ jobs:
         run: composer show -D
 
       - name: Execute tests
-        run: vendor/bin/phpunit --testdox
+        run: composer run test
 
   tests-on-laravel-10:
     runs-on: ${{ matrix.os }}
@@ -97,4 +97,4 @@ jobs:
         run: composer show -D
 
       - name: Execute tests
-        run: vendor/bin/phpunit --testdox
+        run: composer run test
diff --git a/.gitignore b/.gitignore
@@ -4,4 +4,5 @@
 
 # PHPUnit
 /coverage/*
+/.phpunit.cache/*
 /.phpunit.result.cache
diff --git a/README.md b/README.md
@@ -21,15 +21,17 @@ You can replace `Laravel\Nova\Actions\ExportAsCsv` with `NovaKit\NovaQueuedExpor
 
 ```php
 use Laravel\Nova\Actions\ExportAsCsv;
+use Laravel\Nova\Http\Requests\NovaRequest;
 use NovaKit\NovaQueuedExportAsCsv\Actions\QueuedExportAsCsv;
 
+// ...
+
 /**
  * Get the actions available for the resource.
  *
- * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
- * @return array
+ * @return array<int, \Laravel\Nova\Actions\Action>
  */
-public function actions(NovaRequest $request)
+public function actions(NovaRequest $request): array
 {
     return [
         QueuedExportAsCsv::make(),
@@ -40,6 +42,10 @@ public function actions(NovaRequest $request)
 If you would like to change the storage disk to store the CSV file that is available for download, you may invoke the `withStorageDisk()` method when registering the action:
 
 ```php
+use NovaKit\NovaQueuedExportAsCsv\Actions\QueuedExportAsCsv;
+
+// ...
+
 return [
     QueuedExportAsCsv::make()->withStorageDisk('s3'),
 ];
@@ -51,6 +57,8 @@ You can also customise the response message by using the following code:
 use Laravel\Nova\Actions\Action;
 use NovaKit\NovaQueuedExportAsCsv\Actions\QueuedExportAsCsv;
 
+// ...
+
 return [
     QueuedExportAsCsv::make()->then(function () {
         return response()->json(Action::message('Action has been queued!'));

diff --git a/composer.json b/composer.json
@@ -16,7 +16,7 @@
     },
     "autoload-dev": {
         "psr-4": {
-            "NovaKit\\NovaQueuedExportAsCsv\\Tests\\": "tests/",
+            "Tests\\": "tests/",
             "Workbench\\App\\": "workbench/app/",
             "Workbench\\Database\\Factories\\": "workbench/database/factories/",
             "Workbench\\Database\\Seeders\\": "workbench/database/seeders/"
@@ -25,29 +25,30 @@
     "require": {
         "php": "^8.1",
         "composer-runtime-api": "^2.2",
-        "illuminate/support": "^10.34 || ^11.0",
+        "illuminate/support": "^10.48.23 || ^11.35",
         "laravie/serialize-queries": "^3.0",
         "laravel/serializable-closure": "^1.0",
         "symfony/polyfill-php83": "^1.28"
     },
     "require-dev": {
         "guzzlehttp/guzzle": "^7.2",
         "larastan/larastan": "^2.4",
-        "laravel/nova": "^4.35",
+        "laravel/nova": "^5.0",
+        "laravel/nova-devtool": "^1.0.1",
         "laravel/pint": "^1.17",
-        "nova-kit/nova-devtool": "^1.0",
         "orchestra/testbench": "^8.20 || ^9.0",
+        "orchestra/pest-plugin-testbench": "^2.0",
         "phpstan/phpstan": "^1.11"
     },
+    "conflict": {
+        "laravel/nova": "<5.0.0 || >=6.0.0"
+    },
     "repositories": [
-        {
-            "type": "composer",
-            "url": "https://nova.laravel.com"
-        }
+        { "type": "composer", "url": "https://nova.laravel.com" }
     ],
-    "extra": {
-        "branch-alias": {
-            "dev-main": "2.x-dev"
+    "config": {
+        "allow-plugins": {
+            "pestphp/pest-plugin": true
         }
     },
     "scripts": {
@@ -59,14 +60,16 @@
         "prepare": "@php vendor/bin/testbench package:discover --ansi",
         "build": "@php vendor/bin/testbench workbench:build --ansi",
         "serve": [
+            "Composer\\Config::disableProcessTimeout",
             "@build",
-            "@php vendor/bin/testbench serve"
+            "@php vendor/bin/testbench serve --ansi"
         ],
         "lint": [
-            "@php vendor/bin/phpstan analyse"
+            "@php vendor/bin/pint --ansi",
+            "@php vendor/bin/phpstan analyse --verbose"
         ],
         "test": [
-            "@php vendor/bin/phpunit"
+            "@php vendor/bin/pest"
         ],
         "ci": [
             "@lint",

diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -10,8 +10,10 @@ parameters:
   # The level 8 is the highest level
   level: 6
 
-  checkMissingIterableValueType: false
+  ignoreErrors:
+    - identifier: missingType.generics
+    - identifier: missingType.iterableValue
+
   noUnnecessaryCollectionCall: false
   checkModelProperties: false
   reportUnmatchedIgnoredErrors: false
-  checkGenericClassInNonGenericObjectType: false
diff --git a/phpunit.xml b/phpunit.xml
@@ -1,21 +1,12 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd"
          backupGlobals="false"
-         backupStaticAttributes="false"
          colors="true"
-         convertDeprecationsToExceptions="true"
-         convertErrorsToExceptions="true"
-         convertNoticesToExceptions="true"
-         convertWarningsToExceptions="true"
          processIsolation="false"
          stopOnFailure="false"
-         verbose="true">
-    <coverage includeUncoveredFiles="false">
-        <include>
-            <directory suffix=".php">src/</directory>
-        </include>
-    </coverage>
+         cacheDirectory=".phpunit.cache"
+         backupStaticProperties="false">
     <testsuites>
         <testsuite name="Test Suite">
             <directory suffix="Test.php">./tests/</directory>
@@ -26,4 +17,9 @@
         <env name="APP_KEY" value="AckfSECXIvnK5r28GVIWUAxmbBSjTsmF"/>
         <env name="DB_CONNECTION" value="testing"/>
     </php>
+    <source>
+        <include>
+            <directory suffix=".php">src/</directory>
+        </include>
+    </source>
 </phpunit>
diff --git a/pint.json b/pint.json
@@ -1,6 +1,9 @@
 {
   "preset": "laravel",
   "rules": {
-    "no_superfluous_phpdoc_tags": false
+    "method_chaining_indentation": false,
+    "no_superfluous_phpdoc_tags": {
+      "allow_mixed": true
+    }
   }
 }
diff --git a/src/Actions/QueuedExportAsCsv.php b/src/Actions/QueuedExportAsCsv.php
@@ -18,26 +18,20 @@ class QueuedExportAsCsv extends ExportAsCsv
 {
     /**
      * Storage disk used to store the file.
-     *
-     * @var string|null
      */
-    public $storageDisk;
+    public ?string $storageDisk;
 
     /**
      * Determine if file should be deleted after send.
-     *
-     * @var bool
      */
-    public $deleteFileAfterSend = false;
+    public bool $deleteFileAfterSend = false;
 
     /**
      * Construct a new action instance.
      *
-     * @param  string|null  $name
-     * @param  string|null  $storageDisk
      * @return void
      */
-    public function __construct($name = null, $storageDisk = null)
+    public function __construct(?string $name = null, ?string $storageDisk = null)
     {
         parent::__construct($name);
 
@@ -47,10 +41,9 @@ public function __construct($name = null, $storageDisk = null)
     /**
      * Set the storage disk.
      *
-     * @param  string|null  $storageDisk
      * @return $this
      */
-    public function withStorageDisk($storageDisk)
+    public function withStorageDisk(?string $storageDisk)
     {
         $this->storageDisk = $storageDisk;
 
@@ -59,11 +52,9 @@ public function withStorageDisk($storageDisk)
 
     /**
      * Perform the action request using custom dispatch handler.
-     *
-     * @return \Laravel\Nova\Actions\Response
      */
     #[\Override]
-    protected function dispatchRequestUsing(ActionRequest $request, Response $response, ActionFields $fields)
+    protected function dispatchRequestUsing(ActionRequest $request, Response $response, ActionFields $fields): Response
     {
         $query = $request->toSelectedResourceQuery();
 

diff --git a/src/Events/QueuedCsvExported.php b/src/Events/QueuedCsvExported.php
@@ -10,38 +10,17 @@ class QueuedCsvExported
 {
     use Dispatchable, InteractsWithSockets, SerializesModels;
 
-    /**
-     * The User instance.
-     *
-     * @var \Illuminate\Contracts\Auth\Authenticatable&\Illuminate\Database\Eloquent\Model
-     */
-    public $user;
-
-    /**
-     * The storage filename.
-     *
-     * @var string
-     */
-    public $filename;
-
-    /**
-     * The storage disk.
-     *
-     * @var string|null
-     */
-    public $storageDisk;
-
     /**
      * Create a new event instance.
      *
      * @param  \Illuminate\Contracts\Auth\Authenticatable&\Illuminate\Database\Eloquent\Model  $user
-     * @param  string|null  $storageDisk
      * @return void
      */
-    public function __construct($user, string $filename, $storageDisk)
-    {
-        $this->user = $user;
-        $this->filename = $filename;
-        $this->storageDisk = $storageDisk;
+    public function __construct(
+        public $user,
+        public readonly string $filename,
+        public readonly ?string $storageDisk
+    ) {
+        //
     }
 }
diff --git a/src/Jobs/QueuedExportAsCsv.php b/src/Jobs/QueuedExportAsCsv.php
@@ -5,7 +5,6 @@
 use Illuminate\Bus\Queueable;
 use Illuminate\Contracts\Queue\ShouldQueue;
 use Illuminate\Filesystem\Filesystem;
-use Illuminate\Foundation\Auth\User;
 use Illuminate\Foundation\Bus\Dispatchable;
 use Illuminate\Http\File;
 use Illuminate\Queue\InteractsWithQueue;
@@ -21,60 +20,36 @@ class QueuedExportAsCsv implements ShouldQueue
 {
     use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
 
-    /**
-     * The query builder.
-     *
-     * @var array<string, mixed>
-     */
-    public $query;
-
-    /**
-     * The User ID.
-     *
-     * @var string|int
-     */
-    public $userId;
-
-    /**
-     * The custom format callback.
-     *
-     * @var (callable(\Illuminate\Database\Eloquent\Model):array<string, mixed>)|null
-     */
-    public $withFormatCallback;
-
     /**
      * The configuration options.
      *
      * @var array{filename: string, storageDisk: string|null, notify: string}
      */
-    public $options;
+    public array $options;
 
     /**
      * Create a new job instance.
      *
      * @param  array<string, mixed>  $query
-     * @param  string|int  $userId
      * @param  (callable(\Illuminate\Database\Eloquent\Model):array<string, mixed>)|null  $withFormatCallback
      * @param  array{filename: string, storageDisk: string|null, notify: string}  $options
      * @return void
      */
-    public function __construct(array $query, $userId, $withFormatCallback, array $options)
-    {
-        $this->query = $query;
-        $this->userId = $userId;
-        $this->withFormatCallback = $withFormatCallback;
-
+    public function __construct(
+        public array $query,
+        public string|int $userId,
+        public $withFormatCallback,
+        array $options
+    ) {
         $this->options = array_merge([
             'storageDisk' => null,
         ], $options);
     }
 
     /**
      * Execute the job.
-     *
-     * @return void
      */
-    public function handle()
+    public function handle(): void
     {
         $query = unserialize($this->query);
 
@@ -98,7 +73,7 @@ public function handle()
             'nova-actions-export-as-csv', new File($exportedFilename), $filename, 'public'
         );
 
-        (new Filesystem())->delete($exportedFilename);
+        (new Filesystem)->delete($exportedFilename);
 
         /** @var \Illuminate\Contracts\Auth\Authenticatable&\Illuminate\Database\Eloquent\Model $user */
         $user = $userModel::findOrFail($this->userId);

diff --git a/testbench.yaml b/testbench.yaml
@@ -9,7 +9,9 @@ seeders:
 
 workbench:
   start: /nova
+  user: [email protected]
   build:
+    - package:discover
     - asset-publish
     - create-sqlite-db
     - db:wipe