Skip to content

Commit 917c725

Browse files
mpywmpyw
authored
Feat+Refactor: Introduce a wrapper for scalar values and refactor with it (#4)
* Feat: Introduce a wrapper for scalar values * Refactor: Refactor using Value wrapper * Test: Update tests allowing minor breaking changes
1 parent df9a374 commit 917c725

File tree

5 files changed

+240
-42
lines changed

5 files changed

+240
-42
lines changed

‎src/SystemVariableAssigner.php‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
namespace Mpyw\LaravelMySqlSystemVariableManager;
44

55
use Closure;
6+
use Mpyw\LaravelMySqlSystemVariableManager\Value as BindingValue;
67
use Mpyw\LaravelPdoEmulationControl\EmulationController;
78
use Mpyw\Unclosure\Value;
89
use PDO;
@@ -86,7 +87,8 @@ protected static function withStatementFor(PDO $pdo, string $query, array $value
8687
{
8788
$statement = $pdo->prepare($query);
8889
foreach (array_values($values) as $i => $value) {
89-
$statement->bindValue($i + 1, $value, Grammar::paramTypeFor($value));
90+
$value = BindingValue::wrap($value);
91+
$statement->bindValue($i + 1, $value->getValue(), $value->getParamType());
9092
}
9193
$statement->execute();
9294

‎src/SystemVariableGrammar.php‎

Lines changed: 1 addition & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
namespace Mpyw\LaravelMySqlSystemVariableManager;
44

5-
use PDO;
6-
75
class SystemVariableGrammar
86
{
97
/**
@@ -23,42 +21,11 @@ public static function assignmentExpressions(array $values): array
2321
{
2422
$expressions = [];
2523
foreach ($values as $name => $value) {
26-
$expressions[] = static::escapeIdentifier($name) . '=' . static::placeholderFor($value);
24+
$expressions[] = static::escapeIdentifier($name) . '=' . Value::wrap($value)->getPlaceholder();
2725
}
2826
return $expressions;
2927
}
3028

31-
/**
32-
* @param mixed $value
33-
* @return int
34-
*/
35-
public static function paramTypeFor($value): int
36-
{
37-
switch (gettype($value)) {
38-
case 'integer':
39-
return PDO::PARAM_INT;
40-
case 'boolean':
41-
return PDO::PARAM_BOOL;
42-
case 'NULL':
43-
default:
44-
return PDO::PARAM_STR;
45-
}
46-
}
47-
48-
/**
49-
* @param mixed $value
50-
* @return string
51-
*/
52-
public static function placeholderFor($value): string
53-
{
54-
switch (gettype($value)) {
55-
case 'double':
56-
return 'cast(? as decimal(65, 30))';
57-
default:
58-
return '?';
59-
}
60-
}
61-
6229
/**
6330
* @param string $identifier
6431
* @return string

‎src/Value.php‎

Lines changed: 172 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,172 @@
1+
<?php
2+
3+
namespace Mpyw\LaravelMySqlSystemVariableManager;
4+
5+
use InvalidArgumentException;
6+
use PDO;
7+
8+
class Value implements ValueInterface
9+
{
10+
/**
11+
* @var mixed
12+
*/
13+
protected $value;
14+
15+
/**
16+
* @var string
17+
*/
18+
protected $type;
19+
20+
/**
21+
* Create new int value for MySQL system variable.
22+
*
23+
* @param int $value
24+
* @return static
25+
*/
26+
public static function int(int $value)
27+
{
28+
return new static($value, static::TYPE_INT);
29+
}
30+
31+
/**
32+
* Create new bool value for MySQL system variable.
33+
*
34+
* @param bool $value
35+
* @return static
36+
*/
37+
public static function bool(bool $value)
38+
{
39+
return new static($value, static::TYPE_BOOL);
40+
}
41+
42+
/**
43+
* Create new float value for MySQL system variable.
44+
*
45+
* @param float $value
46+
* @return static
47+
*/
48+
public static function float(float $value)
49+
{
50+
return new static($value, static::TYPE_FLOAT);
51+
}
52+
53+
/**
54+
* Create new string value for MySQL system variable.
55+
*
56+
* @param string $value
57+
* @return static
58+
*/
59+
public static function str(string $value)
60+
{
61+
return new static($value, static::TYPE_STR);
62+
}
63+
64+
/**
65+
* Create new typed value for MySQL system variable.
66+
*
67+
* @param string $type
68+
* @param bool|float|int|string $value
69+
* @return \Mpyw\LaravelMySqlSystemVariableManager\ValueInterface
70+
*/
71+
public static function as(string $type, $value): ValueInterface
72+
{
73+
switch ($type) {
74+
case static::TYPE_INT:
75+
return static::int($value);
76+
case static::TYPE_BOOL:
77+
return static::bool($value);
78+
case static::TYPE_FLOAT:
79+
return static::float($value);
80+
case static::TYPE_STR:
81+
return static::str($value);
82+
default:
83+
throw new InvalidArgumentException('The type must be one of "integer", "boolean", "double" or "string".');
84+
}
85+
}
86+
87+
/**
88+
* Automatically wrap a non-null value.
89+
*
90+
* @param mixed $value
91+
* @return \Mpyw\LaravelMySqlSystemVariableManager\ValueInterface
92+
*/
93+
public static function wrap($value): ValueInterface
94+
{
95+
if ($value instanceof ValueInterface) {
96+
return $value;
97+
}
98+
if (is_scalar($value)) {
99+
return static::as(gettype($value), $value);
100+
}
101+
throw new InvalidArgumentException('The value must be a scalar or ' . ValueInterface::class . ' instance.');
102+
}
103+
104+
/**
105+
* Value constructor.
106+
*
107+
* @param mixed $value
108+
* @param string $type
109+
*/
110+
protected function __construct($value, string $type)
111+
{
112+
$this->value = $value;
113+
$this->type = $type;
114+
}
115+
116+
/**
117+
* Return original value.
118+
*
119+
* @return bool|float|int|string
120+
*/
121+
public function getValue()
122+
{
123+
return $this->value;
124+
}
125+
126+
/**
127+
* Return type.
128+
*
129+
* @return string
130+
*/
131+
public function getType(): string
132+
{
133+
return $this->type;
134+
}
135+
136+
/**
137+
* Return PDO::PARAM_* type.
138+
*
139+
* @return int
140+
*/
141+
public function getParamType(): int
142+
{
143+
switch ($this->type) {
144+
case static::TYPE_INT:
145+
return PDO::PARAM_INT;
146+
case static::TYPE_BOOL:
147+
return PDO::PARAM_BOOL;
148+
case static::TYPE_FLOAT:
149+
case static::TYPE_STR:
150+
default:
151+
return PDO::PARAM_STR;
152+
}
153+
}
154+
155+
/**
156+
* Return a placeholder format.
157+
*
158+
* @return string
159+
*/
160+
public function getPlaceholder(): string
161+
{
162+
switch ($this->type) {
163+
case static::TYPE_FLOAT:
164+
return 'cast(? as decimal(65, 30))';
165+
case static::TYPE_INT:
166+
case static::TYPE_BOOL:
167+
case static::TYPE_STR:
168+
default:
169+
return '?';
170+
}
171+
}
172+
}

‎src/ValueInterface.php‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
<?php
2+
3+
namespace Mpyw\LaravelMySqlSystemVariableManager;
4+
5+
interface ValueInterface
6+
{
7+
public const TYPE_INT = 'integer';
8+
public const TYPE_BOOL = 'boolean';
9+
public const TYPE_FLOAT = 'double';
10+
public const TYPE_STR = 'string';
11+
12+
/**
13+
* Return original value.
14+
*
15+
* @return bool|float|int|string
16+
*/
17+
public function getValue();
18+
19+
/**
20+
* Return type.
21+
*
22+
* @return string
23+
*/
24+
public function getType(): string;
25+
26+
/**
27+
* Return PDO::PARAM_* type.
28+
*
29+
* @return int
30+
*/
31+
public function getParamType(): int;
32+
33+
/**
34+
* Return placeholder for prepared statement.
35+
*
36+
* @return string
37+
*/
38+
public function getPlaceholder(): string;
39+
}

‎tests/BasicVariableAssignmentTest.php‎

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22

33
namespace Mpyw\LaravelMySqlSystemVariableManager\Tests;
44

5+
use InvalidArgumentException;
56
use Mpyw\LaravelMySqlSystemVariableManager\MySqlConnection;
6-
use PDOException;
7+
use Mpyw\LaravelMySqlSystemVariableManager\Value;
78

89
class BasicVariableAssignmentTest extends TestCase
910
{
@@ -39,13 +40,21 @@ public function provideBasicVariables(): array
3940
'assigning boolean (emulated)' => ['foreign_key_checks', true, '1', false, '0'],
4041
'assigning string (native)' => ['tx_isolation', false, 'REPEATABLE-READ', 'read-committed', 'READ-COMMITTED'],
4142
'assigning string (emulated)' => ['tx_isolation', true, 'REPEATABLE-READ', 'read-committed', 'READ-COMMITTED'],
43+
'assigning wrapped float (native)' => ['long_query_time', false, 10.0, Value::float(15.0), 15.0],
44+
'assigning wrapped float (emulated)' => ['long_query_time', true, '10.000000', Value::float(15.0), '15.000000'],
45+
'assigning wrapped integer (native)' => ['long_query_time', false, 10.0, Value::int(15), 15.0],
46+
'assigning wrapped integer (emulated)' => ['long_query_time', true, '10.000000', Value::int(15), '15.000000'],
47+
'assigning wrapped boolean (native)' => ['foreign_key_checks', false, 1, Value::bool(false), 0],
48+
'assigning wrapped boolean (emulated)' => ['foreign_key_checks', true, '1', Value::bool(false), '0'],
49+
'assigning wrapped string (native)' => ['tx_isolation', false, 'REPEATABLE-READ', Value::str('read-committed'), 'READ-COMMITTED'],
50+
'assigning wrapped string (emulated)' => ['tx_isolation', true, 'REPEATABLE-READ', Value::str('read-committed'), 'READ-COMMITTED'],
4251
];
4352
}
4453

4554
public function testAssigningNullThrowsExceptionOnNative(): void
4655
{
47-
$this->expectException(PDOException::class);
48-
$this->expectExceptionMessage("SQLSTATE[42000]: Syntax error or access violation: 1231 Variable 'foreign_key_checks' can't be set to the value of 'NULL'");
56+
$this->expectException(InvalidArgumentException::class);
57+
$this->expectExceptionMessage('The value must be a scalar or Mpyw\LaravelMySqlSystemVariableManager\ValueInterface instance.');
4958

5059
$this->onNativeConnection(function (MySqlConnection $db) {
5160
$db->setSystemVariable('foreign_key_checks', null);
@@ -55,24 +64,33 @@ public function testAssigningNullThrowsExceptionOnNative(): void
5564

5665
public function testAssigningNullThrowsExceptionOnEmulation(): void
5766
{
58-
$this->expectException(PDOException::class);
59-
$this->expectExceptionMessage("SQLSTATE[42000]: Syntax error or access violation: 1231 Variable 'foreign_key_checks' can't be set to the value of 'NULL'");
67+
$this->expectException(InvalidArgumentException::class);
68+
$this->expectExceptionMessage('The value must be a scalar or Mpyw\LaravelMySqlSystemVariableManager\ValueInterface instance.');
6069

6170
$this->onEmulatedConnection(function (MySqlConnection $db) {
6271
$db->setSystemVariable('foreign_key_checks', null);
6372
$db->getPdo();
6473
});
6574
}
6675

67-
public function testAssigningNullDoesNotThrowOnUnresolvedConnection(): void
76+
public function testAssigningNullThrowsOnUnresolvedNativeConnection(): void
6877
{
78+
$this->expectException(InvalidArgumentException::class);
79+
$this->expectExceptionMessage('The value must be a scalar or Mpyw\LaravelMySqlSystemVariableManager\ValueInterface instance.');
80+
6981
$this->onNativeConnection(function (MySqlConnection $db) {
7082
$db->setSystemVariable('foreign_key_checks', null);
7183
});
84+
}
85+
86+
public function testAssigningNullThrowsOnUnresolvedEmulatedConnection(): void
87+
{
88+
$this->expectException(InvalidArgumentException::class);
89+
$this->expectExceptionMessage('The value must be a scalar or Mpyw\LaravelMySqlSystemVariableManager\ValueInterface instance.');
90+
7291
$this->onEmulatedConnection(function (MySqlConnection $db) {
7392
$db->setSystemVariable('foreign_key_checks', null);
7493
});
75-
$this->assertTrue(true);
7694
}
7795

7896
public function testAssignmentPriorityOnLazilyResolvedConnection(): void

0 commit comments

Comments
 (0)