TypeHintDeclarationSniff: return annotation is not useless when return type hint is missing

kukulich · kukulich · commit 1e609159241f · 2018-03-08T09:14:33.000+01:00
diff --git a/SlevomatCodingStandard/Sniffs/TypeHints/TypeHintDeclarationSniff.php b/SlevomatCodingStandard/Sniffs/TypeHints/TypeHintDeclarationSniff.php
@@ -948,10 +948,6 @@ private function typeHintEqualsAnnotation(\PHP_CodeSniffer\Files\File $phpcsFile
 
 	private function isReturnAnnotationUseless(\PHP_CodeSniffer\Files\File $phpcsFile, int $functionPointer, ?ReturnTypeHint $returnTypeHint = null, ?Annotation $returnAnnotation = null): bool
 	{
-		if (!FunctionHelper::isAbstract($phpcsFile, $functionPointer) && !FunctionHelper::returnsValue($phpcsFile, $functionPointer) && $returnTypeHint === null) {
-			return true;
-		}
-
 		if ($returnTypeHint === null || $returnAnnotation === null || $returnAnnotation->getContent() === null) {
 			return false;
 		}
diff --git a/tests/Sniffs/TypeHints/TypeHintDeclarationSniffTest.php b/tests/Sniffs/TypeHints/TypeHintDeclarationSniffTest.php
@@ -145,16 +145,17 @@ public function testEnabledVoidTypeHintErrors(): void
 			'enableObjectTypeHint' => false,
 		]);
 
-		self::assertSame(8, $report->getErrorCount());
+		self::assertSame(9, $report->getErrorCount());
 
 		self::assertSniffError($report, 3, TypeHintDeclarationSniff::CODE_MISSING_RETURN_TYPE_HINT);
 		self::assertSniffError($report, 14, TypeHintDeclarationSniff::CODE_MISSING_RETURN_TYPE_HINT);
 		self::assertSniffError($report, 16, TypeHintDeclarationSniff::CODE_MISSING_RETURN_TYPE_HINT);
 		self::assertSniffError($report, 24, TypeHintDeclarationSniff::CODE_USELESS_DOC_COMMENT);
-		self::assertSniffError($report, 31, TypeHintDeclarationSniff::CODE_MISSING_RETURN_TYPE_HINT);
-		self::assertSniffError($report, 35, TypeHintDeclarationSniff::CODE_MISSING_RETURN_TYPE_HINT);
+		self::assertSniffError($report, 32, TypeHintDeclarationSniff::CODE_MISSING_RETURN_TYPE_HINT);
 		self::assertSniffError($report, 39, TypeHintDeclarationSniff::CODE_MISSING_RETURN_TYPE_HINT);
-		self::assertSniffError($report, 51, TypeHintDeclarationSniff::CODE_INCORRECT_RETURN_TYPE_HINT);
+		self::assertSniffError($report, 43, TypeHintDeclarationSniff::CODE_MISSING_RETURN_TYPE_HINT);
+		self::assertSniffError($report, 47, TypeHintDeclarationSniff::CODE_MISSING_RETURN_TYPE_HINT);
+		self::assertSniffError($report, 59, TypeHintDeclarationSniff::CODE_INCORRECT_RETURN_TYPE_HINT);
 	}
 
 	public function testEnabledNullableTypeHintsNoErrors(): void
diff --git a/tests/Sniffs/TypeHints/data/enabledVoidTypeHintErrors.php b/tests/Sniffs/TypeHints/data/enabledVoidTypeHintErrors.php
@@ -21,11 +21,19 @@ public function method()
 	/**
 	 * @return void
 	 */
-	public function withSuppress(): void
+	public function bothReturnTypeAndAnnotation(): void
 	{
 		return;
 	}
 
+	/**
+	 * @return void
+	 */
+	public function onlyReturnAnnotation()
+	{
+
+	}
+
 }
 
 function () {

Original file line number	Diff line number	Diff line change
`@@ -948,10 +948,6 @@ private function typeHintEqualsAnnotation(\PHP_CodeSniffer\Files\File $phpcsFile`
`948`	`948`
`949`	`949`	`private function isReturnAnnotationUseless(\PHP_CodeSniffer\Files\File $phpcsFile, int $functionPointer, ?ReturnTypeHint $returnTypeHint = null, ?Annotation $returnAnnotation = null): bool`
`950`	`950`	`{`
`951`		`- if (!FunctionHelper::isAbstract($phpcsFile, $functionPointer) && !FunctionHelper::returnsValue($phpcsFile, $functionPointer) && $returnTypeHint === null) {`
`952`		`- return true;`
`953`		`- }`
`954`		`-`
`955`	`951`	`if ($returnTypeHint === null \|\| $returnAnnotation === null \|\| $returnAnnotation->getContent() === null) {`
`956`	`952`	`return false;`
`957`	`953`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,11 +21,19 @@ public function method()`
`21`	`21`	`/**`
`22`	`22`	`* @return void`
`23`	`23`	`*/`
`24`		`- public function withSuppress(): void`
	`24`	`+ public function bothReturnTypeAndAnnotation(): void`
`25`	`25`	`{`
`26`	`26`	`return;`
`27`	`27`	`}`
`28`	`28`
	`29`	`+ /**`
	`30`	`+ * @return void`
	`31`	`+ */`
	`32`	`+ public function onlyReturnAnnotation()`
	`33`	`+ {`
	`34`	`+`
	`35`	`+ }`
	`36`	`+`
`29`	`37`	`}`
`30`	`38`
`31`	`39`	`function () {`