Skip to content
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

Support BackedEnum attribute typecast behaviour. #20185

Merged
merged 3 commits into from
Dec 7, 2024
Merged

Support BackedEnum attribute typecast behaviour. #20185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0acf0db
Support BackedEnum attribute typecast behaviour.
Jun 4, 2024
047d68c
Update changelog
Dec 6, 2024
4b4eb9d
Rename enum cases to match suggested formatting (RFC)
Dec 6, 2024
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
1 change: 1 addition & 0 deletions framework/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Yii Framework 2 Change Log
- Enh #20279: Add to the `\yii\web\Request` `csrfHeader` property to configure a custom HTTP header for CSRF validation (olegbaturin)
- Enh #20279: Add to the `\yii\web\Request` `csrfTokenSafeMethods` property to configure a custom safe HTTP methods list (olegbaturin)
- Bug #20140: Fix compatibility with PHP 8.4: calling `session_set_save_handler()` (Izumi-kun)
- New #20185: Add `BackedEnum` support to `AttributeTypecastBehavior` (briedis)

2.0.51 July 18, 2024
--------------------
Expand Down
11 changes: 9 additions & 2 deletions framework/behaviors/AttributeTypecastBehavior.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,9 +267,16 @@
return StringHelper::floatToString($value);
}
return (string) $value;
default:
throw new InvalidArgumentException("Unsupported type '{$type}'");
}

if (PHP_VERSION_ID >= 80100 && is_subclass_of($type, \BackedEnum::class)) {
if ($value instanceof $type) {
return $value;

Check warning on line 274 in framework/behaviors/AttributeTypecastBehavior.php

View check run for this annotation

Codecov / codecov/patch

framework/behaviors/AttributeTypecastBehavior.php#L272-L274 

Added lines #L272 - L274 were not covered by tests
}
return $type::from($value);

Check warning on line 276 in framework/behaviors/AttributeTypecastBehavior.php

View check run for this annotation

Codecov / codecov/patch

framework/behaviors/AttributeTypecastBehavior.php#L276 

Added line #L276 was not covered by tests
}

throw new InvalidArgumentException("Unsupported type '{$type}'");

Check warning on line 279 in framework/behaviors/AttributeTypecastBehavior.php

View check run for this annotation

Codecov / codecov/patch

framework/behaviors/AttributeTypecastBehavior.php#L279 

Added line #L279 was not covered by tests
}

return call_user_func($type, $value);
Expand Down
86 changes: 86 additions & 0 deletions tests/framework/behaviors/AttributeTypecastBehaviorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,13 @@

namespace yiiunit\framework\behaviors;

use ValueError;
use Yii;
use yii\base\DynamicModel;
use yii\base\Event;
use yii\behaviors\AttributeTypecastBehavior;
use yii\db\ActiveRecord;
use yiiunit\framework\db\enums\StatusTypeString;
use yiiunit\TestCase;

/**
Expand Down Expand Up @@ -47,6 +49,7 @@ protected function setUp(): void
'price' => 'float',
'isActive' => 'boolean',
'callback' => 'string',
'status' => 'string',
];
Yii::$app->getDb()->createCommand()->createTable('test_attribute_typecast', $columns)->execute();
}
Expand Down Expand Up @@ -80,6 +83,55 @@ public function testTypecast()
$this->assertSame('callback: foo', $model->callback);
}

public function testTypecastEnum()
{
if (PHP_VERSION_ID < 80100) {
$this->markTestSkipped('Can not be tested on PHP < 8.1');
}

$model = new ActiveRecordAttributeTypecastWithEnum();

$model->status = StatusTypeString::Active;

$model->getAttributeTypecastBehavior()->typecastAttributes();

$this->assertSame(StatusTypeString::Active, $model->status);
}

/**
* @depends testTypecastEnum
*/
public function testTypecastEnumFromString()
{
if (PHP_VERSION_ID < 80100) {
$this->markTestSkipped('Can not be tested on PHP < 8.1');
}

$model = new ActiveRecordAttributeTypecastWithEnum();
$model->status = 'active'; // Same as StatusTypeString::ACTIVE->value;

$model->getAttributeTypecastBehavior()->typecastAttributes();

$this->assertSame(StatusTypeString::Active, $model->status);
}

/**
* @depends testTypecastEnum
*/
public function testTypecastEnumFailWithInvalidValue()
{
if (PHP_VERSION_ID < 80100) {
$this->markTestSkipped('Can not be tested on PHP < 8.1');
}

$model = new ActiveRecordAttributeTypecastWithEnum();
$model->status = 'invalid';

self::expectException(ValueError::class);

$model->getAttributeTypecastBehavior()->typecastAttributes();
}

/**
* @depends testTypecast
*/
Expand Down Expand Up @@ -339,3 +391,37 @@ public function getAttributeTypecastBehavior()
return $this->getBehavior('attributeTypecast');
}
}

/**
* Test Active Record class with [[AttributeTypecastBehavior]] behavior attached with an enum field.
*
* @property StatusTypeString $status
*/
class ActiveRecordAttributeTypecastWithEnum extends ActiveRecord
{
public function behaviors()
{
return [
'attributeTypecast' => [
'class' => AttributeTypecastBehavior::className(),
'attributeTypes' => [
'status' => StatusTypeString::class,
],
'typecastBeforeSave' => true,
samdark marked this conversation as resolved.
Show resolved Hide resolved
],
];
}

public static function tableName()
{
return 'test_attribute_typecast';
}

/**
* @return AttributeTypecastBehavior
*/
public function getAttributeTypecastBehavior()
{
return $this->getBehavior('attributeTypecast');
}
}
6 changes: 3 additions & 3 deletions tests/framework/db/CommandTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1538,13 +1538,13 @@ public function testBindValuesSupportsEnums()
$db = $this->getConnection();
$command = $db->createCommand();

$command->setSql('SELECT :p1')->bindValues([':p1' => enums\Status::ACTIVE]);
$command->setSql('SELECT :p1')->bindValues([':p1' => enums\Status::Active]);
$this->assertSame('ACTIVE', $command->params[':p1']);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The expected value should be renamed also.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@briedis can you prepare a PR to address this please. @Izumi-kun thanks for spotting and pointing this out

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry about that. Here's the PR: #20296

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No need to be sorry. It is OK.
Thanks for PR


$command->setSql('SELECT :p1')->bindValues([':p1' => enums\StatusTypeString::ACTIVE]);
$command->setSql('SELECT :p1')->bindValues([':p1' => enums\StatusTypeString::Active]);
$this->assertSame('active', $command->params[':p1']);

$command->setSql('SELECT :p1')->bindValues([':p1' => enums\StatusTypeInt::ACTIVE]);
$command->setSql('SELECT :p1')->bindValues([':p1' => enums\StatusTypeInt::Active]);
$this->assertSame(1, $command->params[':p1']);
} else {
$this->markTestSkipped('Enums are not supported in PHP < 8.1');
Expand Down
4 changes: 2 additions & 2 deletions tests/framework/db/enums/Status.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@

enum Status
{
case ACTIVE;
case INACTIVE;
case Active;
case Inactive;
}
4 changes: 2 additions & 2 deletions tests/framework/db/enums/StatusTypeInt.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@

enum StatusTypeInt: int
{
case ACTIVE = 1;
case INACTIVE = 0;
case Active = 1;
case Inactive = 0;
}
4 changes: 2 additions & 2 deletions tests/framework/db/enums/StatusTypeString.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@

enum StatusTypeString: string
{
case ACTIVE = 'active';
case INACTIVE = 'inactive';
case Active = 'active';
case Inactive = 'inactive';
}
Loading