Application - Code Metrics - Inspection of "add formatters command" - kadet1090/KeyLighter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — symfony-console (0fa491)

by Kacper

created 2016-06-12 14:44 UTC

Application A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	58
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	11

Importance

Changes	6
Bugs	0	Features	2

Metric	Value
c	6
b	0
f	2
dl	0
loc	58
rs	10
wmc	9
lcom	1
cbo	11

5 Methods

Rating	Name	Size	Complexity
A	getCommandName()	12	4
A	getDefaultCommands()	8	1
A	getDefaultInputDefinition()	10	1
A	__construct()	5	1
A	run()	11	2

<?php
/**
 * Highlighter
 *
 * Copyright (C) 2016, Some right reserved.
 *
 * @author Kacper "Kadet" Donat <[email protected]>
 *
 * Contact with author:
 * Xmpp: [email protected]
 * E-mail: [email protected]
 *
 * From Kadet with love.
 */

namespace Kadet\Highlighter\bin;


use Kadet\Highlighter\bin\Commands\FormattersCommand;
use Kadet\Highlighter\bin\Commands\HighlightCommand;
use Kadet\Highlighter\bin\Commands\LanguagesCommand;
use Kadet\Highlighter\KeyLighter;
use Symfony\Component\Console\Application as SymfonyApplication;
use Symfony\Component\Console\Formatter\OutputFormatterStyle;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\ConsoleOutput;
use Symfony\Component\Console\Output\OutputInterface;

class Application extends SymfonyApplication
{
    public $explicit = true;

    protected function getCommandName(InputInterface $input)
    {
        $command = $input->getFirstArgument();
        if(!$command && !$input->hasParameterOption('--help')) {
            return 'list';
        } elseif ($this->has($command)) {
            return $command;
        } else {
            $this->explicit = false;
            return 'highlight';
        }
    }

    protected function getDefaultCommands()
    {
        return array_merge(parent::getDefaultCommands(), [
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());
}
            new HighlightCommand(),
            new LanguagesCommand(),
            new FormattersCommand()
        ]);
    }

    protected function getDefaultInputDefinition()
    {
        $input = parent::getDefaultInputDefinition();
        $input->setOptions(array_filter($input->getOptions(), function (InputOption $option) {
            return $option->getShortcut() != 'q';
        }));
        $input->addOption(new InputOption('no-output', 's', InputOption::VALUE_NONE, 'Disables output, useful for debug'));

        return $input;
    }


    public function __construct()
    {
        parent::__construct('KeyLighter', KeyLighter::VERSION);
        $this->setDefaultCommand('highlight');
    }

    public function run(InputInterface $input = null, OutputInterface $output = null)
    {
        $output = $output ?: new ConsoleOutput();

        $output->getFormatter()->setStyle('command', $output->getFormatter()->getStyle('info'));
        $output->getFormatter()->setStyle('language', new OutputFormatterStyle('magenta'));
        $output->getFormatter()->setStyle('path', new OutputFormatterStyle('blue'));
        $output->getFormatter()->setStyle('formatter', new OutputFormatterStyle('yellow'));

        return parent::run($input, $output);
    }


}


1			<?php
2			/**
3			* Highlighter
4			*
5			* Copyright (C) 2016, Some right reserved.
6			*
7			* @author Kacper "Kadet" Donat <[email protected]>
8			*
9			* Contact with author:
10			* Xmpp: [email protected]
11			* E-mail: [email protected]
12			*
13			* From Kadet with love.
14			*/
15
16			namespace Kadet\Highlighter\bin;
17
18
19			use Kadet\Highlighter\bin\Commands\FormattersCommand;
20			use Kadet\Highlighter\bin\Commands\HighlightCommand;
21			use Kadet\Highlighter\bin\Commands\LanguagesCommand;
22			use Kadet\Highlighter\KeyLighter;
23			use Symfony\Component\Console\Application as SymfonyApplication;
24			use Symfony\Component\Console\Formatter\OutputFormatterStyle;
25			use Symfony\Component\Console\Input\InputInterface;
26			use Symfony\Component\Console\Input\InputOption;
27			use Symfony\Component\Console\Output\ConsoleOutput;
28			use Symfony\Component\Console\Output\OutputInterface;
29
30			class Application extends SymfonyApplication
31			{
32			public $explicit = true;
33
34			protected function getCommandName(InputInterface $input)
35			{
36			$command = $input->getFirstArgument();
37			if(!$command && !$input->hasParameterOption('--help')) {
38			return 'list';
39			} elseif ($this->has($command)) {
40			return $command;
41			} else {
42			$this->explicit = false;
43			return 'highlight';
44			}
45			}
46
47			protected function getDefaultCommands()
48			{
49			return array_merge(parent::getDefaultCommands(), [
			1 ignored issue – show Best Practice introduced 2016-06-12 14:47 UTC by Report Bug Copy Issue Report The expression `return array_merge(paren...\FormattersCommand()));` seems to be an `array`, but some of its elements' types (`Kadet\Highlighter\bin\Co...mands\FormattersCommand`) 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...
50			new HighlightCommand(),
51			new LanguagesCommand(),
52			new FormattersCommand()
53			]);
54			}
55
56			protected function getDefaultInputDefinition()
57			{
58			$input = parent::getDefaultInputDefinition();
59			$input->setOptions(array_filter($input->getOptions(), function (InputOption $option) {
60			return $option->getShortcut() != 'q';
61			}));
62			$input->addOption(new InputOption('no-output', 's', InputOption::VALUE_NONE, 'Disables output, useful for debug'));
63
64			return $input;
65			}
66
67
68			public function __construct()
69			{
70			parent::__construct('KeyLighter', KeyLighter::VERSION);
71			$this->setDefaultCommand('highlight');
72			}
73
74			public function run(InputInterface $input = null, OutputInterface $output = null)
75			{
76			$output = $output ?: new ConsoleOutput();
77
78			$output->getFormatter()->setStyle('command', $output->getFormatter()->getStyle('info'));
79			$output->getFormatter()->setStyle('language', new OutputFormatterStyle('magenta'));
80			$output->getFormatter()->setStyle('path', new OutputFormatterStyle('blue'));
81			$output->getFormatter()->setStyle('formatter', new OutputFormatterStyle('yellow'));
82
83			return parent::run($input, $output);
84			}
85
86
87			}
88

kadet1090 / KeyLighter

Branch — symfony-console (0fa491)

Application A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

5 Methods

Duplication Side-by-Side

Filter issues like