Accept mixed for DatabaseName and TableName constructors

MauricioFauth · MauricioFauth · commit ca91eaeb3827 · 2021-12-23T16:25:05.000-03:00
This avoids redundant type assertions.

Signed-off-by: Maurício Meneghini Fauth &lt;mauricio@fauth.dev&gt;
diff --git a/libraries/classes/Common.php b/libraries/classes/Common.php
@@ -505,20 +505,15 @@ private static function setDatabaseAndTableFromRequest(
     ): void {
         global $db, $table, $urlParams;
 
-        $databaseFromRequest = $request->getParam('db');
-        $tableFromRequest = $request->getParam('table');
-
         try {
-            Assert::string($databaseFromRequest);
-            $db = DatabaseName::fromString($databaseFromRequest)->getName();
+            $db = DatabaseName::fromValue($request->getParam('db'))->getName();
         } catch (InvalidArgumentException $exception) {
             $db = '';
         }
 
         try {
             Assert::stringNotEmpty($db);
-            Assert::string($tableFromRequest);
-            $table = TableName::fromString($tableFromRequest)->getName();
+            $table = TableName::fromValue($request->getParam('table'))->getName();
         } catch (InvalidArgumentException $exception) {
             $table = '';
         }
diff --git a/libraries/classes/ConfigStorage/RelationParameters.php b/libraries/classes/ConfigStorage/RelationParameters.php
@@ -209,8 +209,7 @@ public static function fromArray(array $params): self
 
         try {
             Assert::keyExists($params, 'db');
-            Assert::string($params['db']);
-            $db = DatabaseName::fromString($params['db']);
+            $db = DatabaseName::fromValue($params['db']);
         } catch (InvalidArgumentException $exception) {
             $db = null;
         }
diff --git a/libraries/classes/Controllers/Table/Maintenance/AnalyzeController.php b/libraries/classes/Controllers/Table/Maintenance/AnalyzeController.php
@@ -43,7 +43,6 @@ public function __construct(
 
     public function __invoke(ServerRequest $request): void
     {
-        $dbParam = $request->getParam('db');
         $selectedTablesParam = $request->getParsedBodyParam('selected_tbl');
 
         try {
@@ -58,11 +57,10 @@ public function __invoke(ServerRequest $request): void
         }
 
         try {
-            Assert::string($dbParam);
-            $database = DatabaseName::fromString($dbParam);
+            $database = DatabaseName::fromValue($request->getParam('db'));
             $selectedTables = [];
             foreach ($selectedTablesParam as $table) {
-                $selectedTables[] = TableName::fromString($table);
+                $selectedTables[] = TableName::fromValue($table);
             }
         } catch (InvalidArgumentException $exception) {
             $message = Message::error($exception->getMessage());
diff --git a/libraries/classes/Controllers/Table/Maintenance/CheckController.php b/libraries/classes/Controllers/Table/Maintenance/CheckController.php
@@ -43,7 +43,6 @@ public function __construct(
 
     public function __invoke(ServerRequest $request): void
     {
-        $dbParam = $request->getParam('db');
         $selectedTablesParam = $request->getParsedBodyParam('selected_tbl');
 
         try {
@@ -58,11 +57,10 @@ public function __invoke(ServerRequest $request): void
         }
 
         try {
-            Assert::string($dbParam);
-            $database = DatabaseName::fromString($dbParam);
+            $database = DatabaseName::fromValue($request->getParam('db'));
             $selectedTables = [];
             foreach ($selectedTablesParam as $table) {
-                $selectedTables[] = TableName::fromString($table);
+                $selectedTables[] = TableName::fromValue($table);
             }
         } catch (InvalidArgumentException $exception) {
             $message = Message::error($exception->getMessage());
diff --git a/libraries/classes/Controllers/Table/Maintenance/ChecksumController.php b/libraries/classes/Controllers/Table/Maintenance/ChecksumController.php
@@ -43,7 +43,6 @@ public function __construct(
 
     public function __invoke(ServerRequest $request): void
     {
-        $dbParam = $request->getParam('db');
         $selectedTablesParam = $request->getParsedBodyParam('selected_tbl');
 
         try {
@@ -58,11 +57,10 @@ public function __invoke(ServerRequest $request): void
         }
 
         try {
-            Assert::string($dbParam);
-            $database = DatabaseName::fromString($dbParam);
+            $database = DatabaseName::fromValue($request->getParam('db'));
             $selectedTables = [];
             foreach ($selectedTablesParam as $table) {
-                $selectedTables[] = TableName::fromString($table);
+                $selectedTables[] = TableName::fromValue($table);
             }
         } catch (InvalidArgumentException $exception) {
             $message = Message::error($exception->getMessage());
diff --git a/libraries/classes/Controllers/Table/Maintenance/OptimizeController.php b/libraries/classes/Controllers/Table/Maintenance/OptimizeController.php
@@ -43,7 +43,6 @@ public function __construct(
 
     public function __invoke(ServerRequest $request): void
     {
-        $dbParam = $request->getParam('db');
         $selectedTablesParam = $request->getParsedBodyParam('selected_tbl');
 
         try {
@@ -58,11 +57,10 @@ public function __invoke(ServerRequest $request): void
         }
 
         try {
-            Assert::string($dbParam);
-            $database = DatabaseName::fromString($dbParam);
+            $database = DatabaseName::fromValue($request->getParam('db'));
             $selectedTables = [];
             foreach ($selectedTablesParam as $table) {
-                $selectedTables[] = TableName::fromString($table);
+                $selectedTables[] = TableName::fromValue($table);
             }
         } catch (InvalidArgumentException $exception) {
             $message = Message::error($exception->getMessage());
diff --git a/libraries/classes/Controllers/Table/Maintenance/RepairController.php b/libraries/classes/Controllers/Table/Maintenance/RepairController.php
@@ -43,7 +43,6 @@ public function __construct(
 
     public function __invoke(ServerRequest $request): void
     {
-        $dbParam = $request->getParam('db');
         $selectedTablesParam = $request->getParsedBodyParam('selected_tbl');
 
         try {
@@ -58,11 +57,10 @@ public function __invoke(ServerRequest $request): void
         }
 
         try {
-            Assert::string($dbParam);
-            $database = DatabaseName::fromString($dbParam);
+            $database = DatabaseName::fromValue($request->getParam('db'));
             $selectedTables = [];
             foreach ($selectedTablesParam as $table) {
-                $selectedTables[] = TableName::fromString($table);
+                $selectedTables[] = TableName::fromValue($table);
             }
         } catch (InvalidArgumentException $exception) {
             $message = Message::error($exception->getMessage());
diff --git a/libraries/classes/Controllers/Table/Partition/AnalyzeController.php b/libraries/classes/Controllers/Table/Partition/AnalyzeController.php
@@ -36,16 +36,12 @@ public function __construct(
 
     public function __invoke(ServerRequest $request): void
     {
-        $dbParam = $request->getParam('db');
-        $tableParam = $request->getParam('table');
         $partitionName = $request->getParsedBodyParam('partition_name');
 
         try {
-            Assert::string($dbParam);
-            Assert::string($tableParam);
             Assert::stringNotEmpty($partitionName);
-            $database = DatabaseName::fromString($dbParam);
-            $table = TableName::fromString($tableParam);
+            $database = DatabaseName::fromValue($request->getParam('db'));
+            $table = TableName::fromValue($request->getParam('table'));
         } catch (InvalidArgumentException $exception) {
             $message = Message::error($exception->getMessage());
             $this->response->addHTML($message->getDisplay());
diff --git a/libraries/classes/Controllers/Table/Partition/CheckController.php b/libraries/classes/Controllers/Table/Partition/CheckController.php
@@ -36,16 +36,12 @@ public function __construct(
 
     public function __invoke(ServerRequest $request): void
     {
-        $dbParam = $request->getParam('db');
-        $tableParam = $request->getParam('table');
         $partitionName = $request->getParsedBodyParam('partition_name');
 
         try {
-            Assert::string($dbParam);
-            Assert::string($tableParam);
             Assert::stringNotEmpty($partitionName);
-            $database = DatabaseName::fromString($dbParam);
-            $table = TableName::fromString($tableParam);
+            $database = DatabaseName::fromValue($request->getParam('db'));
+            $table = TableName::fromValue($request->getParam('table'));
         } catch (InvalidArgumentException $exception) {
             $message = Message::error($exception->getMessage());
             $this->response->addHTML($message->getDisplay());
diff --git a/libraries/classes/Controllers/Table/Partition/DropController.php b/libraries/classes/Controllers/Table/Partition/DropController.php
@@ -36,16 +36,12 @@ public function __construct(
 
     public function __invoke(ServerRequest $request): void
     {
-        $dbParam = $request->getParam('db');
-        $tableParam = $request->getParam('table');
         $partitionName = $request->getParsedBodyParam('partition_name');
 
         try {
-            Assert::string($dbParam);
-            Assert::string($tableParam);
             Assert::stringNotEmpty($partitionName);
-            $database = DatabaseName::fromString($dbParam);
-            $table = TableName::fromString($tableParam);
+            $database = DatabaseName::fromValue($request->getParam('db'));
+            $table = TableName::fromValue($request->getParam('table'));
         } catch (InvalidArgumentException $exception) {
             $message = Message::error($exception->getMessage());
             $this->response->addHTML($message->getDisplay());
diff --git a/libraries/classes/Controllers/Table/Partition/OptimizeController.php b/libraries/classes/Controllers/Table/Partition/OptimizeController.php
@@ -36,16 +36,12 @@ public function __construct(
 
     public function __invoke(ServerRequest $request): void
     {
-        $dbParam = $request->getParam('db');
-        $tableParam = $request->getParam('table');
         $partitionName = $request->getParsedBodyParam('partition_name');
 
         try {
-            Assert::string($dbParam);
-            Assert::string($tableParam);
             Assert::stringNotEmpty($partitionName);
-            $database = DatabaseName::fromString($dbParam);
-            $table = TableName::fromString($tableParam);
+            $database = DatabaseName::fromValue($request->getParam('db'));
+            $table = TableName::fromValue($request->getParam('table'));
         } catch (InvalidArgumentException $exception) {
             $message = Message::error($exception->getMessage());
             $this->response->addHTML($message->getDisplay());
diff --git a/libraries/classes/Controllers/Table/Partition/RebuildController.php b/libraries/classes/Controllers/Table/Partition/RebuildController.php
@@ -36,16 +36,12 @@ public function __construct(
 
     public function __invoke(ServerRequest $request): void
     {
-        $dbParam = $request->getParam('db');
-        $tableParam = $request->getParam('table');
         $partitionName = $request->getParsedBodyParam('partition_name');
 
         try {
-            Assert::string($dbParam);
-            Assert::string($tableParam);
             Assert::stringNotEmpty($partitionName);
-            $database = DatabaseName::fromString($dbParam);
-            $table = TableName::fromString($tableParam);
+            $database = DatabaseName::fromValue($request->getParam('db'));
+            $table = TableName::fromValue($request->getParam('table'));
         } catch (InvalidArgumentException $exception) {
             $message = Message::error($exception->getMessage());
             $this->response->addHTML($message->getDisplay());
diff --git a/libraries/classes/Controllers/Table/Partition/RepairController.php b/libraries/classes/Controllers/Table/Partition/RepairController.php
@@ -36,16 +36,12 @@ public function __construct(
 
     public function __invoke(ServerRequest $request): void
     {
-        $dbParam = $request->getParam('db');
-        $tableParam = $request->getParam('table');
         $partitionName = $request->getParsedBodyParam('partition_name');
 
         try {
-            Assert::string($dbParam);
-            Assert::string($tableParam);
             Assert::stringNotEmpty($partitionName);
-            $database = DatabaseName::fromString($dbParam);
-            $table = TableName::fromString($tableParam);
+            $database = DatabaseName::fromValue($request->getParam('db'));
+            $table = TableName::fromValue($request->getParam('table'));
         } catch (InvalidArgumentException $exception) {
             $message = Message::error($exception->getMessage());
             $this->response->addHTML($message->getDisplay());
diff --git a/libraries/classes/Controllers/Table/Partition/TruncateController.php b/libraries/classes/Controllers/Table/Partition/TruncateController.php
@@ -36,16 +36,12 @@ public function __construct(
 
     public function __invoke(ServerRequest $request): void
     {
-        $dbParam = $request->getParam('db');
-        $tableParam = $request->getParam('table');
         $partitionName = $request->getParsedBodyParam('partition_name');
 
         try {
-            Assert::string($dbParam);
-            Assert::string($tableParam);
             Assert::stringNotEmpty($partitionName);
-            $database = DatabaseName::fromString($dbParam);
-            $table = TableName::fromString($tableParam);
+            $database = DatabaseName::fromValue($request->getParam('db'));
+            $table = TableName::fromValue($request->getParam('table'));
         } catch (InvalidArgumentException $exception) {
             $message = Message::error($exception->getMessage());
             $this->response->addHTML($message->getDisplay());
diff --git a/libraries/classes/Dbal/DatabaseName.php b/libraries/classes/Dbal/DatabaseName.php
@@ -26,9 +26,11 @@ final class DatabaseName implements Stringable
     private $name;
 
     /**
+     * @param mixed $name
+     *
      * @throws InvalidArgumentException
      */
-    private function __construct(string $name)
+    private function __construct($name)
     {
         Assert::stringNotEmpty($name);
         Assert::maxLength($name, self::MAX_LENGTH);
@@ -37,9 +39,11 @@ private function __construct(string $name)
     }
 
     /**
+     * @param mixed $name
+     *
      * @throws InvalidArgumentException
      */
-    public static function fromString(string $name): self
+    public static function fromValue($name): self
     {
         return new self($name);
     }
diff --git a/libraries/classes/Dbal/TableName.php b/libraries/classes/Dbal/TableName.php
@@ -26,9 +26,11 @@ final class TableName implements Stringable
     private $name;
 
     /**
+     * @param mixed $name
+     *
      * @throws InvalidArgumentException
      */
-    private function __construct(string $name)
+    private function __construct($name)
     {
         Assert::stringNotEmpty($name);
         Assert::maxLength($name, self::MAX_LENGTH);
@@ -37,9 +39,11 @@ private function __construct(string $name)
     }
 
     /**
+     * @param mixed $name
+     *
      * @throws InvalidArgumentException
      */
-    public static function fromString(string $name): self
+    public static function fromValue($name): self
     {
         return new self($name);
     }
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -7700,14 +7700,10 @@
       <code>$tmp</code>
       <code>$value</code>
     </MixedArgument>
-    <MixedArgumentTypeCoercion occurrences="7">
+    <MixedArgumentTypeCoercion occurrences="3">
       <code>$classes</code>
       <code>$key</code>
       <code>$urlParams</code>
-      <code>$urlParams</code>
-      <code>$urlParams</code>
-      <code>$urlParams</code>
-      <code>$urlParams</code>
     </MixedArgumentTypeCoercion>
     <MixedArrayAccess occurrences="3">
       <code>$cfg['DefaultFunctions']['FUNC_' . $currentClass]</code>
diff --git a/test/classes/Dbal/DatabaseNameTest.php b/test/classes/Dbal/DatabaseNameTest.php
diff --git a/test/classes/Dbal/TableNameTest.php b/test/classes/Dbal/TableNameTest.php

Original file line number	Diff line number	Diff line change
`@@ -209,8 +209,7 @@ public static function fromArray(array $params): self`
`209`	`209`
`210`	`210`	`try {`
`211`	`211`	`Assert::keyExists($params, 'db');`
`212`		`- Assert::string($params['db']);`
`213`		`- $db = DatabaseName::fromString($params['db']);`
	`212`	`+ $db = DatabaseName::fromValue($params['db']);`
`214`	`213`	`} catch (InvalidArgumentException $exception) {`
`215`	`214`	`$db = null;`
`216`	`215`	`}`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,6 @@ public function __construct(`
`43`	`43`
`44`	`44`	`public function __invoke(ServerRequest $request): void`
`45`	`45`	`{`
`46`		`- $dbParam = $request->getParam('db');`
`47`	`46`	`$selectedTablesParam = $request->getParsedBodyParam('selected_tbl');`
`48`	`47`
`49`	`48`	`try {`
`@@ -58,11 +57,10 @@ public function __invoke(ServerRequest $request): void`
`58`	`57`	`}`
`59`	`58`
`60`	`59`	`try {`
`61`		`- Assert::string($dbParam);`
`62`		`- $database = DatabaseName::fromString($dbParam);`
	`60`	`+ $database = DatabaseName::fromValue($request->getParam('db'));`
`63`	`61`	`$selectedTables = [];`
`64`	`62`	`foreach ($selectedTablesParam as $table) {`
`65`		`- $selectedTables[] = TableName::fromString($table);`
	`63`	`+ $selectedTables[] = TableName::fromValue($table);`
`66`	`64`	`}`
`67`	`65`	`} catch (InvalidArgumentException $exception) {`
`68`	`66`	`$message = Message::error($exception->getMessage());`