Report::configure() - Code Metrics - reithbot/toyrobot-php - Measure and Improve Code Quality continuously with Scrutinizer

Report::configure() A
last analyzed 2018-07-06 02:58 UTC

↳ Parent: Report

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	13
ccs	6
cts	6
cp	1
rs	9.8333
c	0
b	0
f	0
cc	1
nc	1
nop	0
crap	1

<?php

/**
 * (c) 2018 Douglas Reith.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
declare(strict_types=1);

namespace Reith\ToyRobot\Console;

use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Input\InputArgument;
use Reith\ToyRobot\Messaging\Query\RobotReport;

class Report extends Command
{
    protected function configure()
    {
        $this
            ->setName('REPORT')
            ->setDescription('Get a report from the robot')
            ->setHelp(<<<EOT
The <info>REPORT</info> instruction will get a report from the robot;

<info>./toyrobot</info> <comment>REPORT</comment>

EOT
        );
    }

    /**
     * @param InputInterface  $input
     * @param OutputInterface $output
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $message = new RobotReport();

        $onSuccess = function (string $result) use ($output) {
            $output->writeln($result);
        };

        $this->getHelper('bus')->postQuery($message, $onSuccess);
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.
    }
}
    }
}


1		<?php
2
3		/**
4		* (c) 2018 Douglas Reith.
5		*
6		* For the full copyright and license information, please view the LICENSE
7		* file that was distributed with this source code.
8		*/
9		declare(strict_types=1);
10
11		namespace Reith\ToyRobot\Console;
12
13		use Symfony\Component\Console\Command\Command;
14		use Symfony\Component\Console\Input\InputInterface;
15		use Symfony\Component\Console\Output\OutputInterface;
16		use Symfony\Component\Console\Input\InputArgument;
17		use Reith\ToyRobot\Messaging\Query\RobotReport;
18
19		class Report extends Command
20		{
21	7	protected function configure()
22		{
23		$this
24	7	->setName('REPORT')
25	7	->setDescription('Get a report from the robot')
26	7	->setHelp(<<<EOT
27	7	The <info>REPORT</info> instruction will get a report from the robot;
28
29		<info>./toyrobot</info> <comment>REPORT</comment>
30
31		EOT
32		);
33	7	}
34
35		/**
36		* @param InputInterface $input
37		* @param OutputInterface $output
38		*/
39	5	protected function execute(InputInterface $input, OutputInterface $output)
40		{
41	5	$message = new RobotReport();
42
43		$onSuccess = function (string $result) use ($output) {
44	5	$output->writeln($result);
45	5	};
46
47	5	$this->getHelper('bus')->postQuery($message, $onSuccess);
		0 ignored issues – show Bug introduced 2018-04-17 23:50 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 `postQuery()` does only exist in the following implementations of said interface: `Reith\ToyRobot\Console\BusHelper`. 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...
48	5	}
49		}
50

reithbot / toyrobot-php

Report::configure() A last analyzed 2018-07-06 02:58 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

Report::configure() A
last analyzed 2018-07-06 02:58 UTC