Merge pull request #9 from Riley19280/model-traits

Add Trait information to model info

composer.json

@@ -28,8 +28,9 @@
         "pestphp/pest": "^1.21",
         "pestphp/pest-plugin-laravel": "^1.1",
         "phpunit/phpunit": "^9.5",
-        "spatie/pest-plugin-snapshots": "^1.1"}
-,
+        "spatie/pest-plugin-snapshots": "^1.1",
+        "symfony/serializer": "^6"
+    },
     "autoload": {
         "psr-4": {
             "Spatie\\ModelInfo\\": "src"

src/ModelInfo.php

@@ -50,6 +50,7 @@ public static function forModel(string|Model|ReflectionClass $model): self
             $model->getConnection()->getTablePrefix().$model->getTable(),
             RelationFinder::forModel($model),
             AttributeFinder::forModel($model),
+            self::getTraits($model),
             self::getExtraModelInfo($model),
         );
     }
@@ -61,6 +62,7 @@ public function __construct(
         public string $tableName,
         public Collection $relations,
         public Collection $attributes,
+        public Collection $traits,
         public mixed $extra = null,
     ) {
     }
@@ -74,6 +76,11 @@ protected static function getExtraModelInfo(Model $model): mixed
         return null;
     }
 
+    protected static function getTraits(Model $model): Collection
+    {
+        return collect(array_values(class_uses($model)));
+    }
+
     public function toArray(): array
     {
         $properties = get_object_vars($this);

tests/ModelFinderTest.php

@@ -7,6 +7,7 @@
 use Spatie\ModelInfo\Tests\TestSupport\Models\Nested\Model\NestedModel;
 use Spatie\ModelInfo\Tests\TestSupport\Models\RelationTestModel;
 use Spatie\ModelInfo\Tests\TestSupport\Models\TestModel;
+use Spatie\ModelInfo\Tests\TestSupport\Models\TraitTestModel;
 
 it('can discover all models in a directory', function () {
     $models = ModelFinder::all(
@@ -15,12 +16,13 @@
         "Spatie\ModelInfo\Tests",
     );
 
-    expect($models)->toHaveCount(4);
+    expect($models)->toHaveCount(5);
 
     expect($models->toArray())->toEqualCanonicalizing([
         NestedModel::class,
         ExtraModelInfoModel::class,
         RelationTestModel::class,
         TestModel::class,
+        TraitTestModel::class,
     ]);
 });

tests/ModelInfoTest.php

@@ -5,6 +5,8 @@
 use Spatie\ModelInfo\ModelInfo;
 use Spatie\ModelInfo\Tests\TestSupport\Models\ExtraModelInfoModel;
 use Spatie\ModelInfo\Tests\TestSupport\Models\RelationTestModel;
+use Spatie\ModelInfo\Tests\TestSupport\Models\TraitTestModel;
+use Spatie\ModelInfo\Tests\TestSupport\Traits\TestTrait;
 
 it('can get meta information about a model', function () {
     $modelInfo = ModelInfo::forModel(RelationTestModel::class);
@@ -23,7 +25,7 @@
         "Spatie\ModelInfo\Tests",
     );
 
-    expect($modelInfo)->toHaveCount(4);
+    expect($modelInfo)->toHaveCount(5);
     expect($modelInfo->first())->toBeInstanceOf(ModelInfo::class);
 });
 
@@ -33,6 +35,12 @@
     expect($modelInfo->extra)->toBe('extra info');
 });
 
+it('can get traits from a model', function () {
+    $modelInfo = ModelInfo::forModel(TraitTestModel::class);
+
+    expect($modelInfo->traits->first())->toBe(TestTrait::class);
+});
+
 it('can get a specific attribute', function () {
     $modelInfo = ModelInfo::forModel(RelationTestModel::class);
 

tests/TestSupport/Models/TraitTestModel.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Spatie\ModelInfo\Tests\TestSupport\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use Spatie\ModelInfo\Tests\TestSupport\Traits\TestTrait;
+
+class TraitTestModel extends Model
+{
+    use TestTrait;
+}

tests/TestSupport/Traits/TestTrait.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Spatie\ModelInfo\Tests\TestSupport\Traits;
+
+trait TestTrait
+{
+}

tests/__snapshots__/ModelInfoTest__it_can_get_meta_information_about_a_model__1.yml

@@ -9,4 +9,5 @@ attributes:
     - { name: name, phpType: string, type: string, increments: false, nullable: false, default: null, primary: false, unique: false, fillable: false, appended: null, cast: null, virtual: false }
     - { name: created_at, phpType: DateTime, type: datetime, increments: false, nullable: true, default: null, primary: false, unique: false, fillable: false, appended: null, cast: datetime, virtual: false }
     - { name: updated_at, phpType: DateTime, type: datetime, increments: false, nullable: true, default: null, primary: false, unique: false, fillable: false, appended: null, cast: datetime, virtual: false }
+traits: {  }
 extra: null