Skip to content

Restrict the possible values for the casing options under the Portability\ NS #5926

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 1 commit into from
Mar 2, 2023
Merged

Restrict the possible values for the casing options under the Portability\ NS #5926

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 14 additions & 6 deletions src/Portability/Converter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,14 @@
use function is_string;
use function rtrim;

use const CASE_LOWER;
use const CASE_UPPER;

final class Converter
{
public const CASE_LOWER = CASE_LOWER;
public const CASE_UPPER = CASE_UPPER;

/** @var callable */
private $convertNumeric;

Expand All @@ -31,10 +37,12 @@ final class Converter
private $convertFirstColumn;

/**
* @param bool $convertEmptyStringToNull Whether each empty string should be converted to NULL
* @param bool $rightTrimString Whether each string should right-trimmed
* @param int|null $case Convert the case of the column names
* (one of {@see CASE_LOWER} and {@see CASE_UPPER})
* @param bool $convertEmptyStringToNull Whether each empty string should
* be converted to NULL
* @param bool $rightTrimString Whether each string should right-trimmed
* @param self::CASE_LOWER|self::CASE_UPPER|null $case Convert the case of the column names
* (one of {@see self::CASE_LOWER} and
* {@see self::CASE_UPPER})
*/
public function __construct(bool $convertEmptyStringToNull, bool $rightTrimString, ?int $case)
{
Expand Down Expand Up @@ -182,8 +190,8 @@ private function createConvertValue(bool $convertEmptyStringToNull, bool $rightT
/**
* Creates a function that will convert each array-row retrieved from the database
*
* @param callable|null $function The function that will convert each value
* @param int|null $case Column name case
* @param callable|null $function The function that will convert each value
* @param self::CASE_LOWER|self::CASE_UPPER|null $case Column name case
*
* @return callable|null The resulting function or NULL if no conversion is needed
*/
Expand Down
17 changes: 12 additions & 5 deletions src/Portability/Driver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,19 @@

use function method_exists;

use const CASE_LOWER;
use const CASE_UPPER;

final class Driver extends AbstractDriverMiddleware
{
private int $mode;

/** @var 0|ColumnCase::LOWER|ColumnCase::UPPER */
private int $case;

/**
* @param 0|ColumnCase::LOWER|ColumnCase::UPPER $case Determines how the column case will be treated.
* 0: The case will be left as is in the database.
* {@see ColumnCase::LOWER}: The case will be lowercased.
* {@see ColumnCase::UPPER}: The case will be uppercased.
*/
public function __construct(DriverInterface $driver, int $mode, int $case)
{
parent::__construct($driver);
Expand Down Expand Up @@ -55,9 +59,12 @@ public function connect(

if ($nativeConnection instanceof PDO) {
$portability &= ~Connection::PORTABILITY_FIX_CASE;
$nativeConnection->setAttribute(PDO::ATTR_CASE, $this->case);
$nativeConnection->setAttribute(
PDO::ATTR_CASE,
$this->case === ColumnCase::LOWER ? PDO::CASE_LOWER : PDO::CASE_UPPER,
);
} else {
$case = $this->case === ColumnCase::LOWER ? CASE_LOWER : CASE_UPPER;
$case = $this->case === ColumnCase::LOWER ? Converter::CASE_LOWER : Converter::CASE_UPPER;
}
}

Expand Down
8 changes: 8 additions & 0 deletions src/Portability/Middleware.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,23 @@

namespace Doctrine\DBAL\Portability;

use Doctrine\DBAL\ColumnCase;
use Doctrine\DBAL\Driver as DriverInterface;
use Doctrine\DBAL\Driver\Middleware as MiddlewareInterface;

final class Middleware implements MiddlewareInterface
{
private int $mode;

/** @var 0|ColumnCase::LOWER|ColumnCase::UPPER */
private int $case;

/**
* @param 0|ColumnCase::LOWER|ColumnCase::UPPER $case Determines how the column case will be treated.
* 0: The case will be left as is in the database.
* {@see ColumnCase::LOWER}: The case will be lowercased.
* {@see ColumnCase::UPPER}: The case will be uppercased.
*/
public function __construct(int $mode, int $case)
{
$this->mode = $mode;
Expand Down
2 changes: 1 addition & 1 deletion src/Portability/OptimizeFlags.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ final class OptimizeFlags
* Platform-specific portability flags that need to be excluded from the user-provided mode
* since the platform already operates in this mode to avoid unnecessary conversion overhead.
*
* @var array<string,int>
* @var array<class-string, int>
*/
private static array $platforms = [
DB2Platform::class => 0,
Expand Down
6 changes: 4 additions & 2 deletions tests/Functional/PortabilityTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,8 @@ public function testFullFetchMode(): void
}

/**
* @param list<string> $expected
* @param 0|ColumnCase::LOWER|ColumnCase::UPPER $case
* @param list<string> $expected
*
* @dataProvider caseProvider
*/
Expand All @@ -61,7 +62,7 @@ public function testCaseConversion(int $case, array $expected): void
self::assertSame($expected, array_keys($row));
}

/** @return iterable<string, array{int, list<string>}> */
/** @return iterable<string, array{(ColumnCase::LOWER|ColumnCase::UPPER), list<string>}> */
public static function caseProvider(): iterable
{
yield 'lower' => [ColumnCase::LOWER, ['test_int', 'test_string', 'test_null']];
Expand Down Expand Up @@ -137,6 +138,7 @@ public function testGetDatabaseName(): void
self::assertNotNull($this->connection->getDatabase());
}

/** @param 0|ColumnCase::LOWER|ColumnCase::UPPER $case */
private function connectWithPortability(int $mode, int $case): void
{
// closing the default connection prior to 4.0.0 to prevent connection leak
Expand Down
8 changes: 4 additions & 4 deletions tests/Portability/ConnectionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ public function testGetServerVersion(): void
->method('getServerVersion')
->willReturn('1.2.3');

$connection = new Connection($driverConnection, new Converter(false, false, 0));
$connection = new Connection($driverConnection, new Converter(false, false, Converter::CASE_LOWER));
Copy link
Member

Choose a reason for hiding this comment

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

Wait, why did you change these tests? That shouldn't be necessary, should it?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No, this change is not strictly required, as the previous value (0) is identical to the value provided by this constant. I made these replacements in order to be consistent with the usage of these constants, as I think this also help as an example.
I can revert these changes if you think they are not a proper move for this PR.

Copy link
Member

@derrabus derrabus Feb 26, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

No, you're right. It's better this way, thanks for the explanation. Let's keep the change.


self::assertSame('1.2.3', $connection->getServerVersion());
}
Expand All @@ -27,7 +27,7 @@ public function testGetServerVersionFailsWithLegacyConnection(): void
{
$connection = new Connection(
$this->createMock(DriverConnection::class),
new Converter(false, false, 0),
new Converter(false, false, Converter::CASE_LOWER),
);

$this->expectException(LogicException::class);
Expand All @@ -43,7 +43,7 @@ public function testGetNativeConnection(): void
$driverConnection->method('getNativeConnection')
->willReturn($nativeConnection);

$connection = new Connection($driverConnection, new Converter(false, false, 0));
$connection = new Connection($driverConnection, new Converter(false, false, Converter::CASE_LOWER));

self::assertSame($nativeConnection, $connection->getNativeConnection());
}
Expand All @@ -52,7 +52,7 @@ public function testGetNativeConnectionFailsWithLegacyConnection(): void
{
$connection = new Connection(
$this->createMock(DriverConnection::class),
new Converter(false, false, 0),
new Converter(false, false, Converter::CASE_LOWER),
);

$this->expectException(LogicException::class);
Expand Down
29 changes: 15 additions & 14 deletions tests/Portability/ConverterTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@
use Doctrine\DBAL\Portability\Converter;
use PHPUnit\Framework\TestCase;

use const CASE_LOWER;

class ConverterTest extends TestCase
{
/**
Expand Down Expand Up @@ -61,8 +59,9 @@ public static function convertNumericProvider(): iterable
}

/**
* @param array<string,mixed>|false $row
* @param array<string,mixed>|false $expected
* @param array<string,mixed>|false $row
* @param Converter::CASE_LOWER|Converter::CASE_UPPER|null $case
* @param array<string,mixed>|false $expected
*
* @dataProvider convertAssociativeProvider
*/
Expand Down Expand Up @@ -136,7 +135,7 @@ public static function convertAssociativeProvider(): iterable
$row,
false,
false,
CASE_LOWER,
Converter::CASE_LOWER,
[
'foo' => '',
'bar' => 'X ',
Expand All @@ -147,7 +146,7 @@ public static function convertAssociativeProvider(): iterable
$row,
false,
true,
CASE_LOWER,
Converter::CASE_LOWER,
[
'foo' => '',
'bar' => 'X',
Expand All @@ -158,7 +157,7 @@ public static function convertAssociativeProvider(): iterable
$row,
true,
false,
CASE_LOWER,
Converter::CASE_LOWER,
[
'foo' => null,
'bar' => 'X ',
Expand All @@ -169,7 +168,7 @@ public static function convertAssociativeProvider(): iterable
$row,
true,
true,
CASE_LOWER,
Converter::CASE_LOWER,
[
'foo' => null,
'bar' => 'X',
Expand Down Expand Up @@ -276,8 +275,9 @@ public static function convertAllNumericProvider(): iterable
}

/**
* @param list<array<string,mixed>> $row
* @param list<array<string,mixed>> $expected
* @param list<array<string,mixed>> $row
* @param Converter::CASE_LOWER|Converter::CASE_UPPER|null $case
* @param list<array<string,mixed>> $expected
*
* @dataProvider convertAllAssociativeProvider
*/
Expand Down Expand Up @@ -381,7 +381,7 @@ public static function convertAllAssociativeProvider(): iterable
$data,
false,
false,
CASE_LOWER,
Converter::CASE_LOWER,
[
[
'foo' => 'X ',
Expand All @@ -398,7 +398,7 @@ public static function convertAllAssociativeProvider(): iterable
$data,
false,
true,
CASE_LOWER,
Converter::CASE_LOWER,
[
[
'foo' => 'X',
Expand All @@ -415,7 +415,7 @@ public static function convertAllAssociativeProvider(): iterable
$data,
true,
false,
CASE_LOWER,
Converter::CASE_LOWER,
[
[
'foo' => 'X ',
Expand All @@ -432,7 +432,7 @@ public static function convertAllAssociativeProvider(): iterable
$data,
true,
true,
CASE_LOWER,
Converter::CASE_LOWER,
[
[
'foo' => 'X',
Expand Down Expand Up @@ -499,6 +499,7 @@ public static function convertFirstColumnProvider(): iterable
];
}

/** @param Converter::CASE_LOWER|Converter::CASE_UPPER|null $case */
private function createConverter(bool $convertEmptyStringToNull, bool $rightTrimString, ?int $case): Converter
{
return new Converter($convertEmptyStringToNull, $rightTrimString, $case);
Expand Down