Chris@0: <?php
Chris@0: 
Chris@0: /*
Chris@0:  * This file is part of Psy Shell.
Chris@0:  *
Chris@0:  * (c) 2012-2018 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\Formatter;
Chris@0: 
Chris@0: use Psy\Formatter\DocblockFormatter;
Chris@0: 
Chris@0: class DocblockFormatterTest extends \PHPUnit\Framework\TestCase
Chris@0: {
Chris@0:     /**
Chris@0:      * This is a docblock!
Chris@0:      *
Chris@0:      * @author Justin Hileman <justin@justinhileman.info>
Chris@0:      *
Chris@0:      * @throws InvalidArgumentException if $foo is empty
Chris@0:      *
Chris@0:      * @param mixed $foo It's a foo thing
Chris@0:      * @param int   $bar This is definitely bar
Chris@0:      *
Chris@0:      * @return string A string of no consequence
Chris@0:      */
Chris@0:     private function methodWithDocblock($foo, $bar = 1)
Chris@0:     {
Chris@0:         if (empty($foo)) {
Chris@0:             throw new \InvalidArgumentException();
Chris@0:         }
Chris@0: 
Chris@0:         return 'method called';
Chris@0:     }
Chris@0: 
Chris@0:     public function testFormat()
Chris@0:     {
Chris@0:         $expected = <<<EOS
Chris@0: <comment>Description:</comment>
Chris@0:   This is a docblock!
Chris@0: 
Chris@0: <comment>Throws:</comment>
Chris@0:   <info>InvalidArgumentException </info> if \$foo is empty
Chris@0: 
Chris@0: <comment>Param:</comment>
Chris@0:   <info>mixed </info> <strong>\$foo </strong> It's a foo thing
Chris@0:   <info>int   </info> <strong>\$bar </strong> This is definitely bar
Chris@0: 
Chris@0: <comment>Return:</comment>
Chris@0:   <info>string </info> A string of no consequence
Chris@0: 
Chris@0: <comment>Author:</comment> Justin Hileman \<justin@justinhileman.info>
Chris@0: EOS;
Chris@0: 
Chris@0:         $this->assertSame(
Chris@0:             $expected,
Chris@0:             DocblockFormatter::format(new \ReflectionMethod($this, 'methodWithDocblock'))
Chris@0:         );
Chris@0:     }
Chris@0: }