FileMgr

✏️ /opt/cpanel/ea-wappspector/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExplainTest.php

✕ Tutup

<?php
/**
 * Tests to verify that the "explain" command functions as expected.
 *
 * @author    Juliette Reinders Folmer <phpcs_nospam@adviesenzo.nl>
 * @copyright 2023 Juliette Reinders Folmer. All rights reserved.
 * @license   https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/HEAD/licence.txt BSD Licence
 */

namespace PHP_CodeSniffer\Tests\Core\Ruleset;

use PHP_CodeSniffer\Ruleset;
use PHP_CodeSniffer\Tests\ConfigDouble;
use PHPUnit\Framework\TestCase;

/**
 * Test the Ruleset::explain() function.
 *
 * @covers \PHP_CodeSniffer\Ruleset::explain
 */
final class ExplainTest extends TestCase
{

/**
     * Test the output of the "explain" command.
     *
     * @return void
     */
    public function testExplain()
    {
        // Set up the ruleset.
        $config  = new ConfigDouble(['--standard=PSR1', '-e']);
        $ruleset = new Ruleset($config);

$expected  = PHP_EOL;
        $expected .= 'The PSR1 standard contains 8 sniffs'.PHP_EOL.PHP_EOL;
        $expected .= 'Generic (4 sniffs)'.PHP_EOL;
        $expected .= '------------------'.PHP_EOL;
        $expected .= '  Generic.Files.ByteOrderMark'.PHP_EOL;
        $expected .= '  Generic.NamingConventions.UpperCaseConstantName'.PHP_EOL;
        $expected .= '  Generic.PHP.DisallowAlternativePHPTags'.PHP_EOL;
        $expected .= '  Generic.PHP.DisallowShortOpenTag'.PHP_EOL.PHP_EOL;
        $expected .= 'PSR1 (3 sniffs)'.PHP_EOL;
        $expected .= '---------------'.PHP_EOL;
        $expected .= '  PSR1.Classes.ClassDeclaration'.PHP_EOL;
        $expected .= '  PSR1.Files.SideEffects'.PHP_EOL;
        $expected .= '  PSR1.Methods.CamelCapsMethodName'.PHP_EOL.PHP_EOL;
        $expected .= 'Squiz (1 sniff)'.PHP_EOL;
        $expected .= '---------------'.PHP_EOL;
        $expected .= '  Squiz.Classes.ValidClassName'.PHP_EOL;

$this->expectOutputString($expected);

$ruleset->explain();

}//end testExplain()

/**
     * Test the output of the "explain" command is not influenced by a user set report width.
     *
     * @return void
     */
    public function testExplainAlwaysDisplaysCompleteSniffName()
    {
        // Set up the ruleset.
        $config  = new ConfigDouble(['--standard=PSR1', '-e', '--report-width=30']);
        $ruleset = new Ruleset($config);

$this->expectOutputString($expected);

$ruleset->explain();

}//end testExplainAlwaysDisplaysCompleteSniffName()

/**
     * Test the output of the "explain" command when a ruleset only contains a single sniff.
     *
     * This is mostly about making sure that the summary line uses the correct grammar.
     *
     * @return void
     */
    public function testExplainSingleSniff()
    {
        // Set up the ruleset.
        $standard = __DIR__.'/ExplainSingleSniffTest.xml';
        $config   = new ConfigDouble(["--standard=$standard", '-e']);
        $ruleset  = new Ruleset($config);

$expected  = PHP_EOL;
        $expected .= 'The ExplainSingleSniffTest standard contains 1 sniff'.PHP_EOL.PHP_EOL;
        $expected .= 'Squiz (1 sniff)'.PHP_EOL;
        $expected .= '---------------'.PHP_EOL;
        $expected .= '  Squiz.Scope.MethodScope'.PHP_EOL;

$this->expectOutputString($expected);

$ruleset->explain();

}//end testExplainSingleSniff()

/**
     * Test that "explain" works correctly with custom rulesets.
     *
     * Verifies that:
     * - The "standard" name is taken from the custom ruleset.
     * - Any and all sniff additions and exclusions in the ruleset are taken into account correctly.
     * - That the displayed list will have both the standards as well as the sniff names
     *   ordered alphabetically.
     *
     * @return void
     */
    public function testExplainCustomRuleset()
    {
        // Set up the ruleset.
        $standard = __DIR__.'/ExplainCustomRulesetTest.xml';
        $config   = new ConfigDouble(["--standard=$standard", '-e']);
        $ruleset  = new Ruleset($config);

$expected  = PHP_EOL;
        $expected .= 'The ExplainCustomRulesetTest standard contains 10 sniffs'.PHP_EOL.PHP_EOL;
        $expected .= 'Generic (4 sniffs)'.PHP_EOL;
        $expected .= '------------------'.PHP_EOL;
        $expected .= '  Generic.Files.ByteOrderMark'.PHP_EOL;
        $expected .= '  Generic.NamingConventions.UpperCaseConstantName'.PHP_EOL;
        $expected .= '  Generic.PHP.DisallowAlternativePHPTags'.PHP_EOL;
        $expected .= '  Generic.PHP.DisallowShortOpenTag'.PHP_EOL.PHP_EOL;
        $expected .= 'PSR1 (2 sniffs)'.PHP_EOL;
        $expected .= '---------------'.PHP_EOL;
        $expected .= '  PSR1.Classes.ClassDeclaration'.PHP_EOL;
        $expected .= '  PSR1.Methods.CamelCapsMethodName'.PHP_EOL.PHP_EOL;
        $expected .= 'PSR12 (2 sniffs)'.PHP_EOL;
        $expected .= '----------------'.PHP_EOL;
        $expected .= '  PSR12.ControlStructures.BooleanOperatorPlacement'.PHP_EOL;
        $expected .= '  PSR12.ControlStructures.ControlStructureSpacing'.PHP_EOL.PHP_EOL;
        $expected .= 'Squiz (2 sniffs)'.PHP_EOL;
        $expected .= '----------------'.PHP_EOL;
        $expected .= '  Squiz.Classes.ValidClassName'.PHP_EOL;
        $expected .= '  Squiz.Scope.MethodScope'.PHP_EOL;

$this->expectOutputString($expected);

$ruleset->explain();

}//end testExplainCustomRuleset()

/**
     * Test the output of the "explain" command for a standard containing both deprecated
     * and non-deprecated sniffs.
     *
     * Tests that:
     * - Deprecated sniffs are marked with an asterix in the list.
     * - A footnote is displayed explaining the asterix.
     * - And that the "standard uses # deprecated sniffs" listing is **not** displayed.
     *
     * @return void
     */
    public function testExplainWithDeprecatedSniffs()
    {
        // Set up the ruleset.
        $standard = __DIR__."/ShowSniffDeprecationsTest.xml";
        $config   = new ConfigDouble(["--standard=$standard", '-e']);
        $ruleset  = new Ruleset($config);

$expected  = PHP_EOL;
        $expected .= 'The ShowSniffDeprecationsTest standard contains 11 sniffs'.PHP_EOL.PHP_EOL;

$expected .= 'TestStandard (11 sniffs)'.PHP_EOL;
        $expected .= '------------------------'.PHP_EOL;
        $expected .= '  TestStandard.Deprecated.WithLongReplacement *'.PHP_EOL;
        $expected .= '  TestStandard.Deprecated.WithoutReplacement *'.PHP_EOL;
        $expected .= '  TestStandard.Deprecated.WithReplacement *'.PHP_EOL;
        $expected .= '  TestStandard.Deprecated.WithReplacementContainingLinuxNewlines *'.PHP_EOL;
        $expected .= '  TestStandard.Deprecated.WithReplacementContainingNewlines *'.PHP_EOL;
        $expected .= '  TestStandard.SetProperty.AllowedAsDeclared'.PHP_EOL;
        $expected .= '  TestStandard.SetProperty.AllowedViaMagicMethod'.PHP_EOL;
        $expected .= '  TestStandard.SetProperty.AllowedViaStdClass'.PHP_EOL;
        $expected .= '  TestStandard.SetProperty.NotAllowedViaAttribute'.PHP_EOL;
        $expected .= '  TestStandard.SetProperty.PropertyTypeHandling'.PHP_EOL;
        $expected .= '  TestStandard.ValidSniffs.RegisterEmptyArray'.PHP_EOL.PHP_EOL;

$expected .= '* Sniffs marked with an asterisk are deprecated.'.PHP_EOL;

$this->expectOutputString($expected);

$ruleset->explain();

}//end testExplainWithDeprecatedSniffs()

}//end class

