SilverStripeCommand - Code Metrics - silverleague/silverstripe-console - Measure and Improve Code Quality continuously with Scrutinizer

SilverStripeCommand A
last analyzed 2019-05-07 02:28 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	47
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes

Metric	Value
wmc	5
lcom	0
cbo	3
dl	0
loc	47
rs	10
c	0
b	0
f	0
ccs	12
cts	12
cp	1

3 Methods

Rating	Name	Size	Complexity
A	getOrAskForArgument()	14	3
A	getInjector()	4	1
A	getConfig()	4	1

<?php

namespace SilverLeague\Console\Command;

use SilverStripe\Config\Collections\ConfigCollectionInterface;
use SilverStripe\Core\Config\Config;
use SilverStripe\Core\Injector\Injector;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Question\Question;

/**
 * A slightly embellished Symfony Command class which is SilverStripe aware
 *
 * @package silverstripe-console
 * @author  Robbie Averill <[email protected]>
 */
class SilverStripeCommand extends Command
{
    /**
     * Retrieve an argument from the input interface, or use the Question helper to ask for input
     * if it wasn't provided. Will automatically hide input for password fields.
     *
     * @param  InputInterface  $input
     * @param  OutputInterface $output
     * @param  string          $key      The argument key, e.g. "username"
     * @param  string          $question The question to ask, e.g. "Which username: "
     * @return string|null
     */
    protected function getOrAskForArgument(InputInterface $input, OutputInterface $output, $key, $question)
    {
        if ($supplied = $input->getArgument($key)) {

            return $supplied;
        }

        $question = new Question($question);
        if (stripos($key, 'password') !== false) {
            $question->setHidden(true);
            $question->setHiddenFallback(false);
        }

        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.
    }
}
    }

    /**
     * Get the SilverStripe Injector
     *
     * @return Injector
     */
    public function getInjector()
    {
        return Injector::inst();
    }

    /**
     * Get the configuration API handler
     *
     * @return ConfigCollectionInterface
     */
    public function getConfig()
    {
        return Config::inst();
    }
}


1		<?php
2
3		namespace SilverLeague\Console\Command;
4
5		use SilverStripe\Config\Collections\ConfigCollectionInterface;
6		use SilverStripe\Core\Config\Config;
7		use SilverStripe\Core\Injector\Injector;
8		use Symfony\Component\Console\Command\Command;
9		use Symfony\Component\Console\Input\InputInterface;
10		use Symfony\Component\Console\Output\OutputInterface;
11		use Symfony\Component\Console\Question\Question;
12
13		/**
14		* A slightly embellished Symfony Command class which is SilverStripe aware
15		*
16		* @package silverstripe-console
17		* @author Robbie Averill <[email protected]>
18		*/
19		class SilverStripeCommand extends Command
20		{
21		/**
22		* Retrieve an argument from the input interface, or use the Question helper to ask for input
23		* if it wasn't provided. Will automatically hide input for password fields.
24		*
25		* @param InputInterface $input
26		* @param OutputInterface $output
27		* @param string $key The argument key, e.g. "username"
28		* @param string $question The question to ask, e.g. "Which username: "
29		* @return string\|null
30	3	*/
31		protected function getOrAskForArgument(InputInterface $input, OutputInterface $output, $key, $question)
32	3	{
33	3	if ($supplied = $input->getArgument($key)) {
		0 ignored issues – show Bug Compatibility introduced 2018-11-14 15:00 UTC by Report Bug Copy Issue Report The expression `$input->getArgument($key);` of type `string\|string[]\|null` adds the type `string[]` to the return on line 34 which is incompatible with the return type documented by `SilverLeague\Console\Com...nd::getOrAskForArgument` of type `string\|null`. Loading history...
34		return $supplied;
35		}
36	1
37	1	$question = new Question($question);
38	1	if (stripos($key, 'password') !== false) {
39	1	$question->setHidden(true);
40		$question->setHiddenFallback(false);
41		}
42	1
43		return $this->getHelper('question')->ask($input, $output, $question);
		0 ignored issues – show Bug introduced 2017-01-02 23:31 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...
44		}
45
46		/**
47		* Get the SilverStripe Injector
48		*
49		* @return Injector
50	1	*/
51		public function getInjector()
52	1	{
53		return Injector::inst();
54		}
55
56		/**
57		* Get the configuration API handler
58		*
59		* @return ConfigCollectionInterface
60	1	*/
61		public function getConfig()
62	1	{
63		return Config::inst();
64		}
65		}
66

silverleague / silverstripe-console

SilverStripeCommand A last analyzed 2019-05-07 02:28 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

3 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like

SilverStripeCommand A
last analyzed 2019-05-07 02:28 UTC