Change from Loader (load only) to Storage (load and save)

kpscyber · kpscyber · commit 94423038f7b8 · 2024-09-15T01:08:49.000+07:00
diff --git a/config/workflow-storage.php b/config/workflow-storage.php
@@ -1,13 +1,13 @@
 <?php
 
 return [
-    'databaseLoader' => [
+    'databaseStorage' => [
         'tableNames' => [
             'workflows' => 'workflows',
             'workflow_states' => 'workflow_states',
             'workflow_transitions' => 'workflow_transitions',
             'workflow_state_transitions' => 'workflow_state_transitions',
         ],
-        //'loaderClass' => \Soap\WorkflowStorage\DatabaseLoader::class,
+        'loaderClass' => \Soap\WorkflowStorage\DatabaseStorage::class,
     ],
 ];
diff --git a/database/factories/WorkflowFactory.php b/database/factories/WorkflowFactory.php
@@ -9,7 +9,7 @@ class WorkflowFactory extends Factory
 {
     protected $model = Workflow::class;
 
-    public function definition()
+    public function definition(): array
     {
         return [
             'name' => $this->faker->name,
diff --git a/src/Contracts/WorkflowDatabaseStorage.php b/src/Contracts/WorkflowDatabaseStorage.php
@@ -2,10 +2,8 @@
 
 namespace Soap\WorkflowStorage\Contracts;
 
-interface WorkflowLoader
+interface WorkflowDatabaseStorage extends WorkflowStorage
 {
-    public function load(string $workflowName): array;
-
     public function getWorkflowTableName(): string;
 
     public function getWorkflowStateTableName(): string;
diff --git a/src/Contracts/WorkflowStorage.php b/src/Contracts/WorkflowStorage.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace Soap\WorkflowStorage\Contracts;
+
+interface WorkflowStorage
+{
+    public function all(): array;
+
+    public function load(string $workflowName): array;
+}
diff --git a/src/DatabaseStorage.php b/src/DatabaseStorage.php
@@ -2,10 +2,9 @@
 
 namespace Soap\WorkflowStorage;
 
-use Soap\WorkflowStorage\Contracts\WorkflowLoader;
-use Soap\WorkflowStorage\Models\Workflow;
+use Soap\WorkflowStorage\Contracts\WorkflowDatabaseStorage;
 
-class DatabaseLoader implements WorkflowLoader
+class DatabaseStorage implements WorkflowDatabaseStorage
 {
     const KEY_TABLENAMES = 'tableNames';
 
@@ -51,9 +50,13 @@ public function getWorkflowStateTransitionTableName(): string
 
     public function load(string $workflowName): array
     {
-        $workflow = Workflow::with(['states', 'transitions'])->where('name', $workflowName)->first();
-        $config[$workflowName] = [];
+        $workflowConfig = [];
 
-        return $config;
+        return $workflowConfig;
+    }
+
+    public function all(): array
+    {
+        return [];
     }
 }
diff --git a/src/Models/Workflow.php b/src/Models/Workflow.php
@@ -5,7 +5,7 @@
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\HasMany;
-use Soap\WorkflowStorage\DatabaseLoader;
+use Soap\WorkflowStorage\DatabaseStorage;
 use Soap\WorkflowStorage\Enums\WorkflowTypeEnum;
 
 class Workflow extends Model
@@ -22,7 +22,7 @@ class Workflow extends Model
 
     public function getTable(): string
     {
-        return app(DatabaseLoader::class)->getWorkflowTableName();
+        return app(DatabaseStorage::class)->getWorkflowTableName();
     }
 
     public function states(): HasMany
diff --git a/src/Models/WorkflowState.php b/src/Models/WorkflowState.php
@@ -5,7 +5,7 @@
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
-use Soap\WorkflowStorage\DatabaseLoader;
+use Soap\WorkflowStorage\DatabaseStorage;
 
 class WorkflowState extends Model
 {
@@ -21,7 +21,7 @@ class WorkflowState extends Model
 
     public function getTable(): string
     {
-        return app(DatabaseLoader::class)->getWorkflowStateTableName();
+        return app(DatabaseStorage::class)->getWorkflowStateTableName();
     }
 
     public function workflow(): BelongsTo
diff --git a/src/Models/WorkflowStateTransition.php b/src/Models/WorkflowStateTransition.php
@@ -5,7 +5,7 @@
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
-use Soap\WorkflowStorage\DatabaseLoader;
+use Soap\WorkflowStorage\DatabaseStorage;
 
 class WorkflowStateTransition extends Model
 {
@@ -19,7 +19,7 @@ class WorkflowStateTransition extends Model
 
     public function getTable(): string
     {
-        return app(DatabaseLoader::class)->getWorkflowStateTransitionTableName();
+        return app(DatabaseStorage::class)->getWorkflowStateTransitionTableName();
     }
 
     public function transition(): BelongsTo
@@ -31,9 +31,4 @@ public function fromState(): BelongsTo
     {
         return $this->belongsTo(WorkflowState::class, 'from_state_id');
     }
-
-    public function toState(): BelongsTo
-    {
-        return $this->belongsTo(WorkflowState::class, 'to_state_id');
-    }
 }
diff --git a/src/Models/WorkflowTransition.php b/src/Models/WorkflowTransition.php
@@ -6,7 +6,7 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\Relations\HasMany;
-use Soap\WorkflowStorage\DatabaseLoader;
+use Soap\WorkflowStorage\DatabaseStorage;
 
 class WorkflowTransition extends Model
 {
@@ -20,7 +20,7 @@ class WorkflowTransition extends Model
 
     public function getTable(): string
     {
-        return app(DatabaseLoader::class)->getWorkflowTransitionTableName();
+        return app(DatabaseStorage::class)->getWorkflowTransitionTableName();
     }
 
     public function workflow(): BelongsTo
diff --git a/src/Repositories/WorkflowRepository.php b/src/Repositories/WorkflowRepository.php
@@ -6,13 +6,46 @@
 
 class WorkflowRepository
 {
-    public function all()
+    protected $model;
+
+    public function __construct(Workflow $model)
     {
-        return [];
+        $this->model = $model;
     }
 
     public function find($id)
     {
-        //$workflow = Workflow::with(['transitions.stateTransitions', 'states'])->find($id);
+        $workflow = $this->model->with(['transitions', 'states'])->find($id);
+        $places = $workflow->states->map(function ($state) {
+            return $state->name;
+        })->toArray();
+        $transitions = $workflow->transitions->map(function ($transition) {
+            return [
+                $transition->name => [
+                    'from' => $transition->fromStates->map(function ($transitionState) {
+                        return $transitionState->fromState->name;
+                    })->toArray(),
+                    'to' => $transition->toState->name,
+                ],
+            ];
+        })->toArray();
+
+        return [
+            $workflow->name => [
+                'supports' => $workflow->supports,
+                'places' => $places,
+                'transitions' => $transitions,
+            ],
+        ];
+    }
+
+    public function findByName(string $name): array
+    {
+        $workflowId = $this->model->where('name', $name)->first()->id;
+        if (! $workflowId) {
+            return [];
+        }
+
+        return $this->find($workflowId);
     }
 }
diff --git a/src/WorkflowStorage.php b/src/WorkflowStorage.php
@@ -2,25 +2,25 @@
 
 namespace Soap\WorkflowStorage;
 
-use Soap\WorkflowStorage\Contracts\WorkflowLoader;
+use Soap\WorkflowStorage\Contracts\WorkflowStorage as WorkflowStorageContract;
 
 class WorkflowStorage
 {
     protected array $loaders = [];
 
-    public function __construct(?WorkflowLoader $loader)
+    public function __construct(?WorkflowStorageContract $loader)
     {
         if ($loader) {
             $this->registerLoader($loader);
         }
     }
 
-    public function registerLoader(WorkflowLoader $loader)
+    public function registerLoader(WorkflowStorageContract $loader)
     {
         $this->loaders[$loader::class] = $loader;
     }
 
-    public function getLoader(string $loader): WorkflowLoader
+    public function getLoader(string $loader): WorkflowStorageContract
     {
         return $this->loaders[$loader];
     }
diff --git a/src/WorkflowStorageServiceProvider.php b/src/WorkflowStorageServiceProvider.php
@@ -31,13 +31,13 @@ public function configurePackage(Package $package): void
     public function packageRegistered()
     {
         $this->app->singleton('workflow-storage', function ($app) {
-            $workflowStorage = new WorkflowStorage($app->make(DatabaseLoader::class));
+            $workflowStorage = new WorkflowStorage($app->make(DatabaseStorage::class));
         });
 
-        $this->app->singleton(DatabaseLoader::class, function ($app) {
-            $config = $app->make('config')->get('workflow-storage.databaseLoader', []);
+        $this->app->singleton(DatabaseStorage::class, function ($app) {
+            $config = $app->make('config')->get('workflow-storage.databaseStorage', []);
 
-            return new DatabaseLoader(config: $config);
+            return new DatabaseStorage(config: $config);
         });
 
     }
diff --git a/tests/Feature/WorkflowStorageTest.php b/tests/Feature/WorkflowStorageTest.php
@@ -1,14 +1,16 @@
 <?php
 
+use Illuminate\Support\Arr;
 use Soap\WorkflowStorage\Models\Workflow;
+use Soap\WorkflowStorage\Repositories\WorkflowRepository;
 
 beforeEach(function () {
 
     $workflow = Workflow::create([
-        'name' => 'Test Workflow',
+        'name' => 'test_workflow',
         'type' => 'workflow',
         'description' => 'Test Workflow Description',
-        'supports' => [],
+        'supports' => ['App\Models\Article'],
         'metadata' => [],
     ]);
 
@@ -43,17 +45,26 @@
     ]);
 });
 
-test('data can be retrieved from the database', function () {
+test('workflow data can be retrieved via models from the database', function () {
     $workflow = Workflow::first();
     $states = $workflow->states;
     $transitions = $workflow->transitions;
 
-    expect($workflow->name)->toBe('Test Workflow');
+    expect($workflow->name)->toBe('test_workflow');
     expect($workflow->type->value)->toBe('workflow');
     expect($workflow->description)->toBe('Test Workflow Description');
-    expect($workflow->supports)->toBe([]);
+    expect($workflow->supports)->toBe(['App\Models\Article']);
     expect($workflow->metadata)->toBe([]);
 
     expect($states->count())->toBe(4);
     expect($transitions->count())->toBe(1);
 });
+
+test('workflow configuration can be retrievd via the repository', function () {
+    $repo = app()->make(WorkflowRepository::class);
+    $config = $repo->find(1);
+    ray($config);
+    expect(count($config))->toBe(1);
+    expect(count(Arr::get($config, 'test_workflow.places')))->toBe(4);
+    expect(count(Arr::get($config, 'test_workflow.transitions')))->toBe(1);
+});
diff --git a/workbench/app/Models/Article.php b/workbench/app/Models/Article.php
@@ -0,0 +1,20 @@
+<?php
+
+namespace Workbench\App\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Workbench\AppModels\User;
+use ZeroDaHero\LaravelWorkflow\Traits\WorkflowTrait;
+
+class Order extends Model
+{
+    protected $guarded = ['id'];
+
+    use WorkflowTrait;
+
+    public function user(): BelongsTo
+    {
+        return $this->belongsTo(User::class);
+    }
+}
diff --git a/workbench/database/factories/ArticleFactory.php b/workbench/database/factories/ArticleFactory.php
@@ -0,0 +1,28 @@
+<?php
+
+namespace Workbench\Database\Factories;
+
+use Illuminate\Database\Eloquent\Factories\Factory;
+
+class ArticleFactory extends Factory
+{
+    protected $model = Order::class;
+
+    public function definition()
+    {
+        return [
+            'title' => $this->faker->sentence(),
+        ];
+    }
+
+    public function forUser(int|User $user)
+    {
+        $userId = is_object($user) ? $user->id : $user;
+
+        return $this->state(function (array $attributes) {
+            return [
+                'user_id' => $userId,
+            ];
+        });
+    }
+}
diff --git a/workbench/database/migrations/2024_09_12_081000_create_articles_table.php b/workbench/database/migrations/2024_09_12_081000_create_articles_table.php
@@ -0,0 +1,23 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+    public function up()
+    {
+        Schema::create('articles', function (Blueprint $table) {
+            $table->id();
+            $table->string('title');
+            $table->string('state')->default('draft');
+            $table->string('intro_image')->nullable();
+            $table->string('content_image')->nullable();
+            $table->text('intro_text')->nullable();
+            $table->text('content')->nullable();
+            $table->unsignedBigInteger('user_id')->nullable();
+            $table->timestamps();
+        });
+    }
+};

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ class WorkflowFactory extends Factory`
`9`	`9`	`{`
`10`	`10`	`protected $model = Workflow::class;`
`11`	`11`
`12`		`- public function definition()`
	`12`	`+ public function definition(): array`
`13`	`13`	`{`
`14`	`14`	`return [`
`15`	`15`	`'name' => $this->faker->name,`
Original file line number	Diff line number	Diff line change
`@@ -2,10 +2,8 @@`
`2`	`2`
`3`	`3`	`namespace Soap\WorkflowStorage\Contracts;`
`4`	`4`
`5`		`-interface WorkflowLoader`
	`5`	`+interface WorkflowDatabaseStorage extends WorkflowStorage`
`6`	`6`	`{`
`7`		`- public function load(string $workflowName): array;`
`8`		`-`
`9`	`7`	`public function getWorkflowTableName(): string;`
`10`	`8`
`11`	`9`	`public function getWorkflowStateTableName(): string;`
Original file line number	Diff line number	Diff line change
`@@ -2,10 +2,9 @@`
`2`	`2`
`3`	`3`	`namespace Soap\WorkflowStorage;`
`4`	`4`
`5`		`-use Soap\WorkflowStorage\Contracts\WorkflowLoader;`
`6`		`-use Soap\WorkflowStorage\Models\Workflow;`
	`5`	`+use Soap\WorkflowStorage\Contracts\WorkflowDatabaseStorage;`
`7`	`6`
`8`		`-class DatabaseLoader implements WorkflowLoader`
	`7`	`+class DatabaseStorage implements WorkflowDatabaseStorage`
`9`	`8`	`{`
`10`	`9`	`const KEY_TABLENAMES = 'tableNames';`
`11`	`10`
`@@ -51,9 +50,13 @@ public function getWorkflowStateTransitionTableName(): string`
`51`	`50`
`52`	`51`	`public function load(string $workflowName): array`
`53`	`52`	`{`
`54`		`- $workflow = Workflow::with(['states', 'transitions'])->where('name', $workflowName)->first();`
`55`		`- $config[$workflowName] = [];`
	`53`	`+ $workflowConfig = [];`
`56`	`54`
`57`		`- return $config;`
	`55`	`+ return $workflowConfig;`
	`56`	`+ }`
	`57`	`+`
	`58`	`+ public function all(): array`
	`59`	`+ {`
	`60`	`+ return [];`
`58`	`61`	`}`
`59`	`62`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`use Illuminate\Database\Eloquent\Factories\HasFactory;`
`6`	`6`	`use Illuminate\Database\Eloquent\Model;`
`7`	`7`	`use Illuminate\Database\Eloquent\Relations\HasMany;`
`8`		`-use Soap\WorkflowStorage\DatabaseLoader;`
	`8`	`+use Soap\WorkflowStorage\DatabaseStorage;`
`9`	`9`	`use Soap\WorkflowStorage\Enums\WorkflowTypeEnum;`
`10`	`10`
`11`	`11`	`class Workflow extends Model`
`@@ -22,7 +22,7 @@ class Workflow extends Model`
`22`	`22`
`23`	`23`	`public function getTable(): string`
`24`	`24`	`{`
`25`		`- return app(DatabaseLoader::class)->getWorkflowTableName();`
	`25`	`+ return app(DatabaseStorage::class)->getWorkflowTableName();`
`26`	`26`	`}`
`27`	`27`
`28`	`28`	`public function states(): HasMany`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`use Illuminate\Database\Eloquent\Model;`
`7`	`7`	`use Illuminate\Database\Eloquent\Relations\BelongsTo;`
`8`	`8`	`use Illuminate\Database\Eloquent\Relations\HasMany;`
`9`		`-use Soap\WorkflowStorage\DatabaseLoader;`
	`9`	`+use Soap\WorkflowStorage\DatabaseStorage;`
`10`	`10`
`11`	`11`	`class WorkflowTransition extends Model`
`12`	`12`	`{`
`@@ -20,7 +20,7 @@ class WorkflowTransition extends Model`
`20`	`20`
`21`	`21`	`public function getTable(): string`
`22`	`22`	`{`
`23`		`- return app(DatabaseLoader::class)->getWorkflowTransitionTableName();`
	`23`	`+ return app(DatabaseStorage::class)->getWorkflowTransitionTableName();`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`public function workflow(): BelongsTo`