tests: overed with tests import loader

Author: butschster

context.yaml

@@ -1,6 +1,5 @@
 import:
-  - path: src/**/context.yaml
-  - path: src/ConfigLoader/context.yaml
+  - path: src/*/context.yaml
 
 documents:
   - description: "Context Generator Project Structure"
@@ -55,117 +54,11 @@ documents:
           - 'FilesInterface.php'
         showTreeView: true
 
-  - description: Document Compilation System
-    outputPath: core/document.md
+  - description: Config parser
+    outputPath: core/config-parser.md
     sources:
       - type: file
-        sourcePaths: src/Document
-        contains:
-          - implements
-
-  - description: Source Implementations - File
-    outputPath: sources/file-source.md
-    sources:
-      - type: file
-        sourcePaths: src/Source/File
-        filePattern: '*.php'
-        showTreeView: true
-
-  - description: Source Implementations - GitHub
-    outputPath: sources/github-source.md
-    sources:
-      - type: file
-        sourcePaths: src/Source/Github
-        filePattern: '*.php'
-        showTreeView: true
-
-  - description: Source Implementations - URL
-    outputPath: sources/url-source.md
-    sources:
-      - type: file
-        sourcePaths: src/Source/Url
-        filePattern: '*.php'
-        showTreeView: true
-
-  - description: Source Implementations - Text
-    outputPath: sources/text-source.md
-    sources:
-      - type: file
-        sourcePaths: src/Source/Text
-        filePattern: '*.php'
-        showTreeView: true
-
-  - description: Source Implementations - Git Diff
-    outputPath: sources/git-diff-source.md
-    sources:
-      - type: file
-        sourcePaths: src/Source/GitDiff
-        filePattern: '*.php'
-        showTreeView: true
-
-  - description: Source Implementations - Composer
-    outputPath: sources/composer-source.md
-    sources:
-      - type: file
-        sourcePaths: src/Source/Composer
-        filePattern: '*.php'
-        showTreeView: true
-
-  - description: Source Implementations - Tree
-    outputPath: sources/tree-source.md
-    sources:
-      - type: file
-        sourcePaths: src/Source/Tree
-        filePattern: '*.php'
-        showTreeView: true
-
-  - description: Modifiers System
-    outputPath: modifiers/modifiers-core.md
-    sources:
-      - type: file
-        sourcePaths: src/Modifier
-        filePattern:
-          - '*.php'
-          - 'Alias/*.php'
-        notPath:
-          - 'PhpContentFilter.php'
-          - 'PhpSignature.php'
-          - 'ContextSanitizerModifier.php'
-        showTreeView: true
-
-  - description: PHP Content Modifiers
-    outputPath: modifiers/php-modifiers.md
-    sources:
-      - type: file
-        sourcePaths: src/Modifier
-        filePattern:
-          - 'PhpContentFilter.php'
-          - 'PhpSignature.php'
-        showTreeView: true
-
-  - description: Sanitizer Modifier
-    outputPath: modifiers/sanitizer.md
-    sources:
-      - type: file
-        sourcePaths:
-          - src/Modifier/ContextSanitizerModifier.php
-          - src/Lib/Sanitizer
-        filePattern: '*.php'
-        showTreeView: true
-
-  - description: Content Building System
-    outputPath: utilities/content-builder.md
-    sources:
-      - type: file
-        sourcePaths: src/Lib/Content
-        filePattern: '*.php'
-        showTreeView: true
-
-  - description: Content Block Types
-    outputPath: utilities/content-blocks.md
-    sources:
-      - type: file
-        sourcePaths: src/Lib/Content/Block
+        sourcePaths: src/ConfigLoader
         filePattern: '*.php'
         showTreeView: true
 
@@ -197,7 +90,9 @@ documents:
     outputPath: utilities/github-client.md
     sources:
       - type: file
-        sourcePaths: src/Lib/GithubClient
+        sourcePaths:
+          - src/Lib/GithubClient
+          - src/GithubClientFactory.php
         filePattern: '*.php'
         showTreeView: true
 
@@ -232,22 +127,6 @@ documents:
         sourcePaths:
           - tests
 
-  - description: "MCP Server Actions"
-    outputPath: "mcp/actions.md"
-    sources:
-      - type: file
-        sourcePaths:
-          - src/McpServer/Action
-
-  - description: "MCP Server routing"
-    outputPath: "mcp/routing.md"
-    sources:
-      - type: file
-        sourcePaths:
-          - src/McpServer/Routing
-          - src/McpServer/Server.php
-          - src/McpServer/ServerFactory.php
-
   - description: "Changes in the Project"
     outputPath: "changes.md"
     sources:
@@ -256,13 +135,25 @@ documents:
 
   - description: Import documents docs
     outputPath: docs/import-docs.md
+    overwrite: false
     sources:
       - type: file
         sourcePaths:
           - src/ConfigLoader/Import
+          - tests/src/ConfigLoader/Import
+          - tests/fixtures/ConfigLoader
         showTreeView: true
-      - type: github
-        repository: context-hub/docs
-        branch: main
+
+  - description: Directories using
+    outputPath: docs/dirs.md
+    modifiers:
+      - name: php-content-filter
+        options:
+          keep_doc_comments: false
+    sources:
+      - type: file
         sourcePaths:
-          - docs/configuration.md
+          - src
+        showTreeView: true
+        contains:
+          - Directories

src/ConfigLoader/ConfigLoaderFactory.php

@@ -8,7 +8,6 @@
 use Butschster\ContextGenerator\ConfigLoader\Import\ImportResolver;
 use Butschster\ContextGenerator\ConfigLoader\Parser\CompositeConfigParser;
 use Butschster\ContextGenerator\ConfigLoader\Parser\ConfigParser;
-use Butschster\ContextGenerator\ConfigLoader\Parser\ConfigParserPluginInterface;
 use Butschster\ContextGenerator\ConfigLoader\Parser\ImportParserPlugin;
 use Butschster\ContextGenerator\ConfigLoader\Reader\JsonReader;
 use Butschster\ContextGenerator\ConfigLoader\Reader\PhpReader;
@@ -22,20 +21,14 @@
 /**
  * Factory for creating config loaders
  */
