feat: PHP8 Promoted Props / Match Statement / Throw Statement / Union Types (#1753)

* Added support for PHP 8 promoted properties

* Added tests for Throw as expression

* added support for match statement

* added support for union types

* remove useless test

* added missing union tests

* fix ci

Co-authored-by: Chris Seufert <chris@modd.com.au>

Author: czosel

package.json

@@ -13,7 +13,7 @@
   "dependencies": {
     "linguist-languages": "^7.5.1",
     "mem": "^8.0.0",
-    "php-parser": "czosel/php-parser#177699bf5f19b2ac4a95049fb19000fbc4ffa0fd"
+    "php-parser": "https://github.com/glayzzle/php-parser#bb89fff"
   },
   "devDependencies": {
     "@babel/preset-env": "^7.7.5",

src/printer.js

@@ -1753,7 +1753,16 @@ function printNode(path, options, print) {
         path.call(print, "body"),
       ]);
     case "parameter": {
+      let promoted = "";
+      if (node.flags === 1) {
+        promoted = "public ";
+      } else if (node.flags === 2) {
+        promoted = "protected ";
+      } else if (node.flags === 4) {
+        promoted = "private ";
+      }
       const name = concat([
+        promoted,
         node.nullable ? "?" : "",
         node.type ? concat([path.call(print, "type"), " "]) : "",
         node.byref ? "&" : "",
@@ -2847,6 +2856,17 @@ function printNode(path, options, print) {
         quote,
       ]);
     }
+    case "uniontype": {
+      return group(
+        concat(
+          path.map(
+            (uPath, i) =>
+              concat(i === 0 ? [path.call(print)] : ["|", path.call(print)]),
+            "types"
+          )
+        )
+      );
+    }
     case "encapsedpart": {
       const open =
         (node.syntax === "simple" && node.curly) || node.syntax === "complex"
@@ -2925,6 +2945,50 @@ function printNode(path, options, print) {
 
       return path.call(print, "name");
     }
+    case "match": {
+      const arms = path.map((armPath, armIdx) => {
+        const conds =
+          armPath.getValue().conds === null
+            ? "default"
+            : concat(
+                armPath.map(
+                  (condPath, condIdx) =>
+                    group(
+                      concat(
+                        condIdx > 0
+                          ? [",", line, print(condPath)]
+                          : [print(condPath)]
+                      )
+                    ),
+                  "conds"
+                )
+              );
+        const body = armPath.call(print, "body");
+        return concat(
+          armIdx > 0
+            ? [", ", line, conds, " => ", body]
+            : [line, conds, " => ", body]
+        );
+      }, "arms");
+      return group(
+        concat([
+          "match (",
+          group(
+            concat([
+              softline,
+              indent(concat([path.call(print, "cond")])),
+              softline,
+            ])
+          ),
+          ") {",
+          indent(concat(arms)),
+          " ",
+          softline,
+          "}",
+        ])
+      );
+    }
+
     case "noop":
       return node.comments
         ? comments.printComments(path.getValue().comments, options)

tests/class/__snapshots__/jsfmt.spec.js.snap

@@ -929,6 +929,11 @@ class User {
     }
 }
 
+class Promoted {
+    public function __construct(   public  int $a, private float $b, protected  string  $d  ){
+
+    }
+}
 =====================================output=====================================
 <?php
 
@@ -1434,5 +1439,15 @@ class User
     }
 }
 
