feat: use any literal with expressions

Author: tpetry

README.md

@@ -31,10 +31,10 @@ And you can also create new powerful queries:
 ```php
 // Aggregate multiple statistics with one query for dashboards:
 Movie::select([
-    new CountFilter(new Equal('released', new Number(2021))),
-    new CountFilter(new Equal('released', new Number(2022))),
-    new CountFilter(new Equal('genre_id', new Number(12))),
-    new CountFilter(new Equal('genre_id', new Number(35))),
+    new CountFilter(new Equal('released', new Value(2021))),
+    new CountFilter(new Equal('released', new Value(2022))),
+    new CountFilter(new Equal('genre', new Value('Drama'))),
+    new CountFilter(new Equal('genre', new Value('Comedy'))),
 ])->where('streamingservice', 'netflix');
 ```
 
@@ -65,25 +65,26 @@ Whenever an expression class needs a `string|Expression` parameter, you can pass
 
 As stated before, an expression is always a column name.
 But if you want to e.g. do an equality check, you may want to compare something to a specific value.
-That's where you should use the `Number` class.
+That's where you should use the `Value` class.
+Its values will always be automatically escaped within the query.
 
 ```php
-use Tpetry\QueryExpressions\Value\Number;
+use Tpetry\QueryExpressions\Value\Value;
 
-new Number(44);
-new Number(3.1415);
+new Value(42);
+new Value("Robert'); DROP TABLE students;--");
 ```
 
 > **Note**
-> The `Number` class in isolation is not that usefull.
+> The `Value` class in isolation is not that usefull.
 > But it will be used more in the next examples.
 
 #### Alias
 
 ```php
 use Illuminate\Contracts\Database\Query\Expression;
 use Tpetry\QueryExpressions\Language\Alias;
-use Tpetry\QueryExpressions\Value\Number;
+use Tpetry\QueryExpressions\Value\Value;
 
 new Alias(string|Expression $expression, string $name)
 
@@ -106,7 +107,7 @@ use Illuminate\Contracts\Database\Query\Expression;
 use Tpetry\QueryExpressions\Operator\Arithmetic\{
     Add, Divide, Modulo, Multiply, Power, Subtract,
 };
-use Tpetry\QueryExpressions\Operator\Value\Number;
+use Tpetry\QueryExpressions\Operator\Value\Value;
 
 new Add(string|Expression $value1, string|Expression $value2);
 new Divide(string|Expression $value1, string|Expression $value2);
@@ -117,14 +118,14 @@ new Subtract(string|Expression $value1, string|Expression $value2);
 
 // UPDATE user_quotas SET credits = credits - 15 WHERE id = 1985
 $quota->update([
-    'credits' => new Subtract('credits', new Number(15)),
+    'credits' => new Subtract('credits', new Value(15)),
 ]);
 
 // SELECT id, name, (price - discount) * 0.2 AS vat FROM products
 Product::select([
     'id',
     'name',
-    new Alias(new Multiply(new Subtract('price', 'discount'), new Number(0.2)), 'vat')
+    new Alias(new Multiply(new Subtract('price', 'discount'), new Value(0.2)), 'vat')
 ])->get();
 ```
 
@@ -135,7 +136,7 @@ use Illuminate\Contracts\Database\Query\Expression;
 use Tpetry\QueryExpressions\Operator\Bitwise\{
     BitAnd, BitNot, BitOr, BitXor, ShiftLeft, ShiftRight,
 };
-use Tpetry\QueryExpressions\Operator\Value\Number;
+use Tpetry\QueryExpressions\Operator\Value\Value;
 
 new BitAnd(string|Expression $value1, string|Expression $value2);
 new BitNot(string|Expression $value);
@@ -145,7 +146,7 @@ new ShiftLeft(string|Expression $value, string|Expression $times);
 new ShiftRight(string|Expression $value, string|Expression $times);
 
 // SELECT * FROM users WHERE (acl & 0x8000) = 0x8000
