New LanguageConstructWithParenthesesSniff

Author: kukulich

README.md

@@ -132,6 +132,10 @@ Commas after last element in an array make adding a new element easier and resul
 
 This sniff enforces trailing commas in multi-line arrays and requires short array syntax `[]`.
 
+#### SlevomatCodingStandard.ControlStructures.LanguageConstructWithParentheses 🔧
+
+`LanguageConstructWithParenthesesSniff` checks and fixes language construct used with parentheses.
+
 #### SlevomatCodingStandard.ControlStructures.YodaComparison 🔧
 
 [Yoda conditions](https://en.wikipedia.org/wiki/Yoda_conditions) decrease code comprehensibility and readability by switching operands around comparison operators forcing the reader to read the code in an unnatural way.

SlevomatCodingStandard/Helpers/UseStatementHelper.php

@@ -23,7 +23,7 @@ public static function isTraitUse(\PHP_CodeSniffer\Files\File $phpcsFile, int $u
 			$openerPointer = $typeToken['scope_opener'];
 			$closerPointer = $typeToken['scope_closer'];
 
-			return ($usePointer > $openerPointer && $usePointer < $closerPointer);
+			return $usePointer > $openerPointer && $usePointer < $closerPointer;
 		}
 
 		return false;

SlevomatCodingStandard/Sniffs/ControlStructures/LanguageConstructWithParenthesesSniff.php

@@ -0,0 +1,53 @@
+<?php declare(strict_types = 1);
+
+namespace SlevomatCodingStandard\Sniffs\ControlStructures;
+
+use SlevomatCodingStandard\Helpers\TokenHelper;
+
+class LanguageConstructWithParenthesesSniff implements \PHP_CodeSniffer\Sniffs\Sniff
+{
+
+	const CODE_USED_WITH_PARENTHESES = 'UsedWithParentheses';
+
+	/**
+	 * @return mixed[]
+	 */
+	public function register(): array
+	{
+		return [
+			T_BREAK,
+			T_CONTINUE,
+			T_ECHO,
+			T_INCLUDE,
+			T_INCLUDE_ONCE,
+			T_PRINT,
+			T_REQUIRE,
+			T_REQUIRE_ONCE,
+			T_RETURN,
+			T_THROW,
+			T_YIELD,
+		];
+	}
+
+	/**
+	 * @phpcsSuppress SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingParameterTypeHint
+	 * @param \PHP_CodeSniffer\Files\File $phpcsFile
+	 * @param int $languageConstructPointer
+	 */
+	public function process(\PHP_CodeSniffer\Files\File $phpcsFile, $languageConstructPointer)
+	{
+		$tokens = $phpcsFile->getTokens();
+
+		$nextTokenPointer = TokenHelper::findNextEffective($phpcsFile, $languageConstructPointer + 1);
+		if ($tokens[$nextTokenPointer]['code'] === T_OPEN_PARENTHESIS) {
+			$fix = $phpcsFile->addFixableError(sprintf('Usage of language construct "%s" with parentheses is disallowed.', $tokens[$languageConstructPointer]['content']), $languageConstructPointer, self::CODE_USED_WITH_PARENTHESES);
+			if ($fix) {
+				$phpcsFile->fixer->beginChangeset();
+				$phpcsFile->fixer->replaceToken($nextTokenPointer, $tokens[$nextTokenPointer - 1]['code'] === T_WHITESPACE ? '' : ' ');
+				$phpcsFile->fixer->replaceToken($tokens[$nextTokenPointer]['parenthesis_closer'], '');
+				$phpcsFile->fixer->endChangeset();
+			}
+		}
+	}
+
+}

tests/Sniffs/ControlStructures/LanguageConstructWithParenthesesSniffTest.php

@@ -0,0 +1,34 @@
+<?php declare(strict_types = 1);
+
+namespace SlevomatCodingStandard\Sniffs\ControlStructures;
+
+class LanguageConstructWithParenthesesSniffTest extends \SlevomatCodingStandard\Sniffs\TestCase
+{
+
+	public function testNoErrors()
+	{
+		$this->assertNoSniffErrorInFile($this->checkFile(__DIR__ . '/data/languageConstructWithParenthesesNoErrors.php'));
+	}
+
+	public function testErrors()
+	{
+		$report = $this->checkFile(__DIR__ . '/data/languageConstructWithParenthesesErrors.php', [], [LanguageConstructWithParenthesesSniff::CODE_USED_WITH_PARENTHESES]);
+
+		$this->assertSame(11, $report->getErrorCount());
+
+		$this->assertSniffError($report, 5, LanguageConstructWithParenthesesSniff::CODE_USED_WITH_PARENTHESES, 'Usage of language construct "continue" with parentheses is disallowed.');
+		$this->assertSniffError($report, 8, LanguageConstructWithParenthesesSniff::CODE_USED_WITH_PARENTHESES, 'Usage of language construct "break" with parentheses is disallowed.');
+		$this->assertSniffError($report, 12, LanguageConstructWithParenthesesSniff::CODE_USED_WITH_PARENTHESES, 'Usage of language construct "echo" with parentheses is disallowed.');
+		$this->assertSniffError($report, 13, LanguageConstructWithParenthesesSniff::CODE_USED_WITH_PARENTHESES, 'Usage of language construct "print" with parentheses is disallowed.');
+		$this->assertSniffError($report, 15, LanguageConstructWithParenthesesSniff::CODE_USED_WITH_PARENTHESES, 'Usage of language construct "include" with parentheses is disallowed.');
+		$this->assertSniffError($report, 16, LanguageConstructWithParenthesesSniff::CODE_USED_WITH_PARENTHESES, 'Usage of language construct "include_once" with parentheses is disallowed.');
+		$this->assertSniffError($report, 17, LanguageConstructWithParenthesesSniff::CODE_USED_WITH_PARENTHESES, 'Usage of language construct "require" with parentheses is disallowed.');
+		$this->assertSniffError($report, 18, LanguageConstructWithParenthesesSniff::CODE_USED_WITH_PARENTHESES, 'Usage of language construct "require_once" with parentheses is disallowed.');
+		$this->assertSniffError($report, 22, LanguageConstructWithParenthesesSniff::CODE_USED_WITH_PARENTHESES, 'Usage of language construct "return" with parentheses is disallowed.');
+		$this->assertSniffError($report, 27, LanguageConstructWithParenthesesSniff::CODE_USED_WITH_PARENTHESES, 'Usage of language construct "yield" with parentheses is disallowed.');
+		$this->assertSniffError($report, 31, LanguageConstructWithParenthesesSniff::CODE_USED_WITH_PARENTHESES, 'Usage of language construct "throw" with parentheses is disallowed.');
+
+		$this->assertAllFixedInFile($report);
+	}
+
+}

tests/Sniffs/ControlStructures/data/languageConstructWithParenthesesErrors.fixed.php

@@ -0,0 +1,34 @@
+<?php
+
+foreach ([true, false] as $value) {
+	if (true) {
+		continue 1;
+	}
+	if (false) {
+		break 1;
+	}
+}
+
+echo 'a';
+print 'b';
+
+include 'file.php';
+include_once 'file.php';
+require 'file.php';
+require_once 'file.php';
+
+function foo()
+{
+	return 'foo';
+}
+
+function boo()
+{
+	yield [];
+}
+
+try {
+	throw new \Exception();
+} catch (\Throwable $e) {
+
+}

tests/Sniffs/ControlStructures/data/languageConstructWithParenthesesErrors.php

@@ -0,0 +1,34 @@
+<?php
+
+foreach ([true, false] as $value) {
+	if (true) {
+		continue (1);
+	}
+	if (false) {
+		break (1);
+	}
+}
+
+echo('a');
+print('b');
+
+include('file.php');
+include_once('file.php');
+require('file.php');
+require_once('file.php');
+
+function foo()
+{
+	return('foo');
+}
+
+function boo()
+{
+	yield([]);
+}
+
+try {
+	throw(new \Exception());
+} catch (\Throwable $e) {
+
+}

tests/Sniffs/ControlStructures/data/languageConstructWithParenthesesNoErrors.php

@@ -0,0 +1,34 @@
+<?php
+
+foreach ([true, false] as $value) {
+	if (true) {
+		continue 1;
+	}
+	if (false) {
+		break 1;
+	}
+}
+
+echo 'a';
+print 'b';
+
+include 'file.php';
+include_once 'file.php';
+require 'file.php';
+require_once 'file.php';
+
+function foo()
+{
+	return 'foo';
+}
+
+function boo()
+{
+	yield [];
+}
+
+try {
+	throw new \Exception();
+} catch (\Throwable $e) {
+
+}