8000 [12.x] Add resource helper functions to Model/Collections by TimKunze96 · Pull Request #55107 · laravel/framework · GitHub
[go: up one dir, main page]
Skip to content

[12.x] Add resource helper functions to Model/Collections #55107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 18 commits into from
Apr 2, 2025
+361 −3
Merged

[12.x] Add resource helper functions to Model/Collections #55107

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
0909ce1
Add resource helper functions
TimKunze96 Mar 20, 2025
b7d0768
Fix doc-block style
TimKunze96 Mar 20, 2025
469709a
Remove empty line
TimKunze96 Mar 20, 2025
a4f0faf
Make resource param optional and guess resource name
TimKunze96 Mar 23, 2025
491522e
Use throw_unless instead of assert
TimKunze96 Mar 24, 2025
c060601
Extract name guessing function
TimKunze96 Mar 24, 2025
7ef6563
Add tests for resource helpers
TimKunze96 Mar 24, 2025
ada10bd
Fix formatting
TimKunze96 Mar 24, 2025
48c0865
Fix namespace conflicts and add current page
TimKunze96 Mar 24, 2025
93f3df6
Use more descriptive LogicException instead of Exception
TimKunze96 Mar 24, 2025
5f7092d
Refactor to use traits and extend base collection instead of eloquent…
TimKunze96 Mar 26, 2025
fbf4f78
Ensure trait method exists
TimKunze96 Mar 26, 2025
6e878f4
formatting
taylorotwell Apr 1, 2025
28c1d3f
formatting
taylorotwell Apr 1, 2025
c738f7f
formatting
taylorotwell Apr 1, 2025
9e9f8a6
adjust tests and logic
taylorotwell Apr 2, 2025
bf7676b
add testS
taylorotwell Apr 2, 2025
bbe8ffb
remove comment
taylorotwell Apr 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fix namespace conflicts and add current page
  • Loading branch information
