[Workflow] Adding more return types

guillaumeVDP · nicolas-grekas · commit ea55e454fe86 · 2023-04-20T17:06:44.000+02:00
diff --git a/Event/Event.php b/Event/Event.php
@@ -75,6 +75,9 @@ public function getWorkflowName()
         return $this->workflow->getName();
     }
 
+    /**
+     * @return mixed
+     */
     public function getMetadata(string $key, string|Transition|null $subject)
     {
         return $this->workflow->getMetadataStore()->getMetadata($key, $subject);
diff --git a/MarkingStore/MarkingStoreInterface.php b/MarkingStore/MarkingStoreInterface.php
@@ -31,6 +31,8 @@ public function getMarking(object $subject): Marking;
 
     /**
      * Sets a Marking to a subject.
+     *
+     * @return void
      */
     public function setMarking(object $subject, Marking $marking, array $context = []);
 }
diff --git a/Metadata/GetMetadataTrait.php b/Metadata/GetMetadataTrait.php
@@ -18,6 +18,9 @@
  */
 trait GetMetadataTrait
 {
+    /**
+     * @return mixed
+     */
     public function getMetadata(string $key, string|Transition $subject = null)
     {
         if (null === $subject) {
diff --git a/Metadata/MetadataStoreInterface.php b/Metadata/MetadataStoreInterface.php
@@ -34,6 +34,8 @@ public function getTransitionMetadata(Transition $transition): array;
      * @param string|Transition|null $subject Use null to get workflow metadata
      *                                        Use a string (the place name) to get place metadata
      *                                        Use a Transition instance to get transition metadata
+     *
+     * @return mixed
      */
     public function getMetadata(string $key, string|Transition $subject = null);
 }
diff --git a/Tests/Dumper/GraphvizDumperTest.php b/Tests/Dumper/GraphvizDumperTest.php
@@ -47,7 +47,7 @@ public function testDumpWithMarking($definition, $marking, $expected)
         $this->assertEquals($expected, $dump);
     }
 
-    public static function provideWorkflowDefinitionWithMarking()
+    public static function provideWorkflowDefinitionWithMarking(): \Generator
     {
         yield [
             self::createComplexWorkflowDefinition(),
@@ -62,13 +62,13 @@ public static function provideWorkflowDefinitionWithMarking()
         ];
     }
 
-    public static function provideWorkflowDefinitionWithoutMarking()
+    public static function provideWorkflowDefinitionWithoutMarking(): \Generator
     {
         yield [self::createComplexWorkflowDefinition(), self::provideComplexWorkflowDumpWithoutMarking()];
         yield [self::createSimpleWorkflowDefinition(), self::provideSimpleWorkflowDumpWithoutMarking()];
     }
 
-    public static function createComplexWorkflowDefinitionDumpWithMarking()
+    public static function createComplexWorkflowDefinitionDumpWithMarking(): string
     {
         return 'digraph workflow {
   ratio="compress" rankdir="LR"
@@ -106,7 +106,7 @@ public static function createComplexWorkflowDefinitionDumpWithMarking()
 ';
     }
 
-    public static function createSimpleWorkflowDumpWithMarking()
+    public static function createSimpleWorkflowDumpWithMarking(): string
     {
         return 'digraph workflow {
   ratio="compress" rankdir="LR"
@@ -126,7 +126,7 @@ public static function createSimpleWorkflowDumpWithMarking()
 ';
     }
 
-    public static function provideComplexWorkflowDumpWithoutMarking()
+    public static function provideComplexWorkflowDumpWithoutMarking(): string
     {
         return 'digraph workflow {
   ratio="compress" rankdir="LR"
@@ -164,7 +164,7 @@ public static function provideComplexWorkflowDumpWithoutMarking()
 ';
     }
 
-    public static function provideSimpleWorkflowDumpWithoutMarking()
+    public static function provideSimpleWorkflowDumpWithoutMarking(): string
     {
         return 'digraph workflow {
   ratio="compress" rankdir="LR"
diff --git a/Tests/Dumper/MermaidDumperTest.php b/Tests/Dumper/MermaidDumperTest.php
@@ -146,7 +146,7 @@ public static function provideWorkflowDefinitionWithoutMarking(): array
         ];
     }
 
