🐛 Fix and reorganize tests

VincentLanglet · VincentLanglet · commit 0e28ec0eea74 · 2019-12-29T03:34:14.000+01:00
diff --git a/SymfonyCustom/Sniffs/NamingConventions/ValidTypeHintSniff.php b/SymfonyCustom/Sniffs/NamingConventions/ValidTypeHintSniff.php
@@ -161,6 +161,8 @@ private function getValidTypes(string $content): string
                 $validType = $this->getValidGenericType($matches['genericName'], $matches['genericContent']);
             } elseif (isset($matches['object']) && '' !== $matches['object']) {
                 $validType = $this->getValidObjectType($matches['objectContent']);
+            } elseif (isset($matches['array']) && '' !== $matches['array']) {
+                $validType = $this->getValidTypes(substr($matches['array'], 0, -2)).'[]';
             } else {
                 $validType = $this->getValidType($matches['type']);
             }
@@ -215,6 +217,8 @@ private function orderTypes(array $types): array
      * @param string $genericContent
      *
      * @return string
+     *
+     * @throws DeepExitException
      */
     private function getValidGenericType(string $genericName, string $genericContent): string
     {
@@ -234,6 +238,8 @@ private function getValidGenericType(string $genericName, string $genericContent
      * @param string $objectContent
      *
      * @return string
+     *
+     * @throws DeepExitException
      */
     private function getValidObjectType(string $objectContent): string
     {
@@ -263,10 +269,6 @@ private function getValidObjectType(string $objectContent): string
      */
     private function getValidType(string $typeName): string
     {
-        if ('[]' === substr($typeName, -2)) {
-            return $this->getValidType(substr($typeName, 0, -2)).'[]';
-        }
-
         $lowerType = strtolower($typeName);
         switch ($lowerType) {
             case 'bool':
diff --git a/SymfonyCustom/Tests/NamingConventions/ValidTypeHintUnitTest.inc b/SymfonyCustom/Tests/NamingConventions/ValidTypeHintUnitTest.inc
@@ -2,51 +2,72 @@
 
 // Only PHPDoc comments are checked
 /* @var boolean $a */
+/** @var boolean $a */
 
 /**
+ * Check simple type
+ *
  * @param boolean $a
- * @param Boolean $a
  * @param integer $b
- * @param double  $c
- * @param real    $c
- *
- * @return boolean
- * @return Boolean
- * @return integer
- * @return double
- * @return real
+ * @param double $c
+ * @param real $c
  */
 
-/** @var boolean $a */
-/** @var Boolean $a */
-/** @var integer $b */
-/** @var double $c */
-/** @var real $c */
-
-/** @method integer|string  */
-/** @method array<integer,boolean>|integer[]|array<integer> truc */
-/** @method array<integer, boolean|null>|integer[]|array<array<integer>> truc */
+/**
+ * Don't care about case
+ *
+ * @return BoOlEAn $a
+ * @return boolean $a
+ */
 
 /**
- * @return null|int
- * @return string[]|null|int[]
- * @return Foo<integer|null|string, boolean|null|string>|null|int[]
+ * Works with different tags
+ *
+ * @method integer someFunction()
+ * @property integer $integer
+ * @property-read integer $integer
+ * @property-write integer $integer
+ * @throws integer
  */
 
-/** @method array < integer , null | boolean > | integer [ ] | array < array < integer > > truc */
-/** @method Generator<integer, string, string, boolean> truc */
-/** @method Generator<array<integer>, array<integer>, array<integer>, array<integer>> truc */
-/** @method array { integer: integer, boolean?: boolean } truc */
-/** @param class-string|class-string<Client>|integer truc */
+/**
+ * Union et intersection types
+ *
+ * @param integer|(string|boolean)
+ * @param integer&string|boolean This syntax is not valid
+ * @param (integer&string)|boolean
+ * @param (integer|((string|boolean)))
+ */
 
 /**
+ * Array, generic and object types
+ *
+ * @param array<integer,boolean>|integer[]|array<integer> foo
+ * @param Generator<integer, string, string, boolean> bar
+ * @param Generator<array<integer>, array<integer>, array<integer>, array<integer>> baz
+ * @param array<integer[][][]>[]|boolean
  * @param array{0: integer, 1?: integer}
  * @param array{integer, integer}
  * @param array{foo: integer, bar: string}
  */
 
 /**
- * @param (integer|string)|bool
- * @param (integer&string)|bool
- * @param integer&string|bool
+ * Class-string
+ *
+ * @param class-string|class-string<Client>|integer
+ */
+
+/**
+ * Handle space (Last one is a comment, correctly not replaced)
+ *
+ * @param array < integer , integer | boolean > | integer [ ] | array < array < integer > > integer
+ * @param array { integer: integer, boolean?: boolean } integer
+ */
+
+/**
+ * null type should be the last one
+ *
+ * @param null|int
+ * @param string[]|null|int[]
+ * @param Foo<integer|null|string, boolean|null|string>|null|int[]
  */
diff --git a/SymfonyCustom/Tests/NamingConventions/ValidTypeHintUnitTest.inc.fixed b/SymfonyCustom/Tests/NamingConventions/ValidTypeHintUnitTest.inc.fixed
@@ -2,51 +2,72 @@
 
 // Only PHPDoc comments are checked
 /* @var boolean $a */
+/** @var bool $a */
 
 /**
- * @param bool $a
+ * Check simple type
+ *
  * @param bool $a
  * @param int $b
- * @param float  $c
- * @param float    $c
- *
- * @return bool
- * @return bool
- * @return int
- * @return float
- * @return float
+ * @param float $c
+ * @param float $c
  */
 
-/** @var bool $a */
-/** @var bool $a */
-/** @var int $b */
-/** @var float $c */
-/** @var float $c */
-
-/** @method int|string  */
-/** @method array<int, bool>|int[]|array<int> truc */
-/** @method array<int, bool|null>|int[]|array<array<int>> truc */
+/**
+ * Don't care about case
+ *
+ * @return bool $a
+ * @return bool $a
+ */
 
 /**
- * @return int|null
- * @return string[]|int[]|null
- * @return Foo<int|string|null, bool|string|null>|int[]|null
+ * Works with different tags
+ *
+ * @method int someFunction()
+ * @property int $integer
+ * @property-read int $integer
+ * @property-write int $integer
+ * @throws int
  */
 
-/** @method array<int, bool|null>|int[]|array<array<int>> truc */
-/** @method Generator<int, string, string, bool> truc */
-/** @method Generator<array<int>, array<int>, array<int>, array<int>> truc */
-/** @method array{integer: int, boolean?: bool} truc */
-/** @param class-string|class-string<Client>|int truc */
+/**
+ * Union et intersection types
+ *
+ * @param int|(string|bool)
+ * @param integer&string|boolean This syntax is not valid
+ * @param (int&string)|bool
+ * @param (int|((string|bool)))
+ */
 
 /**
+ * Array, generic and object types
+ *
+ * @param array<int, bool>|int[]|array<int> foo
+ * @param Generator<int, string, string, bool> bar
+ * @param Generator<array<int>, array<int>, array<int>, array<int>> baz
+ * @param array<int[][][]>[]|bool
  * @param array{0: int, 1?: int}
  * @param array{int, int}
  * @param array{foo: int, bar: string}
  */
 
 /**
- * @param (int|string)|bool
- * @param (int&string)|bool
- * @param integer&string|bool
+ * Class-string
+ *
+ * @param class-string|class-string<Client>|int
+ */
+
+/**
+ * Handle space (Last one is a comment, correctly not replaced)
+ *
+ * @param array<int, int|bool>|int[]|array<array<int>> integer
+ * @param array{integer: int, boolean?: bool} integer
+ */
+
+/**
+ * null type should be the last one
+ *
+ * @param int|null
+ * @param string[]|int[]|null
+ * @param Foo<int|string|null, bool|string|null>|int[]|null
  */
diff --git a/SymfonyCustom/Tests/NamingConventions/ValidTypeHintUnitTest.php b/SymfonyCustom/Tests/NamingConventions/ValidTypeHintUnitTest.php
@@ -19,38 +19,35 @@ class ValidTypeHintUnitTest extends AbstractSniffUnitTest
     protected function getErrorList(): array
     {
         return [
-            7  => 1,
-            8  => 1,
-            9  => 1,
+            5  => 1,
             10 => 1,
             11 => 1,
+            12 => 1,
             13 => 1,
-            14 => 1,
-            15 => 1,
-            16 => 1,
-            17 => 1,
+            19 => 1,
             20 => 1,
-            21 => 1,
-            22 => 1,
-            23 => 1,
-            24 => 1,
             26 => 1,
             27 => 1,
             28 => 1,
-            31 => 1,
-            32 => 1,
-            33 => 1,
+            29 => 1,
+            30 => 1,
             36 => 1,
             37 => 1,
             38 => 1,
             39 => 1,
-            40 => 1,
-            43 => 1,
-            44 => 1,
             45 => 1,
+            46 => 1,
+            47 => 1,
+            48 => 1,
             49 => 1,
             50 => 1,
             51 => 1,
+            57 => 1,
+            63 => 1,
+            64 => 1,
+            70 => 1,
+            71 => 1,
+            72 => 1,
         ];
     }
 
