minor symfony#26123 [Workflow] Drop nofooter option in PlantUmlDumper (dead code) (lyrixx)

This PR was merged into the 4.1-dev branch.

Discussion
----------

[Workflow] Drop nofooter option in PlantUmlDumper (dead code)

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

---

I also update the test suite: Dumping a worklow with a state machine
dumper does not make sense.

Commits
-------

9b94647 [Workflow] Drop nofooter option in PlantUmlDumper (dead code)

Author: fabpot

src/Symfony/Component/Workflow/Dumper/PlantUmlDumper.php

@@ -26,14 +26,6 @@
  */
 class PlantUmlDumper implements DumperInterface
 {
-    private const SYMFONY_LOGO = 'sprite $sf_logo [81x20/16z] {
-hPNRaYiX24K1xwBo_tyx6-qaCtDEJ-KXLYMTLbp0HWcHZr3KRDJ8z94HG3jZn4_mijbQ2ryJoFePtXLWA_qxyGy19DpdY_10z11ZAbGjFHRwcEbcKx5-wqsV
-yIMo8StMCHKh8ZUxnEwrZiwRAUOvy1lLcPQF4lEFAjhzMd5WOAqvKflS0Enx8PbihiSYXM8ClGVAseIWTAjCgVSAcnYbQG79xKFsZ0VnDCNc7AVBoPSMcTsX
-UnrujbYjjz0NnsObkTgnmolqJD4QgGUYTQiNe8eIjtx4b6Vv8nPGpncn3NJ8Geo9W9VW2wGACm_JzgIO8A8KXr2jUBCVGEAAJSZ6JUlsNnmOzmIYti9G7bjL
-8InaHM9G40NkwTG7OxrggvNIejA8AZuqyWjOzTIKi-wwYvjeHYesSWuPiTGDN5THzkYLU4MD5r2_0PDhG7LIUG33z5HtM6CP3icyWEVOS61sD_2ZsBfJdbVA
-qM53XHDUwhY0TAwPug3OG9NonRFhO8ynF3I4unuAMDHmSrXH57V1RGvl9jafuZF9ZhqjWOEh98y0tUYGsUxkBSllIyBdT2oM5Fn2-ut-fzsq_cQNuL6Uvwqr
-knh4RrvOKzxZfLV3s0rs_R_1SdYt3VxeQ1_y2_W2
-}';
     private const INITIAL = '<<initial>>';
     private const MARKED = '<<marked>>';
 
