Chris@13: <?php
Chris@13: 
Chris@13: /*
Chris@13:  * This file is part of Psy Shell.
Chris@13:  *
Chris@13:  * (c) 2012-2018 Justin Hileman
Chris@13:  *
Chris@13:  * For the full copyright and license information, please view the LICENSE
Chris@13:  * file that was distributed with this source code.
Chris@13:  */
Chris@13: 
Chris@13: namespace Psy\Test\Util;
Chris@13: 
Chris@13: use Psy\Util\Docblock;
Chris@13: 
Chris@13: class DocblockTest extends \PHPUnit\Framework\TestCase
Chris@13: {
Chris@13:     /**
Chris@13:      * @dataProvider comments
Chris@13:      */
Chris@13:     public function testDocblockParsing($comment, $body, $tags)
Chris@13:     {
Chris@13:         $reflector = $this
Chris@13:             ->getMockBuilder('ReflectionClass')
Chris@13:             ->disableOriginalConstructor()
Chris@13:             ->getMock();
Chris@13: 
Chris@13:         $reflector->expects($this->once())
Chris@13:             ->method('getDocComment')
Chris@13:             ->will($this->returnValue($comment));
Chris@13: 
Chris@13:         $docblock = new Docblock($reflector);
Chris@13: 
Chris@13:         $this->assertSame($body, $docblock->desc);
Chris@13: 
Chris@13:         foreach ($tags as $tag => $value) {
Chris@13:             $this->assertTrue($docblock->hasTag($tag));
Chris@13:             $this->assertEquals($value, $docblock->tag($tag));
Chris@13:         }
Chris@13:     }
Chris@13: 
Chris@13:     public function comments()
Chris@13:     {
Chris@17:         if (\defined('HHVM_VERSION')) {
Chris@13:             $this->markTestSkipped('We have issues with PHPUnit mocks on HHVM.');
Chris@13:         }
Chris@13: 
Chris@13:         return [
Chris@13:             ['', '', []],
Chris@13:             [
Chris@13:                 '/**
Chris@13:                  * This is a docblock
Chris@13:                  *
Chris@13:                  * @throws \Exception with a description
Chris@13:                  */',
Chris@13:                 'This is a docblock',
Chris@13:                 [
Chris@13:                     'throws' => [['type' => '\Exception', 'desc' => 'with a description']],
Chris@13:                 ],
Chris@13:             ],
Chris@13:             [
Chris@13:                 '/**
Chris@13:                  * This is a slightly longer docblock
Chris@13:                  *
Chris@13:                  * @param int         $foo Is a Foo
Chris@13:                  * @param string      $bar With some sort of description
Chris@13:                  * @param \ClassName $baz is cool too
Chris@13:                  *
Chris@13:                  * @return int At least it isn\'t a string
Chris@13:                  */',
Chris@13:                 'This is a slightly longer docblock',
Chris@13:                 [
Chris@13:                     'param' => [
Chris@13:                         ['type' => 'int', 'desc' => 'Is a Foo', 'var' => '$foo'],
Chris@13:                         ['type' => 'string', 'desc' => 'With some sort of description', 'var' => '$bar'],
Chris@13:                         ['type' => '\ClassName', 'desc' => 'is cool too', 'var' => '$baz'],
Chris@13:                     ],
Chris@13:                     'return' => [
Chris@13:                         ['type' => 'int', 'desc' => 'At least it isn\'t a string'],
Chris@13:                     ],
Chris@13:                 ],
Chris@13:             ],
Chris@13:             [
Chris@13:                 '/**
Chris@13:                  * This is a docblock!
Chris@13:                  *
Chris@13:                  * It spans lines, too!
Chris@13:                  *
Chris@13:                  * @tagname plus a description
Chris@13:                  *
Chris@13:                  * @return
Chris@13:                  */',
Chris@13:                 "This is a docblock!\n\nIt spans lines, too!",
Chris@13:                 [
Chris@13:                     'tagname' => ['plus a description'],
Chris@13:                 ],
Chris@13:             ],
Chris@13:         ];
Chris@13:     }
Chris@13: }