Command::setHelp() - Code Metrics - Inspection of "docs: add docs/commands.md generated by _docs comm..." - popstas/transmission-cli - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2515f9...556e6f )

by Stanislav

created 2016-03-07 15:21 UTC

Command::setHelp() A

↳ Parent: Command

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	9
rs	9.6666
cc	1
eloc	7
nc	1
nop	1

<?php

namespace Popstas\Transmission\Console\Command;

use GuzzleHttp;
use InfluxDB;
use Martial\Transmission\API;
use Popstas\Transmission\Console;
use Popstas\Transmission\Console\Application;
use Popstas\Transmission\Console\Config;
use Popstas\Transmission\Console\TransmissionClient;
use Psr\Log\LogLevel;
use Symfony\Component\Console\Command\Command as BaseCommand;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Logger\ConsoleLogger;
use Symfony\Component\Console\Output\OutputInterface;

class Command extends BaseCommand
{
    private $help;


    protected function configure()
    {
        $this->addOption('dry-run', null, InputOption::VALUE_NONE, 'Dry run, don\'t change any data');
        $this->addOption('config', null, InputOption::VALUE_OPTIONAL, 'Configuration file');
        $this->addOption('transmission-host', null, InputOption::VALUE_OPTIONAL, 'Transmission host');
        $this->addOption('transmission-port', null, InputOption::VALUE_OPTIONAL, 'Transmission port');
        $this->addOption('transmission-user', null, InputOption::VALUE_OPTIONAL, 'Transmission user');
        $this->addOption('transmission-password', null, InputOption::VALUE_OPTIONAL, 'Transmission password');
    }

    /**
     * @return Application
     */
    public function getApplication()
    {
        return parent::getApplication();
    }

    protected function initialize(InputInterface $input, OutputInterface $output)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        // logger
        $logger = $this->getApplication()->getLogger();
        if (!isset($logger)) {
            $verbosityLevelMap = [
                LogLevel::NOTICE => OutputInterface::VERBOSITY_NORMAL,
                LogLevel::INFO   => OutputInterface::VERBOSITY_VERBOSE,
                LogLevel::DEBUG  => OutputInterface::VERBOSITY_DEBUG,
            ];
            $logger = new ConsoleLogger($output, $verbosityLevelMap);
            $this->getApplication()->setLogger($logger);
        }

        // config
        $config = $this->getApplication()->getConfig();
        if (!isset($config)) {
            $config = new Config($input->getOption('config'));
            try {
                $config->loadConfigFile();
            } catch (\RuntimeException $e) {
                $logger->critical($e->getMessage());
                $this->setCode(function () {
                    return 1;
                });
                return;
            }
            $this->getApplication()->setConfig($config);
        }

        // client
        $client = $this->getApplication()->getClient();
        if (!isset($client)) {
            $client = $this->createTransmissionClient(
                $config->overrideConfig($input, 'transmission-host'),
                $config->overrideConfig($input, 'transmission-port'),
                $config->overrideConfig($input, 'transmission-user'),
                $config->overrideConfig($input, 'transmission-password')
            );
            $this->getApplication()->setClient($client);
        }

        $logger->info('[{date}] command: {args}', [
            'date' => date('Y-m-d H:i:s'),
            'args' => implode(' ', array_slice($_SERVER['argv'], 1)),
        ]);

        parent::initialize($input, $output);
    }

    private function createTransmissionClient($host, $port, $user, $password)
    {
        $logger = $this->getApplication()->getLogger();

        $connect = ['host' => $host, 'port' => $port, 'user' => $user, 'password' => $password];

        $baseUri = 'http://' . $connect['host'] . ':' . $connect['port'] . '/transmission/rpc';
        $httpClient = new GuzzleHttp\Client(['base_uri' => $baseUri]);

        $api = new API\RpcClient($httpClient, $connect['user'], $connect['password']);
        $api->setLogger($logger);

        $logger->debug('Connect Transmission using: {user}:{password}@{host}:{port}', $connect);

        return new TransmissionClient($api);
    }

    public function dryRun(
        InputInterface $input,
        OutputInterface $output,
        \Closure $callback,
        $message = 'dry-run, don\'t doing anything'
    ) {
        if (!$input->getOption('dry-run')) {
            return $callback();
        } else {
            $output->writeln($message);
            return true;
        }
    }

    public function setHelp($help)
    {
        $this->help = $help;
        $help = preg_replace('/```\n(.*?)\n```/mis', '<info>$1</info>', $help);
        $help = preg_replace('/(\n|^)#+ (.*)/', '$1<question>$2</question>', $help);
        $help = preg_replace('/`([^`]*?)`/', '<comment>$1</comment>', $help);
        $help = preg_replace('/\*\*(.*?)\*\*/', '<comment>$1</comment>', $help);
        return parent::setHelp($help);
    }
    
    public function getRawHelp()
    {
        return $this->help;
    }
}


