tests: fix types in stubs

Author: JaZo

tests/_mocks/ItemStub.php

@@ -8,8 +8,14 @@
 
 class ItemStub extends Item
 {
+    /**
+     * @var array<int, string>
+     */
     protected $hidden = ['password'];
 
+    /**
+     * @var array<string, string>
+     */
     protected $casts = [
         'age' => 'integer',
         'score' => 'float',
@@ -25,10 +31,16 @@ class ItemStub extends Item
         'foo' => 'bar',
     ];
 
+    /**
+     * @var array<int, string>
+     */
     protected $guarded = [
         'secret',
     ];
 
+    /**
+     * @var array<int, string>
+     */
     protected $fillable = [
         'name',
         'city',
@@ -42,34 +54,46 @@ class ItemStub extends Item
         'collection_data',
     ];
 
-    public function getListItemsAttribute($value)
+    /**
+     * @return array<int, string>
+     */
+    public function getListItemsAttribute(string $value): array
     {
-        return json_decode($value, true);
+        $result = json_decode($value, true);
+        assert(is_array($result));
+
+        /** @var array<int, string> $result */
+        return $result;
     }
 
-    public function setListItemsAttribute($value)
+    /**
+     * @param  array<int, string>  $value
+     */
+    public function setListItemsAttribute(array $value): void
     {
         $this->attributes['list_items'] = json_encode($value);
     }
 
-    public function setBirthdayAttribute($value)
+    public function setBirthdayAttribute(string $value): void
     {
         $this->attributes['birthday'] = strtotime($value);
     }
 
-    public function getBirthdayAttribute($value)
+    public function getBirthdayAttribute(int $value): string
     {
         return date('Y-m-d', $value);
     }
 
-    public function getAgeAttribute($value)
+    public function getAgeAttribute(mixed $value): int
     {
+        assert(is_int($this->attributes['birthday']));
         $date = \DateTime::createFromFormat('U', (string) $this->attributes['birthday']);
+        assert($date instanceof \DateTime);
 
         return $date->diff(new \DateTime('now'))->y;
     }
 
-    public function getTestAttribute($value)
+    public function getTestAttribute(mixed $value): string
     {
         return 'test';
     }

tests/_mocks/Items/AnotherRelatedItem.php

@@ -8,13 +8,10 @@
 
 class AnotherRelatedItem extends Item
 {
-    /**
-     * @var string
-     */
     protected $type = 'another-related-item';
 
     /**
-     * @var array
+     * @var array<int, string>
      */
     protected $visible = [
         'test_related_attribute1',

tests/_mocks/Items/ChildItem.php

@@ -8,26 +8,26 @@
 
 class ChildItem extends Item
 {
-    /**
-     * @var string
-     */
     protected $type = 'child';
 
     /**
-     * @var array
+     * @var array<int, string>
      */
     protected $visible = [
         'active',
         'description',
     ];
 
     /**
-     * @var array
+     * @var array<string, string>
      */
     protected $casts = [
         'active' => 'bool',
     ];
 
+    /**
+     * @var array<string, mixed>
+     */
     protected $attributes = [
         'active' => true,
     ];

tests/_mocks/Items/ParentItem.php

@@ -4,17 +4,16 @@
 
 namespace Swis\JsonApi\Client\Tests\Mocks\Items;
 
+use Swis\JsonApi\Client\Interfaces\ManyRelationInterface;
+use Swis\JsonApi\Client\Interfaces\OneRelationInterface;
 use Swis\JsonApi\Client\Item;
 
 class ParentItem extends Item
 {
-    /**
-     * @var string
-     */
     protected $type = 'parent';
 
     /**
-     * @var array
+     * @var array<int, string>
      */
     protected $visible = [
         'active',
@@ -23,21 +22,21 @@ class ParentItem extends Item
     ];
 
     /**
-     * @var array
+     * @var array<string, string>
      */
     protected $casts = [
         'active' => 'bool',
     ];
 
     /**
-     * @var array
+     * @var array<string, mixed>
      */
     protected $attributes = [
         'active' => true,
     ];
 
     /**
-     * @var array
+     * @var array<int, string>
      */
     protected $availableRelations = [
         'child',
@@ -47,27 +46,42 @@ class ParentItem extends Item
         'does_not_exist',
     ];
 
-    public function child()
+    /**
+     * @return \Swis\JsonApi\Client\Interfaces\OneRelationInterface<\Swis\JsonApi\Client\Tests\Mocks\Items\ChildItem>
+     */
+    public function child(): OneRelationInterface
     {
         return $this->hasOne(ChildItem::class);
     }
 
-    public function children()
+    /**
+     * @return \Swis\JsonApi\Client\Interfaces\ManyRelationInterface<\Swis\JsonApi\Client\Tests\Mocks\Items\ChildItem>
+     */
+    public function children(): ManyRelationInterface
     {
         return $this->hasMany(ChildItem::class);
     }
 
-    public function morph()
+    /**
+     * @return \Swis\JsonApi\Client\Interfaces\OneRelationInterface<\Swis\JsonApi\Client\Interfaces\ItemInterface>
+     */
+    public function morph(): OneRelationInterface
     {
         return $this->morphTo();
     }
 
-    public function morphmany()
+    /**
+     * @return \Swis\JsonApi\Client\Interfaces\ManyRelationInterface<\Swis\JsonApi\Client\Interfaces\ItemInterface>
+     */
+    public function morphmany(): ManyRelationInterface
     {
         return $this->morphToMany();
     }
 
-    public function empty()
+    /**
+     * @return \Swis\JsonApi\Client\Interfaces\OneRelationInterface<\Swis\JsonApi\Client\Tests\Mocks\Items\ChildItem>
+     */
+    public function empty(): OneRelationInterface
     {
         return $this->hasOne(ChildItem::class);
     }

tests/_mocks/Items/RelatedItem.php

@@ -4,31 +4,32 @@
 
 namespace Swis\JsonApi\Client\Tests\Mocks\Items;
 
+use Swis\JsonApi\Client\Interfaces\OneRelationInterface;
 use Swis\JsonApi\Client\Item;
 
 class RelatedItem extends Item
 {
-    /**
-     * @var string
-     */
     protected $type = 'related-item';
 
     /**
-     * @var array
+     * @var array<int, string>
      */
     protected $visible = [
         'test_related_attribute1',
         'test_related_attribute2',
     ];
 
     /**
-     * @var array
+     * @var array<int, string>
      */
     protected $availableRelations = [
         'parent_relation',
     ];
 
-    public function parentRelation()
+    /**
+     * @return \Swis\JsonApi\Client\Interfaces\OneRelationInterface<\Swis\JsonApi\Client\Tests\Mocks\Items\WithRelationshipItem>
+     */
+    public function parentRelation(): OneRelationInterface
     {
         return $this->hasOne(WithRelationshipItem::class);
     }

tests/_mocks/Items/WithHiddenItem.php

@@ -8,6 +8,9 @@
 
 class WithHiddenItem extends Item
 {
+    /**
+     * @var array<int, string>
+     */
     protected $hidden = [
         'testKey',
     ];

tests/_mocks/Items/WithRelationshipItem.php

@@ -4,25 +4,24 @@
 
 namespace Swis\JsonApi\Client\Tests\Mocks\Items;
 
+use Swis\JsonApi\Client\Interfaces\ManyRelationInterface;
+use Swis\JsonApi\Client\Interfaces\OneRelationInterface;
 use Swis\JsonApi\Client\Item;
 
 class WithRelationshipItem extends Item
 {
-    /**
-     * @var string
-     */
     protected $type = 'item-with-relationship';
 
     /**
-     * @var array
+     * @var array<int, string>
      */
     protected $visible = [
         'test_attribute_1',
         'test_attribute_2',
     ];
 
     /**
-     * @var array
+     * @var array<int, string>
      */
     protected $availableRelations = [
         'hasone_relation',
@@ -31,22 +30,34 @@ class WithRelationshipItem extends Item
         'morphtomany_relation',
     ];
 
-    public function hasoneRelation()
+    /**
+     * @return \Swis\JsonApi\Client\Interfaces\OneRelationInterface<\Swis\JsonApi\Client\Tests\Mocks\Items\RelatedItem>
+     */
+    public function hasoneRelation(): OneRelationInterface
     {
         return $this->hasOne(RelatedItem::class);
     }
 
-    public function hasmanyRelation()
+    /**
+     * @return \Swis\JsonApi\Client\Interfaces\ManyRelationInterface<\Swis\JsonApi\Client\Tests\Mocks\Items\RelatedItem>
+     */
+    public function hasmanyRelation(): ManyRelationInterface
     {
         return $this->hasMany(RelatedItem::class);
     }
 
-    public function morphtoRelation()
+    /**
+     * @return \Swis\JsonApi\Client\Interfaces\OneRelationInterface<\Swis\JsonApi\Client\Interfaces\ItemInterface>
+     */
+    public function morphtoRelation(): OneRelationInterface
     {
         return $this->morphTo();
     }
 
-    public function morphtomanyRelation()
+    /**
+     * @return \Swis\JsonApi\Client\Interfaces\ManyRelationInterface<\Swis\JsonApi\Client\Interfaces\ItemInterface>
+     */
+    public function morphtomanyRelation(): ManyRelationInterface
     {
         return $this->morphToMany();
     }

tests/_mocks/Items/WithoutRelationshipsItem.php

@@ -8,8 +8,5 @@
 
 class WithoutRelationshipsItem extends Item
 {
-    /**
-     * @var string
-     */
     protected $type = 'item-without-relationships';
 }

tests/_mocks/MockRepository.php

@@ -6,6 +6,9 @@
 
 use Swis\JsonApi\Client\Repository;
 
+/**
+ * @implements \Swis\JsonApi\Client\Interfaces\RepositoryInterface<\Swis\JsonApi\Client\Tests\Mocks\ItemStub>
+ */
 class MockRepository extends Repository
 {
     protected $endpoint = 'mocks';