WIP ContextHelper::is_token_namespaced(): add basic tests

Check the way the tests are structured. There is for sure room to improve their organization.

Author: rodrigoprimo

WordPress/Util/Tests/Helpers/ContextHelper/IsTokenNamespacedUnitTest.inc

@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * The below should NOT be recognized as namespaced tokens by ContextHelper::is_token_namespaced().
+ */
+
+/* test return false 1 */ my_function();
+/* test return false 2 */ \my_function();
+/* test return false 3 */ MyClass::my_static_method();
+/* test return false 4 */ $var = new \MyClass();
+/* test return false 5 */ $const = MY_CONSTANT;
+/* test return false 6 */ $const = \MY_CONSTANT;
+
+/*
+ * The below should be recognized as namespaced tokens by ContextHelper::is_token_namespaced().
+ */
+
+/* test return true 1 */ MyNamespace\my_function();
+/* test return true 2 */ \MyNamespace\my_function();
+/* test return true 3 */ namespace\my_function(); // False positive if the file is not namespaced.
+/* test return true 4 */ $var = new MyNamespace\MyClass();
+/* test return true 5 */ $const = MyNamespace\MY_CONSTANT;

WordPress/Util/Tests/Helpers/ContextHelper/IsTokenNamespacedUnitTest.php

@@ -0,0 +1,96 @@
+<?php
+/**
+ * WordPress Coding Standard.
+ *
+ * @package WPCS\WordPressCodingStandards
+ * @link    https://github.com/WordPress/WordPress-Coding-Standards
+ * @license https://opensource.org/licenses/MIT MIT
+ */
+
+namespace WordPressCS\WordPress\Util\Tests\Helpers\ContextHelper;
+
+use PHPCSUtils\Tokens\Collections;
+use WordPressCS\WordPress\Helpers\ContextHelper;
+use PHPCSUtils\TestUtils\UtilityMethodTestCase;
+
+/**
+ * Tests for the `ContextHelper::is_token_namespaced()` utility method.
+ *
+ * @since 3.3.0
+ *
+ * @covers \WordPressCS\WordPress\Helpers\ContextHelper::is_token_namespaced()
+ */
+final class IsTokenNamespacedUnitTest extends UtilityMethodTestCase {
+
+	/**
+	 * Test is_token_namespaced() returns false if the token does not exist.
+	 *
+	 * @return void
+	 */
+	public function testIsTokenNamespacedReturnFalseIfTokenDoesntExist() {
+		$this->assertFalse( ContextHelper::is_token_namespaced( self::$phpcsFile, -1 ) );
+	}
+
+	/**
+	 * Test is_token_namespaced() returns false for non-namespaced contexts.
+	 *
+	 * @dataProvider dataIsTokenNamespacedShouldReturnFalse
+	 *
+	 * @param string $commentString The comment which prefaces the target token in the test file.
+	 * @param string $tokenContent  The token content to use for the target token.
+	 *
+	 * @return void
+	 */
+	public function testIsTokenNamespacedShouldReturnFalse( $commentString, $tokenContent ) {
+		$stackPtr = $this->getTargetToken( $commentString, Collections::nameTokens(), $tokenContent );
+		$this->assertFalse( ContextHelper::is_token_namespaced( self::$phpcsFile, $stackPtr ) );
+	}
+
+	/**
+	 * Data provider.
+	 *
+	 * @return array
+	 * @see testIsTokenNamespacedShouldReturnFalse()
+	 */
+	public static function dataIsTokenNamespacedShouldReturnFalse() {
+		return array(
+			array( '/* test return false 1 */', 'my_function' ),
+			array( '/* test return false 2 */', 'my_function' ),
+			array( '/* test return false 3 */', 'MyClass' ),
+			array( '/* test return false 4 */', 'MyClass' ),
+			array( '/* test return false 5 */', 'MY_CONSTANT' ),
+			array( '/* test return false 6 */', 'MY_CONSTANT' ),
+		);
+	}
+
+	/**
+	 * Test is_token_namespaced() returns true for namespaced contexts.
+	 *
+	 * @dataProvider dataIsTokenNamespacedShouldReturnTrue
+	 *
+	 * @param string $commentString The comment which prefaces the target token in the test file.
+	 * @param string $tokenContent  The token content to use for the target token.
+	 *
+	 * @return void
+	 */
+	public function testIsTokenNamespacedShouldReturnTrue( $commentString, $tokenContent ) {
+		$stackPtr = $this->getTargetToken( $commentString, Collections::nameTokens(), $tokenContent );
+		$this->assertTrue( ContextHelper::is_token_namespaced( self::$phpcsFile, $stackPtr ) );
+	}
+
+	/**
+	 * Data provider.
+	 *
+	 * @return array
+	 * @see testIsTokenNamespacedShouldReturnTrue()
+	 */
+	public static function dataIsTokenNamespacedShouldReturnTrue() {
+		return array(
+			array( '/* test return true 1 */', 'my_function' ),
+			array( '/* test return true 2 */', 'my_function' ),
+			array( '/* test return true 3 */', 'my_function' ),
+			array( '/* test return true 4 */', 'MyClass' ),
+			array( '/* test return true 5 */', 'MY_CONSTANT' ),
+		);
+	}
+}