Refactored generator factory

Author: dantleech

lib/Core/BuiltPipeline.php

@@ -32,9 +32,9 @@ public function run(array $data = []): array
 
     public function generator(array $data = []): Generator
     {
-        $configuredGenerator = $this->factory->generatorFor('pipeline', [
+        $configuredGenerator = $this->factory->generatorFor(['pipeline', [
             'stages' => $this->stages,
-        ]);
+        ]]);
 
         $return = $data;
         $generator = $configuredGenerator->generator();

lib/Core/GeneratorFactory.php

@@ -3,6 +3,8 @@
 namespace PhpBench\Pipeline\Core;
 
 use PhpBench\Pipeline\Core\Exception\InvalidStage;
+use PhpBench\Pipeline\Core\Exception\InvalidYieldedValue;
+use Generator;
 
 class GeneratorFactory
 {
@@ -22,7 +24,7 @@ public function generatorFor($stage, array $config = []): ConfiguredGenerator
             $generator = $stage();
 
             if (false === $generator instanceof Generator) {
-                throw new InvalidStage(sprintf(
+                throw new InvalidYieldedValue(sprintf(
                     'Callable stages must return Generators, got "%s"',
                     is_object($generator) ? get_class($generator) : gettype($generator)
                 ));
@@ -31,9 +33,13 @@ public function generatorFor($stage, array $config = []): ConfiguredGenerator
             return new ConfiguredGenerator($generator, []);
         }
 
+        if (is_string($stage)) {
+            $stage = (array) $stage;
+        }
+
         if (false === is_array($stage)) {
             throw new InvalidStage(sprintf(
-                'Stage must either be an stage config element or a callable, got "%s"',
+                'Stage must either be a stage config element or a callable, got "%s"',
                 is_object($stage) ? get_class($stage) : gettype($stage)
             ));
         }

lib/Core/PipelineBuilder.php

@@ -51,6 +51,7 @@ public function build(): BuiltPipeline
     public function load(array $stages): self
     {
         foreach ($stages as $stage) {
+            $this->stages[] = $stage;
         }
 
         return $this;

lib/Extension/Core/Stage/Distribution/Fork.php

@@ -21,6 +21,7 @@ public function __invoke(): Generator
         while (true) {
             foreach ($config['stages'] as $stage) {
                 $generatorFactory->generatorFor($stage);
+                yield;
             }
         }
 

tests/Unit/Core/BuiltPipelineTest.php

@@ -22,9 +22,9 @@ public function setUp()
     public function testItShouldProvideAGenerator()
     {
         $pipeline = new BuiltPipeline([], $this->factory->reveal());
-        $this->factory->generatorFor('pipeline', [
+        $this->factory->generatorFor(['pipeline', [
             'stages' => [],
-        ])->will(function () {
+        ]])->will(function () {
             return new ConfiguredGenerator((function () {
                 yield;
                 yield 'hello';

tests/Unit/Core/GeneratorFactoryTest.php

@@ -13,6 +13,7 @@
 use PhpBench\Pipeline\Core\ConfiguredGenerator;
 use PhpBench\Pipeline\Core\Exception\InvalidStage;
 use stdClass;
+use PhpBench\Pipeline\Core\Exception\InvalidYieldedValue;
 
 class GeneratorFactoryTest extends TestCase
 {
@@ -79,7 +80,7 @@ public function testResolvesConfig()
 
     public function testThrowsExceptionIfCallableDoesntReturnAGenerator()
     {
-        $this->expectException(InvalidStage::class);
+        $this->expectException(InvalidYieldedValue::class);
         $this->expectExceptionMessage('Callable stages must return Generators, got "stdClass"');
 
         $this->factory->generatorFor(function () {
@@ -90,7 +91,7 @@ public function testThrowsExceptionIfCallableDoesntReturnAGenerator()
     public function testThrowsExceptionIfStageNotStageOrCallable()
     {
         $this->expectException(InvalidStage::class);
-        $this->expectExceptionMessage('Stage must either be an stage config element or a callable, got "stdClass"');
+        $this->expectExceptionMessage('Stage must either be a stage config element or a callable, got "stdClass"');
 
         $this->factory->generatorFor(new stdClass());
     }

tests/Unit/Core/PipelineBuilderTest.php

@@ -38,41 +38,6 @@ public function testBuildsAnEmptyPipeline()
         $this->assertInstanceOf(BuiltPipeline::class, $pipeline);
     }
 
-    public function testBuildsPipelineWithCallable()
-    {
-        $builder = PipelineBuilder::create();
-        $builder->stage(function () {
-            yield;
-            yield ['Hello'];
-        });
-        $pipeline = $builder->build();
-
-        $this->assertInstanceOf(BuiltPipeline::class, $pipeline);
-        $result = $pipeline->run();
-        $this->assertEquals(['Hello'], $result);
-    }
-
-    public function testBuildsPipelineWithStageAlias()
-    {
-        $this->extension1->stageAliases()->willReturn(['test/foobar']);
-        $this->extension1->stage('test/foobar')->willReturn($this->stage1->reveal());
-        $this->stage1->configure(Argument::type(Schema::class))->will(function () {});
-        $this->stage1->__invoke()->will(function () {
-            yield;
-            yield ['Test'];
-        });
-
-        $builder = PipelineBuilder::create();
-        $builder->addExtension($this->extension1->reveal());
-
-        $builder->stage('test/foobar');
-        $pipeline = $builder->build();
-
-        $this->assertInstanceOf(BuiltPipeline::class, $pipeline);
-        $result = $pipeline->run();
-        $this->assertEquals(['Test'], $result);
-    }
-
     /**
      * @dataProvider provideBuildsPipelinesFromStages
      */
@@ -153,36 +118,6 @@ function () {
             ],
             [ 'Value1' ],
         ];
-        yield 'but throws exception if stage has more than 2 elements ' => [
-            [ 
-                [ 'test/stage1', [], [] ]
-            ],
-            [],
-            [
-                InvalidStage::class,
-                'Stage config element cannot have more than 2 elements, got 3'
-            ]
-        ];
-        yield 'but throws exception if stage was neither an array or a callable ' => [
-            [ 
-                new stdClass,
-            ],
-            [],
-            [
-                InvalidStage::class,
-                'Stage must either be an array config element or a callable, got "stdClass"'
-            ]
-        ];
-        yield 'but throws exception stage was a indexes are not numerical' => [
-            [ 
-                [ 'test/stage1' => [] ]
-            ],
-            [],
-            [
-                InvalidStage::class,
-                'Stage config element must be a 1 to 2 element tuple (e.g. ["stage\/alias",{"config1":"value1"}]), got "{"test\/stage1":[]}"'
-            ]
-        ];
     }
 
     public function testBuildsPipelineWithMultipleStages()

tests/Unit/Core/PipelineTest.php

@@ -145,6 +145,10 @@ public function provideSubstitutesConfigTokensWithDataValues()
 
     public function testThrowsAnExceptionIfStageDoesNotYieldAnArray()
     {
+        $this->factory->generatorFor(Argument::type('callable'))->will(function ($args) {
+            return new ConfiguredGenerator($args[0](), []);
+        });
+
         $this->expectException(InvalidYieldedValue::class);
 
         $this->runPipeline([