Merge pull request #16 from tuyakhov/pluralize

Update docs & add tests for type inflection

Author: tuyakhov

README.md

@@ -44,6 +44,17 @@ class Controller extends \yii\rest\Controller
     }
 }
 ```
+By default, the value of `type` is automatically pluralized. 
+You can change this behavior by setting `tuyakhov\jsonapi\Serializer::$pluralize` property:
+```
+class Controller extends \yii\rest\Controller
+{
+    public $serializer = [
+        'class' => 'tuyakhov\jsonapi\Serializer',
+        'pluralize' => false,  // makes {"type": "user"}, instead of {"type": "users"}
+    ];
+}
+```
 Defining models:
 1) Let's define `User` model and declare an `articles` relation 
 ```php

tests/SerializerTest.php

@@ -290,4 +290,22 @@ public function testSerializeDataProvider($dataProvider, $expectedResult)
         ResourceModel::$fields = ['username'];
         $this->assertEquals($expectedResult, $serializer->serialize($dataProvider));
     }
+
+    public function testTypeInflection()
+    {
+        $serializer = new Serializer();
+        $serializer->pluralize = false;
+        $model = new ResourceModel();
+        ResourceModel::$fields = [];
+        $this->assertSame([
+            'data' => [
+                'id' => '123',
+                'type' => 'resource-model',
+                'attributes' => [],
+                'links' => [
+                    'self' => ['href' => 'http://example.com/resource/123']
+                ]
+            ]
+        ], $serializer->serialize($model));
+    }
 }