[Workflow] Changed initial_places to initial_marking, added property …

…instead of type
symfony · fabpot · Apr 6, 2019 · Mar 23, 2019 · Apr 6, 2019 · Apr 6, 2019
commit 73708a61b6af18f41b8a398645c31e7ca688205c
diff --git a/UPGRADE-4.3.md b/UPGRADE-4.3.md
@@ -166,11 +166,6 @@ Workflow
               initial_places: [draft]
    ```
 
-Yaml
-----
-
- * Using a mapping inside a multi-line string is deprecated and will throw a `ParseException` in 5.0.
-
 Workflow
 --------
 
@@ -202,19 +197,22 @@ Workflow
    ```yaml
    framework:
        workflows:
+           type: workflow
            article:
                marking_store:
                    type: multiple
+                   arguments: states
    ```
 
    After:
    ```yaml
    framework:
        workflows:
+           type: workflow
            article:
                marking_store:
                    type: method
-
+                   property: states
    ```
 
  * `SingleStateMarkingStore` is deprecated. Use `MethodMarkingStore` instead.
@@ -225,16 +223,21 @@ Workflow
        workflows:
            article:
                marking_store:
-                   type: single
+                   arguments: state
    ```
 
    After:
    ```yaml
    framework:
        workflows:
+           type: state_machine
            article:
                marking_store:
                    type: method
-                   arguments:
-                       - true
+                   property: state
    ```
+
+Yaml
+----
+
+ * Using a mapping inside a multi-line string is deprecated and will throw a `ParseException` in 5.0.
diff --git a/UPGRADE-5.0.md b/UPGRADE-5.0.md
@@ -388,8 +388,47 @@ Workflow
  * `ClassInstanceSupportStrategy` has been removed, use `InstanceOfSupportStrategy` instead.
  * `MarkingStoreInterface::setMarking()` has a third argument: `array $context = []`.
  * Removed support of `initial_place`. Use `initial_places` instead.
- * `MultipleStateMarkingStore` has been removed.
- * `SingleStateMarkingStore` has been removed.
+ * `MultipleStateMarkingStore` has been removed. Use `MethodMarkingStore` instead.
+
+   Before:
+   ```yaml
+   framework:
+       workflows:
+           type: workflow
+           article:
+               marking_store:
+                   type: multiple
+                   arguments: states
+   ```
+
+   After:
+   ```yaml
+   framework:
+       workflows:
+           type: workflow
+           article:
+               marking_store:
+                   property: states
+   ```
+ * `SingleStateMarkingStore` has been removed. Use `MethodMarkingStore` instead.
+
+   Before:
+   ```yaml
+   framework:
+       workflows:
+           article:
+               marking_store:
+                   arguments: state
+   ```
+
+   After:
+   ```yaml
+   framework:
+       workflows:
+           article:
+               marking_store:
+                   property: state
+   ```
 
 Yaml
 ----

diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
@@ -233,7 +233,7 @@ private function addWorkflowSection(ArrayNodeDefinition $rootNode)
                                     $workflows = [];
                                 }
 
