Merge pull request #25 from ricordisamoa/nullable-types

Support PHP 7.1 nullable types (#16)

Author: dunglas

README.md

@@ -59,6 +59,7 @@ Supports:
 * methods of classes and traits
 * method definitions in interfaces
 * PHPDoc inheritance
+* PHP 7.1 nullable types (can be disabled with `--no-nullable-types` option)
 
 ## Credits
 

src/ConvertCommand.php

@@ -55,6 +55,7 @@ protected function configure()
             ->setDescription('Convert files')
             ->addOption('exclude', 'e', InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'Directories to exclude', ['vendor'])
             ->addOption('dry-run', null, InputOption::VALUE_NONE, 'Displays diff instead of modifying files')
+            ->addOption('no-nullable-types', null, InputOption::VALUE_NONE, 'Uses a default `null` value instead of PHP 7.1 nullable types')
             ->addArgument('input', InputArgument::OPTIONAL | InputArgument::IS_ARRAY, 'Input directories', ['.'])
         ;
     }
@@ -87,7 +88,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $changed = [];
         foreach ($project->getFiles() as $file) {
             $old = $file->getSource();
-            $new = $converter->convert($project, $file);
+            $new = $converter->convert($project, $file, !$input->getOption('no-nullable-types'));
 
             if ($new !== $old) {
                 if ($input->getOption('dry-run')) {

src/Converter.php

@@ -55,10 +55,11 @@ class Converter
      *
      * @param Project $project
      * @param File    $file
+     * @param bool    $nullableTypes
      *
      * @return string
      */
-    public function convert(Project $project, File $file): string
+    public function convert(Project $project, File $file, bool $nullableTypes): string
     {
         $tokens = token_get_all($file->getSource());
 
@@ -129,12 +130,12 @@ public function convert(Project $project, File $file): string
                         if (null !== $function && $outputReturn) {
                             $return = $this->getReturn($project, $objectType, $namespace, $object, $function);
 
-                            if ($return && $return[0] && !$return[1]) {
+                            if ($return && $return[0] && (!$return[1] || $nullableTypes)) {
                                 if ($endsInNewLine = $this->endsInNewLine($output)) {
                                     $output = substr($output, 0, -strlen($endsInNewLine));
                                 }
 
-                                $output .= sprintf(': %s', $return[0]);
+                                $output .= sprintf(': %s%s', $return[1] ? '?' : '', $return[0]);
 
                                 if ($endsInNewLine) {
                                     $output .= $endsInNewLine;
@@ -242,9 +243,13 @@ public function convert(Project $project, File $file): string
                             $parameter = $this->getParameter($project, $objectType, $namespace, $object, $function, $text);
 
                             if ($parameter) {
-                                $output .= $parameter[0].' ';
-
                                 $outputDefaultValue = (bool) $parameter[1];
+                                if ($outputDefaultValue && $nullableTypes) {
+                                    $output .= '?';
+                                    $outputDefaultValue = false;
+                                }
+
+                                $output .= $parameter[0].' ';
                             }
 
                             if ($paramByReference) {
@@ -550,10 +555,16 @@ private function getTypeFromTag(Tag $tag): array
             }
 
             if (!$type0 instanceof Null_ && $type1 instanceof Null_) {
+                if ($type0 instanceof Array_) {
+                    return ['array', true];
+                }
                 return [$type0->__toString(), true];
             }
 
             if (!$type1 instanceof Null_ && $type0 instanceof Null_) {
+                if ($type1 instanceof Array_) {
+                    return ['array', true];
+                }
                 return [$type1->__toString(), true];
             }
 

tests/ConverterTest.php

@@ -35,7 +35,7 @@ public static function setUpBeforeClass()
     /**
      * @dataProvider filesProvider
      */
-    public function testSingleFiles(string $projectName, string $fileName)
+    public function testSingleFiles(string $projectName, string $fileName, bool $nullableTypes = null)
     {
         $projectFactory = ProjectFactory::createInstance();
         $project = $projectFactory->create(
@@ -46,7 +46,7 @@ public function testSingleFiles(string $projectName, string $fileName)
         foreach ($project->getFiles() as $file) {
             $this->assertStringEqualsFile(
                 __DIR__.'/Results/'.$fileName,
-                self::$converter->convert($project, $file)
+                self::$converter->convert($project, $file, $nullableTypes !== null ? $nullableTypes : false)
             );
         }
     }
@@ -68,14 +68,14 @@ public function testInheritance()
             if ($childPath === $path) {
                 $this->assertStringEqualsFile(
                     __DIR__.'/Results/Child.php',
-                    self::$converter->convert($project, $file)
+                    self::$converter->convert($project, $file, false)
                 );
             }
         }
     }
 
     /**
-     * @return string[][]
+     * @return array[]
      */
     public function filesProvider(): array
     {
@@ -90,6 +90,7 @@ public function filesProvider(): array
             ['arrayNoTypes', 'array_no_types.php'],
             ['typeAliasesWhitelisting', 'type_aliases_and_whitelisting.php'],
             ['passByReference', 'pass_by_reference.php'],
+            ['nullableTypes', 'nullable_types.php', true],
         ];
     }
 }

tests/Fixtures/nullable_types.php

@@ -0,0 +1,82 @@
+<?php
+
+/**
+ * Must be converted.
+ *
+ * @return string|null
+ */
+function foo()
+{
+}
+
+/**
+ * Must be converted.
+ *
+ * @param \DateTime|null $a
+ * @param int|null       $c
+ * @param string[]|null  $d
+ *
+ * @return float
+ */
+function bar($a, array $b, $c, $d, bool $e, callable $f = null)
+{
+    return 0.0;
+}
+
+/**
+ * Must not be modified (no params defined).
+ */
+function baz($a)
+{
+}
+
+/**
+ * Must be converted.
+ *
+ * @return bool[]|null
+ */
+function bazbaz()
+{
+}
+
+/**
+ * Must not be converted (already using type hints).
+ *
+ * @param int $a
+ *
+ * @return string
+ */
+function bat(int $a): string
+{
+}
+
+/**
+ * Must not be modified (incompatible types).
+ *
+ * @param int|string|null
+ *
+ * @return bool|int|null
+ */
+function foobar($a)
+{
+}
+
+/**
+ * Must not be converted (type hints take precedence over PHPDoc annotations).
+ *
+ * @param int|null $a
+ *
+ * @return string
+ */
+function foobaz(int $a): string
+{
+}
+
+/**
+ * Must not be converted (already using default value).
+ *
+ * @param int|null $a
+ */
+function foobat(int $a = null)
+{
+}

tests/Results/nullable_types.php

@@ -0,0 +1,82 @@
+<?php
+
+/**
+ * Must be converted.
+ *
+ * @return string|null
+ */
+function foo(): ?string
+{
+}
+
+/**
+ * Must be converted.
+ *
+ * @param \DateTime|null $a
+ * @param int|null       $c
+ * @param string[]|null  $d
+ *
+ * @return float
+ */
+function bar(?\DateTime $a, array $b, ?int $c, ?array $d, bool $e, callable $f = null): float
+{
+    return 0.0;
+}
+
+/**
+ * Must not be modified (no params defined).
+ */
+function baz($a)
+{
+}
+
+/**
+ * Must be converted.
+ *
+ * @return bool[]|null
+ */
+function bazbaz(): ?array
+{
+}
+
+/**
+ * Must not be converted (already using type hints).
+ *
+ * @param int $a
+ *
+ * @return string
+ */
+function bat(int $a): string
+{
+}
+
+/**
+ * Must not be modified (incompatible types).
+ *
+ * @param int|string|null
+ *
+ * @return bool|int|null
+ */
+function foobar($a)
+{
+}
+
+/**
+ * Must not be converted (type hints take precedence over PHPDoc annotations).
+ *
+ * @param int|null $a
+ *
+ * @return string
+ */
+function foobaz(int $a): string
+{
+}
+
+/**
+ * Must not be converted (already using default value).
+ *
+ * @param int|null $a
+ */
+function foobat(int $a = null)
+{
+}