apply coding standard to code

This commit is contained in:
TomasVotruba
2018-01-02 13:40:57 +01:00
parent 89a0935960
commit 1c8f795c0e
45 changed files with 212 additions and 216 deletions
+2 -2
View File
@@ -156,7 +156,7 @@ class DescriptionFactory
// determine how many whitespace characters need to be stripped // determine how many whitespace characters need to be stripped
$startingSpaceCount = 9999999; $startingSpaceCount = 9999999;
for ($i = 1; $i < count($lines); $i++) { for ($i = 1; $i < count($lines); ++$i) {
// lines with a no length do not count as they are not indented at all // lines with a no length do not count as they are not indented at all
if (strlen(trim($lines[$i])) === 0) { if (strlen(trim($lines[$i])) === 0) {
continue; continue;
@@ -169,7 +169,7 @@ class DescriptionFactory
// strip the number of spaces from each line // strip the number of spaces from each line
if ($startingSpaceCount > 0) { if ($startingSpaceCount > 0) {
for ($i = 1; $i < count($lines); $i++) { for ($i = 1; $i < count($lines); ++$i) {
$lines[$i] = substr($lines[$i], $startingSpaceCount); $lines[$i] = substr($lines[$i], $startingSpaceCount);
} }
} }
+1 -1
View File
@@ -105,7 +105,7 @@ class Serializer
private function getSummaryAndDescriptionTextBlock(DocBlock $docblock, $wrapLength): string private function getSummaryAndDescriptionTextBlock(DocBlock $docblock, $wrapLength): string
{ {
$text = $docblock->getSummary() . ((string)$docblock->getDescription() ? "\n\n" . $docblock->getDescription() $text = $docblock->getSummary() . ((string) $docblock->getDescription() ? "\n\n" . $docblock->getDescription()
: ''); : '');
if ($wrapLength !== null) { if ($wrapLength !== null) {
$text = wordwrap($text, $wrapLength); $text = wordwrap($text, $wrapLength);
+2 -2
View File
@@ -63,7 +63,7 @@ final class StandardTagFactory implements TagFactory
'throws' => '\phpDocumentor\Reflection\DocBlock\Tags\Throws', 'throws' => '\phpDocumentor\Reflection\DocBlock\Tags\Throws',
'uses' => '\phpDocumentor\Reflection\DocBlock\Tags\Uses', 'uses' => '\phpDocumentor\Reflection\DocBlock\Tags\Uses',
'var' => '\phpDocumentor\Reflection\DocBlock\Tags\Var_', 'var' => '\phpDocumentor\Reflection\DocBlock\Tags\Var_',
'version' => '\phpDocumentor\Reflection\DocBlock\Tags\Version' 'version' => '\phpDocumentor\Reflection\DocBlock\Tags\Version',
]; ];
/** /**
@@ -278,7 +278,7 @@ final class StandardTagFactory implements TagFactory
[ [
'name' => $tagName, 'name' => $tagName,
'body' => $tagBody, 'body' => $tagBody,
TypeContext::class => $context TypeContext::class => $context,
] ]
); );
+4 -4
View File
@@ -69,7 +69,7 @@ final class Example extends BaseTag
if ($this->isURI) { if ($this->isURI) {
$filePath = $this->isUriRelative($this->filePath) $filePath = $this->isUriRelative($this->filePath)
? str_replace('%2F', '/', rawurlencode($this->filePath)) ? str_replace('%2F', '/', rawurlencode($this->filePath))
:$this->filePath; : $this->filePath;
} }
return trim($filePath . ' ' . parent::getDescription()); return trim($filePath . ' ' . parent::getDescription());
@@ -105,9 +105,9 @@ final class Example extends BaseTag
// Starting line / Number of lines / Description // Starting line / Number of lines / Description
if (preg_match('/^([1-9]\d*)(?:\s+((?1))\s*)?(.*)$/sux', $matches[3], $contentMatches)) { if (preg_match('/^([1-9]\d*)(?:\s+((?1))\s*)?(.*)$/sux', $matches[3], $contentMatches)) {
$startingLine = (int)$contentMatches[1]; $startingLine = (int) $contentMatches[1];
if (isset($contentMatches[2]) && $contentMatches[2] !== '') { if (isset($contentMatches[2]) && $contentMatches[2] !== '') {
$lineCount = (int)$contentMatches[2]; $lineCount = (int) $contentMatches[2];
} }
if (array_key_exists(3, $contentMatches)) { if (array_key_exists(3, $contentMatches)) {
@@ -117,7 +117,7 @@ final class Example extends BaseTag
} }
return new static( return new static(
$filePath !== null?$filePath:$fileUri, $filePath !== null ? $filePath : $fileUri,
$fileUri !== null, $fileUri !== null,
$startingLine, $startingLine,
$lineCount, $lineCount,
@@ -39,6 +39,6 @@ class AlignFormatter implements Formatter
*/ */
public function format(Tag $tag): string public function format(Tag $tag): string
{ {
return '@' . $tag->getName() . str_repeat(' ', $this->maxLen - strlen($tag->getName()) + 1) . (string)$tag; return '@' . $tag->getName() . str_repeat(' ', $this->maxLen - strlen($tag->getName()) + 1) . (string) $tag;
} }
} }
@@ -23,6 +23,6 @@ class PassthroughFormatter implements Formatter
*/ */
public function format(Tag $tag): string public function format(Tag $tag): string
{ {
return trim('@' . $tag->getName() . ' ' . (string)$tag); return trim('@' . $tag->getName() . ' ' . (string) $tag);
} }
} }
+1 -1
View File
@@ -40,7 +40,7 @@ final class Link extends BaseTag implements Factory\StaticMethod
/** /**
* {@inheritdoc} * {@inheritdoc}
*/ */
public static function create(string $body, ?DescriptionFactory $descriptionFactory = null, ?TypeContext $context = null): Link public static function create(string $body, ?DescriptionFactory $descriptionFactory = null, ?TypeContext $context = null): self
{ {
Assert::notNull($descriptionFactory); Assert::notNull($descriptionFactory);
+5 -5
View File
@@ -71,7 +71,7 @@ final class Method extends BaseTag implements Factory\StaticMethod
?TypeContext $context = null ?TypeContext $context = null
): ?self { ): ?self {
Assert::stringNotEmpty($body); Assert::stringNotEmpty($body);
Assert::allNotNull([ $typeResolver, $descriptionFactory ]); Assert::allNotNull([$typeResolver, $descriptionFactory]);
// 1. none or more whitespace // 1. none or more whitespace
// 2. optionally the keyword "static" followed by whitespace // 2. optionally the keyword "static" followed by whitespace
@@ -150,7 +150,7 @@ final class Method extends BaseTag implements Factory\StaticMethod
} }
} }
$argument = [ 'name' => $argumentName, 'type' => $argumentType]; $argument = ['name' => $argumentName, 'type' => $argumentType];
} }
} else { } else {
$arguments = []; $arguments = [];
@@ -198,7 +198,7 @@ final class Method extends BaseTag implements Factory\StaticMethod
} }
return trim(($this->isStatic() ? 'static ' : '') return trim(($this->isStatic() ? 'static ' : '')
. (string)$this->returnType . ' ' . (string) $this->returnType . ' '
. $this->methodName . $this->methodName
. '(' . implode(', ', $arguments) . ')' . '(' . implode(', ', $arguments) . ')'
. ($this->description ? ' ' . $this->description->render() : '')); . ($this->description ? ' ' . $this->description->render() : ''));
@@ -208,7 +208,7 @@ final class Method extends BaseTag implements Factory\StaticMethod
{ {
foreach ($arguments as &$argument) { foreach ($arguments as &$argument) {
if (is_string($argument)) { if (is_string($argument)) {
$argument = [ 'name' => $argument ]; $argument = ['name' => $argument];
} }
if (! isset($argument['type'])) { if (! isset($argument['type'])) {
@@ -217,7 +217,7 @@ final class Method extends BaseTag implements Factory\StaticMethod
$keys = array_keys($argument); $keys = array_keys($argument);
sort($keys); sort($keys);
if ($keys !== [ 'name', 'type' ]) { if ($keys !== ['name', 'type']) {
throw new \InvalidArgumentException( throw new \InvalidArgumentException(
'Arguments can only have the "name" and "type" fields, found: ' . var_export($keys, true) 'Arguments can only have the "name" and "type" fields, found: ' . var_export($keys, true)
); );
+1 -1
View File
@@ -38,6 +38,6 @@ final class Fqsen implements Reference
*/ */
public function __toString(): string public function __toString(): string
{ {
return (string)$this->fqsen; return (string) $this->fqsen;
} }
} }
+4 -4
View File
@@ -37,8 +37,8 @@ final class Source extends BaseTag implements Factory\StaticMethod
Assert::integerish($startingLine); Assert::integerish($startingLine);
Assert::nullOrIntegerish($lineCount); Assert::nullOrIntegerish($lineCount);
$this->startingLine = (int)$startingLine; $this->startingLine = (int) $startingLine;
$this->lineCount = $lineCount !== null ? (int)$lineCount : null; $this->lineCount = $lineCount !== null ? (int) $lineCount : null;
$this->description = $description; $this->description = $description;
} }
@@ -59,9 +59,9 @@ final class Source extends BaseTag implements Factory\StaticMethod
// Starting line / Number of lines / Description // Starting line / Number of lines / Description
if (preg_match('/^([1-9]\d*)\s*(?:((?1))\s+)?(.*)$/sux', $body, $matches)) { if (preg_match('/^([1-9]\d*)\s*(?:((?1))\s+)?(.*)$/sux', $body, $matches)) {
$startingLine = (int)$matches[1]; $startingLine = (int) $matches[1];
if (isset($matches[2]) && $matches[2] !== '') { if (isset($matches[2]) && $matches[2] !== '') {
$lineCount = (int)$matches[2]; $lineCount = (int) $matches[2];
} }
$description = $matches[3]; $description = $matches[3];
+1 -1
View File
@@ -41,7 +41,7 @@ final class DocBlockFactory implements DocBlockFactoryInterface
* *
* @param string[] $additionalTags * @param string[] $additionalTags
*/ */
public static function createInstance(array $additionalTags = []): DocBlockFactory public static function createInstance(array $additionalTags = []): self
{ {
$fqsenResolver = new FqsenResolver(); $fqsenResolver = new FqsenResolver();
$tagFactory = new StandardTagFactory($fqsenResolver); $tagFactory = new StandardTagFactory($fqsenResolver);
@@ -74,8 +74,8 @@ DESCRIPTION;
$this->assertInstanceOf(See::class, $seeTags[0]); $this->assertInstanceOf(See::class, $seeTags[0]);
$seeTag = $seeTags[0]; $seeTag = $seeTags[0];
$this->assertSame('\\' . StandardTagFactory::class, (string)$seeTag->getReference()); $this->assertSame('\\' . StandardTagFactory::class, (string) $seeTag->getReference());
$this->assertSame('', (string)$seeTag->getDescription()); $this->assertSame('', (string) $seeTag->getDescription());
} }
public function testDescriptionsCanEscapeAtSignsAndClosingBraces(): void public function testDescriptionsCanEscapeAtSignsAndClosingBraces(): void
+1 -1
View File
@@ -42,7 +42,7 @@ class UsingTagsTest extends TestCase
$this->assertInstanceOf(\MyTag::class, $customTagObjects[0]); $this->assertInstanceOf(\MyTag::class, $customTagObjects[0]);
$this->assertSame('my-tag', $customTagObjects[0]->getName()); $this->assertSame('my-tag', $customTagObjects[0]->getName());
$this->assertSame('I have a description', (string)$customTagObjects[0]->getDescription()); $this->assertSame('I have a description', (string) $customTagObjects[0]->getDescription());
$this->assertSame($docComment, $reconstitutedDocComment); $this->assertSame($docComment, $reconstitutedDocComment);
} }
} }
+2 -2
View File
@@ -71,7 +71,7 @@ class DescriptionTest extends TestCase
$fixture = new Description($body, $tags); $fixture = new Description($body, $tags);
$this->assertSame($expected, (string)$fixture); $this->assertSame($expected, (string) $fixture);
} }
/** /**
@@ -123,6 +123,6 @@ class DescriptionTest extends TestCase
$fixture = new Description($body, $tags); $fixture = new Description($body, $tags);
$expected = '@JoinTable(name="table", joinColumns={@JoinColumn (name="column_id", referencedColumnName="id")}, inverseJoinColumns={@JoinColumn (name="column_id_2", referencedColumnName="id")})'; $expected = '@JoinTable(name="table", joinColumns={@JoinColumn (name="column_id", referencedColumnName="id")}, inverseJoinColumns={@JoinColumn (name="column_id_2", referencedColumnName="id")})';
$this->assertSame($expected, (string)$fixture); $this->assertSame($expected, (string) $fixture);
} }
} }
+4 -4
View File
@@ -58,7 +58,7 @@ DOCCOMMENT;
'This is a summary', 'This is a summary',
new Description('This is a description'), new Description('This is a description'),
[ [
new DocBlock\Tags\Generic('unknown-tag', new Description('Test description for the unknown tag')) new DocBlock\Tags\Generic('unknown-tag', new Description('Test description for the unknown tag')),
] ]
); );
@@ -92,7 +92,7 @@ DOCCOMMENT;
'This is a summary', 'This is a summary',
new Description('This is a description'), new Description('This is a description'),
[ [
new DocBlock\Tags\Generic('unknown-tag', new Description('Test description for the unknown tag')) new DocBlock\Tags\Generic('unknown-tag', new Description('Test description for the unknown tag')),
] ]
); );
@@ -126,7 +126,7 @@ DOCCOMMENT;
'This is a summary', 'This is a summary',
new Description('This is a description'), new Description('This is a description'),
[ [
new DocBlock\Tags\Generic('unknown-tag', new Description('Test description for the unknown tag')) new DocBlock\Tags\Generic('unknown-tag', new Description('Test description for the unknown tag')),
] ]
); );
@@ -166,7 +166,7 @@ DOCCOMMENT;
'This is a summary', 'This is a summary',
new Description('This is a description'), new Description('This is a description'),
[ [
new DocBlock\Tags\Generic('unknown-tag', new Description('Test description for the unknown tag')) new DocBlock\Tags\Generic('unknown-tag', new Description('Test description for the unknown tag')),
] ]
); );
@@ -32,7 +32,6 @@ use PHPUnit\Framework\TestCase;
*/ */
class StandardTagFactoryTest extends TestCase class StandardTagFactoryTest extends TestCase
{ {
/** /**
* Call Mockery::close after each test. * Call Mockery::close after each test.
*/ */
@@ -120,7 +119,7 @@ class StandardTagFactoryTest extends TestCase
$tag = $tagFactory->create('@see Tag'); $tag = $tagFactory->create('@see Tag');
$this->assertInstanceOf(See::class, $tag); $this->assertInstanceOf(See::class, $tag);
$this->assertSame($fqsen, (string)$tag->getReference()); $this->assertSame($fqsen, (string) $tag->getReference());
} }
/** /**
+2 -3
View File
@@ -27,7 +27,6 @@ use PHPUnit\Framework\TestCase;
*/ */
class CoversTest extends TestCase class CoversTest extends TestCase
{ {
/** /**
* Call Mockery::close after each test. * Call Mockery::close after each test.
*/ */
@@ -114,7 +113,7 @@ class CoversTest extends TestCase
{ {
$fixture = new Covers(new Fqsen('\DateTime'), new Description('Description')); $fixture = new Covers(new Fqsen('\DateTime'), new Description('Description'));
$this->assertSame('\DateTime Description', (string)$fixture); $this->assertSame('\DateTime Description', (string) $fixture);
} }
/** /**
@@ -141,7 +140,7 @@ class CoversTest extends TestCase
$fixture = Covers::create('DateTime My Description', $descriptionFactory, $resolver, $context); $fixture = Covers::create('DateTime My Description', $descriptionFactory, $resolver, $context);
$this->assertSame('\DateTime My Description', (string)$fixture); $this->assertSame('\DateTime My Description', (string) $fixture);
$this->assertSame($fqsen, $fixture->getReference()); $this->assertSame($fqsen, $fixture->getReference());
$this->assertSame($description, $fixture->getDescription()); $this->assertSame($description, $fixture->getDescription());
} }
+2 -2
View File
@@ -111,7 +111,7 @@ class DeprecatedTest extends TestCase
{ {
$fixture = new Deprecated('1.0', new Description('Description')); $fixture = new Deprecated('1.0', new Description('Description'));
$this->assertSame('1.0 Description', (string)$fixture); $this->assertSame('1.0 Description', (string) $fixture);
} }
/** /**
@@ -133,7 +133,7 @@ class DeprecatedTest extends TestCase
$fixture = Deprecated::create('1.0 My Description', $descriptionFactory, $context); $fixture = Deprecated::create('1.0 My Description', $descriptionFactory, $context);
$this->assertSame('1.0 My Description', (string)$fixture); $this->assertSame('1.0 My Description', (string) $fixture);
$this->assertSame($version, $fixture->getVersion()); $this->assertSame($version, $fixture->getVersion());
$this->assertSame($description, $fixture->getDescription()); $this->assertSame($description, $fixture->getDescription());
} }
-1
View File
@@ -11,7 +11,6 @@ use PHPUnit\Framework\TestCase;
*/ */
class ExampleTest extends TestCase class ExampleTest extends TestCase
{ {
/** /**
* Call Mockery::close after each test. * Call Mockery::close after each test.
*/ */
@@ -50,14 +50,14 @@ class AlignFormatterTest extends TestCase
$tags = [ $tags = [
new Param('foobar', new String_()), new Param('foobar', new String_()),
new Version('1.2.0'), new Version('1.2.0'),
new Link('http://www.example.com', new Description('Examples')) new Link('http://www.example.com', new Description('Examples')),
]; ];
$fixture = new AlignFormatter($tags); $fixture = new AlignFormatter($tags);
$expected = [ $expected = [
'@param string $foobar', '@param string $foobar',
'@version 1.2.0', '@version 1.2.0',
'@link http://www.example.com Examples' '@link http://www.example.com Examples',
]; ];
foreach ($tags as $key => $tag) { foreach ($tags as $key => $tag) {
+3 -2
View File
@@ -32,6 +32,7 @@ class GenericTest extends TestCase
{ {
m::close(); m::close();
} }
/** /**
* @uses \phpDocumentor\Reflection\DocBlock\Tags\Generic::__construct * @uses \phpDocumentor\Reflection\DocBlock\Tags\Generic::__construct
* @uses \phpDocumentor\Reflection\DocBlock\Description * @uses \phpDocumentor\Reflection\DocBlock\Description
@@ -98,7 +99,7 @@ class GenericTest extends TestCase
{ {
$fixture = new Generic('generic', new Description('Description')); $fixture = new Generic('generic', new Description('Description'));
$this->assertSame('Description', (string)$fixture); $this->assertSame('Description', (string) $fixture);
} }
/** /**
@@ -120,7 +121,7 @@ class GenericTest extends TestCase
$fixture = Generic::create('My Description', 'generic', $descriptionFactory, $context); $fixture = Generic::create('My Description', 'generic', $descriptionFactory, $context);
$this->assertSame('My Description', (string)$fixture); $this->assertSame('My Description', (string) $fixture);
$this->assertSame($generics, $fixture->getName()); $this->assertSame($generics, $fixture->getName());
$this->assertSame($description, $fixture->getDescription()); $this->assertSame($description, $fixture->getDescription());
} }
+3 -3
View File
@@ -111,7 +111,7 @@ class LinkTest extends TestCase
{ {
$fixture = new Link('http://this.is.my/link', new Description('Description')); $fixture = new Link('http://this.is.my/link', new Description('Description'));
$this->assertSame('http://this.is.my/link Description', (string)$fixture); $this->assertSame('http://this.is.my/link Description', (string) $fixture);
} }
/** /**
@@ -133,7 +133,7 @@ class LinkTest extends TestCase
$fixture = Link::create('http://this.is.my/link My Description', $descriptionFactory, $context); $fixture = Link::create('http://this.is.my/link My Description', $descriptionFactory, $context);
$this->assertSame('http://this.is.my/link My Description', (string)$fixture); $this->assertSame('http://this.is.my/link My Description', (string) $fixture);
$this->assertSame($links, $fixture->getLink()); $this->assertSame($links, $fixture->getLink());
$this->assertSame($description, $fixture->getDescription()); $this->assertSame($description, $fixture->getDescription());
} }
@@ -152,7 +152,7 @@ class LinkTest extends TestCase
$fixture = Link::create('', $descriptionFactory, new Context('')); $fixture = Link::create('', $descriptionFactory, new Context(''));
$this->assertSame('', (string)$fixture); $this->assertSame('', (string) $fixture);
$this->assertSame('', $fixture->getLink()); $this->assertSame('', $fixture->getLink());
$this->assertSame(null, $fixture->getDescription()); $this->assertSame(null, $fixture->getDescription());
} }
+27 -28
View File
@@ -66,7 +66,7 @@ class MethodTest extends TestCase
{ {
$arguments = [ $arguments = [
['name' => 'argument1', 'type' => new String_()], ['name' => 'argument1', 'type' => new String_()],
['name' => 'argument2', 'type' => new Object_()] ['name' => 'argument2', 'type' => new Object_()],
]; ];
$fixture = new Method('myMethod', $arguments, new Void_(), true, new Description('My Description')); $fixture = new Method('myMethod', $arguments, new Void_(), true, new Description('My Description'));
@@ -111,7 +111,7 @@ class MethodTest extends TestCase
public function testHasArguments(): void public function testHasArguments(): void
{ {
$arguments = [ $arguments = [
[ 'name' => 'argument1', 'type' => new String_() ] ['name' => 'argument1', 'type' => new String_()],
]; ];
$fixture = new Method('myMethod', $arguments); $fixture = new Method('myMethod', $arguments);
@@ -127,7 +127,7 @@ class MethodTest extends TestCase
{ {
$arguments = ['argument1']; $arguments = ['argument1'];
$expected = [ $expected = [
[ 'name' => $arguments[0], 'type' => new Void_() ] ['name' => $arguments[0], 'type' => new Void_()],
]; ];
$fixture = new Method('myMethod', $arguments); $fixture = new Method('myMethod', $arguments);
@@ -141,9 +141,9 @@ class MethodTest extends TestCase
*/ */
public function testArgumentTypeCanBeInferredAsVoid(): void public function testArgumentTypeCanBeInferredAsVoid(): void
{ {
$arguments = [ [ 'name' => 'argument1' ] ]; $arguments = [['name' => 'argument1']];
$expected = [ $expected = [
[ 'name' => $arguments[0]['name'], 'type' => new Void_() ] ['name' => $arguments[0]['name'], 'type' => new Void_()],
]; ];
$fixture = new Method('myMethod', $arguments); $fixture = new Method('myMethod', $arguments);
@@ -160,9 +160,9 @@ class MethodTest extends TestCase
public function testRestArgumentIsParsedAsRegularArg(): void public function testRestArgumentIsParsedAsRegularArg(): void
{ {
$expected = [ $expected = [
[ 'name' => 'arg1', 'type' => new Void_() ], ['name' => 'arg1', 'type' => new Void_()],
[ 'name' => 'rest', 'type' => new Void_() ], ['name' => 'rest', 'type' => new Void_()],
[ 'name' => 'rest2', 'type' => new Array_() ], ['name' => 'rest2', 'type' => new Array_()],
]; ];
$descriptionFactory = m::mock(DescriptionFactory::class); $descriptionFactory = m::mock(DescriptionFactory::class);
@@ -244,13 +244,13 @@ class MethodTest extends TestCase
{ {
$arguments = [ $arguments = [
['name' => 'argument1', 'type' => new String_()], ['name' => 'argument1', 'type' => new String_()],
['name' => 'argument2', 'type' => new Object_()] ['name' => 'argument2', 'type' => new Object_()],
]; ];
$fixture = new Method('myMethod', $arguments, new Void_(), true, new Description('My Description')); $fixture = new Method('myMethod', $arguments, new Void_(), true, new Description('My Description'));
$this->assertSame( $this->assertSame(
'static void myMethod(string $argument1, object $argument2) My Description', 'static void myMethod(string $argument1, object $argument2) My Description',
(string)$fixture (string) $fixture
); );
} }
@@ -271,8 +271,8 @@ class MethodTest extends TestCase
$description = new Description('My Description'); $description = new Description('My Description');
$expectedArguments = [ $expectedArguments = [
[ 'name' => 'argument1', 'type' => new String_() ], ['name' => 'argument1', 'type' => new String_()],
[ 'name' => 'argument2', 'type' => new Void_() ] ['name' => 'argument2', 'type' => new Void_()],
]; ];
$descriptionFactory->shouldReceive('create')->with('My Description', $context)->andReturn($description); $descriptionFactory->shouldReceive('create')->with('My Description', $context)->andReturn($description);
@@ -284,7 +284,7 @@ class MethodTest extends TestCase
$context $context
); );
$this->assertSame('static void myMethod(string $argument1, void $argument2) My Description', (string)$fixture); $this->assertSame('static void myMethod(string $argument1, void $argument2) My Description', (string) $fixture);
$this->assertSame('myMethod', $fixture->getMethodName()); $this->assertSame('myMethod', $fixture->getMethodName());
$this->assertEquals($expectedArguments, $fixture->getArguments()); $this->assertEquals($expectedArguments, $fixture->getArguments());
$this->assertInstanceOf(Void_::class, $fixture->getReturnType()); $this->assertInstanceOf(Void_::class, $fixture->getReturnType());
@@ -316,7 +316,7 @@ class MethodTest extends TestCase
); );
$this->assertTrue($fixture->isStatic()); $this->assertTrue($fixture->isStatic());
$this->assertSame('static $this myMethod()', (string)$fixture); $this->assertSame('static $this myMethod()', (string) $fixture);
$this->assertSame('myMethod', $fixture->getMethodName()); $this->assertSame('myMethod', $fixture->getMethodName());
$this->assertInstanceOf(This::class, $fixture->getReturnType()); $this->assertInstanceOf(This::class, $fixture->getReturnType());
} }
@@ -334,15 +334,14 @@ class MethodTest extends TestCase
/** /**
* @dataProvider collectionReturnTypesProvider * @dataProvider collectionReturnTypesProvider
* @covers ::create * @covers ::create
* @uses \phpDocumentor\Reflection\DocBlock\Tags\Method::<public> * @uses phpDocumentor\Reflection\DocBlock\Tags\Method::<public>
* @uses \phpDocumentor\Reflection\DocBlock\Description * @uses phpDocumentor\Reflection\DocBlock\Description
* @uses \phpDocumentor\Reflection\DocBlock\DescriptionFactory * @uses phpDocumentor\Reflection\DocBlock\DescriptionFactory
* @uses \phpDocumentor\Reflection\TypeResolver * @uses phpDocumentor\Reflection\TypeResolver
* @uses \phpDocumentor\Reflection\Types\Array_ * @uses phpDocumentor\Reflection\Types\Array_
* @uses \phpDocumentor\Reflection\Types\Compound * @uses phpDocumentor\Reflection\Types\Compound
* @uses \phpDocumentor\Reflection\Types\Integer * @uses phpDocumentor\Reflection\Types\Integer
* @uses \phpDocumentor\Reflection\Types\Object_ * @uses phpDocumentor\Reflection\Types\Object_
* @param string null $expectedKeyType
*/ */
public function testCollectionReturnTypes( public function testCollectionReturnTypes(
string $returnType, string $returnType,
@@ -354,7 +353,7 @@ class MethodTest extends TestCase
$descriptionFactory = m::mock(DescriptionFactory::class); $descriptionFactory = m::mock(DescriptionFactory::class);
$descriptionFactory->shouldReceive('create')->with('', null)->andReturn(new Description('')); $descriptionFactory->shouldReceive('create')->with('', null)->andReturn(new Description(''));
$fixture = Method::create("$returnType myMethod(\$arg)", $resolver, $descriptionFactory); $fixture = Method::create("${returnType} myMethod(\$arg)", $resolver, $descriptionFactory);
$returnType = $fixture->getReturnType(); $returnType = $fixture->getReturnType();
$this->assertInstanceOf($expectedType, $returnType); $this->assertInstanceOf($expectedType, $returnType);
@@ -433,7 +432,7 @@ class MethodTest extends TestCase
public function testCreationFailsIfArgumentRecordContainsInvalidEntry(): void public function testCreationFailsIfArgumentRecordContainsInvalidEntry(): void
{ {
$this->expectException('InvalidArgumentException'); $this->expectException('InvalidArgumentException');
new Method('body', [ [ 'name' => 'myName', 'unknown' => 'nah' ] ]); new Method('body', [['name' => 'myName', 'unknown' => 'nah']]);
} }
/** /**
@@ -462,7 +461,7 @@ class MethodTest extends TestCase
$context $context
); );
$this->assertSame('static void myMethod() My Description', (string)$fixture); $this->assertSame('static void myMethod() My Description', (string) $fixture);
$this->assertSame('myMethod', $fixture->getMethodName()); $this->assertSame('myMethod', $fixture->getMethodName());
$this->assertEquals([], $fixture->getArguments()); $this->assertEquals([], $fixture->getArguments());
$this->assertInstanceOf(Void_::class, $fixture->getReturnType()); $this->assertInstanceOf(Void_::class, $fixture->getReturnType());
@@ -496,7 +495,7 @@ class MethodTest extends TestCase
$context $context
); );
$this->assertSame('void myMethod()', (string)$fixture); $this->assertSame('void myMethod()', (string) $fixture);
$this->assertSame('myMethod', $fixture->getMethodName()); $this->assertSame('myMethod', $fixture->getMethodName());
$this->assertEquals([], $fixture->getArguments()); $this->assertEquals([], $fixture->getArguments());
$this->assertInstanceOf(Void_::class, $fixture->getReturnType()); $this->assertInstanceOf(Void_::class, $fixture->getReturnType());
@@ -531,7 +530,7 @@ class MethodTest extends TestCase
$context $context
); );
$this->assertSame('\MyClass[]|int[] myMethod()', (string)$fixture); $this->assertSame('\MyClass[]|int[] myMethod()', (string) $fixture);
$this->assertSame('myMethod', $fixture->getMethodName()); $this->assertSame('myMethod', $fixture->getMethodName());
$this->assertEquals([], $fixture->getArguments()); $this->assertEquals([], $fixture->getArguments());
+2 -2
View File
@@ -149,7 +149,7 @@ class ParamTest extends TestCase
{ {
$fixture = new Param('myParameter', new String_(), true, new Description('Description')); $fixture = new Param('myParameter', new String_(), true, new Description('Description'));
$this->assertSame('string ...$myParameter Description', (string)$fixture); $this->assertSame('string ...$myParameter Description', (string) $fixture);
} }
/** /**
@@ -170,7 +170,7 @@ class ParamTest extends TestCase
$fixture = Param::create('string ...$myParameter My Description', $typeResolver, $descriptionFactory, $context); $fixture = Param::create('string ...$myParameter My Description', $typeResolver, $descriptionFactory, $context);
$this->assertSame('string ...$myParameter My Description', (string)$fixture); $this->assertSame('string ...$myParameter My Description', (string) $fixture);
$this->assertSame('myParameter', $fixture->getVariableName()); $this->assertSame('myParameter', $fixture->getVariableName());
$this->assertInstanceOf(String_::class, $fixture->getType()); $this->assertInstanceOf(String_::class, $fixture->getType());
$this->assertTrue($fixture->isVariadic()); $this->assertTrue($fixture->isVariadic());
@@ -131,7 +131,7 @@ class PropertyReadTest extends TestCase
{ {
$fixture = new PropertyRead('myProperty', new String_(), new Description('Description')); $fixture = new PropertyRead('myProperty', new String_(), new Description('Description'));
$this->assertSame('string $myProperty Description', (string)$fixture); $this->assertSame('string $myProperty Description', (string) $fixture);
} }
/** /**
@@ -157,7 +157,7 @@ class PropertyReadTest extends TestCase
$context $context
); );
$this->assertSame('string $myProperty My Description', (string)$fixture); $this->assertSame('string $myProperty My Description', (string) $fixture);
$this->assertSame('myProperty', $fixture->getVariableName()); $this->assertSame('myProperty', $fixture->getVariableName());
$this->assertInstanceOf(String_::class, $fixture->getType()); $this->assertInstanceOf(String_::class, $fixture->getType());
$this->assertSame($description, $fixture->getDescription()); $this->assertSame($description, $fixture->getDescription());
+2 -2
View File
@@ -131,7 +131,7 @@ class PropertyTest extends TestCase
{ {
$fixture = new Property('myProperty', new String_(), new Description('Description')); $fixture = new Property('myProperty', new String_(), new Description('Description'));
$this->assertSame('string $myProperty Description', (string)$fixture); $this->assertSame('string $myProperty Description', (string) $fixture);
} }
/** /**
@@ -152,7 +152,7 @@ class PropertyTest extends TestCase
$fixture = Property::create('string $myProperty My Description', $typeResolver, $descriptionFactory, $context); $fixture = Property::create('string $myProperty My Description', $typeResolver, $descriptionFactory, $context);
$this->assertSame('string $myProperty My Description', (string)$fixture); $this->assertSame('string $myProperty My Description', (string) $fixture);
$this->assertSame('myProperty', $fixture->getVariableName()); $this->assertSame('myProperty', $fixture->getVariableName());
$this->assertInstanceOf(String_::class, $fixture->getType()); $this->assertInstanceOf(String_::class, $fixture->getType());
$this->assertSame($description, $fixture->getDescription()); $this->assertSame($description, $fixture->getDescription());
@@ -131,7 +131,7 @@ class PropertyWriteTest extends TestCase
{ {
$fixture = new PropertyWrite('myProperty', new String_(), new Description('Description')); $fixture = new PropertyWrite('myProperty', new String_(), new Description('Description'));
$this->assertSame('string $myProperty Description', (string)$fixture); $this->assertSame('string $myProperty Description', (string) $fixture);
} }
/** /**
@@ -157,7 +157,7 @@ class PropertyWriteTest extends TestCase
$context $context
); );
$this->assertSame('string $myProperty My Description', (string)$fixture); $this->assertSame('string $myProperty My Description', (string) $fixture);
$this->assertSame('myProperty', $fixture->getVariableName()); $this->assertSame('myProperty', $fixture->getVariableName());
$this->assertInstanceOf(String_::class, $fixture->getType()); $this->assertInstanceOf(String_::class, $fixture->getType());
$this->assertSame($description, $fixture->getDescription()); $this->assertSame($description, $fixture->getDescription());
+2 -2
View File
@@ -113,7 +113,7 @@ class ReturnTest extends TestCase
{ {
$fixture = new Return_(new String_(), new Description('Description')); $fixture = new Return_(new String_(), new Description('Description'));
$this->assertSame('string Description', (string)$fixture); $this->assertSame('string Description', (string) $fixture);
} }
/** /**
@@ -137,7 +137,7 @@ class ReturnTest extends TestCase
$fixture = Return_::create('string My Description', $resolver, $descriptionFactory, $context); $fixture = Return_::create('string My Description', $resolver, $descriptionFactory, $context);
$this->assertSame('string My Description', (string)$fixture); $this->assertSame('string My Description', (string) $fixture);
$this->assertEquals($type, $fixture->getType()); $this->assertEquals($type, $fixture->getType());
$this->assertSame($description, $fixture->getDescription()); $this->assertSame($description, $fixture->getDescription());
} }
+5 -5
View File
@@ -126,7 +126,7 @@ class SeeTest extends TestCase
{ {
$fixture = new See(new FqsenRef(new Fqsen('\DateTime::format()')), new Description('Description')); $fixture = new See(new FqsenRef(new Fqsen('\DateTime::format()')), new Description('Description'));
$this->assertSame('\DateTime::format() Description', (string)$fixture); $this->assertSame('\DateTime::format() Description', (string) $fixture);
} }
/** /**
@@ -154,9 +154,9 @@ class SeeTest extends TestCase
$fixture = See::create('DateTime My Description', $resolver, $descriptionFactory, $context); $fixture = See::create('DateTime My Description', $resolver, $descriptionFactory, $context);
$this->assertSame('\DateTime My Description', (string)$fixture); $this->assertSame('\DateTime My Description', (string) $fixture);
$this->assertInstanceOf(FqsenRef::class, $fixture->getReference()); $this->assertInstanceOf(FqsenRef::class, $fixture->getReference());
$this->assertSame((string)$fqsen, (string)$fixture->getReference()); $this->assertSame((string) $fqsen, (string) $fixture->getReference());
$this->assertSame($description, $fixture->getDescription()); $this->assertSame($description, $fixture->getDescription());
} }
@@ -184,9 +184,9 @@ class SeeTest extends TestCase
$fixture = See::create('https://test.org My Description', $resolver, $descriptionFactory, $context); $fixture = See::create('https://test.org My Description', $resolver, $descriptionFactory, $context);
$this->assertSame('https://test.org My Description', (string)$fixture); $this->assertSame('https://test.org My Description', (string) $fixture);
$this->assertInstanceOf(UrlRef::class, $fixture->getReference()); $this->assertInstanceOf(UrlRef::class, $fixture->getReference());
$this->assertSame('https://test.org', (string)$fixture->getReference()); $this->assertSame('https://test.org', (string) $fixture->getReference());
$this->assertSame($description, $fixture->getDescription()); $this->assertSame($description, $fixture->getDescription());
} }
+3 -4
View File
@@ -25,7 +25,6 @@ use PHPUnit\Framework\TestCase;
*/ */
class SinceTest extends TestCase class SinceTest extends TestCase
{ {
/** /**
* Call Mockery::close after each test. * Call Mockery::close after each test.
*/ */
@@ -112,7 +111,7 @@ class SinceTest extends TestCase
{ {
$fixture = new Since('1.0', new Description('Description')); $fixture = new Since('1.0', new Description('Description'));
$this->assertSame('1.0 Description', (string)$fixture); $this->assertSame('1.0 Description', (string) $fixture);
} }
/** /**
@@ -134,7 +133,7 @@ class SinceTest extends TestCase
$fixture = Since::create('1.0 My Description', $descriptionFactory, $context); $fixture = Since::create('1.0 My Description', $descriptionFactory, $context);
$this->assertSame('1.0 My Description', (string)$fixture); $this->assertSame('1.0 My Description', (string) $fixture);
$this->assertSame($version, $fixture->getVersion()); $this->assertSame($version, $fixture->getVersion());
$this->assertSame($description, $fixture->getDescription()); $this->assertSame($description, $fixture->getDescription());
} }
@@ -153,7 +152,7 @@ class SinceTest extends TestCase
$fixture = Since::create('', $descriptionFactory, new Context('')); $fixture = Since::create('', $descriptionFactory, new Context(''));
$this->assertSame('', (string)$fixture); $this->assertSame('', (string) $fixture);
$this->assertSame(null, $fixture->getVersion()); $this->assertSame(null, $fixture->getVersion());
$this->assertSame(null, $fixture->getDescription()); $this->assertSame(null, $fixture->getDescription());
} }
+2 -2
View File
@@ -129,7 +129,7 @@ class SourceTest extends TestCase
{ {
$fixture = new Source(1, 10, new Description('Description')); $fixture = new Source(1, 10, new Description('Description'));
$this->assertSame('1 10 Description', (string)$fixture); $this->assertSame('1 10 Description', (string) $fixture);
} }
/** /**
@@ -149,7 +149,7 @@ class SourceTest extends TestCase
$fixture = Source::create('1 10 My Description', $descriptionFactory, $context); $fixture = Source::create('1 10 My Description', $descriptionFactory, $context);
$this->assertSame('1 10 My Description', (string)$fixture); $this->assertSame('1 10 My Description', (string) $fixture);
$this->assertSame(1, $fixture->getStartingLine()); $this->assertSame(1, $fixture->getStartingLine());
$this->assertSame(10, $fixture->getLineCount()); $this->assertSame(10, $fixture->getLineCount());
$this->assertSame($description, $fixture->getDescription()); $this->assertSame($description, $fixture->getDescription());
+2 -2
View File
@@ -113,7 +113,7 @@ class ThrowsTest extends TestCase
{ {
$fixture = new Throws(new String_(), new Description('Description')); $fixture = new Throws(new String_(), new Description('Description'));
$this->assertSame('string Description', (string)$fixture); $this->assertSame('string Description', (string) $fixture);
} }
/** /**
@@ -137,7 +137,7 @@ class ThrowsTest extends TestCase
$fixture = Throws::create('string My Description', $resolver, $descriptionFactory, $context); $fixture = Throws::create('string My Description', $resolver, $descriptionFactory, $context);
$this->assertSame('string My Description', (string)$fixture); $this->assertSame('string My Description', (string) $fixture);
$this->assertEquals($type, $fixture->getType()); $this->assertEquals($type, $fixture->getType());
$this->assertSame($description, $fixture->getDescription()); $this->assertSame($description, $fixture->getDescription());
} }
+2 -2
View File
@@ -113,7 +113,7 @@ class UsesTest extends TestCase
{ {
$fixture = new Uses(new Fqsen('\DateTime'), new Description('Description')); $fixture = new Uses(new Fqsen('\DateTime'), new Description('Description'));
$this->assertSame('\DateTime Description', (string)$fixture); $this->assertSame('\DateTime Description', (string) $fixture);
} }
/** /**
@@ -140,7 +140,7 @@ class UsesTest extends TestCase
$fixture = Uses::create('DateTime My Description', $resolver, $descriptionFactory, $context); $fixture = Uses::create('DateTime My Description', $resolver, $descriptionFactory, $context);
$this->assertSame('\DateTime My Description', (string)$fixture); $this->assertSame('\DateTime My Description', (string) $fixture);
$this->assertSame($fqsen, $fixture->getReference()); $this->assertSame($fqsen, $fixture->getReference());
$this->assertSame($description, $fixture->getDescription()); $this->assertSame($description, $fixture->getDescription());
} }
+2 -2
View File
@@ -142,7 +142,7 @@ class VarTest extends TestCase
{ {
$fixture = new Var_('myVariable', new String_(), new Description('Description')); $fixture = new Var_('myVariable', new String_(), new Description('Description'));
$this->assertSame('string $myVariable Description', (string)$fixture); $this->assertSame('string $myVariable Description', (string) $fixture);
} }
/** /**
@@ -163,7 +163,7 @@ class VarTest extends TestCase
$fixture = Var_::create('string $myVariable My Description', $typeResolver, $descriptionFactory, $context); $fixture = Var_::create('string $myVariable My Description', $typeResolver, $descriptionFactory, $context);
$this->assertSame('string $myVariable My Description', (string)$fixture); $this->assertSame('string $myVariable My Description', (string) $fixture);
$this->assertSame('myVariable', $fixture->getVariableName()); $this->assertSame('myVariable', $fixture->getVariableName());
$this->assertInstanceOf(String_::class, $fixture->getType()); $this->assertInstanceOf(String_::class, $fixture->getType());
$this->assertSame($description, $fixture->getDescription()); $this->assertSame($description, $fixture->getDescription());
+3 -3
View File
@@ -111,7 +111,7 @@ class VersionTest extends TestCase
{ {
$fixture = new Version('1.0', new Description('Description')); $fixture = new Version('1.0', new Description('Description'));
$this->assertSame('1.0 Description', (string)$fixture); $this->assertSame('1.0 Description', (string) $fixture);
} }
/** /**
@@ -133,7 +133,7 @@ class VersionTest extends TestCase
$fixture = Version::create('1.0 My Description', $descriptionFactory, $context); $fixture = Version::create('1.0 My Description', $descriptionFactory, $context);
$this->assertSame('1.0 My Description', (string)$fixture); $this->assertSame('1.0 My Description', (string) $fixture);
$this->assertSame($version, $fixture->getVersion()); $this->assertSame($version, $fixture->getVersion());
$this->assertSame($description, $fixture->getDescription()); $this->assertSame($description, $fixture->getDescription());
} }
@@ -152,7 +152,7 @@ class VersionTest extends TestCase
$fixture = Version::create('', $descriptionFactory, new Context('')); $fixture = Version::create('', $descriptionFactory, new Context(''));
$this->assertSame('', (string)$fixture); $this->assertSame('', (string) $fixture);
$this->assertSame(null, $fixture->getVersion()); $this->assertSame(null, $fixture->getVersion());
$this->assertSame(null, $fixture->getDescription()); $this->assertSame(null, $fixture->getDescription());
} }
+5 -5
View File
@@ -202,7 +202,7 @@ DOCBLOCK;
[ [
'This is a DocBlock. This should still be summary.', 'This is a DocBlock. This should still be summary.',
'This is a DocBlock. This should still be summary.', 'This is a DocBlock. This should still be summary.',
'' '',
], ],
[ [
<<<DOCBLOCK <<<DOCBLOCK
@@ -211,7 +211,7 @@ This should be a Description.
DOCBLOCK DOCBLOCK
, ,
'This is a DocBlock.', 'This is a DocBlock.',
'This should be a Description.' 'This should be a Description.',
], ],
[ [
<<<DOCBLOCK <<<DOCBLOCK
@@ -221,7 +221,7 @@ This should be a Description.
DOCBLOCK DOCBLOCK
, ,
"This is a\nmultiline Summary.", "This is a\nmultiline Summary.",
'This should be a Description.' 'This should be a Description.',
], ],
[ [
<<<DOCBLOCK <<<DOCBLOCK
@@ -231,7 +231,7 @@ This should be a Description.
DOCBLOCK DOCBLOCK
, ,
'This is a Summary without dot but with a whiteline', 'This is a Summary without dot but with a whiteline',
'This should be a Description.' 'This should be a Description.',
], ],
[ [
<<<DOCBLOCK <<<DOCBLOCK
@@ -241,7 +241,7 @@ This should be a Description.
DOCBLOCK DOCBLOCK
, ,
'This is a Summary with dot and with a whiteline.', 'This is a Summary with dot and with a whiteline.',
'This should be a Description.' 'This should be a Description.',
], ],
]; ];
} }
+2 -2
View File
@@ -73,7 +73,7 @@ class DocBlockTest extends TestCase
public function testDocBlockCanHaveTags(): void public function testDocBlockCanHaveTags(): void
{ {
$tags = [ $tags = [
m::mock(DocBlock\Tag::class) m::mock(DocBlock\Tag::class),
]; ];
$fixture = new DocBlock('', null, $tags); $fixture = new DocBlock('', null, $tags);
@@ -91,7 +91,7 @@ class DocBlockTest extends TestCase
{ {
$this->expectException('InvalidArgumentException'); $this->expectException('InvalidArgumentException');
$tags = [ $tags = [
null null,
]; ];
$fixture = new DocBlock('', null, $tags); $fixture = new DocBlock('', null, $tags);
} }