@@ -62,7 +54,7 @@ class PlantUmlDumper implements DumperInterface
 
     public function __construct(string $transitionType = null)
     {
-        if (!in_array($transitionType, self::TRANSITION_TYPES)) {
+        if (!\in_array($transitionType, self::TRANSITION_TYPES, true)) {
             throw new InvalidArgumentException("Transition type '$transitionType' does not exist.");
         }
         $this->transitionType = $transitionType;
@@ -121,21 +113,12 @@ private function startPuml(array $options): string
         $start = '@startuml'.PHP_EOL;
         $start .= 'allow_mixing'.PHP_EOL;
 
-        if ($options['nofooter'] ?? false) {
-            return $start;
-        }
-
-        return $start.self::SYMFONY_LOGO.PHP_EOL;
+        return $start;
     }
 
     private function endPuml(array $options): string
     {
-        $end = PHP_EOL.'@enduml';
-        if ($options['nofooter'] ?? false) {
-            return $end;
-        }
-
-        return PHP_EOL.'footer \nGenerated by <$sf_logo> **Workflow Component** and **PlantUML**'.$end;
+        return PHP_EOL.'@enduml';
     }
 
     private function getLines(array $code): string

src/Symfony/Component/Workflow/Tests/Dumper/PlantUmlDumperTest.php

@@ -11,7 +11,6 @@
 namespace Symfony\Component\Workflow\Tests\Dumper;
 
 use PHPUnit\Framework\TestCase;
-use Symfony\Component\Workflow\Dumper\DumperInterface;
 use Symfony\Component\Workflow\Dumper\PlantUmlDumper;
 use Symfony\Component\Workflow\Marking;
 use Symfony\Component\Workflow\Tests\WorkflowBuilderTrait;
@@ -21,73 +20,46 @@ class PlantUmlDumperTest extends TestCase
     use WorkflowBuilderTrait;
 
     /**
-     * @var DumperInterface[]
+     * @dataProvider provideWorkflowDefinitionWithoutMarking
      */
-    private $dumpers;
-
-    protected function setUp()
+    public function testDumpWorkflowWithoutMarking($definition, $marking, $expectedFileName, $title)
     {
-        $this->dumpers =
-            array(
-                PlantUmlDumper::STATEMACHINE_TRANSITION => new PlantUmlDumper(PlantUmlDumper::STATEMACHINE_TRANSITION),
-                PlantUmlDumper::WORKFLOW_TRANSITION => new PlantUmlDumper(PlantUmlDumper::WORKFLOW_TRANSITION),
-            );
+        $dumper = new PlantUmlDumper(PlantUmlDumper::WORKFLOW_TRANSITION);
+        $dump = $dumper->dump($definition, $marking, array('title' => $title));
+        // handle windows, and avoid to create more fixtures
+        $dump = str_replace(PHP_EOL, "\n", $dump.PHP_EOL);
+        $file = $this->getFixturePath($expectedFileName, PlantUmlDumper::WORKFLOW_TRANSITION);
+        $this->assertStringEqualsFile($file, $dump);
     }
 
-    /**
-     * @dataProvider provideWorkflowDefinitionWithoutMarking
-     */
-    public function testDumpWithoutMarking($definition, $expectedFileName, $title, $nofooter)
+    public function provideWorkflowDefinitionWithoutMarking()
     {
-        foreach ($this->dumpers as $transitionType => $dumper) {
-            $dump = $dumper->dump($definition, null, array('title' => $title, 'nofooter' => $nofooter));
-            // handle windows, and avoid to create more fixtures
-            $dump = str_replace(PHP_EOL, "\n", $dump.PHP_EOL);
-            $this->assertStringEqualsFile($this->getFixturePath($expectedFileName, $transitionType), $dump);
-        }
+        yield array($this->createSimpleWorkflowDefinition(), null, 'simple-workflow-nomarking', 'SimpleDiagram');
+        yield array($this->createComplexWorkflowDefinition(), null, 'complex-workflow-nomarking', 'ComplexDiagram');
+        $marking = new Marking(array('b' => 1));
+        yield array($this->createSimpleWorkflowDefinition(), $marking, 'simple-workflow-marking', 'SimpleDiagram');
+        $marking = new Marking(array('c' => 1, 'e' => 1));
+        yield array($this->createComplexWorkflowDefinition(), $marking, 'complex-workflow-marking', 'ComplexDiagram');
     }
 
     /**
-     * @dataProvider provideWorkflowDefinitionWithMarking
+     * @dataProvider provideStateMachineDefinitionWithoutMarking
      */
-    public function testDumpWithMarking($definition, $marking, $expectedFileName, $title, $footer)
-    {
-        foreach ($this->dumpers as $transitionType => $dumper) {
-            $dump = $dumper->dump($definition, $marking, array('title' => $title, 'nofooter' => $footer));
-            // handle windows, and avoid to create more fixtures
-            $dump = str_replace(PHP_EOL, "\n", $dump.PHP_EOL);
-            $this->assertStringEqualsFile($this->getFixturePath($expectedFileName, $transitionType), $dump);
-        }
-    }
-
-    public function provideWorkflowDefinitionWithoutMarking()
+    public function testDumpStateMachineWithoutMarking($definition, $marking, $expectedFileName, $title)
     {
-        $title = 'SimpleDiagram';
-        yield array($this->createSimpleWorkflowDefinition(), 'simple-workflow-nomarking-nofooter', $title, true);
-        yield array($this->createSimpleWorkflowDefinition(), 'simple-workflow-nomarking', $title, false);
-        $title = 'ComplexDiagram';
-        yield array($this->createComplexWorkflowDefinition(), 'complex-workflow-nomarking-nofooter', $title, true);
-        yield array($this->createComplexWorkflowDefinition(), 'complex-workflow-nomarking', $title, false);
+        $dumper = new PlantUmlDumper(PlantUmlDumper::STATEMACHINE_TRANSITION);
+        $dump = $dumper->dump($definition, $marking, array('title' => $title));
+        // handle windows, and avoid to create more fixtures
+        $dump = str_replace(PHP_EOL, "\n", $dump.PHP_EOL);
+        $file = $this->getFixturePath($expectedFileName, PlantUmlDumper::STATEMACHINE_TRANSITION);
+        $this->assertStringEqualsFile($file, $dump);
     }
 
-    public function provideWorkflowDefinitionWithMarking()
+    public function provideStateMachineDefinitionWithoutMarking()
     {
-        $title = 'SimpleDiagram';
-        $marking = new Marking(array('b' => 1));
-        yield array(
-            $this->createSimpleWorkflowDefinition(), $marking, 'simple-workflow-marking-nofooter', $title, true,
-        );
-        yield array(
-            $this->createSimpleWorkflowDefinition(), $marking, 'simple-workflow-marking', $title, false,
-        );
-        $title = 'ComplexDiagram';
+        yield array($this->createComplexStateMachineDefinition(), null, 'complex-state-machine-nomarking', 'SimpleDiagram');
         $marking = new Marking(array('c' => 1, 'e' => 1));
-        yield array(
-            $this->createComplexWorkflowDefinition(), $marking, 'complex-workflow-marking-nofooter', $title, true,
-        );
-        yield array(
-            $this->createComplexWorkflowDefinition(), $marking, 'complex-workflow-marking', $title, false,
-        );
+        yield array($this->createComplexStateMachineDefinition(), $marking, 'complex-state-machine-marking', 'SimpleDiagram');
     }
 
     private function getFixturePath($name, $transitionType)

src/Symfony/Component/Workflow/Tests/fixtures/puml/arrow/simple-workflow-marking-nofooter.puml renamed to src/Symfony/Component/Workflow/Tests/fixtures/puml/arrow/complex-state-machine-marking.puml

@@ -11,8 +11,11 @@ skinparam state {
     FontColor<<marked>> White
 }
 state "a" <<initial>>
-state "b" <<marked>>
-state "c"
+state "b"
+state "c" <<marked>>
+state "d"
 "a" --> "b": "t1"
+"d" --> "b": "t1"
 "b" --> "c": "t2"
+"b" --> "d": "t3"
 @enduml

src/Symfony/Component/Workflow/Tests/fixtures/puml/arrow/simple-workflow-nomarking-nofooter.puml renamed to src/Symfony/Component/Workflow/Tests/fixtures/puml/arrow/complex-state-machine-nomarking.puml

@@ -13,6 +13,9 @@ skinparam state {
 state "a" <<initial>>
 state "b"
 state "c"
+state "d"
 "a" --> "b": "t1"
+"d" --> "b": "t1"
 "b" --> "c": "t2"
+"b" --> "d": "t3"
 @enduml