feat: tests completed with addon refactoring

mitulgolakiya · mitulgolakiya · commit cb73ca7e0e67 · 2022-07-05T10:05:56.000+05:30
diff --git a/config/laravel_generator.php b/config/laravel_generator.php
@@ -146,6 +146,10 @@
 
         'seeder' => false,
 
+        'swagger' => false, // generate swagger for your APIs
+
+        'tests' => false, // generate test cases for your APIs
+
         'excluded_fields' => ['id'], // Array of columns that doesn't required while creating module
     ],
 
@@ -180,20 +184,6 @@
 
     'tables' => 'blade',
 
-    /*
-    |--------------------------------------------------------------------------
-    | Add-Ons
-    |--------------------------------------------------------------------------
-    |
-    */
-
-    'add_ons' => [
-
-        'swagger'       => false, // generate swagger for your APIs
-
-        'tests'         => false, // generate test cases for your APIs
-    ],
-
     /*
     |--------------------------------------------------------------------------
     | Timestamp Fields
diff --git a/src/Commands/BaseCommand.php b/src/Commands/BaseCommand.php
@@ -72,7 +72,7 @@ public function generateCommonItems()
             $repositoryGenerator->generate();
         }
 
-        if ($this->config->options->factory || (!$this->isSkip('tests') and $this->config->addons->tests)) {
+        if ($this->config->options->factory || (!$this->isSkip('tests') and $this->config->options->tests)) {
             $factoryGenerator = app(FactoryGenerator::class);
             $factoryGenerator->generate();
         }
@@ -100,7 +100,7 @@ public function generateAPIItems()
             $routesGenerator->generate();
         }
 
-        if (!$this->isSkip('tests') and $this->config->addons->tests) {
+        if (!$this->isSkip('tests') and $this->config->options->tests) {
             if ($this->config->options->repositoryPattern) {
                 $repositoryTestGenerator = app(RepositoryTestGenerator::class);
                 $repositoryTestGenerator->generate();
diff --git a/src/Commands/Publish/GeneratorPublishCommand.php b/src/Commands/Publish/GeneratorPublishCommand.php
@@ -72,10 +72,10 @@ private function publishTestCases()
         $createdAtField = config('laravel_generator.timestamps.created_at', 'created_at');
         $updatedAtField = config('laravel_generator.timestamps.updated_at', 'updated_at');
 
-        $templateData = get_template('test.api_test_trait', 'laravel-generator');
-
-        $templateData = str_replace('$NAMESPACE_TESTS$', $testsNameSpace, $templateData);
-        $templateData = str_replace('$TIMESTAMPS$', "['$createdAtField', '$updatedAtField']", $templateData);
+        $templateData = view('laravel-generator::api.tet.api_test_trait', [
+            'timestamps' => "['$createdAtField', '$updatedAtField']",
+            'namespacesTests' => $testsNameSpace
+        ])->render();
 
         $fileName = 'ApiTestTrait.php';
 
diff --git a/src/Commands/RollbackGeneratorCommand.php b/src/Commands/RollbackGeneratorCommand.php
@@ -94,15 +94,15 @@ public function handle()
             $menuGenerator->rollback();
         }
 
-        if ($this->config->addons->tests) {
+        if ($this->config->options->tests) {
             $repositoryTestGenerator = app(RepositoryTestGenerator::class);
             $repositoryTestGenerator->rollback();
 
             $apiTestGenerator = app(APITestGenerator::class);
             $apiTestGenerator->rollback();
         }
 
-        if ($this->config->options->factory or $this->config->addons->tests) {
+        if ($this->config->options->factory or $this->config->options->tests) {
             $factoryGenerator = app(FactoryGenerator::class);
             $factoryGenerator->rollback();
         }
diff --git a/src/Common/GeneratorConfig.php b/src/Common/GeneratorConfig.php
@@ -17,7 +17,6 @@ class GeneratorConfig
     public GeneratorPaths $paths;
     public ModelNames $modelNames;
     public GeneratorPrefixes $prefixes;
-    public GeneratorAddons $addons;
     public GeneratorOptions $options;
     public Command $command;
 
@@ -31,6 +30,7 @@ class GeneratorConfig
 
     public $tableName;
     public string $tableType;
+    public string $apiPrefix;
     public $primaryName;
     public $connection;
 
@@ -40,9 +40,9 @@ public function init()
         $this->loadPrefixes();
         $this->loadPaths();
         $this->tableType = config('laravel_generator.tables', 'blade');
+        $this->apiPrefix = config('laravel_generator.api_prefix', 'api');
         $this->loadNamespaces();
         $this->prepareTable();
-        $this->prepareAddons();
         $this->prepareOptions();
     }
 
@@ -259,20 +259,13 @@ public function prepareOptions()
         $options->resources = config('laravel_generator.options.resources', false);
         $options->factory = config('laravel_generator.options.factory', false);
         $options->seeder = config('laravel_generator.options.seeder', false);
+        $options->swagger = config('laravel_generator.options.swagger', false);
+        $options->tests = config('laravel_generator.options.tests', false);
         $options->excludedFields = config('laravel_generator.options.excluded_fields', ['id']);
 
         $this->options = $options;
     }
 
-    public function prepareAddons()
-    {
-        $addons = new GeneratorAddons();
-        $addons->swagger = config('laravel_generator.add_ons.swagger', false);
-        $addons->tests = config('laravel_generator.add_ons.tests', false);
-
-        $this->addons = $addons;
-    }
-
     public function overrideOptionsFromJsonFile($jsonData)
     {
 //        $options = self::$availableOptions;
diff --git a/src/DTOs/GeneratorAddons.php b/src/DTOs/GeneratorAddons.php
diff --git a/src/DTOs/GeneratorOptions.php b/src/DTOs/GeneratorOptions.php
@@ -11,5 +11,7 @@ class GeneratorOptions
     public bool $resources;
     public bool $factory;
     public bool $seeder;
+    public bool $swagger;
+    public bool $tests;
     public array $excludedFields;
 }
diff --git a/src/Generators/API/APIControllerGenerator.php b/src/Generators/API/APIControllerGenerator.php
@@ -53,7 +53,7 @@ private function fillDocs(): array
     {
         $methods = ['controller', 'index', 'store', 'show', 'update', 'destroy'];
 
-        if ($this->config->addons->swagger) {
+        if ($this->config->options->swagger) {
             $templatePrefix = 'controller_docs';
             $templateType = 'swagger-generator';
         } else {
diff --git a/src/Generators/API/APIRoutesGenerator.php b/src/Generators/API/APIRoutesGenerator.php
@@ -7,47 +7,41 @@
 
 class APIRoutesGenerator extends BaseGenerator
 {
-    private string $routeContents;
-
-    private string $routesTemplate;
-
     public function __construct()
     {
         parent::__construct();
 
         $this->path = $this->config->paths->apiRoutes;
-
-        $this->routeContents = g_filesystem()->getFile($this->path);
-
-        if (!empty($this->config->prefixes->route)) {
-            $routesTemplate = get_template('api.routes.prefix_routes', 'laravel-generator');
-        } else {
-            $routesTemplate = get_template('api.routes.routes', 'laravel-generator');
-        }
-
-        $this->routesTemplate = fill_template($this->config->dynamicVars, $routesTemplate);
     }
 
     public function generate()
     {
-        $this->routeContents .= PHP_EOL.PHP_EOL.$this->routesTemplate;
-        $existingRouteContents = g_filesystem()->getFile($this->path);
-        if (Str::contains($existingRouteContents, "Route::resource('".$this->config->modelNames->dashedPlural."',")) {
+        $routeContents = g_filesystem()->getFile($this->path);
+
+        $routes = view('laravel-generator::api.routes', $this->variables())->render();
+
+        if (Str::contains($routeContents, $routes)) {
             $this->config->commandInfo(PHP_EOL.'Menu '.$this->config->modelNames->dashedPlural.' already exists, Skipping Adjustment.');
 
             return;
         }
 
-        g_filesystem()->createFile($this->path, $this->routeContents);
+        $routeContents .= PHP_EOL.PHP_EOL.$routes;
+
+        g_filesystem()->createFile($this->path, $routeContents);
 
         $this->config->commandComment(PHP_EOL.$this->config->modelNames->dashedPlural.' api routes added.');
     }
 
     public function rollback()
     {
-        if (Str::contains($this->routeContents, $this->routesTemplate)) {
-            $this->routeContents = str_replace($this->routesTemplate, '', $this->routeContents);
-            g_filesystem()->createFile($this->path, $this->routeContents);
+        $routeContents = g_filesystem()->getFile($this->path);
+
+        $routes = view('laravel-generator::api.routes', $this->variables())->render();
+
+        if (Str::contains($routeContents, $routes)) {
+            $routeContents = str_replace($routeContents, '', $routes);
+            g_filesystem()->createFile($this->path, $routeContents);
             $this->config->commandComment('api routes deleted');
         }
     }
diff --git a/src/Generators/API/APITestGenerator.php b/src/Generators/API/APITestGenerator.php
@@ -18,9 +18,7 @@ public function __construct()
 
     public function generate()
     {
-        $templateData = get_template('api.test.api_test', 'laravel-generator');
-
-        $templateData = fill_template($this->config->dynamicVars, $templateData);
+        $templateData = view('laravel-generator::api.test.api_test', $this->variables())->render();
 
         g_filesystem()->createFile($this->path.$this->fileName, $templateData);
 
diff --git a/src/Generators/ModelGenerator.php b/src/Generators/ModelGenerator.php
@@ -117,7 +117,7 @@ protected function generateFillables(): array
 
     private function fillDocs(): string
     {
-        if (!$this->config->addons->swagger) {
+        if (!$this->config->options->swagger) {
             return '';
         }
 
diff --git a/src/Generators/RepositoryGenerator.php b/src/Generators/RepositoryGenerator.php
@@ -23,7 +23,7 @@ public function variables(): array
 
     public function generate()
     {
-        $templateData = view('laravel-generator::repository', $this->variables())->render();
+        $templateData = view('laravel-generator::repository.repository', $this->variables())->render();
 
         g_filesystem()->createFile($this->path.$this->fileName, $templateData);
 
diff --git a/src/Generators/RepositoryTestGenerator.php b/src/Generators/RepositoryTestGenerator.php
@@ -16,21 +16,14 @@ public function __construct()
 
     public function generate()
     {
-        $templateData = get_template('test.repository_test', 'laravel-generator');
-
-        $templateData = $this->fillTemplate($templateData);
+        $templateData = view('laravel-generator::repository.repository_test', $this->variables())->render();
 
         g_filesystem()->createFile($this->path.$this->fileName, $templateData);
 
         $this->config->commandComment(PHP_EOL.'RepositoryTest created: ');
         $this->config->commandInfo($this->fileName);
     }
 
-    private function fillTemplate($templateData): string
-    {
-        return fill_template($this->config->dynamicVars, $templateData);
-    }
-
     public function rollback()
     {
         if ($this->rollbackFile($this->path, $this->fileName)) {
diff --git a/tests/Commands/APIScaffoldGeneratorCommandTest.php b/tests/Commands/APIScaffoldGeneratorCommandTest.php
@@ -94,7 +94,7 @@
 
     mockShouldNotHaveCalledGenerateMethod($shouldNotHaveCalledGenerator);
 
-    config()->set('laravel_generator.add_ons.tests', true);
+    config()->set('laravel_generator.options.tests', true);
 
     $modelSchemaFile = __DIR__.'/../fixtures/model_schema/Post.json';
 
diff --git a/tests/Commands/RollbackGeneratorCommandTest.php b/tests/Commands/RollbackGeneratorCommandTest.php
@@ -94,7 +94,7 @@ function mockShouldNotHaveCalledRollbackGenerators(array $shouldNotHaveCalledGen
 
     mockShouldNotHaveCalledRollbackGenerators($shouldNotHaveCalledGenerator);
 
-    config()->set('laravel_generator.add_ons.tests', true);
+    config()->set('laravel_generator.options.tests', true);
 
     artisan(RollbackGeneratorCommand::class, ['model' => 'User', 'type' => 'api_scaffold']);
 });
@@ -152,7 +152,7 @@ function mockShouldNotHaveCalledRollbackGenerators(array $shouldNotHaveCalledGen
 
     mockShouldNotHaveCalledRollbackGenerators($shouldNotHaveCalledGenerator);
 
-    config()->set('laravel_generator.add_ons.tests', true);
+    config()->set('laravel_generator.options.tests', true);
 
     artisan(RollbackGeneratorCommand::class, ['model' => 'User', 'type' => 'scaffold']);
 });
diff --git a/views/api/routes.blade.php b/views/api/routes.blade.php
@@ -0,0 +1 @@
+Route::resource('{{ $config->modelNames->dashedPlural }}', {{ $config->namespaces->apiController }}\{{ $config->modelNames->name }}APIController::class);
diff --git a/views/api/test/api_test.blade.php b/views/api/test/api_test.blade.php
@@ -0,0 +1,84 @@
+@php
+    echo "<?php".PHP_EOL;
+@endphp
+
+namespace {{ $config->namespaces->apiTests }};
+
+use Illuminate\Foundation\Testing\WithoutMiddleware;
+use Illuminate\Foundation\Testing\DatabaseTransactions;
+use {{ $config->namespaces->tests }}\TestCase;
+use {{ $config->namespaces->tests }}\ApiTestTrait;
+use {{ $config->namespaces->model }}\{{ $config->modelNames->name }};
+
+class {{ $config->modelNames->name }}ApiTest extends TestCase
+{
+    use ApiTestTrait, WithoutMiddleware, DatabaseTransactions;
+
+    /**
+     * @test
+     */
+    public function test_create_{{ $config->modelNames->snake }}()
+    {
+        ${{ $config->modelNames->camel }} = {{ $config->modelNames->name }}::factory()->make()->toArray();
+
+        $this->response = $this->json(
+            'POST',
+            '/{{ $config->apiPrefix }}/{{ $config->modelNames->dashedPlural }}', ${{ $config->modelNames->camel }}
+        );
+
+        $this->assertApiResponse(${{ $config->modelNames->camel }});
+    }
+
+    /**
+     * @test
+     */
+    public function test_read_{{ $config->modelNames->snake }}()
+    {
+        ${{ $config->modelNames->camel }} = {{ $config->modelNames->name }}::factory()->create();
+
+        $this->response = $this->json(
+            'GET',
+            '/{{ $config->apiPrefix }}/{{ $config->modelNames->dashedPlural }}/'.${{ $config->modelNames->camel }}->{{ $config->primaryName }}
+        );
+
+        $this->assertApiResponse(${{ $config->modelNames->camel }}->toArray());
+    }
+
+    /**
+     * @test
+     */
+    public function test_update_{{ $config->modelNames->snake }}()
+    {
+        ${{ $config->modelNames->camel }} = {{ $config->modelNames->name }}::factory()->create();
+        $edited{{ $config->modelNames->name }} = {{ $config->modelNames->name }}::factory()->make()->toArray();
+
+        $this->response = $this->json(
+            'PUT',
+            '/{{ $config->apiPrefix }}/{{ $config->modelNames->dashedPlural }}/'.${{ $config->modelNames->camel }}->{{ $config->primaryName }},
+            $edited{{ $config->modelNames->name }}
+        );
+
+        $this->assertApiResponse($edited{{ $config->modelNames->name }});
+    }
+
+    /**
+     * @test
+     */
+    public function test_delete_{{ $config->modelNames->snake }}()
+    {
+        ${{ $config->modelNames->camel }} = {{ $config->modelNames->name }}::factory()->create();
+
+        $this->response = $this->json(
+            'DELETE',
+             '/{{ $config->apiPrefix }}/{{ $config->modelNames->dashedPlural }}/'.${{ $config->modelNames->camel }}->{{ $config->primaryName }}
+         );
+
+        $this->assertApiSuccess();
+        $this->response = $this->json(
+            'GET',
+            '/{{ $config->apiPrefix }}/{{ $config->modelNames->dashedPlural }}/'.${{ $config->modelNames->camel }}->{{ $config->primaryName }}
+        );
+
+        $this->response->assertStatus(404);
+    }
+}
diff --git a/views/api/test/api_test_trait.blade.php b/views/api/test/api_test_trait.blade.php
diff --git a/views/model/model.blade.php b/views/model/model.blade.php
diff --git a/views/repository/repository.blade.php b/views/repository/repository.blade.php
diff --git a/views/repository/repository_test.blade.php b/views/repository/repository_test.blade.php

Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ public function generateCommonItems()`
`72`	`72`	`$repositoryGenerator->generate();`
`73`	`73`	`}`
`74`	`74`
`75`		`- if ($this->config->options->factory \|\| (!$this->isSkip('tests') and $this->config->addons->tests)) {`
	`75`	`+ if ($this->config->options->factory \|\| (!$this->isSkip('tests') and $this->config->options->tests)) {`
`76`	`76`	`$factoryGenerator = app(FactoryGenerator::class);`
`77`	`77`	`$factoryGenerator->generate();`
`78`	`78`	`}`
`@@ -100,7 +100,7 @@ public function generateAPIItems()`
`100`	`100`	`$routesGenerator->generate();`
`101`	`101`	`}`
`102`	`102`
`103`		`- if (!$this->isSkip('tests') and $this->config->addons->tests) {`
	`103`	`+ if (!$this->isSkip('tests') and $this->config->options->tests) {`
`104`	`104`	`if ($this->config->options->repositoryPattern) {`
`105`	`105`	`$repositoryTestGenerator = app(RepositoryTestGenerator::class);`
`106`	`106`	`$repositoryTestGenerator->generate();`
Original file line number	Diff line number	Diff line change
`@@ -94,15 +94,15 @@ public function handle()`
`94`	`94`	`$menuGenerator->rollback();`
`95`	`95`	`}`
`96`	`96`
`97`		`- if ($this->config->addons->tests) {`
	`97`	`+ if ($this->config->options->tests) {`
`98`	`98`	`$repositoryTestGenerator = app(RepositoryTestGenerator::class);`
`99`	`99`	`$repositoryTestGenerator->rollback();`
`100`	`100`
`101`	`101`	`$apiTestGenerator = app(APITestGenerator::class);`
`102`	`102`	`$apiTestGenerator->rollback();`
`103`	`103`	`}`
`104`	`104`
`105`		`- if ($this->config->options->factory or $this->config->addons->tests) {`
	`105`	`+ if ($this->config->options->factory or $this->config->options->tests) {`
`106`	`106`	`$factoryGenerator = app(FactoryGenerator::class);`
`107`	`107`	`$factoryGenerator->rollback();`
`108`	`108`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,5 +11,7 @@ class GeneratorOptions`
`11`	`11`	`public bool $resources;`
`12`	`12`	`public bool $factory;`
`13`	`13`	`public bool $seeder;`
	`14`	`+ public bool $swagger;`
	`15`	`+ public bool $tests;`
`14`	`16`	`public array $excludedFields;`
`15`	`17`	`}`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ private function fillDocs(): array`
`53`	`53`	`{`
`54`	`54`	`$methods = ['controller', 'index', 'store', 'show', 'update', 'destroy'];`
`55`	`55`
`56`		`- if ($this->config->addons->swagger) {`
	`56`	`+ if ($this->config->options->swagger) {`
`57`	`57`	`$templatePrefix = 'controller_docs';`
`58`	`58`	`$templateType = 'swagger-generator';`
`59`	`59`	`} else {`
Original file line number	Diff line number	Diff line change
`@@ -18,9 +18,7 @@ public function __construct()`
`18`	`18`
`19`	`19`	`public function generate()`
`20`	`20`	`{`
`21`		`- $templateData = get_template('api.test.api_test', 'laravel-generator');`
`22`		`-`
`23`		`- $templateData = fill_template($this->config->dynamicVars, $templateData);`
	`21`	`+ $templateData = view('laravel-generator::api.test.api_test', $this->variables())->render();`
`24`	`22`
`25`	`23`	`g_filesystem()->createFile($this->path.$this->fileName, $templateData);`
`26`	`24`