JsonApiSerializerTest - Code Metrics - Inspection of "Feature/json api collection relationship links" - thephpleague/fractal - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#290)

unknown
created 2016-03-24 13:33 UTC
JsonApiSerializerTest A

↳ Parent: Project
Complexity

Total Complexity
Size/Duplication

Total Lines	1973
Duplicated Lines	36.75 %
Coupling/Cohesion

Components	1
Dependencies	11
Importance

Changes	1
Bugs	0	Features	1
Metric	Value
wmc	29
c	1
b	0
f	1
lcom	1
cbo	11
dl	725
loc	1973
rs	9.2173
29 Methods

Rating	Name	Duplication	Size	Complexity
A	testSerializingCollectionResourceWithEmptyHasManyInclude()	0	75	1
B	testSerializingItemResourceWithNestedIncludes()	85	85	1
A	setUp()	0	5	1
A	testSerializingItemResourceWithHasOneInclude()	0	51	1
A	testSerializingItemResourceWithHasOneDasherizedInclude()	55	55	1
B	testSerializingItemResourceWithEmptyHasOneInclude()	0	36	1
A	testSerializingItemResourceWithHasManyInclude()	0	72	1
B	testSerializingItemResourceWithEmptyHasManyInclude()	0	34	1
B	testSerializingItemResourceWithoutIncludes()	0	32	1
B	testSerializingItemResourceWithMeta()	36	36	1
A	testSerializingCollectionResourceWithoutIncludes()	52	52	1
B	testSerializingCollectionResourceWithHasOneInclude()	86	86	1
A	testSerializingCollectionResourceWithEmptyHasOneInclude()	0	73	1
B	testSerializingCollectionResourceWithHasManyInclude()	0	128	1
A	testSerializingCollectionResourceWithMeta()	55	55	1
B	testSerializingCollectionResourceWithDuplicatedIncludeData()	0	79	1
B	testSerializingItemResourceWithSelfLink()	38	38	1
A	testSerializingCollectionResourceWithSelfLink()	61	61	1
A	testSerializingItemResourceWithLinksForHasOneRelationship()	63	63	1
B	testSerializingItemResourceWithLinksForHasManyRelationship()	0	87	1
B	testSerializingCollectionResourceWithLinksForHasOneRelationship()	0	99	1
B	testSerializingCollectionResourceWithLinksForHasManyRelationship()	0	135	1
A	testExceptionThrownIfResourceHasNoId()	0	12	1
B	testSerializingItemWithReferenceToRootObject()	0	78	1
B	testSerializingCollectionWithReferenceToRootObjects()	0	111	1
B	testSerializingCollectionResourceWithPaginator()	0	100	1
B	testSerializingCollectionResourceWithPaginatorWithOmittedUnavailablePreviousLink()	97	97	1
B	testSerializingCollectionResourceWithPaginatorWithOmittedUnavailableNextLink()	97	97	1
A	tearDown()	0	4	1
How to fix Duplicated Code

<?php

use League\Fractal\Manager;
use League\Fractal\Resource\Collection;
use League\Fractal\Resource\Item;
use League\Fractal\Scope;
use League\Fractal\Serializer\JsonApiSerializer;
use League\Fractal\Test\Stub\Transformer\JsonApiAuthorTransformer;
use League\Fractal\Test\Stub\Transformer\JsonApiBookTransformer;

class JsonApiSerializerTest extends PHPUnit_Framework_TestCase
{
    private $manager;

    public function setUp()
    {
        $this->manager = new Manager();
        $this->manager->setSerializer(new JsonApiSerializer());
    }

    public function testSerializingItemResourceWithHasOneInclude()
    {
        $this->manager->parseIncludes('author');

        $bookData = [
            'id' => 1,
            'title' => 'Foo',
            'year' => '1991',
            '_author' => [
                'id' => 1,
                'name' => 'Dave',
            ],
        ];

        $resource = new Item($bookData, new JsonApiBookTransformer(), 'books');

        $scope = new Scope($this->manager, $resource);

        $expected = [
            'data' => [
                'type' => 'books',
                'id' => '1',
                'attributes' => [
                    'title' => 'Foo',
                    'year' => 1991,
                ],
                'relationships' => [
                    'author' => [
                        'data' => [
                            'type' => 'people',
                            'id' => '1',
                        ],
                    ],
                ],
            ],
            'included' => [
                [
                    'type' => 'people',
                    'id' => '1',
                    'attributes' => [
                        'name' => 'Dave',
                    ],
                ],
            ],
        ];

        $this->assertSame($expected, $scope->toArray());

        $expectedJson = '{"data":{"type":"books","id":"1","attributes":{"title":"Foo","year":1991},"relationships":{"author":{"data":{"type":"people","id":"1"}}}},"included":[{"type":"people","id":"1","attributes":{"name":"Dave"}}]}';
        $this->assertSame($expectedJson, $scope->toJson());
    }

    public function testSerializingItemResourceWithHasOneDasherizedInclude()
    {
        $this->manager->parseIncludes('co-author');

        $bookData = [
            'id' => 1,
            'title' => 'Foo',
            'year' => '1991',
            '_author' => [
                'id' => 1,
                'name' => 'Dave',
            ],
            '_co_author' => [
                'id' => 2,
                'name' => 'Jim',
            ],
        ];

        $resource = new Item($bookData, new JsonApiBookTransformer(), 'books');

        $scope = new Scope($this->manager, $resource);

        $expected = [
            'data' => [
                'type' => 'books',
                'id' => '1',
                'attributes' => [
                    'title' => 'Foo',
                    'year' => 1991,
                ],
                'relationships' => [
                    'co-author' => [
                        'data' => [
                            'type' => 'people',
                            'id' => '2',
                        ],
                    ],
                ],
            ],
            'included' => [
                [
                    'type' => 'people',
                    'id' => '2',
                    'attributes' => [
                        'name' => 'Jim',
                    ],
                ],
            ],
        ];

        $this->assertSame($expected, $scope->toArray());

        $expectedJson = '{"data":{"type":"books","id":"1","attributes":{"title":"Foo","year":1991},"relationships":{"co-author":{"data":{"type":"people","id":"2"}}}},"included":[{"type":"people","id":"2","attributes":{"name":"Jim"}}]}';
        $this->assertSame($expectedJson, $scope->toJson());
    }

    public function testSerializingItemResourceWithEmptyHasOneInclude()
    {
        $this->manager->parseIncludes('author');

        $bookData = [
            'id' => 1,
            'title' => 'Foo',
            'year' => '1991',
            '_author' => null,
        ];

        $resource = new Item($bookData, new JsonApiBookTransformer(), 'books');

        $scope = new Scope($this->manager, $resource);

        $expected = [
            'data' => [
                'type' => 'books',
                'id' => '1',
                'attributes' => [
                    'title' => 'Foo',
                    'year' => 1991,
                ],
                'relationships' => [
                    'author' => [
                        'data' => null,
                    ],
                ],
            ],
        ];

        $this->assertSame($expected, $scope->toArray());

        $expectedJson = '{"data":{"type":"books","id":"1","attributes":{"title":"Foo","year":1991},"relationships":{"author":{"data":null}}}}';
        $this->assertSame($expectedJson, $scope->toJson());
    }

