Debug commands

config/services.php

@@ -13,13 +13,12 @@
 use Qossmic\Deptrac\AstRunner\Resolver\AnonymousClassResolver;
 use Qossmic\Deptrac\AstRunner\Resolver\ClassConstantResolver;
 use Qossmic\Deptrac\AstRunner\Resolver\TypeResolver;
-use Qossmic\Deptrac\ClassLikeAnalyser;
-use Qossmic\Deptrac\ClassLikeLayerResolverFactory;
 use Qossmic\Deptrac\Collector\BoolCollector;
 use Qossmic\Deptrac\Collector\ClassNameCollector;
 use Qossmic\Deptrac\Collector\ClassNameRegexCollector;
 use Qossmic\Deptrac\Collector\DirectoryCollector;
 use Qossmic\Deptrac\Collector\ExtendsCollector;
+use Qossmic\Deptrac\Collector\FunctionNameCollector;
 use Qossmic\Deptrac\Collector\ImplementsCollector;
 use Qossmic\Deptrac\Collector\InheritanceLevelCollector;
 use Qossmic\Deptrac\Collector\InheritsCollector;
@@ -31,8 +30,8 @@
 use Qossmic\Deptrac\Configuration\Loader\YmlFileLoader;
 use Qossmic\Deptrac\Configuration\ParameterResolver;
 use Qossmic\Deptrac\Console\Command\AnalyseCommand;
-use Qossmic\Deptrac\Console\Command\DebugClassLikeCommand;
 use Qossmic\Deptrac\Console\Command\DebugLayerCommand;
+use Qossmic\Deptrac\Console\Command\DebugTokenCommand;
 use Qossmic\Deptrac\Console\Command\DebugUnassignedCommand;
 use Qossmic\Deptrac\Console\Command\InitCommand;
 use Qossmic\Deptrac\Dependency\InheritanceFlatter;
@@ -55,6 +54,8 @@
 use Qossmic\Deptrac\OutputFormatter\XMLOutputFormatter;
 use Qossmic\Deptrac\OutputFormatterFactory;
 use Qossmic\Deptrac\RulesetEngine;
+use Qossmic\Deptrac\TokenAnalyser;
+use Qossmic\Deptrac\TokenLayerResolverFactory;
 use Qossmic\Deptrac\UnassignedAnalyser;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
 use function Symfony\Component\DependencyInjection\Loader\Configurator\param;
@@ -102,7 +103,7 @@
     $services->set(TypeResolver::class);
 
     $services
-        ->set(ClassLikeLayerResolverFactory::class)
+        ->set(TokenLayerResolverFactory::class)
         ->args([
             service(Registry::class),
             service(ParameterResolver::class),
@@ -115,31 +116,31 @@
             service(FileResolver::class),
             service(Resolver::class),
             service(RulesetEngine::class),
-            service(ClassLikeLayerResolverFactory::class),
+            service(TokenLayerResolverFactory::class),
         ]);
 
     $services
-        ->set(ClassLikeAnalyser::class)
+        ->set(TokenAnalyser::class)
         ->args([
             service(AstRunner::class),
             service(FileResolver::class),
-            service(ClassLikeLayerResolverFactory::class),
+            service(TokenLayerResolverFactory::class),
         ]);
 
     $services
         ->set(LayerAnalyser::class)
         ->args([
             service(AstRunner::class),
             service(FileResolver::class),
-            service(ClassLikeLayerResolverFactory::class),
+            service(TokenLayerResolverFactory::class),
         ]);
 
     $services
         ->set(UnassignedAnalyser::class)
         ->args([
             service(AstRunner::class),
             service(FileResolver::class),
-            service(ClassLikeLayerResolverFactory::class),
+            service(TokenLayerResolverFactory::class),
         ]);
 
     $services->set(RulesetEngine::class);
@@ -195,6 +196,9 @@
     $services
         ->set(ClassNameCollector::class)
         ->tag('collector');
+    $services
+        ->set(FunctionNameCollector::class)
+        ->tag('collector');
     $services
         ->set(ClassNameRegexCollector::class)
         ->tag('collector');
@@ -257,9 +261,9 @@
         ]);
 
     $services
