Type-safety cleanup of src/Sql (mago analyze) with phpcs/phpstan compliance

mago.toml

@@ -0,0 +1,126 @@
+php-version = "8.2"
+
+[source]
+paths = ["src", "test"]
+includes = ["vendor"]
+
+[source.glob]
+literal-separator = false
+
+[formatter]
+preset = "default"
+preserve-breaking-member-access-chain = true
+preserve-breaking-member-access-chain-first-method-on-same-line = true
+preserve-breaking-argument-list = true
+preserve-breaking-array-like = true
+preserve-breaking-parameter-list = true
+preserve-breaking-attribute-list = true
+preserve-breaking-conditional-expression = true
+preserve-breaking-condition-expression = true
+preserve-redundant-logical-binary-expression-parentheses = true
+preserve-breaking-binary-expression = true
+space-after-logical-not-unary-prefix-operator = true
+always-break-named-arguments-list = true
+align-assignment-like = true
+sort-class-methods = true
+
+[linter]
+minimum-fail-level = "Help"
+integrations = ["laminas", "phpunit"]
+
+[linter.rules]
+literal-named-argument = { enabled = true }
+halstead = { effort-threshold = 7000 }
+valid-docblock = { enabled = true }
+no-negated-ternary = { enabled = true }
+no-short-bool-cast = { enabled = true }
+no-inline = { enabled = true }
+no-array-accumulation-in-loop = { enabled = true }
+no-literal-namespace-string = { enabled = true }
+no-parameter-shadowing = { enabled = true }
+no-side-effects-with-declarations = { enabled = true }
+prefer-array-spread = { enabled = true }
+prefer-explode-over-preg-split = { enabled = true }
+prefer-first-class-callable = { check-functions = true }
+prefer-test-attribute = { enabled = true }
+require-namespace = { enabled = true }
+prefer-pre-increment = { enabled = true }
+prefer-self-return-type = { enabled = true }
+sorted-integer-keys = { enabled = true }
+yoda-conditions = { enabled = true }
+file-name = { enabled = true }
+array-style = { level = "Help" }
+block-statement = { level = "Help" }
+braced-string-interpolation = { enabled = true, level = "Help" }
+no-alias-function = { level = "Help" }
+no-php-tag-terminator = { level = "Help" }
+no-trailing-space = { level = "Help" }
+string-style = { enabled = true, level = "Help" }
+ambiguous-constant-access = { enabled = true }
+ambiguous-function-call = { enabled = true }
+class-name = { psr = true }
+function-name = { camel = true, exclude = ["src/functions/*"] }
+interface-name = { psr = true }
+method-name = { enabled = true, camel = true }
+no-fully-qualified-global-class-like = { enabled = true }
+no-fully-qualified-global-constant = { enabled = true }
+no-fully-qualified-global-function = { enabled = true }
+property-name = { enabled = true }
+trait-name = { psr = true }
+variable-name = { enabled = true, camel = true, either = false }
+too-many-methods = { exclude = ["test/"] }
+no-iterator-to-array-in-foreach = { enabled = true }
+no-duplicate-match-arm = { level = "Help" }
+no-empty-comment = { level = "Help" }
+no-empty-loop = { level = "Help" }
+no-is-null = { enabled = true, level = "Help" }
+no-null-property-init = { enabled = true }
+no-redundant-else = { enabled = true }
+disallowed-type-instantiation = { enabled = true }
+no-debug-symbols = { level = "Help" }
+no-assign-in-argument = { enabled = true }
+no-dead-store = { enabled = true }
+no-redundant-variable = { enabled = true }
+no-unused-closure-capture = { enabled = true }
+no-unused-global = { enabled = true }
+no-unused-static = { enabled = true }
+switch-continue-to-break = { enabled = true }
+invalid-open-tag = { level = "Help" }
+
+[analyzer]
+plugins = ["psl", "psr-container"]
+find-unused-definitions = true
+find-unused-expressions = true
+find-overly-wide-return-types = true
+analyze-dead-code = true
+memoize-properties = true
+check-throws = true
+unchecked-exceptions = [
+    'Error',
+    'LogicException',
+    'PHPUnit\Framework\Exception',
+    'PHPUnit\Framework\MockObject\Exception',
+    'PHPUnit\Event\NoPreviousThrowableException',
+]
+unchecked-exception-classes = []
+check-missing-override = true
+find-unused-parameters = true
+strict-list-index-checks = true
+strict-array-index-existence = true
+allow-array-truthy-operand = false
+no-boolean-literal-comparison = true
+check-missing-type-hints = true
+check-arrow-function-missing-type-hints = true
+register-super-globals = false
+check-property-initialization = true
+class-initializers = [
+    'PHPUnit\Framework\TestCase::setUp',
+    'PHPUnit\Framework\TestCase::setUpBeforeClass',
+]
+check-use-statements = true
+check-name-casing = true
+enforce-class-finality = false
+require-api-or-internal = false
+ignore = [
+    { code = "invalid-enum-case-value", in = "src/Sql/" },
+]