    public function testSerializingItemResourceWithHasManyInclude()
    {
        $this->manager->parseIncludes('published');

        $authorData = [
            'id' => 1,
            'name' => 'Dave',
            '_published' => [
                [
                    'id' => 1,
                    'title' => 'Foo',
                    'year' => '1991',
                ],
                [
                    'id' => 2,
                    'title' => 'Bar',
                    'year' => '2015',
                ],
            ],
        ];

        $resource = new Item($authorData, new JsonApiAuthorTransformer(), 'people');

        $scope = new Scope($this->manager, $resource);

        $expected = [
            'data' => [
                'type' => 'people',
                'id' => '1',
                'attributes' => [
                    'name' => 'Dave',
                ],
                'relationships' => [
                    'published' => [
                        'data' => [
                            [
                                'type' => 'books',
                                'id' => 1,
                            ],
                            [
                                'type' => 'books',
                                'id' => 2,
                            ],
                        ],
                    ],
                ],
            ],
            'included' => [
                [
                    'type' => 'books',
                    'id' => '1',
                    'attributes' => [
                        'title' => 'Foo',
                        'year' => 1991,
                    ],
                ],
                [
                    'type' => 'books',
                    'id' => '2',
                    'attributes' => [
                        'title' => 'Bar',
                        'year' => 2015,
                    ],
                ],
            ],
        ];

        $this->assertEquals($expected, $scope->toArray());

        $expectedJson = '{"data":{"type":"people","id":"1","attributes":{"name":"Dave"},"relationships":{"published":{"data":[{"type":"books","id":"1"},{"type":"books","id":"2"}]}}},"included":[{"type":"books","id":"1","attributes":{"title":"Foo","year":1991}},{"type":"books","id":"2","attributes":{"title":"Bar","year":2015}}]}';
        $this->assertSame($expectedJson, $scope->toJson());
    }

    public function testSerializingItemResourceWithEmptyHasManyInclude()
    {
        $this->manager->parseIncludes('published');

        $authorData = [
            'id' => 1,
            'name' => 'Dave',
            '_published' => [],
        ];

        $resource = new Item($authorData, new JsonApiAuthorTransformer(), 'people');

        $scope = new Scope($this->manager, $resource);

        $expected = [
            'data' => [
                'type' => 'people',
                'id' => '1',
                'attributes' => [
                    'name' => 'Dave',
                ],
                'relationships' => [
                    'published' => [
                        'data' => [],
                    ],
                ],
            ],
        ];

        $this->assertSame($expected, $scope->toArray());

        $expectedJson = '{"data":{"type":"people","id":"1","attributes":{"name":"Dave"},"relationships":{"published":{"data":[]}}}}';
        $this->assertSame($expectedJson, $scope->toJson());
    }

    public function testSerializingItemResourceWithoutIncludes()
    {
        $bookData = [
            'id' => 1,
            'title' => 'Foo',
            'year' => '1991',
            '_author' => [
                'id' => 1,
                'name' => 'Dave',
            ],
        ];

        $resource = new Item($bookData, new JsonApiBookTransformer(), 'books');

        $scope = new Scope($this->manager, $resource);

        $expected = [
            'data' => [
                'type' => 'books',
                'id' => '1',
                'attributes' => [
                    'title' => 'Foo',
                    'year' => 1991,
                ],
            ],
        ];

        $this->assertSame($expected, $scope->toArray());

        $expectedJson = '{"data":{"type":"books","id":"1","attributes":{"title":"Foo","year":1991}}}';
        $this->assertSame($expectedJson, $scope->toJson());
    }

    public function testSerializingItemResourceWithMeta()
    {
        $bookData = [
            'id' => 1,
            'title' => 'Foo',
            'year' => '1991',
            '_author' => [
                'id' => 1,
                'name' => 'Dave',
            ],
        ];

        $resource = new Item($bookData, new JsonApiBookTransformer(), 'books');
        $resource->setMetaValue('foo', 'bar');

        $scope = new Scope($this->manager, $resource);

        $expected = [
            'data' => [
                'type' => 'books',
                'id' => '1',
                'attributes' => [
                    'title' => 'Foo',
                    'year' => 1991,
                ],
            ],
            'meta' => [
                'foo' => 'bar',
            ],
        ];

        $this->assertSame($expected, $scope->toArray());

        $expectedJson = '{"data":{"type":"books","id":"1","attributes":{"title":"Foo","year":1991}},"meta":{"foo":"bar"}}';
        $this->assertSame($expectedJson, $scope->toJson());
    }

    public function testSerializingCollectionResourceWithoutIncludes()
    {
        $booksData = [
            [
                'id' => 1,
                'title' => 'Foo',
                'year' => '1991',
                '_author' => [
                    'id' => 1,
                    'name' => 'Dave',
                ],
            ],
            [
                'id' => 2,
                'title' => 'Bar',
                'year' => '1997',
                '_author' => [
                    'id' => 2,
                    'name' => 'Bob',
                ],
            ],
        ];

        $resource = new Collection($booksData, new JsonApiBookTransformer(), 'books');
        $scope = new Scope($this->manager, $resource);

        $expected = [
            'data' => [
                [
                    'type' => 'books',
                    'id' => '1',
                    'attributes' => [
                        'title' => 'Foo',
                        'year' => 1991,
                    ],
                ],
                [
                    'type' => 'books',
                    'id' => '2',
                    'attributes' => [
                        'title' => 'Bar',
                        'year' => 1997,
                    ],
                ],
            ],
        ];

        $this->assertSame($expected, $scope->toArray());

        $expectedJson = '{"data":[{"type":"books","id":"1","attributes":{"title":"Foo","year":1991}},{"type":"books","id":"2","attributes":{"title":"Bar","year":1997}}]}';
        $this->assertSame($expectedJson, $scope->toJson());
    }

    public function testSerializingCollectionResourceWithHasOneInclude()
    {
        $this->manager->parseIncludes('author');

        $booksData = [
            [
                'id' => 1,
                'title' => 'Foo',
                'year' => '1991',
                '_author' => [
                    'id' => 1,
                    'name' => 'Dave',
                ],
            ],
            [
                'id' => 2,
                'title' => 'Bar',
                'year' => '1997',
                '_author' => [
                    'id' => 2,
                    'name' => 'Bob',
                ],
            ],
        ];

        $resource = new Collection($booksData, new JsonApiBookTransformer(), 'books');
        $scope = new Scope($this->manager, $resource);

        $expected = [
            'data' => [
                [
                    'type' => 'books',
                    'id' => '1',
                    'attributes' => [
                        'title' => 'Foo',
                        'year' => 1991,
                    ],
                    'relationships' => [
                        'author' => [
                            'data' => [
                                'type' => 'people',
                                'id' => '1',
                            ],
                        ],
                    ],
                ],
                [
                    'type' => 'books',
                    'id' => '2',
                    'attributes' => [
                        'title' => 'Bar',
                        'year' => 1997,
                    ],
                    'relationships' => [
                        'author' => [
                            'data' => [
                                'type' => 'people',
                                'id' => '2',
                            ],
                        ],
                    ],
                ],
            ],
            'included' => [
                [
                    'type' => 'people',
                    'id' => '1',
                    'attributes' => [
                        'name' => 'Dave',
                    ],
                ],
                [
                    'type' => 'people',
                    'id' => '2',
                    'attributes' => [
                        'name' => 'Bob',
                    ],
                ],
            ],
        ];

        $this->assertSame($expected, $scope->toArray());

        $expectedJson = '{"data":[{"type":"books","id":"1","attributes":{"title":"Foo","year":1991},"relationships":{"author":{"data":{"type":"people","id":"1"}}}},{"type":"books","id":"2","attributes":{"title":"Bar","year":1997},"relationships":{"author":{"data":{"type":"people","id":"2"}}}}],"included":[{"type":"people","id":"1","attributes":{"name":"Dave"}},{"type":"people","id":"2","attributes":{"name":"Bob"}}]}';
        $this->assertSame($expectedJson, $scope->toJson());
    }

