refactor

imanghafoori1 · Dec 4, 2023 · 35389b5 · 35389b5
1 parent 5ae40cf
commit 35389b5
Show file tree

Hide file tree

Showing 20 changed files with 165 additions and 132 deletions.
diff --git a/src/ErrorReporters/ErrorPrinter.php b/src/ErrorReporters/ErrorPrinter.php
@@ -10,20 +10,46 @@ class ErrorPrinter
 {
     public static $ignored;
 
-    public $errorsList = [
-        'total' => 0,
-    ];
+    /**
+     * @var array
+     */
+    public $errorsList = [];
+
+    /**
+     * @var int
+     */
+    public $total = 0;
 
+    /**
+     * The output interface implementation.
+     *
+     * @var \Illuminate\Console\OutputStyle
+     */
     public $printer;
 
+    /**
+     * @var bool
+     */
     public $logErrors = true;
 
+    /**
+     * @var string[]
+     */
     public $pended = [];
 
+    /**
+     * @var int
+     */
     public $count = 0;
 
+    /**
+     * @var self
+     */
     public static $instance;
 
+    /**
+     * @var string
+     */
     public static $basePath;
 
     /**
@@ -70,7 +96,7 @@ public function print($msg, $path = '   ')
 
     public function printHeader($msg)
     {
-        $number = ++$this->errorsList['total'];
+        $number = ++$this->total;
         ($number < 10) && $number = " $number";
 
         $number = '<fg=cyan>'.$number.' </>';
@@ -121,16 +147,16 @@ public function hasErrors()
     public function logErrors()
     {
         $errList = $this->errorsList;
-        unset($errList['total']);
 
         foreach ($errList as $list) {
             foreach ($list as $error) {
-                if ($error instanceof PendingError) {
-                    $this->printHeader($error->getHeader());
-                    $this->print($error->getErrorData());
-                    $this->printLink($error->getLinkPath(), $error->getLinkLineNumber());
-                    $this->end();
-                }
+                $this->printHeader($error->getHeader());
+                $this->print($error->getErrorData());
+                $this->printLink(
+                    $error->getLinkPath(),
+                    $error->getLinkLineNumber()
+                );
+                $this->end();
             }
         }
 

diff --git a/src/Commands/CheckEvents.php → src/Features/CheckEvents/CheckEvents.php b/src/Commands/CheckEvents.php → src/Features/CheckEvents/CheckEvents.php
@@ -1,10 +1,9 @@
 <?php
 
-namespace Imanghafoori\LaravelMicroscope\Commands;
+namespace Imanghafoori\LaravelMicroscope\Features\CheckEvents;
 
 use Illuminate\Console\Command;
 use Imanghafoori\LaravelMicroscope\ErrorReporters\ErrorPrinter;
-use Imanghafoori\LaravelMicroscope\SpyClasses\SpyDispatcher;
 use Imanghafoori\LaravelMicroscope\Traits\LogsErrors;
 
 class CheckEvents extends Command

diff --git a/src/Features/CheckEvents/Installer.php b/src/Features/CheckEvents/Installer.php
@@ -0,0 +1,21 @@
+<?php
+
+namespace Imanghafoori\LaravelMicroscope\Features\CheckEvents;
+
+use Illuminate\Contracts\Queue\Factory as QueueFactoryContract;
+use Illuminate\Support\Facades\Event;
+
+class Installer
+{
+    public static function spyEvents()
+    {
+        app()->booting(function () {
+            app()->singleton('events', function ($app) {
+                return (new SpyDispatcher($app))->setQueueResolver(function () use ($app) {
+                    return $app->make(QueueFactoryContract::class);
+                });
+            });
+            Event::clearResolvedInstance('events');
+        });
+    }
+}
diff --git a/src/SpyClasses/SpyDispatcher.php → src/Features/CheckEvents/SpyDispatcher.php b/src/SpyClasses/SpyDispatcher.php → src/Features/CheckEvents/SpyDispatcher.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Imanghafoori\LaravelMicroscope\SpyClasses;
+namespace Imanghafoori\LaravelMicroscope\Features\CheckEvents;
 
 use Exception;
 use Illuminate\Events\Dispatcher;

diff --git a/src/Features/CheckImports/CheckImportReporter.php b/src/Features/CheckImports/CheckImportReporter.php
@@ -41,10 +41,10 @@ private static function printFileCounts($foldersStats, $bladeStats, int $countRo
     public static function printErrorsCount()
     {
         $totalErrors = ImportsAnalyzer::$extraCorrectImportsCount + ImportsAnalyzer::$wrongImportsCount + ImportsAnalyzer::$wrongClassRefCount;
-        $output = '<options=bold;fg=yellow>'.ImportsAnalyzer::$checkedRefCount.' refs were checked, '.$totalErrors.' error'.($totalErrors == 1 ? ' ' : 's').' found.</>'.PHP_EOL;
-        $output .= ' - <fg=yellow>'.ImportsAnalyzer::$extraCorrectImportsCount.' unused</> import'.(ImportsAnalyzer::$extraCorrectImportsCount == 1 ? ' ' : 's').' found.'.PHP_EOL;
-        $output .= ' - <fg=red>'.ImportsAnalyzer::$wrongImportsCount.' wrong</> import'.(ImportsAnalyzer::$wrongImportsCount <= 1 ? ' ' : 's').' found.'.PHP_EOL;
-        $output .= ' - <fg=red>'.ImportsAnalyzer::$wrongClassRefCount.' wrong</> class'.(ImportsAnalyzer::$wrongClassRefCount <= 1 ? '' : 'es').' ref found.';
+        $output = '<options=bold;fg=yellow>'.ImportsAnalyzer::$checkedRefCount.' references were checked, '.$totalErrors.' error'.($totalErrors == 1 ? '' : 's').' found.</>'.PHP_EOL;
+        $output .= ' - <fg=yellow>'.ImportsAnalyzer::$extraCorrectImportsCount.' unused</> import'.(ImportsAnalyzer::$extraCorrectImportsCount == 1 ? '' : 's').' found.'.PHP_EOL;
+        $output .= ' - <fg=red>'.ImportsAnalyzer::$wrongImportsCount.' wrong</> import'.(ImportsAnalyzer::$wrongImportsCount <= 1 ? '' : 's').' found.'.PHP_EOL;
+        $output .= ' - <fg=red>'.ImportsAnalyzer::$wrongClassRefCount.' wrong</> class reference'.(ImportsAnalyzer::$wrongClassRefCount <= 1 ? '' : 's').' found.';
 
         return $output;
     }
@@ -112,9 +112,9 @@ public static function totalImportsMsg()
         return '<options=bold;fg=yellow>'.ImportsAnalyzer::$checkedRefCount.' imports were checked under:</>';
     }
 
-    private static function getBladeStats($stats, $checkedFilesCount): string
+    private static function getBladeStats($stats, $filesCount): string
     {
-        $output = self::blue($checkedFilesCount).'blade'.($checkedFilesCount <= 1 ? '' : 's');
+        $output = self::blue($filesCount).'blade'.($filesCount <= 1 ? '' : 's');
         $numPaths = count($stats);
         $output .= self::hyphen();
         $i = 0;
@@ -127,24 +127,24 @@ private static function getBladeStats($stats, $checkedFilesCount): string
         return $output;
     }
 
-    private static function getRouteStats($routeFilesCount)
+    private static function getRouteStats($count)
     {
-        return '   - <fg=blue>'.$routeFilesCount.'</> route'.($routeFilesCount <= 1 ? '' : 's').PHP_EOL;
+        return '   - <fg=blue>'.$count.'</> route'.($count <= 1 ? '' : 's').PHP_EOL;
     }
 
-    private static function getFilesStats($checkedFilesCount)
+    private static function getFilesStats($count)
     {
-        return '   - <fg=blue>'.$checkedFilesCount.'</> class'.($checkedFilesCount <= 1 ? '' : 'es').PHP_EOL;
+        return '   - <fg=blue>'.$count.'</> class'.($count <= 1 ? '' : 'es').PHP_EOL;
     }
 
-    private static function normalize($dir)
+    private static function normalize($dirPath)
     {
-        return FilePath::normalize(str_replace(base_path(), '.', $dir));
+        return FilePath::normalize(str_replace(base_path(), '.', $dirPath));
     }
 
-    private static function green(string $path)
+    private static function green(string $string)
     {
-        return '<fg=green>'.$path.'</>';
+        return '<fg=green>'.$string.'</>';
     }
 
     private static function hyphen()
@@ -159,9 +159,7 @@ private static function files($count)
 
     private static function addLine($path, $count, $i, $numPaths)
     {
-        $output = '';
-        $path = self::normalize($path);
-        $output .= self::green($path);
+        $output = self::green(self::normalize($path));
         $output .= self::files($count);
         if ($i !== $numPaths) {
             $output .= self::hyphen();

diff --git a/src/Features/CheckImports/ExistenceChecker.php b/src/Features/CheckImports/ExistenceChecker.php
@@ -6,9 +6,9 @@
 
 class ExistenceChecker
 {
-    public static function check($class, $absFilePath): bool
+    public static function check($import, $absFilePath): bool
     {
-        if (! self::isAbsent($class) || \function_exists($class)) {
+        if (self::entityExists($import)) {
             return true;
         }
 
@@ -18,15 +18,19 @@ public static function check($class, $absFilePath): bool
             return false;
         }
 
-        if (! self::isAbsent($class) || \function_exists($class)) {
+        if (self::entityExists($import)) {
             return true;
         }
 
         return false;
     }
 
-    private static function isAbsent($class)
+    private static function entityExists($import)
     {
-        return ! class_exists($class) && ! interface_exists($class) && ! trait_exists($class) && ! (function_exists('enum_exists') && enum_exists($class));
+        return class_exists($import) ||
+            interface_exists($import) ||
+            trait_exists($import) ||
+            function_exists($import) ||
+            (function_exists('enum_exists') && enum_exists($import));
     }
 }
diff --git a/src/Features/CheckImports/Handlers/ExtraCorrectImports.php b/src/Features/CheckImports/Handlers/ExtraCorrectImports.php
@@ -6,21 +6,18 @@
 
 class ExtraCorrectImports
 {
-    public static function handle($unusedCorrectImports, $absFilePath)
+    public static function handle($extraCorrectImports, $absFilePath)
     {
-        foreach ($unusedCorrectImports as $class) {
-            self::extraImport($absFilePath, $class[0], $class[1]);
-        }
-    }
+        $printer = ErrorPrinter::singleton();
 
-    public static function extraImport($absPath, $class, $lineNumber)
-    {
-        ErrorPrinter::singleton()->simplePendError(
-            $class,
-            $absPath,
-            $lineNumber,
-            'extraImport',
-            'Extra Import:'
-        );
+        foreach ($extraCorrectImports as [$class, $lineNumber]) {
+            $printer->simplePendError(
+                $class,
+                $absFilePath,
+                $lineNumber,
+                'extraCorrectImport',
+                'Extra Import:'
+            );
+        }
     }
 }
diff --git a/src/Features/CheckImports/Handlers/ExtraWrongImports.php b/src/Features/CheckImports/Handlers/ExtraWrongImports.php
@@ -6,21 +6,18 @@
 
 class ExtraWrongImports
 {
-    public static function handle($unusedWrongImports, $absPath)
+    public static function handle($extraWrongImports, $absPath)
     {
-        foreach ($unusedWrongImports as $class) {
-            self::wrongImport($absPath, $class[0], $class[1]);
-        }
-    }
+        $printer = ErrorPrinter::singleton();
 
-    public static function wrongImport($absPath, $class, $lineNumber)
-    {
-        ErrorPrinter::singleton()->simplePendError(
-            "use $class;",
-            $absPath,
-            $lineNumber,
-            'wrongImport',
-            'Unused & wrong import:'
-        );
+        foreach ($extraWrongImports as [$class, $lineNumber]) {
+            $printer->simplePendError(
+                "use $class;",
+                $absPath,
+                $lineNumber,
+                'extraWrongImport',
+                'Unused & wrong import:'
+            );
+        }
     }
 }
diff --git a/src/Features/CheckImports/Handlers/FixWrongClassRefs.php b/src/Features/CheckImports/Handlers/FixWrongClassRefs.php
@@ -74,13 +74,13 @@ private static function printFixation($absPath, $wrongClass, $lineNumber, $corre
         );
     }
 
-    private static function wrongUsedClassError($absPath, $class, $lineNumber)
+    private static function wrongUsedClassError($absPath, $class, $line)
     {
         ErrorPrinter::singleton()->simplePendError(
             $class,
             $absPath,
-            $lineNumber,
-            'wrongUsedClassError',
+            $line,
+            'wrongClassRef',
             'Class does not exist:'
         );
     }

diff --git a/src/Features/CheckImports/Handlers/PrintWrongClassRefs.php b/src/Features/CheckImports/Handlers/PrintWrongClassRefs.php
@@ -11,15 +11,13 @@ public static function handle(array $wrongClassRefs, $absFilePath)
         $printer = ErrorPrinter::singleton();
 
         foreach ($wrongClassRefs as $classReference) {
-            $wrongClassRef = $classReference['class'];
-            $line = $classReference['line'];
-
-            self::wrongRef($printer, $wrongClassRef, $absFilePath, $line);
+            $printer->simplePendError(
+                $classReference['class'],
+                $absFilePath,
+                $classReference['line'],
+                'wrongClassReference',
+                'Class Reference does not exist:'
+            );
         }
     }
-
-    private static function wrongRef($printer, $wrongClassRef, $absFilePath, $line): void
-    {
-        $printer->simplePendError($wrongClassRef, $absFilePath, $line, 'wrongReference', 'Inline class Ref does not exist:');
-    }
 }
diff --git a/src/Features/CheckRoutes/Installer.php b/src/Features/CheckRoutes/Installer.php
@@ -0,0 +1,17 @@
+<?php
+
+namespace Imanghafoori\LaravelMicroscope\Features\CheckRoutes;
+
+use Illuminate\Support\Facades\Route;
+
+class Installer
+{
+    public static function spyRouter()
+    {
+        $router = new SpyRouter(app('events'), app());
+        app()->singleton('router', function ($app) use ($router) {
+            return $router;
+        });
+        Route::swap($router);
+    }
+}
diff --git a/...ures/RouteOverride/SpyRouteCollection.php → ...atures/CheckRoutes/SpyRouteCollection.php b/...ures/RouteOverride/SpyRouteCollection.php → ...atures/CheckRoutes/SpyRouteCollection.php
@@ -1,8 +1,9 @@
 <?php
 
-namespace Imanghafoori\LaravelMicroscope\Features\RouteOverride;
+namespace Imanghafoori\LaravelMicroscope\Features\CheckRoutes;
 
 use Illuminate\Routing\RouteCollection;
+use Imanghafoori\LaravelMicroscope\Features\RouteOverride\RouteDefinitionConflict;
 
 class SpyRouteCollection extends RouteCollection
 {

diff --git a/src/Features/RouteOverride/SpyRouter.php → src/Features/CheckRoutes/SpyRouter.php b/src/Features/RouteOverride/SpyRouter.php → src/Features/CheckRoutes/SpyRouter.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Imanghafoori\LaravelMicroscope\Features\RouteOverride;
+namespace Imanghafoori\LaravelMicroscope\Features\CheckRoutes;
 
 use Closure;
 use Illuminate\Routing\Router;
@@ -14,7 +14,7 @@ class SpyRouter extends Router
     public $routePaths = [];
 
     /**
-     * @var \Imanghafoori\LaravelMicroscope\Features\RouteOverride\SpyRouteCollection
+     * @var \Imanghafoori\LaravelMicroscope\Features\CheckRoutes\SpyRouteCollection
      */
     private $routesSpy = null;