Merge pull request #986 from phel-lang/fix/981-phel-phar-doc

Chemaclass · web-flow · commit c37577d54216 · 2025-09-28T15:41:55.000+02:00
Fix doc command on phar
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,7 @@ All notable changes to this project will be documented in this file.
 
 ## Unreleased
 
+- Fix `doc` command on phar command
 - Add `catch` and `finally` functions to the API docs
 - Add `--format` json option to `phel doc` command
 
diff --git a/src/php/Api/Infrastructure/PhelFnLoader.php b/src/php/Api/Infrastructure/PhelFnLoader.php
@@ -4,6 +4,7 @@
 
 namespace Phel\Api\Infrastructure;
 
+use Phar;
 use Phel;
 use Phel\Api\Domain\PhelFnLoaderInterface;
 use Phel\Compiler\Infrastructure\GlobalEnvironmentSingleton;
@@ -440,7 +441,22 @@ public function loadAllPhelFunctions(array $namespaces): void
         }
 
         $docPhelContent = str_replace('%REQUIRES%', $requireNamespaces, $template);
-        $phelFile = __DIR__ . '/phel/doc.phel';
+
+        // When running in a phar, we can't write to __DIR__ due to phar.readonly
+        // Use a temporary directory in the current working directory instead
+        if (Phar::running() !== '') {
+            $tempDir = getcwd() . '/.phel_temp_' . uniqid();
+            mkdir($tempDir, 0755, true);
+            $phelFile = $tempDir . '/doc.phel';
+        } else {
+            $phelDir = __DIR__ . '/phel';
+            if (!is_dir($phelDir)) {
+                mkdir($phelDir, 0755, true);
+            }
+
+            $phelFile = $phelDir . '/doc.phel';
+        }
+
         file_put_contents($phelFile, $docPhelContent);
 
         $namespace = $this->runFacade
@@ -462,6 +478,11 @@ public function loadAllPhelFunctions(array $namespaces): void
         }
 
         unlink($phelFile);
+
+        // Clean up temporary directory if running in phar
+        if (Phar::running() !== '' && dirname($phelFile) !== __DIR__) {
+            rmdir(dirname($phelFile));
+        }
     }
 
     /**
diff --git a/src/php/Build/Application/NamespaceExtractor.php b/src/php/Build/Application/NamespaceExtractor.php
@@ -21,6 +21,7 @@
 use RecursiveDirectoryIterator;
 use RecursiveIteratorIterator;
 use RegexIterator;
+use UnexpectedValueException;
 
 final readonly class NamespaceExtractor implements NamespaceExtractorInterface
 {
@@ -137,12 +138,19 @@ private function findAllNs(string $directory): array
             return [];
         }
 
-        $iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($realpath));
-        $phelIterator = new RegexIterator($iterator, '/^.+\.phel$/i', RegexIterator::GET_MATCH);
+        try {
+            $directoryIterator = new RecursiveDirectoryIterator($realpath);
+            $iterator = new RecursiveIteratorIterator($directoryIterator);
+            $phelIterator = new RegexIterator($iterator, '/^.+\.phel$/i', RegexIterator::GET_MATCH);
 
-        $result = [];
-        foreach ($phelIterator as $file) {
-            $result[] = $this->getNamespaceFromFile($file[0]);
+            $result = [];
+            foreach ($phelIterator as $file) {
+                $result[] = $this->getNamespaceFromFile($file[0]);
+            }
+        } catch (UnexpectedValueException) {
+            // Skip directories that cannot be read (e.g., permission denied)
+            // This can happen with system-protected directories in temp paths
+            return [];
         }
 
         return $result;
