Merge pull request #87 from Ocramius/feature/php-7-1-support

PHP 7.1 support
zendframework · Oct 24, 2016 · 3449c7c · 3449c7c
2 parents 4606aad + c682384
commit 3449c7c
Show file tree

Hide file tree

Showing 15 changed files with 493 additions and 36 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -47,6 +47,15 @@ matrix:
     - php: 7
       env:
         - DEPS=latest
+    - php: 7.1
+      env:
+        - DEPS=lowest
+    - php: 7.1
+      env:
+        - DEPS=locked
+    - php: 7.1
+      env:
+        - DEPS=latest
     - php: hhvm
       env:
         - DEPS=lowest
@@ -65,7 +74,7 @@ notifications:
 
 before_install:
   - travis_retry composer self-update
-  - if [[ $TRAVIS_PHP_VERSION != "hhvm" && $TEST_COVERAGE != 'true' ]]; then phpenv config-rm xdebug.ini ; fi
+  - if [[ $TRAVIS_PHP_VERSION != "hhvm" && $TEST_COVERAGE != 'true' ]]; then phpenv config-rm xdebug.ini || true ; fi
 
 install:
   - if [[ $DEPS == 'latest' ]]; then travis_retry composer update $COMPOSER_ARGS ; fi

diff --git a/src/Generator/MethodGenerator.php b/src/Generator/MethodGenerator.php
@@ -9,6 +9,7 @@
 
 namespace Zend\Code\Generator;
 
+use ReflectionMethod;
 use Zend\Code\Reflection\MethodReflection;
 
 class MethodGenerator extends AbstractMemberGenerator
@@ -389,12 +390,30 @@ private static function extractReturnTypeFromMethodReflection(MethodReflection $
             return null;
         }
 
-        $returnTypeString = (string) $returnType;
+        if (! method_exists($returnType, 'getName')) {
+            return self::expandLiteralType((string) $returnType, $methodReflection);
+        }
+
+        return ($returnType->allowsNull() ? '?' : '')
+            . self::expandLiteralType($returnType->getName(), $methodReflection);
+    }
 
-        if ('self' === strtolower($returnType)) {
+    /**
+     * @param string           $literalReturnType
+     * @param ReflectionMethod $methodReflection
+     *
+     * @return string
+     */
+    private static function expandLiteralType($literalReturnType, ReflectionMethod $methodReflection)
+    {
+        if ('self' === strtolower($literalReturnType)) {
             return $methodReflection->getDeclaringClass()->getName();
         }
 
-        return $returnTypeString;
+        if ('parent' === strtolower($literalReturnType)) {
+            return $methodReflection->getDeclaringClass()->getParentClass()->getName();
+        }
+
+        return $literalReturnType;
     }
 }
diff --git a/src/Generator/ParameterGenerator.php b/src/Generator/ParameterGenerator.php
@@ -9,6 +9,7 @@
 
 namespace Zend\Code\Generator;
 
+use ReflectionParameter;
 use Zend\Code\Reflection\ParameterReflection;
 
 class ParameterGenerator extends AbstractGenerator
@@ -334,14 +335,12 @@ private static function extractFQCNTypeFromReflectionType(ParameterReflection $r
             return null;
         }
 
