[Config] Add conditional types to conditional builders

wouterj · wouterj · commit ce1087e59fe6 · 2022-07-30T15:17:10.000+02:00
diff --git a/src/Symfony/Component/Config/Builder/ConfigBuilderGenerator.php b/src/Symfony/Component/Config/Builder/ConfigBuilderGenerator.php
@@ -138,7 +138,9 @@ private function handleArrayNode(ArrayNode $node, ClassBuilder $class, string $n
         $hasNormalizationClosures = $this->hasNormalizationClosures($node);
         $comment = $this->getComment($node);
         if ($hasNormalizationClosures) {
-            $comment .= sprintf(' * @return %s|$this'."\n ", $childClass->getFqcn());
+            $comment = sprintf(" * @template TValue\n * @param TValue \$value\n%s", $comment);
+            $comment .= sprintf(' * @return %s|$this'."\n", $childClass->getFqcn());
+            $comment .= sprintf(' * @psalm-return (TValue is array ? %s : static)'."\n ", $childClass->getFqcn());
         }
         if ('' !== $comment) {
             $comment = "/**\n$comment*/\n";
@@ -279,7 +281,9 @@ public function NAME(string $VAR, TYPE $VALUE): static
 
         $comment = $this->getComment($node);
         if ($hasNormalizationClosures) {
-            $comment .= sprintf(' * @return %s|$this'."\n ", $childClass->getFqcn());
+            $comment = sprintf(" * @template TValue\n * @param TValue \$value\n%s", $comment);
+            $comment .= sprintf(' * @return %s|$this'."\n", $childClass->getFqcn());
+            $comment .= sprintf(' * @psalm-return (TValue is array ? %s : static)'."\n ", $childClass->getFqcn());
         }
         if ('' !== $comment) {
             $comment = "/**\n$comment*/\n";
@@ -337,7 +341,7 @@ public function NAME(string $VAR, TYPE $VALUE): static
     return $this->PROPERTY[$VAR];
 }';
             $class->addUse(InvalidConfigurationException::class);
-            $class->addMethod($methodName, $body, [
+            $class->addMethod($methodName, str_replace('$value', '$VAR', $body), [
                 'COMMENT' => $comment, 'PROPERTY' => $property->getName(),
                 'CLASS' => $childClass->getFqcn(),
                 'VAR' => '' === $key ? 'key' : $key,
diff --git a/src/Symfony/Component/Config/Tests/Builder/Fixtures/ScalarNormalizedTypes/Symfony/Config/ScalarNormalizedTypes/NestedConfig.php b/src/Symfony/Component/Config/Tests/Builder/Fixtures/ScalarNormalizedTypes/Symfony/Config/ScalarNormalizedTypes/NestedConfig.php
@@ -17,8 +17,11 @@ class NestedConfig
     private $_usedProperties = [];
 
     /**
+     * @template TValue
+     * @param TValue $value
      * @default {"enabled":null}
      * @return \Symfony\Config\ScalarNormalizedTypes\Nested\NestedObjectConfig|$this
+     * @psalm-return (TValue is array ? \Symfony\Config\ScalarNormalizedTypes\Nested\NestedObjectConfig : static)
      */
     public function nestedObject(mixed $value = []): \Symfony\Config\ScalarNormalizedTypes\Nested\NestedObjectConfig|static
     {
@@ -40,7 +43,10 @@ public function nestedObject(mixed $value = []): \Symfony\Config\ScalarNormalize
     }
 
     /**
+     * @template TValue
+     * @param TValue $value
      * @return \Symfony\Config\ScalarNormalizedTypes\Nested\NestedListObjectConfig|$this
+     * @psalm-return (TValue is array ? \Symfony\Config\ScalarNormalizedTypes\Nested\NestedListObjectConfig : static)
      */
     public function nestedListObject(mixed $value = []): \Symfony\Config\ScalarNormalizedTypes\Nested\NestedListObjectConfig|static
     {
diff --git a/src/Symfony/Component/Config/Tests/Builder/Fixtures/ScalarNormalizedTypes/Symfony/Config/ScalarNormalizedTypesConfig.php b/src/Symfony/Component/Config/Tests/Builder/Fixtures/ScalarNormalizedTypes/Symfony/Config/ScalarNormalizedTypesConfig.php
@@ -48,8 +48,11 @@ public function keyedArray(string $name, mixed $value): static
     }
 
     /**
+     * @template TValue
+     * @param TValue $value
      * @default {"enabled":null}
      * @return \Symfony\Config\ScalarNormalizedTypes\ObjectConfig|$this
+     * @psalm-return (TValue is array ? \Symfony\Config\ScalarNormalizedTypes\ObjectConfig : static)
      */
     public function object(mixed $value = []): \Symfony\Config\ScalarNormalizedTypes\ObjectConfig|static
     {
@@ -71,7 +74,10 @@ public function object(mixed $value = []): \Symfony\Config\ScalarNormalizedTypes
     }
 
     /**
+     * @template TValue
+     * @param TValue $value
      * @return \Symfony\Config\ScalarNormalizedTypes\ListObjectConfig|$this
+     * @psalm-return (TValue is array ? \Symfony\Config\ScalarNormalizedTypes\ListObjectConfig : static)
      */
     public function listObject(mixed $value = []): \Symfony\Config\ScalarNormalizedTypes\ListObjectConfig|static
     {
@@ -86,7 +92,10 @@ public function listObject(mixed $value = []): \Symfony\Config\ScalarNormalizedT
     }
 
     /**
+     * @template TValue
+     * @param TValue $value
      * @return \Symfony\Config\ScalarNormalizedTypes\KeyedListObjectConfig|$this
+     * @psalm-return (TValue is array ? \Symfony\Config\ScalarNormalizedTypes\KeyedListObjectConfig : static)
      */
     public function keyedListObject(string $class, mixed $value = []): \Symfony\Config\ScalarNormalizedTypes\KeyedListObjectConfig|static
     {

Original file line number	Diff line number	Diff line change
`@@ -48,8 +48,11 @@ public function keyedArray(string $name, mixed $value): static`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`/**`
	`51`	`+ * @template TValue`
	`52`	`+ * @param TValue $value`
`51`	`53`	`* @default {"enabled":null}`
`52`	`54`	`* @return \Symfony\Config\ScalarNormalizedTypes\ObjectConfig\|$this`
	`55`	`+ * @psalm-return (TValue is array ? \Symfony\Config\ScalarNormalizedTypes\ObjectConfig : static)`
`53`	`56`	`*/`
`54`	`57`	`public function object(mixed $value = []): \Symfony\Config\ScalarNormalizedTypes\ObjectConfig\|static`
`55`	`58`	`{`
`@@ -71,7 +74,10 @@ public function object(mixed $value = []): \Symfony\Config\ScalarNormalizedTypes`
`71`	`74`	`}`
`72`	`75`
`73`	`76`	`/**`
	`77`	`+ * @template TValue`
	`78`	`+ * @param TValue $value`
`74`	`79`	`* @return \Symfony\Config\ScalarNormalizedTypes\ListObjectConfig\|$this`
	`80`	`+ * @psalm-return (TValue is array ? \Symfony\Config\ScalarNormalizedTypes\ListObjectConfig : static)`
`75`	`81`	`*/`
`76`	`82`	`public function listObject(mixed $value = []): \Symfony\Config\ScalarNormalizedTypes\ListObjectConfig\|static`
`77`	`83`	`{`
`@@ -86,7 +92,10 @@ public function listObject(mixed $value = []): \Symfony\Config\ScalarNormalizedT`
`86`	`92`	`}`
`87`	`93`
`88`	`94`	`/**`
	`95`	`+ * @template TValue`
	`96`	`+ * @param TValue $value`
`89`	`97`	`* @return \Symfony\Config\ScalarNormalizedTypes\KeyedListObjectConfig\|$this`
	`98`	`+ * @psalm-return (TValue is array ? \Symfony\Config\ScalarNormalizedTypes\KeyedListObjectConfig : static)`
`90`	`99`	`*/`
`91`	`100`	`public function keyedListObject(string $class, mixed $value = []): \Symfony\Config\ScalarNormalizedTypes\KeyedListObjectConfig\|static`
`92`	`101`	`{`