Doc2test (#68)

Author: f3ath

.codeclimate.yml

@@ -2,9 +2,7 @@ engines:
   phpmd:
     enabled: true
     checks:
-      Controversial/CamelCasePropertyName:
-        enabled: false
       Naming/ShortVariable:
         enabled: false
       CleanCode/StaticAccess:
-        enabled: false
+        enabled: false

.doc2test.ini

@@ -0,0 +1,2 @@
+source = ./README.md
+destination = ./doc-test

.gitignore

@@ -1,4 +1,5 @@
 composer.phar
+/doc-test/
 /vendor/
 /composer.lock
 /.php_cs.cache

.travis.yml

@@ -10,3 +10,9 @@ before_script:
 script:
   - vendor/bin/php-cs-fixer fix -v --dry-run
   - phpunit --coverage-clover build/logs/clover.xml
+  - vendor/bin/doc2test && vendor/bin/phpunit -c doc-test/phpunit.xml
+
+matrix:
+  exclude:
+  - php: '7.0'
+    script: vendor/bin/doc2test && vendor/bin/phpunit -c doc-test/phpunit.xml

README.md

@@ -3,7 +3,7 @@ This library is an attempt to express business rules of JSON API specification i
 
 A simple example to illustrate the general idea. This JSON representation from
 [the documentation](http://jsonapi.org/format/#document-resource-objects)
-
+<!-- name=my_json -->
 ```json
 {
     "data": {
@@ -28,19 +28,20 @@ A simple example to illustrate the general idea. This JSON representation from
 }
 ```
 can be built with the following php code (less imports):
+<!-- assert=output expect=my_json -->
 ```php
 <?php
-$articles = new ResourceObject('articles', '1');
-$author = Relationship::fromLinkage(
-    new SingleLinkage(
-        new ResourceIdentifier('people', '9')
+$articles = new \JsonApiPhp\JsonApi\Document\Resource\ResourceObject('articles', '1');
+$author = \JsonApiPhp\JsonApi\Document\Resource\Relationship::fromLinkage(
+    new \JsonApiPhp\JsonApi\Document\Resource\Linkage\SingleLinkage(
+        new \JsonApiPhp\JsonApi\Document\Resource\ResourceIdentifier('people', '9')
     )
 );
 $author->setLink('self', '/articles/1/relationships/author');
 $author->setLink('related','/articles/1/author');
 $articles->setRelationship('author', $author);
 $articles->setAttribute('title', 'Rails is Omakase');
-$doc = Document::fromResource($articles);
+$doc = \JsonApiPhp\JsonApi\Document::fromResource($articles);
 echo json_encode($doc, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);
 ```
 

composer.json

@@ -2,7 +2,7 @@
   "name": "json-api-php/json-api",
   "description": "An attempt to express JSON API specs (jsonapi.org) in object-oriented way as a set of PHP 7 classes",
   "type": "library",
-
+  "prefer-stable": true,
   "license": "MIT",
   "authors": [
     {
@@ -15,7 +15,8 @@
   },
   "require-dev": {
     "phpunit/phpunit": "^6.0",
-    "friendsofphp/php-cs-fixer": "^2.2"
+    "friendsofphp/php-cs-fixer": "^2.2",
+    "doc2test/doc2test": "dev-master"
   },
   "autoload": {
     "psr-4": {

phpunit.xml.dist

@@ -1,13 +1,4 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<!--
-  ~  This file is part of JSON:API implementation for PHP.
-  ~
-  ~  (c) Alexey Karapetov <karapetov@gmail.com>
-  ~
-  ~  For the full copyright and license information, please view the LICENSE
-  ~  file that was distributed with this source code.
-  -->
-
 <phpunit
         bootstrap="vendor/autoload.php"
         stopOnFailure="false"

test/Document/CompoundDocumentTest.php

@@ -77,10 +77,18 @@ public function testOfficialDocsExample()
 
         $doc = Document::fromResources($article);
         $doc->setIncluded($dan, $comment05, $comment12);
+        $doc->setLink('self', 'http://example.com/articles');
+        $doc->setLink('next', 'http://example.com/articles?page[offset]=2');
+        $doc->setLink('last', 'http://example.com/articles?page[offset]=10');
 
         $this->assertEncodesTo(
             '
             {
+              "links": {
+                "self": "http://example.com/articles",
+                "next": "http://example.com/articles?page[offset]=2",
+                "last": "http://example.com/articles?page[offset]=10"
+              },
               "data": [{
                 "type": "articles",
                 "id": "1",