minor #4580 Add suport for true/false return type hints. (SpacePossum)

This PR was merged into the 2.15 branch.

Discussion
----------

Add suport for true/false return type hints.

fixes first issues listed here #4511

Commits
-------

20969b5 Add suport for true/false return type hints.

Author: SpacePossum

src/Fixer/FunctionNotation/PhpdocToReturnTypeFixer.php

@@ -32,7 +32,7 @@
 final class PhpdocToReturnTypeFixer extends AbstractFixer implements ConfigurationDefinitionFixerInterface
 {
     /**
-     * @var array
+     * @var array<array<int, string>>
      */
     private $blacklistFuncNames = [
         [T_STRING, '__construct'],
@@ -41,7 +41,7 @@ final class PhpdocToReturnTypeFixer extends AbstractFixer implements Configurati
     ];
 
     /**
-     * @var array
+     * @var array<string, int>
      */
     private $versionSpecificTypes = [
         'void' => 70100,
@@ -50,17 +50,19 @@ final class PhpdocToReturnTypeFixer extends AbstractFixer implements Configurati
     ];
 
     /**
-     * @var array
+     * @var array<string, string>
      */
     private $scalarTypes = [
-        'bool' => true,
-        'float' => true,
-        'int' => true,
-        'string' => true,
+        'bool' => 'bool',
+        'true' => 'bool',
+        'false' => 'bool',
+        'float' => 'float',
+        'int' => 'int',
+        'string' => 'string',
     ];
 
     /**
-     * @var array
+     * @var array<string, bool>
      */
     private $skippedTypes = [
         'mixed' => true,
@@ -127,9 +129,9 @@ public function isCandidate(Tokens $tokens)
      */
     public function getPriority()
     {
-        // should be run after PhpdocScalarFixer.
+        // should be run after PhpdocScalarFixer and PhpdocTypes.
         // should be run before ReturnTypeDeclarationFixer, FullyQualifiedStrictTypesFixer, NoSuperfluousPhpdocTagsFixer.
-        return 8;
+        return 13;
     }
 
     /**
@@ -172,15 +174,18 @@ protected function applyFix(\SplFileInfo $file, Tokens $tokens)
             if (1 !== \count($returnTypeAnnotation)) {
                 continue;
             }
+
             $returnTypeAnnotation = current($returnTypeAnnotation);
             $types = array_values($returnTypeAnnotation->getTypes());
             $typesCount = \count($types);
+
             if (1 > $typesCount || 2 < $typesCount) {
                 continue;
             }
 
             $isNullable = false;
             $returnType = current($types);
+
             if (2 === $typesCount) {
                 $null = $types[0];
                 $returnType = $types[1];
@@ -216,16 +221,20 @@ protected function applyFix(\SplFileInfo $file, Tokens $tokens)
                 continue;
             }
 
-            if (isset($this->scalarTypes[$returnType]) && false === $this->configuration['scalar_types']) {
-                continue;
-            }
+            if (isset($this->scalarTypes[$returnType])) {
+                if (false === $this->configuration['scalar_types']) {
+                    continue;
+                }
 
-            if (1 !== Preg::match($this->classRegex, $returnType, $matches)) {
-                continue;
-            }
+                $returnType = $this->scalarTypes[$returnType];
+            } else {
+                if (1 !== Preg::match($this->classRegex, $returnType, $matches)) {
+                    continue;
+                }
 
-            if (isset($matches['array'])) {
-                $returnType = 'array';
+                if (isset($matches['array'])) {
+                    $returnType = 'array';
+                }
             }
 
             $startIndex = $tokens->getNextTokenOfKind($index, ['{', ';']);

tests/AutoReview/FixerFactoryTest.php

@@ -196,6 +196,7 @@ public function provideFixersPriorityCases()
             [$fixers['phpdoc_to_return_type'], $fixers['fully_qualified_strict_types']],
             [$fixers['phpdoc_to_return_type'], $fixers['no_superfluous_phpdoc_tags']],
             [$fixers['phpdoc_to_return_type'], $fixers['return_type_declaration']],
+            [$fixers['phpdoc_types'], $fixers['phpdoc_to_return_type']],
             [$fixers['pow_to_exponentiation'], $fixers['binary_operator_spaces']],
             [$fixers['pow_to_exponentiation'], $fixers['method_argument_space']],
             [$fixers['pow_to_exponentiation'], $fixers['native_function_casing']],

tests/Fixer/FunctionNotation/PhpdocToReturnTypeFixerTest.php

@@ -119,11 +119,31 @@ function xyz() {}
                 '<?php /** @return object */ function my_foo() {}',
                 70200,
             ],
-            'fix scalar types by default' => [
+            'fix scalar types by default, int' => [
                 '<?php /** @return int */ function my_foo(): int {}',
                 '<?php /** @return int */ function my_foo() {}',
             ],
-            'fix scalar types when configured' => [
+            'fix scalar types by default, float' => [
+                '<?php /** @return float */ function my_foo(): float {}',
+                '<?php /** @return float */ function my_foo() {}',
+            ],
+            'fix scalar types by default, string' => [
+                '<?php /** @return string */ function my_foo(): string {}',
+                '<?php /** @return string */ function my_foo() {}',
+            ],
+            'fix scalar types by default, bool' => [
+                '<?php /** @return bool */ function my_foo(): bool {}',
+                '<?php /** @return bool */ function my_foo() {}',
+            ],
+            'fix scalar types by default, false' => [
+                '<?php /** @return false */ function my_foo(): bool {}',
+                '<?php /** @return false */ function my_foo() {}',
+            ],
+            'fix scalar types by default, true' => [
+                '<?php /** @return true */ function my_foo(): bool {}',
+                '<?php /** @return true */ function my_foo() {}',
+            ],
+            'do not fix scalar types when configured as such' => [
                 '<?php /** @return int */ function my_foo() {}',
                 null,
                 null,

tests/Fixtures/Integration/priority/phpdoc_types,phpdoc_to_return_type.test

@@ -0,0 +1,25 @@
+--TEST--
+Integration of fixers: phpdoc_types,phpdoc_to_return_type.
+--RULESET--
+{"phpdoc_types": true, "phpdoc_to_return_type": true}
+--REQUIREMENTS--
+{"php": 70000}
+--EXPECT--
+<?php
+/**
+ * @return int
+ */
+function my_foo(): int
+{
+    return 1;
+}
+
+--INPUT--
+<?php
+/**
+ * @return INT
+ */
+function my_foo()
+{
+    return 1;
+}