- Move ParserInterface.php into the Contract.

- Move AstMap related data classes into the contract.

This is in preparation to allow custom implementations of the AstParser for Deptrac purposes. This is useful for 2 reasons:
- It will allow closing qossmic/deptrac#1402 by recommending a custom version of the parser implemented in the userspace with a supported contract to implement by the custom version
- allow for replacing the Nikic parser by PHPStan Parser.

Neither of those are implemented in this commit, but the rest of the required dependencies for the first will be exposed in the next commit.

baseline.xml

@@ -8,12 +8,12 @@
       <code><![CDATA[list<T>]]></code>
     </InvalidReturnType>
   </file>
-  <file src="src/Core/Ast/AstMap/ClassLike/ClassLikeToken.php">
+  <file src="src/Contract/Ast/AstMap/ClassLikeToken.php">
     <ArgumentTypeCoercion>
       <code>$pattern</code>
     </ArgumentTypeCoercion>
   </file>
-  <file src="src/Core/Ast/AstMap/Function/FunctionToken.php">
+  <file src="src/Contract/Ast/AstMap/FunctionToken.php">
     <ArgumentTypeCoercion>
       <code>$pattern</code>
     </ArgumentTypeCoercion>

config/services.php

@@ -7,6 +7,7 @@
 use PhpParser\ParserFactory;
 use Psr\EventDispatcher\EventDispatcherInterface;
 use Qossmic\Deptrac\Contract\Analyser\EventHelper;
+use Qossmic\Deptrac\Contract\Ast\ParserInterface;
 use Qossmic\Deptrac\Contract\Config\CollectorType;
 use Qossmic\Deptrac\Contract\Config\EmitterType;
 use Qossmic\Deptrac\Contract\Layer\LayerProvider;
@@ -38,7 +39,6 @@
 use Qossmic\Deptrac\Core\Ast\Parser\Extractors\StaticExtractor;
 use Qossmic\Deptrac\Core\Ast\Parser\Extractors\VariableExtractor;
 use Qossmic\Deptrac\Core\Ast\Parser\NikicPhpParser\NikicPhpParser;
-use Qossmic\Deptrac\Core\Ast\Parser\ParserInterface;
 use Qossmic\Deptrac\Core\Ast\Parser\TypeResolver;
 use Qossmic\Deptrac\Core\Dependency\DependencyResolver;
 use Qossmic\Deptrac\Core\Dependency\Emitter\ClassDependencyEmitter;

src/Contract/Analyser/ProcessEvent.php

@@ -4,7 +4,7 @@
 
 namespace Qossmic\Deptrac\Contract\Analyser;
 
-use Qossmic\Deptrac\Contract\Ast\TokenReferenceInterface;
+use Qossmic\Deptrac\Contract\Ast\AstMap\TokenReferenceInterface;
 use Qossmic\Deptrac\Contract\Dependency\DependencyInterface;
 use Symfony\Contracts\EventDispatcher\Event;
 

src/Core/Ast/AstMap/AstInherit.php → src/Contract/Ast/AstMap/AstInherit.php

@@ -2,10 +2,8 @@
 
 declare(strict_types=1);
 
-namespace Qossmic\Deptrac\Core\Ast\AstMap;
+namespace Qossmic\Deptrac\Contract\Ast\AstMap;
 
-use Qossmic\Deptrac\Contract\Ast\FileOccurrence;
-use Qossmic\Deptrac\Core\Ast\AstMap\ClassLike\ClassLikeToken;
 use Stringable;
 
 use function array_reverse;

