RequireDevTools::requireDevTools() - Code Metrics - Inspection of "DevTools Require - Validate credentials" - Laravel-Backpack/CRUD - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#3843)

unknown
created 2021-09-28 00:00 UTC
RequireDevTools::requireDevTools() A

↳ Parent: RequireDevTools
Complexity

Conditions	1
Paths	1
Size

Total Lines	7
Code Lines	4
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	4
c	0
b	0
f	0
nc	1
nop	0
dl	0
loc	7
rs	10
<?php

namespace Backpack\CRUD\app\Console\Commands;

use File;
use Illuminate\Console\Command;
use Str;
use Symfony\Component\Process\Process;

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

    protected $progressBar;

    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'backpack:require:devtools
                                {--debug} : Show process output or not. Useful for debugging.';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Require Backpack DevTools on dev.';

    /**
     * Execute the console command.
     *
     * @return mixed Command-line output
     */
    public function handle()
    {
        $this->progressBar = $this->output->createProgressBar(45);
        $this->progressBar->minSecondsBetweenRedraws(0);
        $this->progressBar->maxSecondsBetweenRedraws(120);
        $this->progressBar->setRedrawFrequency(1);
        $this->progressBar->start();

        $this->info(' Requiring DevTools. Please wait...');
        $this->progressBar->advance();

        // Check if repositories exists
        $this->composerRepositories();

        // Check for authentication
        $this->checkForAuthentication();

        // Require DevTools
        $this->requireDevTools();

        // Check if devtools is installed
        $tries = 2;
        while (! file_exists('vendor/backpack/devtools/src/Console/Commands/InstallDevTools.php')) {
            // Abort at nth try
            if (--$tries === 0) {
                return $this->error(' DevTools was not installed.');
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
            }

            // Restart progress bar
            $this->error('Please make sure your access token is correct.');
            $this->progressBar->start();

            // Clear authentication
            if (File::exists('auth.json')) {
                $auth = json_decode(File::get('auth.json'));
                if ($auth->{'http-basic'}->{'backpackforlaravel.com'} ?? false) {
                    unset($auth->{'http-basic'}->{'backpackforlaravel.com'});

                    File::put('auth.json', json_encode($auth, JSON_PRETTY_PRINT));
                }
            }

            // Check for authentication
            $this->checkForAuthentication();

            // Require DevTools
            $this->requireDevTools();
        }

        // Finish
        $this->progressBar->finish();
        $this->info(' DevTools is now required.');

        // DevTools inside installer
        $this->info('');
        $this->info(' Now running the DevTools installation command.');

        // manually include the command in the run-time
        if (! class_exists(\Backpack\DevTools\Console\Commands\InstallDevTools::class)) {
filter:
    dependency_paths: ["lib/*"]
            include base_path('vendor/backpack/devtools/src/Console/Commands/InstallDevTools.php');
        }

        $this->call(\Backpack\DevTools\Console\Commands\InstallDevTools::class);
    }

    public function composerRepositories()
    {
        $details = null;
        $process = new Process(['composer', 'config', 'repositories.backpack/devtools']);
        $process->run(function ($type, $buffer) use (&$details) {
            if ($type !== Process::ERR && $buffer !== '') {
                $details = json_decode($buffer);
            } else {
                $details = json_decode(File::get('composer.json'), true)['repositories']['backpack/devtools'] ?? false;
            }
            $this->progressBar->advance();
        });

        // Create repositories
        if (! $details) {
            $this->info(' Creating repositories entry in composer.json');

            $process = new Process(['composer', 'config', 'repositories.backpack/devtools', 'composer', 'https://repo.backpackforlaravel.com']);
            $process->run(function ($type, $buffer) {
            $process->run(function ($type, /** @scrutinizer ignore-unused */ $buffer) {
                if ($type === Process::ERR) {
                    // Fallback
                    $composerJson = Str::of(File::get('composer.json'));

                    $currentRepositories = json_decode($composerJson, true)['repositories'] ?? false;

                    $repositories = Str::of(json_encode([
                        'repositories' => [
                            'backpack/devtools' => [
                                'type' => 'composer',
                                'url' => 'https://repo.backpackforlaravel.com',
                            ],
                        ],
                    ], JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES));

                    $composerJson = $currentRepositories
                        // Replace current repositories
                        ? preg_replace('/"repositories":\s{\r?\n/', $repositories->match("/\{\n\s+([\s\S]+)\n\s{4}\}/m")->append(",\n"), $composerJson)
                        // Append to the end of the file
                        : preg_replace("/\r?\n}/", $repositories->replaceFirst('{', ','), $composerJson);

                    File::put('composer.json', $composerJson);
                }
                $this->progressBar->advance();
            });
        }
    }

    public function checkForAuthentication()
    {
        // Check if auth exists
        $details = null;
        $process = new Process(['composer', 'config', 'http-basic.backpackforlaravel.com']);
        $process->run(function ($type, $buffer) use (&$details) {
            if ($type !== Process::ERR && $buffer !== '') {
                $details = json_decode($buffer);
            } elseif (File::exists('auth.json')) {
                $details = json_decode(File::get('auth.json'), true)['http-basic']['backpackforlaravel.com'] ?? false;
            }
            $this->progressBar->advance();
        });

        // Create an auth.json file
        if (! $details) {
            $this->info(' Creating auth.json file with your authentication token');

            $this->line(' (Find your access token details on https://backpackforlaravel.com/user/tokens)');
            $username = $this->ask('Access token username');
            $password = $this->ask('Access token password');

            $process = new Process(['composer', 'config', 'http-basic.backpackforlaravel.com', $username, $password]);
            $process->run(function ($type, $buffer) use ($username, $password) {
            $process->run(function ($type, /** @scrutinizer ignore-unused */ $buffer) use ($username, $password) {
                if ($type === Process::ERR) {
                    // Fallback
                    $authFile = [
                        'http-basic' => [
                            'backpackforlaravel.com' => [
                                'username' => $username,
                                'password' => $password,
                            ],
                        ],
                    ];

                    if (File::exists('auth.json')) {
                        $currentFile = json_decode(File::get('auth.json'), true);
                        if (! ($currentFile['http-basic']['backpackforlaravel.com'] ?? false)) {
                            $authFile = array_merge_recursive($authFile, $currentFile);
                        }
                    }

                    File::put('auth.json', json_encode($authFile, JSON_PRETTY_PRINT));
                }

                $this->progressBar->advance();
            });
        }
    }

    public function requireDevTools()
    {
        // Require package
        $process = new Process(['composer', 'require', '--dev', '--with-all-dependencies', 'backpack/devtools']);
        $process->setTimeout(300);
        $process->run(function ($type, $buffer) {
        $process->run(function ($type, /** @scrutinizer ignore-unused */ $buffer) {
            $this->progressBar->advance();
        });
    }
}

Laravel-Backpack / CRUD

Scrutinizer GitHub App not installed

Pull Request — master (#3843)

RequireDevTools::requireDevTools() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
