Ruleset::expandRulesetReference(): test handling "Internal" references

Author: jrfnl

tests/Core/Ruleset/ExpandRulesetReferenceInternalIgnoreTest.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0"?>
+<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="ExpandRulesetReferenceInternalTest" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/PHPCSStandards/PHP_CodeSniffer/master/phpcs.xsd">
+
+    <config name="installed_paths" value="./tests/Core/Ruleset/Fixtures/Internal/"/>
+
+    <rule ref="Internal.NoCodeFound">
+        <severity>0</severity>
+    </rule>
+
+    <!-- While this references a valid sniff category, it will be ignored anyway as the ref starts with "Internal". -->
+    <rule ref="Internal.Valid"/>
+
+    <!-- Prevent a "no sniff were registered" error. -->
+    <rule ref="Generic.PHP.BacktickOperator"/>
+</ruleset>

tests/Core/Ruleset/ExpandRulesetReferenceInternalStandardTest.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0"?>
+<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="ExpandRulesetReferenceInternalTest" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/PHPCSStandards/PHP_CodeSniffer/master/phpcs.xsd">
+
+    <config name="installed_paths" value="./tests/Core/Ruleset/Fixtures/Internal/"/>
+
+    <rule ref="Internal"/>
+
+</ruleset>

tests/Core/Ruleset/ExpandRulesetReferenceInternalTest.php

@@ -0,0 +1,66 @@
+<?php
+/**
+ * Test the Ruleset::expandRulesetReference() method.
+ *
+ * @author    Juliette Reinders Folmer <[email protected]>
+ * @copyright 2025 PHPCSStandards and contributors
+ * @license   https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
+ */
+
+namespace PHP_CodeSniffer\Tests\Core\Ruleset;
+
+use PHP_CodeSniffer\Ruleset;
+use PHP_CodeSniffer\Tests\ConfigDouble;
+use PHP_CodeSniffer\Tests\Core\Ruleset\AbstractRulesetTestCase;
+
+/**
+ * Test handling of "internal" references in the Ruleset::expandRulesetReference() method.
+ *
+ * @covers \PHP_CodeSniffer\Ruleset::expandRulesetReference
+ */
+final class ExpandRulesetReferenceInternalTest extends AbstractRulesetTestCase
+{
+
+
+    /**
+     * Verify that a ruleset reference starting with "Internal." (including the dot) doesn't cause any sniffs to be registered.
+     *
+     * @return void
+     */
+    public function testInternalRefDoesNotGetExpanded()
+    {
+        // Set up the ruleset.
+        $standard = __DIR__.'/ExpandRulesetReferenceInternalIgnoreTest.xml';
+        $config   = new ConfigDouble(["--standard=$standard"]);
+        $ruleset  = new Ruleset($config);
+
+        $expected = ['Generic.PHP.BacktickOperator' => 'PHP_CodeSniffer\\Standards\\Generic\\Sniffs\\PHP\\BacktickOperatorSniff'];
+
+        $this->assertSame($expected, $ruleset->sniffCodes);
+
+    }//end testInternalRefDoesNotGetExpanded()
+
+
+    /**
+     * While definitely not recommended, including a standard named "Internal", _does_ allow for sniffs to be registered.
+     *
+     * Note: customizations (exclusions/property setting etc) for individual sniffs may not always be handled correctly,
+     * which is why naming a standard "Internal" is definitely not recommended.
+     *
+     * @return void
+     */
+    public function testInternalStandardDoesGetExpanded()
+    {
+        // Set up the ruleset.
+        $standard = __DIR__.'/ExpandRulesetReferenceInternalStandardTest.xml';
+        $config   = new ConfigDouble(["--standard=$standard"]);
+        $ruleset  = new Ruleset($config);
+
+        $expected = ['Internal.Valid.Valid' => 'Fixtures\\Internal\\Sniffs\\Valid\\ValidSniff'];
+
+        $this->assertSame($expected, $ruleset->sniffCodes);
+
+    }//end testInternalStandardDoesGetExpanded()
+
+
+}//end class

tests/Core/Ruleset/Fixtures/Internal/Sniffs/Valid/ValidSniff.php

@@ -0,0 +1,25 @@
+<?php
+/**
+ * Test fixture.
+ *
+ * @see \PHP_CodeSniffer\Tests\Core\Ruleset\ExpandRulesetReferenceInternalTest
+ */
+
+namespace Fixtures\Internal\Sniffs\Valid;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+
+class ValidSniff implements Sniff
+{
+
+    public function register()
+    {
+        return [T_CLASS];
+    }
+
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        // Do something.
+    }
+}

tests/Core/Ruleset/Fixtures/Internal/ruleset.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0"?>
+<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="Internal" namespace="Fixtures\Internal" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/PHPCSStandards/PHP_CodeSniffer/master/phpcs.xsd">
+
+    <!--
+    A standard named "Internal" can be included, but individual categories or sniffs from that standard cannot.
+    In other words: standards should not be named "Internal".
+
+    This test fixture helps document and safeguard the current behaviour for standards named "Internal".
+    -->
+
+</ruleset>