-                                if (1 === \count($workflows) && isset($workflows['workflows']) && array_keys($workflows['workflows']) !== range(0, \count($workflows) - 1) && !empty(array_diff(array_keys($workflows['workflows']), ['audit_trail', 'type', 'marking_store', 'supports', 'support_strategy', 'initial_places', 'places', 'transitions']))) {
+                                if (1 === \count($workflows) && isset($workflows['workflows']) && array_keys($workflows['workflows']) !== range(0, \count($workflows) - 1) && !empty(array_diff(array_keys($workflows['workflows']), ['audit_trail', 'type', 'marking_store', 'supports', 'support_strategy', 'initial_marking', 'places', 'transitions']))) {
                                     $workflows = $workflows['workflows'];
                                 }
 
@@ -258,9 +258,17 @@ private function addWorkflowSection(ArrayNodeDefinition $rootNode)
                         ->arrayNode('workflows')
                             ->useAttributeAsKey('name')
                             ->prototype('array')
+                                ->beforeNormalization()
+                                    ->always(function ($v) {
+                                        if (isset($v['initial_place'])) {
+                                            $v['initial_marking'] = [$v['initial_place']];
+                                        }
+
+                                        return $v;
+                                    })
+                                ->end()
                                 ->fixXmlConfig('support')
                                 ->fixXmlConfig('place')
-                                ->fixXmlConfig('initial_place')
                                 ->fixXmlConfig('transition')
                                 ->children()
                                     ->arrayNode('audit_trail')
@@ -274,9 +282,11 @@ private function addWorkflowSection(ArrayNodeDefinition $rootNode)
                                         ->fixXmlConfig('argument')
                                         ->children()
                                             ->enumNode('type')
+                                                ->setDeprecated('The "%path%.%node%" configuration key has been deprecated in Symfony 4.3. Use "method" instead as it will be the only option in Symfony 5.0.')
                                                 ->values(['multiple_state', 'single_state', 'method'])
                                             ->end()
                                             ->arrayNode('arguments')
+                                                ->setDeprecated('The "%path%.%node%" configuration key has been deprecated in Symfony 4.3. Use "property" instead.')
                                                 ->beforeNormalization()
                                                     ->ifString()
                                                     ->then(function ($v) { return [$v]; })
@@ -285,6 +295,9 @@ private function addWorkflowSection(ArrayNodeDefinition $rootNode)
                                                 ->prototype('scalar')
                                                 ->end()
                                             ->end()
+                                            ->scalarNode('property')
+                                                ->defaultNull()
+                                            ->end()
                                             ->scalarNode('service')
                                                 ->cannotBeEmpty()
                                             ->end()
@@ -297,6 +310,10 @@ private function addWorkflowSection(ArrayNodeDefinition $rootNode)
                                             ->ifTrue(function ($v) { return !empty($v['arguments']) && isset($v['service']); })
                                             ->thenInvalid('"arguments" and "service" cannot be used together.')
                                         ->end()
+                                        ->validate()
+                                            ->ifTrue(function ($v) { return !empty($v['property']) && isset($v['service']); })
+                                            ->thenInvalid('"property" and "service" cannot be used together.')
+                                        ->end()
                                     ->end()
                                     ->arrayNode('supports')
                                         ->beforeNormalization()
@@ -315,10 +332,10 @@ private function addWorkflowSection(ArrayNodeDefinition $rootNode)
                                         ->cannotBeEmpty()
                                     ->end()
                                     ->scalarNode('initial_place')
-                                        ->setDeprecated('The "%path%.%node%" configuration key has been deprecated in Symfony 4.3, use the "initial_places" configuration key instead.')
+                                        ->setDeprecated('The "%path%.%node%" configuration key has been deprecated in Symfony 4.3, use the "initial_marking" configuration key instead.')
                                         ->defaultNull()
                                     ->end()
-                                    ->arrayNode('initial_places')
+                                    ->arrayNode('initial_marking')
                                         ->beforeNormalization()
                                             ->ifTrue(function ($v) { return !\is_array($v); })
                                             ->then(function ($v) { return [$v]; })

diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -631,14 +631,14 @@ private function registerWorkflowConfiguration(array $config, ContainerBuilder $
 
             // Create places
             $places = array_column($workflow['places'], 'name');
-            $initialPlaces = $workflow['initial_places'] ?? $workflow['initial_place'] ?? [];
+            $initialMarking = $workflow['initial_marking'] ?? $workflow['initial_place'] ?? [];
 
             // Create a Definition
             $definitionDefinition = new Definition(Workflow\Definition::class);
             $definitionDefinition->setPublic(false);
             $definitionDefinition->addArgument($places);
             $definitionDefinition->addArgument($transitions);
-            $definitionDefinition->addArgument($initialPlaces);
+            $definitionDefinition->addArgument($initialMarking);
             $definitionDefinition->addArgument($metadataStoreDefinition);
 
             // Create MarkingStore
@@ -647,6 +647,12 @@ private function registerWorkflowConfiguration(array $config, ContainerBuilder $
                 foreach ($workflow['marking_store']['arguments'] as $argument) {
                     $markingStoreDefinition->addArgument($argument);
                 }
+                if ('method' === $workflow['marking_store']['type']) {
+                    $markingStoreDefinition->setArguments([
+                        'state_machine' === $type, //single state
+                        $workflow['marking_store']['property'] ?? 'marking',
+                    ]);
+                }
             } elseif (isset($workflow['marking_store']['service'])) {
                 $markingStoreDefinition = new Reference($workflow['marking_store']['service']);
             }
@@ -686,7 +692,7 @@ private function registerWorkflowConfiguration(array $config, ContainerBuilder $
                     ->addTransitions(array_map(function (Reference $ref) use ($container): Workflow\Transition {
                         return $container->get((string) $ref);
                     }, $transitions))
-                    ->setInitialPlace($initialPlaces)
+                    ->setInitialPlace($initialMarking)
                     ->build()
                 ;
                 $validator->validate($realDefinition, $name);

diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd b/src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd
@@ -279,7 +279,7 @@
 
     <xsd:complexType name="workflow">
         <xsd:sequence>
-            <xsd:element name="initial-place" type="xsd:string" minOccurs="0" maxOccurs="unbounded" />
+            <xsd:element name="initial-marking" type="xsd:string" minOccurs="0" maxOccurs="unbounded" />
             <xsd:element name="marking-store" type="marking_store" minOccurs="0" maxOccurs="1" />
             <xsd:element name="support" type="xsd:string" minOccurs="0" maxOccurs="unbounded" />
             <xsd:element name="place" type="place" minOccurs="0" maxOccurs="unbounded" />
@@ -289,6 +289,7 @@
         <xsd:attribute name="name" type="xsd:string" />
         <xsd:attribute name="type" type="workflow_type" />
         <xsd:attribute name="initial-place" type="xsd:string" />
+        <xsd:attribute name="initial-marking" type="xsd:string" />
         <xsd:attribute name="support-strategy" type="xsd:string" />
         <xsd:attribute name="enabled" type="xsd:boolean" />
     </xsd:complexType>
@@ -304,12 +305,14 @@
         </xsd:sequence>
         <xsd:attribute name="type" type="marking_store_type" />
         <xsd:attribute name="service" type="xsd:string" />
+        <xsd:attribute name="property" type="xsd:string" />
     </xsd:complexType>
 
     <xsd:simpleType name="marking_store_type">
         <xsd:restriction base="xsd:string">
             <xsd:enumeration value="multiple_state" />
             <xsd:enumeration value="single_state" />
+            <xsd:enumeration value="method" />
         </xsd:restriction>
     </xsd:simpleType>
 

diff --git a/...Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/workflow-legacy.php b/...Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/workflow-legacy.php
@@ -1,7 +1,5 @@
 <?php
 
-use Symfony\Bundle\FrameworkBundle\Tests\DependencyInjection\FrameworkExtensionTest;
-
 $container->loadFromExtension('framework', [
     'workflows' => [
         'legacy' => [

diff --git a/...p/workflow_with_arguments_and_service.php → ...low_legacy_with_arguments_and_service.php b/...p/workflow_with_arguments_and_service.php → ...low_legacy_with_arguments_and_service.php
diff --git a/...es/php/workflow_with_type_and_service.php → ...workflow_legacy_with_type_and_service.php b/...es/php/workflow_with_type_and_service.php → ...workflow_legacy_with_type_and_service.php
@@ -6,7 +6,7 @@
     'workflows' => [
         'my_workflow' => [
             'marking_store' => [
-                'type' => 'multiple_state',
+                'type' => 'method',
                 'service' => 'workflow_service',
             ],
             'supports' => [

diff --git a/...FrameworkBundle/Tests/DependencyInjection/Fixtures/php/workflow_with_guard_expression.php b/...FrameworkBundle/Tests/DependencyInjection/Fixtures/php/workflow_with_guard_expression.php
@@ -6,13 +6,10 @@
     'workflows' => [
         'article' => [
             'type' => 'workflow',
-            'marking_store' => [
-                'type' => 'multiple_state',
-            ],
             'supports' => [
                 FrameworkExtensionTest::class,
             ],
-            'initial_places' => ['draft'],
+            'initial_marking' => ['draft'],
             'places' => [
                 'draft',
                 'wait_for_journalist',

diff --git a/...ts/DependencyInjection/Fixtures/php/workflow_with_multiple_transitions_with_same_name.php b/...ts/DependencyInjection/Fixtures/php/workflow_with_multiple_transitions_with_same_name.php
@@ -6,13 +6,10 @@
     'workflows' => [
         'article' => [
             'type' => 'workflow',
-            'marking_store' => [
-                'type' => 'multiple_state',
-            ],
             'supports' => [
                 FrameworkExtensionTest::class,
             ],
-            'initial_places' => ['draft'],
+            'initial_marking' => ['draft'],
             'places' => [
                 'draft',
                 'wait_for_journalist',

diff --git a/...eworkBundle/Tests/DependencyInjection/Fixtures/php/workflow_with_property_and_service.php b/...eworkBundle/Tests/DependencyInjection/Fixtures/php/workflow_with_property_and_service.php
@@ -0,0 +1,32 @@
+<?php
+
+use Symfony\Bundle\FrameworkBundle\Tests\DependencyInjection\FrameworkExtensionTest;
+
+$container->loadFromExtension('framework', [
+    'workflows' => [
+        'my_workflow' => [
+            'type' => 'workflow',
+            'marking_store' => [
+                'property' => 'states',
+                'service' => 'workflow_service',
+            ],
+            'supports' => [
+                FrameworkExtensionTest::class,
+            ],
+            'places' => [
+                'first',
+                'last',
+            ],
+            'transitions' => [
+                'go' => [
+                    'from' => [
+                        'first',
+                    ],
+                    'to' => [
+                        'last',
+                    ],
+                ],
+            ],
+        ],
+    ],
+]);
diff --git a/...dle/Tests/DependencyInjection/Fixtures/php/workflow_with_support_and_support_strategy.php b/...dle/Tests/DependencyInjection/Fixtures/php/workflow_with_support_and_support_strategy.php
@@ -5,9 +5,7 @@
 $container->loadFromExtension('framework', [
     'workflows' => [
         'my_workflow' => [
-            'marking_store' => [
-                'type' => 'multiple_state',
-            ],
+            'type' => 'workflow',
             'supports' => [
                 FrameworkExtensionTest::class,
             ],

diff --git a/.../Tests/DependencyInjection/Fixtures/php/workflow_without_support_and_support_strategy.php b/.../Tests/DependencyInjection/Fixtures/php/workflow_without_support_and_support_strategy.php
@@ -1,13 +1,9 @@
 <?php
 
-use Symfony\Bundle\FrameworkBundle\Tests\DependencyInjection\FrameworkExtensionTest;
-
 $container->loadFromExtension('framework', [
     'workflows' => [
         'my_workflow' => [
-            'marking_store' => [
-                'type' => 'multiple_state',
-            ],
+            'type' => 'workflow',
             'places' => [
                 'first',
                 'last',

diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/workflows.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/workflows.php
@@ -6,13 +6,10 @@
     'workflows' => [
         'article' => [
             'type' => 'workflow',
-            'marking_store' => [
-                'type' => 'multiple_state',
-            ],
             'supports' => [
                 FrameworkExtensionTest::class,
             ],
-            'initial_places' => ['draft'],
+            'initial_marking' => ['draft'],
             'places' => [
                 'draft',
                 'wait_for_journalist',
@@ -41,13 +38,10 @@
             ],
         ],
         'pull_request' => [
-            'marking_store' => [
-                'type' => 'single_state',
-            ],
             'supports' => [
                 FrameworkExtensionTest::class,
             ],
-            'initial_places' => ['start'],
+            'initial_marking' => 'start',
             'metadata' => [
                 'title' => 'workflow title',
             ],