Preserve relative phpDocumentor API paths

Author: coisa

src/Console/Command/WikiCommand.php

@@ -179,7 +179,10 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         }
 
         foreach ($projectCapabilities->getApiDirectories() as $path) {
-            $processBuilder = $processBuilder->withArgument('--directory', $path);
+            $processBuilder = $processBuilder->withArgument(
+                '--directory',
+                $this->filesystem->getAbsolutePath($path)
+            );
         }
 
         if (null !== $defaultPackageName = $projectCapabilities->getDefaultPackageName()) {

src/Project/ProjectCapabilities.php

@@ -25,7 +25,7 @@
 final readonly class ProjectCapabilities
 {
     /**
-     * @param list<string> $apiDirectories absolute directories that contain autoloaded PHP API source
+     * @param list<string> $apiDirectories project-relative directories that contain autoloaded PHP API source
      * @param string|null $defaultPackageName the default package name derived from Composer namespaces when available
      * @param bool $hasGuideDirectory whether the configured guide directory exists
      * @param bool $hasTestsPath whether the configured tests path exists

src/Project/ProjectCapabilitiesResolver.php

@@ -94,23 +94,39 @@ private function resolveApiDirectories(): array
 
         foreach (self::API_AUTOLOAD_TYPES as $autoloadType) {
             foreach ($this->normalizeAutoloadPaths($this->composer->getAutoload($autoloadType)) as $path) {
-                $absolutePath = $this->filesystem->getAbsolutePath($path);
+                $relativePath = $this->resolveRelativeApiDirectory($path);
 
-                if (! \is_string($absolutePath)) {
+                if (null === $relativePath) {
                     continue;
                 }
 
-                if (! is_dir($absolutePath)) {
-                    continue;
-                }
-
-                $directories[$absolutePath] = $absolutePath;
+                $directories[$relativePath] = $relativePath;
             }
         }
 
         return array_values($directories);
     }
 
+    /**
+     * @param string $path
+     *
+     * @return string|null
+     */
+    private function resolveRelativeApiDirectory(string $path): ?string
+    {
+        $absolutePath = $this->filesystem->getAbsolutePath($path);
+
+        if (! \is_string($absolutePath)) {
+            return null;
+        }
+
+        if (! is_dir($absolutePath)) {
+            return null;
+        }
+
+        return $this->filesystem->makePathRelative($absolutePath);
+    }
+
     /**
      * @param array<string, mixed> $autoload
      *

tests/Console/Command/DocsCommandTest.php

@@ -133,14 +133,7 @@ protected function setUp(): void
         $this->filesystem->exists('/repo/docs')
             ->willReturn(true);
         $this->projectCapabilitiesResolver->resolve(Argument::any(), Argument::any())
-            ->willReturn(new ProjectCapabilities(
-                ['/repo/src'],
-                'FastForward\\DevTools',
-                true,
-                false,
-                false,
-                true,
-            ));
+            ->willReturn(new ProjectCapabilities(['src/'], 'FastForward\\DevTools', true, false, false, true));
         $this->composer->getAutoload('psr-4')
             ->willReturn([
                 'FastForward\\DevTools\\' => 'src/',
@@ -153,6 +146,7 @@ protected function setUp(): void
                 static fn(array $context): bool => DevToolsPathResolver::getPreferredVendorPath(
                     'vendor/fast-forward/phpdoc-bootstrap-template'
                 ) === $context['template']
+                    && ['src/'] === $context['apiDirectories']
             )
         )
             ->willReturn('<phpdocumentor />');
@@ -208,14 +202,7 @@ public function executeWillFailWhenCustomGuideSourceDoesNotExist(): void
         $this->filesystem->getAbsolutePath('missing-guides')
             ->willReturn('/repo/missing-guides');
         $this->projectCapabilitiesResolver->resolve(Argument::any(), Argument::any())
-            ->willReturn(new ProjectCapabilities(
-                ['/repo/src'],
-                'FastForward\\DevTools',
-                false,
-                false,
-                false,
-                true,
-            ));
+            ->willReturn(new ProjectCapabilities(['src/'], 'FastForward\\DevTools', false, false, false, true));
         $this->processQueue->add(Argument::cetera())
             ->shouldNotBeCalled();
         $this->logger->info('Generating API documentation...', Argument::that(

tests/Console/Command/WikiCommandTest.php

@@ -102,14 +102,7 @@ protected function setUp(): void
                 'FastForward\\DevTools\\' => 'src/',
             ]);
         $this->projectCapabilitiesResolver->resolve(Argument::any(), Argument::any(), Argument::any())
-            ->willReturn(new ProjectCapabilities(
-                [getcwd() . '/src'],
-                'FastForward\\DevTools',
-                false,
-                false,
-                true,
-                true,
-            ));
+            ->willReturn(new ProjectCapabilities(['src/'], 'FastForward\\DevTools', false, false, true, true));
         $this->input->getOption('target')
             ->willReturn('.github/wiki');
         $this->input->getOption('cache-dir')
@@ -160,6 +153,12 @@ public function executeWillReturnSuccessWhenProcessQueueSucceeds(): void
         )
             ->willReturn($this->processBuilder->reveal())
             ->shouldBeCalled();
+        $this->filesystem->getAbsolutePath('src/')
+            ->willReturn(getcwd() . '/src')
+            ->shouldBeCalled();
+        $this->processBuilder->withArgument('--directory', getcwd() . '/src')
+            ->willReturn($this->processBuilder->reveal())
+            ->shouldBeCalled();
         $this->processQueue->add($this->process->reveal(), Argument::cetera())
             ->shouldBeCalled();
         $this->processQueue->run($this->output->reveal())
@@ -189,6 +188,12 @@ public function executeWithNoCacheWillSkipPhpDocumentorCacheFolder(): void
             ->willReturn(true);
         $this->processBuilder->withArgument('--cache-folder', Argument::cetera())
             ->shouldNotBeCalled();
+        $this->filesystem->getAbsolutePath('src/')
+            ->willReturn(getcwd() . '/src')
+            ->shouldBeCalled();
+        $this->processBuilder->withArgument('--directory', getcwd() . '/src')
+            ->willReturn($this->processBuilder->reveal())
+            ->shouldBeCalled();
         $this->processQueue->add($this->process->reveal(), Argument::cetera())
             ->shouldBeCalled();
         $this->processQueue->run($this->output->reveal())

tests/Project/ProjectCapabilitiesResolverTest.php

@@ -37,7 +37,6 @@
 use function Safe\file_put_contents;
 use function Safe\getcwd;
 use function Safe\mkdir;
-use function Safe\realpath;
 
 #[CoversClass(ProjectCapabilitiesResolver::class)]
 #[UsesClass(Filesystem::class)]
@@ -149,7 +148,7 @@ public function resolveWillDetectPhpPackageCapabilities(): void
         self::assertTrue($capabilities->canRunTests());
         self::assertTrue($capabilities->canGenerateMetrics());
         self::assertTrue($capabilities->canGenerateWiki());
-        self::assertSame([realpath($this->workspace . '/src')], $capabilities->getApiDirectories());
+        self::assertSame(['src/'], $capabilities->getApiDirectories());
         self::assertSame('App', $capabilities->getDefaultPackageName());
     }
 }