Run PHPCS setup code only once per instance of the XMLDocValidator class

Author: rodrigoprimo

Scripts/DocCodeExamples/XmlDocValidator.php

@@ -59,6 +59,13 @@ class XmlDocValidator
      */
     private $phpcsConfig;
 
+    /**
+     * The PHPCS ruleset object.
+     *
+     * @var \PHP_CodeSniffer\Ruleset
+     */
+    private $phpcsRuleset;
+
     /**
      * A helper object to write output.
      *
@@ -137,6 +144,8 @@ public function __construct(
      */
     public function validate(): bool
     {
+        $this->setUpPhpcs();
+
         $validated = true;
 
         $codeBlocks        = $this->extractor->extract($this->path);
@@ -153,6 +162,29 @@ public function validate(): bool
         return $validated;
     }
 
+    /**
+     * Set up the PHPCS to be able to run the sniff against a code example programmatically.
+     *
+     * @return void
+     */
+    private function setUpPhpcs()
+    {
+        if (\defined('PHP_CODESNIFFER_VERBOSITY') === false) {
+            \define('PHP_CODESNIFFER_VERBOSITY', 0);
+        }
+
+        if (\defined('PHP_CODESNIFFER_CBF') === false) {
+            \define('PHP_CODESNIFFER_CBF', false);
+        }
+
+        $this->phpcsConfig->standards = [$this->standard];
+        $this->phpcsConfig->sniffs    = [$this->sniff];
+
+        new Tokens(); // @phpstan-ignore new.resultUnused
+
+        $this->phpcsRuleset = new Ruleset($this->phpcsConfig);
+    }
+
     /**
      * Verify code blocks of a given section (valid or invalid).
      *
@@ -164,7 +196,7 @@ public function validate(): bool
      *
      * @return bool
      */
-    protected function verifyCodeBlocks(array $codeBlocks, bool $isExpectedToBeValid): bool
+    private function verifyCodeBlocks(array $codeBlocks, bool $isExpectedToBeValid): bool
     {
         $codeBlocksPassedValidation = true;
 
@@ -208,27 +240,13 @@ private function verifyCodeBlock(CodeBlock $codeBlock, bool $isExpectedToBeValid
             $codeBlockBehavesAsExpected = false;
         }
 
-        if (\defined('PHP_CODESNIFFER_VERBOSITY') === false) {
-            \define('PHP_CODESNIFFER_VERBOSITY', 0);
-        }
-
-        if (\defined('PHP_CODESNIFFER_CBF') === false) {
-            \define('PHP_CODESNIFFER_CBF', false);
-        }
-
-        $this->phpcsConfig->standards = [$this->standard];
-        $this->phpcsConfig->sniffs    = [$this->sniff];
-
-        new Tokens(); // @phpstan-ignore new.resultUnused
-        $ruleset = new Ruleset($this->phpcsConfig);
-
         // Set a unique file name for the DummyFile instance to avoid cache conflicts for
         // sniffs that rely on PHPCSUtils functionality.
         $dummyFileName = md5($this->sniff . $codeBlock->position);
         $fileContents  = 'phpcs_input_file: ' . $dummyFileName . PHP_EOL;
         $fileContents .= $codeBlockContent;
 
-        $file = new DummyFile($fileContents, $ruleset, $this->phpcsConfig);
+        $file = new DummyFile($fileContents, $this->phpcsRuleset, $this->phpcsConfig);
         $file->process();
 
         if ($isExpectedToBeValid === true && ($file->getErrorCount() !== 0 || $file->getWarningCount() !== 0)) {