Support and test AST version 50

Author: TysonAndre-tmg

README.md

@@ -3,6 +3,14 @@ PHP-Parser to php-ast
 
 [![Build Status](https://travis-ci.org/TysonAndre/php-parser-to-php-ast.svg?branch=master)](https://travis-ci.org/TysonAndre/php-parser-to-php-ast)
 
+This converts ASTs(Abstract Syntax Trees) from [PHP-Parser](https://github.com/nikic/PHP-Parser) to [php-ast](https://github.com/nikic/php-ast/).
+It can be used as a PHP-only implementation of php-ast.
+
+Supported [php-ast AST versions](https://github.com/nikic/php-ast#version-changelog): 40, 50
+
+Current Status
+--------------
+
 No tests are failing
 
 - This is 90% done

composer.json

@@ -1,15 +1,15 @@
 {
-    "name": "tysonandre/php-parser",
-    "description": "A php-parser to php-ast converter written in php",
+    "name": "tysonandre/php-parser-to-php-ast",
+    "description": "A php-parser to php-ast converter written in php. Can be used to test out projects using php-ast without compiling php-ast.",
     "require": {
         "php": ">=7.1",
-        "nikic/PHP-Parser": "3.0.5"
+        "nikic/PHP-Parser": "~3.1.0"
     },
     "require-dev": {
         "phpunit/phpunit": "^5.7"
     },
     "suggest": {
-        "ext-ast": "~0.1.4"
+        "ext-ast": "~0.1.5"
     },
     "autoload": {
         "psr-4": {"ASTConverter\\": "src/ASTConverter"}

composer.lock

@@ -1,4 +1,5 @@
 <?php declare(strict_types=1);
+// TODO: update for version 50 and 40
 
 use ast\flags;
 
@@ -164,7 +165,10 @@ function format_flags(int $kind, int $flags) : string {
     return (string) $flags;
 }
 
-/** Dumps abstract syntax tree */
+/**
+ * Dumps abstract syntax tree
+ * @suppress PhanUndeclaredProperty fixme
+ */
 function ast_dump($ast, int $options = 0) : string {
     if ($ast instanceof ast\Node) {
         $result = ast\get_kind_name($ast->kind);
@@ -179,13 +183,20 @@ function ast_dump($ast, int $options = 0) : string {
         if (ast\kind_uses_flags($ast->kind)) {
             $result .= "\n    flags: " . format_flags($ast->kind, $ast->flags);
         }
-        if (isset($ast->name)) {
-            $result .= "\n    name: $ast->name";
+        $name = $ast->name ?? $ast->children['name'] ?? null;
+        if (is_string($name)) {
+            $result .= "\n    name: $name";
         }
-        if (isset($ast->docComment)) {
-            $result .= "\n    docComment: $ast->docComment";
+        $docComment = $ast->docComment ?? $ast->children['docComment'] ?? null;
+        if ($docComment !== null) {
+            $result .= "\n    docComment: $docComment";
         }
         foreach ($ast->children as $i => $child) {
+            if ($i === 'name' && $child === $name) {
+                continue;
+            } else if ($i === 'docComment' && $child === $docComment) {
+                continue;
+            }
             $result .= "\n    $i: " . str_replace("\n", "\n    ", ast_dump($child, $options));
         }
         return $result;

src/ASTConverter/ASTConverter.php

@@ -4,4 +4,5 @@
 while ($a) { $b; }
 
 declare(ticks=1);
+/** Doc comment on decl */
 declare(ticks=1) {}

src/util.php

@@ -1,2 +1,2 @@
 <?php
-function test(A $a, array $b, callable $c, INT $d, Float $e, string $f, bool $g, iterable $h) : void { }
+function test(A $a, array $b, callable $c, INT $d, Float $e, string $f, bool $g, iterable $h, object $j) : void { }

test_files/src/stmt_list.php

@@ -22,12 +22,38 @@ function($filename) {
         return array_values($files);
     }
 
+    /**
+     * @return bool
+     */
+    public static function hasNativeASTSupport(int $astVersion) {
+        try {
+            $x = \ast\parse_code('', $astVersion);
+            return true;
+        } catch (\LogicException $e) {
+            return false;
+        }
+    }
+
+    /**
+     * @return string[]|int[] [string $filePath, int $astVersion]
+     */
     public function astValidFileExampleProvider() {
         $tests = [];
         $sourceDir = dirname(dirname(realpath(__DIR__))) . '/test_files/src';
         $files = $this->_scanSourceDirForPHP($sourceDir);
+        $supports40 = self::hasNativeASTSupport(40);
+        $supports50 = self::hasNativeASTSupport(50);
+        if (!($supports40 || $supports50)) {
+            throw new RuntimeException("Neither AST version 40 nor 50 are natively supported");
+        }
         foreach ($files as $file) {
-            $tests[] = [$sourceDir . '/' . $file];
+            $path = $sourceDir . '/' . $file;
+            if ($supports40) {
+                $tests[] = [$path, 40];
+            }
+            if ($supports50) {
+                $tests[] = [$path, 50];
+            }
         }
         return $tests;
     }
@@ -52,15 +78,15 @@ private static function normalizeOriginalAST($node) {
     }
 
     /** @dataProvider astValidFileExampleProvider */
-    public function testFallbackFromParser(string $fileName) {
+    public function testFallbackFromParser(string $fileName, int $astVersion) {
         $contents = file_get_contents($fileName);
         if ($contents === false) {
             $this->fail("Failed to read $fileName");
         }
-        $ast = \ast\parse_code($contents, ASTConverter::AST_VERSION);
+        $ast = \ast\parse_code($contents, $astVersion);
         self::normalizeOriginalAST($ast);
         $this->assertInstanceOf('\ast\Node', $ast, 'Examples must be syntactically valid PHP parseable by php-ast');
-        $fallback_ast = \ASTConverter\ASTConverter::ast_parse_code_fallback($contents, ASTConverter::AST_VERSION);
+        $fallback_ast = \ASTConverter\ASTConverter::ast_parse_code_fallback($contents, $astVersion);
         $this->assertInstanceOf('\ast\Node', $fallback_ast, 'The fallback must also return a tree of php-ast nodes');
         $fallbackASTRepr = var_export($fallback_ast, true);
         $originalASTRepr = var_export($ast, true);

test_files/src/type_hints.php

@@ -177,11 +177,25 @@ function foo() {
     }
 
     private function _testFallbackFromParser(string $incompleteContents, string $validContents) {
-        $ast = \ast\parse_code($validContents, ASTConverter::AST_VERSION);
+        $supports40 = ConversionTest::hasNativeASTSupport(40);
+        $supports50 = ConversionTest::hasNativeASTSupport(50);
+        if (!($supports40 || $supports50)) {
+            $this->fail('No supported AST versions to test');
+        }
+        if ($supports40) {
+            $this->_testFallbackFromParserForASTVersion($incompleteContents, $validContents, 40);
+        }
+        if ($supports50) {
+            $this->_testFallbackFromParserForASTVersion($incompleteContents, $validContents, 50);
+        }
+    }
+
+    private function _testFallbackFromParserForASTVersion(string $incompleteContents, string $validContents, int $astVersion) {
+        $ast = \ast\parse_code($validContents, $astVersion);
         $this->assertInstanceOf('\ast\Node', $ast, 'Examples(for validContents) must be syntactically valid PHP parseable by php-ast');
         $errors = [];
         $phpParserNode = ASTConverter::phpparser_parse($incompleteContents, true, $errors);
-        $fallback_ast = ASTConverter::phpparser_to_phpast($phpParserNode, ASTConverter::AST_VERSION);
+        $fallback_ast = ASTConverter::phpparser_to_phpast($phpParserNode, $astVersion);
         $this->assertInstanceOf('\ast\Node', $fallback_ast, 'The fallback must also return a tree of php-ast nodes');
         $fallbackASTRepr = var_export($fallback_ast, true);
         $originalASTRepr = var_export($ast, true);
@@ -197,7 +211,7 @@ private function _testFallbackFromParser(string $incompleteContents, string $val
             } catch (\PhpParser\Error $e) {
             }
             $original_ast_dump = \ast_dump($ast);
-            $parser_export = var_export($phpParserNode, true);
+            // $parser_export = var_export($phpParserNode, true);
             $this->assertSame($originalASTRepr, $fallbackASTRepr,  <<<EOT
 The fallback must return the same tree of php-ast nodes
 Code: