Merge pull request #14 from PHPCSStandards/feature/tokenlist-more-defensive-coding

Debug/TokenList: add more defensive coding

Author: jrfnl

Debug/Sniffs/Debug/TokenListSniff.php

@@ -35,6 +35,23 @@ class TokenListSniff implements Sniff
         'CSS',
     ];
 
+    /**
+     * Default values for the token indexes accessed.
+     *
+     * This prevents issues with "undefined index" notices in case of rare tokenizer issues.
+     *
+     * @var array
+     */
+    private $tokenDefaults = [
+        'type'       => '?',
+        'code'       => '?',
+        'content'    => '',
+        'line'       => '?',
+        'column'     => '?',
+        'level'      => 0,
+        'conditions' => [],
+    ];
+
     /**
      * Returns an array of tokens this test wants to listen for.
      *
@@ -76,27 +93,29 @@ public function process(File $phpcsFile, $stackPtr)
         echo \str_repeat('-', ($ptrPadding + $linePadding + 35 + 16 + 18)), \PHP_EOL;
 
         foreach ($tokens as $ptr => $token) {
+            $token  += $this->tokenDefaults;
+            $content = $token['content'];
+
             if (isset($token['length']) === false) {
-                $token['length'] = strlen($token['content']);
+                $token['length'] = 0;
+                if (isset($token['content'])) {
+                    $token['length'] = strlen($content);
+                }
             }
 
-            $content = $token['content'];
             if ($token['code'] === \T_WHITESPACE
                 || (defined('T_DOC_COMMENT_WHITESPACE')
                 && $token['code'] === \T_DOC_COMMENT_WHITESPACE)
             ) {
-                if (strpos($token['content'], "\t") !== false) {
-                    $content = str_replace("\t", '\t', $token['content']);
+                if (strpos($content, "\t") !== false) {
+                    $content = str_replace("\t", '\t', $content);
                 }
                 if (isset($token['orig_content'])) {
                     $content .= ' :: Orig: ' . str_replace("\t", '\t', $token['orig_content']);
                 }
             }
 
-            $conditionCount = 'F'; // False.
-            if (isset($token['conditions'])) {
-                $conditionCount = count($token['conditions']);
-            }
+            $conditionCount = count($token['conditions']);
 
             echo \str_pad($ptr, $ptrPadding, ' ', \STR_PAD_LEFT),
                 ' :: L', \str_pad($token['line'], $linePadding, '0', \STR_PAD_LEFT),

Debug/Tests/Debug/TokenListUnitTest.inc

@@ -1 +1,3 @@
 <?php
+
+function

Debug/Tests/Debug/TokenListZUnitTest.php

@@ -37,6 +37,9 @@ public function testOutput()
         $expected .= 'Ptr :: Ln :: Col  :: Cond :: Token Type                 :: [len]: Content' . "\n";
         $expected .= '-------------------------------------------------------------------------' . "\n";
         $expected .= '  0 :: L1 :: C  1 :: CC 0 :: T_OPEN_TAG                 :: [5]: <?php' . "\n\n";
+        $expected .= '  1 :: L2 :: C  1 :: CC 0 :: T_WHITESPACE               :: [0]: ' . "\n\n";
+        $expected .= '  2 :: L3 :: C  1 :: CC 0 :: T_FUNCTION                 :: [8]: function' . "\n";
+        $expected .= '  3 :: L3 :: C  9 :: CC 0 :: T_WHITESPACE               :: [0]: ' . "\n\n";
 
         $this->assertSame($expected, $output);
     }