­ ­ ­ ­ ­ ­ ­ ­ ­ ­ ­ ­ ­ ­ ­ ­ ­ ­ * @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/HEAD/licence.txt BSD Licence */ namespace PHP_CodeSniffer\Tests\Core\Files\File; use PHP_CodeSniffer\Tests\Core\AbstractMethodUnitTest; /** * Tests for the \PHP_CodeSniffer\Files\File::findImplementedInterfaceNames method. * * @covers \PHP_CodeSniffer\Files\File::findImplementedInterfaceNames */ final class FindImplementedInterfaceNamesTest extends AbstractMethodUnitTest { /** * Test getting a `false` result when a non-existent token is passed. * * @return void */ public function testNonExistentToken() { $result = self::$phpcsFile->findImplementedInterfaceNames(100000); $this->assertFalse($result); }//end testNonExistentToken() /** * Test getting a `false` result when a token other than one of the supported tokens is passed. * * @return void */ public function testNotAClass() { $token = $this->getTargetToken('/* testNotAClass */', [T_FUNCTION]); $result = self::$phpcsFile->findImplementedInterfaceNames($token); $this->assertFalse($result); }//end testNotAClass() /** * Test retrieving the name(s) of the interfaces being implemented by a class. * * @param string $identifier Comment which precedes the test case. * @param array|false $expected Expected function output. * * @dataProvider dataImplementedInterface * * @return void */ public function testFindImplementedInterfaceNames($identifier, $expected) { $OOToken = $this->getTargetToken($identifier, [T_CLASS, T_ANON_CLASS, T_INTERFACE, T_ENUM]); $result = self::$phpcsFile->findImplementedInterfaceNames($OOToken); $this->assertSame($expected, $result); }//end testFindImplementedInterfaceNames() /** * Data provider for the FindImplementedInterfaceNames test. * * @see testFindImplementedInterfaceNames() * * @return array|false>> */ public static function dataImplementedInterface() { return [ 'interface declaration, no implements' => [ 'identifier' => '/* testPlainInterface */', 'expected' => false, ], 'class does not implement' => [ 'identifier' => '/* testNonImplementedClass */', 'expected' => false, ], 'class implements single interface, unqualified' => [ 'identifier' => '/* testClassImplementsSingle */', 'expected' => [ 'testFIINInterface', ], ], 'class implements multiple interfaces' => [ 'identifier' => '/* testClassImplementsMultiple */', 'expected' => [ 'testFIINInterface', 'testFIINInterface2', ], ], 'class implements single interface, fully qualified' => [ 'identifier' => '/* testImplementsFullyQualified */', 'expected' => [ '\PHP_CodeSniffer\Tests\Core\File\testFIINInterface', ], ], 'class implements single interface, partially qualified' => [ 'identifier' => '/* testImplementsPartiallyQualified */', 'expected' => [ 'Core\File\RelativeInterface', ], ], 'class extends and implements' => [ 'identifier' => '/* testClassThatExtendsAndImplements */', 'expected' => [ 'InterfaceA', '\NameSpaced\Cat\InterfaceB', ], ], 'class implements and extends' => [ 'identifier' => '/* testClassThatImplementsAndExtends */', 'expected' => [ '\InterfaceA', 'InterfaceB', ], ], 'enum does not implement' => [ 'identifier' => '/* testBackedEnumWithoutImplements */', 'expected' => false, ], 'enum implements single interface, unqualified' => [ 'identifier' => '/* testEnumImplementsSingle */', 'expected' => [ 'Colorful', ], ], 'enum implements multiple interfaces, unqualified + fully qualified' => [ 'identifier' => '/* testBackedEnumImplementsMulti */', 'expected' => [ 'Colorful', '\Deck', ], ], 'anon class implements single interface, unqualified' => [ 'identifier' => '/* testAnonClassImplementsSingle */', 'expected' => [ 'testFIINInterface', ], ], 'parse error - implements keyword, but no interface name' => [ 'identifier' => '/* testMissingImplementsName */', 'expected' => false, ], 'parse error - live coding - no curly braces' => [ 'identifier' => '/* testParseError */', 'expected' => false, ], ]; }//end dataImplementedInterface() }//end class