Normalize paths to run on windows

doctrine · Jan 31, 2024 · e20a0c1 · e20a0c1
1 parent ca7f5f3
commit e20a0c1
Show file tree

Hide file tree

Showing 13 changed files with 46 additions and 25 deletions.
diff --git a/lib/Builder.php b/lib/Builder.php
@@ -17,6 +17,7 @@
 use Doctrine\RST\Meta\Metas;
 use InvalidArgumentException;
 use Symfony\Component\Filesystem\Filesystem;
+use Symfony\Component\Filesystem\Path;
 use Symfony\Component\Finder\Finder;
 
 use function file_exists;
@@ -132,6 +133,8 @@ public function build(
         string $directory,
         string $targetDirectory = 'output'
     ): void {
+        $directory       = Path::normalize($directory);
+        $targetDirectory = Path::normalize($targetDirectory);
         // Creating output directory if doesn't exists
         if (! is_dir($targetDirectory)) {
             $this->filesystem->mkdir($targetDirectory, 0755);

diff --git a/lib/Builder/Scanner.php b/lib/Builder/Scanner.php
@@ -6,6 +6,7 @@
 
 use Doctrine\RST\Meta\Metas;
 use InvalidArgumentException;
+use Symfony\Component\Filesystem\Path;
 use Symfony\Component\Finder\Finder;
 use Symfony\Component\Finder\SplFileInfo;
 
@@ -54,7 +55,7 @@ public function scan(): ParseQueue
         // completely populate the splFileInfos property
         $this->fileInfos = [];
         foreach ($this->finder as $fileInfo) {
-            $relativeFilename = $fileInfo->getRelativePathname();
+            $relativeFilename = Path::normalize($fileInfo->getRelativePathname());
             // strip off the extension
             $documentPath = substr($relativeFilename, 0, -(strlen($this->fileExtension) + 1));
 
@@ -142,6 +143,6 @@ private function hasFileBeenUpdated(string $filename): bool
      */
     private function getFilenameFromFile(SplFileInfo $file): string
     {
-        return substr($file->getRelativePathname(), 0, -(strlen($this->fileExtension) + 1));
+        return substr(Path::normalize($file->getRelativePathname()), 0, -(strlen($this->fileExtension) + 1));
     }
 }
diff --git a/lib/Configuration.php b/lib/Configuration.php
@@ -20,8 +20,10 @@
 use Doctrine\RST\Templates\TwigAdapter;
 use Doctrine\RST\Templates\TwigTemplateRenderer;
 use RuntimeException;
+use Symfony\Component\Filesystem\Path;
 use Twig\Environment as TwigEnvironment;
 
+use function array_map;
 use function sprintf;
 use function sys_get_temp_dir;
 
@@ -93,7 +95,7 @@ class Configuration
 
     public function __construct()
     {
-        $this->cacheDir = sys_get_temp_dir() . '/doctrine-rst-parser';
+        $this->cacheDir = Path::normalize(sys_get_temp_dir()) . '/doctrine-rst-parser';
 
         $this->eventManager = new EventManager();
 
@@ -113,7 +115,7 @@ public function getCacheDir(): string
 
     public function setCacheDir(string $cacheDir): void
     {
-        $this->cacheDir = $cacheDir;
+        $this->cacheDir = Path::normalize($cacheDir);
     }
 
     public function getTemplateRenderer(): TemplateRenderer
@@ -141,7 +143,7 @@ public function getCustomTemplateDirs(): array
     /** @param string[] $customTemplateDirs */
     public function setCustomTemplateDirs(array $customTemplateDirs): void
     {
-        $this->customTemplateDirs = $customTemplateDirs;
+        $this->customTemplateDirs = array_map([Path::class, 'normalize'], $customTemplateDirs);
     }
 
     public function addCustomTemplateDir(string $customTemplateDir): void

diff --git a/lib/Environment.php b/lib/Environment.php
@@ -11,6 +11,7 @@
 use Doctrine\RST\References\ResolvedReference;
 use Doctrine\RST\Templates\TemplateRenderer;
 use InvalidArgumentException;
+use Symfony\Component\Filesystem\Path;
 use Symfony\Component\String\Slugger\AsciiSlugger;
 
 use function array_shift;
@@ -372,7 +373,7 @@ public function getDirName(): string
 
     public function setCurrentFileName(string $filename): void
     {
-        $this->currentFileName = $filename;
+        $this->currentFileName = Path::normalize($filename);
     }
 
     /**
@@ -388,7 +389,7 @@ public function getCurrentFileName(): string
 
     public function setCurrentDirectory(string $directory): void
     {
-        $this->currentDirectory = $directory;
+        $this->currentDirectory = Path::normalize($directory);
     }
 
     public function getCurrentDirectory(): string
@@ -403,7 +404,7 @@ public function absoluteRelativePath(string $url): string
 
     public function setTargetDirectory(string $directory): void
     {
-        $this->targetDirectory = $directory;
+        $this->targetDirectory = Path::normalize($directory);
     }
 
     public function getTargetDirectory(): string

diff --git a/lib/FileIncluder.php b/lib/FileIncluder.php
@@ -5,6 +5,7 @@
 namespace Doctrine\RST;
 
 use RuntimeException;
+use Symfony\Component\Filesystem\Path;
 
 use function explode;
 use function file_exists;
@@ -26,6 +27,7 @@ final class FileIncluder
     /** @var string */
     private $includeRoot;
 
+    /** @param string $includeRoot Many roots can be provided by separating them with | */
     public function __construct(
         Environment $environment,
         bool $includeAllowed,
@@ -83,7 +85,9 @@ private function isFileIncludeAllowed(string $path): bool
             return false;
         }
 
-        foreach (explode(':', $this->includeRoot) as $root) {
+        $real = Path::normalize($real);
+
+        foreach (explode('|', $this->includeRoot) as $root) {
             if (strpos($real, $root) === 0) {
                 return true;
             }

diff --git a/lib/Nodes/TocNode.php b/lib/Nodes/TocNode.php
@@ -5,6 +5,9 @@
 namespace Doctrine\RST\Nodes;
 
 use Doctrine\RST\Environment;
+use Symfony\Component\Filesystem\Path;
+
+use function array_map;
 
 class TocNode extends Node
 {
@@ -27,7 +30,7 @@ public function __construct(Environment $environment, array $files, array $optio
     {
         parent::__construct();
 
-        $this->files       = $files;
+        $this->files       = array_map([Path::class, 'normalize'], $files);
         $this->environment = $environment;
         $this->options     = $options;
     }

diff --git a/lib/Templates/TwigEnvironmentFactory.php b/lib/Templates/TwigEnvironmentFactory.php
@@ -5,6 +5,7 @@
 namespace Doctrine\RST\Templates;
 
 use Doctrine\RST\Configuration;
+use Symfony\Component\Filesystem\Path;
 use Twig\Environment as TwigEnvironment;
 use Twig\Loader\FilesystemLoader;
 
@@ -32,7 +33,7 @@ private static function getTemplateDirs(Configuration $configuration): array
 
         $templateDirectories = $configuration->getCustomTemplateDirs();
         // add the fallback directory
-        $templateDirectories[] = __DIR__;
+        $templateDirectories[] = Path::normalize(__DIR__);
 
         foreach ($templateDirectories as $templateDir) {
             $themePath = $templateDir . '/' . $configuration->getTheme() . '/' . $fileExtension;

diff --git a/lib/Toc/GlobSearcher.php b/lib/Toc/GlobSearcher.php
@@ -5,6 +5,7 @@
 namespace Doctrine\RST\Toc;
 
 use Doctrine\RST\Environment;
+use Symfony\Component\Filesystem\Path;
 use Symfony\Component\Finder\Finder;
 
 use function array_merge;
@@ -27,7 +28,7 @@ class GlobSearcher
      */
     public function globSearch(Environment $environment, string $globPattern): array
     {
-        $currentFilePath = (string) realpath(rtrim($environment->absoluteRelativePath(''), '/'));
+        $currentFilePath = Path::normalize((string) realpath(rtrim($environment->absoluteRelativePath(''), '/')));
 
         $rootDocPath = rtrim(str_replace($environment->getDirName(), '', $currentFilePath), '/');
 
@@ -51,7 +52,7 @@ public function globSearch(Environment $environment, string $globPattern): array
         foreach ($finder as $file) {
             if ($file->isDir()) {
                 // remove the root directory so it is a relative path from the root
-                $relativePath = str_replace($rootDocPath, '', (string) $file->getRealPath());
+                $relativePath = str_replace($rootDocPath, '', Path::normalize((string) $file->getRealPath()));
 
                 // recursively search in this directory
                 $dirFiles = $this->globSearch($environment, $relativePath . '/*');
@@ -60,7 +61,7 @@ public function globSearch(Environment $environment, string $globPattern): array
             } else {
                 // Trim the root path and the .rst extension. This is what the
                 // RST parser requires to add a dependency.
-                $file = str_replace([$rootDocPath, '.rst'], '', (string) $file->getRealPath());
+                $file = str_replace([$rootDocPath, '.rst'], '', Path::normalize((string) $file->getRealPath()));
 
                 $allFiles[] = $file;
             }

diff --git a/tests/BaseBuilderTest.php b/tests/BaseBuilderTest.php
@@ -7,6 +7,7 @@
 use Doctrine\RST\Builder;
 use Exception;
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\Filesystem\Path;
 
 use function file_get_contents;
 use function shell_exec;
@@ -34,12 +35,12 @@ protected function configureBuilder(Builder $builder): void
 
     protected function sourceFile(string $file = ''): string
     {
-        return __DIR__ . '/' . $this->getFixturesDirectory() . '/input/' . $file;
+        return Path::normalize(__DIR__) . '/' . $this->getFixturesDirectory() . '/input/' . $file;
     }
 
     protected function targetFile(string $file = ''): string
     {
-        return __DIR__ . '/' . $this->getFixturesDirectory() . '/output/' . $file;
+        return Path::normalize(__DIR__) . '/' . $this->getFixturesDirectory() . '/output/' . $file;
     }
 
     /** @throws Exception */

diff --git a/tests/FileIncluderTest.php b/tests/FileIncluderTest.php
@@ -9,6 +9,7 @@
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use RuntimeException;
+use Symfony\Component\Filesystem\Path;
 
 use function trim;
 
@@ -22,9 +23,9 @@ public function testInclude(): void
         $this->environment->expects(self::once())
             ->method('absoluteRelativePath')
             ->with('include.rst')
-            ->willReturn(__DIR__ . '/Parser/files/include.rst');
+            ->willReturn(Path::normalize(__DIR__) . '/Parser/files/include.rst');
 
-        $fileIncluder = new FileIncluder($this->environment, true, __DIR__ . '/Parser/files');
+        $fileIncluder = new FileIncluder($this->environment, true, Path::normalize(__DIR__) . '/Parser/files');
 
         $contents = $fileIncluder->includeFiles('.. include:: include.rst');
 
@@ -36,7 +37,7 @@ public function testIncludeWithEmptyIncludeRoot(): void
         $this->environment->expects(self::once())
             ->method('absoluteRelativePath')
             ->with('include.rst')
-            ->willReturn(__DIR__ . '/Parser/files/include.rst');
+            ->willReturn(Path::normalize(__DIR__) . '/Parser/files/include.rst');
 
         $fileIncluder = new FileIncluder($this->environment, true, '');
 

diff --git a/tests/GlobSearcherTest.php b/tests/GlobSearcherTest.php
@@ -7,6 +7,7 @@
 use Doctrine\RST\Environment;
 use Doctrine\RST\Toc\GlobSearcher;
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\Filesystem\Path;
 
 use function sort;
 
@@ -17,7 +18,7 @@ class GlobSearcherTest extends TestCase
 
     public function testGlobSearch(): void
     {
-        $dir = __DIR__ . '/BuilderToctree/input';
+        $dir = Path::normalize(__DIR__) . '/BuilderToctree/input';
 
         $environment = $this->createMock(Environment::class);
 

diff --git a/tests/Parser/ParserTest.php b/tests/Parser/ParserTest.php
@@ -18,6 +18,7 @@
 use InvalidArgumentException;
 use PHPUnit\Framework\TestCase;
 use RuntimeException;
+use Symfony\Component\Filesystem\Path;
 
 use function assert;
 use function count;
@@ -383,7 +384,7 @@ public function testIncludesKeepScope(): void
 
     public function testIncludesPolicy(): void
     {
-        $directory   = __DIR__ . '/files/';
+        $directory   = Path::normalize(__DIR__) . '/files/';
         $parser      = new Parser();
         $environment = $parser->getEnvironment();
         $environment->setCurrentDirectory($directory);
@@ -397,7 +398,7 @@ public function testIncludesPolicy(): void
         self::assertStringContainsString('SUBDIRECTORY OK', $document);
         self::assertStringContainsString('EXTERNAL FILE INCLUDED!', $document);
 
-        // Disbaled policy:
+        // Disabled policy:
         $parser->setIncludePolicy(false);
         $nodes = $parser->parseFile($directory . 'inclusion-policy.rst')->getNodes();
         self::assertCount(1, $nodes);

diff --git a/tests/Templates/TwigEnvironmentFactoryTest.php b/tests/Templates/TwigEnvironmentFactoryTest.php
@@ -9,6 +9,7 @@
 use Exception;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Filesystem\Filesystem;
+use Symfony\Component\Filesystem\Path;
 use Twig\Environment;
 use Twig\Loader\FilesystemLoader;
 
@@ -29,7 +30,7 @@ public function testTemplateDirectoriesNothingCustom(): void
 
         // no theme, no custom dirs
         self::assertLoaderPaths(
-            [(string) realpath(__DIR__ . '/../../lib/Templates/default/html')],
+            [Path::normalize((string) realpath(__DIR__ . '/../../lib/Templates/default/html'))],
             TwigEnvironmentFactory::createTwigEnvironment($configuration)
         );
     }
@@ -61,7 +62,7 @@ public function testTemplateDirectoriesThemeAndDirectories(): void
                 $dir1 . '/cool_theme/html',
                 $dir2 . '/cool_theme/html',
                 $dir1 . '/default/html',
-                (string) realpath(__DIR__ . '/../../lib/Templates/default/html'),
+                Path::normalize((string) realpath(__DIR__ . '/../../lib/Templates/default/html')),
             ],
             TwigEnvironmentFactory::createTwigEnvironment($configuration)
         );
@@ -80,7 +81,7 @@ private static function assertLoaderPaths(array $expectedPaths, Environment $twi
 
     protected function setUp(): void
     {
-        $this->tmpPath    = sys_get_temp_dir() . '/_rst_twig_tests';
+        $this->tmpPath    = Path::normalize(sys_get_temp_dir()) . '/_rst_twig_tests';
         $this->filesystem = new Filesystem();
     }