refactor(name-parser): make class fully static

Author: nunomaduro

src/Checkers/ClassChecker.php

@@ -7,7 +7,7 @@
 use Peck\Config;
 use Peck\Contracts\Checker;
 use Peck\Contracts\Services\Spellchecker;
-use Peck\Services\NameParser;
+use Peck\Support\NameParser;
 use Peck\ValueObjects\Issue;
 use Peck\ValueObjects\Misspelling;
 use ReflectionClass;
@@ -27,7 +27,6 @@
      */
     public function __construct(
         private Config $config,
-        private NameParser $nameParser,
         private Spellchecker $spellchecker,
     ) {
         //
@@ -107,7 +106,7 @@ private function getIssuesFromClass(SplFileInfo $file): array
                         $misspelling,
                         $file->getRealPath(),
                         $this->getErrorLine($file, $name),
-                    ), $this->spellchecker->check($this->nameParser->parse($name))),
+                    ), $this->spellchecker->check(NameParser::parse($name))),
             ];
         }
 

src/Checkers/FileSystemChecker.php

@@ -7,7 +7,7 @@
 use Peck\Config;
 use Peck\Contracts\Checker;
 use Peck\Contracts\Services\Spellchecker;
-use Peck\Services\NameParser;
+use Peck\Support\NameParser;
 use Peck\ValueObjects\Issue;
 use Peck\ValueObjects\Misspelling;
 use Symfony\Component\Finder\Finder;
@@ -22,7 +22,6 @@
      */
     public function __construct(
         private Config $config,
-        private NameParser $nameParser,
         private Spellchecker $spellchecker,
     ) {}
 