phpstan-baseline.neon

@@ -1,10 +1,22 @@
 parameters:
 	ignoreErrors:
 		-
-			message: '#^Variable \$paramSpecs might not be defined\.$#'
-			identifier: variable.undefined
+			message: '#^Offset 0 on array\{list\<string\>\} on left side of \?\? always exists and is not nullable\.$#'
+			identifier: nullCoalesce.offset
 			count: 1
-			path: src/Sql/AbstractSql.php
+			path: src/Sql/Expression.php
+
+		-
+			message: '#^Argument of an invalid type PhpDb\\Sql\\Platform\\PlatformDecoratorInterface supplied for foreach, only iterables are supported\.$#'
+			identifier: foreach.nonIterable
+			count: 1
+			path: src/Sql/Platform/Platform.php
+
+		-
+			message: '#^Method PhpDb\\Sql\\Platform\\Platform\:\:getDecorators\(\) should return array\<string, PhpDb\\Sql\\Platform\\PlatformDecoratorInterface\> but returns PhpDb\\Sql\\Platform\\PlatformDecoratorInterface\.$#'
+			identifier: return.type
+			count: 1
+			path: src/Sql/Platform/Platform.php
 
 		-
 			message: '#^Parameter \#1 \$attribute \(string\) of method PhpDbTest\\Adapter\\Driver\\TestAsset\\PdoMock\:\:getAttribute\(\) should be compatible with parameter \$attribute \(int\) of method PDO\:\:getAttribute\(\)$#'
@@ -78,6 +90,12 @@ parameters:
 			count: 3
 			path: test/unit/Sql/AbstractSqlFunctionalTestCase.php
 
+		-
+			message: '#^Call to new PhpDb\\Sql\\Argument\\Select\(\) on a separate line has no effect\.$#'
+			identifier: new.resultUnused
+			count: 1
+			path: test/unit/Sql/ArgumentTest.php
+
 		-
 			message: '#^PHPDoc tag @var with type PhpDb\\Sql\\Ddl\\Column\\ColumnInterface is not subtype of native type PHPUnit\\Framework\\MockObject\\MockObject\.$#'
 			identifier: varTag.nativeType
@@ -91,22 +109,22 @@ parameters:
 			path: test/unit/Sql/Ddl/AlterTableTest.php
 
 		-
-			message: '#^Call to an undefined method PHPUnit\\Framework\\MockObject\\MockObject\:\:addColumn\(\)\.$#'
-			identifier: method.notFound
+			message: '#^Access to an undefined property PhpDb\\Sql\\Delete\:\:\$unknown\.$#'
+			identifier: property.notFound
 			count: 1
-			path: test/unit/Sql/Ddl/Constraint/AbstractConstraintTest.php
+			path: test/unit/Sql/DeleteTest.php
 
 		-
-			message: '#^Call to an undefined method PHPUnit\\Framework\\MockObject\\MockObject\:\:getColumns\(\)\.$#'
-			identifier: method.notFound
-			count: 3
-			path: test/unit/Sql/Ddl/Constraint/AbstractConstraintTest.php
+			message: '#^Access to protected property PhpDb\\Sql\\Delete\:\:\$table\.$#'
+			identifier: property.protected
+			count: 1
+			path: test/unit/Sql/DeleteTest.php
 
 		-
-			message: '#^Call to an undefined method PHPUnit\\Framework\\MockObject\\MockObject\:\:setColumns\(\)\.$#'
-			identifier: method.notFound
-			count: 2
-			path: test/unit/Sql/Ddl/Constraint/AbstractConstraintTest.php
+			message: '#^Call to static method PHPUnit\\Framework\\Assert\:\:assertNull\(\) with array\|PhpDb\\Sql\\TableIdentifier\|string will always evaluate to false\.$#'
+			identifier: staticMethod.impossibleType
+			count: 1
+			path: test/unit/Sql/DeleteTest.php
 
 		-
 			message: '#^Access to an undefined property PhpDb\\Sql\\InsertIgnore\:\:\$foo\.$#'
@@ -125,3 +143,9 @@ parameters:
 			identifier: property.notFound
 			count: 1
 			path: test/unit/Sql/InsertTest.php
+
+		-
+			message: '#^Access to an undefined property PhpDb\\Sql\\Select\:\:\$invalidProperty\.$#'
+			identifier: property.notFound
+			count: 1
+			path: test/unit/Sql/SelectTest.php