Merge pull request #266 from PHPCSStandards/feature/tests-heredocnowdoccloser-improvements

Tests/HeredocNowdocCloserTest: clean up + use named data sets

Author: jrfnl

tests/Core/Tokenizer/HeredocNowdocCloserTest.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Tests the tokenization of goto declarations and statements.
+ * Tests the tokenization of heredoc/nowdoc closer tokens.
  *
  * @author    Juliette Reinders Folmer <[email protected]>
  * @copyright 2020 Squiz Pty Ltd (ABN 77 084 670 600)
@@ -9,9 +9,6 @@
 
 namespace PHP_CodeSniffer\Tests\Core\Tokenizer;
 
-use PHP_CodeSniffer\Config;
-use PHP_CodeSniffer\Ruleset;
-use PHP_CodeSniffer\Files\DummyFile;
 use PHP_CodeSniffer\Tests\Core\AbstractMethodUnitTest;
 
 /**
@@ -23,44 +20,11 @@ final class HeredocNowdocCloserTest extends AbstractMethodUnitTest
 {
 
 
-    /**
-     * Initialize & tokenize \PHP_CodeSniffer\Files\File with code from the test case file.
-     *
-     * {@internal This is a near duplicate of the original method. Only difference is that
-     * tab replacement is enabled for this test.}
-     *
-     * @beforeClass
-     *
-     * @return void
-     */
-    public static function initializeFile()
-    {
-        $config            = new Config();
-        $config->standards = ['PSR1'];
-        $config->tabWidth  = 4;
-
-        $ruleset = new Ruleset($config);
-
-        // Default to a file with the same name as the test class. Extension is property based.
-        $relativeCN     = str_replace(__NAMESPACE__, '', get_called_class());
-        $relativePath   = str_replace('\\', DIRECTORY_SEPARATOR, $relativeCN);
-        $pathToTestFile = realpath(__DIR__).$relativePath.'.'.static::$fileExtension;
-
-        // Make sure the file gets parsed correctly based on the file type.
-        $contents  = 'phpcs_input_file: '.$pathToTestFile.PHP_EOL;
-        $contents .= file_get_contents($pathToTestFile);
-
-        self::$phpcsFile = new DummyFile($contents, $ruleset, $config);
-        self::$phpcsFile->process();
-
-    }//end initializeFile()
-
-
     /**
      * Verify that leading (indent) whitespace in a heredoc/nowdoc closer token get the tab replacement treatment.
      *
-     * @param string $testMarker The comment prefacing the target token.
-     * @param array  $expected   Expectations for the token array.
+     * @param string                         $testMarker The comment prefacing the target token.
+     * @param array<string, int|string|null> $expected   Expectations for the token array.
      *
      * @dataProvider dataHeredocNowdocCloserTabReplacement
      * @covers       PHP_CodeSniffer\Tokenizers\Tokenizer::createPositionMap
@@ -91,52 +55,52 @@ public function testHeredocNowdocCloserTabReplacement($testMarker, $expected)
      *
      * @see testHeredocNowdocCloserTabReplacement()
      *
-     * @return array
+     * @return array<string, array<string, string|array<string, int|string|null>>>
      */
     public static function dataHeredocNowdocCloserTabReplacement()
     {
         return [
-            [
+            'Heredoc closer without indent'      => [
                 'testMarker' => '/* testHeredocCloserNoIndent */',
                 'expected'   => [
                     'length'       => 3,
                     'content'      => 'EOD',
                     'orig_content' => null,
                 ],
             ],
-            [
+            'Nowdoc closer without indent'       => [
                 'testMarker' => '/* testNowdocCloserNoIndent */',
                 'expected'   => [
                     'length'       => 3,
                     'content'      => 'EOD',
                     'orig_content' => null,
                 ],
             ],
-            [
+            'Heredoc closer with indent, spaces' => [
                 'testMarker' => '/* testHeredocCloserSpaceIndent */',
                 'expected'   => [
                     'length'       => 7,
                     'content'      => '    END',
                     'orig_content' => null,
                 ],
             ],
-            [
+            'Nowdoc closer with indent, spaces'  => [
                 'testMarker' => '/* testNowdocCloserSpaceIndent */',
                 'expected'   => [
                     'length'       => 8,
                     'content'      => '     END',
                     'orig_content' => null,
                 ],
             ],
-            [
+            'Heredoc closer with indent, tabs'   => [
                 'testMarker' => '/* testHeredocCloserTabIndent */',
                 'expected'   => [
                     'length'       => 8,
                     'content'      => '     END',
                     'orig_content' => '	 END',
                 ],
             ],
-            [
+            'Nowdoc closer with indent, tabs'    => [
                 'testMarker' => '/* testNowdocCloserTabIndent */',
                 'expected'   => [
                     'length'       => 7,