Chris@0: <?php
Chris@0: 
Chris@0: namespace PhpParser;
Chris@0: 
Chris@0: use PhpParser\Comment;
Chris@0: use PhpParser\Node\Expr;
Chris@0: use PhpParser\Node\Scalar;
Chris@0: use PhpParser\Node\Scalar\String_;
Chris@0: 
Chris@0: abstract class ParserTest extends \PHPUnit_Framework_TestCase
Chris@0: {
Chris@0:     /** @returns Parser */
Chris@0:     abstract protected function getParser(Lexer $lexer);
Chris@0: 
Chris@0:     /**
Chris@0:      * @expectedException \PhpParser\Error
Chris@0:      * @expectedExceptionMessage Syntax error, unexpected EOF on line 1
Chris@0:      */
Chris@0:     public function testParserThrowsSyntaxError() {
Chris@0:         $parser = $this->getParser(new Lexer());
Chris@0:         $parser->parse('<?php foo');
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @expectedException \PhpParser\Error
Chris@0:      * @expectedExceptionMessage Cannot use foo as self because 'self' is a special class name on line 1
Chris@0:      */
Chris@0:     public function testParserThrowsSpecialError() {
Chris@0:         $parser = $this->getParser(new Lexer());
Chris@0:         $parser->parse('<?php use foo as self;');
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @expectedException \PhpParser\Error
Chris@0:      * @expectedExceptionMessage Unterminated comment on line 1
Chris@0:      */
Chris@0:     public function testParserThrowsLexerError() {
Chris@0:         $parser = $this->getParser(new Lexer());
Chris@0:         $parser->parse('<?php /*');
Chris@0:     }
Chris@0: 
Chris@0:     public function testAttributeAssignment() {
Chris@0:         $lexer = new Lexer(array(
Chris@0:             'usedAttributes' => array(
Chris@0:                 'comments', 'startLine', 'endLine',
Chris@0:                 'startTokenPos', 'endTokenPos',
Chris@0:             )
Chris@0:         ));
Chris@0: 
Chris@0:         $code = <<<'EOC'
Chris@0: <?php
Chris@0: /** Doc comment */
Chris@0: function test($a) {
Chris@0:     // Line
Chris@0:     // Comments
Chris@0:     echo $a;
Chris@0: }
Chris@0: EOC;
Chris@0:         $code = canonicalize($code);
Chris@0: 
Chris@0:         $parser = $this->getParser($lexer);
Chris@0:         $stmts = $parser->parse($code);
Chris@0: 
Chris@0:         /** @var \PhpParser\Node\Stmt\Function_ $fn */
Chris@0:         $fn = $stmts[0];
Chris@0:         $this->assertInstanceOf('PhpParser\Node\Stmt\Function_', $fn);
Chris@0:         $this->assertEquals(array(
Chris@0:             'comments' => array(
Chris@0:                 new Comment\Doc('/** Doc comment */', 2, 6),
Chris@0:             ),
Chris@0:             'startLine' => 3,
Chris@0:             'endLine' => 7,
Chris@0:             'startTokenPos' => 3,
Chris@0:             'endTokenPos' => 21,
Chris@0:         ), $fn->getAttributes());
Chris@0: 
Chris@0:         $param = $fn->params[0];
Chris@0:         $this->assertInstanceOf('PhpParser\Node\Param', $param);
Chris@0:         $this->assertEquals(array(
Chris@0:             'startLine' => 3,
Chris@0:             'endLine' => 3,
Chris@0:             'startTokenPos' => 7,
Chris@0:             'endTokenPos' => 7,
Chris@0:         ), $param->getAttributes());
Chris@0: 
Chris@0:         /** @var \PhpParser\Node\Stmt\Echo_ $echo */
Chris@0:         $echo = $fn->stmts[0];
Chris@0:         $this->assertInstanceOf('PhpParser\Node\Stmt\Echo_', $echo);
Chris@0:         $this->assertEquals(array(
Chris@0:             'comments' => array(
Chris@0:                 new Comment("// Line\n", 4, 49),
Chris@0:                 new Comment("// Comments\n", 5, 61),
Chris@0:             ),
Chris@0:             'startLine' => 6,
Chris@0:             'endLine' => 6,
Chris@0:             'startTokenPos' => 16,
Chris@0:             'endTokenPos' => 19,
Chris@0:         ), $echo->getAttributes());
Chris@0: 
Chris@0:         /** @var \PhpParser\Node\Expr\Variable $var */
Chris@0:         $var = $echo->exprs[0];
Chris@0:         $this->assertInstanceOf('PhpParser\Node\Expr\Variable', $var);
Chris@0:         $this->assertEquals(array(
Chris@0:             'startLine' => 6,
Chris@0:             'endLine' => 6,
Chris@0:             'startTokenPos' => 18,
Chris@0:             'endTokenPos' => 18,
Chris@0:         ), $var->getAttributes());
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @expectedException \RangeException
Chris@0:      * @expectedExceptionMessage The lexer returned an invalid token (id=999, value=foobar)
Chris@0:      */
Chris@0:     public function testInvalidToken() {
Chris@0:         $lexer = new InvalidTokenLexer;
Chris@0:         $parser = $this->getParser($lexer);
Chris@0:         $parser->parse('dummy');
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @dataProvider provideTestExtraAttributes
Chris@0:      */
Chris@0:     public function testExtraAttributes($code, $expectedAttributes) {
Chris@0:         $parser = $this->getParser(new Lexer);
Chris@0:         $stmts = $parser->parse("<?php $code;");
Chris@0:         $attributes = $stmts[0]->getAttributes();
Chris@0:         foreach ($expectedAttributes as $name => $value) {
Chris@0:             $this->assertSame($value, $attributes[$name]);
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     public function provideTestExtraAttributes() {
Chris@0:         return array(
Chris@0:             array('0', ['kind' => Scalar\LNumber::KIND_DEC]),
Chris@0:             array('9', ['kind' => Scalar\LNumber::KIND_DEC]),
Chris@0:             array('07', ['kind' => Scalar\LNumber::KIND_OCT]),
Chris@0:             array('0xf', ['kind' => Scalar\LNumber::KIND_HEX]),
Chris@0:             array('0XF', ['kind' => Scalar\LNumber::KIND_HEX]),
Chris@0:             array('0b1', ['kind' => Scalar\LNumber::KIND_BIN]),
Chris@0:             array('0B1', ['kind' => Scalar\LNumber::KIND_BIN]),
Chris@0:             array('[]', ['kind' => Expr\Array_::KIND_SHORT]),
Chris@0:             array('array()', ['kind' => Expr\Array_::KIND_LONG]),
Chris@0:             array("'foo'", ['kind' => String_::KIND_SINGLE_QUOTED]),
Chris@0:             array("b'foo'", ['kind' => String_::KIND_SINGLE_QUOTED]),
Chris@0:             array("B'foo'", ['kind' => String_::KIND_SINGLE_QUOTED]),
Chris@0:             array('"foo"', ['kind' => String_::KIND_DOUBLE_QUOTED]),
Chris@0:             array('b"foo"', ['kind' => String_::KIND_DOUBLE_QUOTED]),
Chris@0:             array('B"foo"', ['kind' => String_::KIND_DOUBLE_QUOTED]),
Chris@0:             array('"foo$bar"', ['kind' => String_::KIND_DOUBLE_QUOTED]),
Chris@0:             array('b"foo$bar"', ['kind' => String_::KIND_DOUBLE_QUOTED]),
Chris@0:             array('B"foo$bar"', ['kind' => String_::KIND_DOUBLE_QUOTED]),
Chris@0:             array("<<<'STR'\nSTR\n", ['kind' => String_::KIND_NOWDOC, 'docLabel' => 'STR']),
Chris@0:             array("<<<STR\nSTR\n", ['kind' => String_::KIND_HEREDOC, 'docLabel' => 'STR']),
Chris@0:             array("<<<\"STR\"\nSTR\n", ['kind' => String_::KIND_HEREDOC, 'docLabel' => 'STR']),
Chris@0:             array("b<<<'STR'\nSTR\n", ['kind' => String_::KIND_NOWDOC, 'docLabel' => 'STR']),
Chris@0:             array("B<<<'STR'\nSTR\n", ['kind' => String_::KIND_NOWDOC, 'docLabel' => 'STR']),
Chris@0:             array("<<< \t 'STR'\nSTR\n", ['kind' => String_::KIND_NOWDOC, 'docLabel' => 'STR']),
Chris@0:             // HHVM doesn't support this due to a lexer bug
Chris@0:             // (https://github.com/facebook/hhvm/issues/6970)
Chris@0:             // array("<<<'\xff'\n\xff\n", ['kind' => String_::KIND_NOWDOC, 'docLabel' => "\xff"]),
Chris@0:             array("<<<\"STR\"\n\$a\nSTR\n", ['kind' => String_::KIND_HEREDOC, 'docLabel' => 'STR']),
Chris@0:             array("b<<<\"STR\"\n\$a\nSTR\n", ['kind' => String_::KIND_HEREDOC, 'docLabel' => 'STR']),
Chris@0:             array("B<<<\"STR\"\n\$a\nSTR\n", ['kind' => String_::KIND_HEREDOC, 'docLabel' => 'STR']),
Chris@0:             array("<<< \t \"STR\"\n\$a\nSTR\n", ['kind' => String_::KIND_HEREDOC, 'docLabel' => 'STR']),
Chris@0:             array("die", ['kind' => Expr\Exit_::KIND_DIE]),
Chris@0:             array("die('done')", ['kind' => Expr\Exit_::KIND_DIE]),
Chris@0:             array("exit", ['kind' => Expr\Exit_::KIND_EXIT]),
Chris@0:             array("exit(1)", ['kind' => Expr\Exit_::KIND_EXIT]),
Chris@0:             array("?>Foo", ['hasLeadingNewline' => false]),
Chris@0:             array("?>\nFoo", ['hasLeadingNewline' => true]),
Chris@0:             array("namespace Foo;", ['kind' => Node\Stmt\Namespace_::KIND_SEMICOLON]),
Chris@0:             array("namespace Foo {}", ['kind' => Node\Stmt\Namespace_::KIND_BRACED]),
Chris@0:             array("namespace {}", ['kind' => Node\Stmt\Namespace_::KIND_BRACED]),
Chris@0:         );
Chris@0:     }
Chris@0: }
Chris@0: 
Chris@0: class InvalidTokenLexer extends Lexer {
Chris@0:     public function getNextToken(&$value = null, &$startAttributes = null, &$endAttributes = null) {
Chris@0:         $value = 'foobar';
Chris@0:         return 999;
Chris@0:     }
Chris@0: }