From dc76ab95dfcbb44be1778edcd38dc9664012cb9a Mon Sep 17 00:00:00 2001
From: Guy Sartorelli <guy.sartorelli@silverstripe.com>
Date: Thu, 2 Nov 2023 11:25:47 +1300
Subject: [PATCH] ENH Tidy-up code

---
 bin/mdphpcs              |  2 +-
 composer.json            |  4 ++--
 src/CodeBlock.php        | 19 ++++++++++++++++++-
 src/FixerReport.php      |  2 +-
 src/Sniffer.php          | 18 ++++++++++++------
 tests/CodeBlockTest.php  |  8 ++++----
 tests/SnifferFixTest.php |  4 ++--
 tests/SnifferTest.php    |  4 ++--
 8 files changed, 42 insertions(+), 19 deletions(-)

diff --git a/bin/mdphpcs b/bin/mdphpcs
index c70ed55..e7af6ae 100755
--- a/bin/mdphpcs
+++ b/bin/mdphpcs
@@ -2,7 +2,7 @@
 <?php
 
 use PHP_CodeSniffer\Exceptions\DeepExitException;
-use SilverStripe\MD_PHP_CodeSniffer\Sniffer;
+use SilverStripe\MarkdownPhpCodeSniffer\Sniffer;
 
 // php_codesniffer autoloader (which itself includes the composer autoloader)
 $autoloadCandidates = [
diff --git a/composer.json b/composer.json
index 3da10e0..5a8c847 100644
--- a/composer.json
+++ b/composer.json
@@ -16,8 +16,8 @@
     },
     "autoload": {
         "psr-4": {
-            "SilverStripe\\MD_PHP_CodeSniffer\\": "src/",
-            "SilverStripe\\MD_PHP_CodeSniffer\\Tests\\": "tests/"
+            "SilverStripe\\MarkdownPhpCodeSniffer\\": "src/",
+            "SilverStripe\\MarkdownPhpCodeSniffer\\Tests\\": "tests/"
         }
     },
     "bin": [
diff --git a/src/CodeBlock.php b/src/CodeBlock.php
index 84873cb..3f01148 100644
--- a/src/CodeBlock.php
+++ b/src/CodeBlock.php
@@ -1,8 +1,10 @@
 <?php
 
-namespace SilverStripe\MD_PHP_CodeSniffer;
+namespace SilverStripe\MarkdownPhpCodeSniffer;
 
+use PHP_CodeSniffer\Config;
 use PHP_CodeSniffer\Files\DummyFile;
+use PHP_CodeSniffer\Ruleset;
 
 class CodeBlock extends DummyFile
 {
@@ -12,6 +14,21 @@ class CodeBlock extends DummyFile
 
     private string $finalContent = '';
 
+    public function __construct(
+        Ruleset $ruleset,
+        Config $config,
+        string $content,
+        string $path,
+        string $realPath,
+        int $num
+    ) {
+        parent::__construct($content, $ruleset, $config);
+
+        $this->path = $path;
+        $this->realPath = $realPath;
+        $this->num = $num;
+    }
+
     public function cleanUp()
     {
         $this->finalContent = $this->content ?? '';
diff --git a/src/FixerReport.php b/src/FixerReport.php
index c43d8f0..e86d5ea 100644
--- a/src/FixerReport.php
+++ b/src/FixerReport.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace SilverStripe\MD_PHP_CodeSniffer;
+namespace SilverStripe\MarkdownPhpCodeSniffer;
 
 use PHP_CodeSniffer\Exceptions\DeepExitException;
 use PHP_CodeSniffer\Files\File;
diff --git a/src/Sniffer.php b/src/Sniffer.php
index 013c4d2..feeae2d 100644
--- a/src/Sniffer.php
+++ b/src/Sniffer.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace SilverStripe\MD_PHP_CodeSniffer;
+namespace SilverStripe\MarkdownPhpCodeSniffer;
 
 use League\CommonMark\Environment\Environment;
 use League\CommonMark\Extension\CommonMark\CommonMarkCoreExtension;
@@ -65,10 +65,14 @@ public function run(string $lintLanguage, bool $fixing, bool $usingExplicitStand
         // Add code blocks to the file list for linting
         $todo = [];
         foreach ($codeBlocks as $block) {
-            $dummy = new CodeBlock($block['content'], $sniffer->ruleset, $sniffer->config);
-            $dummy->num = $block['num'];
-            $dummy->path = $block['path'];
-            $dummy->realPath = $block['realpath'];
+            $dummy = new CodeBlock(
+                $sniffer->ruleset,
+                $sniffer->config,
+                $block['content'],
+                $block['path'],
+                $block['realpath'],
+                $block['num']
+            );
             $todo[] = $dummy;
         }
 
@@ -107,6 +111,7 @@ public function run(string $lintLanguage, bool $fixing, bool $usingExplicitStand
 
         $sniffer->reporter->printReports();
 
+        // These return values are directly from Runner::runPHPCS()
         if ($numErrors === 0) {
             // No errors found.
             return 0;
@@ -148,6 +153,7 @@ private function prepareConfig(bool $usingExplicitStandard, string $lintLanguage
             $config->standards = [__DIR__ . '/../phpcs.default.xml'];
         }
 
+        // Most of these overrides are directly from Runner::runPHPCBF()
         if ($fixing) {
             // Override some of the command line settings that might break the fixes.
             $config->generator = null;
@@ -228,7 +234,7 @@ private function sniff(Runner $sniffer, array $todo): int
         // Turn all sniff errors into exceptions.
         set_error_handler([$sniffer, 'handleErrors']);
 
-        $lastDir  = '';
+        $lastDir = '';
         $numBlocks = count($todo);
 
         // Process each block sequentially - running sniff in parallel isn't supported
diff --git a/tests/CodeBlockTest.php b/tests/CodeBlockTest.php
index edb18ca..604b294 100644
--- a/tests/CodeBlockTest.php
+++ b/tests/CodeBlockTest.php
@@ -1,12 +1,12 @@
 <?php
 
-namespace SilverStripe\MD_PHP_CodeSniffer\Test;
+namespace SilverStripe\MarkdownPhpCodeSniffer\Test;
 
 use ReflectionProperty;
 use PHP_CodeSniffer\Config;
 use PHP_CodeSniffer\Ruleset;
 use PHPUnit\Framework\TestCase;
-use SilverStripe\MD_PHP_CodeSniffer\CodeBlock;
+use SilverStripe\MarkdownPhpCodeSniffer\CodeBlock;
 
 class CodeBlockTest extends TestCase
 {
@@ -22,7 +22,7 @@ public static function setUpBeforeClass(): void
     public function testGetContent()
     {
         $config = new Config();
-        $block = new CodeBlock('This is the content', new Ruleset($config), $config);
+        $block = new CodeBlock(new Ruleset($config), $config, 'This is the content', '', '', 0);
 
         $this->assertSame('This is the content', $block->getContent());
 
@@ -34,7 +34,7 @@ public function testGetContent()
     public function testCleanup()
     {
         $config = new Config();
-        $block = new CodeBlock('This is the content', new Ruleset($config), $config);
+        $block = new CodeBlock(new Ruleset($config), $config, 'This is the content', '', '', 0);
         $block->cleanUp();
 
         $this->assertSame('This is the content', $block->getContent());
diff --git a/tests/SnifferFixTest.php b/tests/SnifferFixTest.php
index 211ec4a..c3429cb 100644
--- a/tests/SnifferFixTest.php
+++ b/tests/SnifferFixTest.php
@@ -1,12 +1,12 @@
 <?php
 
-namespace SilverStripe\MD_PHP_CodeSniffer\Test;
+namespace SilverStripe\MarkdownPhpCodeSniffer\Test;
 
 use PHP_CodeSniffer\Files\FileList;
 use PHP_CodeSniffer\Ruleset;
 use PHPUnit\Framework\TestCase;
 use ReflectionMethod;
-use SilverStripe\MD_PHP_CodeSniffer\Sniffer;
+use SilverStripe\MarkdownPhpCodeSniffer\Sniffer;
 
 /**
  * Because of PHP CodeSniffer's reliance on constants, this has to be done separately from the other tests.
diff --git a/tests/SnifferTest.php b/tests/SnifferTest.php
index 6de735b..e5f9dfc 100644
--- a/tests/SnifferTest.php
+++ b/tests/SnifferTest.php
@@ -1,12 +1,12 @@
 <?php
 
-namespace SilverStripe\MD_PHP_CodeSniffer\Test;
+namespace SilverStripe\MarkdownPhpCodeSniffer\Test;
 
 use PHP_CodeSniffer\Files\FileList;
 use PHP_CodeSniffer\Ruleset;
 use PHPUnit\Framework\TestCase;
 use ReflectionMethod;
-use SilverStripe\MD_PHP_CodeSniffer\Sniffer;
+use SilverStripe\MarkdownPhpCodeSniffer\Sniffer;
 
 class SnifferTest extends TestCase
 {