Refactor name(space) of JenssegersItem to Item

Author: JaZo

README.MD

@@ -128,7 +128,7 @@ The `DocumentClient` follows the following steps internally:
  1. Send the request using your HTTP client;
  2. Use [art4/json-api-client](https://github.com/art4/json-api-client) to parse and validate the response;
  3. Create the correct document instance;
- 4. Hydrate every item by using the item model registered with the `TypeMapper` or a `JenssegersItem` as fallback;
+ 4. Hydrate every item by using the item model registered with the `TypeMapper` or a `\Swis\JsonApi\Client\Item` as fallback;
  5. Hydrate all relationships;
  6. Add meta data to the document such as [errors](http://jsonapi.org/format/#errors), [links](http://jsonapi.org/format/#document-links) and [meta](http://jsonapi.org/format/#document-meta).
 
@@ -139,22 +139,20 @@ It can take everything your request factory takes as input data and returns the
 It does not parse or validate the response or hydrate items!
 
 
-## Item models
+## Items
 
-By default, all items are an instance of `JenssegersItem`.
-You can define your own models by extending the `JenssegersItem` or by implementing the `\Swis\JsonApi\Client\Interfaces\ItemInterface` yourself.
+By default, all items are an instance of `\Swis\JsonApi\Client\Item`.
+The `Item` extends [jenssegers/model](https://github.com/jenssegers/model), which provides a Laravel Eloquent-like base class.
+Please see it's documentation about the features it provides.
+You can define your own models by extending `\Swis\JsonApi\Client\Item` or by implementing the `\Swis\JsonApi\Client\Interfaces\ItemInterface` yourself.
 This can be useful if you want to define, for example, hidden attributes, casts or get/set mutators.
 If you use custom models, you must register them with the [TypeMapper](#typemapper).
 
-### JenssegersItem
-
-The `JenssegersItem` extends [jenssegers/model](https://github.com/jenssegers/model), which provides a Laravel Eloquent-like base class.
-Please see it's documentation about the features it provides.
-On top of that, this package has implemented Laravel Eloquent-like relations.
 
-#### Relations
+### Relations
 
-The relations are basic variants of [Laravel Eloquent relationships](https://laravel.com/docs/eloquent-relationships) and provide a fluent interface to retrieve the related items.
+On top of [jenssegers/model](https://github.com/jenssegers/model), this package has implemented [Laravel Eloquent-like relations](https://laravel.com/docs/eloquent-relationships).
+These relations provide a fluent interface to retrieve the related items.
 There are currently four relations available:
 
  * `HasOneRelation`
@@ -165,9 +163,9 @@ There are currently four relations available:
 Please see the following example about defining the relationships:
 
 ``` php
-use Swis\JsonApi\Client\Items\JenssegersItem;
+use Swis\JsonApi\Client\Item;
 
-class AuthorItem extends JenssegersItem
+class AuthorItem extends Item
 {
     protected $type = 'author';
 
@@ -177,7 +175,7 @@ class AuthorItem extends JenssegersItem
     }
 }
 
-class BlogItem extends JenssegersItem
+class BlogItem extends Item
 {
     protected $type = 'blog';
 

src/Items/JenssegersItem.php renamed to src/Item.php

@@ -1,17 +1,16 @@
 <?php
 
-namespace Swis\JsonApi\Client\Items;
+namespace Swis\JsonApi\Client;
 
 use Jenssegers\Model\Model;
-use Swis\JsonApi\Client\Collection;
 use Swis\JsonApi\Client\Interfaces\ItemInterface;
 use Swis\JsonApi\Client\Interfaces\RelationInterface;
 use Swis\JsonApi\Client\Relations\HasManyRelation;
 use Swis\JsonApi\Client\Relations\HasOneRelation;
 use Swis\JsonApi\Client\Relations\MorphToManyRelation;
 use Swis\JsonApi\Client\Relations\MorphToRelation;
 
-class JenssegersItem extends Model implements ItemInterface
+class Item extends Model implements ItemInterface
 {
     /**
      * @var string

src/ItemHydrator.php

@@ -5,7 +5,6 @@
 use Swis\JsonApi\Client\Interfaces\ItemInterface;
 use Swis\JsonApi\Client\Interfaces\RelationInterface;
 use Swis\JsonApi\Client\Interfaces\TypeMapperInterface;
-use Swis\JsonApi\Client\Items\JenssegersItem;
 use Swis\JsonApi\Client\Relations\HasManyRelation;
 use Swis\JsonApi\Client\Relations\HasOneRelation;
 use Swis\JsonApi\Client\Relations\MorphToManyRelation;
@@ -199,7 +198,7 @@ protected function buildRelationItem(RelationInterface $relation, array $relatio
         if ($this->typeMapper->hasMapping($type)) {
             $relationItem = $this->typeMapper->getMapping($type);
         } else {
-            $relationItem = new JenssegersItem();
+            $relationItem = new Item();
             $relationItem->setType($type);
         }
 

src/JsonApi/Hydrator.php

@@ -10,7 +10,7 @@
 use Swis\JsonApi\Client\Collection;
 use Swis\JsonApi\Client\Interfaces\ItemInterface;
 use Swis\JsonApi\Client\Interfaces\TypeMapperInterface;
-use Swis\JsonApi\Client\Items\JenssegersItem;
+use Swis\JsonApi\Client\Item;
 
 class Hydrator
 {
@@ -118,7 +118,7 @@ protected function getItemClass(string $type): ItemInterface
             return $this->typeMapper->getMapping($type);
         }
 
-        return (new JenssegersItem())->setType($type);
+        return (new Item())->setType($type);
     }
 
     /**

tests/CollectionDocumentBuilderTest.php

@@ -4,7 +4,7 @@
 
 use Swis\JsonApi\Client\Collection;
 use Swis\JsonApi\Client\CollectionDocumentBuilder;
-use Swis\JsonApi\Client\Items\JenssegersItem;
+use Swis\JsonApi\Client\Item;
 
 class CollectionDocumentBuilderTest extends AbstractTest
 {
@@ -16,8 +16,8 @@ public function it_fills_items_from_array()
         $collectionDocumentBuilder = new CollectionDocumentBuilder();
 
         $data = [
-            (new JenssegersItem(['key1' => 'value1']))->setId(1),
-            (new JenssegersItem(['key2' => 'value2']))->setId(2),
+            (new Item(['key1' => 'value1']))->setId(1),
+            (new Item(['key2' => 'value2']))->setId(2),
         ];
 
         $collectionDocument = $collectionDocumentBuilder->build($data);
@@ -26,11 +26,11 @@ public function it_fills_items_from_array()
         $items = $collectionDocument->getData();
         static::assertInstanceOf(Collection::class, $items);
 
-        static::assertInstanceOf(JenssegersItem::class, $items[0]);
+        static::assertInstanceOf(Item::class, $items[0]);
         static::assertEquals(1, $items[0]->getId());
         static::assertEquals($data[0]['key1'], $items[0]->key1);
 
-        static::assertInstanceOf(JenssegersItem::class, $items[1]);
+        static::assertInstanceOf(Item::class, $items[1]);
         static::assertEquals(2, $items[1]->getId());
         static::assertEquals($data[1]['key2'], $items[1]->key2);
     }

tests/ItemDocumentBuilderTest.php

@@ -2,9 +2,9 @@
 
 namespace Swis\JsonApi\Client\Tests;
 
+use Swis\JsonApi\Client\Item;
 use Swis\JsonApi\Client\ItemDocumentBuilder;
 use Swis\JsonApi\Client\ItemHydrator;
-use Swis\JsonApi\Client\Items\JenssegersItem;
 use Swis\JsonApi\Client\TypeMapper;
 
 class ItemDocumentBuilderTest extends AbstractTest
@@ -20,10 +20,10 @@ public function it_fills_items_from_id_and_attributes()
         $itemHydrator = new ItemHydrator($typeMapper);
         $itemDocumentBuilder = new ItemDocumentBuilder($itemHydrator);
 
-        $itemDocument = $itemDocumentBuilder->build(new JenssegersItem(), $data, 123);
+        $itemDocument = $itemDocumentBuilder->build(new Item(), $data, 123);
 
         $item = $itemDocument->getData();
-        static::assertInstanceOf(JenssegersItem::class, $item);
+        static::assertInstanceOf(Item::class, $item);
         static::assertEquals($item->key1, $data['key1']);
         static::assertEquals($item->key2, $data['key2']);
     }

tests/ItemHydratorTest.php

@@ -4,15 +4,15 @@
 
 use InvalidArgumentException;
 use Swis\JsonApi\Client\Collection;
+use Swis\JsonApi\Client\Item;
 use Swis\JsonApi\Client\ItemHydrator;
-use Swis\JsonApi\Client\Items\JenssegersItem;
 use Swis\JsonApi\Client\Relations\HasManyRelation;
 use Swis\JsonApi\Client\Relations\HasOneRelation;
 use Swis\JsonApi\Client\Relations\MorphToManyRelation;
 use Swis\JsonApi\Client\Relations\MorphToRelation;
-use Swis\JsonApi\Client\Tests\Mocks\Items\Jenssegers\AnotherRelatedJenssegersItem;
-use Swis\JsonApi\Client\Tests\Mocks\Items\Jenssegers\RelatedJenssegersItem;
-use Swis\JsonApi\Client\Tests\Mocks\Items\Jenssegers\WithRelationshipJenssegersItem;
+use Swis\JsonApi\Client\Tests\Mocks\Items\AnotherRelatedItem;
+use Swis\JsonApi\Client\Tests\Mocks\Items\RelatedItem;
+use Swis\JsonApi\Client\Tests\Mocks\Items\WithRelationshipItem;
 use Swis\JsonApi\Client\TypeMapper;
 
 class ItemHydratorTest extends AbstractTest
@@ -27,7 +27,7 @@ public function it_hydrates_items_without_relationships()
             'testattribute2' => 'test2',
         ];
 
-        $item = new JenssegersItem();
+        $item = new Item();
 
         $item = $this->getItemHydrator()->hydrate($item, $data);
 
@@ -40,10 +40,10 @@ public function it_hydrates_items_without_relationships()
     private function getItemHydrator()
     {
         $typeMapper = new TypeMapper();
-        $typeMapper->setMapping('hydratedItem', JenssegersItem::class);
+        $typeMapper->setMapping('hydratedItem', Item::class);
 
-        $typeMapper->setMapping('related-item', RelatedJenssegersItem::class);
-        $typeMapper->setMapping('another-related-item', AnotherRelatedJenssegersItem::class);
+        $typeMapper->setMapping('related-item', RelatedItem::class);
+        $typeMapper->setMapping('another-related-item', AnotherRelatedItem::class);
 
         return new ItemHydrator($typeMapper);
     }
@@ -59,7 +59,7 @@ public function it_hydrates_items_with_hasone_relationships()
             'hasone_relation' => 1,
         ];
 
-        $item = new WithRelationshipJenssegersItem();
+        $item = new WithRelationshipItem();
         $item = $this->getItemHydrator()->hydrate($item, $data);
 
         /** @var \Swis\JsonApi\Client\Relations\HasOneRelation $hasOne */
@@ -100,7 +100,7 @@ public function it_hydrates_items_with_hasmany_relationships()
             ],
         ];
 
-        $item = new WithRelationshipJenssegersItem();
+        $item = new WithRelationshipItem();
 
         $item = $this->getItemHydrator()->hydrate($item, $data);
         /** @var \Swis\JsonApi\Client\Relations\HasManyRelation $hasMany */
@@ -151,7 +151,7 @@ public function it_throws_exception_when_morphto_relationship_without_type_attri
             ],
         ];
 
-        $item = new WithRelationshipJenssegersItem();
+        $item = new WithRelationshipItem();
 
         $this->expectException(InvalidArgumentException::class);
         $this->getItemHydrator()->hydrate($item, $data);
@@ -172,7 +172,7 @@ public function it_hydrates_items_with_morphto_relationship()
             ],
         ];
 
-        $item = new WithRelationshipJenssegersItem();
+        $item = new WithRelationshipItem();
         $item = $this->getItemHydrator()->hydrate($item, $data);
 
         /** @var \Swis\JsonApi\Client\Relations\MorphToRelation $morphTo */
@@ -208,7 +208,7 @@ public function it_throws_exception_when_morphtomany_relationship_without_type_a
             ],
         ];
 
-        $item = new WithRelationshipJenssegersItem();
+        $item = new WithRelationshipItem();
 
         $this->expectException(InvalidArgumentException::class);
         $this->getItemHydrator()->hydrate($item, $data);
@@ -236,7 +236,7 @@ public function it_hydrates_items_with_morphtomany_relationship()
             ],
         ];
 
-        $item = new WithRelationshipJenssegersItem();
+        $item = new WithRelationshipItem();
         $item = $this->getItemHydrator()->hydrate($item, $data);
 
         /** @var \Swis\JsonApi\Client\Relations\MorphToManyRelation $morphToMany */
@@ -279,7 +279,7 @@ public function it_hydrates_nested_relationship_items()
             ],
         ];
 
-        $item = new WithRelationshipJenssegersItem();
+        $item = new WithRelationshipItem();
         $item = $this->getItemHydrator()->hydrate($item, $data);
 
         /** @var \Swis\JsonApi\Client\Relations\HasOneRelation $hasOne */
@@ -314,7 +314,7 @@ public function it_hydrates_a_hasmany_relationship_by_id()
             ],
         ];
 
-        $item = new WithRelationshipJenssegersItem();
+        $item = new WithRelationshipItem();
 
         $item = $this->getItemHydrator()->hydrate($item, $data);
         /** @var \Swis\JsonApi\Client\Relations\HasManyRelation $hasMany */

tests/Items/JenssegersItemRelationsTest.php renamed to tests/ItemRelationsTest.php

@@ -1,24 +1,23 @@
 <?php
 
-namespace Swis\JsonApi\Client\Tests\Items;
+namespace Swis\JsonApi\Client\Tests;
 
-use Swis\JsonApi\Client\Items\JenssegersItem;
+use Swis\JsonApi\Client\Item;
 use Swis\JsonApi\Client\Relations\HasOneRelation;
-use Swis\JsonApi\Client\Tests\AbstractTest;
-use Swis\JsonApi\Client\Tests\Mocks\Items\Jenssegers\ChildJenssegersItem;
-use Swis\JsonApi\Client\Tests\Mocks\Items\Jenssegers\MasterJenssegersItem;
+use Swis\JsonApi\Client\Tests\Mocks\Items\ChildItem;
+use Swis\JsonApi\Client\Tests\Mocks\Items\MasterItem;
 
-class JenssegersItemRelationsTest extends AbstractTest
+class ItemRelationsTest extends AbstractTest
 {
     /**
      * @test
      */
     public function it_has_relationships_when_added()
     {
-        $masterItem = new MasterJenssegersItem();
+        $masterItem = new MasterItem();
         $this->assertInstanceOf(HasOneRelation::class, $masterItem->child());
 
-        $childItem = new ChildJenssegersItem();
+        $childItem = new ChildItem();
         $childItem->setId(1);
         $this->assertEquals(1, $childItem->getId());
         $masterItem->child()->associate($childItem);
@@ -32,13 +31,13 @@ public function it_has_relationships_when_added()
      */
     public function it_can_check_for_relations()
     {
-        $item = new JenssegersItem();
+        $item = new Item();
         $this->assertFalse($item->hasRelationship('test'));
 
-        $masterItem = new MasterJenssegersItem();
+        $masterItem = new MasterItem();
         $this->assertFalse($masterItem->hasRelationship('child'));
 
-        $childItem = new ChildJenssegersItem();
+        $childItem = new ChildItem();
         $childItem->setId(1);
         $masterItem->child()->associate($childItem);
         $this->assertTrue($masterItem->hasRelationship('child'));
@@ -49,8 +48,8 @@ public function it_can_check_for_relations()
      */
     public function it_can_get_all_relations()
     {
-        $masterItem = new MasterJenssegersItem();
-        $childItem = new ChildJenssegersItem();
+        $masterItem = new MasterItem();
+        $childItem = new ChildItem();
         $childItem->setId(1);
         $masterItem->child()->setId(1);
         $masterItem->child()->associate($childItem);