    public function testSerializingCollectionResourceWithEmptyHasOneInclude()
    {
        $this->manager->parseIncludes('author');

        $booksData = [
            [
                'id' => 1,
                'title' => 'Foo',
                'year' => '1991',
                '_author' => null,
            ],
            [
                'id' => 2,
                'title' => 'Bar',
                'year' => '1997',
                '_author' => [
                    'id' => 2,
                    'name' => 'Bob',
                ],
            ],
        ];

        $resource = new Collection($booksData, new JsonApiBookTransformer(), 'books');
        $scope = new Scope($this->manager, $resource);

        $expected = [
            'data' => [
                [
                    'type' => 'books',
                    'id' => '1',
                    'attributes' => [
                        'title' => 'Foo',
                        'year' => 1991,
                    ],
                    'relationships' => [
                        'author' => [
                            'data' => null,
                        ],
                    ],
                ],
                [
                    'type' => 'books',
                    'id' => '2',
                    'attributes' => [
                        'title' => 'Bar',
                        'year' => 1997,
                    ],
                    'relationships' => [
                        'author' => [
                            'data' => [
                                'type' => 'people',
                                'id' => '2',
                            ],
                        ],
                    ],
                ],
            ],
            'included' => [
                [
                    'type' => 'people',
                    'id' => '2',
                    'attributes' => [
                        'name' => 'Bob',
                    ],
                ],
            ],
        ];

        $this->assertSame($expected, $scope->toArray());

        $expectedJson = '{"data":[{"type":"books","id":"1","attributes":{"title":"Foo","year":1991},"relationships":{"author":{"data":null}}},{"type":"books","id":"2","attributes":{"title":"Bar","year":1997},"relationships":{"author":{"data":{"type":"people","id":"2"}}}}],"included":[{"type":"people","id":"2","attributes":{"name":"Bob"}}]}';
        $this->assertSame($expectedJson, $scope->toJson());
    }

    public function testSerializingCollectionResourceWithHasManyInclude()
    {
        $this->manager->parseIncludes('published');

        $authorsData = [
            [
                'id' => 1,
                'name' => 'Dave',
                '_published' => [
                    [
                        'id' => 1,
                        'title' => 'Foo',
                        'year' => '1991',
                    ],
                    [
                        'id' => 2,
                        'title' => 'Bar',
                        'year' => '2015',
                    ],
                ],
            ],
            [
                'id' => 2,
                'name' => 'Bob',
                '_published' => [
                    [
                        'id' => 3,
                        'title' => 'Baz',
                        'year' => '1995',
                    ],
                    [
                        'id' => 4,
                        'title' => 'Quux',
                        'year' => '2000',
                    ],
                ],
            ],
        ];

        $resource = new Collection($authorsData, new JsonApiAuthorTransformer(), 'people');
        $scope = new Scope($this->manager, $resource);

        $expected = [
            'data' => [
                [
                    'type' => 'people',
                    'id' => '1',
                    'attributes' => [
                        'name' => 'Dave',
                    ],
                    'relationships' => [
                        'published' => [
                            'data' => [
                                [
                                    'type' => 'books',
                                    'id' => 1,
                                ],
                                [
                                    'type' => 'books',
                                    'id' => 2,
                                ],
                            ],
                        ],
                    ],
                ],
                [
                    'type' => 'people',
                    'id' => '2',
                    'attributes' => [
                        'name' => 'Bob',
                    ],
                    'relationships' => [
                        'published' => [
                            'data' => [
                                [
                                    'type' => 'books',
                                    'id' => 3,
                                ],
                                [
                                    'type' => 'books',
                                    'id' => 4,
                                ],
                            ],
                        ],
                    ],
                ],
            ],
            'included' => [
                [
                    'type' => 'books',
                    'id' => '1',
                    'attributes' => [
                        'title' => 'Foo',
                        'year' => 1991,
                    ],
                ],
                [
                    'type' => 'books',
                    'id' => '2',
                    'attributes' => [
                        'title' => 'Bar',
                        'year' => 2015,
                    ],
                ],
                [
                    'type' => 'books',
                    'id' => '3',
                    'attributes' => [
                        'title' => 'Baz',
                        'year' => 1995,
                    ],
                ],
                [
                    'type' => 'books',
                    'id' => '4',
                    'attributes' => [
                        'title' => 'Quux',
                        'year' => 2000,
                    ],
                ],
            ],
        ];

        $this->assertEquals($expected, $scope->toArray());

        $expectedJson = '{"data":[{"type":"people","id":"1","attributes":{"name":"Dave"},"relationships":{"published":{"data":[{"type":"books","id":"1"},{"type":"books","id":"2"}]}}},{"type":"people","id":"2","attributes":{"name":"Bob"},"relationships":{"published":{"data":[{"type":"books","id":"3"},{"type":"books","id":"4"}]}}}],"included":[{"type":"books","id":"1","attributes":{"title":"Foo","year":1991}},{"type":"books","id":"2","attributes":{"title":"Bar","year":2015}},{"type":"books","id":"3","attributes":{"title":"Baz","year":1995}},{"type":"books","id":"4","attributes":{"title":"Quux","year":2000}}]}';
        $this->assertSame($expectedJson, $scope->toJson());
    }

    public function testSerializingCollectionResourceWithEmptyHasManyInclude()
    {
        $this->manager->parseIncludes('published');

        $authorsData = [
            [
                'id' => 1,
                'name' => 'Dave',
                '_published' => [],
            ],
            [
                'id' => 2,
                'name' => 'Bob',
                '_published' => [
                    [
                        'id' => 3,
                        'title' => 'Baz',
                        'year' => '1995',
                    ],
                ],
            ],
        ];

        $resource = new Collection($authorsData, new JsonApiAuthorTransformer(), 'people');
        $scope = new Scope($this->manager, $resource);

        $expected = [
            'data' => [
                [
                    'type' => 'people',
                    'id' => '1',
                    'attributes' => [
                        'name' => 'Dave',
                    ],
                    'relationships' => [
                        'published' => [
                            'data' => [],
                        ],
                    ],
                ],
                [
                    'type' => 'people',
                    'id' => '2',
                    'attributes' => [
                        'name' => 'Bob',
                    ],
                    'relationships' => [
                        'published' => [
                            'data' => [
                                [
                                    'type' => 'books',
                                    'id' => 3,
                                ],
                            ],
                        ],
                    ],
                ],
            ],
            'included' => [
                [
                    'type' => 'books',
                    'id' => '3',
                    'attributes' => [
                        'title' => 'Baz',
                        'year' => 1995,
                    ],
                ],
            ],
        ];

        $this->assertEquals($expected, $scope->toArray());

        $expectedJson = '{"data":[{"type":"people","id":"1","attributes":{"name":"Dave"},"relationships":{"published":{"data":[]}}},{"type":"people","id":"2","attributes":{"name":"Bob"},"relationships":{"published":{"data":[{"type":"books","id":"3"}]}}}],"included":[{"type":"books","id":"3","attributes":{"title":"Baz","year":1995}}]}';
        $this->assertSame($expectedJson, $scope->toJson());
    }

