Merge pull request #70 from RonasIT/49-add-model-generator-tests

Add model generator tests

Author: DenTray

src/Generators/EntityGenerator.php

@@ -26,7 +26,7 @@ abstract class EntityGenerator
     protected $paths = [];
     protected $model;
     protected $fields;
-    protected $relations;
+    protected $relations = [];
     protected $crudOptions;
 
     /**
@@ -213,14 +213,14 @@ protected function getModelClass(string $model): string
         return "{$modelNamespace}\\{$model}";
     }
 
-    protected function isStubExists(string $stubName): bool
+    protected function isStubExists(string $stubName, ?string $generationType = null): bool
     {
         $config = "entity-generator.stubs.{$stubName}";
 
         $stubPath = config($config);
 
         if (!view()->exists($stubPath)) {
-            $generationType = Str::replace('_', ' ', $stubName);
+            $generationType ??= Str::replace('_', ' ', $stubName);
 
             $message = "Generation of {$generationType} has been skipped cause the view {$stubPath} from the config {$config} is not exists. Please check that config has the correct view name value.";
 

src/Generators/ModelGenerator.php

@@ -10,22 +10,22 @@
 
 class ModelGenerator extends EntityGenerator
 {
-    CONST PLURAL_NUMBER_REQUIRED = [
+    protected const array PLURAL_NUMBER_REQUIRED = [
         'belongsToMany',
-        'hasMany'
+        'hasMany',
     ];
 
     public function generate(): void
     {
         if ($this->classExists('models', $this->model)) {
             $this->throwFailureException(
-                ClassAlreadyExistsException::class,
-                "Cannot create {$this->model} Model cause {$this->model} Model already exists.",
-                "Remove {$this->model} Model."
+                exceptionClass: ClassAlreadyExistsException::class,
+                failureMessage: "Cannot create {$this->model} Model cause {$this->model} Model already exists.",
+                recommendedMessage: "Remove {$this->model} Model.",
             );
         }
 
-        if ($this->isStubExists('model') && ($this->isStubExists('relation') || empty($this->relations))) {
+        if ($this->isStubExists('model') && (!$this->hasRelations() || $this->isStubExists('relation', 'model'))) {
             $this->prepareRelatedModels();
             $modelContent = $this->getNewModelContent();
 
@@ -35,14 +35,19 @@ public function generate(): void
         }
     }
 
+    protected function hasRelations(): bool
+    {
+        return !collect($this->relations)->every(fn ($relation) => empty($relation));
+    }
+
     protected function getNewModelContent(): string
     {
         return $this->getStub('model', [
             'entity' => $this->model,
             'fields' => Arr::collapse($this->fields),
             'relations' => $this->prepareRelations(),
             'casts' => $this->getCasts($this->fields),
-            'namespace' => $this->getOrCreateNamespace('models')
+            'namespace' => $this->getOrCreateNamespace('models'),
         ]);
     }
 
@@ -59,9 +64,9 @@ public function prepareRelatedModels(): void
             foreach ($relationsByType as $relation) {
                 if (!$this->classExists('models', $relation)) {
                     $this->throwFailureException(
-                        ClassNotExistsException::class,
-                        "Cannot create {$relation} Model cause {$relation} Model does not exists.",
-                        "Create a {$relation} Model by himself or run command 'php artisan make:entity {$relation} --only-model'."
+                        exceptionClass: ClassNotExistsException::class,
+                        failureMessage: "Cannot create {$this->model} Model cause relation model {$relation} does not exist.",
+                        recommendedMessage: "Create the {$relation} Model by himself or run command 'php artisan make:entity {$relation} --only-model'.",
                     );
                 }
 
@@ -70,7 +75,7 @@ public function prepareRelatedModels(): void
                 $newRelation = $this->getStub('relation', [
                     'name' => $this->getRelationName($this->model, $types[$type]),
                     'type' => $types[$type],
-                    'entity' => $this->model
+                    'entity' => $this->model,
                 ]);
 
                 $fixedContent = preg_replace('/\}$/', "\n    {$newRelation}\n}", $content);
@@ -80,9 +85,9 @@ public function prepareRelatedModels(): void
         }
     }
 
-    public function getModelContent($model): string
+    public function getModelContent(string $model): string
     {
-        $modelPath = base_path($this->paths['models'] . "/{$model}.php");
+        $modelPath = base_path("{$this->paths['models']}/{$model}.php");
 
         return file_get_contents($modelPath);
     }
@@ -97,7 +102,7 @@ public function prepareRelations(): array
                     $result[] = [
                         'name' => $this->getRelationName($relation, $type),
                         'type' => $type,
-                        'entity' => $relation
+                        'entity' => $relation,
                     ];
                 }
             }
@@ -106,7 +111,7 @@ public function prepareRelations(): array
         return $result;
     }
 
-    protected function getCasts($fields): array
+    protected function getCasts(array $fields): array
     {
         $casts = [
             'boolean-required' => 'boolean',
@@ -117,7 +122,7 @@ protected function getCasts($fields): array
         $result = [];
 
         foreach ($fields as $fieldType => $names) {
-            if (empty($casts[$fieldType])) {
+            if (!array_key_exists($fieldType, $casts)) {
                 continue;
             }
 
@@ -129,7 +134,7 @@ protected function getCasts($fields): array
         return $result;
     }
 
-    private function getRelationName($relation, $type): string
+    private function getRelationName(string $relation, string $type): string
     {
         $relationName = Str::snake($relation);
 

stubs/model.blade.php

@@ -14,10 +14,6 @@ class {{$entity}} extends Model
     ];
 
     protected $hidden = ['pivot'];
-@foreach($relations as $relation)
-
-    @include(config('entity-generator.stubs.relation'), $relation)
-@endforeach
 @if(!empty($casts))
 
     protected $casts = [
@@ -26,4 +22,9 @@ class {{$entity}} extends Model
 @endforeach
     ];
 @endif
+@foreach($relations as $relation)
+
+    @include(config('entity-generator.stubs.relation'), $relation)
+
+@endforeach
 }

stubs/relation.blade.php

@@ -1,4 +1,4 @@
     public function {{$name}}()
     {
         return $this->{{$type}}({{$entity}}::class);
-    }
+    }

tests/ControllerGeneratorTest.php

@@ -3,7 +3,6 @@
 namespace RonasIT\Support\Tests;
 
 use Illuminate\Contracts\Filesystem\FileNotFoundException;
-use Illuminate\Support\Facades\Event;
 use Illuminate\Support\Facades\View;
 use RonasIT\Support\Events\SuccessCreateMessage;
 use RonasIT\Support\Events\WarningEvent;
@@ -16,13 +15,6 @@ class ControllerGeneratorTest extends TestCase
 {
     use ControllerGeneratorMockTrait;
 
-    public function setUp(): void
-    {
-        parent::setUp();
-
-        Event::fake();
-    }
-
     public function testControllerAlreadyExists()
     {
         $this->mockClass(ControllerGenerator::class, [

tests/FactoryGeneratorTest.php

@@ -14,13 +14,6 @@ class FactoryGeneratorTest extends TestCase
 {
     use FactoryMockTrait;
 
-    public function setUp(): void
-    {
-        parent::setUp();
-
-        Event::fake();
-    }
-
     public function testModelNotExists()
     {
         $this->assertExceptionThrew(
@@ -57,7 +50,6 @@ className: ClassAlreadyExistsException::class,
 
     public function testProcessUnknownFieldType()
     {
-        $this->mockConfigurations();
         $this->mockFilesystem();
 
         $this->assertExceptionThrew(
@@ -82,7 +74,6 @@ className: ViewException::class,
 
     public function testCreateSuccess()
     {
-        $this->mockConfigurations();
         $this->mockFilesystem();
 
         app(FactoryGenerator::class)

tests/MigrationGeneratorTest.php

@@ -5,16 +5,11 @@
 use Illuminate\Support\Carbon;
 use RonasIT\Support\Exceptions\UnknownFieldTypeException;
 use RonasIT\Support\Generators\MigrationGenerator;
-use RonasIT\Support\Tests\Support\Migration\MigrationMockTrait;
 
 class MigrationGeneratorTest extends TestCase
 {
-    use MigrationMockTrait;
-
     public function testSetUnknownFieldType()
     {
-        $this->setupConfigurations();
-
         $this->assertExceptionThrew(
             className: UnknownFieldTypeException::class,
             message: 'Unknown field type unknown-type in MigrationGenerator.',
@@ -39,9 +34,6 @@ public function testCreateMigration()
     {
         Carbon::setTestNow('2022-02-02');
 
-        $this->mockFilesystem();
-        $this->setupConfigurations();
-
         app(MigrationGenerator::class)
             ->setModel('Post')
             ->setRelations([
@@ -67,9 +59,6 @@ public function testCreateMigrationMYSQL()
 
         Carbon::setTestNow('2022-02-02');
 
-        $this->mockFilesystem();
-        $this->setupConfigurations();
-
         app(MigrationGenerator::class)
             ->setModel('Post')
             ->setRelations([