Merge pull request #10 from soap/develop

soap · web-flow · commit 302d41f57d0b · 2024-09-19T16:43:41.000+07:00
Develop
diff --git a/config/workflow_loader.php b/config/workflow_loader.php
@@ -1,13 +1,15 @@
 <?php
 
 return [
-    'databaseLoader' => [
-        'tableNames' => [
-            'workflows' => 'workflows',
-            'workflow_states' => 'workflow_states',
-            'workflow_transitions' => 'workflow_transitions',
-            'workflow_state_transitions' => 'workflow_state_transitions',
+    'loaders' => [
+        'database' => [
+            'tableNames' => [
+                'workflows' => 'workflows',
+                'workflow_states' => 'workflow_states',
+                'workflow_transitions' => 'workflow_transitions',
+                'workflow_state_transitions' => 'workflow_state_transitions',
+            ],
+            'class' => \Soap\WorkflowLoader\DatabaseLoader::class,
         ],
-        'loaderClass' => \Soap\WorkflowLoader\DatabaseLoader::class,
     ],
 ];
diff --git a/database/migrations/wf1_create_workflows_table.php b/database/migrations/wf1_create_workflows_table.php
@@ -8,20 +8,23 @@
 {
     public function up()
     {
-        Schema::create('workflows', function (Blueprint $table) {
+        $tableName = app(\Soap\WorkflowLoader\DatabaseLoader::class)->getWorkflowTableName();
+        Schema::create($tableName, function (Blueprint $table) {
             $table->id();
             $table->string('name');
-            $table->string('marking_store_attribute')->nullable()->comment('name of marking store attribute');
+            $table->text('marking_store')->nullable()->comment('marking store as array');
             $table->string('type')->default('workflow')->comment('workflow or state_machine');
             $table->text('description')->nullable();
             $table->json('supports')->nullable()->comment('support models');
             $table->json('metadata')->nullable()->comment('metadata');
+            $table->boolean('active')->default(true);
             $table->timestamps();
         });
     }
 
     public function down()
     {
-        Schema::dropIfExists('workflows');
+        $tableName = app(\Soap\WorkflowLoader\DatabaseLoader::class)->getWorkflowTableName();
+        Schema::dropIfExists($tableName);
     }
 };
diff --git a/database/migrations/wf2_create_workflow_states_table.php b/database/migrations/wf2_create_workflow_states_table.php
@@ -8,7 +8,8 @@
 {
     public function up()
     {
-        Schema::create('workflow_states', function (Blueprint $table) {
+        $tableName = app(\Soap\WorkflowLoader\DatabaseLoader::class)->getWorkflowStateTableName();
+        Schema::create($tableName, function (Blueprint $table) {
             $table->id();
             $table->string('name');
             $table->tinyInteger('initial_state')->default(0)->comment('initial state');
@@ -21,6 +22,7 @@ public function up()
 
     public function down()
     {
-        Schema::dropIfExists('workflow_states');
+        $tableName = app(\Soap\WorkflowLoader\DatabaseLoader::class)->getWorkflowStateTableName();
+        Schema::dropIfExists($tableName);
     }
 };
diff --git a/database/migrations/wf3_create_workflow_transitions_table.php b/database/migrations/wf3_create_workflow_transitions_table.php
@@ -8,7 +8,8 @@
 {
     public function up()
     {
-        Schema::create('workflow_transitions', function (Blueprint $table) {
+        $tableName = app(\Soap\WorkflowLoader\DatabaseLoader::class)->getWorkflowTransitionTableName();
+        Schema::create($tableName, function (Blueprint $table) {
             $table->id();
             $table->string('name');
             $table->foreignId('to_state_id')->constrained('workflow_states')->onDelete('cascade');
@@ -20,6 +21,7 @@ public function up()
 
     public function down()
     {
-        Schema::dropIfExists('workflow_transitions');
+        $tableName = app(\Soap\WorkflowLoader\DatabaseLoader::class)->getWorkflowTransitionTableName();
+        Schema::dropIfExists($tableName);
     }
 };
diff --git a/database/migrations/wf4_create_workflow_state_transitions_table.php b/database/migrations/wf4_create_workflow_state_transitions_table.php
@@ -8,7 +8,8 @@
 {
     public function up()
     {
-        Schema::create('workflow_state_transitions', function (Blueprint $table) {
+        $tableName = app(\Soap\WorkflowLoader\DatabaseLoader::class)->getWorkflowStateTransitionTableName();
+        Schema::create($tableName, function (Blueprint $table) {
             $table->id();
             $table->foreignId('workflow_transition_id')->constrained('workflow_transitions')->onDelete('cascade');
             $table->foreignId('from_state_id')->constrained('workflow_states')->onDelete('cascade');
@@ -19,6 +20,7 @@ public function up()
 
     public function down()
     {
-        Schema::dropIfExists('workflow_state_transitions');
+        $tableName = app(\Soap\WorkflowLoader\DatabaseLoader::class)->getWorkflowStateTransitionTableName();
+        Schema::dropIfExists($tableName);
     }
 };
diff --git a/resources/stubs/WorkflowServiceProvider.php.stub b/resources/stubs/WorkflowServiceProvider.php.stub
@@ -3,21 +3,17 @@
 namespace App\Providers;
 
 use Illuminate\Support\ServiceProvider;
-use Soap\WorkflowLoader\DatabaseLoader;
 
 class WorkflowServiceProvider extends ServiceProvider
 {
-    public function register()
-    {
-
-    }
+    public function register() {}
 
     public function boot()
     {
-        $registy = app()->make('workflow');
-        $workflowLoader = app()->make('workflow-loader');
-        foreach ($wokflowLoader->all() as $workflow => $config) {
-            $registy->addFromArray($workflow, $config);
+        $registry = app()->make('workflow');
+        $workflowLoaderRegistry = app()->make('workflowLoaderRegistry');   
+        foreach ($workflowLoaderRegistry->all() as $workflow => $config) {
+            $registry->addFromArray($workflow, $config);
         }
     }
 }
diff --git a/src/DatabaseLoader.php b/src/DatabaseLoader.php
@@ -14,12 +14,15 @@ class DatabaseLoader implements WorkflowDatabaseLoader
      */
     protected $config;
 
-    public function __construct(?array $config)
+    protected $repo;
+
+    public function __construct(?array $config, WorkflowRepository $repo)
     {
         if (! isset($config[self::KEY_TABLE_NAMES])) {
             throw new \InvalidArgumentException('Table names not found in config');
         }
         $this->config = $config;
+        $this->repo = $repo;
     }
 
     public function getTableNames(): array
@@ -54,15 +57,15 @@ public function getWorkflowStateTransitionTableName(): string
 
     public function load(string $workflowName): array
     {
-        $repo = app()->make(WorkflowRepository::class);
+        //$repo = app()->make(WorkflowRepository::class);
 
-        return $repo->findByName($workflowName);
+        return $this->repo->findByName($workflowName);
     }
 
     public function all(): array
     {
-        $repo = app()->make(WorkflowRepository::class);
+        //$repo = app()->make(WorkflowRepository::class);
 
-        return $repo->all();
+        return $this->repo->all();
     }
 }
diff --git a/src/Facades/WorkflowLoaderRegistry.php b/src/Facades/WorkflowLoaderRegistry.php
@@ -7,10 +7,10 @@
 /**
  * @see \Soap\WorkflowLoader\WorkflowLoader
  */
-class WorkflowLoader extends Facade
+class WorkflowLoaderRegistry extends Facade
 {
     protected static function getFacadeAccessor(): string
     {
-        return \Soap\WorkflowLoader\WorkflowLoader::class;
+        return 'workflowLoaderRegistry';
     }
 }
diff --git a/src/Models/Workflow.php b/src/Models/Workflow.php
@@ -17,6 +17,7 @@ class Workflow extends Model
     protected $casts = [
         'supports' => 'array',
         'metadata' => 'array',
+        'marking_store' => 'array',
         'type' => WorkflowTypeEnum::class,
     ];
 
diff --git a/src/Repositories/WorkflowRepository.php b/src/Repositories/WorkflowRepository.php
@@ -50,19 +50,21 @@ protected function makeWorkflowCofig($workflow): array
             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,
-                ],
+        $transitions = [];
+        foreach ($workflow->transitions as $transition) {
+            $transitions[$transition->name] = [
+                'from' => $transition->fromStates->map(function ($transitionState) {
+                    return $transitionState->fromState->name;
+                })->toArray(),
+                'to' => $transition->toState->name,
             ];
-        })->toArray();
+        }
 
         return [
             $workflow->name => [
+                'marking_store' => $workflow->marking_store ?? [],
+                'type' => $workflow->type ? $workflow->type->value : 'workflow',
+                'metadata' => $workflow->metadata,
                 'supports' => $workflow->supports,
                 'places' => $places,
                 'transitions' => $transitions,
diff --git a/src/WorkflowLoader.php b/src/WorkflowLoader.php
diff --git a/src/WorkflowLoaderRegistry.php b/src/WorkflowLoaderRegistry.php
@@ -0,0 +1,59 @@
+<?php
+
+namespace Soap\WorkflowLoader;
+
+use Soap\WorkflowLoader\Contracts\WorkflowLoader as WorkflowLoaderContract;
+
+class WorkflowLoaderRegistry
+{
+    protected array $loaders = [];
+
+    public function __construct(array $loaders)
+    {
+        foreach ($loaders as $key => $loader) {
+            if (! isset($loader['class'])) {
+                throw new \Exception("Key 'class' configuration not found in {$key} loader");
+            }
+
+            if (! class_exists($loader['class'])) {
+                throw new \Exception("Class {$loader['class']} not found");
+            }
+            $this->registerLoader($key, app()->make($loader['class']));
+        }
+    }
+
+    public function registerLoader(string $name, WorkflowLoaderContract $loader)
+    {
+        $this->loaders[$name] = $loader;
+    }
+
+    public function getLoaders(): array
+    {
+        return $this->loaders;
+    }
+
+    public function getLoader(string $name): WorkflowLoaderContract
+    {
+        if (! isset($this->loaders[$name])) {
+            throw new \Exception("Loader {$name} not found");
+        }
+
+        return $this->loaders[$name];
+    }
+
+    public function all(): array
+    {
+        if (count($this->loaders) === 0) {
+            return [];
+        }
+
+        $workflows = [];
+        foreach ($this->loaders as $name => $loader) {
+            foreach ($loader->all() as $workflow => $config) {
+                $workflows[$workflow] = $config;
+            }
+        }
+
+        return $workflows;
+    }
+}
diff --git a/src/WorkflowLoaderServiceProvider.php b/src/WorkflowLoaderServiceProvider.php
@@ -32,10 +32,14 @@ public function packageRegistered()
     {
         $this->app->when(\Soap\WorkflowLoader\DatabaseLoader::class)
             ->needs('$config')
-            ->give(config('workflow_loader.databaseLoader'));
+            ->give($this->app->make('config')->get('workflow_loader.loaders.database'));
 
-        $this->app->singleton('workflow-loader', function ($app) {
-            $workflowLoader = new WorkflowLoader($app->make(\Soap\WorkflowLoader\DatabaseLoader::class));
-        });
+        $this->app->when(\Soap\WorkflowLoader\WorkflowLoaderRegistry::class)
+            ->needs('$loaders')
+            ->give($this->app->make('config')->get('workflow_loader.loaders'));
+
+        $this->app->bind(\Soap\WorkflowLoader\Contracts\WorkflowDatabaseLoader::class, \Soap\WorkflowLoader\DatabaseLoader::class);
+
+        $this->app->singleton('workflowLoaderRegistry', \Soap\WorkflowLoader\WorkflowLoaderRegistry::class);
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -8,20 +8,23 @@`
`8`	`8`	`{`
`9`	`9`	`public function up()`
`10`	`10`	`{`
`11`		`- Schema::create('workflows', function (Blueprint $table) {`
	`11`	`+ $tableName = app(\Soap\WorkflowLoader\DatabaseLoader::class)->getWorkflowTableName();`
	`12`	`+ Schema::create($tableName, function (Blueprint $table) {`
`12`	`13`	`$table->id();`
`13`	`14`	`$table->string('name');`
`14`		`- $table->string('marking_store_attribute')->nullable()->comment('name of marking store attribute');`
	`15`	`+ $table->text('marking_store')->nullable()->comment('marking store as array');`
`15`	`16`	`$table->string('type')->default('workflow')->comment('workflow or state_machine');`
`16`	`17`	`$table->text('description')->nullable();`
`17`	`18`	`$table->json('supports')->nullable()->comment('support models');`
`18`	`19`	`$table->json('metadata')->nullable()->comment('metadata');`
	`20`	`+ $table->boolean('active')->default(true);`
`19`	`21`	`$table->timestamps();`
`20`	`22`	`});`
`21`	`23`	`}`
`22`	`24`
`23`	`25`	`public function down()`
`24`	`26`	`{`
`25`		`- Schema::dropIfExists('workflows');`
	`27`	`+ $tableName = app(\Soap\WorkflowLoader\DatabaseLoader::class)->getWorkflowTableName();`
	`28`	`+ Schema::dropIfExists($tableName);`
`26`	`29`	`}`
`27`	`30`	`};`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,8 @@`
`8`	`8`	`{`
`9`	`9`	`public function up()`
`10`	`10`	`{`
`11`		`- Schema::create('workflow_states', function (Blueprint $table) {`
	`11`	`+ $tableName = app(\Soap\WorkflowLoader\DatabaseLoader::class)->getWorkflowStateTableName();`
	`12`	`+ Schema::create($tableName, function (Blueprint $table) {`
`12`	`13`	`$table->id();`
`13`	`14`	`$table->string('name');`
`14`	`15`	`$table->tinyInteger('initial_state')->default(0)->comment('initial state');`
`@@ -21,6 +22,7 @@ public function up()`
`21`	`22`
`22`	`23`	`public function down()`
`23`	`24`	`{`
`24`		`- Schema::dropIfExists('workflow_states');`
	`25`	`+ $tableName = app(\Soap\WorkflowLoader\DatabaseLoader::class)->getWorkflowStateTableName();`
	`26`	`+ Schema::dropIfExists($tableName);`
`25`	`27`	`}`
`26`	`28`	`};`
Original file line number	Diff line number	Diff line change
`@@ -3,21 +3,17 @@`
`3`	`3`	`namespace App\Providers;`
`4`	`4`
`5`	`5`	`use Illuminate\Support\ServiceProvider;`
`6`		`-use Soap\WorkflowLoader\DatabaseLoader;`
`7`	`6`
`8`	`7`	`class WorkflowServiceProvider extends ServiceProvider`
`9`	`8`	`{`
`10`		`- public function register()`
`11`		`- {`
`12`		`-`
`13`		`- }`
	`9`	`+ public function register() {}`
`14`	`10`
`15`	`11`	`public function boot()`
`16`	`12`	`{`
`17`		`- $registy = app()->make('workflow');`
`18`		`- $workflowLoader = app()->make('workflow-loader');`
`19`		`- foreach ($wokflowLoader->all() as $workflow => $config) {`
`20`		`- $registy->addFromArray($workflow, $config);`
	`13`	`+ $registry = app()->make('workflow');`
	`14`	`+ $workflowLoaderRegistry = app()->make('workflowLoaderRegistry');`
	`15`	`+ foreach ($workflowLoaderRegistry->all() as $workflow => $config) {`
	`16`	`+ $registry->addFromArray($workflow, $config);`
`21`	`17`	`}`
`22`	`18`	`}`
`23`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,12 +14,15 @@ class DatabaseLoader implements WorkflowDatabaseLoader`
`14`	`14`	`*/`
`15`	`15`	`protected $config;`
`16`	`16`
`17`		`- public function __construct(?array $config)`
	`17`	`+ protected $repo;`
	`18`	`+`
	`19`	`+ public function __construct(?array $config, WorkflowRepository $repo)`
`18`	`20`	`{`
`19`	`21`	`if (! isset($config[self::KEY_TABLE_NAMES])) {`
`20`	`22`	`throw new \InvalidArgumentException('Table names not found in config');`
`21`	`23`	`}`
`22`	`24`	`$this->config = $config;`
	`25`	`+ $this->repo = $repo;`
`23`	`26`	`}`
`24`	`27`
`25`	`28`	`public function getTableNames(): array`
`@@ -54,15 +57,15 @@ public function getWorkflowStateTransitionTableName(): string`
`54`	`57`
`55`	`58`	`public function load(string $workflowName): array`
`56`	`59`	`{`
`57`		`- $repo = app()->make(WorkflowRepository::class);`
	`60`	`+ //$repo = app()->make(WorkflowRepository::class);`
`58`	`61`
`59`		`- return $repo->findByName($workflowName);`
	`62`	`+ return $this->repo->findByName($workflowName);`
`60`	`63`	`}`
`61`	`64`
`62`	`65`	`public function all(): array`
`63`	`66`	`{`
`64`		`- $repo = app()->make(WorkflowRepository::class);`
	`67`	`+ //$repo = app()->make(WorkflowRepository::class);`
`65`	`68`
`66`		`- return $repo->all();`
	`69`	`+ return $this->repo->all();`
`67`	`70`	`}`
`68`	`71`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,10 +7,10 @@`
`7`	`7`	`/**`
`8`	`8`	`* @see \Soap\WorkflowLoader\WorkflowLoader`
`9`	`9`	`*/`
`10`		`-class WorkflowLoader extends Facade`
	`10`	`+class WorkflowLoaderRegistry extends Facade`
`11`	`11`	`{`
`12`	`12`	`protected static function getFacadeAccessor(): string`
`13`	`13`	`{`
`14`		`- return \Soap\WorkflowLoader\WorkflowLoader::class;`
	`14`	`+ return 'workflowLoaderRegistry';`
`15`	`15`	`}`
`16`	`16`	`}`