@@ -46,7 +45,7 @@ public function check(array $parameters): array
 
         foreach ($filesOrDirectories as $fileOrDirectory) {
             $name = $fileOrDirectory->getFilenameWithoutExtension();
-            $name = $this->nameParser->parse($name);
+            $name = NameParser::parse($name);
 
             $issues = [
                 ...$issues,

src/Kernel.php

@@ -6,7 +6,6 @@
 
 use Peck\Checkers\ClassChecker;
 use Peck\Checkers\FileSystemChecker;
-use Peck\Services\NameParser;
 use Peck\Services\Spellcheckers\InMemorySpellchecker;
 
 final readonly class Kernel
@@ -28,13 +27,12 @@ public function __construct(
     public static function default(): self
     {
         $config = Config::instance();
-        $nameParser = new NameParser;
         $inMemoryChecker = InMemorySpellchecker::default();
 
         return new self(
             [
-                new FileSystemChecker($config, $nameParser, $inMemoryChecker),
-                new ClassChecker($config, $nameParser, $inMemoryChecker),
+                new FileSystemChecker($config, $inMemoryChecker),
+                new ClassChecker($config, $inMemoryChecker),
             ],
         );
     }

src/Services/NameParser.php src/Support/NameParser.phpsrc/Services/NameParser.php renamed to src/Support/NameParser.php

@@ -2,15 +2,15 @@
 
 declare(strict_types=1);
 
-namespace Peck\Services;
+namespace Peck\Support;
 
 final readonly class NameParser
 {
     /**
      * Transforms the given input (method or class names) into a
      * human-readable format which can be used for spellchecking.
      */
-    public function parse(string $input): string
+    public static function parse(string $input): string
     {
         // Trim leading underscores (e.g. __construct -> construct)
         $input = ltrim($input, '_');

tests/Unit/Checkers/ClassCheckerTest.php

@@ -4,15 +4,13 @@
 
 use Peck\Checkers\ClassChecker;
 use Peck\Config;
-use Peck\Services\NameParser;
 use Peck\Services\Spellcheckers\InMemorySpellchecker;
 use PhpSpellcheck\Spellchecker\Aspell;
 use Symfony\Component\Finder\SplFileInfo;
 
 it('does not detect issues in the given directory', function (): void {
     $checker = new ClassChecker(
         Config::instance(),
-        (new NameParser),
         InMemorySpellchecker::default(),
     );
 
@@ -26,7 +24,6 @@
 it('detects issues in the given directory', function (): void {
     $checker = new ClassChecker(
         Config::instance(),
-        (new NameParser),
         InMemorySpellchecker::default(),
     );
 
@@ -101,7 +98,6 @@
 
     $checker = new ClassChecker(
         $config,
-        (new NameParser),
         new InMemorySpellchecker(
             $config,
             Aspell::create(),
@@ -153,7 +149,6 @@
         new Config(
             whitelistedDirectories: ['FolderThatShouldBeIgnored'],
         ),
-        (new NameParser),
         InMemorySpellchecker::default(),
     );
 
@@ -218,7 +213,6 @@
         new Config(
             whitelistedDirectories: ['FolderThatShouldBeIgnored'],
         ),
-        (new NameParser),
         InMemorySpellchecker::default(),
     );
 

tests/Unit/Checkers/FileSystemCheckerTest.php

@@ -4,14 +4,12 @@
 
 use Peck\Checkers\FileSystemChecker;
 use Peck\Config;
-use Peck\Services\NameParser;
 use Peck\Services\Spellcheckers\InMemorySpellchecker;
 use PhpSpellcheck\Spellchecker\Aspell;
 
 it('does not detect issues in the given directory', function (): void {
     $checker = new FileSystemChecker(
         Config::instance(),
-        (new NameParser),
         InMemorySpellchecker::default(),
     );
 
@@ -25,7 +23,6 @@
 it('detects issues in the given directory', function (): void {
     $checker = new FileSystemChecker(
         Config::instance(),
-        (new NameParser),
         InMemorySpellchecker::default(),
     );
 
@@ -76,7 +73,6 @@
 
     $checker = new FileSystemChecker(
         $config,
-        (new NameParser),
         new InMemorySpellchecker(
             $config,
             Aspell::create(),
@@ -121,7 +117,6 @@
         new Config(
             whitelistedDirectories: ['FolderThatShouldBeIgnored'],
         ),
-        (new NameParser),
         InMemorySpellchecker::default(),
     );
 

tests/Unit/Services/NameParserTest.php tests/Unit/Support/NameParserTest.phptests/Unit/Services/NameParserTest.php renamed to tests/Unit/Support/NameParserTest.php

@@ -2,40 +2,40 @@
 
 declare(strict_types=1);
 
-use Peck\Services\NameParser;
+use Peck\Support\NameParser;
 
 it('can handle pascal case', function (): void {
-    $result = (new NameParser)->parse('MyClassName');
+    $result = NameParser::parse('MyClassName');
 
     expect($result)->toBeString()->toBe('my class name');
 });
 
 it('can handle camel case', function (): void {
-    $result = (new NameParser)->parse('myMethodOrVariableName');
+    $result = NameParser::parse('myMethodOrVariableName');
 
     expect($result)->toBeString()->toBe('my method or variable name');
 });
 
 it('can handle snake case', function (): void {
-    $result = (new NameParser)->parse('snake_case');
+    $result = NameParser::parse('snake_case');
 
     expect($result)->toBeString()->toBe('snake case');
 });
 
 it('can handle screaming snake case', function (): void {
-    $result = (new NameParser)->parse('MY_CLASS_CONSTANT');
+    $result = NameParser::parse('MY_CLASS_CONSTANT');
 
     expect($result)->toBeString()->toBe('my class constant');
 });
 
 it('can handle kebab case', function (): void {
-    $result = (new NameParser)->parse('some-endpoint-name');
+    $result = NameParser::parse('some-endpoint-name');
 
     expect($result)->toBeString()->toBe('some endpoint name');
 });
 
 it('can handle magic functions', function (): void {
-    $result = (new NameParser)->parse('__construct');
+    $result = NameParser::parse('__construct');
 
     expect($result)->toBeString()->toBe('construct');
 });