ApiListCommand - Code Metrics - Inspection of "Transformed api-list caching system" - PCextreme/cloudstack-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#28)

by Jesse

created 2018-10-24 18:46 UTC

ApiListCommand A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	189
Duplicated Lines	19.05 %

Coupling/Cohesion

Components	2
Dependencies	6

Importance

Changes

Metric	Value
wmc	15
lcom	2
cbo	6
dl	36
loc	189
rs	10
c	0
b	0
f	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	configure()	0	6	1
A	execute()	0	33	2
A	askUrlApi()	0	9	1
A	askApiKey()	14	14	2
A	askSecretKey()	14	14	2
A	processList()	0	21	3
A	parseCommand()	0	20	2
A	cache()	8	8	2

How to fix Duplicated Code

<?php

declare(strict_types=1);

namespace PCextreme\Cloudstack\Console;

use PCextreme\Cloudstack\Client;
use Symfony\Component\Cache\Simple\FilesystemCache;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Helper\ProgressBar;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Question\Question;

class ApiListCommand extends Command
{
    /**
     * @var FilesystemCache
     */
    private $cache;

    /**
     * Configures the current command.
     *
     * @return void
     */
    protected function configure()
    {
        $this->setName('api:list')
            ->setDescription('Generate API list cache.')
            ->setHelp("This will generate the API list cache file usign the 'listApis' command.");
    }

