add closure node

Author: ichiriac

docs/AST.md

@@ -2,44 +2,6 @@
 
 # AST
 
-The AST builder class
-
-**Parameters**
-
--   `withPositions`  
--   `withSource`  
-
-**Properties**
-
--   `withPositions` **[Boolean](#boolean)** Should locate any node (by default false)
--   `withSource` **[Boolean](#boolean)** Should extract the node original code (by default false)
-
-## position
-
-Create a position node from specified parser
-including it's lexer current state
-
-**Parameters**
-
--   `Parser`  
--   `parser`  
-
-Returns **[Position](#position)** 
-
-## prepare
-
-Prepares an AST node
-
-**Parameters**
-
--   `kind` **([String](#string) | null)** Defines the node type
-    (if null, the kind must be passed at the function call)
--   `parser` **Parser** The parser instance (use for extracting locations)
-
-Returns **[Function](#function)** 
-
-# AST
-
 ## Class hierarchy
 
 -   [Location](#location)
@@ -91,6 +53,7 @@ Returns **[Function](#function)**
         -   [Try](#try)
         -   [Catch](#catch)
         -   [Call](#call)
+        -   [Closure](#closure)
         -   [New](#new)
         -   [UseGroup](#usegroup)
         -   [UseItem](#useitem)
@@ -146,6 +109,44 @@ Prepares an AST node
 
 Returns **[Function](#function)** 
 
+# AST
+
+The AST builder class
+
+**Parameters**
+
+-   `withPositions`  
+-   `withSource`  
+
+**Properties**
+
+-   `withPositions` **[Boolean](#boolean)** Should locate any node (by default false)
+-   `withSource` **[Boolean](#boolean)** Should extract the node original code (by default false)
+
+## position
+
+Create a position node from specified parser
+including it's lexer current state
+
+**Parameters**
+
+-   `Parser`  
+-   `parser`  
+
+Returns **[Position](#position)** 
+
+## prepare
+
+Prepares an AST node
+
+**Parameters**
+
+-   `kind` **([String](#string) | null)** Defines the node type
+    (if null, the kind must be passed at the function call)
+-   `parser` **Parser** The parser instance (use for extracting locations)
+
+Returns **[Function](#function)** 
+
 # Array
 
 **Extends Expression**
@@ -307,6 +308,20 @@ Defines a clone call
 
 -   `what` **[Expression](#expression)** 
 
+# Closure
+
+**Extends Statement**
+
+Defines a closure
+
+**Properties**
+
+-   `arguments` **[Array](#array)<[Parameter](#parameter)>** 
+-   `type` **[Identifier](#identifier)** 
+-   `byref` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
+-   `nullable` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
+-   `body` **([Block](#block) | null)** 
+
 # Coalesce
 
 **Extends Operation**

src/ast.js

@@ -59,6 +59,7 @@ var Position = require('./ast/position');
  *     - [Try](#try)
  *     - [Catch](#catch)
  *     - [Call](#call)
+ *     - [Closure](#closure)
  *     - [New](#new)
  *     - [UseGroup](#usegroup)
  *     - [UseItem](#useitem)
@@ -178,6 +179,7 @@ AST.prototype.prepare = function(kind, parser) {
   require('./ast/class'),
   require('./ast/classconstant'),
   require('./ast/clone'),
+  require('./ast/closure'),
   require('./ast/coalesce'),
   require('./ast/constant'),
   require('./ast/constref'),

src/ast/closure.js

@@ -0,0 +1,29 @@
+/*!
+ * Copyright (C) 2017 Glayzzle (BSD3 License)
+ * @authors https://github.com/glayzzle/php-parser/graphs/contributors
+ * @url http://glayzzle.com
+ */
+"use strict";
+var Statement = require('./statement');
+var KIND = 'closure';
+
+/**
+ * Defines a closure
+ * @constructor Closure
+ * @extends {Statement}
+ * @property {Parameter[]} arguments
+ * @property {Identifier} type
+ * @property {boolean} byref
+ * @property {boolean} nullable
+ * @property {Block|null} body
+ */
+var Closure = Statement.extends(function Closure(args, byref, type, nullable, location) {
+  Statement.apply(this, [KIND, location]);
+  this.arguments = args;
+  this.byref = byref;
+  this.type = type;
+  this.nullable = nullable;
+  this.body = null;
+});
+
+module.exports = Closure;

test/astTests.js

@@ -10,15 +10,15 @@ describe('Test AST structure', function() {
   });
 
   it('test withSource options', function() {
-    var ast = parser.parseEval('true;', {
+    var ast = parser.parseEval('$a = true;', {
       ast: {
         withSource: true
       }
     });
     // @todo
   });
   it('test withPositions options', function() {
-    var ast = parser.parseEval('true;', {
+    var ast = parser.parseEval('$a = true;', {
       ast: {
         withPositions: true
       }

test/functionTests.js

@@ -2,9 +2,12 @@ var should = require("should");
 var parser = require('../src/index');
 
 describe('Function tests', function() {
-  var ast = parser.parseEval(
-    'function &foo($a = 1, callable $b, ?array &...$params) : ?boolean {}'
-  );
+  var ast = parser.parseEval([
+    'function &foo($a = 1, callable $b, ?array &...$params) : ?boolean {}',
+    '$a = function &($b) use($c) : array {',
+    '  return true;',
+    '};'
+  ].join('\n'));
 
   it('test description', function () {
     // Get result from parser
@@ -38,5 +41,12 @@ describe('Function tests', function() {
     */
   });
 
+  it('test closure', function () {
+    // @todo
+    ast.children[1].right.kind.should.be.exactly('closure');
+    var fn = ast.children[1].right;
+    fn.byref.should.be.exactly(true);
+  });
+
 
 });