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