refactor: fix model relation type, separate methods in ModelMockTrait

refs: #203

Author: Ni Nelli

src/Generators/ModelGenerator.php

@@ -261,7 +261,7 @@ protected function isRequired(string $typeName): bool
     protected function getRelationType(string $model, string $relation): string
     {
         if (in_array($relation, self::PLURAL_NUMBER_REQUIRED)) {
-            return "Collection<int, $model>";
+            return "Collection<{$model}>";
         }
 
         return "{$model}|null";

tests/ModelGeneratorTest.php

@@ -19,7 +19,7 @@ public function setUp(): void
     {
         parent::setUp();
 
-        $this->mockFilesystem();
+        $this->mockDefaultFilesystem();
     }
 
     public function testModelAlreadyExists()
@@ -249,19 +249,15 @@ className: WarningEvent::class,
 
     public function testAddPropertyAnnotationToRelatedModel()
     {
-        $this->mockFilesystem([
-            'Post.php' => $this->getFixture('new_model_without_fields.php'),
-        ]);
-
         app(ModelGenerator::class)
             ->setModel('Category')
             ->setFields([])
             ->setRelations(new RelationsDTO(
-                belongsToMany: ['Post'],
+                belongsToMany: ['User'],
             ))
             ->generate();
 
-        $this->assertGeneratedFileEquals('related_model_with_property.php', 'app/Models/Post.php');
+        $this->assertGeneratedFileEquals('related_model_with_property.php', 'app/Models/User.php');
 
         $this->assertEventPushed(
             className: SuccessCreateMessage::class,

tests/Support/Model/ModelMockTrait.php

@@ -9,19 +9,24 @@ trait ModelMockTrait
 {
     use GeneratorMockTrait;
 
+    public function mockDefaultFilesystem(): void
+    {
+        $fileSystemMock = new FileSystemMock;
+
+        $fileSystemMock->models = [
+            'Comment.php' => file_get_contents(getcwd() . '/tests/Support/Models/WelcomeBonus.php'),
+            'User.php' => file_get_contents(getcwd() . '/tests/Support/Models/WelcomeBonus.php'),
+            'Forum/Author.php' => file_get_contents(getcwd() . '/tests/Support/Models/WelcomeBonus.php'),
+        ];
+
+        $fileSystemMock->setStructure();
+    }
+
     public function mockFilesystem(array $models = []): void
     {
         $fileSystemMock = new FileSystemMock;
 
-        if (!empty($models)) {
-            $fileSystemMock->models = $models;
-        } else {
-            $fileSystemMock->models = [
-                'Comment.php' => file_get_contents(getcwd() . '/tests/Support/Models/WelcomeBonus.php'),
-                'User.php' => file_get_contents(getcwd() . '/tests/Support/Models/WelcomeBonus.php'),
-                'Forum/Author.php' => file_get_contents(getcwd() . '/tests/Support/Models/WelcomeBonus.php'),
-            ];
-        }
+        $fileSystemMock->models = $models;
 
         $fileSystemMock->setStructure();
     }

tests/fixtures/ModelGeneratorTest/new_model.php

@@ -22,7 +22,7 @@
  * @property Carbon $published_at
  * @property array $meta
  * @property Comment|null $comment
- * @property Collection<int, User> $users
+ * @property Collection<User> $users
  */
 class Post extends Model
 {

tests/fixtures/ModelGeneratorTest/new_model_with_many_relations.php

@@ -8,7 +8,7 @@
 use Illuminate\Database\Eloquent\Collection;
 
 /**
- * @property Collection<int, User> $users
+ * @property Collection<User> $users
  */
 class Post extends Model
 {

tests/fixtures/ModelGeneratorTest/new_model_with_subfolers_relations.php

@@ -9,7 +9,7 @@
 
 /**
  * @property string $title
- * @property Collection<int, Author> $authors
+ * @property Collection<Author> $authors
  */
 class Post extends Model
 {

tests/fixtures/ModelGeneratorTest/new_subfolders_model.php

@@ -24,7 +24,7 @@
  * @property Carbon $published_at
  * @property array $meta
  * @property Comment|null $comment
- * @property Collection<int, User> $users
+ * @property Collection<User> $users
  */
 class Post extends Model
 {

tests/fixtures/ModelGeneratorTest/related_model_with_property.php

@@ -1,26 +1,34 @@
 <?php
 
-namespace App\Models;
+namespace RonasIT\Support\Tests\Support\Models;
 
 use Illuminate\Database\Eloquent\Collection;
 use Illuminate\Database\Eloquent\Model;
 use RonasIT\Support\Traits\ModelTrait;
 
-//TODO: add @property annotation for each model's field
 /**
- * @property Collection<int, Category> $categories
+ * @property Collection<Category> $categories
  */
-class Post extends Model
+class WelcomeBonus extends Model
 {
     use ModelTrait;
 
+    public function getConnectionName(): string
+    {
+        return 'pgsql';
+    }
+
     protected $fillable = [
+        'title',
+        'name',
     ];
 
-    protected $hidden = ['pivot'];
+    public function some_relation()
+    {
+    }
 
     public function categories()
     {
         return $this->belongsToMany(Category::class);
     }
-}
+}