phpDocumentor · jaapio · Jan 31, 2025
diff --git a/composer.json b/composer.json
@@ -48,18 +48,19 @@
         "league/commonmark": "^2.2",
         "league/flysystem": "^1.0",
         "league/tactician": "^1.0",
-        "league/uri": "^6.7",
-        "league/uri-interfaces": "^2.0",
+        "league/uri": "^7.5",
+        "league/uri-interfaces": "^7.5",
         "monolog/monolog": "^2.9",
         "nikic/php-parser": "^5.0",
         "phar-io/manifest": "^2.0",
         "phar-io/version": "^3.2",
+        "phpdocumentor/filesystem": "^1.7",
         "phpdocumentor/flyfinder": "^1.0",
         "phpdocumentor/graphviz": "^2.0",
-        "phpdocumentor/guides": "^1.5",
-        "phpdocumentor/guides-graphs": "^1.4",
-        "phpdocumentor/guides-markdown": "^1.5",
-        "phpdocumentor/guides-restructured-text": "^1.5",
+        "phpdocumentor/guides": "^1.7",
+        "phpdocumentor/guides-graphs": "^1.7",
+        "phpdocumentor/guides-markdown": "^1.7",
+        "phpdocumentor/guides-restructured-text": "^1.7",
         "phpdocumentor/json-path": "^0.1.0",
         "phpdocumentor/reflection": "^6.0",
         "phpdocumentor/reflection-common": "^2.0",

diff --git a/composer.lock b/composer.lock
diff --git a/phpstan.neon b/phpstan.neon
@@ -16,9 +16,6 @@ parameters:
     - '#.*NodeDefinition::fixXmlConfig.*#'
     - '#.*NodeDefinition::addDefaultsIfNotSet.*#'
 
-    # FlyFinder plugin adds a find method to FlySystem's Filesystem
-    - '#Call to an undefined method League\\Flysystem\\Filesystem::find\(\)#'
-
     # PHPStan has issue when involving templates and parent types
     - '#Parameter \#1 \$matcher of method phpDocumentor\\Descriptor\\Builder\\AssemblerFactory::(register|registerFallback)\(\) expects phpDocumentor\\Descriptor\\Builder\\Matcher<object>, phpDocumentor\\Descriptor\\Builder\\Matcher<.+> given\.#'
 

diff --git a/src/phpDocumentor/Configuration/ApiSpecification.php b/src/phpDocumentor/Configuration/ApiSpecification.php
@@ -6,8 +6,8 @@
 
 use ArrayAccess;
 use phpDocumentor\Configuration\Definition\Version3;
-use phpDocumentor\Dsn;
-use phpDocumentor\Path;
+use phpDocumentor\FileSystem\Dsn;
+use phpDocumentor\FileSystem\Path;
 use RuntimeException;
 use Webmozart\Assert\Assert;
 

diff --git a/src/phpDocumentor/Configuration/CommandlineOptionsMiddleware.php b/src/phpDocumentor/Configuration/CommandlineOptionsMiddleware.php
@@ -14,8 +14,8 @@
 namespace phpDocumentor\Configuration;
 
 use League\Uri\Contracts\UriInterface;
-use phpDocumentor\Dsn;
-use phpDocumentor\Path;
+use phpDocumentor\FileSystem\Dsn;
+use phpDocumentor\FileSystem\Path;
 use Symfony\Component\Filesystem\Path as SymfonyPath;
 use Webmozart\Assert\Assert;
 
