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