[194]: modify search request #196
Merged
Conversation
This file contains hidden or 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
There was a problem hiding this comment.
Pull Request Overview
This PR modifies the search request generation to add enhanced validation for the order_by parameter by constraining it to only accept orderable fields from the corresponding model class.
- Adds model class import to search request templates
- Updates
order_byvalidation rule to include dynamic field validation usingself::getOrderableFields() - Updates test fixtures and template generation logic to support the new validation pattern
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| tests/fixtures/RequestGeneratorTest/search_request.php | Updated search request fixture with model import and enhanced order_by validation |
| tests/fixtures/CommandTest/subfolder/search_request.php | New search request fixture with model-specific validation |
| tests/fixtures/CommandTest/search_request.php | Updated search request fixture with model import and validation |
| tests/CommandTest.php | Updated test to reference correct fixture path |
| stubs/request.blade.php | Enhanced template to conditionally add model import and order_by validation logic |
| src/Generators/RequestsGenerator.php | Added entityNamespace parameter to template data |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
stubs/request.blade.php
Outdated
| @foreach($parameters as $parameter) | ||
| '{{ $parameter['name'] }}' => '{{ implode('|', $parameter['rules']) }}', | ||
| @if($method === $requestsGenerator::SEARCH_METHOD && $parameter['name'] === 'order_by') | ||
| '{{ $parameter['name'] }}' => '{{ implode('|', $parameter['rules']) }}|in:' . self::getOrderableFields({{ Str::singular($entity) }}::class), |
There was a problem hiding this comment.
[nitpick] The validation rule construction concatenates strings in a complex way that could be error-prone. Consider extracting this logic into a helper method or variable for better readability and maintainability.
Suggested change
| '{{ $parameter['name'] }}' => '{{ implode('|', $parameter['rules']) }}|in:' . self::getOrderableFields({{ Str::singular($entity) }}::class), | |
| @php | |
| $orderByRule = implode('|', $parameter['rules']) . '|in:' . self::getOrderableFields({{ Str::singular($entity) }}::class); | |
| @endphp | |
| '{{ $parameter['name'] }}' => '{{ $orderByRule }}', |
There was a problem hiding this comment.
@neellii may we add the in rule in this method
DenTray
requested changes
Sep 23, 2025
stubs/request.blade.php
Outdated
| @foreach($parameters as $parameter) | ||
| '{{ $parameter['name'] }}' => '{{ implode('|', $parameter['rules']) }}', | ||
| @if($method === $requestsGenerator::SEARCH_METHOD && $parameter['name'] === 'order_by') | ||
| '{{ $parameter['name'] }}' => '{{ implode('|', $parameter['rules']) }}|in:' . self::getOrderableFields({{ Str::singular($entity) }}::class), |
There was a problem hiding this comment.
@neellii may we add the in rule in this method
tests/CommandTest.php
Outdated
| $this->assertGeneratedFileEquals('create_request.php', 'app/Http/Requests/Post/CreatePostRequest.php'); | ||
| $this->assertGeneratedFileEquals('get_request.php', 'app/Http/Requests/Post/GetPostRequest.php'); | ||
| $this->assertGeneratedFileEquals('search_request.php', 'app/Http/Requests/Post/SearchPostsRequest.php'); | ||
| $this->assertGeneratedFileEquals('subfolder/search_request.php', 'app/Http/Requests/Post/SearchPostsRequest.php'); |
There was a problem hiding this comment.
that's strange, could you please investigate the reason of why search request generated in the subfolder?
| 'page' => 'integer', | ||
| 'per_page' => 'integer', | ||
| 'order_by' => 'string', | ||
| 'order_by' => 'string|in:' . self::getOrderableFields(Post::class), |
There was a problem hiding this comment.
Suggested change
| 'order_by' => 'string|in:' . self::getOrderableFields(Post::class), | |
| 'order_by' => 'string|in:' . $this->getOrderableFields(Post::class), |
DenTray
approved these changes
Sep 29, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
refs: #194