mirrors/barryvdh_ReflectionDocBlock
1
0
Fork 0
mirror of https://github.com/barryvdh/ReflectionDocBlock.git synced 2026-08-18 10:07:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

Limit characters after tag name

Browse Source 
Previously we allowed all characters after a tag name which made
it a bit fuzzy how tags are handled. Psr-5 is more strict about
the characters that are allowed in tags and those that are part of
the body. A tag name can now be followed by `(`, <space> and `{` all
other characters are forbidden. The first character of the body is
not restricted anymore.

fixes #165
This commit is contained in:
Jaapio
2020-02-09 08:52:29 +01:00
parent 6a88d1ae42
commit ed7b7919e3
2 changed files with 90 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/unit/DocBlock/StandardTagFactoryTest.php
+87
View File
@@ -13,6 +13,7 @@ declare(strict_types=1);
namespace phpDocumentor\Reflection\DocBlock;
use InvalidArgumentException;
use Mockery as m;
use phpDocumentor\Reflection\DocBlock\Tags\Author;
use phpDocumentor\Reflection\DocBlock\Tags\Formatter;
@@ -341,4 +342,90 @@ class StandardTagFactoryTest extends TestCase
$this->assertInstanceOf(InvalidTag::class, $tag);
}
/**
* @dataProvider validTagProvider
*/
public function testValidFormattedTags(string $input, string $tagName, string $render) : void
{
$fqsenResolver = $this->prophesize(FqsenResolver::class);
$tagFactory = new StandardTagFactory($fqsenResolver->reveal());
$tagFactory->registerTagHandler('tag', Generic::class);
$tag = $tagFactory->create($input);
self::assertSame($tagName, $tag->getName());
self::assertSame($render, $tag->render());
}
/**
* @return string[][]
*
* @phpstan-return array<string, array<int, string>>
*/
public function validTagProvider() : array
{
//rendered result is adding a space, because the tags are not rendered properly.
return [
'tag without body' => [
'@tag',
'tag',
'@tag',
],
'tag specialization' => [
'@tag:some-spec',
'tag',
'@tag :some-spec',
],
'tag with textual description' => [
'@tag some text',
'tag',
'@tag some text',
],
'tag [a]' => [
'@tag [is valid]',
'tag',
'@tag [is valid]',
],
'tag {a}' => [
'@tag {is valid}',
'tag',
'@tag {is valid}',
],
'tag{a}' => [
'@tag{is valid}',
'tag',
'@tag {is valid}',
],
'tag(a)' => [
'@tag(is valid)',
'tag',
'@tag (is valid)',
],
];
}
/**
* @dataProvider invalidTagProvider
*/
public function testInValidFormattedTags(string $input) : void
{
$this->expectException(InvalidArgumentException::class);
$fqsenResolver = $this->prophesize(FqsenResolver::class);
$tagFactory = new StandardTagFactory($fqsenResolver->reveal());
$tagFactory->registerTagHandler('tag', Generic::class);
$tagFactory->create($input);
}
/**
* @return string[][]
*
* @phpstan-return list<array<int, string>>
*/
public function invalidTagProvider() : array
{
return [
['@tag[invalid]'],
['@tag@invalid'],
];
}
}