Reorganized imports; fixed some issues reported by phpstan and hinted some false positives

rkrx · rkrx · commit e0276734805f · 2023-10-17T10:26:02.000+02:00
diff --git a/composer.json b/composer.json
@@ -16,7 +16,7 @@
 	},
 	"require-dev": {
 		"phpunit/phpunit": ">= 6.0",
-		"phpstan/phpstan": "*@stable",
+		"phpstan/phpstan": ">= 0.1",
 		"jetbrains/phpstorm-attributes": "^1.0"
 	},
 	"autoload": {
diff --git a/src/Builder/Expr/DBOrderSpec.php b/src/Builder/Expr/DBOrderSpec.php
@@ -2,8 +2,6 @@
 
 namespace Kir\MySQL\Builder\Expr;
 
-use RuntimeException;
-
 /**
  * Defines fields that are sortable. Sortable fields have an alias.
  * The alias can be passed as a sort specifier - along with the direction in which to sort.
diff --git a/src/Builder/Insert.php b/src/Builder/Insert.php
@@ -1,7 +1,7 @@
 <?php
 namespace Kir\MySQL\Builder;
 
-use Kir\MySQL\Databases\MySQL\MySQLSelect;
+use DateTimeInterface;
 use Kir\MySQL\Tools\AliasReplacer;
 use RuntimeException;
 use Traversable;
@@ -54,7 +54,7 @@ public function setKey(string $field) {
 
 	/**
 	 * @param string $field
-	 * @param null|bool|int|float|string $value
+	 * @param null|bool|int|float|string|DateTimeInterface $value
 	 * @return $this
 	 */
 	public function add(string $field, $value) {
@@ -64,7 +64,7 @@ public function add(string $field, $value) {
 
 	/**
 	 * @param string $field
-	 * @param null|bool|int|float|string $value
+	 * @param null|bool|int|float|string|DateTimeInterface $value
 	 * @return $this
 	 */
 	public function update(string $field, $value) {
@@ -74,7 +74,7 @@ public function update(string $field, $value) {
 
 	/**
 	 * @param string $field
-	 * @param null|bool|int|float|string $value
+	 * @param null|bool|int|float|string|DateTimeInterface $value
 	 * @return $this
 	 */
 	public function addOrUpdate(string $field, $value) {
@@ -128,7 +128,7 @@ public function addOrUpdateExpr(string $expr, ...$args) {
 	}
 
 	/**
-	 * @param array<string, mixed> $data
+	 * @param array<string, null|bool|int|float|string|DateTimeInterface> $data
 	 * @param array<int, string>|null $mask
 	 * @param array<int, string>|null $excludeFields
 	 * @return $this
@@ -141,7 +141,7 @@ public function addAll(array $data, array $mask = null, array $excludeFields = n
 	}
 
 	/**
-	 * @param array<string, mixed> $data
+	 * @param array<string, null|bool|int|float|string|DateTimeInterface> $data
 	 * @param array<int, string>|null $mask
 	 * @param array<int, string>|null $excludeFields
 	 * @return $this
@@ -156,7 +156,7 @@ public function updateAll(array $data, array $mask = null, array $excludeFields
 	}
 
 	/**
-	 * @param array<string, mixed> $data
+	 * @param array<string, null|bool|int|float|string|DateTimeInterface> $data
 	 * @param array<int, string>|null $mask
 	 * @param array<int, string>|null $excludeFields
 	 * @return $this
diff --git a/src/Builder/InsertUpdateStatement.php b/src/Builder/InsertUpdateStatement.php
@@ -2,8 +2,6 @@
 namespace Kir\MySQL\Builder;
 
 use Kir\MySQL\Builder\Internal\DefaultValue;
-use Kir\MySQL\Builder\DBExpr;
-use Kir\MySQL\Builder\Select;
 
 abstract class InsertUpdateStatement extends Statement {
 	/** @var array<int, string> */
diff --git a/src/Builder/Internal/ConditionBuilder.php b/src/Builder/Internal/ConditionBuilder.php
@@ -1,9 +1,9 @@
 <?php
 namespace Kir\MySQL\Builder\Internal;
 
+use Kir\MySQL\Builder;
 use Kir\MySQL\Builder\Expr\OptionalExpression;
 use Kir\MySQL\Database;
-use Kir\MySQL\Builder;
 
 final class ConditionBuilder {
 	/**
diff --git a/src/Builder/Internal/DDLRunnable.php b/src/Builder/Internal/DDLRunnable.php
@@ -9,12 +9,12 @@
 class DDLRunnable {
 	/** @var DatabaseStatement */
 	private $query;
-	/** @var null|callable(): T */
+	/** @var null|callable(scalar=): T */
 	private $callbackFn;
 
 	/**
 	 * @param DatabaseStatement $query
-	 * @param null|callable(): T $callbackFn
+	 * @param null|callable(scalar=): T $callbackFn
 	 */
 	public function __construct(DatabaseStatement $query, ?callable $callbackFn = null) {
 		$this->query = $query;
diff --git a/src/Builder/QueryStatement.php b/src/Builder/QueryStatement.php
@@ -1,13 +1,13 @@
 <?php
 namespace Kir\MySQL\Builder;
 
+use Kir\MySQL\Database\DatabaseStatement;
 use Kir\MySQL\Databases\MySQL\MySQLExceptionInterpreter;
 use Kir\MySQL\Exceptions\SqlException;
+use Kir\MySQL\QueryLogger\QueryLoggers;
 use PDO;
 use PDOException;
 use PDOStatement;
-use Kir\MySQL\Database\DatabaseStatement;
-use Kir\MySQL\QueryLogger\QueryLoggers;
 
 class QueryStatement implements DatabaseStatement {
 	/** @var PDOStatement<mixed> */
diff --git a/src/Builder/RunnableDelete.php b/src/Builder/RunnableDelete.php
@@ -24,6 +24,15 @@ public function run(array $params = []) {
 	 * @return DDLRunnable<int>
 	 */
 	public function prepare(): DDLRunnable {
-		return $this->createPreparable($this->db()->prepare($this), 'intval');
+		return $this->createPreparable(
+			$this->db()->prepare($this),
+			/**
+			 * @param scalar $v
+			 * @return int
+			 */
+			function ($v) {
+				return (int) $v;
+			}
+		);
 	}
 }
diff --git a/src/Builder/RunnableSelect.php b/src/Builder/RunnableSelect.php
@@ -3,8 +3,8 @@
 
 use Generator;
 use IteratorAggregate;
-use Kir\MySQL\Tools\AliasReplacer;
 use Kir\MySQL\Builder\Helpers\DBIgnoreRow;
+use Kir\MySQL\Tools\AliasReplacer;
 use Traversable;
 
 /**
diff --git a/src/Builder/RunnableUpdate.php b/src/Builder/RunnableUpdate.php
@@ -24,6 +24,15 @@ public function run(array $params = []): int {
 	 * @return DDLRunnable<int>
 	 */
 	public function prepare(): DDLRunnable {
-		return $this->createPreparable($this->db()->prepare($this), 'intval');
+		return $this->createPreparable(
+			$this->db()->prepare($this),
+			/**
+			 * @param bool|int|float|string $v
+			 * @return int
+			 */
+			function ($v) {
+				return (int) $v;
+			}
+		);
 	}
 }
diff --git a/src/Builder/Traits/CreateDDLRunnable.php b/src/Builder/Traits/CreateDDLRunnable.php
@@ -10,10 +10,11 @@
 trait CreateDDLRunnable {
 	/**
 	 * @param DatabaseStatement $query
-	 * @param callable(scalar=): T $callbackFn
+	 * @param callable(scalar): T $callbackFn
 	 * @return DDLRunnable<T>
 	 */
 	public function createPreparable(DatabaseStatement $query, $callbackFn): DDLRunnable {
+		// @phpstan-ignore-next-line
 		return new DDLRunnable($query, $callbackFn);
 	}
 }
diff --git a/src/Builder/Traits/HavingBuilder.php b/src/Builder/Traits/HavingBuilder.php
@@ -3,10 +3,10 @@
 
 use DateTimeInterface;
 use Kir\MySQL\Builder\DBExpr;
-use Kir\MySQL\Builder\Select;
 use Kir\MySQL\Builder\Expr\OptionalExpression;
 use Kir\MySQL\Builder\Helpers\ConditionAddHelper;
 use Kir\MySQL\Builder\Internal\ConditionBuilder;
+use Kir\MySQL\Builder\Select;
 
 trait HavingBuilder {
 	use AbstractDB;
diff --git a/src/Builder/Traits/JoinBuilder.php b/src/Builder/Traits/JoinBuilder.php
@@ -1,8 +1,8 @@
 <?php
 namespace Kir\MySQL\Builder\Traits;
 
-use Kir\MySQL\Builder\Select;
 use Kir\MySQL\Builder\DBExpr;
+use Kir\MySQL\Builder\Select;
 use Kir\MySQL\Tools\VirtualTable;
 
 trait JoinBuilder {
diff --git a/src/Builder/Traits/UnionBuilder.php b/src/Builder/Traits/UnionBuilder.php
@@ -2,7 +2,6 @@
 namespace Kir\MySQL\Builder\Traits;
 
 use Kir\MySQL\Builder\Select;
-use Kir\MySQL\Databases\MySQL\MySQLSelect;
 
 trait UnionBuilder {
 	use AbstractDB;
diff --git a/src/Builder/Traits/WhereBuilder.php b/src/Builder/Traits/WhereBuilder.php
@@ -3,10 +3,10 @@
 
 use DateTimeInterface;
 use Kir\MySQL\Builder\DBExpr;
-use Kir\MySQL\Builder\Select;
 use Kir\MySQL\Builder\Expr\OptionalExpression;
 use Kir\MySQL\Builder\Helpers\ConditionAddHelper;
 use Kir\MySQL\Builder\Internal\ConditionBuilder;
+use Kir\MySQL\Builder\Select;
 
 trait WhereBuilder {
 	use AbstractDB;
diff --git a/src/Databases/MySQL.php b/src/Databases/MySQL.php
@@ -10,17 +10,17 @@
 use Kir\MySQL\Database;
 use Kir\MySQL\Databases\MySQL\MySQLExceptionInterpreter;
 use Kir\MySQL\Databases\MySQL\MySQLFieldQuoter;
+use Kir\MySQL\Databases\MySQL\MySQLQuoter;
 use Kir\MySQL\Databases\MySQL\MySQLRunnableSelect;
 use Kir\MySQL\Databases\MySQL\MySQLUUIDGenerator;
-use Kir\MySQL\Databases\MySQL\MySQLQuoter;
 use Kir\MySQL\QueryLogger\QueryLoggers;
 use Kir\MySQL\Tools\AliasRegistry;
 use Kir\MySQL\Tools\VirtualTables;
 use PDO;
 use PDOException;
 use RuntimeException;
+use Stringable;
 use Throwable;
-use phpDocumentor\Reflection\Types\Scalar;
 
 /**
  */
diff --git a/src/Databases/MySQL/MySQLExceptionInterpreter.php b/src/Databases/MySQL/MySQLExceptionInterpreter.php
@@ -2,12 +2,12 @@
 namespace Kir\MySQL\Databases\MySQL;
 
 use Kir\MySQL\Exceptions\DatabaseHasGoneAwayException;
+use Kir\MySQL\Exceptions\DuplicateUniqueKeyException;
 use Kir\MySQL\Exceptions\IntegrityConstraintViolationException;
+use Kir\MySQL\Exceptions\LockWaitTimeoutExceededException;
+use Kir\MySQL\Exceptions\SqlDeadLockException;
 use Kir\MySQL\Exceptions\SqlException;
 use PDOException;
-use Kir\MySQL\Exceptions\SqlDeadLockException;
-use Kir\MySQL\Exceptions\DuplicateUniqueKeyException;
-use Kir\MySQL\Exceptions\LockWaitTimeoutExceededException;
 
 class MySQLExceptionInterpreter {
 	/**
diff --git a/src/Databases/MySQL/MySQLQuoter.php b/src/Databases/MySQL/MySQLQuoter.php
@@ -6,7 +6,6 @@
 use Kir\MySQL\Builder\DBExpr;
 use Kir\MySQL\Builder\Select;
 use PDO;
-use phpDocumentor\Reflection\Types\Scalar;
 
 class MySQLQuoter {
 	/** @var PDO */
@@ -20,7 +19,7 @@ public function __construct(PDO $pdo, DateTimeZone $timeZone) {
 	}
 
 	/**
-	 * @param null|bool|int|float|string|array<int, null|scalar>|DBExpr|Select|DateTimeInterface $value
+	 * @param null|scalar|array<int, null|scalar>|DBExpr|Select|DateTimeInterface $value
 	 * @return string
 	 */
 	public function quote($value): string {
diff --git a/src/Databases/MySQL/MySQLRunnableSelect.php b/src/Databases/MySQL/MySQLRunnableSelect.php
@@ -7,7 +7,6 @@
 use Kir\MySQL\Builder\Helpers\FieldTypeProvider;
 use Kir\MySQL\Builder\Helpers\FieldValueConverter;
 use Kir\MySQL\Builder\QueryStatement;
-use Kir\MySQL\Builder\RunnableSelect;
 use Kir\MySQL\Databases\MySQL;
 use PDO;
 use stdClass;
diff --git a/src/Databases/MySQL/MySQLSelect.php b/src/Databases/MySQL/MySQLSelect.php
@@ -6,11 +6,11 @@
 use Kir\MySQL\Builder\Statement;
 use Kir\MySQL\Builder\Traits\GroupByBuilder;
 use Kir\MySQL\Builder\Traits\HavingBuilder;
+use Kir\MySQL\Builder\Traits\JoinBuilder;
+use Kir\MySQL\Builder\Traits\LimitBuilder;
 use Kir\MySQL\Builder\Traits\OffsetBuilder;
 use Kir\MySQL\Builder\Traits\OrderByBuilder;
 use Kir\MySQL\Builder\Traits\TableBuilder;
-use Kir\MySQL\Builder\Traits\JoinBuilder;
-use Kir\MySQL\Builder\Traits\LimitBuilder;
 use Kir\MySQL\Builder\Traits\TableNameBuilder;
 use Kir\MySQL\Builder\Traits\UnionBuilder;
 use Kir\MySQL\Builder\Traits\WhereBuilder;
diff --git a/tests/Databases/MySQLTest.php b/tests/Databases/MySQLTest.php
@@ -175,6 +175,7 @@ public function testInfoLoggingFromQuery(): void {
 		}));
 		$query = 'SELECT COUNT(*) FROM test1';
 		$db->query($query)->fetchColumn(0);
+		// @phpstan-ignore-next-line
 		self::assertEquals($query, $log->queries[0]['query'] ?? null);
 	}
 
@@ -188,7 +189,9 @@ public function testErrorLoggingFromQuery(): void {
 		try {
 			$db->query($query)->fetchColumn(0);
 		} catch (PDOException $e) {}
+		// @phpstan-ignore-next-line
 		self::assertEquals($query, $log->queries[0]['query'] ?? null);
+		// @phpstan-ignore-next-line
 		self::assertStringContainsString('SQLSTATE[42S02]', ($log->queries[0]['exception'] ?? null)->getMessage());
 	}
 
@@ -200,6 +203,7 @@ public function testInfoLoggingFromExec(): void {
 		}));
 		$query = 'SET @foo = 1';
 		$db->exec($query);
+		// @phpstan-ignore-next-line
 		self::assertEquals($query, $log->queries[0]['query'] ?? null);
 	}
 
@@ -213,7 +217,9 @@ public function testErrorLoggingFromExec(): void {
 		try {
 			$db->exec($query);
 		} catch (PDOException $e) {}
+		// @phpstan-ignore-next-line
 		self::assertEquals($query, $log->queries[0]['query'] ?? null);
+		// @phpstan-ignore-next-line
 		self::assertStringContainsString('SQLSTATE[42S02]', ($log->queries[0]['exception'] ?? null)->getMessage());
 	}
 
@@ -225,6 +231,7 @@ public function testInfoLoggingFromGetTableFields(): void {
 		}));
 		$query = 'DESCRIBE test1';
 		$db->getTableFields('test1');
+		// @phpstan-ignore-next-line
 		self::assertEquals($query, $log->queries[0]['query'] ?? null);
 	}
 
@@ -238,7 +245,9 @@ public function testErrorLoggingFromGetTableFields(): void {
 		try {
 			$db->getTableFields('test1_');
 		} catch (PDOException $e) {}
+		// @phpstan-ignore-next-line
 		self::assertEquals($query, $log->queries[0]['query'] ?? null);
+		// @phpstan-ignore-next-line
 		self::assertStringContainsString('SQLSTATE[42S02]', ($log->queries[0]['exception'] ?? null)->getMessage());
 	}
 }
