Add basic respond statement

Author: jasonmccreary

src/Generators/ControllerGenerator.php

@@ -11,6 +11,7 @@
 use Blueprint\Models\Statements\QueryStatement;
 use Blueprint\Models\Statements\RedirectStatement;
 use Blueprint\Models\Statements\RenderStatement;
+use Blueprint\Models\Statements\RespondStatement;
 use Blueprint\Models\Statements\SendStatement;
 use Blueprint\Models\Statements\SessionStatement;
 use Blueprint\Models\Statements\ValidateStatement;
@@ -114,6 +115,8 @@ private function buildMethods(Controller $controller)
                     $body .= self::INDENT . $statement->output() . PHP_EOL;
                 } elseif ($statement instanceof RedirectStatement) {
                     $body .= self::INDENT . $statement->output() . PHP_EOL;
+                } elseif ($statement instanceof RespondStatement) {
+                    $body .= self::INDENT . $statement->output() . PHP_EOL;
                 } elseif ($statement instanceof SessionStatement) {
                     $body .= self::INDENT . $statement->output() . PHP_EOL;
                 } elseif ($statement instanceof EloquentStatement) {

src/Lexers/StatementLexer.php

@@ -10,6 +10,7 @@
 use Blueprint\Models\Statements\QueryStatement;
 use Blueprint\Models\Statements\RedirectStatement;
 use Blueprint\Models\Statements\RenderStatement;
+use Blueprint\Models\Statements\RespondStatement;
 use Blueprint\Models\Statements\SendStatement;
 use Blueprint\Models\Statements\SessionStatement;
 use Blueprint\Models\Statements\ValidateStatement;
@@ -44,6 +45,9 @@ public function analyze(array $tokens): array
                 case 'redirect':
                     $statements[] = $this->analyzeRedirect($statement);
                     break;
+                case 'respond':
+                    $statements[] = $this->analyzeRespond($statement);
+                    break;
                 case 'save':
                 case 'update':
                 case 'delete':
@@ -88,17 +92,9 @@ private function analyzeRedirect(string $statement)
         return new RedirectStatement($route, $data);
     }
 
-    private function parseWithStatement(string $statement)
+    private function analyzeRespond(string $statement)
     {
-        [$object, $with] = $this->extractTokens($statement, 2);
-
-        $data = [];
-
-        if (!empty($with)) {
-            $data = preg_split('/,([ \t]+)?/', substr($with, 5));
-        }
-
-        return [$object, $data];
+        return new RespondStatement($statement);
     }
 
     private function analyzeMail($statement)
@@ -126,6 +122,19 @@ private function analyzeValidate($statement)
         return new ValidateStatement(preg_split('/,([ \t]+)?/', $statement));
     }
 
+    private function parseWithStatement(string $statement)
+    {
+        [$object, $with] = $this->extractTokens($statement, 2);
+
+        $data = [];
+
+        if (!empty($with)) {
+            $data = preg_split('/,([ \t]+)?/', substr($with, 5));
+        }
+
+        return [$object, $data];
+    }
+
     private function extractTokens(string $statement, int $limit = -1)
     {
         return array_pad(preg_split('/[ \t]+/', $statement, $limit), $limit, null);

src/Models/Statements/RespondStatement.php

@@ -0,0 +1,47 @@
+<?php
+
+
+namespace Blueprint\Models\Statements;
+
+use Illuminate\Support\Str;
+
+class RespondStatement
+{
+    /**
+     * @var int
+     */
+    private $status = 200;
+
+    /**
+     * @var string
+     */
+    private $content;
+
+    public function __construct(string $data)
+    {
+        if (ctype_digit($data)) {
+            $this->status = (int)$data;
+        } else {
+            $this->content = $data;
+        }
+    }
+
+    public function status(): int
+    {
+        return $this->status;
+    }
+
+    public function content(): ?string
+    {
+        return $this->content;
+    }
+
+    public function output()
+    {
+        if ($this->content()) {
+            return 'return $' . $this->content . ';';
+        }
+
+        return sprintf('return response()->noContent(%s);', $this->status() === 204 ? '' : $this->status());
+    }
+}

tests/Feature/Generator/ControllerGeneratorTest.php

@@ -106,6 +106,7 @@ public function controllerTreeDataProvider()
             ['definitions/readme-example.bp', 'app/Http/Controllers/PostController.php', 'controllers/readme-example.php'],
             ['definitions/crazy-eloquent.bp', 'app/Http/Controllers/PostController.php', 'controllers/crazy-eloquent.php'],
             ['definitions/nested-components.bp', 'app/Http/Controllers/Admin/UserController.php', 'controllers/nested-components.php'],
+            ['definitions/respond-statements.bp', 'app/Http/Controllers/Api/PostController.php', 'controllers/respond-statements.php'],
         ];
     }
 }