-    public static function provideWorkflowWithReservedWords()
+    public static function provideWorkflowWithReservedWords(): array
     {
         $builder = new DefinitionBuilder();
 
diff --git a/Tests/Dumper/PlantUmlDumperTest.php b/Tests/Dumper/PlantUmlDumperTest.php
@@ -36,7 +36,7 @@ public function testDumpWorkflowWithoutMarking($definition, $marking, $expectedF
         $this->assertStringEqualsFile($file, $dump);
     }
 
-    public static function provideWorkflowDefinitionWithoutMarking()
+    public static function provideWorkflowDefinitionWithoutMarking(): \Generator
     {
         yield [self::createSimpleWorkflowDefinition(), null, 'simple-workflow-nomarking', 'SimpleDiagram'];
         yield [self::createComplexWorkflowDefinition(), null, 'complex-workflow-nomarking', 'ComplexDiagram'];
@@ -59,7 +59,7 @@ public function testDumpStateMachineWithoutMarking($definition, $marking, $expec
         $this->assertStringEqualsFile($file, $dump);
     }
 
-    public static function provideStateMachineDefinitionWithoutMarking()
+    public static function provideStateMachineDefinitionWithoutMarking(): \Generator
     {
         yield [static::createComplexStateMachineDefinition(), null, 'complex-state-machine-nomarking', 'SimpleDiagram'];
         $marking = new Marking(['c' => 1, 'e' => 1]);
@@ -94,7 +94,7 @@ public function testDumpWorkflowWithSpacesInTheStateNamesAndDescription()
         $this->assertStringEqualsFile($file, $dump);
     }
 
-    private function getFixturePath($name, $transitionType)
+    private function getFixturePath($name, $transitionType): string
     {
         return __DIR__.'/../fixtures/puml/'.$transitionType.'/'.$name.'.puml';
     }
diff --git a/Tests/EventListener/GuardListenerTest.php b/Tests/EventListener/GuardListenerTest.php
@@ -143,7 +143,7 @@ public function testGuardExpressionBlocks()
         $this->assertTrue($event->isBlocked());
     }
 
-    private function createEvent(Transition $transition = null)
+    private function createEvent(Transition $transition = null): GuardEvent
     {
         $subject = new Subject();
         $transition ??= new Transition('name', 'from', 'to');
@@ -171,7 +171,7 @@ private function configureAuthenticationChecker($isUsed, $granted = true)
         ;
     }
 
-    private function configureValidator($isUsed, $valid = true)
+    private function configureValidator($isUsed, $valid = true): void
     {
         if (!$isUsed) {
             $this->validator
diff --git a/Tests/MarkingStore/MethodMarkingStoreTest.php b/Tests/MarkingStore/MethodMarkingStoreTest.php
@@ -111,7 +111,7 @@ public function testGetMarkingWithUninitializedProperty2()
         $markingStore->getMarking($subject);
     }
 
-    private function createValueObject(string $markingValue)
+    private function createValueObject(string $markingValue): object
     {
         return new class($markingValue) {
             /** @var string */
diff --git a/Tests/RegistryTest.php b/Tests/RegistryTest.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Workflow\Tests;
 
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Workflow\Definition;
 use Symfony\Component\Workflow\Exception\InvalidArgumentException;
@@ -108,7 +109,7 @@ public function testAllWithNoMatch()
         $this->assertCount(0, $workflows);
     }
 
-    private function createWorkflowSupportStrategy($supportedClassName)
+    private function createWorkflowSupportStrategy($supportedClassName): MockObject&WorkflowSupportStrategyInterface
     {
         $strategy = $this->createMock(WorkflowSupportStrategyInterface::class);
         $strategy->expects($this->any())->method('supports')
diff --git a/Tests/Subject.php b/Tests/Subject.php
@@ -22,12 +22,12 @@ public function __construct($marking = null)
         $this->context = [];
     }
 
-    public function getMarking()
+    public function getMarking(): string|array|null
     {
         return $this->marking;
     }
 
-    public function setMarking($marking, array $context = [])
+    public function setMarking($marking, array $context = []): void
     {
         $this->marking = $marking;
         $this->context = $context;
diff --git a/Tests/SupportStrategy/InstanceOfSupportStrategyTest.php b/Tests/SupportStrategy/InstanceOfSupportStrategyTest.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Workflow\Tests\SupportStrategy;
 
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Workflow\SupportStrategy\InstanceOfSupportStrategy;
 use Symfony\Component\Workflow\Workflow;
@@ -31,7 +32,7 @@ public function testSupportsIfNotClassInstance()
         $this->assertFalse($strategy->supports($this->createWorkflow(), new Subject1()));
     }
 
-    private function createWorkflow()
+    private function createWorkflow(): MockObject&Workflow
     {
         return $this->getMockBuilder(Workflow::class)
             ->disableOriginalConstructor()
diff --git a/Tests/WorkflowBuilderTrait.php b/Tests/WorkflowBuilderTrait.php
@@ -17,7 +17,7 @@
 
 trait WorkflowBuilderTrait
 {
-    private static function createComplexWorkflowDefinition()
+    private static function createComplexWorkflowDefinition(): Definition
     {
         $places = range('a', 'g');
 
@@ -52,7 +52,7 @@ private static function createComplexWorkflowDefinition()
         //           +----+                          +----+     +----+     +----+
     }
 
-    private static function createSimpleWorkflowDefinition()
+    private static function createSimpleWorkflowDefinition(): Definition
     {
         $places = range('a', 'c');
 
@@ -87,7 +87,7 @@ private static function createSimpleWorkflowDefinition()
         // +---+     +----+     +---+     +----+     +---+
     }
 
-    private static function createWorkflowWithSameNameTransition()
+    private static function createWorkflowWithSameNameTransition(): Definition
     {
         $places = range('a', 'c');
 
@@ -115,7 +115,7 @@ private static function createWorkflowWithSameNameTransition()
         //   +--------------------------------------------------------------------+
     }
 
-    private static function createComplexStateMachineDefinition()
+    private static function createComplexStateMachineDefinition(): Definition
     {
         $places = ['a', 'b', 'c', 'd'];
 
diff --git a/Tests/WorkflowTest.php b/Tests/WorkflowTest.php
@@ -427,14 +427,16 @@ public function testApplyWithEventDispatcher()
         $this->assertSame($eventNameExpected, $eventDispatcher->dispatchedEvents);
     }
 
-    public static function provideApplyWithEventDispatcherForAnnounceTests()
+    public static function provideApplyWithEventDispatcherForAnnounceTests(): \Generator
     {
         yield [false, [Workflow::DISABLE_ANNOUNCE_EVENT => true]];
         yield [true, [Workflow::DISABLE_ANNOUNCE_EVENT => false]];
         yield [true, []];
     }
 
-    /** @dataProvider provideApplyWithEventDispatcherForAnnounceTests */
+    /**
+     * @dataProvider provideApplyWithEventDispatcherForAnnounceTests
+     */
     public function testApplyWithEventDispatcherForAnnounce(bool $fired, array $context)
     {
         $definition = $this->createComplexWorkflowDefinition();
diff --git a/Validator/DefinitionValidatorInterface.php b/Validator/DefinitionValidatorInterface.php
@@ -21,6 +21,8 @@
 interface DefinitionValidatorInterface
 {
     /**
+     * @return void
+     *
      * @throws InvalidDefinitionException on invalid definition
      */
     public function validate(Definition $definition, string $name);

Original file line number	Diff line number	Diff line change
`@@ -75,6 +75,9 @@ public function getWorkflowName()`
`75`	`75`	`return $this->workflow->getName();`
`76`	`76`	`}`
`77`	`77`
	`78`	`+ /**`
	`79`	`+ * @return mixed`
	`80`	`+ */`
`78`	`81`	`public function getMetadata(string $key, string\|Transition\|null $subject)`
`79`	`82`	`{`
`80`	`83`	`return $this->workflow->getMetadataStore()->getMetadata($key, $subject);`
Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,8 @@ public function getMarking(object $subject): Marking;`
`31`	`31`
`32`	`32`	`/**`
`33`	`33`	`* Sets a Marking to a subject.`
	`34`	`+ *`
	`35`	`+ * @return void`
`34`	`36`	`*/`
`35`	`37`	`public function setMarking(object $subject, Marking $marking, array $context = []);`
`36`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,9 @@`
`18`	`18`	`*/`
`19`	`19`	`trait GetMetadataTrait`
`20`	`20`	`{`
	`21`	`+ /**`
	`22`	`+ * @return mixed`
	`23`	`+ */`
`21`	`24`	`public function getMetadata(string $key, string\|Transition $subject = null)`
`22`	`25`	`{`
`23`	`26`	`if (null === $subject) {`
Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,8 @@ public function getTransitionMetadata(Transition $transition): array;`
`34`	`34`	`* @param string\|Transition\|null $subject Use null to get workflow metadata`
`35`	`35`	`* Use a string (the place name) to get place metadata`
`36`	`36`	`* Use a Transition instance to get transition metadata`
	`37`	`+ *`
	`38`	`+ * @return mixed`
`37`	`39`	`*/`
`38`	`40`	`public function getMetadata(string $key, string\|Transition $subject = null);`
`39`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ public function testDumpWithMarking($definition, $marking, $expected)`
`47`	`47`	`$this->assertEquals($expected, $dump);`
`48`	`48`	`}`
`49`	`49`
`50`		`- public static function provideWorkflowDefinitionWithMarking()`
	`50`	`+ public static function provideWorkflowDefinitionWithMarking(): \Generator`
`51`	`51`	`{`
`52`	`52`	`yield [`
`53`	`53`	`self::createComplexWorkflowDefinition(),`
`@@ -62,13 +62,13 @@ public static function provideWorkflowDefinitionWithMarking()`
`62`	`62`	`];`
`63`	`63`	`}`
`64`	`64`
`65`		`- public static function provideWorkflowDefinitionWithoutMarking()`
	`65`	`+ public static function provideWorkflowDefinitionWithoutMarking(): \Generator`
`66`	`66`	`{`
`67`	`67`	`yield [self::createComplexWorkflowDefinition(), self::provideComplexWorkflowDumpWithoutMarking()];`
`68`	`68`	`yield [self::createSimpleWorkflowDefinition(), self::provideSimpleWorkflowDumpWithoutMarking()];`
`69`	`69`	`}`
`70`	`70`
`71`		`- public static function createComplexWorkflowDefinitionDumpWithMarking()`
	`71`	`+ public static function createComplexWorkflowDefinitionDumpWithMarking(): string`
`72`	`72`	`{`
`73`	`73`	`return 'digraph workflow {`
`74`	`74`	`ratio="compress" rankdir="LR"`
`@@ -106,7 +106,7 @@ public static function createComplexWorkflowDefinitionDumpWithMarking()`
`106`	`106`	`';`
`107`	`107`	`}`
`108`	`108`
`109`		`- public static function createSimpleWorkflowDumpWithMarking()`
	`109`	`+ public static function createSimpleWorkflowDumpWithMarking(): string`
`110`	`110`	`{`
`111`	`111`	`return 'digraph workflow {`
`112`	`112`	`ratio="compress" rankdir="LR"`
`@@ -126,7 +126,7 @@ public static function createSimpleWorkflowDumpWithMarking()`
`126`	`126`	`';`
`127`	`127`	`}`
`128`	`128`
`129`		`- public static function provideComplexWorkflowDumpWithoutMarking()`
	`129`	`+ public static function provideComplexWorkflowDumpWithoutMarking(): string`
`130`	`130`	`{`
`131`	`131`	`return 'digraph workflow {`
`132`	`132`	`ratio="compress" rankdir="LR"`
`@@ -164,7 +164,7 @@ public static function provideComplexWorkflowDumpWithoutMarking()`
`164`	`164`	`';`
`165`	`165`	`}`
`166`	`166`
`167`		`- public static function provideSimpleWorkflowDumpWithoutMarking()`
	`167`	`+ public static function provideSimpleWorkflowDumpWithoutMarking(): string`
`168`	`168`	`{`
`169`	`169`	`return 'digraph workflow {`
`170`	`170`	`ratio="compress" rankdir="LR"`
Original file line number	Diff line number	Diff line change
`@@ -146,7 +146,7 @@ public static function provideWorkflowDefinitionWithoutMarking(): array`
`146`	`146`	`];`
`147`	`147`	`}`
`148`	`148`
`149`		`- public static function provideWorkflowWithReservedWords()`
	`149`	`+ public static function provideWorkflowWithReservedWords(): array`
`150`	`150`	`{`
`151`	`151`	`$builder = new DefinitionBuilder();`
`152`	`152`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ public function testDumpWorkflowWithoutMarking($definition, $marking, $expectedF`
`36`	`36`	`$this->assertStringEqualsFile($file, $dump);`
`37`	`37`	`}`
`38`	`38`
`39`		`- public static function provideWorkflowDefinitionWithoutMarking()`
	`39`	`+ public static function provideWorkflowDefinitionWithoutMarking(): \Generator`
`40`	`40`	`{`
`41`	`41`	`yield [self::createSimpleWorkflowDefinition(), null, 'simple-workflow-nomarking', 'SimpleDiagram'];`
`42`	`42`	`yield [self::createComplexWorkflowDefinition(), null, 'complex-workflow-nomarking', 'ComplexDiagram'];`
`@@ -59,7 +59,7 @@ public function testDumpStateMachineWithoutMarking($definition, $marking, $expec`
`59`	`59`	`$this->assertStringEqualsFile($file, $dump);`
`60`	`60`	`}`
`61`	`61`
`62`		`- public static function provideStateMachineDefinitionWithoutMarking()`
	`62`	`+ public static function provideStateMachineDefinitionWithoutMarking(): \Generator`
`63`	`63`	`{`
`64`	`64`	`yield [static::createComplexStateMachineDefinition(), null, 'complex-state-machine-nomarking', 'SimpleDiagram'];`
`65`	`65`	`$marking = new Marking(['c' => 1, 'e' => 1]);`
`@@ -94,7 +94,7 @@ public function testDumpWorkflowWithSpacesInTheStateNamesAndDescription()`
`94`	`94`	`$this->assertStringEqualsFile($file, $dump);`
`95`	`95`	`}`
`96`	`96`
`97`		`- private function getFixturePath($name, $transitionType)`
	`97`	`+ private function getFixturePath($name, $transitionType): string`
`98`	`98`	`{`
`99`	`99`	`return __DIR__.'/../fixtures/puml/'.$transitionType.'/'.$name.'.puml';`
`100`	`100`	`}`
Original file line number	Diff line number	Diff line change
`@@ -143,7 +143,7 @@ public function testGuardExpressionBlocks()`
`143`	`143`	`$this->assertTrue($event->isBlocked());`
`144`	`144`	`}`
`145`	`145`
`146`		`- private function createEvent(Transition $transition = null)`
	`146`	`+ private function createEvent(Transition $transition = null): GuardEvent`
`147`	`147`	`{`
`148`	`148`	`$subject = new Subject();`
`149`	`149`	`$transition ??= new Transition('name', 'from', 'to');`
`@@ -171,7 +171,7 @@ private function configureAuthenticationChecker($isUsed, $granted = true)`
`171`	`171`	`;`
`172`	`172`	`}`
`173`	`173`
`174`		`- private function configureValidator($isUsed, $valid = true)`
	`174`	`+ private function configureValidator($isUsed, $valid = true): void`
`175`	`175`	`{`
`176`	`176`	`if (!$isUsed) {`
`177`	`177`	`$this->validator`
Original file line number	Diff line number	Diff line change
`@@ -111,7 +111,7 @@ public function testGetMarkingWithUninitializedProperty2()`
`111`	`111`	`$markingStore->getMarking($subject);`
`112`	`112`	`}`
`113`	`113`
`114`		`- private function createValueObject(string $markingValue)`
	`114`	`+ private function createValueObject(string $markingValue): object`
`115`	`115`	`{`
`116`	`116`	`return new class($markingValue) {`
`117`	`117`	`/** @var string */`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\Workflow\Tests;`
`13`	`13`
	`14`	`+use PHPUnit\Framework\MockObject\MockObject;`
`14`	`15`	`use PHPUnit\Framework\TestCase;`
`15`	`16`	`use Symfony\Component\Workflow\Definition;`
`16`	`17`	`use Symfony\Component\Workflow\Exception\InvalidArgumentException;`
`@@ -108,7 +109,7 @@ public function testAllWithNoMatch()`
`108`	`109`	`$this->assertCount(0, $workflows);`
`109`	`110`	`}`
`110`	`111`
`111`		`- private function createWorkflowSupportStrategy($supportedClassName)`
	`112`	`+ private function createWorkflowSupportStrategy($supportedClassName): MockObject&WorkflowSupportStrategyInterface`
`112`	`113`	`{`
`113`	`114`	`$strategy = $this->createMock(WorkflowSupportStrategyInterface::class);`
`114`	`115`	`$strategy->expects($this->any())->method('supports')`