bug symfony#21271 [Workflow] Added new validator to make sure each place has unique translation names (Nyholm)

This PR was submitted for the master branch but it was merged into the 3.2 branch instead (closes symfony#21271).

Discussion
----------

[Workflow] Added new validator to make sure each place has unique translation names

| Q             | A
| ------------- | ---
| Branch?       | 3.2
| Bug fix?      | yes
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets |
| License       | MIT
| Doc PR        | n/a

A definition where a place that has transitions with the same name is an invalid definition.

```yaml
invalid1:
  places: ['a', 'b', 'c']
  transitions:
    t1:
      from: a
      to: b
    t1:
      from: a
      to: c

valid1:
  places: ['a', 'b', 'c']
  transitions:
    t1:
      from: a
      to: b
    t2:
      from: a
      to: c

valid2:
  places: ['a', 'b', 'c']
  transitions:
    t1:
      from: a
      to: b
    t1:
      from: b
      to: c

valid3:
  places: ['a', 'b', 'c', 'd']
  transitions:
    t1:
      from: ['a', 'b']
      to: d
    t2:
      from: ['a', 'b']
      to: c
```

FYI @lyrixx

Commits
-------

eece8ad [Workflow] Added new validator to make sure each place has unique translation names

Author: fabpot

src/Symfony/Component/Workflow/Tests/Validator/WorkflowValidatorTest.php

@@ -2,7 +2,9 @@
 
 namespace Symfony\Component\Workflow\Tests\Validator;
 
+use Symfony\Component\Workflow\Definition;
 use Symfony\Component\Workflow\Tests\WorkflowBuilderTrait;
+use Symfony\Component\Workflow\Transition;
 use Symfony\Component\Workflow\Validator\WorkflowValidator;
 
 class WorkflowValidatorTest extends \PHPUnit_Framework_TestCase
@@ -26,4 +28,36 @@ public function testSinglePlaceWorkflowValidatorAndSimpleWorkflow()
 
         (new WorkflowValidator(true))->validate($definition, 'foo');
     }
+
+    /**
+     * @expectedException \Symfony\Component\Workflow\Exception\InvalidDefinitionException
+     * @expectedExceptionMessage All transitions for a place must have an unique name. Multiple transitions named "t1" where found for place "a" in workflow "foo".
+     */
+    public function testWorkflowWithInvalidNames()
+    {
+        $places = range('a', 'c');
+
+        $transitions = array();
+        $transitions[] = new Transition('t0', 'c', 'b');
+        $transitions[] = new Transition('t1', 'a', 'b');
+        $transitions[] = new Transition('t1', 'a', 'c');
+
+        $definition = new Definition($places, $transitions);
+
+        (new WorkflowValidator())->validate($definition, 'foo');
+    }
+
+    public function testSameTransitionNameButNotSamePlace()
+    {
+        $places = range('a', 'd');
+
+        $transitions = array();
+        $transitions[] = new Transition('t1', 'a', 'b');
+        $transitions[] = new Transition('t1', 'b', 'c');
+        $transitions[] = new Transition('t1', 'd', 'c');
+
+        $definition = new Definition($places, $transitions);
+
+        (new WorkflowValidator())->validate($definition, 'foo');
+    }
 }

src/Symfony/Component/Workflow/Validator/WorkflowValidator.php

@@ -31,6 +31,17 @@ public function __construct($singlePlace = false)
 
     public function validate(Definition $definition, $name)
     {
+        // Make sure all transitions for one place has unique name.
+        $places = array_fill_keys($definition->getPlaces(), array());
+        foreach ($definition->getTransitions() as $transition) {
+            foreach ($transition->getFroms() as $from) {
+                if (in_array($transition->getName(), $places[$from])) {
+                    throw new InvalidDefinitionException(sprintf('All transitions for a place must have an unique name. Multiple transitions named "%s" where found for place "%s" in workflow "%s".', $transition->getName(), $from, $name));
+                }
+                $places[$from][] = $transition->getName();
+            }
+        }
+
         if (!$this->singlePlace) {
             return;
         }