    public function testSerializingCollectionResourceWithMeta()
    {
        $booksData = [
            [
                'id' => 1,
                'title' => 'Foo',
                'year' => '1991',
                '_author' => [
                    'name' => 'Dave',
                ],
            ],
            [
                'id' => 2,
                'title' => 'Bar',
                'year' => '1997',
                '_author' => [
                    'name' => 'Bob',
                ],
            ],
        ];

        $resource = new Collection($booksData, new JsonApiBookTransformer(), 'books');
        $resource->setMetaValue('foo', 'bar');

        $scope = new Scope($this->manager, $resource);

        $expected = [
            'data' => [
                [
                    'type' => 'books',
                    'id' => '1',
                    'attributes' => [
                        'title' => 'Foo',
                        'year' => 1991,
                    ],
                ],
                [
                    'type' => 'books',
                    'id' => '2',
                    'attributes' => [
                        'title' => 'Bar',
                        'year' => 1997,
                    ],
                ],
            ],
            'meta' => [
                'foo' => 'bar',
            ],
        ];

        $this->assertSame($expected, $scope->toArray());

        $expectedJson = '{"data":[{"type":"books","id":"1","attributes":{"title":"Foo","year":1991}},{"type":"books","id":"2","attributes":{"title":"Bar","year":1997}}],"meta":{"foo":"bar"}}';
        $this->assertSame($expectedJson, $scope->toJson());
    }

    public function testSerializingCollectionResourceWithDuplicatedIncludeData()
    {
        $this->manager->parseIncludes('author');

        $booksData = [
            [
                'id' => 1,
                'title' => 'Foo',
                'year' => '1991',
                '_author' => [
                    'id' => 1,
                    'name' => 'Dave',
                ],
            ],
            [
                'id' => 2,
                'title' => 'Bar',
                'year' => '1997',
                '_author' => [
                    'id' => 1,
                    'name' => 'Dave',
                ],
            ],
        ];

        $resource = new Collection($booksData, new JsonApiBookTransformer(), 'books');
        $scope = new Scope($this->manager, $resource);

        $expected = [
            'data' => [
                [
                    'type' => 'books',
                    'id' => '1',
                    'attributes' => [
                        'title' => 'Foo',
                        'year' => 1991,
                    ],
                    'relationships' => [
                        'author' => [
                            'data' => [
                                'type' => 'people',
                                'id' => '1',
                            ],
                        ],
                    ],
                ],
                [
                    'type' => 'books',
                    'id' => '2',
                    'attributes' => [
                        'title' => 'Bar',
                        'year' => 1997,
                    ],
                    'relationships' => [
                        'author' => [
                            'data' => [
                                'type' => 'people',
                                'id' => '1',
                            ],
                        ],
                    ],
                ],
            ],
            'included' => [
                [
                    'type' => 'people',
                    'id' => '1',
                    'attributes' => [
                        'name' => 'Dave',
                    ],
                ],
            ],
        ];

        $this->assertSame($expected, $scope->toArray());

        $expectedJson = '{"data":[{"type":"books","id":"1","attributes":{"title":"Foo","year":1991},"relationships":{"author":{"data":{"type":"people","id":"1"}}}},{"type":"books","id":"2","attributes":{"title":"Bar","year":1997},"relationships":{"author":{"data":{"type":"people","id":"1"}}}}],"included":[{"type":"people","id":"1","attributes":{"name":"Dave"}}]}';
        $this->assertSame($expectedJson, $scope->toJson());
    }

    public function testSerializingItemResourceWithNestedIncludes()
    {
        $this->manager->parseIncludes(['author', 'author.published']);

        $bookData = [
            'id' => 1,
            'title' => 'Foo',
            'year' => '1991',
            '_author' => [
                'id' => 1,
                'name' => 'Dave',
                '_published' => [
                    [
                        'id' => 1,
                        'title' => 'Foo',
                        'year' => '1991',
                    ],
                    [
                        'id' => 2,
                        'title' => 'Bar',
                        'year' => '2015',
                    ],
                ],
            ],
        ];

        $resource = new Item($bookData, new JsonApiBookTransformer(), 'books');

        $scope = new Scope($this->manager, $resource);

        $expected = [
            'data' => [
                'type' => 'books',
                'id' => '1',
                'attributes' => [
                    'title' => 'Foo',
                    'year' => 1991,
                ],
                'relationships' => [
                    'author' => [
                        'data' => [
                            'type' => 'people',
                            'id' => '1',
                        ],
                    ],
                ],
            ],
            'included' => [
                [
                    'type' => 'books',
                    'id' => '2',
                    'attributes' => [
                        'title' => 'Bar',
                        'year' => 2015,
                    ],
                ],
                [
                    'type' => 'people',
                    'id' => '1',
                    'attributes' => [
                        'name' => 'Dave',
                    ],
                    'relationships' => [
                        'published' => [
                            'data' => [
                                [
                                    'type' => 'books',
                                    'id' => '1',
                                ],
                                [
                                    'type' => 'books',
                                    'id' => '2',
                                ],
                            ],
                        ],
                    ],
                ],
            ],
        ];

        $this->assertSame($expected, $scope->toArray());

        $expectedJson = '{"data":{"type":"books","id":"1","attributes":{"title":"Foo","year":1991},"relationships":{"author":{"data":{"type":"people","id":"1"}}}},"included":[{"type":"books","id":"2","attributes":{"title":"Bar","year":2015}},{"type":"people","id":"1","attributes":{"name":"Dave"},"relationships":{"published":{"data":[{"type":"books","id":"1"},{"type":"books","id":"2"}]}}}]}';
        $this->assertSame($expectedJson, $scope->toJson());
    }

    public function testSerializingItemResourceWithSelfLink()
    {
        $baseUrl = 'http://example.com';
        $this->manager->setSerializer(new JsonApiSerializer($baseUrl));

        $bookData = [
            'id' => 1,
            'title' => 'Foo',
            'year' => '1991',
            '_author' => [
                'id' => 1,
                'name' => 'Dave',
            ],
        ];

        $resource = new Item($bookData, new JsonApiBookTransformer(), 'books');

        $scope = new Scope($this->manager, $resource);

        $expected = [
            'data' => [
                'type' => 'books',
                'id' => '1',
                'attributes' => [
                    'title' => 'Foo',
                    'year' => 1991,
                ],
                'links' => [
                    'self' => 'http://example.com/books/1',
                ],
            ],
        ];

        $this->assertSame($expected, $scope->toArray());

        $expectedJson = '{"data":{"type":"books","id":"1","attributes":{"title":"Foo","year":1991},"links":{"self":"http:\/\/example.com\/books\/1"}}}';
        $this->assertSame($expectedJson, $scope->toJson());
    }

