Imanghafoori\LaravelMicroscope\Checks\ActionsComments

Complexity

Total Complexity

18

Size/Duplication

Total Lines	111
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	check()	0	4	1
B	checkActions()	0	44	8
B	getMsg()	0	32	6
A	getCallsiteInfo()	0	9	1
A	checkControllerActionsForRoutes()	0	13	2

<?php

namespace Imanghafoori\LaravelMicroscope\Checks;

use Imanghafoori\LaravelMicroscope\Analyzers\ClassMethods;
use Imanghafoori\LaravelMicroscope\Analyzers\Refactor;

class ActionsComments
{
    public static $command;

    public static function check($tokens, $absFilePath, $classFilePath, $psr4Path, $psr4Namespace)

The parameter $absFilePath is not used and could be removed.

    {
        self::checkControllerActionsForRoutes($classFilePath, $psr4Path, $psr4Namespace, $tokens);
    }

    public static function checkControllerActionsForRoutes($classFilePath, $psr4Path, $psr4Namespace, $tokens)
    {
//        $errorPrinter = resolve(ErrorPrinter::class);
        $fullNamespace = RoutelessActions::getFullNamespace($classFilePath, $psr4Path, $psr4Namespace);

        if (RoutelessActions::isLaravelController($fullNamespace)) {
            $actions = self::checkActions($tokens, $fullNamespace, $classFilePath);

$actions is not used, you could remove the assignment.

            /*foreach ($actions as $action) {
                $errorPrinter->routelessAction($absFilePath, $action[0], $action[1]);
            }*/
        }
    }

    protected static function checkActions($tokens, $fullNamespace, $path)
    {
        $class = ClassMethods::read($tokens);

        $methods = RoutelessActions::getControllerActions($class['methods']);
        $routelessActions = [];
        $shouldSave = false;

        foreach ($methods as $method) {
            $classAtMethod = RoutelessActions::classAtMethod($fullNamespace, $method['name'][1]);

            if (! ($route = app('router')->getRoutes()->getByAction($classAtMethod))) {
                continue;
            }

            /**
             * @var $route \Illuminate\Routing\Route
             */
            $methods = $route->methods();
            ($methods == ['GET', 'HEAD']) && $methods = ['GET'];
            $msg = self::getMsg($methods, $route);

            $commentIndex = $method['startBodyIndex'][0] + 1;

            if (T_DOC_COMMENT !== $tokens[$commentIndex + 1][0]) {
                $shouldSave = true;
                $tokens[$commentIndex][1] = "\n        ".$msg.$tokens[$commentIndex][1];
            } elseif ($msg !== $tokens[$commentIndex + 1][1]) {
                // if the docblock is there, but needs update...
                $shouldSave = true;
                $tokens[$commentIndex + 1][1] = $msg;
            }

            $line = $method['name'][2];
            $routelessActions[] = [$line, $classAtMethod];
        }

        $question = 'Do you want to add route definition to: '.$fullNamespace;
        if ($shouldSave && (self::$command)->confirm($question, true)) {
            Refactor::saveTokens($path->getRealpath(), $tokens);
        }

        return $routelessActions;
    }

    protected static function getMsg($methods, $route)
    {
        $msg = '/**'."\n";
        $prefix = '         * ';

        [$file, $line] = self::getCallsiteInfo($methods[0], $route);

The variable $file does not exist. Did you forget to declare it?

The variable $line does not exist. Did you forget to declare it?

        if ($file) {
            $msg .= $prefix.'@at('.$file.':'.$line.')';
        }

        $nameBlock = $prefix."@name('".($route->getName() ?: '')."')";
        $msg .= "\n".$prefix;
        if (\count($methods) > 1) {
            $msg .= '@methods('.\implode(', ', $methods).')'."\n".$prefix.'@uri(\'/'.$route->uri().'\')'."\n".$nameBlock;
        } else {
            $msg .= '@'.strtolower(\implode('', $methods)).'(\'/'.$route->uri().'\')'."\n".$nameBlock;
        }

        $middlewares = $route->gatherMiddleware();

        foreach ($middlewares as $i => $m) {
            if (! is_string($m)) {
                $middlewares[$i] = 'Closure';
            }
        }
        $msg .= "\n".$prefix.'@middlewares('.\implode(', ', $middlewares).')';

        $msg .= "\n         */";

        return $msg;
    }

    public static function getCallsiteInfo($methods, $route)
    {
        $callsite = app('router')->getRoutes()->routesInfo[$methods][$route->uri()] ?? [];
        $file = $callsite[0]['file'] ?? '';
        $line = $callsite[0]['line'] ?? '';
        $file = \trim(str_replace(base_path(), '', $file), '\\/');

        return [$file, $line];
    }
}