Ruleset: drop support for sniffs setting the $supportedTokenizers property

Ref:
* squizlabs/PHP_CodeSniffer 2448

Co-authored-by: Greg Sherwood <[email protected]>

Author: jrfnl

src/Files/File.php

@@ -14,6 +14,7 @@
 use PHP_CodeSniffer\Exceptions\TokenizerException;
 use PHP_CodeSniffer\Fixer;
 use PHP_CodeSniffer\Ruleset;
+use PHP_CodeSniffer\Tokenizers\PHP;
 use PHP_CodeSniffer\Util\Common;
 use PHP_CodeSniffer\Util\Tokens;
 
@@ -72,17 +73,10 @@ class File
     /**
      * The tokenizer being used for this file.
      *
-     * @var \PHP_CodeSniffer\Tokenizers\Tokenizer
+     * @var \PHP_CodeSniffer\Tokenizers\PHP
      */
     public $tokenizer = null;
 
-    /**
-     * The name of the tokenizer being used for this file.
-     *
-     * @var string
-     */
-    public $tokenizerType = 'PHP';
-
     /**
      * Was the file loaded from cache?
      *
@@ -240,15 +234,6 @@ public function __construct($path, Ruleset $ruleset, Config $config)
         $this->config  = $config;
         $this->fixer   = new Fixer();
 
-        $parts     = explode('.', $path);
-        $extension = array_pop($parts);
-        if (isset($config->extensions[$extension]) === true) {
-            $this->tokenizerType = $config->extensions[$extension];
-        } else {
-            // Revert to default.
-            $this->tokenizerType = 'PHP';
-        }
-
         $this->configCache['cache']           = $this->config->cache;
         $this->configCache['sniffs']          = array_map('strtolower', $this->config->sniffs);
         $this->configCache['exclude']         = array_map('strtolower', $this->config->exclude);
@@ -412,14 +397,8 @@ public function process()
                     continue;
                 }
 
-                // Make sure this sniff supports the tokenizer
-                // we are currently using.
                 $class = $listenerData['class'];
 
-                if (isset($listenerData['tokenizers'][$this->tokenizerType]) === false) {
-                    continue;
-                }
-
                 if (trim($this->path, '\'"') !== 'STDIN') {
                     // If the file path matches one of our ignore patterns, skip it.
                     // While there is support for a type of each pattern
@@ -505,7 +484,7 @@ public function process()
         // We don't show this error for STDIN because we can't be sure the content
         // actually came directly from the user. It could be something like
         // refs from a Git pre-push hook.
-        if ($foundCode === false && $this->tokenizerType === 'PHP' && $this->path !== 'STDIN') {
+        if ($foundCode === false && $this->path !== 'STDIN') {
             $shortTags = (bool) ini_get('short_open_tag');
             if ($shortTags === false) {
                 $error = 'No PHP code was found in this file and short open tags are not allowed by this install of PHP. This file may be using short open tags but PHP does not allow them.';
@@ -543,14 +522,13 @@ public function parse()
         }
 
         try {
-            $tokenizerClass  = 'PHP_CodeSniffer\Tokenizers\\'.$this->tokenizerType;
-            $this->tokenizer = new $tokenizerClass($this->content, $this->config, $this->eolChar);
+            $this->tokenizer = new PHP($this->content, $this->config, $this->eolChar);
             $this->tokens    = $this->tokenizer->getTokens();
         } catch (TokenizerException $e) {
             $this->ignored = true;
             $this->addWarning($e->getMessage(), null, 'Internal.Tokenizer.Exception');
             if (PHP_CODESNIFFER_VERBOSITY > 0) {
-                echo "[$this->tokenizerType => tokenizer error]... ";
+                echo '[tokenizer error]... ';
                 if (PHP_CODESNIFFER_VERBOSITY > 1) {
                     echo PHP_EOL;
                 }
@@ -582,7 +560,7 @@ public function parse()
                 $numLines = $this->tokens[($this->numTokens - 1)]['line'];
             }
 
-            echo "[$this->tokenizerType => $this->numTokens tokens in $numLines lines]... ";
+            echo "[$this->numTokens tokens in $numLines lines]... ";
             if (PHP_CODESNIFFER_VERBOSITY > 1) {
                 echo PHP_EOL;
             }

src/Ruleset.php

@@ -1425,6 +1425,27 @@ public function registerSniffs($files, $restrictions, $exclusions)
                 continue;
             }
 
+            if ($reflection->hasProperty('supportedTokenizers') === true) {
+                // Using the default value as the class is not yet instantiated and this is not a property which should get changed anyway.
+                $value = $reflection->getDefaultProperties()['supportedTokenizers'];
+
+                if (is_array($value) === true
+                    && empty($value) === false
+                    && in_array('PHP', $value, true) === false
+                ) {
+                    if ($reflection->implementsInterface('PHP_CodeSniffer\\Sniffs\\DeprecatedSniff') === true) {
+                        // Silently ignore the sniff if the sniff is marked as deprecated.
+                        continue;
+                    }
+
+                    $message  = 'Support for scanning files other than PHP, like CSS/JS files, has been removed in PHP_CodeSniffer 4.0.'.PHP_EOL;
+                    $message .= 'The %s sniff is listening for %s.';
+                    $message  = sprintf($message, Common::getSniffCode($className), implode(', ', $value));
+                    $this->msgCache->add($message, MessageCollector::ERROR);
+                    continue;
+                }
+            }//end if
+
             $listeners[$className] = $className;
 
             if (PHP_CODESNIFFER_VERBOSITY > 2) {
@@ -1464,9 +1485,7 @@ public function populateTokenListeners()
             $this->sniffs[$sniffClass]    = new $sniffClass();
             $this->sniffCodes[$sniffCode] = $sniffClass;
 
-            $isDeprecated = false;
             if ($this->sniffs[$sniffClass] instanceof DeprecatedSniff) {
-                $isDeprecated = true;
                 $this->deprecatedSniffs[$sniffCode] = $sniffClass;
             }
 
@@ -1477,34 +1496,6 @@ public function populateTokenListeners()
                 }
             }
 
-            $tokenizers = [];
-            $vars       = get_class_vars($sniffClass);
-            if (empty($vars['supportedTokenizers']) === false
-                && $isDeprecated === false
-                && in_array('PHP', $vars['supportedTokenizers'], true) === false
-            ) {
-                if (in_array('CSS', $vars['supportedTokenizers'], true) === true
-                    || in_array('JS', $vars['supportedTokenizers'], true) === true
-                ) {
-                    $message = 'Scanning CSS/JS files is deprecated and support will be removed in PHP_CodeSniffer 4.0.'.PHP_EOL;
-                } else {
-                    // Just in case someone has an integration with a custom tokenizer.
-                    $message = 'Support for custom tokenizers will be removed in PHP_CodeSniffer 4.0.'.PHP_EOL;
-                }
-
-                $message .= 'The %s sniff is listening for %s.';
-                $message  = sprintf($message, $sniffCode, implode(', ', $vars['supportedTokenizers']));
-                $this->msgCache->add($message, MessageCollector::DEPRECATED);
-            }
-
-            if (isset($vars['supportedTokenizers']) === true) {
-                foreach ($vars['supportedTokenizers'] as $tokenizer) {
-                    $tokenizers[$tokenizer] = $tokenizer;
-                }
-            } else {
-                $tokenizers = ['PHP' => 'PHP'];
-            }
-
             $tokens = $this->sniffs[$sniffClass]->register();
             if (is_array($tokens) === false) {
                 $msg = "The sniff {$sniffClass}::register() method must return an array.";
@@ -1544,11 +1535,10 @@ public function populateTokenListeners()
 
                 if (isset($this->tokenListeners[$token][$sniffClass]) === false) {
                     $this->tokenListeners[$token][$sniffClass] = [
-                        'class'      => $sniffClass,
-                        'source'     => $sniffCode,
-                        'tokenizers' => $tokenizers,
-                        'ignore'     => $ignorePatterns,
-                        'include'    => $includePatterns,
+                        'class'   => $sniffClass,
+                        'source'  => $sniffCode,
+                        'ignore'  => $ignorePatterns,
+                        'include' => $includePatterns,
                     ];
                 }
             }

tests/Core/Ruleset/Fixtures/TestStandard/Sniffs/SupportedTokenizers/ImplementsDeprecatedInterfaceSniff.php

@@ -2,7 +2,7 @@
 /**
  * Test fixture.
  *
- * @see \PHP_CodeSniffer\Tests\Core\Ruleset\PopulateTokenListenersSupportedTokenizersTest
+ * @see \PHP_CodeSniffer\Tests\Core\Ruleset\RegisterSniffsRemovedTokenizersTest
  */
 
 namespace Fixtures\TestStandard\Sniffs\SupportedTokenizers;

