[203]: add model relations property annotations #208

neellii · 2025-10-16T06:31:00Z

refs: #203

Copilot

Pull Request Overview

This PR adds model relations property annotations to Laravel models by generating @property annotations for relationships. The implementation adds support for both single and collection-based relationships with appropriate type hints.

Adds @property annotations for model relationships in generated models
Imports Illuminate\Database\Eloquent\Collection when collection-type relations are present
Generates proper type hints for singular (Model|null) and plural (Collection|Model) relationships

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

File	Description
stubs/model.blade.php	Adds conditional import for Collection class when collection-type relations exist
src/Generators/ModelGenerator.php	Implements logic to generate relation annotations and determine Collection import necessity
tests/fixtures/ModelGeneratorTest/*.php	Test fixtures showing expected output with relation property annotations

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-16T08:23:33Z

src/Generators/ModelGenerator.php

+            foreach ($relations as $relation) {
+                $relation = class_basename($relation);
+
+                $result[$this->getRelationName($relation, $type)] = $this->getRelationType($relation, $type);


The method getRelationName() is being called but is not defined in this class. This will cause a fatal error when the code is executed.

DenTray · 2025-10-16T09:12:41Z

src/Generators/ModelGenerator.php

+    protected function getRelationType(string $relation, string $type): string
+    {
+        if (in_array($type, self::PLURAL_NUMBER_REQUIRED)) {
+            return "Collection|$relation";


Suggested change

return "Collection|$relation";

return "Collection<{$relation}>";

DenTray · 2025-10-16T09:28:09Z

src/Generators/ModelGenerator.php

+                $relation = class_basename($relation);
+
+                $result[$this->getRelationName($relation, $type)] = $this->getRelationType($relation, $type);


let's try to refactor it to prevent code duplication (the same logic already exists in the prepareRelations)

refs: #203

Copilot

Pull Request Overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated 4 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-20T06:38:54Z

tests/Support/Model/ModelMockTrait.php

-            'User.php' => file_get_contents(getcwd() . '/tests/Support/Models/WelcomeBonus.php'),
-            'Forum/Author.php' => file_get_contents(getcwd() . '/tests/Support/Models/WelcomeBonus.php'),
-        ];
+        if (!empty ($models)) {


Remove the space between !empty and the opening parenthesis. The correct syntax is !empty($models).

Suggested change

if (!empty ($models)) {

if (!empty($models)) {

Copilot · 2025-10-20T06:38:54Z

src/Generators/ModelGenerator.php

                    'entity' => $this->model,
                ]);

+//              TODO: use ronasit/larabuilder instead


Remove the extra spaces before the TODO comment. Use consistent indentation with // followed by a single space.

Suggested change

// TODO: use ronasit/larabuilder instead

// TODO: use ronasit/larabuilder instead

Copilot · 2025-10-20T06:38:54Z

src/Generators/ModelGenerator.php

        $import = "use {$import};";

        if (!Str::contains($classContent, $import)) {
+//          TODO: use ronasit/larabuilder instead


Remove the extra spaces before the TODO comment. Use consistent indentation with // followed by a single space.

Suggested change

// TODO: use ronasit/larabuilder instead

// TODO: use ronasit/larabuilder instead

Copilot · 2025-10-20T06:38:55Z

src/Generators/ModelGenerator.php

+    {
+        $annotation = "* @property {$propertyDataType} \${$propertyName}";
+
+//      TODO: use ronasit/larabuilder instead


Remove the extra spaces before the TODO comment. Use consistent indentation with // followed by a single space.

Suggested change

// TODO: use ronasit/larabuilder instead

// TODO: use ronasit/larabuilder instead

refs: #203

DenTray · 2025-10-23T12:44:33Z

src/Generators/ModelGenerator.php

+    protected function getRelationType(string $model, string $relation): string
+    {
+        if (in_array($relation, self::PLURAL_NUMBER_REQUIRED)) {
+            return "Collection<int, $model>";


Suggested change

return "Collection<int, $model>";

return "Collection<{$model}>";

DenTray · 2025-10-23T12:46:52Z

tests/fixtures/ModelGeneratorTest/new_model.php

 * @property Carbon $published_at
 * @property array $meta
+ * @property Comment|null $comment
+ * @property Collection<int, User> $users


Suggested change

* @property Collection<int, User> $users

* @property Collection<User> $users

DenTray · 2025-10-23T12:53:26Z

tests/fixtures/ModelGeneratorTest/new_model_with_many_relations.php


-//TODO: add @property annotation for each model's field
 /**
+ * @property Collection<int, User> $users


Suggested change

* @property Collection<int, User> $users

* @property Collection<User> $users

DenTray · 2025-10-23T12:53:42Z

tests/fixtures/ModelGeneratorTest/new_model_with_subfolers_relations.php


 /**
 * @property string $title
+ * @property Collection<int, Author> $authors


Suggested change

* @property Collection<int, Author> $authors

* @property Collection<Author> $authors

DenTray · 2025-10-23T12:54:02Z

tests/fixtures/ModelGeneratorTest/new_subfolders_model.php

 * @property Carbon $published_at
 * @property array $meta
+ * @property Comment|null $comment
+ * @property Collection<int, User> $users


Suggested change

* @property Collection<int, User> $users

* @property Collection<User> $users

DenTray · 2025-10-23T12:54:21Z

tests/fixtures/ModelGeneratorTest/related_model_with_property.php

+
+//TODO: add @property annotation for each model's field
+/**
+ * @property Collection<int, Category> $categories


Suggested change

* @property Collection<int, Category> $categories

* @property Collection<Category> $categories

DenTray · 2025-10-23T13:02:27Z

tests/ModelGeneratorTest.php

+    public function testAddPropertyAnnotationToRelatedModel()
+    {
+        $this->mockFilesystem([
+            'Post.php' => $this->getFixture('new_model_without_fields.php'),


may we just add the Post model to the mockFilesystem method?

DenTray · 2025-10-23T13:08:04Z

tests/Support/Model/ModelMockTrait.php

-    }
-
-    public function mockFilesystem(): void
+    public function mockFilesystem(array $models = []): void


let's implement it as separate methods

public function mockFilesystem(array $models = []): void

public function mockDefaultFilesystem(): void

@neellii @DenTray

public function mockFilesystem(array $models = []): void

Are you sure about this?

MB: public function mockFilesystem(array $models): void

refs: #203

AZabolotnikov · 2025-10-27T08:20:45Z

tests/Support/Model/ModelMockTrait.php

-    public function mockFilesystem(): void
+    public function mockFilesystem(array $models = []): void
    {
        $fileSystemMock = new FileSystemMock;


Suggested change

$fileSystemMock = new FileSystemMock;

$fileSystemMock = new FileSystemMock();

ref: https://www.php-fig.org/psr/psr-12/#4-classes-properties-and-methods

AZabolotnikov · 2025-10-27T08:20:55Z

tests/Support/Model/ModelMockTrait.php

+    public function mockDefaultFilesystem(): void
    {
-        $fileSystemMock = new FileSystemMock();
+        $fileSystemMock = new FileSystemMock;


Suggested change

$fileSystemMock = new FileSystemMock;

$fileSystemMock = new FileSystemMock();

ref: https://www.php-fig.org/psr/psr-12/#4-classes-properties-and-methods

refs: #203

Copilot

Pull Request Overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/Generators/ModelGenerator.php

Copilot · 2025-11-03T15:24:59Z

stubs/model.blade.php

-@foreach($anotationProperties as $key => $value)
- * @property {{ $value }} ${{ $key }}
+@foreach($annotationProperties as $key => $value)
+ * @property {!! $value !!} ${{ $key }}


[nitpick] Using unescaped output {!! !!} for the property value could be a security concern if the value contains malicious content. However, since this is a code generator and values come from controlled sources (the generator itself), this is acceptable. Consider adding a comment explaining why unescaped output is necessary here (to preserve type syntax like Collection<Model>).

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Ni Nelli added 2 commits October 16, 2025 15:29

feat: add model relations property annotations

9b5e4b4

refs: #203

chore: merge with master

8b1a21e

neellii assigned DenTray Oct 16, 2025

DenTray requested a review from Copilot October 16, 2025 08:23

Copilot AI reviewed Oct 16, 2025

View reviewed changes

neellii assigned neellii and unassigned DenTray Oct 16, 2025

DenTray requested changes Oct 16, 2025

View reviewed changes

refactor: add related models property annotations, remove duplicate code

4f8a534

refs: #203

neellii assigned DenTray and unassigned neellii Oct 17, 2025

chore: add TODO

48d2b8c

refs: #203

neellii assigned neellii and DenTray and unassigned DenTray and neellii Oct 20, 2025

DenTray requested a review from Copilot October 20, 2025 06:38

Merge branch 'master' into 203-relationships-annotation

63a88a9

Copilot AI reviewed Oct 20, 2025

View reviewed changes

neellii assigned neellii and unassigned DenTray Oct 23, 2025

Ni Nelli added 2 commits October 23, 2025 13:51

style: minor fixes

5e293d2

refs: #203

chore: merge with origin

c928e1b

neellii assigned DenTray and unassigned neellii Oct 23, 2025

Merge branch 'master' into 203-relationships-annotation

c3c6115

DenTray requested changes Oct 23, 2025

View reviewed changes

DenTray assigned neellii and unassigned DenTray Oct 23, 2025

refactor: fix model relation type, separate methods in ModelMockTrait

caf1c8c

refs: #203

chore: merge with origin

484b184

neellii assigned DenTray, neellii and AZabolotnikov and unassigned neellii and DenTray Oct 24, 2025

AZabolotnikov reviewed Oct 27, 2025

View reviewed changes

AZabolotnikov assigned DenTray and neellii and unassigned AZabolotnikov and DenTray Oct 27, 2025

refactor: style fixes, remove redundant code

21dd8aa

refs: #203

neellii assigned AZabolotnikov and unassigned neellii Oct 28, 2025

AZabolotnikov assigned DenTray and unassigned AZabolotnikov Oct 28, 2025

Merge branch 'master' into 203-relationships-annotation

569c284

DenTray requested a review from Copilot November 3, 2025 15:22

Copilot AI reviewed Nov 3, 2025

View reviewed changes

DenTray and others added 2 commits November 3, 2025 21:35

Apply suggestion from @Copilot

21ef6ff

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Apply suggestion from @Copilot

69628d2

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

DenTray approved these changes Nov 3, 2025

View reviewed changes

DenTray merged commit 55a07ef into master Nov 3, 2025
4 checks passed

DenTray deleted the 203-relationships-annotation branch November 3, 2025 15:46

	return "Collection\|$relation";
	return "Collection<{$relation}>";

		$relation = class_basename($relation);

		$result[$this->getRelationName($relation, $type)] = $this->getRelationType($relation, $type);

	// TODO: use ronasit/larabuilder instead
	// TODO: use ronasit/larabuilder instead

	return "Collection<int, $model>";
	return "Collection<{$model}>";

	* @property Collection<int, User> $users
	* @property Collection<User> $users

	* @property Collection<int, Author> $authors
	* @property Collection<Author> $authors

	* @property Collection<int, Category> $categories
	* @property Collection<Category> $categories

	$fileSystemMock = new FileSystemMock;
	$fileSystemMock = new FileSystemMock();

[203]: add model relations property annotations #208

[203]: add model relations property annotations #208

Uh oh!

Conversation

neellii commented Oct 16, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Oct 16, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AZabolotnikov Oct 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI Nov 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

AZabolotnikov Oct 27, 2025 •

edited

Loading