123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275 |
- <?php
- namespace PhpParser;
- class DummyNode extends NodeAbstract {
- public $subNode1;
- public $subNode2;
- public function __construct($subNode1, $subNode2, $attributes) {
- parent::__construct($attributes);
- $this->subNode1 = $subNode1;
- $this->subNode2 = $subNode2;
- }
- public function getSubNodeNames() {
- return array('subNode1', 'subNode2');
- }
- // This method is only overwritten because the node is located in an unusual namespace
- public function getType() {
- return 'Dummy';
- }
- }
- class NodeAbstractTest extends \PHPUnit_Framework_TestCase
- {
- public function provideNodes() {
- $attributes = array(
- 'startLine' => 10,
- 'comments' => array(
- new Comment('// Comment' . "\n"),
- new Comment\Doc('/** doc comment */'),
- ),
- );
- $node = new DummyNode('value1', 'value2', $attributes);
- $node->notSubNode = 'value3';
- return array(
- array($attributes, $node),
- );
- }
- /**
- * @dataProvider provideNodes
- */
- public function testConstruct(array $attributes, Node $node) {
- $this->assertSame('Dummy', $node->getType());
- $this->assertSame(array('subNode1', 'subNode2'), $node->getSubNodeNames());
- $this->assertSame(10, $node->getLine());
- $this->assertSame('/** doc comment */', $node->getDocComment()->getText());
- $this->assertSame('value1', $node->subNode1);
- $this->assertSame('value2', $node->subNode2);
- $this->assertTrue(isset($node->subNode1));
- $this->assertTrue(isset($node->subNode2));
- $this->assertFalse(isset($node->subNode3));
- $this->assertSame($attributes, $node->getAttributes());
- return $node;
- }
- /**
- * @dataProvider provideNodes
- */
- public function testGetDocComment(array $attributes, Node $node) {
- $this->assertSame('/** doc comment */', $node->getDocComment()->getText());
- array_pop($node->getAttribute('comments')); // remove doc comment
- $this->assertNull($node->getDocComment());
- array_pop($node->getAttribute('comments')); // remove comment
- $this->assertNull($node->getDocComment());
- }
- public function testSetDocComment() {
- $node = new DummyNode(null, null, []);
- // Add doc comment to node without comments
- $docComment = new Comment\Doc('/** doc */');
- $node->setDocComment($docComment);
- $this->assertSame($docComment, $node->getDocComment());
- // Replace it
- $docComment = new Comment\Doc('/** doc 2 */');
- $node->setDocComment($docComment);
- $this->assertSame($docComment, $node->getDocComment());
- // Add docmment to node with other comments
- $c1 = new Comment('/* foo */');
- $c2 = new Comment('/* bar */');
- $docComment = new Comment\Doc('/** baz */');
- $node->setAttribute('comments', [$c1, $c2]);
- $node->setDocComment($docComment);
- $this->assertSame([$c1, $c2, $docComment], $node->getAttribute('comments'));
- }
- /**
- * @dataProvider provideNodes
- */
- public function testChange(array $attributes, Node $node) {
- // change of line
- $node->setLine(15);
- $this->assertSame(15, $node->getLine());
- // direct modification
- $node->subNode = 'newValue';
- $this->assertSame('newValue', $node->subNode);
- // indirect modification
- $subNode =& $node->subNode;
- $subNode = 'newNewValue';
- $this->assertSame('newNewValue', $node->subNode);
- // removal
- unset($node->subNode);
- $this->assertFalse(isset($node->subNode));
- }
- /**
- * @dataProvider provideNodes
- */
- public function testIteration(array $attributes, Node $node) {
- // Iteration is simple object iteration over properties,
- // not over subnodes
- $i = 0;
- foreach ($node as $key => $value) {
- if ($i === 0) {
- $this->assertSame('subNode1', $key);
- $this->assertSame('value1', $value);
- } else if ($i === 1) {
- $this->assertSame('subNode2', $key);
- $this->assertSame('value2', $value);
- } else if ($i === 2) {
- $this->assertSame('notSubNode', $key);
- $this->assertSame('value3', $value);
- } else {
- throw new \Exception;
- }
- $i++;
- }
- $this->assertSame(3, $i);
- }
- public function testAttributes() {
- /** @var $node Node */
- $node = $this->getMockForAbstractClass('PhpParser\NodeAbstract');
- $this->assertEmpty($node->getAttributes());
- $node->setAttribute('key', 'value');
- $this->assertTrue($node->hasAttribute('key'));
- $this->assertSame('value', $node->getAttribute('key'));
- $this->assertFalse($node->hasAttribute('doesNotExist'));
- $this->assertNull($node->getAttribute('doesNotExist'));
- $this->assertSame('default', $node->getAttribute('doesNotExist', 'default'));
- $node->setAttribute('null', null);
- $this->assertTrue($node->hasAttribute('null'));
- $this->assertNull($node->getAttribute('null'));
- $this->assertNull($node->getAttribute('null', 'default'));
- $this->assertSame(
- array(
- 'key' => 'value',
- 'null' => null,
- ),
- $node->getAttributes()
- );
- }
- public function testJsonSerialization() {
- $code = <<<'PHP'
- <?php
- // comment
- /** doc comment */
- function functionName(&$a = 0, $b = 1.0) {
- echo 'Foo';
- }
- PHP;
- $expected = <<<'JSON'
- [
- {
- "nodeType": "Stmt_Function",
- "byRef": false,
- "name": "functionName",
- "params": [
- {
- "nodeType": "Param",
- "type": null,
- "byRef": true,
- "variadic": false,
- "name": "a",
- "default": {
- "nodeType": "Scalar_LNumber",
- "value": 0,
- "attributes": {
- "startLine": 4,
- "endLine": 4,
- "kind": 10
- }
- },
- "attributes": {
- "startLine": 4,
- "endLine": 4
- }
- },
- {
- "nodeType": "Param",
- "type": null,
- "byRef": false,
- "variadic": false,
- "name": "b",
- "default": {
- "nodeType": "Scalar_DNumber",
- "value": 1,
- "attributes": {
- "startLine": 4,
- "endLine": 4
- }
- },
- "attributes": {
- "startLine": 4,
- "endLine": 4
- }
- }
- ],
- "returnType": null,
- "stmts": [
- {
- "nodeType": "Stmt_Echo",
- "exprs": [
- {
- "nodeType": "Scalar_String",
- "value": "Foo",
- "attributes": {
- "startLine": 5,
- "endLine": 5,
- "kind": 1
- }
- }
- ],
- "attributes": {
- "startLine": 5,
- "endLine": 5
- }
- }
- ],
- "attributes": {
- "startLine": 4,
- "comments": [
- {
- "nodeType": "Comment",
- "text": "\/\/ comment\n",
- "line": 2,
- "filePos": 6
- },
- {
- "nodeType": "Comment_Doc",
- "text": "\/** doc comment *\/",
- "line": 3,
- "filePos": 17
- }
- ],
- "endLine": 6
- }
- }
- ]
- JSON;
- $parser = new Parser\Php7(new Lexer());
- $stmts = $parser->parse(canonicalize($code));
- $json = json_encode($stmts, JSON_PRETTY_PRINT);
- $this->assertEquals(canonicalize($expected), canonicalize($json));
- }
- }
|