Improved attribute handling with types and Attribute support (#1567)

* Add `AllowDynamicProperties` Attribute to cooperate with php8.2 deprecation

* lint snapshot

* Fix collection attribute typing

* Update CHANGELOG.md

* Update CHANGELOG.md

* Update CHANGELOG.md

* Update composer.json

* Fix collectino with template types WIP

* Add `AllowDynamicProperties` Attribute to cooperate with php8.2 deprecation

* Fix collection attribute typing

* Update CHANGELOG.md

* Update CHANGELOG.md

* Update composer.json

* composer fix-style

* Fix tests

* Fix tests

* composer fix-style

* Fix collectino with complex template types{

* Delete phpactor

* Install from scrumble repo

* Implemented correct attribute handling

* composer fix-style

* Revert "Install from scrumble repo"

This reverts commit 3f1057adb6.

* Re-add barryvdh links

* Revert "Update composer.json"

This reverts commit 98252fe740.

* Fix pivot test

* Correct CHANGELOG.md with attribute merge request

* More clear PhpDocTypeParser filename and clarified directory according to PSR12

---------

Co-authored-by: GeoSot <[email protected]>
Co-authored-by: laravel-ide-helper <[email protected]>
Co-authored-by: Luukdewaaier <[email protected]>
Co-authored-by: Luuk de Weijer <[email protected]>

CHANGELOG.md

@@ -13,6 +13,13 @@ All notable changes to this project will be documented in this file.
 ### Added
  - Add type to pivot when using a custom pivot class [#1518 / d3v2a](https://github.com/barryvdh/laravel-ide-helper/pull/1518)
 
+2024-01-04, v3.1.0
+------------------
+
+### Fixes
+
+- Fix for getSomethingAttribute functions which return a collection with type templating in the phpDoc. And support for Attribute class in attributes https://github.com/barryvdh/laravel-ide-helper/pull/1567
+
 2024-03-01, 3.0.0
 ------------------
 

src/Console/ModelsCommand.php

@@ -12,6 +12,7 @@
 namespace Barryvdh\LaravelIdeHelper\Console;
 
 use Barryvdh\LaravelIdeHelper\Contracts\ModelHookInterface;
+use Barryvdh\LaravelIdeHelper\Parsers\PhpDocReturnTypeParser;
 use Barryvdh\Reflection\DocBlock;
 use Barryvdh\Reflection\DocBlock\Context;
 use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
@@ -196,7 +197,7 @@ class ModelsCommand extends Command
     protected function getArguments()
     {
         return [
-          ['model', InputArgument::OPTIONAL | InputArgument::IS_ARRAY, 'Which models to include', []],
+            ['model', InputArgument::OPTIONAL | InputArgument::IS_ARRAY, 'Which models to include', []],
         ];
     }
 
@@ -208,20 +209,21 @@ class ModelsCommand extends Command
     protected function getOptions()
     {
         return [
-          ['filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the helper file'],
-          ['dir', 'D', InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY,
-              'The model dir, supports glob patterns', [], ],
-          ['write', 'W', InputOption::VALUE_NONE, 'Write to Model file'],
-          ['write-mixin', 'M', InputOption::VALUE_NONE,
-              "Write models to {$this->filename} and adds @mixin to each model, avoiding IDE duplicate declaration warnings",
-          ],
-          ['nowrite', 'N', InputOption::VALUE_NONE, 'Don\'t write to Model file'],
-          ['reset', 'R', InputOption::VALUE_NONE, 'Refresh the properties/methods list, but keep the text'],
-          ['phpstorm-noinspections', 'p', InputOption::VALUE_NONE,
-              'Add PhpFullyQualifiedNameUsageInspection and PhpUnnecessaryFullyQualifiedNameInspection PHPStorm ' .
-              'noinspection tags',
-          ],
-          ['ignore', 'I', InputOption::VALUE_OPTIONAL, 'Which models to ignore', ''],
+            ['filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the helper file'],
+            ['dir', 'D', InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY,
+                'The model dir, supports glob patterns', [], ],
+            ['write', 'W', InputOption::VALUE_NONE, 'Write to Model file'],
+            ['write-mixin', 'M', InputOption::VALUE_NONE,
+                "Write models to {$this->filename} and adds @mixin to each model, avoiding IDE duplicate declaration warnings",
+            ],
+            ['nowrite', 'N', InputOption::VALUE_NONE, 'Don\'t write to Model file'],
+            ['reset', 'R', InputOption::VALUE_NONE, 'Remove the original phpdocs instead of appending'],
+            ['smart-reset', 'r', InputOption::VALUE_NONE, 'Refresh the properties/methods list, but keep the text'],
+            ['phpstorm-noinspections', 'p', InputOption::VALUE_NONE,
+                'Add PhpFullyQualifiedNameUsageInspection and PhpUnnecessaryFullyQualifiedNameInspection PHPStorm ' .
+                'noinspection tags',
+            ],
+            ['ignore', 'I', InputOption::VALUE_OPTIONAL, 'Which models to ignore', ''],
         ];
     }
 
@@ -580,10 +582,7 @@ class ModelsCommand extends Command
                 $isAttribute = is_a($type, '\Illuminate\Database\Eloquent\Casts\Attribute', true);
                 $method = $reflection->getName();
                 if (
-                    Str::startsWith($method, 'get') && Str::endsWith(
-                        $method,
-                        'Attribute'
-                    ) && $method !== 'getAttribute'
+                    Str::startsWith($method, 'get') && Str::endsWith($method, 'Attribute') && $method !== 'getAttribute'
                 ) {
                     //Magic get<name>Attribute
                     $name = Str::snake(substr($method, 3, -9));
@@ -599,15 +598,14 @@ class ModelsCommand extends Command
                     $this->setProperty(
                         Str::snake($method),
                         $type,
-                        $types->has('get'),
-                        $types->has('set'),
+                        $types->has('get') ?: null,
+                        $types->has('set') ?: null,
                         $this->getCommentFromDocBlock($reflection)
                     );
                 } elseif (
-                    Str::startsWith($method, 'set') && Str::endsWith(
-                        $method,
-                        'Attribute'
-                    ) && $method !== 'setAttribute'
+                    Str::startsWith($method, 'set') &&
+                    Str::endsWith($method, 'Attribute') &&
+                    $method !== 'setAttribute'
                 ) {
                     //Magic set<name>Attribute
                     $name = Str::snake(substr($method, 3, -9));
@@ -628,7 +626,7 @@ class ModelsCommand extends Command
                             get_class($model->newModelQuery())
                         );
                         $modelName = $this->getClassNameInDestinationFile(
-                            new \ReflectionClass($model),
+                            new ReflectionClass($model),
                             get_class($model)
                         );
                         $this->setMethod($name, $builder . '|' . $modelName, $args, $comment);
@@ -712,10 +710,10 @@ class ModelsCommand extends Command
                                 ) {
                                     if ($relationObj instanceof BelongsToMany) {
                                         $pivot = get_class($relationObj->newPivot());
-                                        if (!in_array($pivot,[ Pivot::class, MorphPivot::class])) {
+                                        if (!in_array($pivot, [Pivot::class, MorphPivot::class])) {
                                             $this->setProperty(
                                                 $relationObj->getPivotAccessor(),
-                                                $this->getClassNameInDestinationFile($model,$pivot),
+                                                $this->getClassNameInDestinationFile($model, $pivot),
                                                 true,
                                                 false
                                             );
@@ -1249,6 +1247,13 @@ class ModelsCommand extends Command
         $phpdoc = new DocBlock($reflection, $context);
 
         if ($phpdoc->hasTag('return')) {
+            $returnTag = $phpdoc->getTagsByName('return')[0];
+
+            $typeParser = new PhpDocReturnTypeParser($returnTag->getContent(), $context->getNamespaceAliases());
+            if ($typeAlias = $typeParser->parse()) {
+                return $typeAlias;
+            }
+
             $type = $phpdoc->getTagsByName('return')[0]->getType();
         }
 

src/Parsers/PhpDocReturnTypeParser.php

@@ -0,0 +1,79 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Parsers;
+
+class PhpDocReturnTypeParser
+{
+    /**
+     * @var string
+     */
+    private string $typeAlias;
+
+    /**
+     * @var array
+     */
+    private array $namespaceAliases;
+
+    /**
+     * @param string $typeAlias
+     * @param array $namespaceAliases
+     */
+    public function __construct(string $typeAlias, array $namespaceAliases)
+    {
+        $this->typeAlias = $typeAlias;
+        $this->namespaceAliases = $namespaceAliases;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function parse(): string|null
+    {
+        $matches = [];
+        preg_match('/(\w+)(<.*>)/', $this->typeAlias, $matches);
+        $matchCount = count($matches);
+
+        if ($matchCount === 0 || $matchCount === 1) {
+            return null;
+        }
+
+        if (empty($this->namespaceAliases[$matches[1]])) {
+            return null;
+        }
+
+        return $this->namespaceAliases[$matches[1]] . $this->parseTemplate($matches[2] ?? null);
+    }
+
+    /**
+     * @param string|null $template
+     * @return string
+     */
+    private function parseTemplate(string|null $template): string
+    {
+        if ($template  === null || $template === '') {
+            return '';
+        }
+
+        $type = '';
+        $result = '';
+
+        foreach (str_split($template) as $char) {
+            $match = preg_match('/[A-z]/', $char);
+
+            if (!$match) {
+                $type = $this->namespaceAliases[$type] ?? $type;
+                $result .= $type;
+                $result .= $char;
+                $type = '';
+
+                continue;
+            }
+
+            $type .= $char;
+        }
+
+        return $result;
+    }
+}

tests/Console/ModelsCommand/Attributes/Models/BackedAttribute.php

@@ -0,0 +1,59 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Attributes\Models;
+
+use Illuminate\Database\Eloquent\Casts\Attribute;
+use Illuminate\Database\Eloquent\Model;
+
+class BackedAttribute extends Model
+{
+    protected function name(): Attribute
+    {
+        return new Attribute(
+            function (?string $name): ?string {
+                return $name;
+            },
+            function (?string $name): ?string {
+                return $name;
+            }
+        );
+    }
+
+    protected function nameRead(): Attribute
+    {
+        return new Attribute(
+            function (?string $name): ?string {
+                return $name;
+            },
+        );
+    }
+
+    protected function nameWrite(): Attribute
+    {
+        return new Attribute(
+            set: function (?string $name): ?string {
+                return $name;
+            },
+        );
+    }
+
+    protected function nonBackedSet(): Attribute
+    {
+        return new Attribute(
+            set: function (?string $name): ?string {
+                return $name;
+            },
+        );
+    }
+
+    protected function nonBackedGet(): Attribute
+    {
+        return new Attribute(
+            get: function (): ?string {
+                return 'test';
+            },
+        );
+    }
+}

tests/Console/ModelsCommand/Attributes/__snapshots__/Test__test__1.php

@@ -7,6 +7,83 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Attributes\Model
 use Illuminate\Database\Eloquent\Casts\Attribute;
 use Illuminate\Database\Eloquent\Model;
 
+/**
+ * 
+ *
+ * @property int $id
+ * @property string|null $name
+ * @property string|null $name_read
+ * @property string|null $name_write
+ * @property-read string|null $non_backed_get
+ * @property-write string|null $non_backed_set
+ * @method static \Illuminate\Database\Eloquent\Builder|BackedAttribute newModelQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder|BackedAttribute newQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder|BackedAttribute query()
+ * @method static \Illuminate\Database\Eloquent\Builder|BackedAttribute whereId($value)
+ * @method static \Illuminate\Database\Eloquent\Builder|BackedAttribute whereName($value)
+ * @method static \Illuminate\Database\Eloquent\Builder|BackedAttribute whereNameRead($value)
+ * @method static \Illuminate\Database\Eloquent\Builder|BackedAttribute whereNameWrite($value)
+ * @mixin \Eloquent
+ */
+class BackedAttribute extends Model
+{
+    protected function name(): Attribute
+    {
+        return new Attribute(
+            function (?string $name): ?string {
+                return $name;
+            },
+            function (?string $name): ?string {
+                return $name;
+            }
+        );
+    }
+
+    protected function nameRead(): Attribute
+    {
+        return new Attribute(
+            function (?string $name): ?string {
+                return $name;
+            },
+        );
+    }
+
+    protected function nameWrite(): Attribute
+    {
+        return new Attribute(
+            set: function (?string $name): ?string {
+                return $name;
+            },
+        );
+    }
+
+    protected function nonBackedSet(): Attribute
+    {
+        return new Attribute(
+            set: function (?string $name): ?string {
+                return $name;
+            },
+        );
+    }
+
+    protected function nonBackedGet(): Attribute
+    {
+        return new Attribute(
+            get: function (): ?string {
+                return 'test';
+            },
+        );
+    }
+}
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Attributes\Models;
+
+use Illuminate\Database\Eloquent\Casts\Attribute;
+use Illuminate\Database\Eloquent\Model;
+
 /**
  * 
  *

tests/Console/ModelsCommand/GenerateMixinCollection/Models/WithCollection.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateMixinCollection\Models;
+
+use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateMixinCollection\NonModels\CollectionModel;
+use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateMixinCollection\NonModels\NonModel;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Collection;
+use Illuminate\Support\Collection as IntCollection;
+
+class WithCollection extends Model
+{
+    /**
+     * @return Collection<int, string>
+     */
+    public function getCollectionAttribute(): Collection
+    {
+        return new Collection();
+    }
+
+    /**
+     * @return Collection
+     */
+    public function getCollectionWithoutTemplateAttribute(): Collection
+    {
+        return new Collection();
+    }
+
+    public function getCollectionWithoutDocBlockAttribute(): Collection
+    {
+        return new Collection();
+    }
+
+    /**
+     * @return Collection<int, NonModel>
+     */
+    public function getCollectionWithNonModelTemplateAttribute(): Collection
+    {
+        return new Collection();
+    }
+
+    /**
+     * @return Collection<Collection, CollectionModel<IntCollection, CollectionModel<int, NonModel>>>
+     */
+    public function getCollectionWithNestedTemplateAttribute(): Collection
+    {
+        return new Collection();
+    }
+}

tests/Console/ModelsCommand/GenerateMixinCollection/NonModels/CollectionModel.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateMixinCollection\NonModels;
+
+class CollectionModel
+{
+}

tests/Console/ModelsCommand/GenerateMixinCollection/NonModels/NonModel.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateMixinCollection\NonModels;
+
+class NonModel
+{
+}

tests/Console/ModelsCommand/GenerateMixinCollection/Test.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateMixinCollection;
+
+use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
+use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
+
+class Test extends AbstractModelsCommand
+{
+    public function test(): void
+    {
+        $command = $this->app->make(ModelsCommand::class);
+
+        $tester = $this->runCommand($command, [
+            '--write-mixin' => true,
+        ]);
+
+        $this->assertSame(0, $tester->getStatusCode());
+        $this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
+        $this->assertMatchesMockedSnapshot();
+    }
+}

tests/Console/ModelsCommand/GenerateMixinCollection/__snapshots__/Test__test__1.php

@@ -0,0 +1,85 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateMixinCollection\Models;
+
+use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateMixinCollection\NonModels\CollectionModel;
+use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateMixinCollection\NonModels\NonModel;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Collection;
+use Illuminate\Support\Collection as IntCollection;
+
+/**
+ * @mixin IdeHelperWithCollection
+ */
+class WithCollection extends Model
+{
+    /**
+     * @return Collection<int, string>
+     */
+    public function getCollectionAttribute(): Collection
+    {
+        return new Collection();
+    }
+
+    /**
+     * @return Collection
+     */
+    public function getCollectionWithoutTemplateAttribute(): Collection
+    {
+        return new Collection();
+    }
+
+    public function getCollectionWithoutDocBlockAttribute(): Collection
+    {
+        return new Collection();
+    }
+
+    /**
+     * @return Collection<int, NonModel>
+     */
+    public function getCollectionWithNonModelTemplateAttribute(): Collection
+    {
+        return new Collection();
+    }
+
+    /**
+     * @return Collection<Collection, CollectionModel<IntCollection, CollectionModel<int, NonModel>>>
+     */
+    public function getCollectionWithNestedTemplateAttribute(): Collection
+    {
+        return new Collection();
+    }
+}
+<?php
+
+// @formatter:off
+// phpcs:ignoreFile
+/**
+ * A helper file for your Eloquent Models
+ * Copy the phpDocs from this file to the correct Model,
+ * And remove them from this file, to prevent double declarations.
+ *
+ * @author Barry vd. Heuvel <[email protected]>
+ */
+
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateMixinCollection\Models{
+/**
+ * 
+ *
+ * @property-read \Illuminate\Support\Collection<int, string> $collection
+ * @property-read \Illuminate\Support\Collection<\Illuminate\Support\Collection, \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateMixinCollection\NonModels\CollectionModel<\Illuminate\Support\Collection, \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateMixinCollection\NonModels\CollectionModel<int, \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateMixinCollection\NonModels\NonModel>>> $collection_with_nested_template
+ * @property-read \Illuminate\Support\Collection<int, \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateMixinCollection\NonModels\NonModel> $collection_with_non_model_template
+ * @property-read \Illuminate\Support\Collection $collection_without_doc_block
+ * @property-read \Illuminate\Support\Collection $collection_without_template
+ * @method static \Illuminate\Database\Eloquent\Builder|WithCollection newModelQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder|WithCollection newQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder|WithCollection query()
+ * @mixin \Eloquent
+ */
+	#[\AllowDynamicProperties]
+	class IdeHelperWithCollection {}
+}
+

tests/Console/ModelsCommand/Pivot/Models/ModelWithPivot.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Pivot\Models;
 
 use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Pivot\Models\Pivots\CustomPivot;

tests/Console/ModelsCommand/Pivot/Models/Pivots/CustomPivot.php

@@ -1,10 +1,11 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Pivot\Models\Pivots;
 
 use Illuminate\Database\Eloquent\Relations\Pivot;
 
 class CustomPivot extends Pivot
 {
-
 }

tests/Console/ModelsCommand/Pivot/Test.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Pivot;
 
 use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;

tests/Console/ModelsCommand/Pivot/__snapshots__/Test__test__1.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Pivot\Models;
 
 use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Pivot\Models\Pivots\CustomPivot;
@@ -27,6 +29,8 @@ class ModelWithPivot extends Model
 }
 <?php
 
+declare(strict_types=1);
+
 namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Pivot\Models\Pivots;
 
 use Illuminate\Database\Eloquent\Relations\Pivot;
@@ -41,5 +45,4 @@ use Illuminate\Database\Eloquent\Relations\Pivot;
  */
 class CustomPivot extends Pivot
 {
-
 }

tests/Console/ModelsCommand/migrations/____backed_attribute_table.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class BackedAttributeTable extends Migration
+{
+    public function up(): void
+    {
+        Schema::create('backed_attributes', function (Blueprint $table) {
+            $table->bigIncrements('id');
+            $table->string('name');
+            $table->string('name_read');
+            $table->string('name_write');
+        });
+    }
+}