Merge pull request #455 from derrabus/bump/doctrine-cs

Doctrine CS 10
doctrine · Oct 5, 2022 · 3f4b83c · 3f4b83c
2 parents 0fa705b + 8cd57e8
commit 3f4b83c
Show file tree

Hide file tree

Showing 8 changed files with 37 additions and 44 deletions.
diff --git a/composer.json b/composer.json
@@ -39,7 +39,7 @@
     },
     "require-dev": {
         "doctrine/cache": "^1.11 || ^2.0",
-        "doctrine/coding-standard": "^9",
+        "doctrine/coding-standard": "^9 || ^10",
         "phpstan/phpstan": "~1.4.10 || ^1.8.0",
         "phpunit/phpunit": "^7.5 || ^8.5 || ^9.5",
         "symfony/cache": "^4.4 || ^5.4 || ^6",

diff --git a/lib/Doctrine/Common/Annotations/Annotation.php b/lib/Doctrine/Common/Annotations/Annotation.php
@@ -18,9 +18,7 @@ class Annotation
      */
     public $value;
 
-    /**
-     * @param array<string, mixed> $data Key-value for properties to be defined in this class.
-     */
+    /** @param array<string, mixed> $data Key-value for properties to be defined in this class. */
     final public function __construct(array $data)
     {
         foreach ($data as $key => $value) {

diff --git a/lib/Doctrine/Common/Annotations/AnnotationException.php b/lib/Doctrine/Common/Annotations/AnnotationException.php
@@ -149,19 +149,15 @@ public static function enumeratorError($attributeName, $annotationName, $context
         ));
     }
 
-    /**
-     * @return AnnotationException
-     */
+    /** @return AnnotationException */
     public static function optimizerPlusSaveComments()
     {
         return new self(
             'You have to enable opcache.save_comments=1 or zend_optimizerplus.save_comments=1.'
         );
     }
 
-    /**
-     * @return AnnotationException
-     */
+    /** @return AnnotationException */
     public static function optimizerPlusLoadComments()
     {
         return new self(

diff --git a/lib/Doctrine/Common/Annotations/CachedReader.php b/lib/Doctrine/Common/Annotations/CachedReader.php
@@ -38,9 +38,7 @@ final class CachedReader implements Reader
     /** @var int[] */
     private $loadedFilemtimes = [];
 
-    /**
-     * @param bool $debug
-     */
+    /** @param bool $debug */
     public function __construct(Reader $reader, Cache $cache, $debug = false)
     {
         $this->delegate = $reader;

diff --git a/lib/Doctrine/Common/Annotations/DocParser.php b/lib/Doctrine/Common/Annotations/DocParser.php
@@ -1166,9 +1166,7 @@ private function identifierEndsWithClassConstant(string $identifier): bool
         return $this->getClassConstantPositionInIdentifier($identifier) === strlen($identifier) - strlen('::class');
     }
 
-    /**
-     * @return int|false
-     */
+    /** @return int|false */
     private function getClassConstantPositionInIdentifier(string $identifier)
     {
         return stripos($identifier, '::class');

diff --git a/lib/Doctrine/Common/Annotations/TokenParser.php b/lib/Doctrine/Common/Annotations/TokenParser.php
@@ -46,9 +46,7 @@ class TokenParser
      */
     private $pointer = 0;
 
-    /**
-     * @param string $contents
-     */
+    /** @param string $contents */
     public function __construct($contents)
     {
         $this->tokens = token_get_all($contents);

diff --git a/phpcs.xml.dist b/phpcs.xml.dist
@@ -148,4 +148,9 @@
     <rule ref="Squiz.Functions.GlobalFunction.Found">
         <exclude-pattern>*/tests/Doctrine/Tests/Common/Annotations/Fixtures/functions.php</exclude-pattern>
     </rule>
+
+    <!-- Single-line PHPDoc blocks will confuse PHPUnit 7.5 -->
+    <rule ref="SlevomatCodingStandard.Commenting.RequireOneLineDocComment.MultiLineDocComment">
+        <exclude-pattern>*/tests</exclude-pattern>
+    </rule>
 </ruleset>
diff --git a/tests/Doctrine/Tests/Common/Annotations/DocParserTest.php b/tests/Doctrine/Tests/Common/Annotations/DocParserTest.php
@@ -130,7 +130,7 @@ public function testBasicAnnotations(): void
         self::assertEquals('value2', $annot->value[1]['key2']);
 
         // Complete docblock
-        $docblock = <<<DOCBLOCK
+        $docblock = <<<'DOCBLOCK'
 /**
  * Some nifty class.
  *
@@ -174,7 +174,7 @@ public function testNamespacedAnnotations(): void
         $parser = new DocParser();
         $parser->setIgnoreNotImportedAnnotations(true);
 
-        $docblock = <<<DOCBLOCK
+        $docblock = <<<'DOCBLOCK'
 /**
  * Some nifty class.
  *
@@ -200,14 +200,14 @@ public function testTypicalMethodDocBlock(): void
     {
         $parser = $this->createTestParser();
 
-        $docblock = <<<DOCBLOCK
+        $docblock = <<<'DOCBLOCK'
 /**
  * Some nifty method.
  *
  * @since 2.0
  * @Doctrine\Tests\Common\Annotations\Name(foo="bar")
- * @param string \$foo This is foo.
- * @param mixed \$bar This is bar.
+ * @param string $foo This is foo.
+ * @param mixed $bar This is bar.
  * @return string Foo and bar.
  * @This is irrelevant
  * @Marker
@@ -229,7 +229,7 @@ public function testAnnotationWithoutConstructor(): void
     {
         $parser = $this->createTestParser();
 
-        $docblock = <<<DOCBLOCK
+        $docblock = <<<'DOCBLOCK'
 /**
  * @SomeAnnotationClassNameWithoutConstructor("Some data")
  */
@@ -245,7 +245,7 @@ public function testAnnotationWithoutConstructor(): void
         self::assertNotNull($annot->data);
         self::assertEquals($annot->data, 'Some data');
 
-        $docblock = <<<DOCBLOCK
+        $docblock = <<<'DOCBLOCK'
 /**
  * @SomeAnnotationClassNameWithoutConstructor(name="Some Name", data = "Some data")
  */
@@ -261,7 +261,7 @@ public function testAnnotationWithoutConstructor(): void
         self::assertEquals($annot->name, 'Some Name');
         self::assertEquals($annot->data, 'Some data');
 
-        $docblock = <<<DOCBLOCK
+        $docblock = <<<'DOCBLOCK'
 /**
  * @SomeAnnotationClassNameWithoutConstructor(data = "Some data")
  */
@@ -274,7 +274,7 @@ public function testAnnotationWithoutConstructor(): void
         self::assertEquals($annot->data, 'Some data');
         self::assertNull($annot->name);
 
-        $docblock = <<<DOCBLOCK
+        $docblock = <<<'DOCBLOCK'
 /**
  * @SomeAnnotationClassNameWithoutConstructor(name = "Some name")
  */
@@ -287,7 +287,7 @@ public function testAnnotationWithoutConstructor(): void
         self::assertEquals($annot->name, 'Some name');
         self::assertNull($annot->data);
 
-        $docblock = <<<DOCBLOCK
+        $docblock = <<<'DOCBLOCK'
 /**
  * @SomeAnnotationClassNameWithoutConstructor("Some data")
  */
@@ -300,7 +300,7 @@ public function testAnnotationWithoutConstructor(): void
         self::assertEquals($annot->data, 'Some data');
         self::assertNull($annot->name);
 
-        $docblock = <<<DOCBLOCK
+        $docblock = <<<'DOCBLOCK'
 /**
  * @SomeAnnotationClassNameWithoutConstructor("Some data",name = "Some name")
  */
@@ -313,7 +313,7 @@ public function testAnnotationWithoutConstructor(): void
         self::assertEquals($annot->name, 'Some name');
         self::assertEquals($annot->data, 'Some data');
 
-        $docblock = <<<DOCBLOCK
+        $docblock = <<<'DOCBLOCK'
 /**
  * @SomeAnnotationWithConstructorWithoutParams(name = "Some name")
  */
@@ -326,7 +326,7 @@ public function testAnnotationWithoutConstructor(): void
         self::assertEquals($annot->name, 'Some name');
         self::assertEquals($annot->data, 'Some data');
 
-        $docblock = <<<DOCBLOCK
+        $docblock = <<<'DOCBLOCK'
 /**
  * @SomeAnnotationClassNameWithoutConstructorAndProperties()
  */
@@ -1058,7 +1058,7 @@ public function testSupportClassConstants(string $docblock, $expected): void
     public function testWithoutConstructorWhenIsNotDefaultValue(): void
     {
         $parser   = $this->createTestParser();
-        $docblock = <<<DOCBLOCK
+        $docblock = <<<'DOCBLOCK'
 /**
  * @SomeAnnotationClassNameWithoutConstructorAndProperties("Foo")
  */
@@ -1076,7 +1076,7 @@ public function testWithoutConstructorWhenIsNotDefaultValue(): void
     public function testWithoutConstructorWhenHasNoProperties(): void
     {
         $parser   = $this->createTestParser();
-        $docblock = <<<DOCBLOCK
+        $docblock = <<<'DOCBLOCK'
 /**
  * @SomeAnnotationClassNameWithoutConstructorAndProperties(value = "Foo")
  */
@@ -1095,7 +1095,7 @@ public function testAnnotationTargetSyntaxError(): void
     {
         $parser   = $this->createTestParser();
         $context  = 'class SomeClassName';
-        $docblock = <<<DOCBLOCK
+        $docblock = <<<'DOCBLOCK'
 /**
  * @Doctrine\Tests\Common\Annotations\Fixtures\AnnotationWithTargetSyntaxError()
  */
@@ -1114,7 +1114,7 @@ public function testAnnotationWithInvalidTargetDeclarationError(): void
     {
         $parser   = $this->createTestParser();
         $context  = 'class SomeClassName';
-        $docblock = <<<DOCBLOCK
+        $docblock = <<<'DOCBLOCK'
 /**
  * @AnnotationWithInvalidTargetDeclaration()
  */
@@ -1142,7 +1142,7 @@ public function testAnnotationWithTargetEmptyError(): void
     {
         $parser   = $this->createTestParser();
         $context  = 'class SomeClassName';
-        $docblock = <<<DOCBLOCK
+        $docblock = <<<'DOCBLOCK'
 /**
  * @AnnotationWithTargetEmpty()
  */
@@ -1171,7 +1171,7 @@ public function testRegressionDDC575(): void
     {
         $parser = $this->createTestParser();
 
-        $docblock = <<<DOCBLOCK
+        $docblock = <<<'DOCBLOCK'
 /**
  * @Name
  *
@@ -1183,7 +1183,7 @@ public function testRegressionDDC575(): void
 
         self::assertInstanceOf(Name::class, $result[0]);
 
-        $docblock = <<<DOCBLOCK
+        $docblock = <<<'DOCBLOCK'
 /**
  * @Name
  * @Marker
@@ -1359,7 +1359,7 @@ public function testSyntaxErrorWithContextDescription(): void
      */
     public function testSyntaxErrorWithUnknownCharacters(): void
     {
-        $docblock = <<<DOCBLOCK
+        $docblock = <<<'DOCBLOCK'
 /**
  * @test at.
  */
@@ -1384,7 +1384,7 @@ class A {
      */
     public function testIgnorePHPDocThrowTag(): void
     {
-        $docblock = <<<DOCBLOCK
+        $docblock = <<<'DOCBLOCK'
 /**
  * @throws \RuntimeException
  */
@@ -1454,7 +1454,7 @@ public function testCastNegativeFloat(): void
 
     public function testSetValuesException(): void
     {
-        $docblock = <<<DOCBLOCK
+        $docblock = <<<'DOCBLOCK'
 /**
  * @SomeAnnotationClassNameWithoutConstructor(invalidaProperty = "Some val")
  */
@@ -1494,7 +1494,7 @@ public function testTrailingCommaIsAllowed(): void
 
     public function testTabPrefixIsAllowed(): void
     {
-        $docblock = <<<DOCBLOCK
+        $docblock = <<<'DOCBLOCK'
 /**
  *	@Name
  */
@@ -1578,7 +1578,7 @@ public function testMultiByteAnnotation(): void
             $this->markTestSkipped('This test requires mbstring function overloading is turned on');
         }
 
-        $docblock = <<<DOCBLOCK
+        $docblock = <<<'DOCBLOCK'
         /**
          * Мультибайтовый текст ломал парсер при оверлоадинге строковых функций
          * @Doctrine\Tests\Common\Annotations\Name