Replace ConfigHelper with ConfigData

Author: andrey-helldar

config/deploy-operations.php

@@ -39,11 +39,12 @@
     */
 
     'transactions' => [
-        // | Determines whether the use of database transactions is enabled.
+        // Determines whether the use of database transactions is enabled.
 
         'enabled' => false,
 
-        // | The number of attempts to execute a request within a transaction before throwing an error.
+        // The number of attempts to execute a request within a transaction before throwing an error.
+
         'attempts' => 1,
     ],
 
@@ -146,6 +147,6 @@
         |
         */
 
-        'full_path' => env('DEPLOY_OPERATIONS_SHOW_FULL_PATH', false),
+        'full_path' => (bool) env('DEPLOY_OPERATIONS_SHOW_FULL_PATH', false),
     ],
 ];

database/migrations/2022_08_18_180137_change_migration_actions_table.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-use DragonCode\LaravelDeployOperations\Helpers\ConfigHelper;
+use DragonCode\LaravelDeployOperations\Data\Config\ConfigData;
 use Illuminate\Database\Migrations\Migration;
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
@@ -49,6 +49,6 @@ protected function doesntHaveColumn(string $column): bool
 
     protected function table(): string
     {
-        return app(ConfigHelper::class)->table();
+        return app(ConfigData::class)->table;
     }
 };

database/migrations/2023_01_21_172923_rename_migrations_actions_table_to_actions.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-use DragonCode\LaravelDeployOperations\Helpers\ConfigHelper;
+use DragonCode\LaravelDeployOperations\Data\Config\ConfigData;
 use Illuminate\Database\Migrations\Migration;
 use Illuminate\Support\Facades\Schema;
 
@@ -28,7 +28,13 @@ public function down(): void
     protected function validateTable(string $name): void
     {
         if (Schema::hasTable($name)) {
-            throw new RuntimeException(sprintf('A table named [%s] already exists. Change the table name settings in the [%s] configuration file.', $name, 'config/actions.php'));
+            throw new RuntimeException(
+                sprintf(
+                    'A table named [%s] already exists. Change the table name settings in the [%s] configuration file.',
+                    $name,
+                    'config/actions.php'
+                )
+            );
         }
     }
 
@@ -39,6 +45,6 @@ protected function doesntSame(string $first, string $second): bool
 
     protected function table(): string
     {
-        return app(ConfigHelper::class)->table();
+        return app(ConfigData::class)->table;
     }
 };

database/migrations/2024_05_21_112438_rename_actions_table_to_operations.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-use DragonCode\LaravelDeployOperations\Helpers\ConfigHelper;
+use DragonCode\LaravelDeployOperations\Data\Config\ConfigData;
 use Illuminate\Database\Migrations\Migration;
 use Illuminate\Support\Facades\Schema;
 
@@ -28,7 +28,13 @@ public function down(): void
     protected function validateTable(string $name): void
     {
         if (Schema::hasTable($name)) {
-            throw new RuntimeException(sprintf('A table named [%s] already exists. Change the table name settings in the [%s] configuration file.', $name, 'config/deploy-operations.php'));
+            throw new RuntimeException(
+                sprintf(
+                    'A table named [%s] already exists. Change the table name settings in the [%s] configuration file.',
+                    $name,
+                    'config/deploy-operations.php'
+                )
+            );
         }
     }
 
@@ -39,6 +45,6 @@ protected function doesntSame(string $first, string $second): bool
 
     protected function table(): string
     {
-        return app(ConfigHelper::class)->table();
+        return app(ConfigData::class)->table;
     }
 };

database/migrations/2024_05_21_114318_rename_column_in_operations_table.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-use DragonCode\LaravelDeployOperations\Helpers\ConfigHelper;
+use DragonCode\LaravelDeployOperations\Data\Config\ConfigData;
 use Illuminate\Database\Migrations\Migration;
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
@@ -27,6 +27,6 @@ protected function rename(string $from, string $to): void
 
     protected function table(): string
     {
-        return app(ConfigHelper::class)->table();
+        return app(ConfigData::class)->table;
     }
 };