tests/Feature/Lexers/StatementLexerTest.php

@@ -9,6 +9,7 @@
 use Blueprint\Models\Statements\QueryStatement;
 use Blueprint\Models\Statements\RedirectStatement;
 use Blueprint\Models\Statements\RenderStatement;
+use Blueprint\Models\Statements\RespondStatement;
 use Blueprint\Models\Statements\SendStatement;
 use Blueprint\Models\Statements\SessionStatement;
 use Blueprint\Models\Statements\ValidateStatement;
@@ -314,13 +315,40 @@ public function it_returns_a_redirect_statement_with_data()
         $this->assertEquals(['foo', 'bar', 'baz'], $actual[0]->data());
     }
 
-    public function eloquentTokensProvider()
+    /**
+     * @test
+     */
+    public function it_returns_a_response_statement_with_status_code()
     {
-        return [
-            ['save', 'post'],
-            ['update', 'post'],
-            ['delete', 'post.id'],
+        $tokens = [
+            'respond' => '204'
+        ];
+
+        $actual = $this->subject->analyze($tokens);
+
+        $this->assertCount(1, $actual);
+        $this->assertInstanceOf(RespondStatement::class, $actual[0]);
+
+        $this->assertEquals(204, $actual[0]->status());
+        $this->assertNull($actual[0]->content());
+    }
+
+    /**
+     * @test
+     */
+    public function it_returns_a_response_statement_with_content()
+    {
+        $tokens = [
+            'respond' => 'post'
         ];
+
+        $actual = $this->subject->analyze($tokens);
+
+        $this->assertCount(1, $actual);
+        $this->assertInstanceOf(RespondStatement::class, $actual[0]);
+
+        $this->assertEquals(200, $actual[0]->status());
+        $this->assertEquals('post', $actual[0]->content());
     }
 
     /**
@@ -444,4 +472,13 @@ public function sessionTokensProvider()
             ['store', 'post.id'],
         ];
     }
+
+    public function eloquentTokensProvider()
+    {
+        return [
+            ['save', 'post'],
+            ['update', 'post'],
+            ['delete', 'post.id'],
+        ];
+    }
 }

tests/fixtures/controllers/respond-statements.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace App\Http\Controllers\Api;
+
+use App\Api\Post;
+use Illuminate\Http\Request;
+
+class PostController extends Controller
+{
+    /**
+     * @param \Illuminate\Http\Request $request
+     * @return \Illuminate\Http\Response
+     */
+    public function index(Request $request)
+    {
+        $posts = Post::all();
+
+        return $posts;
+    }
+
+    /**
+     * @param \Illuminate\Http\Request $request
+     * @return \Illuminate\Http\Response
+     */
+    public function store(Request $request)
+    {
+        return response()->noContent();
+    }
+
+    /**
+     * @param \Illuminate\Http\Request $request
+     * @return \Illuminate\Http\Response
+     */
+    public function error(Request $request)
+    {
+        return response()->noContent(400);
+    }
+}

tests/fixtures/definitions/respond-statements.bp

@@ -0,0 +1,9 @@
+controllers:
+  Api/Post:
+    index:
+      query: all:posts
+      respond: posts
+    store:
+      respond: 204
+    error:
+      respond: 400