-        ->set(DebugClassLikeCommand::class)
+        ->set(DebugTokenCommand::class)
         ->args([
-            service(ClassLikeAnalyser::class),
+            service(TokenAnalyser::class),
             service(Loader::class),
         ]);
 

docs/debugging.md

@@ -5,7 +5,7 @@ your depfile. All commands output one issue per line and can therefore be easily
 combined with other tools like `wc` or `grep`.
 
 * [`debug:layer`](#debuglayer)
-* [`debug:class`](#debugclass)
+* [`debug:token`](#debugtoken)
 * [`debug:unassigned`](#debugunassigned)
 
 ## `debug:layer`
@@ -21,13 +21,12 @@ examples\Layer1\SomeClass
 examples\Layer1\SomeClass2
 ```
 
-## `debug:class`
+## `debug:token`
 
-The `debug:class`-command will let you know which layers a specified class-like
-belongs to.
+The `debug:token` (previously `debug:class-like`)-command will let you know which layers a specified token belongs to.
 
 ```bash
-php deptrac.phar debug:class-like examples/DirectoryLayer.depfile.yaml 'examples\Layer1\AnotherClassLikeAController'
+php deptrac.phar debug:token examples/DirectoryLayer.depfile.yaml 'examples\Layer1\AnotherClassLikeAController' class-like
 
 Controller
 Layer1

src/Analyser.php

@@ -13,14 +13,14 @@ class Analyser
     private FileResolver $fileResolver;
     private Resolver $resolver;
     private RulesetEngine $rulesetEngine;
-    private ClassLikeLayerResolverFactory $classLikeLayerResolverFactory;
+    private TokenLayerResolverFactory $classLikeLayerResolverFactory;
 
     public function __construct(
         AstRunner $astRunner,
         FileResolver $fileResolver,
         Resolver $resolver,
         RulesetEngine $rulesetEngine,
-        ClassLikeLayerResolverFactory $classLikeLayerResolverFactory
+        TokenLayerResolverFactory $classLikeLayerResolverFactory
     ) {
         $this->astRunner = $astRunner;
         $this->fileResolver = $fileResolver;

src/AstRunner/AstMap/SuperGlobalName.php

@@ -6,6 +6,18 @@
 
 final class SuperGlobalName implements TokenName
 {
+    public const ALLOWED_NAMES = [
+        'GLOBALS',
+        '_SERVER',
+        '_GET',
+        '_POST',
+        '_FILES',
+        '_COOKIE',
+        '_SESSION',
+        '_REQUEST',
+        '_ENV',
+    ];
+
     private string $name;
 
     public function __construct(string $name)

src/AstRunner/AstParser/NikicPhpParser/FileReferenceVisitor.php

@@ -29,24 +29,13 @@
 use Qossmic\Deptrac\AstRunner\AstMap\ClassReferenceBuilder;
 use Qossmic\Deptrac\AstRunner\AstMap\FileReferenceBuilder;
 use Qossmic\Deptrac\AstRunner\AstMap\ReferenceBuilder;
+use Qossmic\Deptrac\AstRunner\AstMap\SuperGlobalName;
 use Qossmic\Deptrac\AstRunner\Resolver\DependencyResolver;
 use Qossmic\Deptrac\AstRunner\Resolver\TypeResolver;
 use Qossmic\Deptrac\AstRunner\Resolver\TypeScope;
 
 class FileReferenceVisitor extends NodeVisitorAbstract
 {
-    private const SUPERGLOBALS = [
-        'GLOBALS',
-        '_SERVER',
-        '_GET',
-        '_POST',
-        '_FILES',
-        '_COOKIE',
-        '_SESSION',
-        '_REQUEST',
-        '_ENV',
-    ];
-
     private FileReferenceBuilder $fileReferenceBuilder;
 
     /** @var DependencyResolver[] */
@@ -182,7 +171,7 @@ public function leaveNode(Node $node)
             }
         }
 
-        if ($node instanceof Node\Expr\Variable && in_array($node->name, self::SUPERGLOBALS, true)) {
+        if ($node instanceof Node\Expr\Variable && in_array($node->name, SuperGlobalName::ALLOWED_NAMES, true)) {
             $this->currentReference->superglobal($node->name, $node->getLine());
         }
 

src/Console/Application.php

@@ -6,8 +6,8 @@
 
 use Psr\Container\ContainerInterface;
 use Qossmic\Deptrac\Console\Command\AnalyseCommand;
-use Qossmic\Deptrac\Console\Command\DebugClassLikeCommand;
 use Qossmic\Deptrac\Console\Command\DebugLayerCommand;
+use Qossmic\Deptrac\Console\Command\DebugTokenCommand;
 use Qossmic\Deptrac\Console\Command\DebugUnassignedCommand;
 use Qossmic\Deptrac\Console\Command\InitCommand;
 use Qossmic\Deptrac\ContainerBuilder;
@@ -45,8 +45,8 @@ public function doRun(InputInterface $input, OutputInterface $output): int
         /** @var AnalyseCommand $analyseCommand */
         $analyseCommand = $container->get(AnalyseCommand::class);
 
-        /** @var DebugClassLikeCommand $debugClassLikeCommand */
-        $debugClassLikeCommand = $container->get(DebugClassLikeCommand::class);
+        /** @var DebugTokenCommand $debugClassLikeCommand */
+        $debugClassLikeCommand = $container->get(DebugTokenCommand::class);
 
         /** @var DebugLayerCommand $debugLayerCommand */
         $debugLayerCommand = $container->get(DebugLayerCommand::class);

src/Console/Command/DebugTokenCommand.php

@@ -0,0 +1,80 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Qossmic\Deptrac\Console\Command;
+
+use Qossmic\Deptrac\AstRunner\AstMap\ClassLikeName;
+use Qossmic\Deptrac\AstRunner\AstMap\FileName;
+use Qossmic\Deptrac\AstRunner\AstMap\FunctionName;
+use Qossmic\Deptrac\Configuration\Loader;
+use Qossmic\Deptrac\Console\Command\Exception\SingleDepfileIsRequiredException;
+use Qossmic\Deptrac\TokenAnalyser;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class DebugTokenCommand extends Command
+{
+    private TokenAnalyser $analyser;
+    private Loader $loader;
+
+    public function __construct(
+        TokenAnalyser $analyser,
+        Loader $loader
+    ) {
+        parent::__construct();
+
+        $this->analyser = $analyser;
+        $this->loader = $loader;
+    }
+
+    protected function configure(): void
+    {
+        $this->setName('debug:token');
+        $this->setAliases(['debug:class-like']);
+
+        $this->addArgument('depfile', InputArgument::REQUIRED, 'Path to the depfile');
+        $this->addArgument('token', InputArgument::REQUIRED, 'Full qualified token name to debug');
+        $this->addArgument('type', InputArgument::OPTIONAL, 'Token type (class-like, function, file)', 'class-like');
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $depfile = $input->getArgument('depfile');
+
+        if (!is_string($depfile)) {
+            throw SingleDepfileIsRequiredException::fromArgument($depfile);
+        }
+
+        /** @var string $tokenName */
+        $tokenName = $input->getArgument('token');
+        /** @var string $tokenType */
+        $tokenType = $input->getArgument('type');
+
+        $configuration = $this->loader->load($depfile);
+
+        switch ($tokenType) {
+            case 'class-like':
+                $token = ClassLikeName::fromFQCN($tokenName);
+                break;
+            case 'function':
+                $token = FunctionName::fromFQCN($tokenName);
+                break;
+            case 'file':
+                $token = new FileName($tokenName);
+                break;
+            default:
+                throw new \RuntimeException('Invalid token type "'.$tokenType.'". Only "class-like", "function" or "file" are supported.');
+        }
+
+        $layers = $this->analyser->analyse($configuration, $token);
+
+        natcasesort($layers);
+
+        $output->writeln($layers);
+
+        return 0;
+    }
+}

src/LayerAnalyser.php

@@ -13,12 +13,12 @@ class LayerAnalyser
 {
     private AstRunner $astRunner;
     private FileResolver $fileResolver;
-    private ClassLikeLayerResolverFactory $classLikeLayerResolverFactory;
+    private TokenLayerResolverFactory $classLikeLayerResolverFactory;
 
     public function __construct(
         AstRunner $astRunner,
         FileResolver $fileResolver,
-        ClassLikeLayerResolverFactory $classLikeLayerResolverFactory
+        TokenLayerResolverFactory $classLikeLayerResolverFactory
     ) {
         $this->astRunner = $astRunner;
         $this->fileResolver = $fileResolver;