AddCustomRouteContent::handle() - Code Metrics - Inspection of "Merge pull request #5565 from Laravel-Backpack/mat..." - Laravel-Backpack/CRUD - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — main ( ab55e9...10635f )

by Pedro
created 2024-07-29 09:34 UTC
AddCustomRouteContent::handle() C

↳ Parent: AddCustomRouteContent
Complexity

Conditions	12
Paths	38
Size

Total Lines	99
Code Lines	46
Duplication

Lines	0
Ratio	0 %
Importance

Changes	7
Bugs	7	Features	0
Metric	Value
cc	12
eloc	46
c	7
b	7
f	0
nc	38
nop	0
dl	0
loc	99
rs	6.9666
How to fix Long Method Complexity

<?php

namespace Backpack\CRUD\app\Console\Commands;

use Illuminate\Console\Command;

class AddCustomRouteContent extends Command
{
    use \Backpack\CRUD\app\Console\Commands\Traits\PrettyCommandOutput;


    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'backpack:add-custom-route
                                {code : HTML/PHP code that registers a route. Use either single quotes or double quotes. Never both. }
                                {--route-file=routes/backpack/custom.php : The file where the code should be added relative to the root of the project. }';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Add HTML/PHP code to the routes/backpack/custom.php file';

    /**
     * Create a new command instance.
     *
     * @return void
     */
    public function __construct()
    {
        parent::__construct();
    }

    /**
     * Execute the console command.
     *
     * @return mixed
     */
    public function handle()
    {
        $routeFilePath = base_path($this->option('route-file'));

        if (! file_exists($routeFilePath)) {
            if ($routeFilePath !== base_path($this->backpackCustomRouteFile)) {

                $this->info('The route file <fg=blue>'.$routeFilePath.'</> does not exist. Please create it first.');

                return 1;
            }

            $createRouteFile = $this->confirm('The route file <fg=blue>'.$routeFilePath.'</> does not exist. Should we create it?', 'yes');
            $createRouteFile = $this->confirm('The route file <fg=blue>'.$routeFilePath.'</> does not exist. Should we create it?', /** @scrutinizer ignore-type */ 'yes');
            if ($createRouteFile === 'yes') {

                $this->call('vendor:publish', ['--provider' => \Backpack\CRUD\BackpackServiceProvider::class, '--tag' => 'custom_routes']);
            } else {
                $this->info('The route file <fg=blue>'.$routeFilePath.'</> does not exist. Please create it first.');

                return 1;
            }
        }

        $code = $this->argument('code');

        $this->progressBlock("Adding route to <fg=blue>$routeFilePath</>");

        $originalContent = file($routeFilePath);

        // clean the content from comments etc
        $cleanContent = $this->cleanContentArray($originalContent);

        // if the content contains code, don't add it again.
        if (array_search($code, $cleanContent, true) !== false) {
            $this->closeProgressBlock('Already existed', 'yellow');

            return;
        }

        // get the last element of the array contains '}'
        $lastLine = $this->getLastLineNumberThatContains('}', $cleanContent);

        if ($lastLine === false) {

            $this->closeProgressBlock('Could not find the last line, file '.$routeFilePath.' may be corrupted.', 'red');

            return;
        }

        // in case the last line contains the last } but also the last {, we need to split them
        // so that we can create a space between them and add the new code
        if (strpos($cleanContent[$lastLine], '{') !== false) {
            $lastLineContent = explode('{', $originalContent[$lastLine]);
            $originalContent[$lastLine] = $lastLineContent[0].'{'.PHP_EOL;
            // push all other elements one line down creating space for the new code
            for ($i = count($originalContent) - 1; $i > $lastLine; $i--) {
                $originalContent[$i + 1] = $originalContent[$i];
            }
            $originalContent[$lastLine + 1] = $lastLineContent[1];
            $lastLine++;
        }

        // in case the last line contains more than one ";" it means that line closes more than one group
        // we need to split the line and create space for the new code
        if (substr_count($cleanContent[$lastLine], ';') > 1) {
            $lastLineContent = explode(';', $originalContent[$lastLine]);

            // find in lastLineContent array the last element that contains the }
            $lastElement = $this->getLastLineNumberThatContains('}', $lastLineContent);

            // merge the first part of the lastLineContent up to the lastElement
            $originalContent[$lastLine] = implode(';', array_slice($lastLineContent, 0, $lastElement)).';'.PHP_EOL;

            // push all other elements one line down creating space for the new code
            for ($i = count($originalContent) - 1; $i > $lastLine; $i--) {
                $originalContent[$i + 1] = $originalContent[$i];
            }

            // merge the second part of the lastLineContent starting from the lastElement
            $originalContent[$lastLine + 1] = implode(';', array_slice($lastLineContent, $lastElement));
            $lastLine++;
        }

        $sliceLength = 0;

        // in case there is already an empty line at the end of the route file, we don't need to add another one
        if (trim($originalContent[$lastLine - 1]) === '') {
            $lastLine--;
            $sliceLength = 1;
        }

        // add the code to the line before the last line
        array_splice($originalContent, $lastLine, $sliceLength, '    '.$code.PHP_EOL);

        // write the new content to the file
        if (file_put_contents($routeFilePath, implode('', $originalContent)) === false) {
            $this->closeProgressBlock('Failed to add route. Failed writing the modified route file. Maybe check file permissions?', 'red');

            return;
        }

        $this->closeProgressBlock('done', 'green');
    }

    private function cleanContentArray(array $content)
    {
        return array_filter(array_map(function ($line) {
            $lineText = trim($line);
            if ($lineText === '' ||
                $lineText === '\n' ||
                $lineText === '\r' ||
                $lineText === '\r\n' ||
                $lineText === PHP_EOL ||
                str_starts_with($lineText, '<?php') ||
                str_starts_with($lineText, '?>') ||
                str_starts_with($lineText, '//') ||
                str_starts_with($lineText, '/*') ||
                str_starts_with($lineText, '*/') ||
                str_ends_with($lineText, '*/') ||
                str_starts_with($lineText, '*') ||
                str_starts_with($lineText, 'use ') ||
                str_starts_with($lineText, 'return ') ||
                str_starts_with($lineText, 'namespace ')) {
                return null;
            }

            return $lineText;
        }, $content));
    }

    /**
     * Parse the given file stream and return the line number where a string is found.
     *
     * @param  string  $needle  The string that's being searched for.
     * @param  array  $haystack  The file where the search is being performed.
     * @return bool|int The last line number where the string was found. Or false.
     */
    private function getLastLineNumberThatContains($needle, $haystack)
    {
        $matchingLines = array_filter($haystack, function ($k) use ($needle) {
            return strpos($k, $needle) !== false;
        });

        if ($matchingLines) {

            return array_key_last($matchingLines);

        }

        return false;
    }
}

Laravel-Backpack / CRUD

Scrutinizer GitHub App not installed

Push — main ( ab55e9...10635f )

AddCustomRouteContent::handle() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like