    public function testSerializingCollectionResourceWithSelfLink()
    {
        $baseUrl = 'http://example.com';
        $this->manager->setSerializer(new JsonApiSerializer($baseUrl));

        $booksData = [
            [
                'id' => 1,
                'title' => 'Foo',
                'year' => '1991',
                '_author' => [
                    'id' => 1,
                    'name' => 'Dave',
                ],
            ],
            [
                'id' => 2,
                'title' => 'Bar',
                'year' => '1997',
                '_author' => [
                    'id' => 2,
                    'name' => 'Bob',
                ],
            ],
        ];

        $resource = new Collection($booksData, new JsonApiBookTransformer(), 'books');
        $scope = new Scope($this->manager, $resource);

        $expected = [
            'data' => [
                [
                    'type' => 'books',
                    'id' => '1',
                    'attributes' => [
                        'title' => 'Foo',
                        'year' => 1991,
                    ],
                    'links' => [
                        'self' => 'http://example.com/books/1',
                    ],
                ],
                [
                    'type' => 'books',
                    'id' => '2',
                    'attributes' => [
                        'title' => 'Bar',
                        'year' => 1997,
                    ],
                    'links' => [
                        'self' => 'http://example.com/books/2',
                    ],
                ],
            ],
        ];

        $this->assertSame($expected, $scope->toArray());

        $expectedJson = '{"data":[{"type":"books","id":"1","attributes":{"title":"Foo","year":1991},"links":{"self":"http:\/\/example.com\/books\/1"}},{"type":"books","id":"2","attributes":{"title":"Bar","year":1997},"links":{"self":"http:\/\/example.com\/books\/2"}}]}';
        $this->assertSame($expectedJson, $scope->toJson());
    }

    public function testSerializingItemResourceWithLinksForHasOneRelationship()
    {
        $baseUrl = 'http://example.com';
        $this->manager->setSerializer(new JsonApiSerializer($baseUrl));
        $this->manager->parseIncludes('author');

        $bookData = [
            'id' => 1,
            'title' => 'Foo',
            'year' => '1991',
            '_author' => [
                'id' => 1,
                'name' => 'Dave',
            ],
        ];

        $resource = new Item($bookData, new JsonApiBookTransformer(), 'books');

        $scope = new Scope($this->manager, $resource);

        $expected = [
            'data' => [
                'type' => 'books',
                'id' => '1',
                'attributes' => [
                    'title' => 'Foo',
                    'year' => 1991,
                ],
                'relationships' => [
                    'author' => [
                        'links' => [
                            'self' => 'http://example.com/books/1/relationships/author',
                            'related' => 'http://example.com/books/1/author',
                        ],
                        'data' => [
                            'type' => 'people',
                            'id' => '1',
                        ],
                    ],
                ],
                'links' => [
                    'self' => 'http://example.com/books/1',
                ],
            ],
            'included' => [
                [
                    'type' => 'people',
                    'id' => '1',
                    'attributes' => [
                        'name' => 'Dave',
                    ],
                    'links' => [
                        'self' => 'http://example.com/people/1',
                    ],
                ],
            ],
        ];

        $this->assertEquals($expected, $scope->toArray());

        $expectedJson = '{"data":{"type":"books","id":"1","attributes":{"title":"Foo","year":1991},"links":{"self":"http:\/\/example.com\/books\/1"},"relationships":{"author":{"links":{"self":"http:\/\/example.com\/books\/1\/relationships\/author","related":"http:\/\/example.com\/books\/1\/author"},"data":{"type":"people","id":"1"}}}},"included":[{"type":"people","id":"1","attributes":{"name":"Dave"},"links":{"self":"http:\/\/example.com\/people\/1"}}]}';
        $this->assertSame($expectedJson, $scope->toJson());
    }

    public function testSerializingItemResourceWithLinksForHasManyRelationship()
    {
        $baseUrl = 'http://example.com';
        $this->manager->setSerializer(new JsonApiSerializer($baseUrl));
        $this->manager->parseIncludes('published');

        $authorData = [
            'id' => 1,
            'name' => 'Dave',
            '_published' => [
                [
                    'id' => 1,
                    'title' => 'Foo',
                    'year' => '1991',
                ],
                [
                    'id' => 2,
                    'title' => 'Bar',
                    'year' => '2015',
                ],
            ],
        ];

        $resource = new Item($authorData, new JsonApiAuthorTransformer(), 'people');

        $scope = new Scope($this->manager, $resource);

        $expected = [
            'data' => [
                'type' => 'people',
                'id' => '1',
                'attributes' => [
                    'name' => 'Dave',
                ],
                'relationships' => [
                    'published' => [
                        'links' => [
                            'self' => 'http://example.com/people/1/relationships/published',
                            'related' => 'http://example.com/people/1/published',
                        ],
                        'data' => [
                            [
                                'type' => 'books',
                                'id' => 1,
                            ],
                            [
                                'type' => 'books',
                                'id' => 2,
                            ],
                        ],
                    ],
                ],
                'links' => [
                    'self' => 'http://example.com/people/1',
                ],
            ],
            'included' => [
                [
                    'type' => 'books',
                    'id' => '1',
                    'attributes' => [
                        'title' => 'Foo',
                        'year' => 1991,
                    ],
                    'links' => [
                        'self' => 'http://example.com/books/1',
                    ],
                ],
                [
                    'type' => 'books',
                    'id' => '2',
                    'attributes' => [
                        'title' => 'Bar',
                        'year' => 2015,
                    ],
                    'links' => [
                        'self' => 'http://example.com/books/2',
                    ],
                ],
            ],
        ];

        $this->assertEquals($expected, $scope->toArray());

        $expectedJson = '{"data":{"type":"people","id":"1","attributes":{"name":"Dave"},"links":{"self":"http:\/\/example.com\/people\/1"},"relationships":{"published":{"links":{"self":"http:\/\/example.com\/people\/1\/relationships\/published","related":"http:\/\/example.com\/people\/1\/published"},"data":[{"type":"books","id":"1"},{"type":"books","id":"2"}]}}},"included":[{"type":"books","id":"1","attributes":{"title":"Foo","year":1991},"links":{"self":"http:\/\/example.com\/books\/1"}},{"type":"books","id":"2","attributes":{"title":"Bar","year":2015},"links":{"self":"http:\/\/example.com\/books\/2"}}]}';
        $this->assertSame($expectedJson, $scope->toJson());
    }

    public function testSerializingCollectionResourceWithLinksForHasOneRelationship()
    {
        $baseUrl = 'http://example.com';
        $this->manager->setSerializer(new JsonApiSerializer($baseUrl));
        $this->manager->parseIncludes('author');

        $bookData = [
            [
                'id' => 1,
                'title' => 'Foo',
                'year' => '1991',
                '_author' => [
                    'id' => 1,
                    'name' => 'Dave',
                ],
            ],
            [
                'id' => 2,
                'title' => 'Bar',
                'year' => '1991',
                '_author' => [
                    'id' => 1,
                    'name' => 'Dave',
                ],
            ],
        ];

        $resource = new Collection($bookData, new JsonApiBookTransformer(), 'books');

        $scope = new Scope($this->manager, $resource);

        $expected = [
            'data' => [
                [
                    'type' => 'books',
                    'id' => '1',
                    'attributes' => [
                        'title' => 'Foo',
                        'year' => 1991,
                    ],
                    'relationships' => [
                        'author' => [
                            'links' => [
                                'self' => 'http://example.com/books/1/relationships/author',
                                'related' => 'http://example.com/books/1/author',
                            ],
                            'data' => [
                                'type' => 'people',
                                'id' => '1',
                            ],
                        ],
                    ],
                    'links' => [
                        'self' => 'http://example.com/books/1',
                    ],
                ],
                [
                    'type' => 'books',
                    'id' => '2',
                    'attributes' => [
                        'title' => 'Bar',
                        'year' => 1991,
                    ],
                    'relationships' => [
                        'author' => [
                            'links' => [
                                'self' => 'http://example.com/books/2/relationships/author',
                                'related' => 'http://example.com/books/2/author',
                            ],
                            'data' => [
                                'type' => 'people',
                                'id' => '1',
                            ],
                        ],
                    ],
                    'links' => [
                        'self' => 'http://example.com/books/2',
                    ],
                ],
            ],
            'included' => [
                [
                    'type' => 'people',
                    'id' => '1',
                    'attributes' => [
                        'name' => 'Dave',
                    ],
                    'links' => [
                        'self' => 'http://example.com/people/1',
                    ],
                ],
            ],
        ];

        $this->assertEquals($expected, $scope->toArray());

        $expectedJson = '{"data":[{"type":"books","id":"1","attributes":{"title":"Foo","year":1991},"links":{"self":"http:\/\/example.com\/books\/1"},"relationships":{"author":{"links":{"self":"http:\/\/example.com\/books\/1\/relationships\/author","related":"http:\/\/example.com\/books\/1\/author"},"data":{"type":"people","id":"1"}}}},{"type":"books","id":"2","attributes":{"title":"Bar","year":1991},"links":{"self":"http:\/\/example.com\/books\/2"},"relationships":{"author":{"links":{"self":"http:\/\/example.com\/books\/2\/relationships\/author","related":"http:\/\/example.com\/books\/2\/author"},"data":{"type":"people","id":"1"}}}}],"included":[{"type":"people","id":"1","attributes":{"name":"Dave"},"links":{"self":"http:\/\/example.com\/people\/1"}}]}';
        $this->assertSame($expectedJson, $scope->toJson());
    }

