Application::isPharFile() - Code Metrics - Inspection of "Use built-in `Application:isPharFile` method" - console-helpers/svn-buddy - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f28b17...5a80e7 )

by Alexander

created 2016-10-09 08:39 UTC

Application::isPharFile() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php
/**
 * This file is part of the SVN-Buddy library.
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 *
 * @copyright Alexander Obuhovich <[email protected]>
 * @link      https://github.com/console-helpers/svn-buddy
 */

namespace ConsoleHelpers\SVNBuddy;


use ConsoleHelpers\ConsoleKit\Application as BaseApplication;
use ConsoleHelpers\ConsoleKit\Container as BaseContainer;
use ConsoleHelpers\SVNBuddy\Command\AggregateCommand;
use ConsoleHelpers\SVNBuddy\Command\CleanupCommand;
use ConsoleHelpers\SVNBuddy\Command\CommitCommand;
use ConsoleHelpers\SVNBuddy\Command\CompletionCommand;
use ConsoleHelpers\SVNBuddy\Command\ConfigCommand;
use ConsoleHelpers\SVNBuddy\Command\Dev\MigrationCreateCommand;
use ConsoleHelpers\SVNBuddy\Command\Dev\PharCreateCommand;
use ConsoleHelpers\SVNBuddy\Command\LogCommand;
use ConsoleHelpers\SVNBuddy\Command\MergeCommand;
use ConsoleHelpers\SVNBuddy\Command\RevertCommand;
use ConsoleHelpers\SVNBuddy\Command\SelfUpdateCommand;
use ConsoleHelpers\SVNBuddy\Command\UpdateCommand;
use ConsoleHelpers\SVNBuddy\Repository\Connector\Connector;

class Application extends BaseApplication
{

	/**
	 * Creates application.
	 *
	 * @param BaseContainer $container Container.
	 */
	public function __construct(BaseContainer $container)
	{
		parent::__construct($container);

		$helper_set = $this->getHelperSet();
		$helper_set->set($this->dic['date_helper']);
		$helper_set->set($this->dic['size_helper']);
		$helper_set->set($this->dic['output_helper']);

		set_time_limit(0);
		ini_set('memory_limit', -1);

		putenv('LC_CTYPE=en_US.UTF-8'); // For SVN.
	}

	/**
	 * Returns the long version of the application.
	 *
	 * @return string The long application version
	 *
	 * @api
	 */
	public function getLongVersion()
	{
		$version = parent::getLongVersion();

		/** @var Connector $repository_connector */
		$repository_connector = $this->dic['repository_connector'];
		$client_version = $repository_connector->getCommand('', '--version --quiet')->run();

		return $version . ' (SVN <comment>v' . trim($client_version) . '</comment>)';
	}

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

		$default_commands[] = new MergeCommand();
		$default_commands[] = new CleanupCommand();
		$default_commands[] = new RevertCommand();
		$default_commands[] = new LogCommand();
		$default_commands[] = new UpdateCommand();
		$default_commands[] = new CommitCommand();
		$default_commands[] = new AggregateCommand();
		$default_commands[] = new CompletionCommand();
		$default_commands[] = new ConfigCommand();
		$default_commands[] = new SelfUpdateCommand();

		if ( !$this->isPharFile() ) {
			$default_commands[] = new MigrationCreateCommand();
			$default_commands[] = new PharCreateCommand();
		}

		return $default_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());
}
	}

}


1			<?php
2			/**
3			* This file is part of the SVN-Buddy library.
4			* For the full copyright and license information, please view
5			* the LICENSE file that was distributed with this source code.
6			*
7			* @copyright Alexander Obuhovich <[email protected]>
8			* @link https://github.com/console-helpers/svn-buddy
9			*/
10
11			namespace ConsoleHelpers\SVNBuddy;
12
13
14			use ConsoleHelpers\ConsoleKit\Application as BaseApplication;
15			use ConsoleHelpers\ConsoleKit\Container as BaseContainer;
16			use ConsoleHelpers\SVNBuddy\Command\AggregateCommand;
17			use ConsoleHelpers\SVNBuddy\Command\CleanupCommand;
18			use ConsoleHelpers\SVNBuddy\Command\CommitCommand;
19			use ConsoleHelpers\SVNBuddy\Command\CompletionCommand;
20			use ConsoleHelpers\SVNBuddy\Command\ConfigCommand;
21			use ConsoleHelpers\SVNBuddy\Command\Dev\MigrationCreateCommand;
22			use ConsoleHelpers\SVNBuddy\Command\Dev\PharCreateCommand;
23			use ConsoleHelpers\SVNBuddy\Command\LogCommand;
24			use ConsoleHelpers\SVNBuddy\Command\MergeCommand;
25			use ConsoleHelpers\SVNBuddy\Command\RevertCommand;
26			use ConsoleHelpers\SVNBuddy\Command\SelfUpdateCommand;
27			use ConsoleHelpers\SVNBuddy\Command\UpdateCommand;
28			use ConsoleHelpers\SVNBuddy\Repository\Connector\Connector;
29
30			class Application extends BaseApplication
31			{
32
33			/**
34			* Creates application.
35			*
36			* @param BaseContainer $container Container.
37			*/
38			public function __construct(BaseContainer $container)
39			{
40			parent::__construct($container);
41
42			$helper_set = $this->getHelperSet();
43			$helper_set->set($this->dic['date_helper']);
44			$helper_set->set($this->dic['size_helper']);
45			$helper_set->set($this->dic['output_helper']);
46
47			set_time_limit(0);
48			ini_set('memory_limit', -1);
49
50			putenv('LC_CTYPE=en_US.UTF-8'); // For SVN.
51			}
52
53			/**
54			* Returns the long version of the application.
55			*
56			* @return string The long application version
57			*
58			* @api
59			*/
60			public function getLongVersion()
61			{
62			$version = parent::getLongVersion();
63
64			/** @var Connector $repository_connector */
65			$repository_connector = $this->dic['repository_connector'];
66			$client_version = $repository_connector->getCommand('', '--version --quiet')->run();
67
68			return $version . ' (SVN <comment>v' . trim($client_version) . '</comment>)';
69			}
70
71			/**
72			* {@inheritdoc}
73			*/
74			protected function getDefaultCommands()
75			{
76			$default_commands = parent::getDefaultCommands();
77
78			$default_commands[] = new MergeCommand();
79			$default_commands[] = new CleanupCommand();
80			$default_commands[] = new RevertCommand();
81			$default_commands[] = new LogCommand();
82			$default_commands[] = new UpdateCommand();
83			$default_commands[] = new CommitCommand();
84			$default_commands[] = new AggregateCommand();
85			$default_commands[] = new CompletionCommand();
86			$default_commands[] = new ConfigCommand();
87			$default_commands[] = new SelfUpdateCommand();
88
89			if ( !$this->isPharFile() ) {
90			$default_commands[] = new MigrationCreateCommand();
91			$default_commands[] = new PharCreateCommand();
92			}
93
94			return $default_commands;
			0 ignored issues – show Best Practice introduced 2016-05-29 14:26 UTC by Report Bug Copy Issue Report The expression `return $default_commands;` seems to be an `array`, but some of its elements' types (`ConsoleHelpers\SVNBuddy\...d\Dev\PharCreateCommand`) are incompatible with the return type of the parent method `ConsoleHelpers\ConsoleKi...ion::getDefaultCommands` of type `array<Symfony\Component\...tion\CompletionCommand>`. 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...
95			}
96
97			}
98

console-helpers / svn-buddy

Push — master ( f28b17...5a80e7 )

Application::isPharFile() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like