This repository has been archived by the owner on Jan 29, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
6 changed files
with
295 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
191 changes: 191 additions & 0 deletions
191
test/ResourceGenerator/UrlBasedCollectionWithRouteParamsTest.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,191 @@ | ||
| <?php | ||
| /** | ||
| * @see https://github.com/zendframework/zend-expressive-hal for the canonical source repository | ||
| * @copyright Copyright (c) 2017 Zend Technologies USA Inc. (http://www.zend.com) | ||
| * @license https://github.com/zendframework/zend-expressive-hal/blob/master/LICENSE.md New BSD License | ||
| */ | ||
|
|
||
| namespace ZendTest\Expressive\Hal\ResourceGenerator; | ||
|
|
||
| use PHPUnit\Framework\TestCase; | ||
| use Psr\Container\ContainerInterface; | ||
| use Psr\Http\Message\ServerRequestInterface; | ||
| use Zend\Expressive\Hal\HalResource; | ||
| use Zend\Expressive\Hal\Link; | ||
| use Zend\Expressive\Hal\LinkGenerator; | ||
| use Zend\Expressive\Hal\Metadata\MetadataMap; | ||
| use Zend\Expressive\Hal\Metadata\RouteBasedResourceMetadata; | ||
| use Zend\Expressive\Hal\Metadata\UrlBasedCollectionMetadata; | ||
| use Zend\Expressive\Hal\ResourceGenerator; | ||
| use Zend\Hydrator\ObjectProperty as ObjectPropertyHydrator; | ||
| use Zend\Paginator\Adapter\ArrayAdapter; | ||
| use Zend\Paginator\Paginator; | ||
| use ZendTest\Expressive\Hal\Assertions; | ||
| use ZendTest\Expressive\Hal\TestAsset; | ||
|
|
||
| class UrlBasedCollectionWithRouteParamsTest extends TestCase | ||
| { | ||
| use Assertions; | ||
|
|
||
| public function testUsesQueriesWithPaginatorSpecifiedInMetadataWhenGeneratingLinkHref() | ||
| { | ||
| $request = $this->prophesize(ServerRequestInterface::class); | ||
| $request->getQueryParams()->willReturn([ | ||
| 'query_1' => 'value_1', | ||
| 'p' => 3, | ||
| 'sort' => 'ASC', | ||
| ]); | ||
|
|
||
| $linkGenerator = $this->prophesize(LinkGenerator::class); | ||
|
|
||
| $metadataMap = $this->prophesize(MetadataMap::class); | ||
|
|
||
| $resourceMetadata = new RouteBasedResourceMetadata( | ||
| TestAsset\FooBar::class, | ||
| 'foo-bar', | ||
| ObjectPropertyHydrator::class, | ||
| 'id', | ||
| 'bar_id', | ||
| ['foo_id' => 1234] | ||
| ); | ||
|
|
||
| $metadataMap->has(TestAsset\FooBar::class)->willReturn(true); | ||
| $metadataMap->get(TestAsset\FooBar::class)->willReturn($resourceMetadata); | ||
|
|
||
| $collectionMetadata = new UrlBasedCollectionMetadata( | ||
| Paginator::class, | ||
| 'foo-bar', | ||
| 'http://test.local/collection/', | ||
| 'p', | ||
| 'query' | ||
| ); | ||
|
|
||
| $metadataMap->has(Paginator::class)->willReturn(true); | ||
| $metadataMap->get(Paginator::class)->willReturn($collectionMetadata); | ||
|
|
||
| $hydrators = $this->prophesize(ContainerInterface::class); | ||
| $hydrators->get(ObjectPropertyHydrator::class)->willReturn(new ObjectPropertyHydrator()); | ||
|
|
||
| $collection = new Paginator(new ArrayAdapter($this->createCollectionItems($linkGenerator, $request))); | ||
| $collection->setItemCountPerPage(3); | ||
|
|
||
| $generator = new ResourceGenerator( | ||
| $metadataMap->reveal(), | ||
| $hydrators->reveal(), | ||
| $linkGenerator->reveal() | ||
| ); | ||
|
|
||
| $generator->addStrategy( | ||
| RouteBasedResourceMetadata::class, | ||
| ResourceGenerator\RouteBasedResourceStrategy::class | ||
| ); | ||
|
|
||
| $generator->addStrategy( | ||
| UrlBasedCollectionMetadata::class, | ||
| ResourceGenerator\UrlBasedCollectionStrategy::class | ||
| ); | ||
|
|
||
| $resource = $generator->fromObject($collection, $request->reveal()); | ||
|
|
||
| $this->assertInstanceOf(HalResource::class, $resource); | ||
| $self = $this->getLinkByRel('self', $resource); | ||
| $this->assertLink('self', 'http://test.local/collection/?query_1=value_1&p=3&sort=ASC', $self); | ||
| $first = $this->getLinkByRel('first', $resource); | ||
| $this->assertLink('first', 'http://test.local/collection/?query_1=value_1&p=1&sort=ASC', $first); | ||
| $prev = $this->getLinkByRel('prev', $resource); | ||
| $this->assertLink('prev', 'http://test.local/collection/?query_1=value_1&p=2&sort=ASC', $prev); | ||
| $next = $this->getLinkByRel('next', $resource); | ||
| $this->assertLink('next', 'http://test.local/collection/?query_1=value_1&p=4&sort=ASC', $next); | ||
| $last = $this->getLinkByRel('last', $resource); | ||
| $this->assertLink('last', 'http://test.local/collection/?query_1=value_1&p=5&sort=ASC', $last); | ||
| } | ||
|
|
||
| public function testUsesQueriesSpecifiedInMetadataWhenGeneratingLinkHref() | ||
| { | ||
| $request = $this->prophesize(ServerRequestInterface::class); | ||
| $request->getQueryParams()->willReturn([ | ||
| 'query_1' => 'value_1', | ||
| 'query_2' => 'value_2', | ||
| ]); | ||
|
|
||
| $metadataMap = $this->prophesize(MetadataMap::class); | ||
|
|
||
| $resourceMetadata = new RouteBasedResourceMetadata( | ||
| TestAsset\FooBar::class, | ||
| 'foo-bar', | ||
| ObjectPropertyHydrator::class, | ||
| 'id', | ||
| 'bar_id', | ||
| ['foo_id' => 1234] | ||
| ); | ||
|
|
||
| $metadataMap->has(TestAsset\FooBar::class)->willReturn(true); | ||
| $metadataMap->get(TestAsset\FooBar::class)->willReturn($resourceMetadata); | ||
|
|
||
| $collectionMetadata = new UrlBasedCollectionMetadata( | ||
| \ArrayObject::class, | ||
| 'foo-bar', | ||
| 'http://test.local/collection/', | ||
| 'p', | ||
| 'query' | ||
| ); | ||
| $linkGenerator = $this->prophesize(LinkGenerator::class); | ||
|
|
||
| $metadataMap->has(\ArrayObject::class)->willReturn(true); | ||
| $metadataMap->get(\ArrayObject::class)->willReturn($collectionMetadata); | ||
|
|
||
| $hydrators = $this->prophesize(ContainerInterface::class); | ||
| $hydrators->get(ObjectPropertyHydrator::class)->willReturn(new ObjectPropertyHydrator()); | ||
|
|
||
| $collection = new \ArrayObject(); | ||
|
|
||
| $generator = new ResourceGenerator( | ||
| $metadataMap->reveal(), | ||
| $hydrators->reveal(), | ||
| $linkGenerator->reveal() | ||
| ); | ||
|
|
||
| $generator->addStrategy( | ||
| RouteBasedResourceMetadata::class, | ||
| ResourceGenerator\RouteBasedResourceStrategy::class | ||
| ); | ||
|
|
||
| $generator->addStrategy( | ||
| UrlBasedCollectionMetadata::class, | ||
| ResourceGenerator\UrlBasedCollectionStrategy::class | ||
| ); | ||
|
|
||
| $resource = $generator->fromObject($collection, $request->reveal()); | ||
|
|
||
| $this->assertInstanceOf(HalResource::class, $resource); | ||
| $self = $this->getLinkByRel('self', $resource); | ||
| $this->assertLink('self', 'http://test.local/collection/?query_1=value_1&query_2=value_2', $self); | ||
| } | ||
|
|
||
| private function createCollectionItems($linkGenerator, $request) : array | ||
| { | ||
| $instance = new TestAsset\FooBar; | ||
| $instance->foo = 'BAR'; | ||
| $instance->bar = 'BAZ'; | ||
|
|
||
| $items = []; | ||
| for ($i = 1; $i < 15; $i += 1) { | ||
| $next = clone $instance; | ||
| $next->id = $i; | ||
| $items[] = $next; | ||
|
|
||
| $linkGenerator | ||
| ->fromRoute( | ||
| 'self', | ||
| $request->reveal(), | ||
| 'foo-bar', | ||
| [ | ||
| 'foo_id' => 1234, | ||
| 'bar_id' => $i, | ||
| ] | ||
| ) | ||
| ->willReturn(new Link('self', '/api/foo/1234/bar/' . $i)); | ||
| } | ||
| return $items; | ||
| } | ||
| } |