    public function testSerializingCollectionResourceWithLinksForHasManyRelationship()
    {
        $baseUrl = 'http://example.com';
        $this->manager->setSerializer(new JsonApiSerializer($baseUrl));
        $this->manager->parseIncludes('published');

        $authorData = [
            [
                'id' => 1,
                'name' => 'Dave',
                '_published' => [
                    [
                        'id' => 1,
                        'title' => 'Foo',
                        'year' => '1991',
                    ],
                    [
                        'id' => 2,
                        'title' => 'Bar',
                        'year' => '2015',
                    ],
                ],
            ],
            [
                'id' => 2,
                'name' => 'Bill',
                '_published' => [
                    [
                        'id' => 1,
                        'title' => 'Foo',
                        'year' => '1991',
                    ],
                    [
                        'id' => 2,
                        'title' => 'Bar',
                        'year' => '2015',
                    ],
                ],
            ],
        ];

        $resource = new Collection($authorData, new JsonApiAuthorTransformer(), 'people');

        $scope = new Scope($this->manager, $resource);

        $expected = [
            'data' => [
                [
                    'type' => 'people',
                    'id' => '1',
                    'attributes' => [
                        'name' => 'Dave',
                    ],
                    'relationships' => [
                        'published' => [
                            'links' => [
                                'self' => 'http://example.com/people/1/relationships/published',
                                'related' => 'http://example.com/people/1/published',
                            ],
                            'data' => [
                                [
                                    'type' => 'books',
                                    'id' => 1,
                                ],
                                [
                                    'type' => 'books',
                                    'id' => 2,
                                ],
                            ],
                        ],
                    ],
                    'links' => [
                        'self' => 'http://example.com/people/1',
                    ],
                ],
                [
                    'type' => 'people',
                    'id' => '2',
                    'attributes' => [
                        'name' => 'Bill',
                    ],
                    'relationships' => [
                        'published' => [
                            'links' => [
                                'self' => 'http://example.com/people/2/relationships/published',
                                'related' => 'http://example.com/people/2/published',
                            ],
                            'data' => [
                                [
                                    'type' => 'books',
                                    'id' => 1,
                                ],
                                [
                                    'type' => 'books',
                                    'id' => 2,
                                ],
                            ],
                        ],
                    ],
                    'links' => [
                        'self' => 'http://example.com/people/2',
                    ],
                ],
            ],
            'included' => [
                [
                    'type' => 'books',
                    'id' => '1',
                    'attributes' => [
                        'title' => 'Foo',
                        'year' => 1991,
                    ],
                    'links' => [
                        'self' => 'http://example.com/books/1',
                    ],
                ],
                [
                    'type' => 'books',
                    'id' => '2',
                    'attributes' => [
                        'title' => 'Bar',
                        'year' => 2015,
                    ],
                    'links' => [
                        'self' => 'http://example.com/books/2',
                    ],
                ],
            ],
        ];

        $this->assertEquals($expected, $scope->toArray());

        $expectedJson = '{"data":[{"type":"people","id":"1","attributes":{"name":"Dave"},"links":{"self":"http:\/\/example.com\/people\/1"},"relationships":{"published":{"links":{"self":"http:\/\/example.com\/people\/1\/relationships\/published","related":"http:\/\/example.com\/people\/1\/published"},"data":[{"type":"books","id":"1"},{"type":"books","id":"2"}]}}},{"type":"people","id":"2","attributes":{"name":"Bill"},"links":{"self":"http:\/\/example.com\/people\/2"},"relationships":{"published":{"links":{"self":"http:\/\/example.com\/people\/2\/relationships\/published","related":"http:\/\/example.com\/people\/2\/published"},"data":[{"type":"books","id":"1"},{"type":"books","id":"2"}]}}}],"included":[{"type":"books","id":"1","attributes":{"title":"Foo","year":1991},"links":{"self":"http:\/\/example.com\/books\/1"}},{"type":"books","id":"2","attributes":{"title":"Bar","year":2015},"links":{"self":"http:\/\/example.com\/books\/2"}}]}';
        $this->assertSame($expectedJson, $scope->toJson());
    }

    /**
     * @expectedException InvalidArgumentException
     * @expectedExceptionMessage JSON API resource objects MUST have a valid id
     */
    public function testExceptionThrownIfResourceHasNoId()
    {
        $bookData = [
            'title' => 'Foo',
            'year' => '1991',
        ];

        $resource = new Item($bookData, new JsonApiBookTransformer(), 'books');

        $scope = new Scope($this->manager, $resource);
        $scope->toArray();
    }

    public function testSerializingItemWithReferenceToRootObject()
    {
        $this->manager->parseIncludes('published.author');

        $authorData = [
            'id' => 1,
            'name' => 'Dave',
            '_published' => [
                [
                    'id' => 1,
                    'title' => 'Foo',
                    'year' => 1991,
                    '_author' => ['id' => 1]
                ],
                [
                    'id' => 2,
                    'title' => 'Bar',
                    'year' => 2015,
                    '_author' => ['id' => 1]
                ],
            ],
        ];

        $resource = new Item($authorData, new JsonApiAuthorTransformer(), 'people');

        $scope = new Scope($this->manager, $resource);

        $expected = [
            'data' => [
                'type' => 'people',
                'id' => '1',
                'attributes' => [
                    'name' => 'Dave',
                ],
                'relationships' => [
                    'published' => [
                        'data' => [
                            ['type' => 'books', 'id' => '1'],
                            ['type' => 'books', 'id' => '2'],
                        ],
                    ],
                ],
            ],
            'included' => [
                [
                    'type' => 'books',
                    'id' => '1',
                    'attributes' => [
                        'title' => 'Foo',
                        'year' => 1991,
                    ],
                    'relationships' => [
                        'author' => [
                            'data' => ['type' => 'people', 'id' => '1'],
                        ],
                    ],
                ],
                [
                    'type' => 'books',
                    'id' => '2',
                    'attributes' => [
                        'title' => 'Bar',
                        'year' => 2015,
                    ],
                    'relationships' => [
                        'author' => [
                            'data' => ['type' => 'people', 'id' => '1'],
                        ],
                    ],
                ],
            ],
        ];

        $this->assertSame($expected, $scope->toArray());

        $expectedJson = '{"data":{"type":"people","id":"1","attributes":{"name":"Dave"},"relationships":{"published":{"data":[{"type":"books","id":"1"},{"type":"books","id":"2"}]}}},"included":[{"type":"books","id":"1","attributes":{"title":"Foo","year":1991},"relationships":{"author":{"data":{"type":"people","id":"1"}}}},{"type":"books","id":"2","attributes":{"title":"Bar","year":2015},"relationships":{"author":{"data":{"type":"people","id":"1"}}}}]}';
        $this->assertSame($expectedJson, $scope->toJson());
    }

