| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451 |
- <?php
- namespace Illuminate\Tests\Integration\Http;
- use Illuminate\Foundation\Http\Middleware\ValidatePostSize;
- use Illuminate\Http\Exceptions\PostTooLargeException;
- use Illuminate\Http\Request;
- use Illuminate\Http\Resources\ConditionallyLoadsAttributes;
- use Illuminate\Http\Resources\Json\JsonResource;
- use Illuminate\Http\Resources\MergeValue;
- use Illuminate\Http\Resources\MissingValue;
- use Illuminate\Pagination\Cursor;
- use Illuminate\Pagination\CursorPaginator;
- use Illuminate\Pagination\LengthAwarePaginator;
- use Illuminate\Support\Collection;
- use Illuminate\Support\Facades\Route;
- use Illuminate\Tests\Integration\Http\Fixtures\Author;
- use Illuminate\Tests\Integration\Http\Fixtures\AuthorResourceWithOptionalRelationship;
- use Illuminate\Tests\Integration\Http\Fixtures\EmptyPostCollectionResource;
- use Illuminate\Tests\Integration\Http\Fixtures\ObjectResource;
- use Illuminate\Tests\Integration\Http\Fixtures\Post;
- use Illuminate\Tests\Integration\Http\Fixtures\PostCollectionResource;
- use Illuminate\Tests\Integration\Http\Fixtures\PostCollectionResourceWithPaginationInformation;
- use Illuminate\Tests\Integration\Http\Fixtures\PostResource;
- use Illuminate\Tests\Integration\Http\Fixtures\PostResourceWithAnonymousResourceCollectionWithPaginationInformation;
- use Illuminate\Tests\Integration\Http\Fixtures\PostResourceWithExtraData;
- use Illuminate\Tests\Integration\Http\Fixtures\PostResourceWithJsonOptions;
- use Illuminate\Tests\Integration\Http\Fixtures\PostResourceWithJsonOptionsAndTypeHints;
- use Illuminate\Tests\Integration\Http\Fixtures\PostResourceWithOptionalAppendedAttributes;
- use Illuminate\Tests\Integration\Http\Fixtures\PostResourceWithOptionalData;
- use Illuminate\Tests\Integration\Http\Fixtures\PostResourceWithOptionalMerging;
- use Illuminate\Tests\Integration\Http\Fixtures\PostResourceWithOptionalPivotRelationship;
- use Illuminate\Tests\Integration\Http\Fixtures\PostResourceWithOptionalRelationship;
- use Illuminate\Tests\Integration\Http\Fixtures\PostResourceWithoutWrap;
- use Illuminate\Tests\Integration\Http\Fixtures\ReallyEmptyPostResource;
- use Illuminate\Tests\Integration\Http\Fixtures\ResourceWithPreservedKeys;
- use Illuminate\Tests\Integration\Http\Fixtures\SerializablePostResource;
- use Illuminate\Tests\Integration\Http\Fixtures\Subscription;
- use Mockery;
- use Orchestra\Testbench\TestCase;
- class ResourceTest extends TestCase
- {
- public function testResourcesMayBeConvertedToJson()
- {
- Route::get('/', function () {
- return new PostResource(new Post([
- 'id' => 5,
- 'title' => 'Test Title',
- 'abstract' => 'Test abstract',
- ]));
- });
- $response = $this->withoutExceptionHandling()->get(
- '/', ['Accept' => 'application/json']
- );
- $response->assertStatus(200);
- $response->assertJson([
- 'data' => [
- 'id' => 5,
- 'title' => 'Test Title',
- ],
- ]);
- }
- public function testResourcesMayBeConvertedToJsonWithToJsonMethod()
- {
- $resource = new PostResource(new Post([
- 'id' => 5,
- 'title' => 'Test Title',
- 'abstract' => 'Test abstract',
- ]));
- $this->assertSame('{"id":5,"title":"Test Title","custom":true}', $resource->toJson());
- }
- public function testAnObjectsMayBeConvertedToJson()
- {
- Route::get('/', function () {
- return ObjectResource::make(
- (object) ['first_name' => 'Bob', 'age' => 40]
- );
- });
- $this->withoutExceptionHandling()
- ->get('/', ['Accept' => 'application/json'])
- ->assertStatus(200)
- ->assertExactJson([
- 'data' => [
- 'name' => 'Bob',
- 'age' => 40,
- ],
- ]);
- }
- public function testArraysWithObjectsMayBeConvertedToJson()
- {
- Route::get('/', function () {
- $objects = [
- (object) ['first_name' => 'Bob', 'age' => 40],
- (object) ['first_name' => 'Jack', 'age' => 25],
- ];
- return ObjectResource::collection($objects);
- });
- $this->withoutExceptionHandling()
- ->get('/', ['Accept' => 'application/json'])
- ->assertStatus(200)
- ->assertExactJson([
- 'data' => [
- ['name' => 'Bob', 'age' => 40],
- ['name' => 'Jack', 'age' => 25],
- ],
- ]);
- }
- public function testResourcesMayHaveNoWrap()
- {
- Route::get('/', function () {
- return new PostResourceWithoutWrap(new Post([
- 'id' => 5,
- 'title' => 'Test Title',
- ]));
- });
- $response = $this->withoutExceptionHandling()->get(
- '/', ['Accept' => 'application/json']
- );
- $response->assertJson([
- 'id' => 5,
- 'title' => 'Test Title',
- ]);
- }
- public function testResourcesMayHaveOptionalValues()
- {
- Route::get('/', function () {
- return new PostResourceWithOptionalData(new Post([
- 'id' => 5,
- ]));
- });
- $response = $this->withoutExceptionHandling()->get(
- '/', ['Accept' => 'application/json']
- );
- $response->assertStatus(200);
- $response->assertJson([
- 'data' => [
- 'id' => 5,
- 'second' => 'value',
- 'third' => 'value',
- 'fourth' => 'default',
- 'fifth' => 'default',
- ],
- ]);
- }
- public function testResourcesMayHaveOptionalAppendedAttributes()
- {
- Route::get('/', function () {
- $post = new Post([
- 'id' => 5,
- ]);
- $post->append('is_published');
- return new PostResourceWithOptionalAppendedAttributes($post);
- });
- $response = $this->withoutExceptionHandling()->get(
- '/', ['Accept' => 'application/json']
- );
- $response->assertStatus(200);
- $response->assertJson([
- 'data' => [
- 'id' => 5,
- 'first' => true,
- 'second' => 'override value',
- 'third' => 'override value',
- 'fourth' => true,
- 'fifth' => true,
- ],
- ]);
- }
- public function testResourcesWithOptionalAppendedAttributesReturnDefaultValuesAndNotMissingValues()
- {
- Route::get('/', function () {
- return new PostResourceWithOptionalAppendedAttributes(new Post([
- 'id' => 5,
- ]));
- });
- $response = $this->withoutExceptionHandling()->get(
- '/', ['Accept' => 'application/json']
- );
- $response->assertStatus(200);
- $response->assertExactJson([
- 'data' => [
- 'id' => 5,
- 'fourth' => 'default',
- 'fifth' => 'default',
- ],
- ]);
- }
- public function testResourcesMayHaveOptionalMerges()
- {
- Route::get('/', function () {
- return new PostResourceWithOptionalMerging(new Post([
- 'id' => 5,
- ]));
- });
- $response = $this->withoutExceptionHandling()->get(
- '/', ['Accept' => 'application/json']
- );
- $response->assertStatus(200);
- $response->assertExactJson([
- 'data' => [
- 'id' => 5,
- 'second' => 'value',
- ],
- ]);
- }
- public function testResourcesMayHaveOptionalRelationships()
- {
- Route::get('/', function () {
- return new PostResourceWithOptionalRelationship(new Post([
- 'id' => 5,
- 'title' => 'Test Title',
- ]));
- });
- $response = $this->withoutExceptionHandling()->get(
- '/', ['Accept' => 'application/json']
- );
- $response->assertStatus(200);
- $response->assertExactJson([
- 'data' => [
- 'id' => 5,
- ],
- ]);
- }
- public function testResourcesMayLoadOptionalRelationships()
- {
- Route::get('/', function () {
- $post = new Post([
- 'id' => 5,
- 'title' => 'Test Title',
- ]);
- $post->setRelation('author', new Author(['name' => 'jrrmartin']));
- return new PostResourceWithOptionalRelationship($post);
- });
- $response = $this->withoutExceptionHandling()->get(
- '/', ['Accept' => 'application/json']
- );
- $response->assertStatus(200);
- $response->assertExactJson([
- 'data' => [
- 'id' => 5,
- 'author' => ['name' => 'jrrmartin'],
- 'author_name' => 'jrrmartin',
- ],
- ]);
- }
- public function testResourcesMayShowsNullForLoadedRelationshipWithValueNull()
- {
- Route::get('/', function () {
- $post = new Post([
- 'id' => 5,
- 'title' => 'Test Title',
- ]);
- $post->setRelation('author', null);
- return new PostResourceWithOptionalRelationship($post);
- });
- $response = $this->withoutExceptionHandling()->get(
- '/', ['Accept' => 'application/json']
- );
- $response->assertStatus(200);
- $response->assertExactJson([
- 'data' => [
- 'id' => 5,
- 'author' => null,
- 'author_name' => null,
- ],
- ]);
- }
- public function testResourcesMayHaveOptionalRelationshipsWithDefaultValues()
- {
- Route::get('/', function () {
- return new AuthorResourceWithOptionalRelationship(new Author([
- 'name' => 'jrrmartin',
- ]));
- });
- $response = $this->withoutExceptionHandling()->get(
- '/', ['Accept' => 'application/json']
- );
- $response->assertStatus(200);
- $response->assertExactJson([
- 'data' => [
- 'name' => 'jrrmartin',
- 'posts_count' => 'not loaded',
- 'latest_post_title' => 'not loaded',
- ],
- ]);
- }
- public function testResourcesMayHaveOptionalPivotRelationships()
- {
- Route::get('/', function () {
- $post = new Post(['id' => 5]);
- $post->setRelation('pivot', new Subscription);
- return new PostResourceWithOptionalPivotRelationship($post);
- });
- $response = $this->withoutExceptionHandling()->get(
- '/', ['Accept' => 'application/json']
- );
- $response->assertStatus(200);
- $response->assertExactJson([
- 'data' => [
- 'id' => 5,
- 'subscription' => [
- 'foo' => 'bar',
- ],
- ],
- ]);
- }
- public function testResourcesMayHaveOptionalPivotRelationshipsWithCustomAccessor()
- {
- Route::get('/', function () {
- $post = new Post(['id' => 5]);
- $post->setRelation('accessor', new Subscription);
- return new PostResourceWithOptionalPivotRelationship($post);
- });
- $response = $this->withoutExceptionHandling()->get(
- '/', ['Accept' => 'application/json']
- );
- $response->assertStatus(200);
- $response->assertExactJson([
- 'data' => [
- 'id' => 5,
- 'custom_subscription' => [
- 'foo' => 'bar',
- ],
- ],
- ]);
- }
- public function testResourceIsUrlRoutable()
- {
- $post = new PostResource(new Post([
- 'id' => 5,
- 'title' => 'Test Title',
- ]));
- $this->assertSame('http://localhost/post/5', url('/post', $post));
- }
- public function testNamedRoutesAreUrlRoutable()
- {
- $post = new PostResource(new Post([
- 'id' => 5,
- 'title' => 'Test Title',
- ]));
- Route::get('/post/{id}', function () use ($post) {
- return route('post.show', $post);
- })->name('post.show');
- $response = $this->withoutExceptionHandling()->get('/post/1');
- $this->assertSame('http://localhost/post/5', $response->original);
- }
- public function testResourcesMayBeSerializable()
- {
- Route::get('/', function () {
- return new SerializablePostResource(new Post([
- 'id' => 5,
- 'title' => 'Test Title',
- ]));
- });
- $response = $this->withoutExceptionHandling()->get(
- '/', ['Accept' => 'application/json']
- );
- $response->assertStatus(200);
- $response->assertJson([
- 'data' => [
- 'id' => 5,
- ],
- ]);
- }
- public function testResourcesMayCustomizeResponses()
- {
- Route::get('/', function () {
- return new PostResource(new Post([
- 'id' => 5,
- 'title' => 'Test Title',
- ]));
- });
- $response = $this->withoutExceptionHandling()->get(
- '/', ['Accept' => 'application/json']
- );
- $response->assertStatus(200);
- $response->assertHeader('X-Resource', 'True');
- }
- public function testResourcesMayCustomizeExtraData()
- {
- Route::get('/', function () {
- return new PostResourceWithExtraData(new Post([
- 'id' => 5,
- 'title' => 'Test Title',
- ]));
- });
- $response = $this->withoutExceptionHandling()->get(
- '/', ['Accept' => 'application/json']
- );
- $response->assertJson([
- 'data' => [
- 'id' => 5,
- 'title' => 'Test Title',
- ],
- 'foo' => 'bar',
- ]);
- }
- public function testResourcesMayCustomizeExtraDataWhenBuildingResponse()
- {
- Route::get('/', function () {
- return (new PostResourceWithExtraData(new Post([
- 'id' => 5,
- 'title' => 'Test Title',
- ])))->additional(['baz' => 'qux']);
- });
- $response = $this->withoutExceptionHandling()->get(
- '/', ['Accept' => 'application/json']
- );
- $response->assertJson([
- 'data' => [
- 'id' => 5,
- 'title' => 'Test Title',
- ],
- 'foo' => 'bar',
- 'baz' => 'qux',
- ]);
- }
- public function testResourcesMayCustomizeJsonOptions()
- {
- Route::get('/', function () {
- return new PostResourceWithJsonOptions(new Post([
- 'id' => 5,
- 'title' => 'Test Title',
- 'reading_time' => 3.0,
- ]));
- });
- $response = $this->withoutExceptionHandling()->get(
- '/', ['Accept' => 'application/json']
- );
- $this->assertEquals(
- '{"data":{"id":5,"title":"Test Title","reading_time":3.0}}',
- $response->baseResponse->content()
- );
- }
- public function testCollectionResourcesMayCustomizeJsonOptions()
- {
- Route::get('/', function () {
- return PostResourceWithJsonOptions::collection(collect([
- new Post(['id' => 5, 'title' => 'Test Title', 'reading_time' => 3.0]),
- ]));
- });
- $response = $this->withoutExceptionHandling()->get(
- '/', ['Accept' => 'application/json']
- );
- $this->assertEquals(
- '{"data":[{"id":5,"title":"Test Title","reading_time":3.0}]}',
- $response->baseResponse->content()
- );
- }
- public function testResourcesMayCustomizeJsonOptionsOnPaginatedResponse()
- {
- Route::get('/', function () {
- $paginator = new LengthAwarePaginator(
- collect([new Post(['id' => 5, 'title' => 'Test Title', 'reading_time' => 3.0])]),
- 10, 15, 1
- );
- return PostResourceWithJsonOptions::collection($paginator);
- });
- $response = $this->withoutExceptionHandling()->get(
- '/', ['Accept' => 'application/json']
- );
- $this->assertEquals(
- '{"data":[{"id":5,"title":"Test Title","reading_time":3.0}],"links":{"first":"\/?page=1","last":"\/?page=1","prev":null,"next":null},"meta":{"current_page":1,"from":1,"last_page":1,"links":[{"url":null,"label":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":15,"to":1,"total":10}}',
- $response->baseResponse->content()
- );
- }
- public function testResourcesMayCustomizeJsonOptionsWithTypeHintedConstructor()
- {
- Route::get('/', function () {
- return new PostResourceWithJsonOptionsAndTypeHints(new Post([
- 'id' => 5,
- 'title' => 'Test Title',
- 'reading_time' => 3.0,
- ]));
- });
- $response = $this->withoutExceptionHandling()->get(
- '/', ['Accept' => 'application/json']
- );
- $this->assertEquals(
- '{"data":{"id":5,"title":"Test Title","reading_time":3.0}}',
- $response->baseResponse->content()
- );
- }
- public function testCustomHeadersMayBeSetOnResponses()
- {
- Route::get('/', function () {
- return (new PostResource(new Post([
- 'id' => 5,
- 'title' => 'Test Title',
- ])))->response()->setStatusCode(202)->header('X-Custom', 'True');
- });
- $response = $this->withoutExceptionHandling()->get(
- '/', ['Accept' => 'application/json']
- );
- $response->assertStatus(202);
- $response->assertHeader('X-Custom', 'True');
- }
- public function testResourcesMayReceiveProperStatusCodeForFreshModels()
- {
- Route::get('/', function () {
- $post = new Post([
- 'id' => 5,
- 'title' => 'Test Title',
- ]);
- $post->wasRecentlyCreated = true;
- return new PostResource($post);
- });
- $response = $this->withoutExceptionHandling()->get(
- '/', ['Accept' => 'application/json']
- );
- $response->assertStatus(201);
- }
- public function testCollectionsAreNotDoubledWrapped()
- {
- Route::get('/', function () {
- return new PostCollectionResource(collect([new Post([
- 'id' => 5,
- 'title' => 'Test Title',
- ])]));
- });
- $response = $this->withoutExceptionHandling()->get(
- '/', ['Accept' => 'application/json']
- );
- $response->assertStatus(200);
- $response->assertJson([
- 'data' => [
- [
- 'id' => 5,
- 'title' => 'Test Title',
- ],
- ],
- ]);
- }
- public function testPaginatorsReceiveLinks()
- {
- Route::get('/', function () {
- $paginator = new LengthAwarePaginator(
- collect([new Post(['id' => 5, 'title' => 'Test Title'])]),
- 10, 15, 1
- );
- return new PostCollectionResource($paginator);
- });
- $response = $this->withoutExceptionHandling()->get(
- '/', ['Accept' => 'application/json']
- );
- $response->assertStatus(200);
- $response->assertJson([
- 'data' => [
- [
- 'id' => 5,
- 'title' => 'Test Title',
- ],
- ],
- 'links' => [
- 'first' => '/?page=1',
- 'last' => '/?page=1',
- 'prev' => null,
- 'next' => null,
- ],
- 'meta' => [
- 'current_page' => 1,
- 'from' => 1,
- 'last_page' => 1,
- 'path' => '/',
- 'per_page' => 15,
- 'to' => 1,
- 'total' => 10,
- ],
- ]);
- }
- public function testPaginatorResourceCanPreserveQueryParameters()
- {
- Route::get('/', function () {
- $collection = collect([new Post(['id' => 2, 'title' => 'Laravel Nova'])]);
- $paginator = new LengthAwarePaginator(
- $collection, 3, 1, 2
- );
- return PostCollectionResource::make($paginator)->preserveQuery();
- });
- $response = $this->withoutExceptionHandling()->get(
- '/?framework=laravel&author=Otwell&page=2', ['Accept' => 'application/json']
- );
- $response->assertStatus(200);
- $response->assertJson([
- 'data' => [
- [
- 'id' => 2,
- 'title' => 'Laravel Nova',
- ],
- ],
- 'links' => [
- 'first' => '/?framework=laravel&author=Otwell&page=1',
- 'last' => '/?framework=laravel&author=Otwell&page=3',
- 'prev' => '/?framework=laravel&author=Otwell&page=1',
- 'next' => '/?framework=laravel&author=Otwell&page=3',
- ],
- 'meta' => [
- 'current_page' => 2,
- 'from' => 2,
- 'last_page' => 3,
- 'path' => '/',
- 'per_page' => 1,
- 'to' => 2,
- 'total' => 3,
- ],
- ]);
- }
- public function testPaginatorResourceCanReceiveQueryParameters()
- {
- Route::get('/', function () {
- $collection = collect([new Post(['id' => 2, 'title' => 'Laravel Nova'])]);
- $paginator = new LengthAwarePaginator(
- $collection, 3, 1, 2
- );
- return PostCollectionResource::make($paginator)->withQuery(['author' => 'Taylor']);
- });
- $response = $this->withoutExceptionHandling()->get(
- '/?framework=laravel&author=Otwell&page=2', ['Accept' => 'application/json']
- );
- $response->assertStatus(200);
- $response->assertJson([
- 'data' => [
- [
- 'id' => 2,
- 'title' => 'Laravel Nova',
- ],
- ],
- 'links' => [
- 'first' => '/?author=Taylor&page=1',
- 'last' => '/?author=Taylor&page=3',
- 'prev' => '/?author=Taylor&page=1',
- 'next' => '/?author=Taylor&page=3',
- ],
- 'meta' => [
- 'current_page' => 2,
- 'from' => 2,
- 'last_page' => 3,
- 'path' => '/',
- 'per_page' => 1,
- 'to' => 2,
- 'total' => 3,
- ],
- ]);
- }
- public function testCursorPaginatorReceiveLinks()
- {
- Route::get('/', function () {
- $paginator = new CursorPaginator(
- collect([new Post(['id' => 5, 'title' => 'Test Title']), new Post(['id' => 6, 'title' => 'Hello'])]),
- 1, null, ['parameters' => ['id']]
- );
- return new PostCollectionResource($paginator);
- });
- $response = $this->withoutExceptionHandling()->get(
- '/', ['Accept' => 'application/json']
- );
- $response->assertStatus(200);
- $response->assertJson([
- 'data' => [
- [
- 'id' => 5,
- 'title' => 'Test Title',
- ],
- ],
- 'links' => [
- 'first' => null,
- 'last' => null,
- 'prev' => null,
- 'next' => '/?cursor='.(new Cursor(['id' => 5]))->encode(),
- ],
- 'meta' => [
- 'path' => '/',
- 'per_page' => 1,
- ],
- ]);
- }
- public function testCursorPaginatorResourceCanPreserveQueryParameters()
- {
- Route::get('/', function () {
- $collection = collect([new Post(['id' => 5, 'title' => 'Test Title']), new Post(['id' => 6, 'title' => 'Hello'])]);
- $paginator = new CursorPaginator(
- $collection, 1, null, ['parameters' => ['id']]
- );
- return PostCollectionResource::make($paginator)->preserveQuery();
- });
- $response = $this->withoutExceptionHandling()->get(
- '/?framework=laravel&author=Otwell', ['Accept' => 'application/json']
- );
- $response->assertStatus(200);
- $response->assertJson([
- 'data' => [
- [
- 'id' => 5,
- 'title' => 'Test Title',
- ],
- ],
- 'links' => [
- 'first' => null,
- 'last' => null,
- 'prev' => null,
- 'next' => '/?framework=laravel&author=Otwell&cursor='.(new Cursor(['id' => 5]))->encode(),
- ],
- 'meta' => [
- 'path' => '/',
- 'per_page' => 1,
- ],
- ]);
- }
- public function testCursorPaginatorResourceCanReceiveQueryParameters()
- {
- Route::get('/', function () {
- $collection = collect([new Post(['id' => 5, 'title' => 'Test Title']), new Post(['id' => 6, 'title' => 'Hello'])]);
- $paginator = new CursorPaginator(
- $collection, 1, null, ['parameters' => ['id']]
- );
- return PostCollectionResource::make($paginator)->withQuery(['author' => 'Taylor']);
- });
- $response = $this->withoutExceptionHandling()->get(
- '/?framework=laravel&author=Otwell', ['Accept' => 'application/json']
- );
- $response->assertStatus(200);
- $response->assertJson([
- 'data' => [
- [
- 'id' => 5,
- 'title' => 'Test Title',
- ],
- ],
- 'links' => [
- 'first' => null,
- 'last' => null,
- 'prev' => null,
- 'next' => '/?author=Taylor&cursor='.(new Cursor(['id' => 5]))->encode(),
- ],
- 'meta' => [
- 'path' => '/',
- 'per_page' => 1,
- ],
- ]);
- }
- public function testToJsonMayBeLeftOffOfCollection()
- {
- Route::get('/', function () {
- return new EmptyPostCollectionResource(new LengthAwarePaginator(
- collect([new Post(['id' => 5, 'title' => 'Test Title'])]),
- 10, 15, 1
- ));
- });
- $response = $this->withoutExceptionHandling()->get(
- '/', ['Accept' => 'application/json']
- );
- $response->assertStatus(200);
- $response->assertJson([
- 'data' => [
- [
- 'id' => 5,
- 'title' => 'Test Title',
- 'custom' => true,
- ],
- ],
- 'links' => [
- 'first' => '/?page=1',
- 'last' => '/?page=1',
- 'prev' => null,
- 'next' => null,
- ],
- 'meta' => [
- 'current_page' => 1,
- 'from' => 1,
- 'last_page' => 1,
- 'path' => '/',
- 'per_page' => 15,
- 'to' => 1,
- 'total' => 10,
- ],
- ]);
- }
- public function testToJsonMayBeLeftOffOfSingleResource()
- {
- Route::get('/', function () {
- return new ReallyEmptyPostResource(new Post([
- 'id' => 5,
- 'title' => 'Test Title',
- ]));
- });
- $response = $this->withoutExceptionHandling()->get(
- '/', ['Accept' => 'application/json']
- );
- $response->assertStatus(200);
- $response->assertJson([
- 'data' => [
- 'id' => 5,
- 'title' => 'Test Title',
- ],
- ]);
- }
- public function testOriginalOnResponseIsModelWhenSingleResource()
- {
- $createdPost = new Post(['id' => 5, 'title' => 'Test Title']);
- Route::get('/', function () use ($createdPost) {
- return new ReallyEmptyPostResource($createdPost);
- });
- $response = $this->withoutExceptionHandling()->get(
- '/', ['Accept' => 'application/json']
- );
- $this->assertTrue($createdPost->is($response->getOriginalContent()));
- }
- public function testOriginalOnResponseIsCollectionOfModelWhenCollectionResource()
- {
- $createdPosts = collect([
- new Post(['id' => 5, 'title' => 'Test Title']),
- new Post(['id' => 6, 'title' => 'Test Title 2']),
- ]);
- Route::get('/', function () use ($createdPosts) {
- return new EmptyPostCollectionResource(new LengthAwarePaginator($createdPosts, 10, 15, 1));
- });
- $response = $this->withoutExceptionHandling()->get(
- '/', ['Accept' => 'application/json']
- );
- $createdPosts->each(function ($post) use ($response) {
- $this->assertTrue($response->getOriginalContent()->contains($post));
- });
- }
- public function testCollectionResourceWithPaginationInfomation()
- {
- $posts = collect([
- new Post(['id' => 5, 'title' => 'Test Title']),
- ]);
- Route::get('/', function () use ($posts) {
- return new PostCollectionResourceWithPaginationInformation(new LengthAwarePaginator($posts, 10, 1, 1));
- });
- $response = $this->withoutExceptionHandling()->get(
- '/',
- ['Accept' => 'application/json']
- );
- $response->assertStatus(200);
- $response->assertJson([
- 'data' => [
- [
- 'id' => 5,
- 'title' => 'Test Title',
- ],
- ],
- 'current_page' => 1,
- 'per_page' => 1,
- 'total_page' => 10,
- 'total' => 10,
- ]);
- }
- public function testResourceWithPaginationInfomation()
- {
- $posts = collect([
- new Post(['id' => 5, 'title' => 'Test Title']),
- ]);
- Route::get('/', function () use ($posts) {
- return PostResourceWithAnonymousResourceCollectionWithPaginationInformation::collection(new LengthAwarePaginator($posts, 10, 1, 1));
- });
- $response = $this->withoutExceptionHandling()->get(
- '/',
- ['Accept' => 'application/json']
- );
- $response->assertStatus(200);
- $response->assertJson([
- 'data' => [
- [
- 'id' => 5,
- 'title' => 'Test Title',
- ],
- ],
- 'current_page' => 1,
- 'per_page' => 1,
- 'total_page' => 10,
- 'total' => 10,
- ]);
- }
- public function testCollectionResourcesAreCountable()
- {
- $posts = collect([
- new Post(['id' => 1, 'title' => 'Test title']),
- new Post(['id' => 2, 'title' => 'Test title 2']),
- ]);
- $collection = new PostCollectionResource($posts);
- $this->assertCount(2, $collection);
- $this->assertCount(2, $collection);
- }
- public function testKeysArePreservedIfTheResourceIsFlaggedToPreserveKeys()
- {
- $data = [
- 'authorBook' => [
- 'byId' => [
- 1 => [
- 'id' => 1,
- 'authorId' => 5,
- 'bookId' => 22,
- ],
- 2 => [
- 'id' => 2,
- 'authorId' => 5,
- 'bookId' => 15,
- ],
- 3 => [
- 'id' => 3,
- 'authorId' => 42,
- 'bookId' => 12,
- ],
- ],
- 'allIds' => [1, 2, 3],
- ],
- ];
- Route::get('/', function () use ($data) {
- return new ResourceWithPreservedKeys($data);
- });
- $response = $this->withoutExceptionHandling()->get(
- '/', ['Accept' => 'application/json']
- );
- $response->assertStatus(200);
- $response->assertJson(['data' => $data]);
- }
- public function testKeysArePreservedInAnAnonymousColletionIfTheResourceIsFlaggedToPreserveKeys()
- {
- $data = Collection::make([
- [
- 'id' => 1,
- 'authorId' => 5,
- 'bookId' => 22,
- ],
- [
- 'id' => 2,
- 'authorId' => 5,
- 'bookId' => 15,
- ],
- [
- 'id' => 3,
- 'authorId' => 42,
- 'bookId' => 12,
- ],
- ])->keyBy->id;
- Route::get('/', function () use ($data) {
- return ResourceWithPreservedKeys::collection($data);
- });
- $response = $this->withoutExceptionHandling()->get(
- '/', ['Accept' => 'application/json']
- );
- $response->assertStatus(200);
- $response->assertJson(['data' => $data->toArray()]);
- }
- public function testLeadingMergeKeyedValueIsMergedCorrectly()
- {
- $filter = new class
- {
- use ConditionallyLoadsAttributes;
- public function work()
- {
- return $this->filter([
- new MergeValue(['name' => 'mohamed', 'location' => 'hurghada']),
- ]);
- }
- };
- $results = $filter->work();
- $this->assertEquals([
- 'name' => 'mohamed', 'location' => 'hurghada',
- ], $results);
- }
- public function testPostTooLargeException()
- {
- $this->expectException(PostTooLargeException::class);
- $request = Mockery::mock(Request::class, ['server' => ['CONTENT_LENGTH' => '2147483640']]);
- $post = new ValidatePostSize;
- $post->handle($request, function () {
- });
- }
- public function testLeadingMergeKeyedValueIsMergedCorrectlyWhenFirstValueIsMissing()
- {
- $filter = new class
- {
- use ConditionallyLoadsAttributes;
- public function work()
- {
- return $this->filter([
- new MergeValue([
- 0 => new MissingValue,
- 'name' => 'mohamed',
- 'location' => 'hurghada',
- ]),
- ]);
- }
- };
- $results = $filter->work();
- $this->assertEquals([
- 'name' => 'mohamed', 'location' => 'hurghada',
- ], $results);
- }
- public function testLeadingMergeValueIsMergedCorrectly()
- {
- $filter = new class
- {
- use ConditionallyLoadsAttributes;
- public function work()
- {
- return $this->filter([
- new MergeValue(['First', 'Second']),
- 'Taylor',
- 'Mohamed',
- new MergeValue(['Adam', 'Matt']),
- 'Jeffrey',
- new MergeValue(['Abigail', 'Lydia']),
- ]);
- }
- };
- $results = $filter->work();
- $this->assertEquals([
- 'First', 'Second', 'Taylor', 'Mohamed', 'Adam', 'Matt', 'Jeffrey', 'Abigail', 'Lydia',
- ], $results);
- }
- public function testMergeValuesMayBeMissing()
- {
- $filter = new class
- {
- use ConditionallyLoadsAttributes;
- public function work()
- {
- return $this->filter([
- new MergeValue(['First', 'Second']),
- 'Taylor',
- 'Mohamed',
- $this->mergeWhen(false, ['Adam', 'Matt']),
- 'Jeffrey',
- new MergeValue(['Abigail', 'Lydia']),
- ]);
- }
- };
- $results = $filter->work();
- $this->assertEquals([
- 'First', 'Second', 'Taylor', 'Mohamed', 'Jeffrey', 'Abigail', 'Lydia',
- ], $results);
- }
- public function testInitialMergeValuesMayBeMissing()
- {
- $filter = new class
- {
- use ConditionallyLoadsAttributes;
- public function work()
- {
- return $this->filter([
- $this->mergeWhen(false, ['First', 'Second']),
- 'Taylor',
- 'Mohamed',
- $this->mergeWhen(true, ['Adam', 'Matt']),
- 'Jeffrey',
- new MergeValue(['Abigail', 'Lydia']),
- ]);
- }
- };
- $results = $filter->work();
- $this->assertEquals([
- 'Taylor', 'Mohamed', 'Adam', 'Matt', 'Jeffrey', 'Abigail', 'Lydia',
- ], $results);
- }
- public function testMergeValueCanMergeJsonSerializable()
- {
- $filter = new class
- {
- use ConditionallyLoadsAttributes;
- public function work()
- {
- $postResource = new PostResource(new Post([
- 'id' => 1,
- 'title' => 'Test Title 1',
- ]));
- return $this->filter([
- new MergeValue($postResource),
- 'user' => 'test user',
- 'age' => 'test age',
- ]);
- }
- };
- $results = $filter->work();
- $this->assertEquals([
- 'id' => 1,
- 'title' => 'Test Title 1',
- 'custom' => true,
- 'user' => 'test user',
- 'age' => 'test age',
- ], $results);
- }
- public function testMergeValueCanMergeCollectionOfJsonSerializable()
- {
- $filter = new class
- {
- use ConditionallyLoadsAttributes;
- public function work()
- {
- $posts = collect([
- new Post(['id' => 1, 'title' => 'Test title 1']),
- new Post(['id' => 2, 'title' => 'Test title 2']),
- ]);
- return $this->filter([
- new MergeValue(PostResource::collection($posts)),
- ]);
- }
- };
- $results = $filter->work();
- $this->assertEquals([
- ['id' => 1, 'title' => 'Test title 1', 'custom' => true],
- ['id' => 2, 'title' => 'Test title 2', 'custom' => true],
- ], $results);
- }
- public function testAllMergeValuesMayBeMissing()
- {
- $filter = new class
- {
- use ConditionallyLoadsAttributes;
- public function work()
- {
- return $this->filter([
- $this->mergeWhen(false, ['First', 'Second']),
- 'Taylor',
- 'Mohamed',
- $this->mergeWhen(false, ['Adam', 'Matt']),
- 'Jeffrey',
- $this->mergeWhen(false, ['Abigail', 'Lydia']),
- ]);
- }
- };
- $results = $filter->work();
- $this->assertEquals([
- 'Taylor', 'Mohamed', 'Jeffrey',
- ], $results);
- }
- public function testNestedMerges()
- {
- $filter = new class
- {
- use ConditionallyLoadsAttributes;
- public function work()
- {
- return $this->filter([
- $this->mergeWhen(true, [['Something']]),
- [
- $this->mergeWhen(true, ['First', $this->mergeWhen(true, ['Second'])]),
- 'Third',
- ],
- [
- 'Fourth',
- ],
- ]);
- }
- };
- $results = $filter->work();
- $this->assertEquals([
- [
- 'Something',
- ],
- [
- 'First', 'Second', 'Third',
- ],
- [
- 'Fourth',
- ],
- ], $results);
- }
- public function testTheResourceCanBeAnArray()
- {
- $this->assertJsonResourceResponse([
- 'user@example.com' => 'John',
- 'admin@example.com' => 'Hank',
- ], [
- 'data' => [
- 'user@example.com' => 'John',
- 'admin@example.com' => 'Hank',
- ],
- ]);
- }
- public function testItWillReturnAsAnArrayWhenStringKeysAreStripped()
- {
- $this->assertJsonResourceResponse([
- 1 => 'John',
- 2 => 'Hank',
- 'foo' => new MissingValue,
- ], ['data' => ['John', 'Hank']]);
- $this->assertJsonResourceResponse([
- 1 => 'John',
- 'foo' => new MissingValue,
- 3 => 'Hank',
- ], ['data' => ['John', 'Hank']]);
- $this->assertJsonResourceResponse([
- 'foo' => new MissingValue,
- 2 => 'John',
- 3 => 'Hank',
- ], ['data' => ['John', 'Hank']]);
- }
- public function testItStripsNumericKeys()
- {
- $this->assertJsonResourceResponse([
- 0 => 'John',
- 1 => 'Hank',
- ], ['data' => ['John', 'Hank']]);
- $this->assertJsonResourceResponse([
- 0 => 'John',
- 1 => 'Hank',
- 3 => 'Bill',
- ], ['data' => ['John', 'Hank', 'Bill']]);
- $this->assertJsonResourceResponse([
- 5 => 'John',
- 6 => 'Hank',
- ], ['data' => ['John', 'Hank']]);
- }
- public function testItWontKeysIfAnyOfThemAreStrings()
- {
- $this->assertJsonResourceResponse([
- '5' => 'John',
- '6' => 'Hank',
- 'a' => 'Bill',
- ], ['data' => ['5' => 'John', '6' => 'Hank', 'a' => 'Bill']]);
- $this->assertJsonResourceResponse([
- 0 => 10,
- 1 => 20,
- 'total' => 30,
- ], ['data' => [0 => 10, 1 => 20, 'total' => 30]]);
- }
- private function assertJsonResourceResponse($data, $expectedJson)
- {
- Route::get('/', function () use ($data) {
- return new JsonResource($data);
- });
- $this->withoutExceptionHandling()
- ->get('/', ['Accept' => 'application/json'])
- ->assertStatus(200)
- ->assertExactJson($expectedJson);
- }
- }
|