-final readonly class ConfigLoaderFactory
+final readonly class ConfigLoaderFactory implements ConfigLoaderFactoryInterface
 {
     public function __construct(
         private FilesInterface $files,
         private Directories $dirs,
         private ?LoggerInterface $logger = null,
     ) {}
 
-    /**
-     * Create a loader for a specific config file
-     *
-     * @param array<ConfigParserPluginInterface> $parserPlugins Plugins for the config parser
-     * @return ConfigLoaderInterface The config loader
-     */
     public function create(Directories $dirs, array $parserPlugins = []): ConfigLoaderInterface
     {
         \assert($this->logger instanceof HasPrefixLoggerInterface);
@@ -115,7 +108,6 @@ public function create(Directories $dirs, array $parserPlugins = []): ConfigLoad
         );
     }
 
-    // Add a new method to ConfigLoaderFactory to create a loader for a specific file path
     public function createForFile(Directories $dirs, array $parserPlugins = []): ConfigLoaderInterface
     {
         \assert($this->logger instanceof HasPrefixLoggerInterface);
@@ -172,13 +164,6 @@ public function createForFile(Directories $dirs, array $parserPlugins = []): Con
         );
     }
 
-    /**
-     * Create a loader for an inline JSON configuration string
-     *
-     * @param string $jsonConfig The JSON configuration string
-     * @param array<ConfigParserPluginInterface> $parserPlugins Plugins for the config parser
-     * @return ConfigLoaderInterface The config loader
-     */
     public function createFromString(string $jsonConfig, array $parserPlugins = []): ConfigLoaderInterface
     {
         \assert($this->logger instanceof HasPrefixLoggerInterface);

src/ConfigLoader/ConfigLoaderFactoryInterface.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Butschster\ContextGenerator\ConfigLoader;
+
+use Butschster\ContextGenerator\ConfigLoader\Parser\ConfigParserPluginInterface;
+use Butschster\ContextGenerator\Directories;
+
+/**
+ * Interface for factories that create config loaders
+ */
+interface ConfigLoaderFactoryInterface
+{
+    /**
+     * Create a loader for a specific config file
+     *
+     * @param array<ConfigParserPluginInterface> $parserPlugins Plugins for the config parser
+     * @return ConfigLoaderInterface The config loader
+     */
+    public function create(Directories $dirs, array $parserPlugins = []): ConfigLoaderInterface;
+
+    /**
+     * Create a loader for a specific file path
+     *
+     * @param array<ConfigParserPluginInterface> $parserPlugins Plugins for the config parser
+     * @return ConfigLoaderInterface The config loader
+     */
+    public function createForFile(Directories $dirs, array $parserPlugins = []): ConfigLoaderInterface;
+
+    /**
+     * Create a loader for an inline JSON configuration string
+     *
+     * @param string $jsonConfig The JSON configuration string
+     * @param array<ConfigParserPluginInterface> $parserPlugins Plugins for the config parser
+     * @return ConfigLoaderInterface The config loader
+     */
+    public function createFromString(string $jsonConfig, array $parserPlugins = []): ConfigLoaderInterface;
+}

src/ConfigLoader/ConfigurationProvider.php

@@ -15,7 +15,7 @@
 final readonly class ConfigurationProvider
 {
     public function __construct(
-        private ConfigLoaderFactory $loaderFactory,
+        private ConfigLoaderFactoryInterface $loaderFactory,
         private FilesInterface $files,
         private Directories $dirs,
         private ?LoggerInterface $logger = null,

src/ConfigLoader/Import/CircularImportDetector.php

@@ -7,7 +7,7 @@
 /**
  * Detects circular dependencies in imports
  */
-final class CircularImportDetector
+final class CircularImportDetector implements CircularImportDetectorInterface
 {
     /**
      * @var array<string> Stack of import paths being processed

src/ConfigLoader/Import/CircularImportDetectorInterface.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Butschster\ContextGenerator\ConfigLoader\Import;
+
+/**
+ * Interface for detecting circular dependencies in imports
+ */
+interface CircularImportDetectorInterface
+{
+    /**
+     * Check if adding this path would create a circular dependency
+     */
+    public function wouldCreateCircularDependency(string $path): bool;
+
+    /**
+     * Begin processing an import path
+     */
+    public function beginProcessing(string $path): void;
+
+    /**
+     * Finish processing an import path
+     */
+    public function endProcessing(string $path): void;
+}

src/ConfigLoader/Import/ImportConfig.php

@@ -9,15 +9,47 @@
  */
 final readonly class ImportConfig
 {
+    /**
+     * Creates a new ImportConfig instance.
+     *
+     * @param string $path The path to the configuration file to import
+     * @param string $absolutePath The resolved absolute path to the import file
+     * @param string|null $pathPrefix An optional prefix to add to the output path for documents from this import
+     * @param bool $hasWildcard Whether the path contains wildcard characters for pattern matching
+     */
     public function __construct(
         public string $path,
         public string $absolutePath,
         public ?string $pathPrefix = null,
         public bool $hasWildcard = false,
     ) {}
 
+    public function configDirectory(bool $absolute = false): string
+    {
+        return \dirname($absolute ? $this->absolutePath : $this->path);
+    }
+
     /**
      * Create from an array configuration
+     *
+     * Example:
+     * ```php
+     * // Simple import with no prefix
+     * $config = ImportConfig::fromArray(['path' => 'configs/api.json'], '/app');
+     *
+     * // Import with output path prefix
+     * $config = ImportConfig::fromArray(
+     *     ['path' => 'configs/api.json', 'pathPrefix' => 'api/v1'],
+     *     '/app'
+     * );
+     *
+     * // With this configuration, documents from api.json will be
+     * // generated with the path prefix 'api/v1/' in the output directory
+     * ```
+     *
+     * @param array $config Import configuration array with 'path' and optional 'pathPrefix'
+     * @param string $basePath Base path for resolving relative import paths
+     * @throws \InvalidArgumentException If required 'path' property is missing
      */
     public static function fromArray(array $config, string $basePath): self
     {
@@ -26,6 +58,9 @@ public static function fromArray(array $config, string $basePath): self
             throw new \InvalidArgumentException("Import configuration must have a 'path' property");
         }
         $path = $config['path'];
+
+        // The pathPrefix is used to specify a subdirectory in the output path
+        // where documents from this import should be generated
         $pathPrefix = $config['pathPrefix'] ?? null;
 
         // Check if the path contains wildcards