Application::getDefaultCommands() - Code Metrics - Inspection of "Fix deployer/phar-update deps" - deployphp/deployer - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c322cc...a2ddd5 )

by Anton

created 2017-02-02 03:46 UTC

Application::getDefaultCommands() A

↳ Parent: Application

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	2
eloc	5
c	2
b	0
f	0
nc	2
nop	0
dl	0
loc	10
ccs	4
cts	4
cp	1
crap	2
rs	9.4285

<?php
/* (c) Anton Medvedev <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Deployer\Console;

use Deployer\Component\PharUpdate\Console\Command as PharUpdateCommand;
use Deployer\Component\PharUpdate\Console\Helper as PharUpdateHelper;
use Symfony\Component\Console\Application as Console;
use Symfony\Component\Console\Input\InputDefinition;
use Symfony\Component\Console\Input\InputOption;

class Application extends Console
{
    /**
     * Input definition for user specific arguments and options.
     *
     * @var InputDefinition
     */
    private $userDefinition;

    /**
     * {@inheritdoc}
     */
    protected function getDefaultInputDefinition()
    {
        $inputDefinition = parent::getDefaultInputDefinition();

        $inputDefinition->addOption(
            new InputOption('--file', '-f', InputOption::VALUE_OPTIONAL, 'Specify Deployer file')
        );

        return $inputDefinition;
    }

    /**
     * {@inheritdoc}
     */
    protected function getDefaultCommands()
    {
        $commands = parent::getDefaultCommands();

        if ($this->isPharArchive()) {
            $commands[] = $this->selfUpdateCommand();
        }

        return $commands;
class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * {@inheritdoc}
     */
    private function selfUpdateCommand()
    {
        $selfUpdate = new PharUpdateCommand('self-update');
        $selfUpdate->setDescription('Updates deployer.phar to the latest version');
        $selfUpdate->setManifestUri('https://deployer.org/manifest.json');
        return $selfUpdate;
    }

    /**
     * {@inheritdoc}
     */
    protected function getDefaultHelperSet()
    {
        $helperSet = parent::getDefaultHelperSet();

        if ($this->isPharArchive()) {
            $helperSet->set(new PharUpdateHelper());
        }
        return $helperSet;
    }

    /**
     * @return InputDefinition
     */
    public function getUserDefinition()
    {
        if (null === $this->userDefinition) {
            $this->userDefinition = new InputDefinition();
        }

        return $this->userDefinition;
    }

    /**
     * Add user definition arguments and options to definition.
     */
    public function addUserArgumentsAndOptions()
    {
        $this->getDefinition()->addArguments($this->getUserDefinition()->getArguments());
        $this->getDefinition()->addOptions($this->getUserDefinition()->getOptions());
    }

    public function isPharArchive()
    {
        return 'phar:' === substr(__FILE__, 0, 5);
    }
}


1		<?php
2		/* (c) Anton Medvedev <[email protected]>
3		*
4		* For the full copyright and license information, please view the LICENSE
5		* file that was distributed with this source code.
6		*/
7
8		namespace Deployer\Console;
9
10		use Deployer\Component\PharUpdate\Console\Command as PharUpdateCommand;
11		use Deployer\Component\PharUpdate\Console\Helper as PharUpdateHelper;
12		use Symfony\Component\Console\Application as Console;
13		use Symfony\Component\Console\Input\InputDefinition;
14		use Symfony\Component\Console\Input\InputOption;
15
16		class Application extends Console
17		{
18		/**
19		* Input definition for user specific arguments and options.
20		*
21		* @var InputDefinition
22		*/
23		private $userDefinition;
24
25		/**
26		* {@inheritdoc}
27		*/
28	36	protected function getDefaultInputDefinition()
29		{
30	36	$inputDefinition = parent::getDefaultInputDefinition();
31
32	36	$inputDefinition->addOption(
33	36	new InputOption('--file', '-f', InputOption::VALUE_OPTIONAL, 'Specify Deployer file')
34	36	);
35
36	36	return $inputDefinition;
37		}
38
39		/**
40		* {@inheritdoc}
41		*/
42	36	protected function getDefaultCommands()
43		{
44	36	$commands = parent::getDefaultCommands();
45	36
46	36	if ($this->isPharArchive()) {
47		$commands[] = $this->selfUpdateCommand();
48		}
49
50		return $commands;
		1 ignored issue – show Best Practice introduced 2016-04-07 08:21 UTC by Report Bug Copy Issue Report The expression `return $commands;` seems to be an `array`, but some of its elements' types (`Deployer\Component\PharUpdate\Console\Command`) are incompatible with the return type of the parent method `Symfony\Component\Consol...ion::getDefaultCommands` of type `array<Symfony\Component\...le\Command\ListCommand>`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return new Author('Johannes'); } } class BlogPost extends Post { public function getAuthor() { return 'Johannes'; } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
51		}
52	36
53		/**
54	36	* {@inheritdoc}
55	36	*/
56	36	private function selfUpdateCommand()
57	36	{
58		$selfUpdate = new PharUpdateCommand('self-update');
59		$selfUpdate->setDescription('Updates deployer.phar to the latest version');
60		$selfUpdate->setManifestUri('https://deployer.org/manifest.json');
61		return $selfUpdate;
62		}
63	36
64		/**
65	36	* {@inheritdoc}
66	36	*/
67	36	protected function getDefaultHelperSet()
68		{
69		$helperSet = parent::getDefaultHelperSet();
70
71		if ($this->isPharArchive()) {
72		$helperSet->set(new PharUpdateHelper());
73	14	}
74		return $helperSet;
75	14	}
76	14
77	14	/**
78		* @return InputDefinition
79	14	*/
80		public function getUserDefinition()
81		{
82		if (null === $this->userDefinition) {
83		$this->userDefinition = new InputDefinition();
84		}
85	14
86		return $this->userDefinition;
87	14	}
88	14
89	14	/**
90		* Add user definition arguments and options to definition.
91		*/
92		public function addUserArgumentsAndOptions()
93		{
94		$this->getDefinition()->addArguments($this->getUserDefinition()->getArguments());
95		$this->getDefinition()->addOptions($this->getUserDefinition()->getOptions());
96		}
97
98		public function isPharArchive()
99		{
100		return 'phar:' === substr(__FILE__, 0, 5);
101		}
102		}
103

deployphp / deployer

GitHub Access Token became invalid

Push — master ( c322cc...a2ddd5 )

Application::getDefaultCommands() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like