@@ -127,7 +127,7 @@ private function overwriteTemplates(Configuration $configuration): Configuration
     {
         if (isset($this->options['template']) && $this->options['template']) {
             $configuration['phpdocumentor']['templates'] = array_map(
-                static fn ($templateName) => ['name' => $templateName],
+                static fn ($templateName) => new TemplateDefinition($templateName),
                 (array) $this->options['template'],
             );
         }

diff --git a/src/phpDocumentor/Configuration/Configuration.php b/src/phpDocumentor/Configuration/Configuration.php
@@ -14,8 +14,8 @@
 namespace phpDocumentor\Configuration;
 
 use ArrayObject;
-use phpDocumentor\Dsn;
-use phpDocumentor\Path;
+use phpDocumentor\FileSystem\Dsn;
+use phpDocumentor\FileSystem\Path;
 
 /**
  * @template-extends ArrayObject<string, mixed>&ConfigurationMap

diff --git a/src/phpDocumentor/Configuration/ConfigurationFactory.php b/src/phpDocumentor/Configuration/ConfigurationFactory.php
@@ -144,6 +144,16 @@ private function createConfigurationFromArray(array $configuration): Configurati
             }
         }
 
+        if (isset($configuration['phpdocumentor']['templates'])) {
+            foreach ($configuration['phpdocumentor']['templates'] as $templateNumber => $template) {
+                $configuration['phpdocumentor']['templates'][$templateNumber] = new TemplateDefinition(
+                    $template['name'],
+                    $template['location'],
+                    $template['parameters'],
+                );
+            }
+        }
+
         return new Configuration($configuration);
     }
 }
diff --git a/src/phpDocumentor/Configuration/Definition/Version3.php b/src/phpDocumentor/Configuration/Definition/Version3.php
@@ -14,8 +14,8 @@
 namespace phpDocumentor\Configuration\Definition;
 
 use phpDocumentor\Configuration\SymfonyConfigFactory;
-use phpDocumentor\Dsn;
-use phpDocumentor\Path;
+use phpDocumentor\FileSystem\Dsn;
+use phpDocumentor\FileSystem\Path;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;

diff --git a/src/phpDocumentor/Configuration/PathNormalizingMiddleware.php b/src/phpDocumentor/Configuration/PathNormalizingMiddleware.php
@@ -14,9 +14,8 @@
 namespace phpDocumentor\Configuration;
 
 use League\Uri\Contracts\UriInterface;
-use phpDocumentor\Dsn;
-use phpDocumentor\Path;
-use Symfony\Component\Filesystem\Path as SymfonyPath;
+use phpDocumentor\FileSystem\Dsn;
+use phpDocumentor\FileSystem\Path;
 
 use function array_map;
 use function array_merge;
@@ -85,18 +84,18 @@ private function makeDsnRelativeToConfig(Configuration $configuration, UriInterf
             }
         }
 
-        /** @var array{name: string, location?: ?Path, parameters?: array<string, mixed>} $template */
+        /** @var TemplateDefinition $template */
         foreach ($configuration['phpdocumentor']['templates'] as $key => $template) {
-            if (isset($template['location']) === false) {
+            if (isset($template->location) === false) {
                 continue;
             }
 
-            $location = $template['location'];
-            if ($location instanceof Path && SymfonyPath::isAbsolute((string) $location) === false) {
+            $location = $template->location;
+            if ($location instanceof Path && Path::isAbsolutePath((string) $location) === false) {
                 $location = new Path($configPath . '/' . $location);
             }
 
-            $template['location'] = $location;
+            $template->location = $location;
 
             $configuration['phpdocumentor']['templates'][$key] = $template;
         }

diff --git a/src/phpDocumentor/Configuration/ProvideTemplateOverridePathMiddleware.php b/src/phpDocumentor/Configuration/ProvideTemplateOverridePathMiddleware.php
@@ -14,8 +14,8 @@
 namespace phpDocumentor\Configuration;
 
 use League\Uri\Contracts\UriInterface;
-use phpDocumentor\Dsn;
-use phpDocumentor\Path;
+use phpDocumentor\FileSystem\Dsn;
+use phpDocumentor\FileSystem\Path;
 use phpDocumentor\Transformer\Writer\Twig\EnvironmentFactory;
 
 use function file_exists;

diff --git a/src/phpDocumentor/Configuration/Source.php b/src/phpDocumentor/Configuration/Source.php
@@ -16,8 +16,8 @@
 use ArrayAccess;
 use BadMethodCallException;
 use OutOfBoundsException;
-use phpDocumentor\Dsn;
-use phpDocumentor\Path;
+use phpDocumentor\FileSystem\Dsn;
+use phpDocumentor\FileSystem\Path;
 use ReturnTypeWillChange;
 
 use function array_map;

diff --git a/src/phpDocumentor/Configuration/TemplateDefinition.php b/src/phpDocumentor/Configuration/TemplateDefinition.php
@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace phpDocumentor\Configuration;
+
+use phpDocumentor\FileSystem\Path;
+
+class TemplateDefinition
+{
+    public function __construct(
+        public string $name,
+        public Path|null $location = null,
+        public array $parameters = [],
+    ) {
+    }
+}
diff --git a/src/phpDocumentor/Dsn.php → src/phpDocumentor/FileSystem/Dsn.php b/src/phpDocumentor/Dsn.php → src/phpDocumentor/FileSystem/Dsn.php
@@ -11,12 +11,13 @@
  * @link https://phpdoc.org
  */
 
-namespace phpDocumentor;
+namespace phpDocumentor\FileSystem;
 
 use Generator;
 use League\Uri\Contracts\UriInterface;
 use League\Uri\UriInfo;
 use League\Uri\UriResolver;
+use phpDocumentor\UriFactory;
 use Stringable;
 
 use function array_shift;

diff --git a/...hpDocumentor/Parser/FileSystemFactory.php → ...cumentor/FileSystem/FileSystemFactory.php b/...hpDocumentor/Parser/FileSystemFactory.php → ...cumentor/FileSystem/FileSystemFactory.php
@@ -11,10 +11,7 @@
  * @link https://phpdoc.org
  */
 
-namespace phpDocumentor\Parser;
-
-use League\Flysystem\Filesystem;
-use phpDocumentor\Dsn;
+namespace phpDocumentor\FileSystem;
 
 /**
  * Interface for FileSystem factories.
@@ -24,5 +21,5 @@ interface FileSystemFactory
     /**
      * Returns a Filesystem instance based on the scheme of the provided Dsn.
      */
-    public function create(Dsn $dsn): Filesystem;
+    public function create(Dsn $dsn): FileSystem;
 }
diff --git a/...phpDocumentor/Parser/FlySystemFactory.php → ...ocumentor/FileSystem/FlySystemFactory.php b/...phpDocumentor/Parser/FlySystemFactory.php → ...ocumentor/FileSystem/FlySystemFactory.php
@@ -11,16 +11,14 @@
  * @link https://phpdoc.org
  */
 
-namespace phpDocumentor\Parser;
+namespace phpDocumentor\FileSystem;
 
-use Flyfinder\Finder;
 use InvalidArgumentException;
 use League\Flysystem\Adapter\Local;
 use League\Flysystem\AdapterInterface;
-use League\Flysystem\Filesystem;
+use League\Flysystem\Filesystem as FlySystemFilesystem;
 use League\Flysystem\MountManager;
 use LogicException;
-use phpDocumentor\Dsn;
 use Webmozart\Assert\Assert;
 
 use function hash;
@@ -39,23 +37,21 @@ public function __construct(private readonly MountManager $mountManager)
     /**
      * Returns a Filesystem instance based on the scheme of the provided Dsn
      */
-    public function create(Dsn $dsn): Filesystem
+    public function create(Dsn $dsn): FileSystem
     {
         $dsnId = hash('md5', (string) $dsn);
 
         try {
             $filesystem = $this->mountManager->getFilesystem($dsnId);
         } catch (LogicException) {
-            $filesystem = new Filesystem($this->createAdapter($dsn));
+            $filesystem = new FlySystemFilesystem($this->createAdapter($dsn));
 
             $this->mountManager->mountFilesystem($dsnId, $filesystem);
         }
 
-        $filesystem->addPlugin(new Finder());
+        Assert::isInstanceOf($filesystem, FlySystemFilesystem::class);
 
-        Assert::isInstanceOf($filesystem, Filesystem::class);
-
-        return $filesystem;
+        return FlySystemAdapter::createFromFileSystem($filesystem);
     }
 
     private function createAdapter(Dsn $dsn): AdapterInterface

diff --git a/src/phpDocumentor/Path.php → src/phpDocumentor/FileSystem/Path.php b/src/phpDocumentor/Path.php → src/phpDocumentor/FileSystem/Path.php
@@ -11,7 +11,7 @@
  * @link https://phpdoc.org
  */
 
-namespace phpDocumentor;
+namespace phpDocumentor\FileSystem;
 
 use Stringable;
 use Webmozart\Assert\Assert;

diff --git a/...ocumentor/Parser/SpecificationFactory.php → ...entor/FileSystem/SpecificationFactory.php b/...ocumentor/Parser/SpecificationFactory.php → ...entor/FileSystem/SpecificationFactory.php
@@ -11,15 +11,14 @@
  * @link https://phpdoc.org
  */
 
-namespace phpDocumentor\Parser;
+namespace phpDocumentor\FileSystem;
 
 use Flyfinder\Specification\Glob;
 use Flyfinder\Specification\HasExtension;
 use Flyfinder\Specification\IsHidden;
 use Flyfinder\Specification\NotSpecification;
 use Flyfinder\Specification\SpecificationInterface;
-use phpDocumentor\Parser\SpecificationFactoryInterface as FactoryInterface;
-use phpDocumentor\Path;
+use phpDocumentor\FileSystem\SpecificationFactoryInterface as FactoryInterface;
 
 /**
  * Factory class to build Specification used by FlyFinder when reading files to process.
@@ -30,7 +29,7 @@ final class SpecificationFactory implements FactoryInterface
      * Creates a SpecificationInterface object based on the ignore and extension parameters.
      *
      * @param list<string|Path> $paths
-     * @param array<string, bool|array<string>|null> $ignore
+     * @param array{paths: list<string|Path>, hidden: bool} $ignore
      * @param list<string> $extensions
      */
     public function create(array $paths, array $ignore, array $extensions): SpecificationInterface

diff --git a/.../Parser/SpecificationFactoryInterface.php → ...eSystem/SpecificationFactoryInterface.php b/.../Parser/SpecificationFactoryInterface.php → ...eSystem/SpecificationFactoryInterface.php
@@ -11,10 +11,9 @@
  * @link https://phpdoc.org
  */
 
-namespace phpDocumentor\Parser;
+namespace phpDocumentor\FileSystem;
 
 use Flyfinder\Specification\SpecificationInterface;
-use phpDocumentor\Path;
 
 /**
  * Interface for Specifications used to filter the FileSystem.
@@ -25,7 +24,7 @@ interface SpecificationFactoryInterface
      * Creates a SpecificationInterface object based on the ignore and extension parameters.
      *
      * @param list<string|Path> $paths
-     * @param array<string, bool|array<string>|null> $ignore
+     * @param array{paths: list<string|Path>, hidden: bool} $ignore
      * @param list<string> $extensions
      */
     public function create(array $paths, array $ignore, array $extensions): SpecificationInterface;

diff --git a/src/phpDocumentor/Parser/Cache/Locator.php b/src/phpDocumentor/Parser/Cache/Locator.php
@@ -13,7 +13,7 @@
 
 namespace phpDocumentor\Parser\Cache;
 
-use phpDocumentor\Path;
+use phpDocumentor\FileSystem\Path;
 use RuntimeException;
 use Symfony\Contracts\Cache\CacheInterface;
 use Webmozart\Assert\Assert;

diff --git a/src/phpDocumentor/Parser/FileCollector.php b/src/phpDocumentor/Parser/FileCollector.php
@@ -13,19 +13,18 @@
 
 namespace phpDocumentor\Parser;
 
-use phpDocumentor\Dsn;
-use phpDocumentor\Path;
+use phpDocumentor\FileSystem\FileSystem;
+use phpDocumentor\FileSystem\Path;
 use phpDocumentor\Reflection\File;
 
 interface FileCollector
 {
     /**
-     * @param Dsn                  $dsn        dsn of source.
-     * @param list<string|Path>    $paths
-     * @param array<string, mixed> $ignore     array containing keys 'paths' and 'hidden'
-     * @param list<string>         $extensions
+     * @param list<string|Path> $paths
+     * @param array{paths: string[], hidden: bool} $ignore     array containing keys 'paths' and 'hidden'
+     * @param list<string> $extensions
      *
      * @return File[]
      */
-    public function getFiles(Dsn $dsn, array $paths, array $ignore, array $extensions): array;
+    public function getFiles(FileSystem $fileSystem, array $paths, array $ignore, array $extensions): array;
 }
diff --git a/src/phpDocumentor/Parser/FlySystemCollector.php b/src/phpDocumentor/Parser/FlySystemCollector.php
@@ -13,14 +13,14 @@
 
 namespace phpDocumentor\Parser;
 
-use phpDocumentor\Dsn;
-use phpDocumentor\Path;
+use phpDocumentor\FileSystem\FileSystem;
+use phpDocumentor\FileSystem\Path;
+use phpDocumentor\FileSystem\SpecificationFactoryInterface;
 
 final class FlySystemCollector implements FileCollector
 {
     public function __construct(
         private readonly SpecificationFactoryInterface $specificationFactory,
-        private readonly FlySystemFactory $flySystemFactory,
     ) {
     }
 
@@ -31,12 +31,10 @@ public function __construct(
      *
      * @return list<FlySystemFile>
      */
-    public function getFiles(Dsn $dsn, array $paths, array $ignore, array $extensions): array
+    public function getFiles(FileSystem $fileSystem, array $paths, array $ignore, array $extensions): array
     {
         $specs = $this->specificationFactory->create($paths, $ignore, $extensions);
 
-        $fileSystem = $this->flySystemFactory->create($dsn);
-
         $files = [];
 
         foreach ($fileSystem->find($specs) as $file) {