Ruleset::populateTokenListeners(): add tests (#757)

PHPCSStandards · Dec 19, 2024 · 20e3427 · 20e3427
1 parent ceeba63
commit 20e3427
Show file tree

Hide file tree

Showing 9 changed files with 563 additions and 4 deletions.
diff --git a/tests/Core/Ruleset/ExplainTest.php b/tests/Core/Ruleset/ExplainTest.php
@@ -185,9 +185,9 @@ public function testExplainWithDeprecatedSniffs()
         $ruleset  = new Ruleset($config);
 
         $expected  = PHP_EOL;
-        $expected .= 'The ShowSniffDeprecationsTest standard contains 10 sniffs'.PHP_EOL.PHP_EOL;
+        $expected .= 'The ShowSniffDeprecationsTest standard contains 11 sniffs'.PHP_EOL.PHP_EOL;
 
-        $expected .= 'TestStandard (10 sniffs)'.PHP_EOL;
+        $expected .= 'TestStandard (11 sniffs)'.PHP_EOL;
         $expected .= '------------------------'.PHP_EOL;
         $expected .= '  TestStandard.Deprecated.WithLongReplacement *'.PHP_EOL;
         $expected .= '  TestStandard.Deprecated.WithoutReplacement *'.PHP_EOL;
@@ -198,7 +198,8 @@ public function testExplainWithDeprecatedSniffs()
         $expected .= '  TestStandard.SetProperty.AllowedViaMagicMethod'.PHP_EOL;
         $expected .= '  TestStandard.SetProperty.AllowedViaStdClass'.PHP_EOL;
         $expected .= '  TestStandard.SetProperty.NotAllowedViaAttribute'.PHP_EOL;
-        $expected .= '  TestStandard.SetProperty.PropertyTypeHandling'.PHP_EOL.PHP_EOL;
+        $expected .= '  TestStandard.SetProperty.PropertyTypeHandling'.PHP_EOL;
+        $expected .= '  TestStandard.ValidSniffs.RegisterEmptyArray'.PHP_EOL.PHP_EOL;
 
         $expected .= '* Sniffs marked with an asterix are deprecated.'.PHP_EOL;
 

diff --git a/tests/Core/Ruleset/Fixtures/TestStandard/Sniffs/InvalidSniffs/RegisterNoArraySniff.php b/tests/Core/Ruleset/Fixtures/TestStandard/Sniffs/InvalidSniffs/RegisterNoArraySniff.php
@@ -0,0 +1,25 @@
+<?php
+/**
+ * Test fixture.
+ *
+ * @see \PHP_CodeSniffer\Tests\Core\Ruleset\PopulateTokenListenersTest
+ */
+
+namespace Fixtures\TestStandard\Sniffs\InvalidSniffs;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+
+class RegisterNoArraySniff implements Sniff
+{
+
+    public function register()
+    {
+        return false;
+    }
+
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        // Do something.
+    }
+}
diff --git a/tests/Core/Ruleset/Fixtures/TestStandard/Sniffs/ValidSniffs/RegisterEmptyArraySniff.php b/tests/Core/Ruleset/Fixtures/TestStandard/Sniffs/ValidSniffs/RegisterEmptyArraySniff.php
@@ -0,0 +1,25 @@
+<?php
+/**
+ * Test fixture.
+ *
+ * @see \PHP_CodeSniffer\Tests\Core\Ruleset\PopulateTokenListenersTest
+ */
+
+namespace Fixtures\TestStandard\Sniffs\ValidSniffs;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+
+class RegisterEmptyArraySniff implements Sniff
+{
+
+    public function register()
+    {
+        return [];
+    }
+
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        // Do something.
+    }
+}
diff --git a/tests/Core/Ruleset/PopulateTokenListenersRegisterNoArrayTest.xml b/tests/Core/Ruleset/PopulateTokenListenersRegisterNoArrayTest.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0"?>
+<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="PopulateTokenListenersTest" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/PHPCSStandards/PHP_CodeSniffer/master/phpcs.xsd">
+
+    <config name="installed_paths" value="./tests/Core/Ruleset/Fixtures/TestStandard/"/>
+
+    <rule ref="TestStandard.InvalidSniffs.RegisterNoArray"/>
+
+</ruleset>