    public function testSerializingCollectionWithReferenceToRootObjects()
    {
        $this->manager->parseIncludes('author.published');

        $booksData = [
            [
                'id' => 1,
                'title' => 'Foo',
                'year' => 1991,
                '_author' => [
                    'id' => 1,
                    'name' => 'Dave',
                    '_published' => [
                        [
                            'id' => 1,
                            'title' => 'Foo',
                            'year' => 1991,
                        ],
                        [
                            'id' => 2,
                            'title' => 'Bar',
                            'year' => 2015,
                        ],
                    ],
                ],
            ],
            [
                'id' => 2,
                'title' => 'Bar',
                'year' => 2015,
                '_author' => [
                    'id' => 1,
                    '_published' => [
                        [
                            'id' => 1,
                            'title' => 'Foo',
                            'year' => 1991,
                        ],
                        [
                            'id' => 2,
                            'title' => 'Bar',
                            'year' => 2015,
                        ],
                    ],
                ],
            ],
        ];

        $resource = new Collection($booksData, new JsonApiBookTransformer(), 'books');

        $scope = new Scope($this->manager, $resource);

        $expected = [
            'data' => [
                [
                    'type' => 'books',
                    'id' => '1',
                    'attributes' => [
                        'title' => 'Foo',
                        'year' => 1991,
                    ],
                    'relationships' => [
                        'author' => [
                            'data' => [
                                'type' => 'people',
                                'id' => '1',
                            ],
                        ],
                    ],
                ],
                [
                    'type' => 'books',
                    'id' => '2',
                    'attributes' => [
                        'title' => 'Bar',
                        'year' => 2015,
                    ],
                    'relationships' => [
                        'author' => [
                            'data' => [
                                'type' => 'people',
                                'id' => '1',
                            ],
                        ],
                    ],
                ],
            ],
            'included' => [
                [
                    'type' => 'people',
                    'id' => '1',
                    'attributes' => [
                        'name' => 'Dave',
                    ],
                    'relationships' => [
                        'published' => [
                            'data' => [
                                ['type' => 'books', 'id' => '1'],
                                ['type' => 'books', 'id' => '2'],
                            ],
                        ],
                    ],
                ],
            ],
        ];

        $this->assertSame($expected, $scope->toArray());

        $expectedJson = '{"data":[{"type":"books","id":"1","attributes":{"title":"Foo","year":1991},"relationships":{"author":{"data":{"type":"people","id":"1"}}}},{"type":"books","id":"2","attributes":{"title":"Bar","year":2015},"relationships":{"author":{"data":{"type":"people","id":"1"}}}}],"included":[{"type":"people","id":"1","attributes":{"name":"Dave"},"relationships":{"published":{"data":[{"type":"books","id":"1"},{"type":"books","id":"2"}]}}}]}';
        $this->assertSame($expectedJson, $scope->toJson());
    }

    public function testSerializingCollectionResourceWithPaginator()
    {
        $baseUrl = 'http://example.com';

        $this->manager->setSerializer(new JsonApiSerializer($baseUrl));

        $total = 10;
        $count = 2;
        $perPage = 2;
        $currentPage = 2;
        $lastPage = 5;
        $previousUrl = 'http://example.com/books/?page=1';
        $currentUrl = 'http://example.com/books/?page=2';
        $nextUrl = 'http://example.com/books/?page=3';
        $lastUrl = 'http://example.com/books/?page=5';

        $paginator = Mockery::mock('League\Fractal\Pagination\PaginatorInterface');
        $paginator->shouldReceive('getCurrentPage')->andReturn($currentPage);
        $paginator->shouldReceive('getLastPage')->andReturn($lastPage);
        $paginator->shouldReceive('getTotal')->andReturn($total);
        $paginator->shouldReceive('getCount')->andReturn($count);
        $paginator->shouldReceive('getPerPage')->andReturn($perPage);
        $paginator->shouldReceive('getUrl')->with(1)->andReturn($previousUrl);
        $paginator->shouldReceive('getUrl')->with(2)->andReturn($currentUrl);
        $paginator->shouldReceive('getUrl')->with(3)->andReturn($nextUrl);
        $paginator->shouldReceive('getUrl')->with(5)->andReturn($lastUrl);

        $booksData = [
            [
                'id' => 1,
                'title' => 'Foo',
                'year' => '1991',
                '_author' => [
                    'id' => 1,
                    'name' => 'Dave',
                ],
            ],
            [
                'id' => 2,
                'title' => 'Bar',
                'year' => '1997',
                '_author' => [
                    'id' => 2,
                    'name' => 'Bob',
                ],
            ],
        ];

        $resource = new Collection($booksData, new JsonApiBookTransformer(), 'books');
        $resource->setPaginator($paginator);
        $scope = new Scope($this->manager, $resource);

        $expected = [
            'data' => [
                [
                    'type' => 'books',
                    'id' => '1',
                    'attributes' => [
                        'title' => 'Foo',
                        'year' => 1991,
                    ],
                    'links' => [
                        'self' => 'http://example.com/books/1',
                    ],
                ],
                [
                    'type' => 'books',
                    'id' => '2',
                    'attributes' => [
                        'title' => 'Bar',
                        'year' => 1997,
                    ],
                    'links' => [
                        'self' => 'http://example.com/books/2',
                    ],
                ],
            ],
            'meta' => [
                'pagination' => [
                    'total' =>  10,
                    'count' => 2,
                    'per_page' => 2,
                    'current_page' => 2,
                    'total_pages' => 5
                ]
            ],
            'links' => [
                'self' => 'http://example.com/books/?page=2',
                'first' => 'http://example.com/books/?page=1',
                'prev' => 'http://example.com/books/?page=1',
                'next' => 'http://example.com/books/?page=3',
                'last' => 'http://example.com/books/?page=5'
            ]
        ];

        $this->assertSame($expected, $scope->toArray());

        $expectedJson = '{"data":[{"type":"books","id":"1","attributes":{"title":"Foo","year":1991},"links":{"self":"http:\/\/example.com\/books\/1"}},{"type":"books","id":"2","attributes":{"title":"Bar","year":1997},"links":{"self":"http:\/\/example.com\/books\/2"}}],"meta":{"pagination":{"total":10,"count":2,"per_page":2,"current_page":2,"total_pages":5}},"links":{"self":"http:\/\/example.com\/books\/?page=2","first":"http:\/\/example.com\/books\/?page=1","prev":"http:\/\/example.com\/books\/?page=1","next":"http:\/\/example.com\/books\/?page=3","last":"http:\/\/example.com\/books\/?page=5"}}';
        $this->assertSame($expectedJson, $scope->toJson());
    }

