ShellBot - Code Metrics - mcrumm/phlack - Measure and Improve Code Quality continuously with Scrutinizer

ShellBot A
last analyzed 2016-05-02 17:54 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	50
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

87.5%

Importance

Changes	2
Bugs	1	Features	0

Metric	Value
wmc	5
c	2
b	1
f	0
lcom	1
cbo	6
dl	0
loc	50
ccs	14
cts	16
cp	0.875
rs	10

4 Methods

Rating	Name	Size	Complexity
A	getCommandName()	4	1
A	__construct()	5	2
A	getDefaultCommands()	7	1
A	getDefinition()	9	1

<?php

namespace Crummy\Phlack\Bridge\Symfony\Console;

use Crummy\Phlack\Bot\Mainframe\Mainframe;
use Symfony\Component\Console\Application;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;

class ShellBot extends Application
{
    private $bot;

    /**
     * {@inheritdoc}
     *
     * @param BotCommand $botCommand The BotCommand that executes for this ShellBot.
     */
    public function __construct($name = 'phlackbot', $version = 'UNKNOWN', BotCommand $botCommand = null)
    {
        $this->bot = $botCommand ?: new BotCommand(new ConsoleAdapter(new Mainframe()));
        parent::__construct($name, $version);
    }

    /**
     * Overrides commandName for this ShellBot.
     * {@inheritdoc}
     */
    protected function getCommandName(InputInterface $input)
    {
        return $this->bot->getName();
    }

    /**
     * Adds BotCommand as the sole command for this ShellBot.
     * {@inheritdoc}
     */
    protected function getDefaultCommands()
    {
        $defaultCommands = parent::getDefaultCommands();
        $defaultCommands[] = $this->bot;

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

    /**
     * Replaces the default InputDefinition with one containing only the 'command' argument.
     * {@inheritdoc}
     */
    public function getDefinition()
    {
        $inputDefinition = parent::getDefinition();
        $inputDefinition->setArguments([
            new InputArgument('command', InputArgument::OPTIONAL | InputArgument::IS_ARRAY, 'The input command'),
        ]);

        return $inputDefinition;
    }
}


1		<?php
2
3		namespace Crummy\Phlack\Bridge\Symfony\Console;
4
5		use Crummy\Phlack\Bot\Mainframe\Mainframe;
6		use Symfony\Component\Console\Application;
7		use Symfony\Component\Console\Input\InputArgument;
8		use Symfony\Component\Console\Input\InputInterface;
9
10		class ShellBot extends Application
11		{
12		private $bot;
13
14		/**
15		* {@inheritdoc}
16		*
17		* @param BotCommand $botCommand The BotCommand that executes for this ShellBot.
18		*/
19	2	public function __construct($name = 'phlackbot', $version = 'UNKNOWN', BotCommand $botCommand = null)
20		{
21	2	$this->bot = $botCommand ?: new BotCommand(new ConsoleAdapter(new Mainframe()));
22	2	parent::__construct($name, $version);
23	2	}
24
25		/**
26		* Overrides commandName for this ShellBot.
27		* {@inheritdoc}
28		*/
29		protected function getCommandName(InputInterface $input)
30		{
31		return $this->bot->getName();
32		}
33
34		/**
35		* Adds BotCommand as the sole command for this ShellBot.
36		* {@inheritdoc}
37		*/
38	2	protected function getDefaultCommands()
39		{
40	2	$defaultCommands = parent::getDefaultCommands();
41	2	$defaultCommands[] = $this->bot;
42
43	2	return $defaultCommands;
		0 ignored issues – show Best Practice introduced 2015-12-27 19:07 UTC by Report Bug Copy Issue Report The expression `return $defaultCommands;` seems to be an `array`, but some of its elements' types (`Crummy\Phlack\Bridge\Symfony\Console\BotCommand`) 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...
44		}
45
46		/**
47		* Replaces the default InputDefinition with one containing only the 'command' argument.
48		* {@inheritdoc}
49		*/
50	1	public function getDefinition()
51		{
52	1	$inputDefinition = parent::getDefinition();
53	1	$inputDefinition->setArguments([
54	1	new InputArgument('command', InputArgument::OPTIONAL \| InputArgument::IS_ARRAY, 'The input command'),
55	1	]);
56
57	1	return $inputDefinition;
58		}
59		}
60

mcrumm / phlack

ShellBot A last analyzed 2016-05-02 17:54 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

4 Methods

Duplication Side-by-Side

Filter issues like

ShellBot A
last analyzed 2016-05-02 17:54 UTC