+class Promoted
+{
+    public function __construct(
+        public int $a,
+        private float $b,
+        protected string $d
+    ) {
+    }
+}
+
 ================================================================================
 `;

tests/class/class.php

@@ -293,3 +293,9 @@ public function __construct(int $id, string $name) {
         $this->name = $name;
     }
 }
+
+class Promoted {
+    public function __construct(   public  int $a, private float $b, protected  string  $d  ){
+
+    }
+}

tests/match/__snapshots__/jsfmt.spec.js.snap

@@ -0,0 +1,67 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`match.php 1`] = `
+====================================options=====================================
+parsers: ["php"]
+phpVersion: "8.0"
+printWidth: 80
+                                                                                | printWidth
+=====================================input======================================
+<?php
+
+$really_really_really_long_variable_name = match(getValue()) {
+  true => implode(',',[1,2,3]),
+    false => $a || 'Empty',
+    null => null,
+    default => throw new \\InvalidArgumentException('Unknown Value'),
+};
+
+$boolStr = match($v) {true => 'true', false => 'false'};
+
+$boolish = match($v) {
+    true, 1 => true,
+    false,0,'',null => false,
+    default => null
+};
+
+$a = match(true) {
+    test() => 'Good',
+    test2() => 'Two',
+    default => 'fail'
+};
+
+$nest = match(match($a) {true => 1, false => 2}) {
+    1 => match($b) {
+        'ok' => true,
+        'fail' => false,
+        default => false
+    },
+    2 => 'null'
+};
+=====================================output=====================================
+<?php
+
+$really_really_really_long_variable_name = match (getValue()) {
+    true => implode(",", [1, 2, 3]),
+    false => $a || "Empty",
+    null => null,
+    default => throw new \\InvalidArgumentException("Unknown Value")
+};
+
+$boolStr = match ($v) { true => "true",  false => "false" };
+
+$boolish = match ($v) {
+    true, 1 => true,
+    false, 0, "", null => false,
+    default => null
+};
+
+$a = match (true) { test() => "Good",  test2() => "Two",  default => "fail" };
+
+$nest = match (match ($a) { true => 1,  false => 2 }) {
+    1 => match ($b) { "ok" => true,  "fail" => false,  default => false },
+    2 => "null"
+};
+
+================================================================================
+`;

tests/match/jsfmt.spec.js

@@ -0,0 +1 @@
+run_spec(__dirname, ["php"], { phpVersion: "8.0" });

tests/match/match.php

@@ -0,0 +1,31 @@
+<?php
+
+$really_really_really_long_variable_name = match(getValue()) {
+  true => implode(',',[1,2,3]),
+    false => $a || 'Empty',
+    null => null,
+    default => throw new \InvalidArgumentException('Unknown Value'),
+};
+
+$boolStr = match($v) {true => 'true', false => 'false'};
+
+$boolish = match($v) {
+    true, 1 => true,
+    false,0,'',null => false,
+    default => null
+};
+
+$a = match(true) {
+    test() => 'Good',
+    test2() => 'Two',
+    default => 'fail'
+};
+
+$nest = match(match($a) {true => 1, false => 2}) {
+    1 => match($b) {
+        'ok' => true,
+        'fail' => false,
+        default => false
+    },
+    2 => 'null'
+};

tests/parens/__snapshots__/jsfmt.spec.js.snap

@@ -3172,6 +3172,9 @@ if (!$var) {
     throw (new \\Exception("Bye"));
 }
 
+die(throw new \\Exception('In Statement'));
+$throws = fn() => throw new \\RuntimeException('In arrow function');
+$value = $a ? $a : throw new \\InvalidArgumentException('In ternary');
 =====================================output=====================================
 <?php
 
@@ -3191,6 +3194,10 @@ if (!$var) {
     throw new \\Exception("Bye");
 }
 
+die(throw new \\Exception("In Statement"));
+$throws = fn() => throw new \\RuntimeException("In arrow function");
+$value = $a ? $a : throw new \\InvalidArgumentException("In ternary");
+
 ================================================================================
 `;
 

tests/parens/throw.php

@@ -15,3 +15,7 @@
     throw new \Exception("Bye");
     throw (new \Exception("Bye"));
 }
+
+die(throw new \Exception('In Statement'));
+$throws = fn() => throw new \RuntimeException('In arrow function');
+$value = $a ? $a : throw new \InvalidArgumentException('In ternary');

tests/uniontypes/__snapshots__/jsfmt.spec.js.snap

@@ -0,0 +1,48 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`union.php 1`] = `
+====================================options=====================================
+parsers: ["php"]
+phpVersion: "8.0"
+printWidth: 80
+                                                                                | printWidth
+=====================================input======================================
+<?php
+function a(int|float $a):int|float {}
+
+class UnionClass {
+    public int|float $v = 0;
+
+    public function __construct(public bool|int $flag) {}
+
+    public function get():bool|int|float {}
+}
+
+interface UnionInterface { function do(string|int $in):string|bool; }
+
+=====================================output=====================================
+<?php
+function a(int|float $a): int|float
+{
+}
+
+class UnionClass
+{
+    public int|float $v = 0;
+
+    public function __construct(public bool|int $flag)
+    {
+    }
+
+    public function get(): bool|int|float
+    {
+    }
+}
+
+interface UnionInterface
+{
+    function do(string|int $in): string|bool;
+}
+
+================================================================================
+`;