-        $typeString = (string) $type;
-
-        if ('self' === strtolower($typeString)) {
-            // exceptional case: `self` must expand to the reflection type declaring class
-            return $reflectionParameter->getDeclaringClass()->getName();
+        if (! method_exists($type, 'getName')) {
+            return self::expandLiteralParameterType((string) $type, $reflectionParameter);
         }
 
-        return $typeString;
+        return ($type->allowsNull() ? '?' : '')
+            . self::expandLiteralParameterType($type->getName(), $reflectionParameter);
     }
 
     /**
@@ -368,6 +367,25 @@ private static function prePhp7ExtractFQCNTypeFromReflectionType(ParameterReflec
         return null;
     }
 
+    /**
+     * @param string              $literalParameterType
+     * @param ReflectionParameter $reflectionParameter
+     *
+     * @return string
+     */
+    private static function expandLiteralParameterType($literalParameterType, ReflectionParameter $reflectionParameter)
+    {
+        if ('self' === strtolower($literalParameterType)) {
+            return $reflectionParameter->getDeclaringClass()->getName();
+        }
+
+        if ('parent' === strtolower($literalParameterType)) {
+            return $reflectionParameter->getDeclaringClass()->getParentClass()->getName();
+        }
+
+        return $literalParameterType;
+    }
+
     /**
      * @param string|null $type
      *

diff --git a/src/Generator/TypeGenerator.php b/src/Generator/TypeGenerator.php
@@ -23,19 +23,23 @@ final class TypeGenerator implements GeneratorInterface
      */
     private $type;
 
+    /**
+     * @var bool
+     */
+    private $nullable;
+
     /**
      * @var string[]
      *
      * @link http://php.net/manual/en/functions.arguments.php#functions.arguments.type-declaration
      */
-    private static $internalPhpTypes = ['int', 'float', 'string', 'bool', 'array', 'callable'];
+    private static $internalPhpTypes = ['void', 'int', 'float', 'string', 'bool', 'array', 'callable', 'iterable'];
 
-    // @codingStandardsIgnoreStart
     /**
      * @var string a regex pattern to match valid class names or types
      */
