TailCommand::getEnvironmentConfiguration() - Code Metrics - Inspection of "Merge pull request #53 from spatie/v4" - spatie/laravel-tail - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9e2d47...99c276 )

by Freek

created 2020-02-14 17:18 UTC

TailCommand::getEnvironmentConfiguration() A

↳ Parent: TailCommand

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	10
rs	9.9332
c	0
b	0
f	0
cc	2
nc	2
nop	1

<?php

namespace Spatie\Tail;

use Exception;
use Illuminate\Console\Command;
use Spatie\Ssh\Ssh;
use Symfony\Component\Process\Process;

class TailCommand extends Command
{
    protected $signature = 'tail {environment?}
                            {--lines=0 : Output the last number of lines}
                            {--clear : Clear the terminal screen}';

    protected $description = 'Tail the latest logfile';

    public function handle()
    {
        $this->handleClearOption();

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

        is_null($environment)
            ? $this->tailLocally()
            : $this->tailRemotely($environment);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
    }

    protected function handleClearOption()
    {
        if (! $this->option('clear')) {
            return;
        }

        $this->output->write(sprintf("\033\143\e[3J"));
    }

    protected function tailLocally(): void
    {
        $logDirectory = storage_path('logs');

        Process::fromShellCommandline($this->getTailCommand(), $logDirectory)
            ->setTty(true)
            ->setTimeout(null)
            ->run(function ($type, $line) {
                $this->handleClearOption();

                $this->output->write($line);
            });
    }

    protected function tailRemotely(string $environment): void
    {
        $environmentConfig = $this->getEnvironmentConfiguration($environment);

        Ssh::create($environmentConfig['user'], $environmentConfig['host'])
            ->configureProcess(function (Process $process) {
                $process->setTty(true);
            })
            ->onOutput(function ($type, $line) {
                $this->handleClearOption();

                $this->output->write($line);
            })
            ->execute([
                "cd {$environmentConfig['log_directory']}",
                $this->getTailCommand($environmentConfig['log_directory']),

            ]);
    }

    protected function getEnvironmentConfiguration(string $environment): array
    {
        $config = config('tail');

        if (! isset($config[$environment])) {
            throw new Exception("No configuration set for environment `{$environment}`. Make sure this environment is specified in the `tail` config file!");
        }

        return $config[$environment];
    }

    public function getTailCommand(): string
    {
        return 'tail -f -n '.$this->option('lines').' "`ls -t | head -1`"';
    }
}


1			<?php
2
3			namespace Spatie\Tail;
4
5			use Exception;
6			use Illuminate\Console\Command;
7			use Spatie\Ssh\Ssh;
8			use Symfony\Component\Process\Process;
9
10			class TailCommand extends Command
11			{
12			protected $signature = 'tail {environment?}
13			{--lines=0 : Output the last number of lines}
14			{--clear : Clear the terminal screen}';
15
16			protected $description = 'Tail the latest logfile';
17
18			public function handle()
19			{
20			$this->handleClearOption();
21
22			$environment = $this->argument('environment');
23
24			is_null($environment)
25			? $this->tailLocally()
26			: $this->tailRemotely($environment);
			0 ignored issues – show Bug introduced 2020-02-14 17:31 UTC by Report Bug Copy Issue Report It seems like `$environment` defined by `$this->argument('environment')` on line `22` can also be of type `array`; however, `Spatie\Tail\TailCommand::tailRemotely()` does only seem to accept `string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
27			}
28
29			protected function handleClearOption()
30			{
31			if (! $this->option('clear')) {
32			return;
33			}
34
35			$this->output->write(sprintf("\033\143\e[3J"));
36			}
37
38			protected function tailLocally(): void
39			{
40			$logDirectory = storage_path('logs');
41
42			Process::fromShellCommandline($this->getTailCommand(), $logDirectory)
43			->setTty(true)
44			->setTimeout(null)
45			->run(function ($type, $line) {
46			$this->handleClearOption();
47
48			$this->output->write($line);
49			});
50			}
51
52			protected function tailRemotely(string $environment): void
53			{
54			$environmentConfig = $this->getEnvironmentConfiguration($environment);
55
56			Ssh::create($environmentConfig['user'], $environmentConfig['host'])
57			->configureProcess(function (Process $process) {
58			$process->setTty(true);
59			})
60			->onOutput(function ($type, $line) {
61			$this->handleClearOption();
62
63			$this->output->write($line);
64			})
65			->execute([
66			"cd {$environmentConfig['log_directory']}",
67			$this->getTailCommand($environmentConfig['log_directory']),
			0 ignored issues – show Unused Code introduced 2020-02-14 17:31 UTC by Report Bug Copy Issue Report The call to `TailCommand::getTailCommand()` has too many arguments starting with `$environmentConfig['log_directory']`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
68			]);
69			}
70
71			protected function getEnvironmentConfiguration(string $environment): array
72			{
73			$config = config('tail');
74
75			if (! isset($config[$environment])) {
76			throw new Exception("No configuration set for environment `{$environment}`. Make sure this environment is specified in the `tail` config file!");
77			}
78
79			return $config[$environment];
80			}
81
82			public function getTailCommand(): string
83			{
84			return 'tail -f -n '.$this->option('lines').' "`ls -t \| head -1`"';
85			}
86			}
87

spatie / laravel-tail

GitHub Access Token became invalid

Push — master ( 9e2d47...99c276 )

TailCommand::getEnvironmentConfiguration() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like