-
Notifications
You must be signed in to change notification settings - Fork 2k
fix: Entity::normalizeValue() must handle UnitEnum before toArray() #10137
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.
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
Open
maniaba
wants to merge
2
commits into
codeigniter4:develop
Choose a base branch
from
maniaba:bug-entity
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /** | ||
| * This file is part of CodeIgniter 4 framework. | ||
| * | ||
| * (c) CodeIgniter Foundation <admin@codeigniter.com> | ||
| * | ||
| * For the full copyright and license information, please view | ||
| * the LICENSE file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Tests\Support\Enum; | ||
|
|
||
| /** | ||
| * An enum that also defines toArray(), used to test that UnitEnum handling | ||
| * takes precedence over toArray() in Entity::normalizeValue(). | ||
| */ | ||
| enum StateEnum: string | ||
| { | ||
| case DRAFT = 'draft'; | ||
| case PUBLISHED = 'published'; | ||
|
|
||
| public function toArray(): array | ||
| { | ||
| return array_column(self::cases(), 'value'); | ||
| } | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -35,6 +35,7 @@ | |
| use Tests\Support\Entity\Cast\NotExtendsBaseCast; | ||
| use Tests\Support\Enum\ColorEnum; | ||
| use Tests\Support\Enum\RoleEnum; | ||
| use Tests\Support\Enum\StateEnum; | ||
| use Tests\Support\Enum\StatusEnum; | ||
| use Tests\Support\SomeEntity; | ||
|
|
||
|
|
@@ -1045,6 +1046,24 @@ public function testCastEnumSetWithUnitEnumObject(): void | |
| $this->assertSame(ColorEnum::RED, $entity->color); | ||
| } | ||
|
|
||
| public function testInjectRawDataWithEnumThatHasToArrayMethod(): void | ||
| { | ||
| // Regression test for https://github.com/codeigniter4/CodeIgniter4/issues/10136 | ||
| // Enums implementing toArray() must still be handled by the UnitEnum branch in | ||
| // normalizeValue(), so hasChanged() does not incorrectly report a change after | ||
| // injectRawData() stores the same enum value. | ||
| $entity = new class () extends Entity {}; | ||
|
|
||
| $entity->injectRawData(['state' => StateEnum::DRAFT]); | ||
|
|
||
| // toRawArray() returns raw attributes, so the enum object is returned as-is. | ||
| $this->assertSame(StateEnum::DRAFT, $entity->toRawArray()['state']); | ||
|
|
||
| // The key assertion: normalizeValue() must treat the enum as a UnitEnum | ||
| // (not call toArray() on it), so the original and current normalized forms match. | ||
| $this->assertFalse($entity->hasChanged('state')); | ||
| } | ||
|
Comment on lines
+1049
to
+1065
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please remove all these comments, and just add in the docblock: |
||
|
|
||
| public function testAsArray(): void | ||
| { | ||
| $entity = $this->getEntity(); | ||
|
|
||
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You're returning scalar strings, so this test does not test the reported recursion path.