-    private static $validIdentifierMatcher = '/^[a-zA-Z_\x80-\xff][a-zA-Z0-9_\x80-\xff]*(\\\\[a-zA-Z_\x80-\xff][a-zA-Z0-9_\x80-\xff]*)*$/';
-    // @codingStandardsIgnoreEnd
+    private static $validIdentifierMatcher = '/^[a-zA-Z_\x80-\xff][a-zA-Z0-9_\x80-\xff]*'
+        . '(\\\\[a-zA-Z_\x80-\xff][a-zA-Z0-9_\x80-\xff]*)*$/';
 
     /**
      * @param string $type
@@ -46,7 +50,8 @@ final class TypeGenerator implements GeneratorInterface
      */
     public static function fromTypeString($type)
     {
-        list($wasTrimmed, $trimmedType) = self::trimType($type);
+        list($nullable, $trimmedNullable) = self::trimNullable($type);
+        list($wasTrimmed, $trimmedType) = self::trimType($trimmedNullable);
 
         if (! preg_match(self::$validIdentifierMatcher, $trimmedType)) {
             throw new InvalidArgumentException(sprintf(
@@ -65,9 +70,14 @@ public static function fromTypeString($type)
             ));
         }
 
+        if ($nullable && $isInternalPhpType && 'void' === strtolower($trimmedType)) {
+            throw new InvalidArgumentException(sprintf('Provided type "%s" cannot be nullable', $type));
+        }
+
         $instance = new self();
 
         $instance->type              = $trimmedType;
+        $instance->nullable          = $nullable;
         $instance->isInternalPhpType = self::isInternalPhpType($trimmedType);
 
         return $instance;
@@ -82,26 +92,43 @@ private function __construct()
      */
     public function generate()
     {
+        $nullable = $this->nullable ? '?' : '';
+
         if ($this->isInternalPhpType) {
-            return strtolower($this->type);
+            return $nullable . strtolower($this->type);
         }
 
-        return '\\' . $this->type;
+        return $nullable . '\\' . $this->type;
     }
 
     /**
      * @return string the cleaned type string
      */
     public function __toString()
     {
-        return ltrim($this->generate(), '\\');
+        return ltrim($this->generate(), '?\\');
+    }
+
+    /**
+     * @param string $type
+     *
+     * @return bool[]|string[] ordered tuple, first key represents whether the type is nullable, second is the
+     *                         trimmed string
+     */
+    private static function trimNullable($type)
+    {
+        if (0 === strpos($type, '?')) {
+            return [true, substr($type, 1)];
+        }
+
+        return [false, $type];
     }
 
     /**
      * @param string $type
      *
-     * @return bool[]|int[] ordered tuple, first key represents whether the values was trimmed, second is the
-     *                      trimmed string
+     * @return bool[]|string[] ordered tuple, first key represents whether the values was trimmed, second is the
+     *                         trimmed string
      */
     private static function trimType($type)
     {

diff --git a/test/Generator/MethodGeneratorTest.php b/test/Generator/MethodGeneratorTest.php
@@ -14,7 +14,10 @@
 use Zend\Code\Generator\ValueGenerator;
 use Zend\Code\Reflection\MethodReflection;
 use ZendTest\Code\TestAsset\ClassWithByRefReturnMethod;
+use ZendTest\Code\TestAsset\EmptyClass;
 use ZendTest\Code\TestAsset\InternalHintsClass;
+use ZendTest\Code\TestAsset\IterableHintsClass;
+use ZendTest\Code\TestAsset\NullableReturnTypeHintedClass;
 use ZendTest\Code\TestAsset\ReturnTypeHintedClass;
 
 /**
@@ -338,17 +341,42 @@ public function testFrom(string $className, string $methodName, string $expected
 
     public function returnTypeHintClassesProvider()
     {
-        return [
+        $parameters = [
+            [ReturnTypeHintedClass::class, 'voidReturn', 'void'],
             [ReturnTypeHintedClass::class, 'arrayReturn', 'array'],
             [ReturnTypeHintedClass::class, 'callableReturn', 'callable'],
             [ReturnTypeHintedClass::class, 'intReturn', 'int'],
             [ReturnTypeHintedClass::class, 'floatReturn', 'float'],
             [ReturnTypeHintedClass::class, 'stringReturn', 'string'],
             [ReturnTypeHintedClass::class, 'boolReturn', 'bool'],
             [ReturnTypeHintedClass::class, 'selfReturn', '\\' . ReturnTypeHintedClass::class],
+            [ReturnTypeHintedClass::class, 'parentReturn', '\\' . EmptyClass::class],
             [ReturnTypeHintedClass::class, 'classReturn', '\\' . ReturnTypeHintedClass::class],
             [ReturnTypeHintedClass::class, 'otherClassReturn', '\\' . InternalHintsClass::class],
+            [NullableReturnTypeHintedClass::class, 'arrayReturn', '?array'],
+            [NullableReturnTypeHintedClass::class, 'callableReturn', '?callable'],
+            [NullableReturnTypeHintedClass::class, 'intReturn', '?int'],
+            [NullableReturnTypeHintedClass::class, 'floatReturn', '?float'],
+            [NullableReturnTypeHintedClass::class, 'stringReturn', '?string'],
+            [NullableReturnTypeHintedClass::class, 'boolReturn', '?bool'],
+            [NullableReturnTypeHintedClass::class, 'selfReturn', '?\\' . NullableReturnTypeHintedClass::class],
+            [NullableReturnTypeHintedClass::class, 'parentReturn', '?\\' . EmptyClass::class],
+            [NullableReturnTypeHintedClass::class, 'classReturn', '?\\' . NullableReturnTypeHintedClass::class],
+            [NullableReturnTypeHintedClass::class, 'otherClassReturn', '?\\' . InternalHintsClass::class],
+            [IterableHintsClass::class, 'iterableReturnValue', 'iterable'],
+            [IterableHintsClass::class, 'nullableIterableReturnValue', '?iterable'],
         ];
+
+        return array_filter(
+            $parameters,
+            function (array $parameter) {
+                return PHP_VERSION_ID >= 70100
+                    || (
+                        false === strpos($parameter[2], '?')
+                        && ! in_array(strtolower($parameter[2]), ['void', 'iterable'])
+                    );
+            }
+        );
     }
 
     /**