-User::where(new BitAnd('acl', 0x8000), 0x8000)
+User::where(new BitAnd('acl', new Value(0x8000)), 0x8000)
     ->get();
 ```
 
@@ -159,7 +160,6 @@ use Tpetry\QueryExpressions\Operator\Comparison\{
 use Tpetry\QueryExpressions\Operator\Logical\{
     CondAnd, CondNot, CondOr, CondXor
 };
-use Tpetry\QueryExpressions\Operator\Value\Number;
 
 new Between(string|Expression $value, string|Expression $min, string|Expression $max);
 new DistinctFrom(string|Expression $value1, string|Expression $value2);
@@ -193,7 +193,7 @@ use Illuminate\Contracts\Database\Query\Expression;
 use Tpetry\QueryExpressions\Function\Aggregate\{
     Avg, Count, CountFilter, Max, Min, Sum, SumFilter,
 };
-use Tpetry\QueryExpressions\Operator\Value\Number;
+use Tpetry\QueryExpressions\Operator\Value\Value;
 
 new Avg(string|Expression $value);
 new Count(string|Expression $value);
@@ -214,15 +214,15 @@ BlogVisit::select([
 // SELECT
 //   COUNT(*) FILTER (WHERE (released = 2021)) AS released_2021,
 //   COUNT(*) FILTER (WHERE (released = 2022)) AS released_20212,
-//   COUNT(*) FILTER (WHERE (genre_id = 12)) AS genre_12,
-//   COUNT(*) FILTER (WHERE (genre_id = 35)) AS genre_35
+//   COUNT(*) FILTER (WHERE (genre = 'Drama')) AS genre_drama,
+//   COUNT(*) FILTER (WHERE (genre = 'Comedy')) AS genre_comedy
 // FROM movies
 // WHERE streamingservice = 'netflix'
 Movie::select([
-    new Alias(new CountFilter(new Equal('released', new Number(2021))), 'released_2021'),
-    new Alias(new CountFilter(new Equal('released', new Number(2022))), 'released_2022'),
-    new Alias(new CountFilter(new Equal('genre_id', new Number(12))), 'genre_12'),
-    new Alias(new CountFilter(new Equal('genre_id', new Number(35))), 'genre_35'),
+    new Alias(new CountFilter(new Equal('released', new Value(2021))), 'released_2021'),
+    new Alias(new CountFilter(new Equal('released', new Value(2022))), 'released_2022'),
+    new Alias(new CountFilter(new Equal('genre', new Value('Drama'))), 'genre_drama'),
+    new Alias(new CountFilter(new Equal('genre', new Value('Comedy'))), 'genre_comedy'),
 ])
     ->where('streamingservice', 'netflix')
     ->get();

composer.json

@@ -18,8 +18,8 @@
     ],
     "require": {
         "php": "^8.1",
-        "illuminate/contracts": "^10.0",
-        "illuminate/database": "^10.0",
+        "illuminate/contracts": "^10.13.0",
+        "illuminate/database": "^10.13.0",
         "illuminate/support": "^10.0"
     },
     "require-dev": {

src/Value/Value.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tpetry\QueryExpressions\Value;
+
+use Illuminate\Contracts\Database\Query\Expression;
+use Illuminate\Database\Grammar;
+
+class Value implements Expression
+{
+    public function __construct(
+        private readonly string|int|float|bool|null $value,
+        private readonly bool $binary = false,
+    ) {
+    }
+
+    public function getValue(Grammar $grammar): string
+    {
+        return $grammar->escape($this->value, $this->binary);
+    }
+}

tests/Pest.php

@@ -2,10 +2,6 @@
 
 declare(strict_types=1);
 
-use Illuminate\Database\Query\Grammars\MySqlGrammar;
-use Illuminate\Database\Query\Grammars\PostgresGrammar;
-use Illuminate\Database\Query\Grammars\SQLiteGrammar;
-use Illuminate\Database\Query\Grammars\SqlServerGrammar;
 use Illuminate\Support\Facades\DB;
 use Pest\Expectation;
 use PHPUnit\Framework\Assert;
@@ -38,25 +34,33 @@
 });
 
 expect()->extend('toBeMysql', function (string $expected): Expectation {
-    Assert::assertSame($expected, $this->value->getValue(new MySqlGrammar()));
+    if (DB::connection()->getDriverName() === 'mysql') {
+        Assert::assertSame($expected, $this->value->getValue(DB::connection()->getQueryGrammar()));
+    }
 
     return $this;
 });
 
 expect()->extend('toBePgsql', function (string $expected): Expectation {
-    Assert::assertSame($expected, $this->value->getValue(new PostgresGrammar()));
+    if (DB::connection()->getDriverName() === 'pgsql') {
+        Assert::assertSame($expected, $this->value->getValue(DB::connection()->getQueryGrammar()));
+    }
 
     return $this;
 });
 
 expect()->extend('toBeSqlite', function (string $expected): Expectation {
-    Assert::assertSame($expected, $this->value->getValue(new SQLiteGrammar()));
+    if (DB::connection()->getDriverName() === 'sqlite') {
+        Assert::assertSame($expected, $this->value->getValue(DB::connection()->getQueryGrammar()));
+    }
 
     return $this;
 });
 
 expect()->extend('toBeSqlsrv', function (string $expected): Expectation {
-    Assert::assertSame($expected, $this->value->getValue(new SqlServerGrammar()));
+    if (DB::connection()->getDriverName() === 'sqlsrv') {
+        Assert::assertSame($expected, $this->value->getValue(DB::connection()->getQueryGrammar()));
+    }
 
     return $this;
 });

tests/Value/ValueTest.php

@@ -0,0 +1,61 @@
+<?php
+
+declare(strict_types=1);
+
+use Tpetry\QueryExpressions\Value\Value;
+
+it('can output an integer')
+    ->expect(new Value(10))
+    ->toBeExecutable()
+    ->toBeMysql('10')
+    ->toBePgsql('10')
+    ->toBeSqlite('10')
+    ->toBeSqlsrv('10');
+
+it('can output a float')
+    ->expect(new Value(3.141592))
+    ->toBeExecutable()
+    ->toBeMysql('3.141592')
+    ->toBePgsql('3.141592')
+    ->toBeSqlite('3.141592')
+    ->toBeSqlsrv('3.141592');
+
+it('can output a boolean (true)')
+    ->expect(new Value(true))
+    ->toBeExecutable()
+    ->toBeMysql('1')
+    ->toBePgsql('true')
+    ->toBeSqlite('1')
+    ->toBeSqlsrv('1');
+
+it('can output a boolean (false)')
+    ->expect(new Value(false))
+    ->toBeExecutable()
+    ->toBeMysql('0')
+    ->toBePgsql('false')
+    ->toBeSqlite('0')
+    ->toBeSqlsrv('0');
+
+it('can output a string')
+    ->expect(new Value("Robert'); DROP TABLE students;--"))
+    ->toBeExecutable()
+    ->toBeMysql("'Robert\'); DROP TABLE students;--'")
+    ->toBePgsql("'Robert''); DROP TABLE students;--'")
+    ->toBeSqlite("'Robert''); DROP TABLE students;--'")
+    ->toBeSqlsrv("'Robert''); DROP TABLE students;--'");
+
+it('can output binary')
+    ->expect(new Value(hex2bin('dead00beef'), true))
+    ->toBeExecutable()
+    ->toBeMysql("x'dead00beef'")
+    ->toBePgsql("'\\xdead00beef'::bytea")
+    ->toBeSqlite("x'dead00beef'")
+    ->toBeSqlsrv('0xdead00beef');
+
+it('can output null')
+    ->expect(new Value(null))
+    ->toBeExecutable()
+    ->toBeMysql('null')
+    ->toBePgsql('null')
+    ->toBeSqlite('null')
+    ->toBeSqlsrv('null');