Batal

⬅ Core 93 item

Nama	Tipe	Ukuran	Diubah	Perm	Aksi
📁 Fixtures	dir	—	04/11/25 23:30	0755	📂
🐘 AbstractRulesetTestCase.php	php	3.8 KB	04/11/25 23:30	0644	✏️ ⬇
📄 ConstructorNoSniffsTest.xml	xml	217 B	04/11/25 23:30	0644	✏️ ⬇
🐘 ConstructorTest.php	php	11.1 KB	04/11/25 23:30	0644	✏️ ⬇
🐘 DisplayCachedMessagesTest.php	php	10.8 KB	04/11/25 23:30	0644	✏️ ⬇
📄 ExpandRulesetReferenceCaseMismatch1Test.xml	xml	512 B	04/11/25 23:30	0644	✏️ ⬇
📄 ExpandRulesetReferenceCaseMismatch2Test.xml	xml	547 B	04/11/25 23:30	0644	✏️ ⬇
📄 ExpandRulesetReferenceHomePathFailTest.xml	xml	425 B	04/11/25 23:30	0644	✏️ ⬇
🐘 ExpandRulesetReferenceHomePathTest.php	php	3.5 KB	04/11/25 23:30	0644	✏️ ⬇
📄 ExpandRulesetReferenceHomePathTest.xml	xml	337 B	04/11/25 23:30	0644	✏️ ⬇
📄 ExpandRulesetReferenceInternalIgnoreTest.xml	xml	643 B	04/11/25 23:30	0644	✏️ ⬇
📄 ExpandRulesetReferenceInternalStandardTest.xml	xml	330 B	04/11/25 23:30	0644	✏️ ⬇
🐘 ExpandRulesetReferenceInternalTest.php	php	2.5 KB	04/11/25 23:30	0644	✏️ ⬇
📄 ExpandRulesetReferenceInvalidErrorCode1Test.xml	xml	332 B	04/11/25 23:30	0644	✏️ ⬇
📄 ExpandRulesetReferenceInvalidErrorCode2Test.xml	xml	333 B	04/11/25 23:30	0644	✏️ ⬇
📄 ExpandRulesetReferenceInvalidErrorCode3Test.xml	xml	325 B	04/11/25 23:30	0644	✏️ ⬇
📄 ExpandRulesetReferenceInvalidHomePathRefTest.xml	xml	434 B	04/11/25 23:30	0644	✏️ ⬇
📄 ExpandRulesetReferenceMissingFileTest.xml	xml	364 B	04/11/25 23:30	0644	✏️ ⬇
🐘 ExpandRulesetReferenceTest.php	php	5.4 KB	04/11/25 23:30	0644	✏️ ⬇
📄 ExpandRulesetReferenceTest.xml	xml	621 B	04/11/25 23:30	0644	✏️ ⬇
📄 ExpandRulesetReferenceUnknownCategoryTest.xml	xml	508 B	04/11/25 23:30	0644	✏️ ⬇
📄 ExpandRulesetReferenceUnknownSniffTest.xml	xml	515 B	04/11/25 23:30	0644	✏️ ⬇
📄 ExpandRulesetReferenceUnknownStandardTest.xml	xml	469 B	04/11/25 23:30	0644	✏️ ⬇
🐘 ExpandSniffDirectoryTest.php	php	2.5 KB	04/11/25 23:30	0644	✏️ ⬇
📄 ExpandSniffDirectoryTest.xml	xml	349 B	04/11/25 23:30	0644	✏️ ⬇
📄 ExplainCustomRulesetTest.xml	xml	374 B	04/11/25 23:30	0644	✏️ ⬇
📄 ExplainSingleSniffTest.xml	xml	247 B	04/11/25 23:30	0644	✏️ ⬇
🐘 ExplainTest.php	php	8.2 KB	04/11/25 23:30	0644	✏️ ⬇
🐘 GetIgnorePatternsTest.php	php	3.4 KB	04/11/25 23:30	0644	✏️ ⬇
📄 GetIgnorePatternsTest.xml	xml	742 B	04/11/25 23:30	0644	✏️ ⬇
🐘 GetIncludePatternsTest.php	php	3.2 KB	04/11/25 23:30	0644	✏️ ⬇
📄 GetIncludePatternsTest.xml	xml	556 B	04/11/25 23:30	0644	✏️ ⬇
🐘 PopulateTokenListenersNamingConventionsTest.php	php	4.7 KB	04/11/25 23:30	0644	✏️ ⬇
📄 PopulateTokenListenersNamingConventionsTest.xml	xml	1.6 KB	04/11/25 23:30	0644	✏️ ⬇
📄 PopulateTokenListenersRegisterNoArrayTest.xml	xml	465 B	04/11/25 23:30	0644	✏️ ⬇
🐘 PopulateTokenListenersSupportedTokenizersTest.php	php	4.1 KB	04/11/25 23:30	0644	✏️ ⬇
📄 PopulateTokenListenersSupportedTokenizersTest.xml	xml	369 B	04/11/25 23:30	0644	✏️ ⬇
🐘 PopulateTokenListenersTest.php	php	21.1 KB	04/11/25 23:30	0644	✏️ ⬇
📄 PopulateTokenListenersTest.xml	xml	2 KB	04/11/25 23:30	0644	✏️ ⬇
🐘 ProcessRuleInvalidTypeTest.php	php	1.2 KB	04/11/25 23:30	0644	✏️ ⬇
📄 ProcessRuleInvalidTypeTest.xml	xml	345 B	04/11/25 23:30	0644	✏️ ⬇
🐘 ProcessRuleShouldProcessElementTest.php	php	24.7 KB	04/11/25 23:30	0644	✏️ ⬇
📄 ProcessRuleShouldProcessElementTest.xml	xml	3.3 KB	04/11/25 23:30	0644	✏️ ⬇
📄 ProcessRulesetAutoExpandSniffsDirectoryTest.xml	xml	592 B	04/11/25 23:30	0644	✏️ ⬇
📄 ProcessRulesetAutoloadFileNotFoundTest.xml	xml	394 B	04/11/25 23:30	0644	✏️ ⬇
🐘 ProcessRulesetAutoloadTest.php	php	6.1 KB	04/11/25 23:30	0644	✏️ ⬇
📄 ProcessRulesetAutoloadTest.xml	xml	1.4 KB	04/11/25 23:30	0644	✏️ ⬇
📄 ProcessRulesetBrokenRulesetEmptyFileTest.xml	xml	0 B	04/11/25 23:30	0644	✏️ ⬇
📄 ProcessRulesetBrokenRulesetMultiErrorTest.xml	xml	420 B	04/11/25 23:30	0644	✏️ ⬇
📄 ProcessRulesetBrokenRulesetSingleErrorTest.xml	xml	201 B	04/11/25 23:30	0644	✏️ ⬇
🐘 ProcessRulesetBrokenRulesetTest.php	php	3.1 KB	04/11/25 23:30	0644	✏️ ⬇
📄 ProcessRulesetExcludeSniffGroupTest.xml	xml	362 B	04/11/25 23:30	0644	✏️ ⬇
📄 ProcessRulesetInvalidNoSniffsDirTest.xml	xml	439 B	04/11/25 23:30	0644	✏️ ⬇
📄 ProcessRulesetMiscTest.xml	xml	997 B	04/11/25 23:30	0644	✏️ ⬇
🐘 ProcessRulesetShouldProcessElementTest.php	php	12.4 KB	04/11/25 23:30	0644	✏️ ⬇
📄 ProcessRulesetShouldProcessElementTest.xml	xml	1.7 KB	04/11/25 23:30	0644	✏️ ⬇
🐘 ProcessRulesetTest.php	php	11.2 KB	04/11/25 23:30	0644	✏️ ⬇
📄 PropertyTypeHandlingInlineTest.xml	xml	317 B	04/11/25 23:30	0644	✏️ ⬇
🐘 PropertyTypeHandlingTest.php	php	12 KB	04/11/25 23:30	0644	✏️ ⬇
📄 PropertyTypeHandlingTest.xml	xml	3.8 KB	04/11/25 23:30	0644	✏️ ⬇
📄 RegisterSniffsMissingInterfaceInvalidTest.xml	xml	355 B	04/11/25 23:30	0644	✏️ ⬇
🐘 RegisterSniffsMissingInterfaceTest.php	php	2.1 KB	04/11/25 23:30	0644	✏️ ⬇
📄 RegisterSniffsMissingInterfaceValidTest.xml	xml	446 B	04/11/25 23:30	0644	✏️ ⬇
📄 RegisterSniffsRejectsInvalidSniffNoImplementsNoProcessTest.xml	xml	444 B	04/11/25 23:30	0644	✏️ ⬇
📄 RegisterSniffsRejectsInvalidSniffNoImplementsNoRegisterOrProcessTest.xml	xml	454 B	04/11/25 23:30	0644	✏️ ⬇
📄 RegisterSniffsRejectsInvalidSniffNoImplementsNoRegisterTest.xml	xml	445 B	04/11/25 23:30	0644	✏️ ⬇
🐘 RegisterSniffsRejectsInvalidSniffTest.php	php	2.7 KB	04/11/25 23:30	0644	✏️ ⬇
🐘 RegisterSniffsTest.php	php	10.3 KB	04/11/25 23:30	0644	✏️ ⬇
🐘 RuleInclusionAbsoluteLinuxTest.php	php	3.3 KB	04/11/25 23:30	0644	✏️ ⬇
📄 RuleInclusionAbsoluteLinuxTest.xml	xml	482 B	04/11/25 23:30	0644	✏️ ⬇
🐘 RuleInclusionAbsoluteWindowsTest.php	php	3.2 KB	04/11/25 23:30	0644	✏️ ⬇
📄 RuleInclusionAbsoluteWindowsTest.xml	xml	479 B	04/11/25 23:30	0644	✏️ ⬇
📄 RuleInclusionTest-include.xml	xml	364 B	04/11/25 23:30	0644	✏️ ⬇
🐘 RuleInclusionTest.php	php	18.6 KB	04/11/25 23:30	0644	✏️ ⬇
📄 RuleInclusionTest.xml	xml	1.8 KB	04/11/25 23:30	0644	✏️ ⬇
📄 SetPropertyAllowedAsDeclaredTest.xml	xml	728 B	04/11/25 23:30	0644	✏️ ⬇
📄 SetPropertyAllowedViaMagicMethodTest.xml	xml	732 B	04/11/25 23:30	0644	✏️ ⬇
📄 SetPropertyAllowedViaStdClassTest.xml	xml	729 B	04/11/25 23:30	0644	✏️ ⬇
📄 SetPropertyAppliesPropertyToMultipleSniffsInCategoryTest.xml	xml	338 B	04/11/25 23:30	0644	✏️ ⬇
📄 SetPropertyDoesNotThrowErrorOnInvalidPropertyWhenSetForCategoryTest.xml	xml	343 B	04/11/25 23:30	0644	✏️ ⬇
📄 SetPropertyDoesNotThrowErrorOnInvalidPropertyWhenSetForStandardTest.xml	xml	376 B	04/11/25 23:30	0644	✏️ ⬇
📄 SetPropertyNotAllowedViaAttributeTest.xml	xml	439 B	04/11/25 23:30	0644	✏️ ⬇
📄 SetPropertyThrowsErrorOnInvalidPropertyTest.xml	xml	354 B	04/11/25 23:30	0644	✏️ ⬇
🐘 SetSniffPropertyTest.php	php	16.7 KB	04/11/25 23:30	0644	✏️ ⬇
📄 ShowSniffDeprecationsEmptyDeprecationVersionTest.xml	xml	371 B	04/11/25 23:30	0644	✏️ ⬇
📄 ShowSniffDeprecationsEmptyRemovalVersionTest.xml	xml	367 B	04/11/25 23:30	0644	✏️ ⬇
📄 ShowSniffDeprecationsInvalidDeprecationMessageTest.xml	xml	373 B	04/11/25 23:30	0644	✏️ ⬇
📄 ShowSniffDeprecationsInvalidDeprecationVersionTest.xml	xml	373 B	04/11/25 23:30	0644	✏️ ⬇
📄 ShowSniffDeprecationsInvalidRemovalVersionTest.xml	xml	369 B	04/11/25 23:30	0644	✏️ ⬇
📄 ShowSniffDeprecationsOrderTest.xml	xml	513 B	04/11/25 23:30	0644	✏️ ⬇
📄 ShowSniffDeprecationsReportWidthTest.xml	xml	360 B	04/11/25 23:30	0644	✏️ ⬇
🐘 ShowSniffDeprecationsTest.php	php	25.6 KB	04/11/25 23:30	0644	✏️ ⬇
📄 ShowSniffDeprecationsTest.xml	xml	622 B	04/11/25 23:30	0644	✏️ ⬇

✏️ Rename

🔑 Ubah Permission