Import global constants

doctrine · Feb 16, 2023 · 85ffe81 · 85ffe81
1 parent 23d8ef0
commit 85ffe81
Show file tree

Hide file tree

Showing 6 changed files with 34 additions and 57 deletions.
diff --git a/phpcs.xml.dist b/phpcs.xml.dist
@@ -118,12 +118,6 @@
         <exclude-pattern>src/Query/QueryBuilder.php</exclude-pattern>
     </rule>
 
-    <rule ref="SlevomatCodingStandard.Namespaces.ReferenceUsedNamesOnly">
-        <properties>
-            <property name="searchAnnotations" value="0"/>
-        </properties>
-    </rule>
-
     <!-- see https://github.com/doctrine/dbal/issues/3377 -->
     <rule ref="SlevomatCodingStandard.Operators.DisallowEqualOperators.DisallowedNotEqualOperator">
         <exclude-pattern>src/Schema/Comparator.php</exclude-pattern>

diff --git a/psalm.xml.dist b/psalm.xml.dist
@@ -605,12 +605,6 @@
             <errorLevel type="suppress">
                 <!-- We're testing with invalid input here. -->
                 <file name="tests/Platforms/AbstractPlatformTestCase.php"/>
-
-                <!-- See https://github.com/vimeo/psalm/issues/9320 -->
-                <file name="src/Portability/Converter.php"/>
-                <file name="src/Portability/Driver.php"/>
-                <file name="tests/Portability/ConnectionTest.php"/>
-                <file name="tests/Portability/ConverterTest.php"/>
             </errorLevel>
         </InvalidArgument>
         <InvalidDocblock>
@@ -807,10 +801,6 @@
                     and may not properly interpret the LanguageLevelTypeAware annotation from the stubs.
                 -->
                 <referencedClass name="OCILob"/>
-
-                <!-- See https://github.com/vimeo/psalm/issues/9320 -->
-                <file name="src/Portability/Converter.php"/>
-                <file name="tests/Portability/ConverterTest.php"/>
             </errorLevel>
         </UndefinedDocblockClass>
         <InvalidReturnStatement>
@@ -853,12 +843,5 @@
                 <referencedFunction name="db2_autocommit"/>
             </errorLevel>
         </InvalidScalarArgument>
-        <MismatchingDocblockParamType>
-            <errorLevel type="suppress">
-                <!-- See https://github.com/vimeo/psalm/issues/9320 -->
-                <file name="src/Portability/Converter.php"/>
-                <file name="tests/Portability/ConverterTest.php"/>
-            </errorLevel>
-        </MismatchingDocblockParamType>
     </issueHandlers>
 </psalm>
diff --git a/src/Portability/Converter.php b/src/Portability/Converter.php
@@ -10,8 +10,14 @@
 use function is_string;
 use function rtrim;
 
