arunfung / laravel-package-develop

     * @uses         phpDocumentor\Reflection\DocBlock\Description

     * @dataProvider provideSimpleExampleDescriptions

     */

    public function testDescriptionCanParseASimpleString($contents)

    {

        $tagFactory = m::mock(TagFactory::class);

        $tagFactory->shouldReceive('create')->never();

        $factory     = new DescriptionFactory($tagFactory);

        $description = $factory->create($contents, new Context(''));

        $this->assertSame($contents, $description->render());

    }

    /**

     * @covers ::__construct

     * @uses         phpDocumentor\Reflection\DocBlock\Description

     * @dataProvider provideEscapeSequences

     */

    public function testEscapeSequences($contents, $expected)

    {

        $tagFactory = m::mock(TagFactory::class);

        $tagFactory->shouldReceive('create')->never();

        $factory     = new DescriptionFactory($tagFactory);

        $description = $factory->create($contents, new Context(''));

        $this->assertSame($expected, $description->render());

    }

    /**

     * @covers ::__construct

     * @covers ::create

     * @uses   phpDocumentor\Reflection\DocBlock\Description

     */

    public function testIfSuperfluousStartingSpacesAreRemoved()

    {

        $factory         = new DescriptionFactory(m::mock(TagFactory::class));

        $descriptionText = <<<DESCRIPTION

This is a multiline

  description that you commonly

  see with tags.

      It does have a multiline code sample

      that should align, no matter what

  All spaces superfluous spaces on the

  second and later lines should be

  removed but the code sample should

  still be indented.

DESCRIPTION;

        $expectedDescription = <<<DESCRIPTION

This is a multiline

description that you commonly

see with tags.

    It does have a multiline code sample

    that should align, no matter what

All spaces superfluous spaces on the

second and later lines should be

removed but the code sample should

still be indented.

DESCRIPTION;

        $description = $factory->create($descriptionText, new Context(''));

        $this->assertSame($expectedDescription, $description->render());

    }

    /**

     * Provides a series of example strings that the parser should correctly interpret and return.