src/Core/Ast/AstMap/AstInheritType.php → src/Contract/Ast/AstMap/AstInheritType.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Qossmic\Deptrac\Core\Ast\AstMap;
+namespace Qossmic\Deptrac\Contract\Ast\AstMap;
 
 enum AstInheritType: string
 {

src/Core/Ast/AstMap/ClassLike/ClassLikeReference.php → src/Contract/Ast/AstMap/ClassLikeReference.php

@@ -2,17 +2,12 @@
 
 declare(strict_types=1);
 
-namespace Qossmic\Deptrac\Core\Ast\AstMap\ClassLike;
-
-use Qossmic\Deptrac\Core\Ast\AstMap\AstInherit;
-use Qossmic\Deptrac\Core\Ast\AstMap\DependencyToken;
-use Qossmic\Deptrac\Core\Ast\AstMap\File\FileReference;
-use Qossmic\Deptrac\Core\Ast\AstMap\TaggedTokenReference;
+namespace Qossmic\Deptrac\Contract\Ast\AstMap;
 
 /**
  * @psalm-immutable
  */
-class ClassLikeReference extends TaggedTokenReference
+final class ClassLikeReference extends TaggedTokenReference
 {
     public readonly ClassLikeType $type;
 

src/Core/Ast/AstMap/ClassLike/ClassLikeToken.php → src/Contract/Ast/AstMap/ClassLikeToken.php

@@ -2,10 +2,11 @@
 
 declare(strict_types=1);
 
-namespace Qossmic\Deptrac\Core\Ast\AstMap\ClassLike;
-
-use Qossmic\Deptrac\Contract\Ast\TokenInterface;
+namespace Qossmic\Deptrac\Contract\Ast\AstMap;
 
+/**
+ * @psalm-immutable
+ */
 final class ClassLikeToken implements TokenInterface
 {
     private function __construct(private readonly string $className) {}

src/Core/Ast/AstMap/ClassLike/ClassLikeType.php → src/Contract/Ast/AstMap/ClassLikeType.php

@@ -2,9 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Qossmic\Deptrac\Core\Ast\AstMap\ClassLike;
-
-use Qossmic\Deptrac\Contract\Ast\TokenInterface;
+namespace Qossmic\Deptrac\Contract\Ast\AstMap;
 
 enum ClassLikeType: string implements TokenInterface
 {

src/Contract/Ast/DependencyContext.php → src/Contract/Ast/AstMap/DependencyContext.php

@@ -2,13 +2,11 @@
 
 declare(strict_types=1);
 
-namespace Qossmic\Deptrac\Contract\Ast;
+namespace Qossmic\Deptrac\Contract\Ast\AstMap;
 
 /**
  * @psalm-immutable
- *
  * Context of the dependency.
- *
  * Any additional info about where the dependency occurred.
  */
 final class DependencyContext

src/Core/Ast/AstMap/DependencyToken.php → src/Contract/Ast/AstMap/DependencyToken.php

@@ -2,15 +2,12 @@
 
 declare(strict_types=1);
 
-namespace Qossmic\Deptrac\Core\Ast\AstMap;
-
-use Qossmic\Deptrac\Contract\Ast\DependencyContext;
-use Qossmic\Deptrac\Contract\Ast\TokenInterface;
+namespace Qossmic\Deptrac\Contract\Ast\AstMap;
 
 /**
  * @psalm-immutable
  */
-class DependencyToken
+final class DependencyToken
 {
     public function __construct(
         public readonly TokenInterface $token,

src/Contract/Ast/DependencyType.php → src/Contract/Ast/AstMap/DependencyType.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Qossmic\Deptrac\Contract\Ast;
+namespace Qossmic\Deptrac\Contract\Ast\AstMap;
 
 /**
  * Specifies the type of AST dependency.

src/Contract/Ast/FileOccurrence.php → src/Contract/Ast/AstMap/FileOccurrence.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Qossmic\Deptrac\Contract\Ast;
+namespace Qossmic\Deptrac\Contract\Ast\AstMap;
 
 /**
  * @psalm-immutable

src/Core/Ast/AstMap/File/FileReference.php → src/Contract/Ast/AstMap/FileReference.php

@@ -2,18 +2,12 @@
 
 declare(strict_types=1);
 
-namespace Qossmic\Deptrac\Core\Ast\AstMap\File;
-
-use Qossmic\Deptrac\Contract\Ast\TokenInterface;
-use Qossmic\Deptrac\Contract\Ast\TokenReferenceInterface;
-use Qossmic\Deptrac\Core\Ast\AstMap\ClassLike\ClassLikeReference;
-use Qossmic\Deptrac\Core\Ast\AstMap\DependencyToken;
-use Qossmic\Deptrac\Core\Ast\AstMap\Function\FunctionReference;
+namespace Qossmic\Deptrac\Contract\Ast\AstMap;
 
 /**
  * @psalm-immutable
  */
-class FileReference implements TokenReferenceInterface
+final class FileReference implements TokenReferenceInterface
 {
     /** @var ClassLikeReference[] */
     public readonly array $classLikeReferences;
@@ -44,7 +38,7 @@ public function __construct(
         );
     }
 
-    public function getFilepath(): ?string
+    public function getFilepath(): string
     {
         return $this->filepath;
     }

src/Core/Ast/AstMap/File/FileToken.php → src/Contract/Ast/AstMap/FileToken.php

@@ -2,9 +2,8 @@
 
 declare(strict_types=1);
 
-namespace Qossmic\Deptrac\Core\Ast\AstMap\File;
+namespace Qossmic\Deptrac\Contract\Ast\AstMap;
 
-use Qossmic\Deptrac\Contract\Ast\TokenInterface;
 use Symfony\Component\Filesystem\Path;
 
 final class FileToken implements TokenInterface

src/Core/Ast/AstMap/Function/FunctionReference.php → src/Contract/Ast/AstMap/FunctionReference.php

@@ -2,17 +2,12 @@
 
 declare(strict_types=1);
 
-namespace Qossmic\Deptrac\Core\Ast\AstMap\Function;
-
-use Qossmic\Deptrac\Contract\Ast\TokenInterface;
-use Qossmic\Deptrac\Core\Ast\AstMap\DependencyToken;
-use Qossmic\Deptrac\Core\Ast\AstMap\File\FileReference;
-use Qossmic\Deptrac\Core\Ast\AstMap\TaggedTokenReference;
+namespace Qossmic\Deptrac\Contract\Ast\AstMap;
 
 /**
  * @psalm-immutable
  */
-class FunctionReference extends TaggedTokenReference
+final class FunctionReference extends TaggedTokenReference
 {
     /**
      * @param DependencyToken[] $dependencies

src/Core/Ast/AstMap/Function/FunctionToken.php → src/Contract/Ast/AstMap/FunctionToken.php

@@ -2,9 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Qossmic\Deptrac\Core\Ast\AstMap\Function;
-
-use Qossmic\Deptrac\Contract\Ast\TokenInterface;
+namespace Qossmic\Deptrac\Contract\Ast\AstMap;
 
 final class FunctionToken implements TokenInterface
 {

src/Core/Ast/AstMap/Variable/SuperGlobalToken.php → src/Contract/Ast/AstMap/SuperGlobalToken.php

@@ -2,9 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Qossmic\Deptrac\Core\Ast\AstMap\Variable;
-
-use Qossmic\Deptrac\Contract\Ast\TokenInterface;
+namespace Qossmic\Deptrac\Contract\Ast\AstMap;
 
 enum SuperGlobalToken: string implements TokenInterface
 {

src/Core/Ast/AstMap/TaggedTokenReference.php → src/Contract/Ast/AstMap/TaggedTokenReference.php

@@ -2,9 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Qossmic\Deptrac\Core\Ast\AstMap;
-
-use Qossmic\Deptrac\Contract\Ast\TaggedTokenReferenceInterface;
+namespace Qossmic\Deptrac\Contract\Ast\AstMap;
 
 /**
  * Helper trait for implementing TaggedTokenReferenceInterface.

src/Contract/Ast/TaggedTokenReferenceInterface.php → src/Contract/Ast/AstMap/TaggedTokenReferenceInterface.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Qossmic\Deptrac\Contract\Ast;
+namespace Qossmic\Deptrac\Contract\Ast\AstMap;
 
 /**
  * Represents the AST-Token, its location, and associated tags.

src/Contract/Ast/TokenInterface.php → src/Contract/Ast/AstMap/TokenInterface.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Qossmic\Deptrac\Contract\Ast;
+namespace Qossmic\Deptrac\Contract\Ast\AstMap;
 
 /**
  * Represents an AST-Token, which can be referenced as dependency.

src/Contract/Ast/TokenReferenceInterface.php → src/Contract/Ast/AstMap/TokenReferenceInterface.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Qossmic\Deptrac\Contract\Ast;
+namespace Qossmic\Deptrac\Contract\Ast\AstMap;
 
 /**
  * Represents the AST-Token and its location.

src/Core/Ast/AstMap/Variable/VariableReference.php → src/Contract/Ast/AstMap/VariableReference.php

@@ -2,15 +2,12 @@
 
 declare(strict_types=1);
 
-namespace Qossmic\Deptrac\Core\Ast\AstMap\Variable;
-
-use Qossmic\Deptrac\Contract\Ast\TokenInterface;
-use Qossmic\Deptrac\Contract\Ast\TokenReferenceInterface;
+namespace Qossmic\Deptrac\Contract\Ast\AstMap;
 
 /**
  * @psalm-immutable
  */
-class VariableReference implements TokenReferenceInterface
+final class VariableReference implements TokenReferenceInterface
 {
     public function __construct(private readonly SuperGlobalToken $tokenName) {}
 

src/Contract/Ast/ParserInterface.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Qossmic\Deptrac\Contract\Ast;
+
+use Qossmic\Deptrac\Contract\Ast\AstMap\ClassLikeReference;
+use Qossmic\Deptrac\Contract\Ast\AstMap\FileReference;
+
+interface ParserInterface
+{
+    /**
+     * @throws CouldNotParseFileException
+     */
+    public function parseFile(string $file): FileReference;
+
+    /**
+     * @return list<string> list of method names for a given class-like reference
+     *
+     * @throws CouldNotParseFileException
+     */
+    public function getMethodNamesForClassLikeReference(ClassLikeReference $classReference): array;
+}

src/Contract/Dependency/DependencyInterface.php

@@ -4,8 +4,8 @@
 
 namespace Qossmic\Deptrac\Contract\Dependency;
 
-use Qossmic\Deptrac\Contract\Ast\DependencyContext;
-use Qossmic\Deptrac\Contract\Ast\TokenInterface;
+use Qossmic\Deptrac\Contract\Ast\AstMap\DependencyContext;
+use Qossmic\Deptrac\Contract\Ast\AstMap\TokenInterface;
 
 /**
  * Represents a dependency between 2 tokens (depender and dependent).

src/Contract/Layer/CollectorInterface.php

@@ -4,8 +4,8 @@
 
 namespace Qossmic\Deptrac\Contract\Layer;
 
+use Qossmic\Deptrac\Contract\Ast\AstMap\TokenReferenceInterface;
 use Qossmic\Deptrac\Contract\Ast\CouldNotParseFileException;
-use Qossmic\Deptrac\Contract\Ast\TokenReferenceInterface;
 
 /**
  * A collector is responsible to tell whether an AST node (e.g. a specific class) is part of a layer.

src/Core/Analyser/EventHandler/DependsOnInternalToken.php

@@ -7,7 +7,7 @@
 use Qossmic\Deptrac\Contract\Analyser\EventHelper;
 use Qossmic\Deptrac\Contract\Analyser\ProcessEvent;
 use Qossmic\Deptrac\Contract\Analyser\ViolationCreatingInterface;
-use Qossmic\Deptrac\Core\Ast\AstMap\ClassLike\ClassLikeReference;
+use Qossmic\Deptrac\Contract\Ast\AstMap\ClassLikeReference;
 
 /**
  * @internal

src/Core/Analyser/EventHandler/UncoveredDependentHandler.php

@@ -6,8 +6,8 @@
 
 use JetBrains\PHPStormStub\PhpStormStubsMap;
 use Qossmic\Deptrac\Contract\Analyser\ProcessEvent;
+use Qossmic\Deptrac\Contract\Ast\AstMap\ClassLikeToken;
 use Qossmic\Deptrac\Contract\Result\Uncovered;
-use Qossmic\Deptrac\Core\Ast\AstMap\ClassLike\ClassLikeToken;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 
 /**

src/Core/Analyser/LayerForTokenAnalyser.php

@@ -4,8 +4,8 @@
 
 namespace Qossmic\Deptrac\Core\Analyser;
 
+use Qossmic\Deptrac\Contract\Ast\AstMap\TokenReferenceInterface;
 use Qossmic\Deptrac\Contract\Ast\CouldNotParseFileException;
-use Qossmic\Deptrac\Contract\Ast\TokenReferenceInterface;
 use Qossmic\Deptrac\Contract\Layer\InvalidCollectorDefinitionException;
 use Qossmic\Deptrac\Contract\Layer\InvalidLayerDefinitionException;
 use Qossmic\Deptrac\Core\Ast\AstException;

src/Core/Ast/AstLoader.php

@@ -8,10 +8,10 @@
 use Qossmic\Deptrac\Contract\Ast\AstFileAnalysedEvent;
 use Qossmic\Deptrac\Contract\Ast\AstFileSyntaxErrorEvent;
 use Qossmic\Deptrac\Contract\Ast\CouldNotParseFileException;
+use Qossmic\Deptrac\Contract\Ast\ParserInterface;
 use Qossmic\Deptrac\Contract\Ast\PostCreateAstMapEvent;
 use Qossmic\Deptrac\Contract\Ast\PreCreateAstMapEvent;
 use Qossmic\Deptrac\Core\Ast\AstMap\AstMap;
-use Qossmic\Deptrac\Core\Ast\Parser\ParserInterface;
 
 class AstLoader
 {