Create source locator from correct folder; better variable names

Author: afilina

composer.json

@@ -8,6 +8,7 @@
         "phpdocumentor/reflection-docblock": "^5.2",
         "symfony/filesystem": "^5.2",
         "symfony/process": "^5.2",
+        "nikic/php-parser": "4.6.*",
         "ext-simplexml": "*",
         "ext-dom": "*",
         "ext-libxml": "*"
@@ -19,6 +20,6 @@
         }
     },
     "require-dev": {
-        "phpunit/phpunit": "^9.5"
+        "phpunit/phpunit": "^9.0"
     }
 }

src/Configuration/generator.xsd

@@ -3,10 +3,10 @@
     <xs:element name="generator">
         <xs:complexType>
             <xs:sequence>
-                <xs:element name="source">
+                <xs:element name="source" maxOccurs="unbounded">
                     <xs:complexType>
                         <xs:sequence>
-                            <xs:element name="standard">
+                            <xs:element name="standard" maxOccurs="unbounded">
                                 <xs:complexType>
                                     <xs:attribute name="path" type="xs:string" use="required"/>
                                 </xs:complexType>

src/Handler/GenerateHandler.php

@@ -3,7 +3,6 @@
 
 namespace App\Handler;
 
-use App\CodeRepository\CodeRepository;
 use App\CodeRepository\CodeRepositoryFactory;
 use App\Configuration\ConfigurationRepository;
 use App\Generator\Generator;
@@ -41,15 +40,15 @@ public function handle(string $sniffPath = null): iterable
 
         foreach ($config->getSources() as $source) {
             $codeRepository = $this->codeRepositoryFactory->fromType($source->getType());
-            $repoPath = $codeRepository->getFolder($source);
+            $sourceFolder = $codeRepository->getFolder($source);
             foreach ($source->getStandards() as $standard) {
-                $standardFolder = new Folder($repoPath . $standard->getPath() . '/');
+                $standardFolder = new Folder($sourceFolder . $standard->getPath() . '/');
                 yield "Searching for sniffs in {$standardFolder}...";
 
                 if ($sniffPath !== null) {
-                    $sniffs = [$this->sniffFinder->getSniff($standardFolder, $sniffPath)];
+                    $sniffs = [$this->sniffFinder->getSniff($standardFolder, $sourceFolder, $sniffPath)];
                 } else {
-                    $sniffs = $this->sniffFinder->getSniffs($standardFolder);
+                    $sniffs = $this->sniffFinder->getSniffs($standardFolder, $sourceFolder);
                 }
 
                 foreach ($sniffs as $sniff) {

src/SniffFinder/FilesystemSniffFinder.php

@@ -18,10 +18,10 @@
 
 class FilesystemSniffFinder implements SniffFinder
 {
-    public function getSniff(Folder $folder, string $sniffPath): Sniff
+    public function getSniff(Folder $standardFolder, Folder $sourceFolder, string $sniffPath): Sniff
     {
         $parser = new SniffParser();
-        $projectSourceLocator = $this->createProjectSourceLocator($folder);
+        $projectSourceLocator = $this->createProjectSourceLocator($sourceFolder);
         return $parser->parse($sniffPath, $projectSourceLocator);
     }
 
@@ -44,11 +44,11 @@ private function recursiveSearch(Folder $folder): Iterator
         });
     }
 
-    public function getSniffs(Folder $folder): iterable
+    public function getSniffs(Folder $standardFolder, Folder $sourceFolder): iterable
     {
         $parser = new SniffParser();
-        $globSniffs = new GlobIterator($folder->getPath() . 'Sniffs/*/*Sniff.php');
-        $projectSourceLocator = $this->createProjectSourceLocator($folder);
+        $globSniffs = new GlobIterator($standardFolder->getPath() . 'Sniffs/*/*Sniff.php');
+        $projectSourceLocator = $this->createProjectSourceLocator($sourceFolder);
         foreach ($globSniffs as $fileInfo) {
             yield $parser->parse($fileInfo->getPathname(), $projectSourceLocator);
         }

src/SniffFinder/SniffFinder.php

@@ -8,10 +8,10 @@
 
 interface SniffFinder
 {
-    public function getSniff(Folder $folder, string $sniffPath): Sniff;
+    public function getSniff(Folder $standardFolder, Folder $sourceFolder, string $sniffPath): Sniff;
 
     /**
      * @return iterable<Sniff>
      */
-    public function getSniffs(Folder $folder): iterable;
+    public function getSniffs(Folder $standardFolder, Folder $sourceFolder): iterable;
 }

src/Value/Folder.php

@@ -17,7 +17,7 @@ public function __construct(string $path)
         $this->path = $path;
     }
 
-    public function __toString()
+    public function __toString(): string
     {
         return $this->getPath();
     }

src/Value/Url.php

@@ -17,7 +17,7 @@ public function __construct(string $url)
         $this->url = $url;
     }
 
-    public function __toString()
+    public function __toString(): string
     {
         return $this->getUrl();
     }

tests/CodeRepository/GitCodeRepositoryTest.php

@@ -12,7 +12,7 @@
 /** @covers \App\CodeRepository\GitCodeRepository */
 class GitCodeRepositoryTest extends TestCase
 {
-    const LOCAL_GIT_PATH = 'var/tests/repo/Standard.git';
+    private const LOCAL_GIT_PATH = 'var/tests/repo/Standard.git';
     private GitCodeRepository $codeRepo;
 
     /** @test */

tests/Configuration/Value/ConfigurationTest.php

@@ -16,21 +16,19 @@ class ConfigurationTest extends TestCase
      */
     private static array $SOURCES;
 
-    /** @test */
-    public function getSources()
+    public static function setUpBeforeClass(): void
     {
-        self::assertEquals(
-            self::$SOURCES,
-            $this->createValidVO()->getSources(),
-        );
+        self::$SOURCES = [
+            new Source('path/to/source', [])
+        ];
     }
 
     /** @test */
-    public function getFormat()
+    public function getSources()
     {
         self::assertEquals(
-            self::FORMAT,
-            $this->createValidVO()->getFormat(),
+            self::$SOURCES,
+            $this->createValidVO()->getSources(),
         );
     }
 
@@ -42,10 +40,12 @@ private function createValidVO(): Configuration
         );
     }
 
-    public static function setUpBeforeClass(): void
+    /** @test */
+    public function getFormat()
     {
-        self::$SOURCES = [
-            new Source('path/to/source', [])
-        ];
+        self::assertEquals(
+            self::FORMAT,
+            $this->createValidVO()->getFormat(),
+        );
     }
 }

tests/SniffFinder/FilesystemSniffFinderTest.php

@@ -32,6 +32,9 @@ public function getSniffs()
         $sniffs = $this->finder->getSniffs(
             new Folder(
                 'var/tests/src/Standard/'
+            ),
+            new Folder(
+                'var/tests/'
             )
         );
         self::assertEquals(
@@ -114,6 +117,9 @@ public function getSniff()
                 new Folder(
                     'var/tests/src/Standard/'
                 ),
+                new Folder(
+                    'var/tests/'
+                ),
                 self::PHP_SNIFF_PATH
             )
         );