src/Data/Casts/Config/ExcludeCast.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace DragonCode\LaravelDeployOperations\Data\Casts\Config;
+
+use Illuminate\Support\Collection;
+use Illuminate\Support\Str;
+use Spatie\LaravelData\Casts\Cast;
+use Spatie\LaravelData\Support\Creation\CreationContext;
+use Spatie\LaravelData\Support\DataProperty;
+
+class ExcludeCast implements Cast
+{
+    public function cast(DataProperty $property, mixed $value, array $properties, CreationContext $context): array
+    {
+        return (new Collection($value))
+            ->map(static fn (string $path) => Str::replace(['\\', '/'], DIRECTORY_SEPARATOR, $path))
+            ->filter()
+            ->all();
+    }
+}

src/Data/Casts/Config/PathCast.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace DragonCode\LaravelDeployOperations\Data\Casts\Config;
+
+use Spatie\LaravelData\Casts\Cast;
+use Spatie\LaravelData\Support\Creation\CreationContext;
+use Spatie\LaravelData\Support\DataProperty;
+
+use function rtrim;
+
+class PathCast implements Cast
+{
+    public function cast(DataProperty $property, mixed $value, array $properties, CreationContext $context): string
+    {
+        return rtrim($value, '\\/') . DIRECTORY_SEPARATOR;
+    }
+}

src/Data/Casts/OperationNameCast.php

@@ -18,9 +18,9 @@ public function cast(DataProperty $property, mixed $value, array $properties, Cr
         }
 
         return Str::of($value)
-            ->replace('\\', '/')
+            ->replace('\\', DIRECTORY_SEPARATOR)
             ->replace('.php', '')
-            ->explode('/')
+            ->explode(DIRECTORY_SEPARATOR)
             ->map(fn (string $path) => Str::snake($path))
             ->implode(DIRECTORY_SEPARATOR)
             ->toString();

src/Data/Casts/PathCast.php

@@ -4,7 +4,7 @@
 
 namespace DragonCode\LaravelDeployOperations\Data\Casts;
 
-use DragonCode\LaravelDeployOperations\Helpers\ConfigHelper;
+use DragonCode\LaravelDeployOperations\Data\Config\ConfigData;
 use Illuminate\Support\Str;
 use Spatie\LaravelData\Casts\Cast;
 use Spatie\LaravelData\Support\Creation\CreationContext;
@@ -17,7 +17,7 @@ class PathCast implements Cast
 {
     public function cast(DataProperty $property, mixed $value, array $properties, CreationContext $context): string
     {
-        $path = $this->config()->basePath((string) $value);
+        $path = $this->config()->path . $value;
 
         if ($properties['realpath'] ?? false) {
             return $value ?: $path;
@@ -31,8 +31,8 @@ protected function filename(string $path): false|string
         return realpath(Str::finish($path, '.php'));
     }
 
-    protected function config(): ConfigHelper
+    protected function config(): ConfigData
     {
-        return app(ConfigHelper::class);
+        return app(ConfigData::class);
     }
 }

src/Data/Config/ConfigData.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DragonCode\LaravelDeployOperations\Data\Config;
+
+use DragonCode\LaravelDeployOperations\Data\Casts\Config\ExcludeCast;
+use DragonCode\LaravelDeployOperations\Data\Casts\Config\PathCast;
+use Spatie\LaravelData\Attributes\WithCast;
+use Spatie\LaravelData\Data;
+
+class ConfigData extends Data
+{
+    public ?string $connection;
+
+    public string $table;
+
+    #[WithCast(PathCast::class)]
+    public string $path;
+
+    #[WithCast(ExcludeCast::class)]
+    public ?array $exclude;
+
+    public bool $async;
+
+    public TransactionsData $transactions;
+
+    public QueueData $queue;
+
+    public ShowData $show;
+}