    public function testSerializingCollectionResourceWithPaginatorWithOmittedUnavailablePreviousLink()
    {
        $baseUrl = 'http://example.com';

        $this->manager->setSerializer(new JsonApiSerializer($baseUrl));

        $total = 10;
        $count = 2;
        $perPage = 2;
        $currentPage = 1;
        $lastPage = 5;
        $currentUrl = 'http://example.com/books/?page=1';
        $nextUrl = 'http://example.com/books/?page=2';
        $lastUrl = 'http://example.com/books/?page=5';

        $paginator = Mockery::mock('League\Fractal\Pagination\PaginatorInterface');
        $paginator->shouldReceive('getCurrentPage')->andReturn($currentPage);
        $paginator->shouldReceive('getLastPage')->andReturn($lastPage);
        $paginator->shouldReceive('getTotal')->andReturn($total);
        $paginator->shouldReceive('getCount')->andReturn($count);
        $paginator->shouldReceive('getPerPage')->andReturn($perPage);
        $paginator->shouldReceive('getUrl')->with(1)->andReturn($currentUrl);
        $paginator->shouldReceive('getUrl')->with(2)->andReturn($nextUrl);
        $paginator->shouldReceive('getUrl')->with(5)->andReturn($lastUrl);

        $booksData = [
            [
                'id' => 1,
                'title' => 'Foo',
                'year' => '1991',
                '_author' => [
                    'id' => 1,
                    'name' => 'Dave',
                ],
            ],
            [
                'id' => 2,
                'title' => 'Bar',
                'year' => '1997',
                '_author' => [
                    'id' => 2,
                    'name' => 'Bob',
                ],
            ],
        ];

        $resource = new Collection($booksData, new JsonApiBookTransformer(), 'books');
        $resource->setPaginator($paginator);
        $scope = new Scope($this->manager, $resource);

        $expected = [
            'data' => [
                [
                    'type' => 'books',
                    'id' => '1',
                    'attributes' => [
                        'title' => 'Foo',
                        'year' => 1991,
                    ],
                    'links' => [
                        'self' => 'http://example.com/books/1',
                    ],
                ],
                [
                    'type' => 'books',
                    'id' => '2',
                    'attributes' => [
                        'title' => 'Bar',
                        'year' => 1997,
                    ],
                    'links' => [
                        'self' => 'http://example.com/books/2',
                    ],
                ],
            ],
            'meta' => [
                'pagination' => [
                    'total' =>  10,
                    'count' => 2,
                    'per_page' => 2,
                    'current_page' => 1,
                    'total_pages' => 5
                ]
            ],
            'links' => [
                'self' => 'http://example.com/books/?page=1',
                'first' => 'http://example.com/books/?page=1',
                'next' => 'http://example.com/books/?page=2',
                'last' => 'http://example.com/books/?page=5'
            ]
        ];

        $this->assertSame($expected, $scope->toArray());

        $expectedJson = '{"data":[{"type":"books","id":"1","attributes":{"title":"Foo","year":1991},"links":{"self":"http:\/\/example.com\/books\/1"}},{"type":"books","id":"2","attributes":{"title":"Bar","year":1997},"links":{"self":"http:\/\/example.com\/books\/2"}}],"meta":{"pagination":{"total":10,"count":2,"per_page":2,"current_page":1,"total_pages":5}},"links":{"self":"http:\/\/example.com\/books\/?page=1","first":"http:\/\/example.com\/books\/?page=1","next":"http:\/\/example.com\/books\/?page=2","last":"http:\/\/example.com\/books\/?page=5"}}';
        $this->assertSame($expectedJson, $scope->toJson());
    }

    public function testSerializingCollectionResourceWithPaginatorWithOmittedUnavailableNextLink()
    {
        $baseUrl = 'http://example.com';

        $this->manager->setSerializer(new JsonApiSerializer($baseUrl));

        $total = 10;
        $count = 2;
        $perPage = 2;
        $currentPage = 5;
        $lastPage = 5;
        $firstUrl = 'http://example.com/books/?page=1';
        $previousUrl = 'http://example.com/books/?page=4';
        $lastUrl = 'http://example.com/books/?page=5';

        $paginator = Mockery::mock('League\Fractal\Pagination\PaginatorInterface');
        $paginator->shouldReceive('getCurrentPage')->andReturn($currentPage);
        $paginator->shouldReceive('getLastPage')->andReturn($lastPage);
        $paginator->shouldReceive('getTotal')->andReturn($total);
        $paginator->shouldReceive('getCount')->andReturn($count);
        $paginator->shouldReceive('getPerPage')->andReturn($perPage);
        $paginator->shouldReceive('getUrl')->with(1)->andReturn($firstUrl);
        $paginator->shouldReceive('getUrl')->with(4)->andReturn($previousUrl);
        $paginator->shouldReceive('getUrl')->with(5)->andReturn($lastUrl);

        $booksData = [
            [
                'id' => 1,
                'title' => 'Foo',
                'year' => '1991',
                '_author' => [
                    'id' => 1,
                    'name' => 'Dave',
                ],
            ],
            [
                'id' => 2,
                'title' => 'Bar',
                'year' => '1997',
                '_author' => [
                    'id' => 2,
                    'name' => 'Bob',
                ],
            ],
        ];

        $resource = new Collection($booksData, new JsonApiBookTransformer(), 'books');
        $resource->setPaginator($paginator);
        $scope = new Scope($this->manager, $resource);

        $expected = [
            'data' => [
                [
                    'type' => 'books',
                    'id' => '1',
                    'attributes' => [
                        'title' => 'Foo',
                        'year' => 1991,
                    ],
                    'links' => [
                        'self' => 'http://example.com/books/1',
                    ],
                ],
                [
                    'type' => 'books',
                    'id' => '2',
                    'attributes' => [
                        'title' => 'Bar',
                        'year' => 1997,
                    ],
                    'links' => [
                        'self' => 'http://example.com/books/2',
                    ],
                ],
            ],
            'meta' => [
                'pagination' => [
                    'total' =>  10,
                    'count' => 2,
                    'per_page' => 2,
                    'current_page' => 5,
                    'total_pages' => 5
                ]
            ],
            'links' => [
                'self' => 'http://example.com/books/?page=5',
                'first' => 'http://example.com/books/?page=1',
                'prev' => 'http://example.com/books/?page=4',
                'last' => 'http://example.com/books/?page=5'
            ]
        ];

        $this->assertSame($expected, $scope->toArray());

        $expectedJson = '{"data":[{"type":"books","id":"1","attributes":{"title":"Foo","year":1991},"links":{"self":"http:\/\/example.com\/books\/1"}},{"type":"books","id":"2","attributes":{"title":"Bar","year":1997},"links":{"self":"http:\/\/example.com\/books\/2"}}],"meta":{"pagination":{"total":10,"count":2,"per_page":2,"current_page":5,"total_pages":5}},"links":{"self":"http:\/\/example.com\/books\/?page=5","first":"http:\/\/example.com\/books\/?page=1","prev":"http:\/\/example.com\/books\/?page=4","last":"http:\/\/example.com\/books\/?page=5"}}';
        $this->assertSame($expectedJson, $scope->toJson());
    }

    public function tearDown()
    {
        Mockery::close();
    }
}

thephpleague / fractal

Pull Request — master (#290)

JsonApiSerializerTest A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

29 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like
