Merge pull request #18 from zerodahero/3.x

3.x is now primary branch

Author: zerodahero

.travis.yml

@@ -3,6 +3,7 @@ language: php
 php:
   - 7.2
   - 7.3
+  - 7.4
 before_install:
   - sudo apt-get update -q
   - sudo apt-get autoremove graphviz -y

README.md

@@ -4,12 +4,21 @@ This is a fork from [brexis/laravel-workflow](https://github.com/brexis/laravel-
 
 Use the Symfony Workflow component in Laravel
 
-### Installation
+## Installation
 
     composer require zerodahero/laravel-workflow
 
-#### Right now, I've bumped the dependencies up to active PHP version (>=7.2), so in Laravel >= 5.5, use the package auto-discovery
-#### For laravel <= 5.4 (Deprecated)
+## Upgrade from v2 to v3
+
+The biggest changes from v2 to v3 are the dependencies. To match the Symfony v5 components, the Laravel version is raised to v7. If you're on Laravel v6 or earlier, you should continue to use the v2 releases of this package.
+
+To match the changes in the Symfony v5 workflow component, the "arguments" config option has been changed to "property". This describes the property on the model the workflow ties to (in most circumstances, you can simply change the key name from "arguments" to "property", and set to a string instead of the previous array).
+
+Also, the "initial_place" key has been changed to "initial_places" to align with the Symfony component as well.
+
+### Non-package Discovery
+
+If you aren't using package discovery:
 
 Add a ServiceProvider to your providers array in `config/app.php`:
 
@@ -31,7 +40,7 @@ Add the `Workflow` facade to your facades array:
     'Workflow' => ZeroDaHero\LaravelWorkflow\Facades\WorkflowFacade::class,
 ```
 
-### Configuration
+## Configuration
 
 Publish the config file
 
@@ -45,26 +54,27 @@ Configure your workflow in `config/workflow.php`
 <?php
 
 return [
-    'straight'   => [
-        'type'          => 'workflow', // or 'state_machine'
+    'straight' => [
+        'type' => 'workflow', // or 'state_machine'
         'marking_store' => [
-            'type'      => 'multiple_state',
-            'arguments' => ['currentPlace']
+            'type' => 'multiple_state', // or 'single_state'
+            'property' => 'currentPlace', // this is the property on the model
+            'class' => MethodMarkingStore::class, // you may omit for default, or set to override marking store class
         ],
-        'supports'      => ['App\BlogPost'],
-        'places'        => ['draft', 'review', 'rejected', 'published'],
-        'transitions'   => [
+        'supports' => ['App\BlogPost'],
+        'places' => ['draft', 'review', 'rejected', 'published'],
+        'transitions' => [
             'to_review' => [
                 'from' => 'draft',
-                'to'   => 'review'
+                'to' => 'review'
             ],
             'publish' => [
                 'from' => 'review',
-                'to'   => 'published'
+                'to' => 'published'
             ],
             'reject' => [
                 'from' => 'review',
-                'to'   => 'rejected'
+                'to' => 'rejected'
             ]
         ],
     ]
@@ -80,18 +90,18 @@ You may also add in metadata, similar to the Symfony implementation (note: it is
 <?php
 
 return [
-    'straight'   => [
-        'type'          => 'workflow', // or 'state_machine'
-        'metadata'      => [
+    'straight' => [
+        'type' => 'workflow', // or 'state_machine'
+        'metadata' => [
             'title' => 'Blog Publishing Workflow',
         ],
         'marking_store' => [
-            'type'      => 'multiple_state',
-            'arguments' => ['currentPlace']
+            'type' => 'multiple_state', // or 'single_state'
+            'property' => 'currentPlace' // this is the property on the model
         ],
-        'supports'      => ['App\BlogPost'],
-        'places'        => [
-            'draft', => [
+        'supports' => ['App\BlogPost'],
+        'places' => [
+            'draft' => [
                 'metadata' => [
                     'max_num_of_words' => 500,
                 ]
@@ -100,21 +110,21 @@ return [
             'rejected',
             'published'
         ],
-        'transitions'   => [
+        'transitions' => [
             'to_review' => [
                 'from' => 'draft',
-                'to'   => 'review',
+                'to' => 'review',
                 'metadata' => [
                     'priority' => 0.5,
                 ]
             ],
             'publish' => [
                 'from' => 'review',
-                'to'   => 'published'
+                'to' => 'published'
             ],
             'reject' => [
                 'from' => 'review',
-                'to'   => 'rejected'
+                'to' => 'rejected'
             ]
         ],
     ]
@@ -137,7 +147,7 @@ class BlogPost extends Model
 
 }
 ```
-### Usage
+## Usage
 
 ```php
 <?php
@@ -178,8 +188,8 @@ $post->workflow_apply('publish');
 $post->save();
 ```
 
-### Symfony Workflow Usage
-Once you have the underlying Symfony workflow component, you can do anything you want, just like you would in Symfony. A couple examples are provided below, but be sure to take a look at the [Symfony docs](https://symfony.com/doc/current/workflow.html) to better understand what's going on here. 
+## Symfony Workflow Usage
+Once you have the underlying Symfony workflow component, you can do anything you want, just like you would in Symfony. A couple examples are provided below, but be sure to take a look at the [Symfony docs](https://symfony.com/doc/current/workflow.html) to better understand what's going on here.
 
 ```php
 <?php
@@ -328,7 +338,7 @@ class BlogPostWorkflowSubscriber
         $events->listen(
             'workflow.straight.guard',
             'App\Listeners\BlogPostWorkflowSubscriber@onGuard'
-        );        
+        );
 
         // workflow.leave
         // workflow.[workflow name].leave
@@ -381,7 +391,7 @@ class BlogPostWorkflowSubscriber
 }
 ```
 
-### Dump Workflows
+## Dump Workflows
 Symfony workflow uses GraphvizDumper to create the workflow image. You may need to install the `dot` command of [Graphviz](http://www.graphviz.org/)
 
     php artisan workflow:dump workflow_name --class App\\BlogPost
@@ -390,7 +400,7 @@ You can change the image format with the `--format` option. By default the forma
 
     php artisan workflow:dump workflow_name --format=jpg
 
-### Use in tracking mode
+## Use in tracking mode
 
 If you are loading workflow definitions through some dynamic means (perhaps via DB), you'll most likely want to turn on registry tracking. This will enable you to see what has been loaded, to prevent or ignore duplicate workflow definitions.
 
@@ -410,7 +420,7 @@ return [
 
     /**
      * Only used when track_loaded = true
-     * 
+     *
      * When set to true, a registering a duplicate workflow will be ignored (will not load the new definition)
      * When set to false, a duplicate workflow will throw a DuplicateWorkflowException
      */
@@ -443,27 +453,27 @@ You can dynamically load a workflow by using the `addFromArray` method on the wo
         try {
             $registry->addFromArray($workflowName, $workflowDefinition);
         } catch (DuplicateWorkflowException $e) {
-            // already loaded 
+            // already loaded
         }
     }
 ```
 
-You may also specify an `initial_place` in your workflow definition, if it is not the first place in the "places" list.
+You may also specify an `initial_places` in your workflow definition, if it is not the first place in the "places" list.
 
 ```php
 <?php
 
 return [
-    'type'          => 'workflow', // or 'state_machine'
-    'metadata'      => [
+    'type' => 'workflow', // or 'state_machine'
+    'metadata' => [
         'title' => 'Blog Publishing Workflow',
     ],
     'marking_store' => [
-        'type'      => 'multiple_state',
-        'arguments' => ['currentPlace']
+        'type' => 'multiple_state',
+        'property' => 'currentPlace'
     ],
-    'supports'      => ['App\BlogPost'],
-    'places'        => [
+    'supports' => ['App\BlogPost'],
+    'places' => [
         'review',
         'rejected',
         'published',
@@ -473,22 +483,22 @@ return [
             ]
         ]
     ],
-    'initial_place' => 'draft',
-    'transitions'   => [
+    'initial_places' => 'draft', // or set to an array if multiple initial places
+    'transitions' => [
         'to_review' => [
             'from' => 'draft',
-            'to'   => 'review',
+            'to' => 'review',
             'metadata' => [
                 'priority' => 0.5,
             ]
         ],
         'publish' => [
             'from' => 'review',
-            'to'   => 'published'
+            'to' => 'published'
         ],
         'reject' => [
             'from' => 'review',
-            'to'   => 'rejected'
+            'to' => 'rejected'
         ]
     ],
 ];

composer.json

@@ -1,15 +1,16 @@
 {
     "name": "zerodahero/laravel-workflow",
     "description": "Integerate Symfony Workflow component into Laravel.",
-    "keywords": ["workflow", "symfony", "laravel", "laravel5"],
+    "keywords": ["workflow", "symfony", "laravel", "laravel7"],
     "license": "MIT",
     "require": {
         "php": ">=7.2",
-        "symfony/workflow": "^4.2.9",
-        "symfony/process": "^4.2",
-        "symfony/event-dispatcher": "^4.2",
-        "illuminate/console": "5.5.* || 5.6.* || 5.7.* || 5.8.* || ^6.0",
-        "illuminate/support": "5.5.* || 5.6.* || 5.7.* || 5.8.* || ^6.0"
+        "symfony/workflow": "^5.0",
+        "symfony/process": "^5.0",
+        "symfony/event-dispatcher": "^5.0",
+        "illuminate/console": "^7.0",
+        "illuminate/support": "^7.0",
+        "illuminate/contracts": "^7.0"
     },
     "autoload": {
         "psr-4": {
@@ -23,7 +24,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "1.0-dev"
+            "dev-master": "3.x-dev"
         },
         "laravel": {
             "providers": [
@@ -36,6 +37,8 @@
     },
     "require-dev": {
         "mockery/mockery": "^1.2",
-        "phpunit/phpunit": "^8.0"
+        "phpunit/phpunit": "^8.0",
+        "symfony/var-dumper": "^5.0",
+        "fzaninotto/faker": "^1.9"
     }
 }

phpcs.xml

@@ -1,8 +1,8 @@
 <?xml version="1.0"?>
 <ruleset name="custom">
-	<description>PSR2</description>
+	<description>PSR12</description>
 
-	<rule ref="PSR2" />
+	<rule ref="PSR12" />
 
     <file>src/</file>
 
@@ -14,27 +14,6 @@
         <exclude name="Generic.Commenting.DocComment.NonParamGroup" />
         <exclude name="Generic.Commenting.DocComment.MissingShort" />
     </rule>
-
-    <rule ref="Squiz.Commenting.BlockComment">
-        <exclude name="Squiz.Commenting.BlockComment.NoEmptyLineAfter" />
-    </rule>
-    <rule ref="Squiz.Commenting.DocCommentAlignment"/>
-    <!-- <rule ref="Squiz.Commenting.EmptyCatchComment"/> -->
-    <!-- <rule ref="Squiz.Commenting.InlineComment"/> -->
-    <!-- <rule ref="Squiz.Commenting.LongConditionClosingComment"/> -->
-    <rule ref="Squiz.Commenting.FunctionComment">
-        <exclude name="Squiz.Commenting.FunctionComment.MissingParamComment" />
-        <exclude name="Squiz.Commenting.FunctionComment.ScalarTypeHintMissing" />
-        <exclude name="Squiz.Commenting.FunctionComment.ParamCommentNotCapital" />
-        <exclude name="Squiz.Commenting.FunctionComment.ParamCommentFullStop" />
-        <exclude name="Squiz.Commenting.FunctionComment.TypeHintMissing" />
-        <exclude name="Squiz.Commenting.FunctionComment.EmptyThrows" />
-        <exclude name="Squiz.Commenting.FunctionComment.SpacingAfterParamName" />
-        <exclude name="Squiz.Commenting.FunctionComment.SpacingAfterParamType" />
-    </rule>
-    <rule ref="Squiz.Commenting.PostStatementComment"/>
-    <rule ref="Squiz.Commenting.VariableComment">
-        <exclude name="Squiz.Commenting.VariableComment.Missing" />
-    </rule>
+    <exclude name="Squiz.Commenting" />
 
 </ruleset>

src/Commands/WorkflowDumpCommand.php

@@ -40,27 +40,27 @@ class WorkflowDumpCommand extends Command
      */
     public function handle()
     {
-        $workflowName   = $this->argument('workflow');
-        $format         = $this->option('format');
-        $class          = $this->option('class');
-        $config         = Config::get('workflow');
+        $workflowName = $this->argument('workflow');
+        $format = $this->option('format');
+        $class = $this->option('class');
+        $config = Config::get('workflow');
 
         if (!isset($config[$workflowName])) {
             throw new Exception("Workflow $workflowName is not configured.");
         }
 
         if (false === array_search($class, $config[$workflowName]['supports'])) {
-            throw new Exception("Workflow $workflowName has no support for class $class.".
-            ' Please specify a valid support class with the --class option.');
+            throw new Exception("Workflow $workflowName has no support for class $class." .
+                ' Please specify a valid support class with the --class option.');
         }
 
-        $subject    = new $class;
-        $workflow   = Workflow::get($subject, $workflowName);
+        $subject = new $class();
+        $workflow = Workflow::get($subject, $workflowName);
         $definition = $workflow->getDefinition();
 
         $dumper = new GraphvizDumper();
 
-        $dotCommand = "dot -T$format -o $workflowName.$format";
+        $dotCommand = ['dot', "-T$format", '-o', "$workflowName.$format"];
 
         $process = new Process($dotCommand);
         $process->setInput($dumper->dump($definition));