tests/Core/Ruleset/Fixtures/TestStandard/Sniffs/SupportedTokenizers/ListensForCSSAndJSSniff.php

@@ -2,7 +2,7 @@
 /**
  * Test fixture.
  *
- * @see \PHP_CodeSniffer\Tests\Core\Ruleset\PopulateTokenListenersSupportedTokenizersTest
+ * @see \PHP_CodeSniffer\Tests\Core\Ruleset\RegisterSniffsRemovedTokenizersTest
  */
 
 namespace Fixtures\TestStandard\Sniffs\SupportedTokenizers;

tests/Core/Ruleset/Fixtures/TestStandard/Sniffs/SupportedTokenizers/ListensForCSSAndUnrecognizedSniff.php

@@ -2,7 +2,7 @@
 /**
  * Test fixture.
  *
- * @see \PHP_CodeSniffer\Tests\Core\Ruleset\PopulateTokenListenersSupportedTokenizersTest
+ * @see \PHP_CodeSniffer\Tests\Core\Ruleset\RegisterSniffsRemovedTokenizersTest
  */
 
 namespace Fixtures\TestStandard\Sniffs\SupportedTokenizers;

tests/Core/Ruleset/Fixtures/TestStandard/Sniffs/SupportedTokenizers/ListensForCSSSniff.php

