Improved void and iterable support

slevomat · Jan 3, 2017 · 5925d79 · 5925d79
1 parent 3835b04
commit 5925d79
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 19 deletions.
diff --git a/SlevomatCodingStandard/Helpers/FunctionHelper.php b/SlevomatCodingStandard/Helpers/FunctionHelper.php
@@ -102,7 +102,17 @@ public static function getParametersTypeHints(\PHP_CodeSniffer_File $codeSniffer
 		return $parametersTypeHints;
 	}
 
-	public static function returnsValue(\PHP_CodeSniffer_File $codeSnifferFile, int $functionPointer, bool $requireVoid = false): bool
+	public static function returnsValue(\PHP_CodeSniffer_File $codeSnifferFile, int $functionPointer): bool
+	{
+		return self::innerReturnsValue($codeSnifferFile, $functionPointer, false);
+	}
+
+	public static function returnsVoid(\PHP_CodeSniffer_File $codeSnifferFile, int $functionPointer): bool
+	{
+		return self::innerReturnsValue($codeSnifferFile, $functionPointer, true);
+	}
+
+	private static function innerReturnsValue(\PHP_CodeSniffer_File $codeSnifferFile, int $functionPointer, bool $requireVoid): bool
 	{
 		$tokens = $codeSnifferFile->getTokens();
 
@@ -127,11 +137,6 @@ public static function returnsValue(\PHP_CodeSniffer_File $codeSnifferFile, int
 		return false;
 	}
 
-	public static function returnsVoid(\PHP_CodeSniffer_File $codeSnifferFile, int $functionPointer): bool
-	{
-		return self::returnsValue($codeSnifferFile, $functionPointer, true);
-	}
-
 	/**
 	 * @param \PHP_CodeSniffer_File $codeSnifferFile
 	 * @param int $functionPointer

diff --git a/SlevomatCodingStandard/Sniffs/Typehints/TypeHintDeclarationSniff.php b/SlevomatCodingStandard/Sniffs/Typehints/TypeHintDeclarationSniff.php
@@ -184,7 +184,7 @@ private function checkReturnTypeHints(\PHP_CodeSniffer_File $phpcsFile, int $fun
 			return;
 		}
 
-		if ($this->definitionContainsVoidTypeHint($returnTypeHintDefinition) && $returnsVoid) {
+		if ($returnTypeHintDefinition === 'void' && $returnsVoid) {
 			$phpcsFile->addError(
 				sprintf(
 					'%s %s() does not have return type hint for its return value but it should be possible to add it based on @return annotation "%s".',
@@ -324,11 +324,6 @@ private function definitionContainsNullTypeHint(string $typeHintDefinition): boo
 		return preg_match('~(?:^null$)|(?:^null\|)|(?:\|null\|)|(?:\|null$)~i', $typeHintDefinition) !== 0;
 	}
 
-	private function definitionContainsVoidTypeHint(string $typeHintDefinition): bool
-	{
-		return preg_match('~(?:^void)|(?:^void\|)|(?:\|void\|)|(?:\|void)~i', $typeHintDefinition) !== 0;
-	}
-
 	private function definitionContainsStaticOrThisTypeHint(string $typeHintDefinition): bool
 	{
 		return preg_match('~(?:^static$)|(?:^static\|)|(?:\|static\|)|(?:\|static$)~i', $typeHintDefinition) !== 0

diff --git a/tests/Sniffs/Typehints/TypeHintDeclarationSniffTest.php b/tests/Sniffs/Typehints/TypeHintDeclarationSniffTest.php
@@ -53,22 +53,20 @@ public function testErrors()
 		$this->assertSniffError($report, 104, TypeHintDeclarationSniff::CODE_MISSING_PROPERTY_TYPE_HINT);
 	}
 
-	/**
-	 * @requires PHP 7.1
-	 */
-	public function test71Typehints()
+	public function testVoidAndIterable()
 	{
-		$report = $this->checkFile(__DIR__ . '/data/typehints71.php', [
+		$report = $this->checkFile(__DIR__ . '/data/voidAndIterableTypeHintDeclaration.php', [
 			'enableNullableTypeHints' => false,
 			'traversableTypeHints' => [
 				\Traversable::class,
 			],
 		]);
 
-		$this->assertSame(2, $report->getErrorCount());
+		$this->assertSame(3, $report->getErrorCount());
 
 		$this->assertSniffError($report, 11, TypeHintDeclarationSniff::CODE_MISSING_PARAMETER_TYPE_HINT);
 		$this->assertSniffError($report, 11, TypeHintDeclarationSniff::CODE_MISSING_RETURN_TYPE_HINT);
+		$this->assertSniffError($report, 36, TypeHintDeclarationSniff::CODE_USELESS_DOC_COMMENT);
 	}
 
 	public function testEnabledNullableTypeHintsNoErrors()

diff --git a/tests/Sniffs/Typehints/data/typehints71.php → ...ta/voidAndIterableTypeHintDeclaration.php b/tests/Sniffs/Typehints/data/typehints71.php → ...ta/voidAndIterableTypeHintDeclaration.php
@@ -1,6 +1,6 @@
 <?php // lint >= 7.1
 
-class Typehints71FooClass
+class VoidAndIterableClass
 {
 
 	/**
@@ -30,4 +30,12 @@ public function returnsIterable(): iterable
 		return [];
 	}
 
+	/**
+	 * @return void
+	 */
+	public function returnVoid(): void
+	{
+		return;
+	}
+
 }