@TimKunze96
TimKunze96 committed Mar 24, 2025
commit 48c0865e10c4c1ce80c0e898c9cb5e0e2ec54f32
24 changes: 12 additions & 12 deletions tests/Database/DatabaseEloquentResourceCollectionTest.php
View file
Open in desktop
8000
Original file line number Diff line number Diff line change
Expand Up @@ -11,59 +11,59 @@ class DatabaseEloquentResourceCollectionTest extends TestCase
{
public function testItGuessesTheResourceName()
{
$collection = new TestCollection([
new TestModel(),
$collection = new EloquentResourceCollectionTestCollection([
new EloquentResourceCollectionTestModel(),
]);
$this->assertEquals('App\Http\Resources\TestModelResource', $collection->getGuessedResourceName(new TestModel()));
$this->assertEquals('App\Http\Resources\EloquentResourceCollectionTestModelResource', $collection->getGuessedResourceName(new EloquentResourceCollectionTestModel()));
}

public function testItCanTransformToExplicitResource()
{
$collection = new Collection([
new TestModel(),
new EloquentResourceCollectionTestModel(),
]);

$resource = $collection->toResourceCollection(TestResource::class);
$resource = $collection->toResourceCollection(EloquentResourceCollectionTestResource::class);

$this->assertInstanceOf(JsonResource::class, $resource);
}

public function testItThrowsExceptionWhenResourceCannotBeFound()
{
$this->expectException(\Exception::class);
$this->expectExceptionMessage('Failed to find resource class for model [Illuminate\Tests\Database\TestModel].');
$this->expectExceptionMessage('Failed to find resource class for model [Illuminate\Tests\Database\EloquentResourceCollectionTestModel].');

$collection = new Collection([
new TestModel(),
new EloquentResourceCollectionTestModel(),
]);
$collection->toResourceCollection();
}

public function testItCanGuessResourceWhenNotProvided()
{
$collection = new Collection([
new TestModel(),
new EloquentResourceCollectionTestModel(),
]);

class_alias(TestResource::class, 'App\Http\Resources\TestModelResource');
class_alias(EloquentResourceCollectionTestResource::class, 'App\Http\Resources\EloquentResourceCollectionTestModelResource');

$resource = $collection->toResourceCollection();

$this->assertInstanceOf(JsonResource::class, $resource);
}
}

class TestModel extends Model
class EloquentResourceCollectionTestModel extends Model
{
//
}

class TestResource extends JsonResource
class EloquentResourceCollectionTestResource extends JsonResource
{
//
}

class TestCollection extends Collection
class EloquentResourceCollectionTestCollection extends Collection
{
public function getGuessedResourceName(object $model): string
{
Expand Down
29 changes: 15 additions & 14 deletions tests/Database/DatabaseEloquentResourceModelTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,54 +10,55 @@ class DatabaseEloquentResourceModelTest extends TestCase
{
public function testItCanTransformToExplicitResource()
{
$model = new TestResourceModel();
$resource = $model->toResource(TestJsonResource::class);
$model = new EloquentResourceTestResourceModel();
$resource = $model->toResource(EloquentResourceTestJsonResource::class);

$this->assertInstanceOf(TestJsonResource::class, $resource);
$this->assertInstanceOf(EloquentResourceTestJsonResource::class, $resource);
$this->assertSame($model, $resource->resource);
}

public function testItThrowsExceptionWhenResourceCannotBeFound()
{
$this->expectException(\Exception::class);
$this->expectExceptionMessage('Failed to find resource class for model [Illuminate\Tests\Database\TestResourceModel].');
$this->expectExceptionMessage('Failed to find resource class for model [Illuminate\Tests\Database\EloquentResourceTestResourceModel].');

$model = new TestResourceModel();
$model = new EloquentResourceTestResourceModel();
$model->toResource();
}

public function testItCanGuessResourceWhenNotProvided()
{
$model = new TestResourceModelWithGuessableResource();
$model = new EloquentResourceTestResourceModelWithGuessableResource();

class_alias(TestJsonResource::class, 'App\Http\Resources\TestResourceModelWithGuessableResourceResource');
class_alias(EloquentResourceTestJsonResource::class, 'App\Http\Resources\EloquentResourceTestResourceModelWithGuessableResourceResource');

$resource = $model->toResource();

$this->assertInstanceOf(TestJsonResource::class, $resource);
$this->assertInstanceOf(EloquentResourceTestJsonResource::class, $resource);
$this->assertSame($model, $resource->resource);
}

public function testItCanGuessResourceName()
{
$model = new TestResourceModel();
$this->assertEquals('App\Http\Resources\TestResourceModelResource', $model->getGuessedResourceName());
$model = new EloquentResourceTestResourceModel();
$this->assertEquals('App\Http\Resources\EloquentResourceTestResourceModelResource', $model->getGuessedResourceName());
}

}

class TestResourceModel extends Model
class EloquentResourceTestResourceModel extends Model
{
public function getGuessedResourceName(): string
{
return $this->guessResourceName();
}
}

class TestResourceModelWithGuessableResource extends Model
class EloquentResourceTestResourceModelWithGuessableResource extends Model
{
//
}

class TestJsonResource extends JsonResource
class EloquentResourceTestJsonResource extends JsonResource
{
//
}
38 changes: 19 additions & 19 deletions tests/Pagination/PaginatorResourceTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,61 +11,61 @@ class PaginatorResourceTest extends TestCase
{
public function testItGuessesTheResourceName()
{
$paginator = new TestPaginator([
new TestModel(),
], 1, 1);
$paginator = new PaginatorResourceTestPaginator([
new PaginatorResourceTestModel(),
], 1, 1, 1);

$this->assertEquals('App\Http\Resources\TestModelResource', $paginator->getGuessedResourceName(new TestModel()));
$this->assertEquals('App\Http\Resources\PaginatorResourceTestModelResource', $paginator->getGuessedResourceName(new PaginatorResourceTestModel()));
}

public function testItCanTransformToExplicitResource()
{
$paginator = new TestPaginator([
new TestModel(),
], 1, 1);
$paginator = new PaginatorResourceTestPaginator([
new PaginatorResourceTestModel(),
], 1, 1, 1);

$resource = $paginator->toResourceCollection(TestResource::class);
$resource = $paginator->toResourceCollection(PaginatorResourceTestResource::class);

$this->assertInstanceOf(JsonResource::class, $resource);
}

public function testItThrowsExceptionWhenResourceCannotBeFound()
{
$this->expectException(\Exception::class);
$this->expectExceptionMessage('Failed to find resource class for model [Illuminate\Tests\Pagination\TestModel].');
$this->expectExceptionMessage('Failed to find resource class for model [Illuminate\Tests\Pagination\PaginatorResourceTestModel].');

$paginator = new TestPaginator([
new TestModel(),
], 1, 1);
$paginator = new PaginatorResourceTestPaginator([
new PaginatorResourceTestModel(),
], 1, 1, 1);

$paginator->toResourceCollection();
}

public function testItCanGuessResourceWhenNotProvided()
{
$paginator = new TestPaginator([
new TestModel(),
], 1, 1);
$paginator = new PaginatorResourceTestPaginator([
new PaginatorResourceTestModel(),
], 1, 1, 1);

class_alias(TestResource::class, 'App\Http\Resources\TestModelResource');
class_alias(PaginatorResourceTestResource::class, 'App\Http\Resources\PaginatorResourceTestModelResource');

$resource = $paginator->toResourceCollection();

$this->assertInstanceOf(JsonResource::class, $resource);
}
}

class TestModel extends Model
class PaginatorResourceTestModel extends Model
{
//
}

class TestResource extends JsonResource
class PaginatorResourceTestResource extends JsonResource
{
//
}

class TestPaginator extends LengthAwarePaginator
class PaginatorResourceTestPaginator extends LengthAwarePaginator
{
public function getGuessedResourceName(object $model): string
{
Expand Down
Loading
0