@@ -2,7 +2,7 @@
 /**
  * Test fixture.
  *
- * @see \PHP_CodeSniffer\Tests\Core\Ruleset\PopulateTokenListenersSupportedTokenizersTest
+ * @see \PHP_CodeSniffer\Tests\Core\Ruleset\RegisterSniffsRemovedTokenizersTest
  */
 
 namespace Fixtures\TestStandard\Sniffs\SupportedTokenizers;

tests/Core/Ruleset/Fixtures/TestStandard/Sniffs/SupportedTokenizers/ListensForEmptySniff.php

@@ -2,7 +2,7 @@
 /**
  * Test fixture.
  *
- * @see \PHP_CodeSniffer\Tests\Core\Ruleset\PopulateTokenListenersSupportedTokenizersTest
+ * @see \PHP_CodeSniffer\Tests\Core\Ruleset\RegisterSniffsRemovedTokenizersTest
  */
 
 namespace Fixtures\TestStandard\Sniffs\SupportedTokenizers;

tests/Core/Ruleset/Fixtures/TestStandard/Sniffs/SupportedTokenizers/ListensForJSSniff.php

@@ -2,7 +2,7 @@
 /**
  * Test fixture.
  *
- * @see \PHP_CodeSniffer\Tests\Core\Ruleset\PopulateTokenListenersSupportedTokenizersTest
+ * @see \PHP_CodeSniffer\Tests\Core\Ruleset\RegisterSniffsRemovedTokenizersTest
  */
 
 namespace Fixtures\TestStandard\Sniffs\SupportedTokenizers;

tests/Core/Ruleset/Fixtures/TestStandard/Sniffs/SupportedTokenizers/ListensForPHPAndCSSAndJSSniff.php

@@ -2,7 +2,7 @@
 /**
  * Test fixture.
  *
- * @see \PHP_CodeSniffer\Tests\Core\Ruleset\PopulateTokenListenersSupportedTokenizersTest
+ * @see \PHP_CodeSniffer\Tests\Core\Ruleset\RegisterSniffsRemovedTokenizersTest
  */
 
 namespace Fixtures\TestStandard\Sniffs\SupportedTokenizers;

tests/Core/Ruleset/Fixtures/TestStandard/Sniffs/SupportedTokenizers/ListensForUnrecognizedTokenizersSniff.php

@@ -2,7 +2,7 @@
 /**
  * Test fixture.
  *
- * @see \PHP_CodeSniffer\Tests\Core\Ruleset\PopulateTokenListenersSupportedTokenizersTest
+ * @see \PHP_CodeSniffer\Tests\Core\Ruleset\RegisterSniffsRemovedTokenizersTest
  */
 
 namespace Fixtures\TestStandard\Sniffs\SupportedTokenizers;