Added InlineDocCommentDeclarationSniff

Author: kukulich

SlevomatCodingStandard/Sniffs/Commenting/InlineDocCommentDeclarationSniff.php

@@ -0,0 +1,83 @@
+<?php declare(strict_types = 1);
+
+namespace SlevomatCodingStandard\Sniffs\Commenting;
+
+use SlevomatCodingStandard\Helpers\DocCommentHelper;
+use SlevomatCodingStandard\Helpers\PropertyHelper;
+use SlevomatCodingStandard\Helpers\TokenHelper;
+
+class InlineDocCommentDeclarationSniff implements \PHP_CodeSniffer_Sniff
+{
+
+	const CODE_INVALID_FORMAT = 'InvalidFormat';
+
+	/**
+	 * @return int[]
+	 */
+	public function register(): array
+	{
+		return [
+			T_VARIABLE,
+		];
+	}
+
+	/**
+	 * @phpcsSuppress SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingParameterTypeHint
+	 * @param \PHP_CodeSniffer_File $phpcsFile
+	 * @param int $variablePointer
+	 */
+	public function process(\PHP_CodeSniffer_File $phpcsFile, $variablePointer)
+	{
+		if (PropertyHelper::isProperty($phpcsFile, $variablePointer)) {
+			return;
+		}
+
+		$docCommentOpenPointer = DocCommentHelper::findDocCommentOpenToken($phpcsFile, $variablePointer);
+		if ($docCommentOpenPointer === null) {
+			return;
+		}
+
+		$tokens = $phpcsFile->getTokens();
+
+		$docCommentContent = trim(TokenHelper::getContent($phpcsFile, $docCommentOpenPointer + 1, $tokens[$docCommentOpenPointer]['comment_closer'] - 1));
+
+		if (strpos($docCommentContent, '@var') !== 0) {
+			return;
+		}
+
+		if (preg_match('~^@var\\s+\\S+\s+\$\\S+(?:\\s+.+)?$~', $docCommentContent)) {
+			return;
+		}
+
+		if (preg_match('~^@var\\s+(\$\\S+)\\s+(\\S+)(\\s+.+)?$~', $docCommentContent, $matches)) {
+			$fix = $phpcsFile->addFixableError(
+				sprintf(
+					'Invalid inline doc comment format "%s" for variable %s, expected "@var %s %s%s".',
+					$docCommentContent,
+					$tokens[$variablePointer]['content'],
+					$matches[2],
+					$matches[1],
+					$matches[3] ?? ''
+				),
+				$variablePointer,
+				self::CODE_INVALID_FORMAT
+			);
+
+			if ($fix) {
+				$phpcsFile->fixer->beginChangeset();
+				for ($i = $docCommentOpenPointer; $i <= $tokens[$docCommentOpenPointer]['comment_closer']; $i++) {
+					$phpcsFile->fixer->replaceToken($i, '');
+				}
+				$phpcsFile->fixer->addContent($docCommentOpenPointer, sprintf('/** @var %s %s%s */', $matches[2], $matches[1], $matches[3] ?? ''));
+				$phpcsFile->fixer->endChangeset();
+			}
+		} else {
+			$phpcsFile->addError(
+				sprintf('Invalid inline doc comment format "%1$s" for variable %2$s, expected "@var type %2$s".', $docCommentContent, $tokens[$variablePointer]['content']),
+				$variablePointer,
+				self::CODE_INVALID_FORMAT
+			);
+		}
+	}
+
+}

tests/Sniffs/Commenting/InlineDocCommentDeclarationSniffTest.php

@@ -0,0 +1,46 @@
+<?php declare(strict_types = 1);
+
+namespace SlevomatCodingStandard\Sniffs\Commenting;
+
+class InlineDocCommentDeclarationSniffTest extends \SlevomatCodingStandard\Sniffs\TestCase
+{
+
+	public function testNoInvalidInlineDocCommentDeclarations()
+	{
+		$report = $this->checkFile(__DIR__ . '/data/noInvalidInlineDocCommentDeclarations.php');
+		$this->assertNoSniffErrorInFile($report);
+	}
+
+	public function testInvalidInlineDocCommentDeclarations()
+	{
+		$report = $this->checkFile(__DIR__ . '/data/invalidInlineDocCommentDeclarations.php');
+
+		$this->assertSame(3, $report->getErrorCount());
+
+		$this->assertSniffError(
+			$report,
+			12,
+			InlineDocCommentDeclarationSniff::CODE_INVALID_FORMAT,
+			'Invalid inline doc comment format "@var $a string[]" for variable $a, expected "@var string[] $a".'
+		);
+		$this->assertSniffError(
+			$report,
+			18,
+			InlineDocCommentDeclarationSniff::CODE_INVALID_FORMAT,
+			'Invalid inline doc comment format "@var $c" for variable $c, expected "@var type $c".'
+		);
+		$this->assertSniffError(
+			$report,
+			21,
+			InlineDocCommentDeclarationSniff::CODE_INVALID_FORMAT,
+			'Invalid inline doc comment format "@var $d iterable|array|\Traversable Lorem ipsum" for variable $d, expected "@var iterable|array|\Traversable $d Lorem ipsum".'
+		);
+	}
+
+	public function testFixableInvalidInlineDocCommentDeclarations()
+	{
+		$report = $this->checkFile(__DIR__ . '/data/invalidInlineDocCommentDeclarations.php', [], [InlineDocCommentDeclarationSniff::CODE_INVALID_FORMAT]);
+		$this->assertAllFixedInFile($report);
+	}
+
+}

tests/Sniffs/Commenting/data/invalidInlineDocCommentDeclarations.fixed.php

@@ -0,0 +1,30 @@
+<?php
+
+class Foo
+{
+
+	/** @var string */
+	private $foo;
+
+	public function __construct()
+	{
+		/** @var string[] $a */
+		$a = $this->get();
+
+		/** @see https://www.slevomat.cz */
+		$b = null;
+
+		/** @var $c */
+		$c = [];
+
+		/** @var iterable|array|\Traversable $d Lorem ipsum */
+		$d = [];
+	}
+
+	public function get()
+	{
+		$a = [];
+		return $a;
+	}
+
+}

tests/Sniffs/Commenting/data/invalidInlineDocCommentDeclarations.php

@@ -0,0 +1,30 @@
+<?php
+
+class Foo
+{
+
+	/** @var string */
+	private $foo;
+
+	public function __construct()
+	{
+		/** @var $a string[] */
+		$a = $this->get();
+
+		/** @see https://www.slevomat.cz */
+		$b = null;
+
+		/** @var $c */
+		$c = [];
+
+		/** @var $d iterable|array|\Traversable Lorem ipsum */
+		$d = [];
+	}
+
+	public function get()
+	{
+		$a = [];
+		return $a;
+	}
+
+}

tests/Sniffs/Commenting/data/noInvalidInlineDocCommentDeclarations.php

@@ -0,0 +1,27 @@
+<?php
+
+class Foo
+{
+
+	/** @var string */
+	private $foo;
+
+	public function __construct()
+	{
+		/** @var string[] $a */
+		$a = $this->get();
+
+		/** @see https://www.slevomat.cz */
+		$b = null;
+
+		/** @var iterable|array|\Traversable $d Lorem ipsum */
+		$d = [];
+	}
+
+	public function get()
+	{
+		$a = [];
+		return $a;
+	}
+
+}