Close #190

Author: neomerx

.travis.yml

@@ -1,13 +1,10 @@
 language: php
 php:
-- 5.6
-- 7
 - 7.1
+- 7.2
 matrix:
   include:
-    - php: hhvm
-      dist: trusty
-    - php: 5.5
+    - php: 7.1
       script:
       - vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover
       after_script:

README.md

@@ -2,7 +2,6 @@
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/neomerx/json-api/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/neomerx/json-api/?branch=master)
 [![Code Coverage](https://scrutinizer-ci.com/g/neomerx/json-api/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/neomerx/json-api/?branch=master)
 [![Build Status](https://travis-ci.org/neomerx/json-api.svg?branch=master)](https://travis-ci.org/neomerx/json-api)
-[![HHVM](https://img.shields.io/hhvm/neomerx/json-api.svg)](https://travis-ci.org/neomerx/json-api)
 [![License](https://img.shields.io/packagist/l/neomerx/json-api.svg)](https://packagist.org/packages/neomerx/json-api)
 
 ## Description 
@@ -22,7 +21,7 @@ This framework agnostic package implements [JSON API](http://jsonapi.org/) speci
 * Sparse fieldsets and customized included paths
 * Errors
 
-High code quality and **100% test coverage** with **250+ tests**. Production ready.
+High code quality and **100% test coverage** with **200+ tests**. Production ready.
 
 **To find out more, please check out the [Wiki](https://github.com/neomerx/json-api/wiki) and [Sample App](/sample)**.
 
@@ -42,7 +41,7 @@ The server supports
 - Support for such JSON API features as resource inclusion, pagination and etc.
 
 <p align="center">
-<a href="https://github.com/limoncello-php/app" target="_blank"><img src="https://github.com/limoncello-php/app/raw/master/resources/img/screen-shot.png" alt="Demo app screen-shot" title="Limoncello App" align="middle" width="330" height="252" /></a>
+<a href="https://github.com/limoncello-php/app" target="_blank"><img src="https://raw.githubusercontent.com/limoncello-php/app/master/server/resources/img/screen-shot.png" alt="Demo app screen-shot" title="Limoncello App" align="middle" width="330" height="252" /></a>
 </p>
 
 ## Sample usage
@@ -78,17 +77,17 @@ will output
 The ```AuthorSchema``` provides information about resource's attributes and might look like
 
 ```php
-class AuthorSchema extends SchemaProvider
+class AuthorSchema extends BaseSchema
 {
     protected $resourceType = 'people';
 
-    public function getId($author)
+    public function getId($author): ?string
     {
         /** @var Author $author */
         return $author->authorId;
     }
 
-    public function getAttributes($author)
+    public function getAttributes($author, array $fieldKeysFilter = null): ?array
     {
         /** @var Author $author */
         return [
@@ -103,8 +102,14 @@ The first ```EncoderOptions``` parameter ```JSON_PRETTY_PRINT``` is a PHP predef
 
 The second ```EncoderOptions``` parameter ```http://example.com/api/v1``` is a URL prefix that will be applied to all encoded links unless they have ```$treatAsHref``` flag set to ```true```.
 
+A sample program with encoding of multiple, nested, filtered objects and more is [here](sample).
+
 **For more advanced usage please check out the [Wiki](https://github.com/neomerx/json-api/wiki)**.
 
+## Versions
+
+Current version is 2.x (PHP 7.1+) for older PHP versions (PHP 5.5 - 7.0, HHVM) please use version 1.x.
+
 ## Questions?
 
 Do not hesitate to check [issues](https://github.com/neomerx/json-api/issues) or post a new one.
@@ -117,8 +122,6 @@ Are you planning to add JSON API and need help? We'd love to talk to you [sales@
 
 If you have spotted any specification changes that are not reflected in this package please post an [issue](https://github.com/neomerx/json-api/issues). Pull requests for documentation and code improvements are welcome.
 
-Current tasks are managed with [Waffle.io](https://waffle.io/neomerx/json-api).
-
 There are 2 ways to send pull requests
 - small pull requests should be sent to `develop` branch as **1 commit**
 - for bigger pull requests (e.g. new features) it's recommended to create an `issue` requesting a new branch for that feature. When a new branch named `feature/issueXX` is created (where `XX` is the issue number) you should post pull requests to this branch. When the feature is completed the branch will be squashed and merged to `develop` and then to `master` branches.

composer.json

@@ -21,23 +21,24 @@
     }
   ],
   "require": {
-    "php": ">=5.5.0",
+    "php": ">=7.1.0",
     "psr/http-message": "^1.0",
     "psr/log": "^1.0"
   },
   "require-dev": {
-    "phpunit/phpunit": "^4.6 || ^5.0 || ^6.0",
-    "mockery/mockery": "~0.9.4",
-    "scrutinizer/ocular": "^1.3",
-    "squizlabs/php_codesniffer": "^2.5",
-    "monolog/monolog": "^1.18",
+    "phpunit/phpunit": "^6.5",
+    "mockery/mockery": "^1.0",
+    "scrutinizer/ocular": "^1.4",
+    "squizlabs/php_codesniffer": "^3.1",
+    "monolog/monolog": "^1.23",
     "phpmd/phpmd": "^2.6"
   },
   "minimum-stability": "stable",
   "autoload": {
     "psr-4": {
       "Neomerx\\JsonApi\\": "src/"
-    }
+    },
+    "files": ["src/I18n/translate.php"]
   },
   "autoload-dev": {
     "psr-4": {
@@ -52,7 +53,6 @@
     "test-cs": "./vendor/bin/phpcs -p -s --standard=PSR2 ./src ./tests",
     "test-md": "./vendor/bin/phpmd ./src text codesize,controversial,cleancode,design,unusedcode,naming",
 
-    "perf-php": "docker-compose run --rm cli_php php /app/sample/sample.php -t=10000",
-    "perf-hhvm": "docker-compose run --rm cli_hhvm hhvm /app/sample/sample.php -t=10000"
+    "perf-test": "docker-compose run --rm cli_7_1_php php /app/sample/sample.php -t=10000"
   }
 }

docker-compose.yml

@@ -21,8 +21,16 @@
 # Performance test
 # $ cd /app/sample/ && time php sample.php -t=10000
 
-cli_php:
-  image: php:cli
+cli_7_1_php:
+  image: php:7.1-cli
+  container_name: cli_php_json_api
+  volumes:
+    - .:/app
+  working_dir: /app
+  tty: true
+
+cli_7_2_php:
+  image: php:7.2-cli
   container_name: cli_php_json_api
   volumes:
     - .:/app

sample/Application/EncodeSamples.php

@@ -16,19 +16,19 @@
  * limitations under the License.
  */
 
-use \Closure;
-use \Neomerx\JsonApi\Document\Link;
-use \Neomerx\JsonApi\Encoder\Encoder;
-use \Neomerx\Samples\JsonApi\Models\Post;
-use \Neomerx\Samples\JsonApi\Models\Site;
-use \Neomerx\Samples\JsonApi\Models\Author;
-use \Neomerx\Samples\JsonApi\Models\Comment;
-use \Neomerx\JsonApi\Encoder\EncoderOptions;
-use \Neomerx\Samples\JsonApi\Schemas\PostSchema;
-use \Neomerx\Samples\JsonApi\Schemas\SiteSchema;
-use \Neomerx\Samples\JsonApi\Schemas\AuthorSchema;
-use \Neomerx\Samples\JsonApi\Schemas\CommentSchema;
-use \Neomerx\JsonApi\Encoder\Parameters\EncodingParameters;
+use Closure;
+use Neomerx\JsonApi\Document\Link;
+use Neomerx\JsonApi\Encoder\Encoder;
+use Neomerx\JsonApi\Encoder\EncoderOptions;
+use Neomerx\JsonApi\Encoder\Parameters\EncodingParameters;
+use Neomerx\Samples\JsonApi\Models\Author;
+use Neomerx\Samples\JsonApi\Models\Comment;
+use Neomerx\Samples\JsonApi\Models\Post;
+use Neomerx\Samples\JsonApi\Models\Site;
+use Neomerx\Samples\JsonApi\Schemas\AuthorSchema;
+use Neomerx\Samples\JsonApi\Schemas\CommentSchema;
+use Neomerx\Samples\JsonApi\Schemas\PostSchema;
+use Neomerx\Samples\JsonApi\Schemas\SiteSchema;
 
 /**
  * @package Neomerx\Samples\JsonApi
@@ -106,7 +106,7 @@ public function getSparseAndFieldSetsExample()
         ]);
 
         SiteSchema::$isShowCustomLinks = false;
-        $encoder = Encoder::instance([
+        $encoder                       = Encoder::instance([
             Author::class  => AuthorSchema::class,
             Comment::class => CommentSchema::class,
             Post::class    => PostSchema::class,
@@ -167,10 +167,10 @@ public function getDynamicSchemaExample()
         ], new EncoderOptions(JSON_PRETTY_PRINT));
 
         SiteSchema::$isShowCustomLinks = false;
-        $noLinksResult = $encoder->encodeData($site);
+        $noLinksResult                 = $encoder->encodeData($site);
 
         SiteSchema::$isShowCustomLinks = true;
-        $withLinksResult = $encoder->encodeData($site);
+        $withLinksResult               = $encoder->encodeData($site);
 
         return [
             $noLinksResult,

sample/Schemas/AuthorSchema.php

@@ -16,22 +16,32 @@
  * limitations under the License.
  */
 
-use \Neomerx\JsonApi\Schema\SchemaProvider;
+use Neomerx\JsonApi\Schema\BaseSchema;
+use Neomerx\Samples\JsonApi\Models\Author;
 
 /**
  * @package Neomerx\Samples\JsonApi
  */
-class AuthorSchema extends SchemaProvider
+class AuthorSchema extends BaseSchema
 {
+    /**
+     * @inheritdoc
+     */
     protected $resourceType = 'people';
 
-    public function getId($author)
+    /**
+     * @inheritdoc
+     */
+    public function getId($author): ?string
     {
         /** @var Author $author */
         return $author->authorId;
     }
 
-    public function getAttributes($author)
+    /**
+     * @inheritdoc
+     */
+    public function getAttributes($author, array $fieldKeysFilter = null): ? array
     {
         /** @var Author $author */
         return [

sample/Schemas/CommentSchema.php

@@ -16,32 +16,48 @@
  * limitations under the License.
  */
 
-use \Neomerx\JsonApi\Schema\SchemaProvider;
+use Neomerx\JsonApi\Schema\BaseSchema;
+use Neomerx\Samples\JsonApi\Models\Comment;
 
 /**
  * @package Neomerx\Samples\JsonApi
  */
-class CommentSchema extends SchemaProvider
+class CommentSchema extends BaseSchema
 {
+    /**
+     * @inheritdoc
+     */
     protected $resourceType = 'comments';
 
+    /**
+     * @inheritdoc
+     */
     protected $isShowSelfInIncluded = true;
 
-    public function getId($comment)
+    /**
+     * @inheritdoc
+     */
+    public function getId($comment): ?string
     {
         /** @var Comment $comment */
         return $comment->commentId;
     }
 
-    public function getAttributes($comment)
+    /**
+     * @inheritdoc
+     */
+    public function getAttributes($comment, array $fieldKeysFilter = null): ?array
     {
         /** @var Comment $comment */
         return [
             'body' => $comment->body,
         ];
     }
 
-    public function getRelationships($comment, $isPrimary, array $includeList)
+    /**
+     * @inheritdoc
+     */
+    public function getRelationships($comment, bool $isPrimary, array $includeRelationships): ?array
     {
         /** @var Comment $comment */
         return [

sample/Schemas/PostSchema.php

@@ -16,22 +16,32 @@
  * limitations under the License.
  */
 
-use \Neomerx\JsonApi\Schema\SchemaProvider;
+use Neomerx\JsonApi\Schema\BaseSchema;
+use Neomerx\Samples\JsonApi\Models\Post;
 
 /**
  * @package Neomerx\Samples\JsonApi
  */
-class PostSchema extends SchemaProvider
+class PostSchema extends BaseSchema
 {
+    /**
+     * @inheritdoc
+     */
     protected $resourceType = 'posts';
 
-    public function getId($post)
+    /**
+     * @inheritdoc
+     */
+    public function getId($post): ?string
     {
         /** @var Post $post */
         return $post->postId;
     }
 
-    public function getAttributes($post)
+    /**
+     * @inheritdoc
+     */
+    public function getAttributes($post, array $fieldKeysFilter = null): ?array
     {
         /** @var Post $post */
         return [
@@ -40,7 +50,10 @@ public function getAttributes($post)
         ];
     }
 
-    public function getRelationships($post, $isPrimary, array $includeList)
+    /**
+     * @inheritdoc
+     */
+    public function getRelationships($post, bool $isPrimary, array $includeRelationships): ?array
     {
         /** @var Post $post */
         return [