    /**
     * Executes the current command.
     *
     * @param  InputInterface  $input
     * @param  OutputInterface $output
     * @return void
     */
    protected function execute(InputInterface $input, OutputInterface $output) : void
    {
        $urlApi    = $this->askUrlApi($input, $output);
        $apiKey    = $this->askApiKey($input, $output);
        $secretKey = $this->askSecretKey($input, $output);

        $output->writeLn('');
        $output->writeLn("<info>Processing API list. Please Wait...</info>");

        $client = new Client([
            'urlApi'    => $urlApi,
            'apiKey'    => $apiKey,
            'secretKey' => $secretKey,
        ]);

        $command = 'listApis';
        $method  = $client->getCommandMethod($command);
        $url     = $client->getCommandUrl($command, []);
        $request = $client->getRequest($method, $url, []);

        $list = $client->getResponse($request);

        // We expect an array from the getResponse method, when this returns
        // with a string we most likely got a server error.
        if (is_string($list)) {
            throw new \RuntimeException(sprintf(
                "Invalid API response, received: %s",
                $list
            ));
        }

        $this->processList($output, $list);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

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

    /**
     * Ask for URL API.
     *
     * @param  InputInterface  $input
     * @param  OutputInterface $output
     * @return string
     */
    protected function askUrlApi(InputInterface $input, OutputInterface $output) : string
    {
        $question = new Question(
            'Enter target API url [default: https://api.auroracompute.eu/ams]: ',
            'https://api.auroracompute.eu/ams'
        );

        return $this->getHelper('question')->ask($input, $output, $question);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /**
     * Ask for API key.
     *
     * @param  InputInterface  $input
     * @param  OutputInterface $output
     * @return string
     */
    protected function askApiKey(InputInterface $input, OutputInterface $output) : string

    {
        $question = (new Question('Enter API key: '))
            ->setValidator(function ($answer) {
                if (is_null($answer)) {
                    throw new \InvalidArgumentException("API key can't be null.");
                }

                return $answer;
            })
            ->setMaxAttempts(2);

        return $this->getHelper('question')->ask($input, $output, $question);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /**
     * Ask for secret key.
     *
     * @param  InputInterface  $input
     * @param  OutputInterface $output
     * @return string
     */
    protected function askSecretKey(InputInterface $input, OutputInterface $output) : string

    {
        $question = (new Question('Enter secret key: '))
            ->setValidator(function ($answer) {
                if (is_null($answer)) {
                    throw new \InvalidArgumentException("Secret key can't be null.");
                }

                return $answer;
            })
            ->setMaxAttempts(2);

        return $this->getHelper('question')->ask($input, $output, $question);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /**
     * Dump cache file of APIs list.
     *
     * @param  OutputInterface $output
     * @param  array           $list
     * @return void
     */
    protected function processList(OutputInterface $output, array $list = []) : void
    {
        if (empty($list)) {
            throw new \RuntimeException("API list is empty.");
        }

        $progress = new ProgressBar($output, $list['listapisresponse']['count']);
        $progress->start();

        $commands = [];

        foreach ($list['listapisresponse']['api'] as $api) {
            $commands = array_merge($commands, $this->parseCommand($api));

            $progress->advance();
        }

        $this->cache()->set('api.list', $commands);

        $progress->finish();
    }

    /**
     * Parse command data into expected structure
     * @param  array $command
     * @return array
     */
    protected function parseCommand(array $command) : array
    {
        $params = [];

        foreach ($command['params'] as $param) {
            $params = array_merge($params, [
                $param['name'] => [
                    'description' => $param['description'],
                    'required' => $param['required'],
                    'type' => $param['type'],
                ]
            ]);
        }

        return [$command['name'] => [
            'description' => $command['description'],
            'isasync'     => $command['isasync'],
            'params'      => $params
        ]];
    }

    /**
     * Get cache driver instance
     * @return FilesystemCache
     */
    private function cache() : FilesystemCache

    {
        if (! isset($this->cache)) {
            $this->cache = new FilesystemCache('', 0, __DIR__.'/../../cache');
        }

        return $this->cache;
    }
}


Pull Request — master (#28)

ApiListCommand A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

8 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Available Fixes

Available Fixes

1		<?php
2
3		declare(strict_types=1);
4
5		namespace PCextreme\Cloudstack\Console;
6
7		use PCextreme\Cloudstack\Client;
8		use Symfony\Component\Cache\Simple\FilesystemCache;
9		use Symfony\Component\Console\Command\Command;
10		use Symfony\Component\Console\Helper\ProgressBar;
11		use Symfony\Component\Console\Input\InputInterface;
12		use Symfony\Component\Console\Output\OutputInterface;
13		use Symfony\Component\Console\Question\Question;
14
15		class ApiListCommand extends Command
16		{
17		/**
18		* @var FilesystemCache
19		*/
20		private $cache;
21
22		/**
23		* Configures the current command.
24		*
25		* @return void
26		*/
27		protected function configure()
28		{
29		$this->setName('api:list')
30		->setDescription('Generate API list cache.')
31		->setHelp("This will generate the API list cache file usign the 'listApis' command.");
32		}
33
34		/**
35		* Executes the current command.
36		*
37		* @param InputInterface $input
38		* @param OutputInterface $output
39		* @return void
40		*/
41		protected function execute(InputInterface $input, OutputInterface $output) : void
42		{
43		$urlApi = $this->askUrlApi($input, $output);
44		$apiKey = $this->askApiKey($input, $output);
45		$secretKey = $this->askSecretKey($input, $output);
46
47		$output->writeLn('');
48		$output->writeLn("<info>Processing API list. Please Wait...</info>");
49
50		$client = new Client([
51		'urlApi' => $urlApi,
52		'apiKey' => $apiKey,
53		'secretKey' => $secretKey,
54		]);
55
56		$command = 'listApis';
57		$method = $client->getCommandMethod($command);
58		$url = $client->getCommandUrl($command, []);
59		$request = $client->getRequest($method, $url, []);
60
61		$list = $client->getResponse($request);
62
63		// We expect an array from the getResponse method, when this returns
64		// with a string we most likely got a server error.
65		if (is_string($list)) {
66		throw new \RuntimeException(sprintf(
67		"Invalid API response, received: %s",
68		$list
69		));
70		}
71
72		$this->processList($output, $list);
		0 ignored issues – show Bug introduced 2018-10-22 20:39 UTC by Report Bug Copy Issue Report It seems like `$list` defined by `$client->getResponse($request)` on line `61` can also be of type `null`; however, `PCextreme\Cloudstack\Con...tCommand::processList()` does only seem to accept `array`, 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...
73		}
74
75		/**
76		* Ask for URL API.
77		*
78		* @param InputInterface $input
79		* @param OutputInterface $output
80		* @return string
81		*/
82		protected function askUrlApi(InputInterface $input, OutputInterface $output) : string
83		{
84		$question = new Question(
85		'Enter target API url [default: https://api.auroracompute.eu/ams]: ',
86		'https://api.auroracompute.eu/ams'
87		);
88
89		return $this->getHelper('question')->ask($input, $output, $question);
		0 ignored issues – show Bug introduced 2016-08-19 09:40 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Symfony\Component\Console\Helper\HelperInterface` as the method `ask()` does only exist in the following implementations of said interface: `Symfony\Component\Console\Helper\QuestionHelper`, `Symfony\Component\Consol...r\SymfonyQuestionHelper`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
90		}
91
92		/**
93		* Ask for API key.
94		*
95		* @param InputInterface $input
96		* @param OutputInterface $output
97		* @return string
98		*/
99	View Code Duplication	protected function askApiKey(InputInterface $input, OutputInterface $output) : string
		0 ignored issues – show Duplication introduced 2017-12-11 12:57 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
100		{
101		$question = (new Question('Enter API key: '))
102		->setValidator(function ($answer) {
103		if (is_null($answer)) {
104		throw new \InvalidArgumentException("API key can't be null.");
105		}
106
107		return $answer;
108		})
109		->setMaxAttempts(2);
110
111		return $this->getHelper('question')->ask($input, $output, $question);
		0 ignored issues – show Bug introduced 2016-08-19 09:40 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Symfony\Component\Console\Helper\HelperInterface` as the method `ask()` does only exist in the following implementations of said interface: `Symfony\Component\Console\Helper\QuestionHelper`, `Symfony\Component\Consol...r\SymfonyQuestionHelper`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
112		}
113
114		/**
115		* Ask for secret key.
116		*
117		* @param InputInterface $input
118		* @param OutputInterface $output
119		* @return string
120		*/
121	View Code Duplication	protected function askSecretKey(InputInterface $input, OutputInterface $output) : string
		0 ignored issues – show Duplication introduced 2017-12-11 12:57 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
122		{
123		$question = (new Question('Enter secret key: '))
124		->setValidator(function ($answer) {
125		if (is_null($answer)) {
126		throw new \InvalidArgumentException("Secret key can't be null.");
127		}
128
129		return $answer;
130		})
131		->setMaxAttempts(2);
132
133		return $this->getHelper('question')->ask($input, $output, $question);
		0 ignored issues – show Bug introduced 2016-08-19 09:40 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Symfony\Component\Console\Helper\HelperInterface` as the method `ask()` does only exist in the following implementations of said interface: `Symfony\Component\Console\Helper\QuestionHelper`, `Symfony\Component\Consol...r\SymfonyQuestionHelper`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
134		}
135
136		/**
137		* Dump cache file of APIs list.
138		*
139		* @param OutputInterface $output
140		* @param array $list
141		* @return void
142		*/
143		protected function processList(OutputInterface $output, array $list = []) : void
144		{
145		if (empty($list)) {
146		throw new \RuntimeException("API list is empty.");
147		}
148
149		$progress = new ProgressBar($output, $list['listapisresponse']['count']);
150		$progress->start();
151
152		$commands = [];
153
154		foreach ($list['listapisresponse']['api'] as $api) {
155		$commands = array_merge($commands, $this->parseCommand($api));
156
157		$progress->advance();
158		}
159
160		$this->cache()->set('api.list', $commands);
161
162		$progress->finish();
163		}
164
165		/**
166		* Parse command data into expected structure
167		* @param array $command
168		* @return array
169		*/
170		protected function parseCommand(array $command) : array
171		{
172		$params = [];
173
174		foreach ($command['params'] as $param) {
175		$params = array_merge($params, [
176		$param['name'] => [
177		'description' => $param['description'],
178		'required' => $param['required'],
179		'type' => $param['type'],
180		]
181		]);
182		}
183
184		return [$command['name'] => [
185		'description' => $command['description'],
186		'isasync' => $command['isasync'],
187		'params' => $params
188		]];
189		}
190
191		/**
192		* Get cache driver instance
193		* @return FilesystemCache
194		*/
195	View Code Duplication	private function cache() : FilesystemCache
		0 ignored issues – show Duplication introduced 2018-10-24 20:53 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
196		{
197		if (! isset($this->cache)) {
198		$this->cache = new FilesystemCache('', 0, __DIR__.'/../../cache');
199		}
200
201		return $this->cache;
202		}
203		}
204

PCextreme / cloudstack-php

Pull Request — master (#28)

ApiListCommand A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

8 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like