RequireNullCoalesceEqualOperatorSniff requires PHP 7.4

slevomat · Mar 22, 2020 · e5b070b · e5b070b
1 parent 725678e
commit e5b070b
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -160,6 +160,10 @@ Requires use of null coalesce operator when possible.
 
 Requires use of null coalesce equal operator when possible.
 
+This sniff provides the following setting:
+
+* `enable`: either to enable or no this sniff. By default, it is enabled for PHP versions 7.4 or higher.
+
 #### SlevomatCodingStandard.ControlStructures.EarlyExit 🔧
 
 Requires use of early exit.

diff --git a/SlevomatCodingStandard/Sniffs/ControlStructures/RequireNullCoalesceEqualOperatorSniff.php b/SlevomatCodingStandard/Sniffs/ControlStructures/RequireNullCoalesceEqualOperatorSniff.php
@@ -6,6 +6,7 @@
 use PHP_CodeSniffer\Sniffs\Sniff;
 use PHP_CodeSniffer\Util\Tokens;
 use SlevomatCodingStandard\Helpers\IdentificatorHelper;
+use SlevomatCodingStandard\Helpers\SniffSettingsHelper;
 use SlevomatCodingStandard\Helpers\TokenHelper;
 use const T_COALESCE;
 use const T_EQUAL;
@@ -16,6 +17,9 @@ class RequireNullCoalesceEqualOperatorSniff implements Sniff
 
 	public const CODE_REQUIRED_NULL_COALESCE_EQUAL_OPERATOR = 'RequiredNullCoalesceEqualOperator';
 
+	/** @var bool|null */
+	public $enable = null;
+
 	/**
 	 * @return array<int, (int|string)>
 	 */
@@ -33,6 +37,12 @@ public function register(): array
 	 */
 	public function process(File $phpcsFile, $equalPointer): void
 	{
+		$this->enable = SniffSettingsHelper::isEnabledByPhpVersion($this->enable, 70400);
+
+		if (!$this->enable) {
+			return;
+		}
+
 		/** @var int $variableStartPointer */
 		$variableStartPointer = TokenHelper::findNextEffective($phpcsFile, $equalPointer + 1);
 		$variableEndPointer = IdentificatorHelper::findEndPointer($phpcsFile, $variableStartPointer);

diff --git a/tests/Sniffs/ControlStructures/RequireNullCoalesceEqualOperatorSniffTest.php b/tests/Sniffs/ControlStructures/RequireNullCoalesceEqualOperatorSniffTest.php
@@ -9,15 +9,17 @@ class RequireNullCoalesceEqualOperatorSniffTest extends TestCase
 
 	public function testNoErrors(): void
 	{
-		$report = self::checkFile(__DIR__ . '/data/requireNullCoalesceEqualOperatorNoErrors.php');
+		$report = self::checkFile(__DIR__ . '/data/requireNullCoalesceEqualOperatorNoErrors.php', [
+			'enable' => true,
+		]);
 		self::assertNoSniffErrorInFile($report);
 	}
 
 	public function testErrors(): void
 	{
 		$report = self::checkFile(
 			__DIR__ . '/data/requireNullCoalesceEqualOperatorErrors.php',
-			[],
+			['enable' => true],
 			[RequireNullCoalesceEqualOperatorSniff::CODE_REQUIRED_NULL_COALESCE_EQUAL_OPERATOR]
 		);
 
@@ -30,4 +32,16 @@ public function testErrors(): void
 		self::assertAllFixedInFile($report);
 	}
 
+	public function testShouldNotReportIfSniffIsDisabled(): void
+	{
+		$report = self::checkFile(
+			__DIR__ . '/data/requireNullCoalesceEqualOperatorErrors.php',
+			['enable' => false],
+			[RequireNullCoalesceEqualOperatorSniff::CODE_REQUIRED_NULL_COALESCE_EQUAL_OPERATOR]
+		);
+
+		self::assertSame(0, $report->getErrorCount());
+		self::assertNoSniffErrorInFile($report);
+	}
+
 }