+use const CASE_LOWER;
+use const CASE_UPPER;
+
 final class Converter
 {
+    public const CASE_LOWER = CASE_LOWER;
+    public const CASE_UPPER = CASE_UPPER;
+
     /** @var callable */
     private $convertNumeric;
 
@@ -31,11 +37,12 @@ final class Converter
     private $convertFirstColumn;
 
     /**
-     * @param bool                         $convertEmptyStringToNull Whether each empty string should be converted
-     *                                                               to NULL
-     * @param bool                         $rightTrimString          Whether each string should right-trimmed
-     * @param \CASE_LOWER|\CASE_UPPER|null $case                     Convert the case of the column names
-     *                                                               (one of {@see CASE_LOWER} and {@see CASE_UPPER})
+     * @param bool                                   $convertEmptyStringToNull Whether each empty string should
+     *                                                                         be converted to NULL
+     * @param bool                                   $rightTrimString          Whether each string should right-trimmed
+     * @param self::CASE_LOWER|self::CASE_UPPER|null $case                     Convert the case of the column names
+     *                                                                         (one of {@see self::CASE_LOWER} and
+     *                                                                         {@see self::CASE_UPPER})
      */
     public function __construct(bool $convertEmptyStringToNull, bool $rightTrimString, ?int $case)
     {
@@ -183,8 +190,8 @@ private function createConvertValue(bool $convertEmptyStringToNull, bool $rightT
     /**
      * Creates a function that will convert each array-row retrieved from the database
      *
-     * @param callable|null                $function The function that will convert each value
-     * @param \CASE_LOWER|\CASE_UPPER|null $case     Column name case
+     * @param callable|null                          $function The function that will convert each value
+     * @param self::CASE_LOWER|self::CASE_UPPER|null $case     Column name case
      *
      * @return callable|null The resulting function or NULL if no conversion is needed
      */

diff --git a/src/Portability/Driver.php b/src/Portability/Driver.php
@@ -11,9 +11,6 @@
 
 use function method_exists;
 
-use const CASE_LOWER;
-use const CASE_UPPER;
-
 final class Driver extends AbstractDriverMiddleware
 {
     private int $mode;
@@ -59,7 +56,7 @@ public function connect(
                 $portability &= ~Connection::PORTABILITY_FIX_CASE;
                 $nativeConnection->setAttribute(PDO::ATTR_CASE, self::convertToPdoCase($this->case));
             } else {
-                $case = $this->case === ColumnCase::LOWER ? CASE_LOWER : CASE_UPPER;
+                $case = $this->case === ColumnCase::LOWER ? Converter::CASE_LOWER : Converter::CASE_UPPER;
             }
         }
 

diff --git a/tests/Portability/ConnectionTest.php b/tests/Portability/ConnectionTest.php
@@ -9,8 +9,6 @@
 use LogicException;
 use PHPUnit\Framework\TestCase;
 
-use const CASE_LOWER;
-
 class ConnectionTest extends TestCase
 {
     public function testGetServerVersion(): void
@@ -20,7 +18,7 @@ public function testGetServerVersion(): void
             ->method('getServerVersion')
             ->willReturn('1.2.3');
 
-        $connection = new Connection($driverConnection, new Converter(false, false, CASE_LOWER));
+        $connection = new Connection($driverConnection, new Converter(false, false,  Converter::CASE_LOWER));
 
         self::assertSame('1.2.3', $connection->getServerVersion());
     }
@@ -29,7 +27,7 @@ public function testGetServerVersionFailsWithLegacyConnection(): void
     {
         $connection = new Connection(
             $this->createMock(DriverConnection::class),
-            new Converter(false, false, CASE_LOWER),
+            new Converter(false, false,  Converter::CASE_LOWER),
         );
 
         $this->expectException(LogicException::class);
@@ -45,7 +43,7 @@ public function testGetNativeConnection(): void
         $driverConnection->method('getNativeConnection')
             ->willReturn($nativeConnection);
 
-        $connection = new Connection($driverConnection, new Converter(false, false, CASE_LOWER));
+        $connection = new Connection($driverConnection, new Converter(false, false,  Converter::CASE_LOWER));
 
         self::assertSame($nativeConnection, $connection->getNativeConnection());
     }
@@ -54,7 +52,7 @@ public function testGetNativeConnectionFailsWithLegacyConnection(): void
     {
         $connection = new Connection(
             $this->createMock(DriverConnection::class),
-            new Converter(false, false, CASE_LOWER),
+            new Converter(false, false,  Converter::CASE_LOWER),
         );
 
         $this->expectException(LogicException::class);

diff --git a/tests/Portability/ConverterTest.php b/tests/Portability/ConverterTest.php
@@ -5,8 +5,6 @@
 use Doctrine\DBAL\Portability\Converter;
 use PHPUnit\Framework\TestCase;
 
-use const CASE_LOWER;
-
 class ConverterTest extends TestCase
 {
     /**
@@ -61,9 +59,9 @@ public static function convertNumericProvider(): iterable
     }
 
     /**
-     * @param array<string,mixed>|false  $row
-     * @param CASE_LOWER|CASE_UPPER|null $case
-     * @param array<string,mixed>|false  $expected
+     * @param array<string,mixed>|false                        $row
+     * @param Converter::CASE_LOWER|Converter::CASE_UPPER|null $case
+     * @param array<string,mixed>|false                        $expected
      *
      * @dataProvider convertAssociativeProvider
      */
@@ -137,7 +135,7 @@ public static function convertAssociativeProvider(): iterable
             $row,
             false,
             false,
-            CASE_LOWER,
+            Converter::CASE_LOWER,
             [
                 'foo' => '',
                 'bar' => 'X ',
@@ -148,7 +146,7 @@ public static function convertAssociativeProvider(): iterable
             $row,
             false,
             true,
-            CASE_LOWER,
+            Converter::CASE_LOWER,
             [
                 'foo' => '',
                 'bar' => 'X',
@@ -159,7 +157,7 @@ public static function convertAssociativeProvider(): iterable
             $row,
             true,
             false,
-            CASE_LOWER,
+            Converter::CASE_LOWER,
             [
                 'foo' => null,
                 'bar' => 'X ',
@@ -170,7 +168,7 @@ public static function convertAssociativeProvider(): iterable
             $row,
             true,
             true,
-            CASE_LOWER,
+            Converter::CASE_LOWER,
             [
                 'foo' => null,
                 'bar' => 'X',
@@ -277,9 +275,9 @@ public static function convertAllNumericProvider(): iterable
     }
 
     /**
-     * @param list<array<string,mixed>>  $row
-     * @param CASE_LOWER|CASE_UPPER|null $case
-     * @param list<array<string,mixed>>  $expected
+     * @param list<array<string,mixed>>                        $row
+     * @param Converter::CASE_LOWER|Converter::CASE_UPPER|null $case
+     * @param list<array<string,mixed>>                        $expected
      *
      * @dataProvider convertAllAssociativeProvider
      */
@@ -383,7 +381,7 @@ public static function convertAllAssociativeProvider(): iterable
             $data,
             false,
             false,
-            CASE_LOWER,
+            Converter::CASE_LOWER,
             [
                 [
                     'foo' => 'X ',
@@ -400,7 +398,7 @@ public static function convertAllAssociativeProvider(): iterable
             $data,
             false,
             true,
-            CASE_LOWER,
+            Converter::CASE_LOWER,
             [
                 [
                     'foo' => 'X',
@@ -417,7 +415,7 @@ public static function convertAllAssociativeProvider(): iterable
             $data,
             true,
             false,
-            CASE_LOWER,
+            Converter::CASE_LOWER,
             [
                 [
                     'foo' => 'X ',
@@ -434,7 +432,7 @@ public static function convertAllAssociativeProvider(): iterable
             $data,
             true,
             true,
-            CASE_LOWER,
+            Converter::CASE_LOWER,
             [
                 [
                     'foo' => 'X',
@@ -501,7 +499,7 @@ public static function convertFirstColumnProvider(): iterable
         ];
     }
 
-    /** @param \CASE_LOWER|\CASE_UPPER|null $case */
+    /** @param Converter::CASE_LOWER|Converter::CASE_UPPER|null $case */
     private function createConverter(bool $convertEmptyStringToNull, bool $rightTrimString, ?int $case): Converter
     {
         return new Converter($convertEmptyStringToNull, $rightTrimString, $case);