TDD generation of controller stub

Author: jasonmccreary

src/Generators/ControllerGenerator.php

@@ -0,0 +1,93 @@
+<?php
+
+namespace Blueprint\Generators;
+
+use Blueprint\Column;
+use Blueprint\Contracts\Generator;
+use Blueprint\Controller;
+use Illuminate\Support\Str;
+
+class ControllerGenerator implements Generator
+{
+    /** @var \Illuminate\Contracts\Filesystem\Filesystem */
+    private $files;
+
+    public function __construct($files)
+    {
+        $this->files = $files;
+    }
+
+    public function output(array $tree): array
+    {
+        $output = [];
+
+        $stub = $this->files->get(STUBS_PATH . '/controller/class.stub');
+
+        /** @var \Blueprint\Controller $controller */
+        foreach ($tree['controllers'] as $controller) {
+            $path = $this->getPath($controller);
+            $this->files->put(
+                $path,
+                $this->populateStub($stub, $controller)
+            );
+
+            $output['created'][] = $path;
+        }
+
+        return $output;
+    }
+
+    protected function populateStub(string $stub, Controller $controller)
+    {
+        $stub = str_replace('DummyNamespace', 'App\\Http\\Controllers', $stub);
+        $stub = str_replace('DummyClass', $this->className($controller), $stub);
+        $stub = str_replace('// methods...', $this->buildMethods($controller), $stub);
+        $stub = $this->addImports($controller, $stub);
+
+        return $stub;
+    }
+
+    private function buildMethods(Controller $controller)
+    {
+        $template = $this->methodStub();
+
+        $methods = '';
+
+        foreach ($controller->methods() as $name => $body) {
+            $methods .= PHP_EOL . str_replace('DummyMethod', $name, $template);
+            // TODO:
+            // foreach statements
+            // output their resulting code
+            // validate => replace Request injection (addImport)
+            // queue => output Job::dispatch($data) (addImport)
+        }
+
+        return trim($methods);
+    }
+
+    protected function getPath(Controller $controller)
+    {
+        return 'app/Http/Controllers/' . $this->className($controller) . '.php';
+    }
+
+    private function methodStub()
+    {
+        static $stub = '';
+
+        if (empty($stub)) {
+            $stub = $this->files->get(STUBS_PATH . '/controller/method.stub');
+        }
+
+        return $stub;
+    }
+
+    private function addImports(Controller $controller, $stub)
+    {
+        return $stub;
+    }
+
+    protected function className(Controller $controller): string
+    {
+        return $controller->name() . (Str::endsWith($controller->name(), 'Controller') ? '' : 'Controller');
+    }
+}

stubs/controller/class.stub

@@ -0,0 +1,10 @@
+<?php
+
+namespace DummyNamespace;
+
+use Illuminate\Http\Request;
+
+class DummyClass extends Controller
+{
+    // methods...
+}

stubs/controller/method.stub

@@ -0,0 +1,8 @@
+    /**
+     * @param  \Illuminate\Http\Request $request
+     * @return \Illuminate\Http\Response
+     */
+    public function DummyMethod(Request $request)
+    {
+        //
+    }

tests/Feature/Generator/ControllerGeneratorTest.php

@@ -0,0 +1,80 @@
+<?php
+
+namespace Tests\Feature\Generators;
+
+use Blueprint\Blueprint;
+use Blueprint\Generators\ControllerGenerator;
+use Blueprint\Lexers\StatementLexer;
+use Tests\TestCase;
+
+class ControllerGeneratorTest extends TestCase
+{
+    private $blueprint;
+
+    private $files;
+
+    /** @var ControllerGenerator */
+    private $subject;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->files = \Mockery::mock();
+        $this->subject = new ControllerGenerator($this->files);
+
+        $this->blueprint = new Blueprint();
+        $this->blueprint->registerLexer(new \Blueprint\Lexers\ControllerLexer(new StatementLexer()));
+        $this->blueprint->registerGenerator($this->subject);
+    }
+
+    /**
+     * @test
+     */
+    public function output_writes_nothing_for_empty_tree()
+    {
+        $this->files->expects('get')
+            ->with('stubs/controller/class.stub')
+            ->andReturn(file_get_contents('stubs/controller/class.stub'));
+
+        $this->files->shouldNotHaveReceived('put');
+
+        $this->assertEquals([], $this->subject->output(['controllers' => []]));
+    }
+
+    /**
+     * @test
+     * @dataProvider controllerTreeDataProvider
+     */
+    public function output_writes_migration_for_controller_tree($definition, $path, $controller)
+    {
+        static $iteration = 0;
+
+        $this->files->expects('get')
+            ->with('stubs/controller/class.stub')
+            ->andReturn(file_get_contents('stubs/controller/class.stub'));
+
+        if ($iteration === 0) {
+            $this->files->expects('get')
+                ->with('stubs/controller/method.stub')
+                ->andReturn(file_get_contents('stubs/controller/method.stub'));
+        }
+
+        $this->files->expects('put')
+            ->with($path, $this->fixture($controller));
+
+        $tokens = $this->blueprint->parse($this->fixture($definition));
+        $tree = $this->blueprint->analyze($tokens);
+
+        $this->assertEquals(['created' => [$path]], $this->subject->output($tree));
+        ++$iteration;
+    }
+
+
+    public function controllerTreeDataProvider()
+    {
+        return [
+            ['definitions/readme-example.bp', 'app/Http/Controllers/PostController.php', 'controllers/readme-example.php'],
+        ];
+    }
+}

tests/fixtures/controllers/controller-only.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace App\Http\Controllers;
+
+use Illuminate\Http\Request;
+
+class PostController extends Controller
+{
+    /**
+     * @param  \Illuminate\Http\Request $request
+     * @return \Illuminate\Http\Response
+     */
+    public function index(Request $request)
+    {
+        //
+    }
+
+    /**
+     * @param  \Illuminate\Http\Request $request
+     * @return \Illuminate\Http\Response
+     */
+    public function store(Request $request)
+    {
+        //
+    }
+}