1			<?php
2
3			namespace Popstas\Transmission\Console\Command;
4
5			use GuzzleHttp;
6			use InfluxDB;
7			use Martial\Transmission\API;
8			use Popstas\Transmission\Console;
9			use Popstas\Transmission\Console\Application;
10			use Popstas\Transmission\Console\Config;
11			use Popstas\Transmission\Console\TransmissionClient;
12			use Psr\Log\LogLevel;
13			use Symfony\Component\Console\Command\Command as BaseCommand;
14			use Symfony\Component\Console\Input\InputInterface;
15			use Symfony\Component\Console\Input\InputOption;
16			use Symfony\Component\Console\Logger\ConsoleLogger;
17			use Symfony\Component\Console\Output\OutputInterface;
18
19			class Command extends BaseCommand
20			{
21			private $help;
			0 ignored issues – show Comprehensibility introduced 2016-03-07 15:24 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history...
22
23			protected function configure()
24			{
25			$this->addOption('dry-run', null, InputOption::VALUE_NONE, 'Dry run, don\'t change any data');
26			$this->addOption('config', null, InputOption::VALUE_OPTIONAL, 'Configuration file');
27			$this->addOption('transmission-host', null, InputOption::VALUE_OPTIONAL, 'Transmission host');
28			$this->addOption('transmission-port', null, InputOption::VALUE_OPTIONAL, 'Transmission port');
29			$this->addOption('transmission-user', null, InputOption::VALUE_OPTIONAL, 'Transmission user');
30			$this->addOption('transmission-password', null, InputOption::VALUE_OPTIONAL, 'Transmission password');
31			}
32
33			/**
34			* @return Application
35			*/
36			public function getApplication()
37			{
38			return parent::getApplication();
39			}
40
41			protected function initialize(InputInterface $input, OutputInterface $output)
			0 ignored issues – show Coding Style introduced 2016-02-28 05:20 UTC by Report Bug Copy Issue Report `initialize` uses the super-global variable `$_SERVER` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
42			{
43			// logger
44			$logger = $this->getApplication()->getLogger();
45			if (!isset($logger)) {
46			$verbosityLevelMap = [
47			LogLevel::NOTICE => OutputInterface::VERBOSITY_NORMAL,
48			LogLevel::INFO => OutputInterface::VERBOSITY_VERBOSE,
49			LogLevel::DEBUG => OutputInterface::VERBOSITY_DEBUG,
50			];
51			$logger = new ConsoleLogger($output, $verbosityLevelMap);
52			$this->getApplication()->setLogger($logger);
53			}
54
55			// config
56			$config = $this->getApplication()->getConfig();
57			if (!isset($config)) {
58			$config = new Config($input->getOption('config'));
59			try {
60			$config->loadConfigFile();
61			} catch (\RuntimeException $e) {
62			$logger->critical($e->getMessage());
63			$this->setCode(function () {
64			return 1;
65			});
66			return;
67			}
68			$this->getApplication()->setConfig($config);
69			}
70
71			// client
72			$client = $this->getApplication()->getClient();
73			if (!isset($client)) {
74			$client = $this->createTransmissionClient(
75			$config->overrideConfig($input, 'transmission-host'),
76			$config->overrideConfig($input, 'transmission-port'),
77			$config->overrideConfig($input, 'transmission-user'),
78			$config->overrideConfig($input, 'transmission-password')
79			);
80			$this->getApplication()->setClient($client);
81			}
82
83			$logger->info('[{date}] command: {args}', [
84			'date' => date('Y-m-d H:i:s'),
85			'args' => implode(' ', array_slice($_SERVER['argv'], 1)),
86			]);
87
88			parent::initialize($input, $output);
89			}
90
91			private function createTransmissionClient($host, $port, $user, $password)
92			{
93			$logger = $this->getApplication()->getLogger();
94
95			$connect = ['host' => $host, 'port' => $port, 'user' => $user, 'password' => $password];
96
97			$baseUri = 'http://' . $connect['host'] . ':' . $connect['port'] . '/transmission/rpc';
98			$httpClient = new GuzzleHttp\Client(['base_uri' => $baseUri]);
99
100			$api = new API\RpcClient($httpClient, $connect['user'], $connect['password']);
101			$api->setLogger($logger);
102
103			$logger->debug('Connect Transmission using: {user}:{password}@{host}:{port}', $connect);
104
105			return new TransmissionClient($api);
106			}
107
108			public function dryRun(
109			InputInterface $input,
110			OutputInterface $output,
111			\Closure $callback,
112			$message = 'dry-run, don\'t doing anything'
113			) {
114			if (!$input->getOption('dry-run')) {
115			return $callback();
116			} else {
117			$output->writeln($message);
118			return true;
119			}
120			}
121
122			public function setHelp($help)
123			{
124			$this->help = $help;
125			$help = preg_replace('/```\n(.*?)\n```/mis', '<info>$1</info>', $help);
126			$help = preg_replace('/(\n\|^)#+ (.*)/', '$1<question>$2</question>', $help);
127			$help = preg_replace('/`([^`]*?)`/', '<comment>$1</comment>', $help);
128			$help = preg_replace('/\\(.?)\\*/', '<comment>$1</comment>', $help);
129			return parent::setHelp($help);
130			}
131
132			public function getRawHelp()
133			{
134			return $this->help;
135			}
136			}
137

popstas / transmission-cli

Push — master ( 2515f9...556e6f )

Command::setHelp() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like