Updates for more README example (#273)

jasonmccreary · web-flow · commit 0d82e120b602 · 2020-06-19T14:04:17.000-04:00
diff --git a/README.md b/README.md
@@ -39,6 +39,7 @@ models:
     title: string:400
     content: longtext
     published_at: nullable timestamp
+    author_id: id:user
 
 controllers:
   Post:
@@ -47,9 +48,9 @@ controllers:
       render: post.index with:posts
 
     store:
-      validate: title, content
+      validate: title, content, author_id
       save: post
-      send: ReviewNotification to:post.author with:post
+      send: ReviewPost to:post.author.email with:post
       dispatch: SyncMedia with:post
       fire: NewPost with:post
       flash: post.title
@@ -64,10 +65,13 @@ From these simple 20 lines of YAML, Blueprint will generate all of the following
 - A _controller_ class for `PostController` with `index` and `store` actions complete with code generated for each [statement](https://blueprint.laravelshift.com/docs/controller-statements/).
 - _Routes_ for the `PostController` actions.
 - A [_form request_](https://laravel.com/docs/validation#form-request-validation) of `StorePostRequest` validating `title` and `content` based on the `Post` model definition.
-- A _mailable_ class for `ReviewNotification` complete with a `post` property set through the _constructor_.
+- A _mailable_ class for `ReviewPost` complete with a `post` property set through the _constructor_.
 - A _job_ class for `SyncMedia` complete with a `post` property set through the _constructor_.
 - An _event_ class for `NewPost` complete with a `post` property set through the _constructor_.
 - A _Blade template_ of `post/index.blade.php` rendered by `PostController@index`.
 
+_**Note:** This example assumes features within a default Laravel application such as the `User` model and `app.blade.php
+ layout. Otherwise, the generated test may have failures._
+
 ## Documentation
 Browse the [Blueprint Docs](https://blueprint.laravelshift.com/) for full details on [defining models](https://blueprint.laravelshift.com/docs/defining-models/), [defining controllers](https://blueprint.laravelshift.com/docs/defining-controllers/), [advanced configuration](https://blueprint.laravelshift.com/docs/advanced-configuration/), and [extending Blueprint](https://blueprint.laravelshift.com/docs/extending-blueprint/).
diff --git a/src/Generators/TestGenerator.php b/src/Generators/TestGenerator.php
@@ -106,6 +106,10 @@ protected function buildTestCases(Controller $controller)
             $context = Str::singular($controller->prefix());
             $variable = Str::camel($context);
 
+            $modelNamespace = config('blueprint.models_namespace')
+                ? config('blueprint.namespace') . '\\' . config('blueprint.models_namespace')
+                : config('blueprint.namespace');
+
             if (in_array($name, ['edit', 'update', 'show', 'destroy'])) {
                 $setup['data'][] = sprintf('$%s = factory(%s::class)->create();', $variable, $model);
             }
@@ -211,16 +215,33 @@ protected function buildTestCases(Controller $controller)
                                 $qualifier = $context;
                             }
 
-                            /** @var \Blueprint\Models\Model $model */
+                            $variable_name = $data;
+
+                            /** @var \Blueprint\Models\Model $local_model */
                             $local_model = $this->modelForContext($qualifier);
+
                             if (!is_null($local_model) && $local_model->hasColumn($column)) {
-                                $faker = FactoryGenerator::fakerData($local_model->column($column)->name()) ?? FactoryGenerator::fakerDataType($local_model->column($column)->dataType());
+                                $local_column = $local_model->column($column);
+                                if (($local_column->dataType() === 'id' || $local_column->dataType() === 'uuid') && ($local_column->attributes() && Str::endsWith($local_column->name(), '_id'))) {
+                                    $variable_name = Str::beforeLast($local_column->name(), '_id');
+                                    $reference = $variable_name;
+
+                                    if ($local_column->attributes()) {
+                                        $reference = $local_column->attributes()[0];
+                                        $variable_name .= '->id';
+                                    }
+                                    $faker = sprintf('$%s = factory(%s::class)->create();', Str::beforeLast($local_column->name(), '_id'), Str::studly($reference));
+
+                                    $this->addImport($controller, $modelNamespace . '\\' . Str::studly($reference));
+                                } else {
+                                    $faker = sprintf('$%s = $this->faker->%s;', $data, FactoryGenerator::fakerData($local_column->name()) ?? FactoryGenerator::fakerDataType($local_model->column($column)->dataType()));
+                                }
                             } else {
-                                $faker = 'word';
+                                $faker = sprintf('$%s = $this->faker->word;', $data);
                             }
 
-                            $setup['data'][] = sprintf('$%s = $this->faker->%s;', $data, $faker);
-                            $request_data[$data] = '$' . $data;
+                            $setup['data'][] = $faker;
+                            $request_data[$data] = '$' . $variable_name;
                         }
                     }
                 } elseif ($statement instanceof DispatchStatement) {
@@ -357,10 +378,6 @@ protected function buildTestCases(Controller $controller)
                 } elseif ($statement instanceof EloquentStatement) {
                     $this->addRefreshDatabaseTrait($controller);
 
-                    $modelNamespace = config('blueprint.models_namespace')
-                        ? config('blueprint.namespace') . '\\' . config('blueprint.models_namespace')
-                        : config('blueprint.namespace');
-
                     $model = $this->determineModel($controller->prefix(), $statement->reference());
                     $this->addImport($controller, $modelNamespace . '\\' . $model);
 
@@ -394,10 +411,6 @@ protected function buildTestCases(Controller $controller)
 
                     $setup['data'][] = sprintf('$%s = factory(%s::class, 3)->create();', Str::plural($variable), $model);
 
-                    $modelNamespace = config('blueprint.models_namespace')
-                        ? config('blueprint.namespace') . '\\' . config('blueprint.models_namespace')
-                        : config('blueprint.namespace');
-
                     $this->addImport($controller, $modelNamespace . '\\' . $this->determineModel($controller->prefix(), $statement->model()));
                 }
             }
diff --git a/src/Translators/Rules.php b/src/Translators/Rules.php
@@ -20,8 +20,9 @@ public static function fromColumn(string $context, Column $column)
             array_push($rules, self::overrideStringRuleForSpecialNames($column->name()));
         }
 
-        if ($column->dataType() === 'id' && Str::endsWith($column->name(), '_id')) {
-            $rules = array_merge($rules, ['integer', 'exists:' . Str::plural(Str::beforeLast($column->name(), '_id')) . ',id']);
+        if ($column->dataType() === 'id' && ($column->attributes() || Str::endsWith($column->name(), '_id'))) {
+            $reference = $column->attributes()[0] ?? Str::beforeLast($column->name(), '_id');
+            $rules = array_merge($rules, ['integer', 'exists:' . Str::plural($reference) . ',id']);
         }
 
         if (in_array($column->dataType(), [
diff --git a/tests/Feature/BlueprintTest.php b/tests/Feature/BlueprintTest.php
@@ -208,18 +208,19 @@ public function it_parses_the_readme_example()
                     'title' => 'string:400',
                     'content' => 'longtext',
                     'published_at' => 'nullable timestamp',
+                    'author_id' => 'id:user',
                 ],
             ],
             'controllers' => [
                 'Post' => [
                     'index' => [
-                        'query' => 'all:posts',
+                        'query' => 'all',
                         'render' => 'post.index with:posts',
                     ],
                     'store' => [
-                        'validate' => 'title, content',
+                        'validate' => 'title, content, author_id',
                         'save' => 'post',
-                        'send' => 'ReviewMail to:post.author with:post',
+                        'send' => 'ReviewPost to:post.author.email with:post',
                         'dispatch' => 'SyncMedia with:post',
                         'fire' => 'NewPost with:post',
                         'flash' => 'post.title',
@@ -250,18 +251,19 @@ public function it_parses_the_readme_example_with_different_platform_eols()
                     'title' => 'string:400',
                     'content' => 'longtext',
                     'published_at' => 'nullable timestamp',
+                    'author_id' => 'id:user',
                 ],
             ],
             'controllers' => [
                 'Post' => [
                     'index' => [
-                        'query' => 'all:posts',
+                        'query' => 'all',
                         'render' => 'post.index with:posts',
                     ],
                     'store' => [
-                        'validate' => 'title, content',
+                        'validate' => 'title, content, author_id',
                         'save' => 'post',
-                        'send' => 'ReviewMail to:post.author with:post',
+                        'send' => 'ReviewPost to:post.author.email with:post',
                         'dispatch' => 'SyncMedia with:post',
                         'fire' => 'NewPost with:post',
                         'flash' => 'post.title',
diff --git a/tests/Feature/Generator/Statements/MailGeneratorTest.php b/tests/Feature/Generator/Statements/MailGeneratorTest.php
@@ -137,16 +137,16 @@ public function it_respects_configuration()
             ->with('src/path/Mail')
             ->andReturnFalse();
         $this->files->expects('exists')
-            ->with('src/path/Mail/ReviewMail.php')
+            ->with('src/path/Mail/ReviewPost.php')
             ->andReturnFalse();
         $this->files->expects('makeDirectory')
             ->with('src/path/Mail', 0755, true);
         $this->files->expects('put')
-            ->with('src/path/Mail/ReviewMail.php', $this->fixture('mailables/mail-configured.php'));
+            ->with('src/path/Mail/ReviewPost.php', $this->fixture('mailables/mail-configured.php'));
 
         $tokens = $this->blueprint->parse($this->fixture('drafts/readme-example.yaml'));
         $tree = $this->blueprint->analyze($tokens);
 
-        $this->assertEquals(['created' => ['src/path/Mail/ReviewMail.php']], $this->subject->output($tree));
+        $this->assertEquals(['created' => ['src/path/Mail/ReviewPost.php']], $this->subject->output($tree));
     }
 }
diff --git a/tests/Feature/Lexers/StatementLexerTest.php b/tests/Feature/Lexers/StatementLexerTest.php
@@ -155,15 +155,15 @@ public function it_returns_a_dispatch_statement_with_data()
     public function it_returns_a_send_statement()
     {
         $tokens = [
-            'send' => 'ReviewMail'
+            'send' => 'ReviewPost'
         ];
 
         $actual = $this->subject->analyze($tokens);
 
         $this->assertCount(1, $actual);
         $this->assertInstanceOf(SendStatement::class, $actual[0]);
 
-        $this->assertEquals('ReviewMail', $actual[0]->mail());
+        $this->assertEquals('ReviewPost', $actual[0]->mail());
         $this->assertNull($actual[0]->to());
         $this->assertSame([], $actual[0]->data());
     }
@@ -174,15 +174,15 @@ public function it_returns_a_send_statement()
     public function it_returns_a_send_statement_to_only()
     {
         $tokens = [
-            'send' => 'ReviewMail to:post.author'
+            'send' => 'ReviewPost to:post.author'
         ];
 
         $actual = $this->subject->analyze($tokens);
 
         $this->assertCount(1, $actual);
         $this->assertInstanceOf(SendStatement::class, $actual[0]);
 
-        $this->assertEquals('ReviewMail', $actual[0]->mail());
+        $this->assertEquals('ReviewPost', $actual[0]->mail());
         $this->assertEquals('post.author', $actual[0]->to());
         $this->assertSame([], $actual[0]->data());
     }
@@ -193,15 +193,15 @@ public function it_returns_a_send_statement_to_only()
     public function it_returns_a_send_statement_with_only()
     {
         $tokens = [
-            'send' => 'ReviewMail with:foo, bar, baz'
+            'send' => 'ReviewPost with:foo, bar, baz'
         ];
 
         $actual = $this->subject->analyze($tokens);
 
         $this->assertCount(1, $actual);
         $this->assertInstanceOf(SendStatement::class, $actual[0]);
 
-        $this->assertEquals('ReviewMail', $actual[0]->mail());
+        $this->assertEquals('ReviewPost', $actual[0]->mail());
         $this->assertNull($actual[0]->to());
         $this->assertEquals(['foo', 'bar', 'baz'], $actual[0]->data());
     }
@@ -212,15 +212,15 @@ public function it_returns_a_send_statement_with_only()
     public function it_returns_a_send_statement_to_and_with()
     {
         $tokens = [
-            'send' => 'ReviewMail to:post.author with:foo, bar, baz'
+            'send' => 'ReviewPost to:post.author with:foo, bar, baz'
         ];
 
         $actual = $this->subject->analyze($tokens);
 
         $this->assertCount(1, $actual);
         $this->assertInstanceOf(SendStatement::class, $actual[0]);
 
-        $this->assertEquals('ReviewMail', $actual[0]->mail());
+        $this->assertEquals('ReviewPost', $actual[0]->mail());
         $this->assertEquals('post.author', $actual[0]->to());
         $this->assertEquals(['foo', 'bar', 'baz'], $actual[0]->data());
     }
diff --git a/tests/Feature/Translators/RulesTest.php b/tests/Feature/Translators/RulesTest.php
@@ -96,6 +96,36 @@ public function forColumn_returns_integer_rule_for_integer_types($data_type)
         $this->assertContains('integer', Rules::fromColumn('context', $column));
     }
 
+    /**
+     * @test
+     */
+    public function forColumn_return_exists_rule_for_id_column()
+    {
+        $column = new Column('user_id', 'id');
+
+        $this->assertContains('exists:users,id', Rules::fromColumn('context', $column));
+    }
+
+    /**
+     * @test
+     */
+    public function forColumn_return_exists_rule_id_column_with_attribute()
+    {
+        $column = new Column('author_id', 'id', [], ['user']);
+
+        $this->assertContains('exists:users,id', Rules::fromColumn('context', $column));
+    }
+
+    /**
+     * @test
+     */
+    public function forColumn_return_exists_rule_for_the_unique_modifier()
+    {
+        $column = new Column('column', 'string', ['unique']);
+
+        $this->assertContains('unique:connection.table,column', Rules::fromColumn('connection.table', $column));
+    }
+
     /**
      * @test
      * @dataProvider relationshipColumnProvider
@@ -148,16 +178,6 @@ public function forColumn_returns_date_rule_for_date_types($data_type)
         $this->assertContains('date', Rules::fromColumn('context', $column));
     }
 
-    /**
-     * @test
-     */
-    public function forColumn_return_exists_rule_for_the_unique_modifier()
-    {
-        $column = new Column('column', 'string', ['unique']);
-
-        $this->assertContains('unique:connection.table,column', Rules::fromColumn('connection.table', $column));
-    }
-
     /**
      * @test
      */
diff --git a/tests/fixtures/controllers/readme-example.php b/tests/fixtures/controllers/readme-example.php
@@ -5,7 +5,7 @@
 use App\Events\NewPost;
 use App\Http\Requests\PostStoreRequest;
 use App\Jobs\SyncMedia;
-use App\Mail\ReviewMail;
+use App\Mail\ReviewPost;
 use App\Post;
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\Mail;
@@ -31,7 +31,7 @@ public function store(PostStoreRequest $request)
     {
         $post = Post::create($request->all());
 
-        Mail::to($post->author)->send(new ReviewMail($post));
+        Mail::to($post->author->email)->send(new ReviewPost($post));
 
         SyncMedia::dispatch($post);
 
diff --git a/tests/fixtures/drafts/readme-example.yaml b/tests/fixtures/drafts/readme-example.yaml
@@ -3,17 +3,18 @@ models:
     title: string:400
     content: longtext
     published_at: nullable timestamp
+    author_id: id:user
 
 controllers:
   Post:
     index:
-      query: all:posts
+      query: all
       render: post.index with:posts
 
     store:
-      validate: title, content
+      validate: title, content, author_id
       save: post
-      send: ReviewMail to:post.author with:post
+      send: ReviewPost to:post.author.email with:post
       dispatch: SyncMedia with:post
       fire: NewPost with:post
       flash: post.title
diff --git a/tests/fixtures/factories/fake-nullables.php b/tests/fixtures/factories/fake-nullables.php
@@ -9,5 +9,6 @@
     return [
         'title' => $faker->sentence(4),
         'content' => $faker->paragraphs(3, true),
+        'author_id' => factory(\App\User::class),
     ];
 });
diff --git a/tests/fixtures/form-requests/form-request-configured.php b/tests/fixtures/form-requests/form-request-configured.php
@@ -26,6 +26,7 @@ public function rules()
         return [
             'title' => 'required|string|max:400',
             'content' => 'required|string',
+            'author_id' => 'required|integer|exists:users,id',
         ];
     }
 }
diff --git a/tests/fixtures/mailables/mail-configured.php b/tests/fixtures/mailables/mail-configured.php
@@ -7,7 +7,7 @@
 use Illuminate\Mail\Mailable;
 use Illuminate\Queue\SerializesModels;
 
-class ReviewMail extends Mailable
+class ReviewPost extends Mailable
 {
     use Queueable, SerializesModels;
 
diff --git a/tests/fixtures/migrations/readme-example.php b/tests/fixtures/migrations/readme-example.php
@@ -18,6 +18,7 @@ public function up()
             $table->string('title', 400);
             $table->longText('content');
             $table->timestamp('published_at')->nullable();
+            $table->unsignedBigInteger('author_id');
             $table->timestamps();
         });
     }
diff --git a/tests/fixtures/models/readme-example-phpdoc.php b/tests/fixtures/models/readme-example-phpdoc.php
diff --git a/tests/fixtures/models/readme-example.php b/tests/fixtures/models/readme-example.php
diff --git a/tests/fixtures/tests/readme-example.php b/tests/fixtures/tests/readme-example.php

Original file line number	Diff line number	Diff line change
`@@ -20,8 +20,9 @@ public static function fromColumn(string $context, Column $column)`
`20`	`20`	`array_push($rules, self::overrideStringRuleForSpecialNames($column->name()));`
`21`	`21`	`}`
`22`	`22`
`23`		`- if ($column->dataType() === 'id' && Str::endsWith($column->name(), '_id')) {`
`24`		`- $rules = array_merge($rules, ['integer', 'exists:' . Str::plural(Str::beforeLast($column->name(), '_id')) . ',id']);`
	`23`	`+ if ($column->dataType() === 'id' && ($column->attributes() \|\| Str::endsWith($column->name(), '_id'))) {`
	`24`	`+ $reference = $column->attributes()[0] ?? Str::beforeLast($column->name(), '_id');`
	`25`	`+ $rules = array_merge($rules, ['integer', 'exists:' . Str::plural($reference) . ',id']);`
`25`	`26`	`}`
`26`	`27`
`27`	`28`	`if (in_array($column->dataType(), [`