Merge branch '0.6.x' into patch-metadata-abstract-source-get-column

Author: simon-mundy

src/Adapter/Driver/Pdo/Result.php

@@ -81,7 +81,7 @@ class Result implements Iterator, ResultInterface
     /** @var string|int|false|null */
     protected $generatedValue;
 
-    protected Closure|int $rowCount;
+    protected Closure|int|null $rowCount = null;
 
     /**
      * Initialize
@@ -91,7 +91,7 @@ class Result implements Iterator, ResultInterface
     public function initialize(
         PDOStatement $resource,
         $generatedValue,
-        Closure|int $rowCount = 0
+        Closure|int|null $rowCount = null
     ): ResultInterface&Result {
         $this->resource       = $resource;
         $this->generatedValue = $generatedValue;
@@ -250,7 +250,6 @@ public function count()
         if (is_int($this->rowCount)) {
             return $this->rowCount;
         }
-        /** @phpstan-ignore instanceof.alwaysTrue */
         if ($this->rowCount instanceof Closure) {
             $this->rowCount = (int) ($this->rowCount)();
         } else {

src/Adapter/Driver/Pdo/Statement.php

@@ -22,6 +22,8 @@
 use function is_array;
 use function is_int;
 use function ltrim;
+use function preg_match;
+use function sprintf;
 
 class Statement implements StatementInterface, PdoDriverAwareInterface, ProfilerAwareInterface
 {
@@ -223,8 +225,19 @@ protected function bindParametersFromContainer(): void
                 };
             }
 
-            // parameter is named or positional, value is reference
-            $parameter = is_int($name) ? $name + 1 : ':' . ltrim($name, ':');
+            if (is_int($name)) {
+                $parameter = $name + 1;
+            } else {
+                if (! preg_match('/^:?[a-zA-Z0-9_]+$/', $name)) {
+                    throw new Exception\RuntimeException(sprintf(
+                        'The PDO param "%s" contains invalid characters.'
+                        . ' Only alphabetic characters, digits, and underscores (_) are allowed.',
+                        $name
+                    ));
+                }
+                $parameter = ':' . ltrim($name, ':');
+            }
+
             $this->resource->bindParam($parameter, $value, $type);
         }
 

test/unit/Adapter/Driver/Pdo/ResultTest.php

@@ -17,6 +17,7 @@
 use function uniqid;
 
 #[CoversMethod(Result::class, 'current')]
+#[CoversMethod(Result::class, 'count')]
 #[Group('result-pdo')]
 final class ResultTest extends TestCase
 {
@@ -108,4 +109,74 @@ public function testMultipleRewind(): void
         $this->assertEquals(2, $position);
         $this->assertEquals($data[1], $result->current());
     }
+
+    public function testCountWithNoRowCountFallsBackToStatementRowCount(): void
+    {
+        $stub = $this->getMockBuilder(PDOStatement::class)->getMock();
+        $stub->expects($this->once())
+            ->method('rowCount')
+            ->willReturn(5);
+
+        $result = new Result();
+        $result->initialize($stub, null);
+
+        self::assertSame(5, $result->count());
+    }
+
+    public function testCountWithClosureInvokesClosureAndReturnsValue(): void
+    {
+        $stub = $this->getMockBuilder(PDOStatement::class)->getMock();
+        $stub->expects($this->never())->method('rowCount');
+
+        $rowCount = static fn(): int => 42;
+
+        $result = new Result();
+        $result->initialize($stub, null, $rowCount);
+
+        self::assertSame(42, $result->count());
+    }
+
+    public function testCountWithIntReturnsProvidedValue(): void
+    {
+        $stub = $this->getMockBuilder(PDOStatement::class)->getMock();
+        $stub->expects($this->never())->method('rowCount');
+
+        $result = new Result();
+        $result->initialize($stub, null, 10);
+
+        self::assertSame(10, $result->count());
+    }
+
+    public function testCountCachesResultFromClosure(): void
+    {
+        $callCount = 0;
+        $rowCount  = static function () use (&$callCount): int {
+            $callCount++;
+            return 7;
+        };
+
+        $stub = $this->getMockBuilder(PDOStatement::class)->getMock();
+
+        $result = new Result();
+        $result->initialize($stub, null, $rowCount);
+
+        $result->count();
+        $result->count();
+
+        self::assertSame(1, $callCount);
+    }
+
+    public function testCountCachesResultFromStatementRowCount(): void
+    {
+        $stub = $this->getMockBuilder(PDOStatement::class)->getMock();
+        $stub->expects($this->once())->method('rowCount')->willReturn(3);
+
+        $result = new Result();
+        $result->initialize($stub, null);
+
+        $result->count();
+        $result->count();
+
+        self::assertSame(3, $result->count());
+    }
 }

test/unit/Adapter/Driver/Pdo/StatementTest.php

@@ -7,10 +7,12 @@
 use Override;
 use PhpDb\Adapter\Driver\Pdo\Result;
 use PhpDb\Adapter\Driver\Pdo\Statement;
+use PhpDb\Adapter\Exception\RuntimeException;
 use PhpDb\Adapter\ParameterContainer;
 use PhpDbTest\Adapter\Driver\Pdo\TestAsset\TestConnection;
 use PhpDbTest\Adapter\Driver\Pdo\TestAsset\TestPdo;
 use PHPUnit\Framework\Attributes\CoversMethod;
+use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 
 #[CoversMethod(Statement::class, 'setDriver')]
@@ -22,6 +24,7 @@
 #[CoversMethod(Statement::class, 'prepare')]
 #[CoversMethod(Statement::class, 'isPrepared')]
 #[CoversMethod(Statement::class, 'execute')]
+#[CoversMethod(Statement::class, 'bindParametersFromContainer')]
 final class StatementTest extends TestCase
 {
     protected Statement $statement;
@@ -111,4 +114,29 @@ public function testExecute(): void
         $this->statement->prepare('SELECT 1');
         self::assertInstanceOf(Result::class, $this->statement->execute());
     }
+
+    /** @return array<string, array{string}> */
+    public static function invalidParameterNameProvider(): array
+    {
+        return [
+            'dollar sign' => ['tz$'],
+            'with colon'  => [':tz$'],
+            'hyphen'      => ['my-param'],
+            'space'       => ['my param'],
+            'dot'         => ['my.param'],
+            'at sign'     => ['param@name'],
+        ];
+    }
+
+    #[DataProvider('invalidParameterNameProvider')]
+    public function testExecuteThrowsOnInvalidParameterName(string $name): void
+    {
+        $this->statement->setDriver(new TestPdo(new TestConnection($pdo = new TestAsset\SqliteMemoryPdo())));
+        $this->statement->initialize($pdo);
+        $this->statement->prepare('SELECT 1');
+
+        $this->expectException(RuntimeException::class);
+        $this->expectExceptionMessage('contains invalid characters');
+        $this->statement->execute([$name => 'value']);
+    }
 }