DebugTasksCommand::configure() - Code Metrics - Inspection of "Added command and extended storage" - php-task/TaskBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#14)

by Wachter

created 2016-02-18 20:30 UTC

DebugTasksCommand::configure() A

↳ Parent: DebugTasksCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	6
rs	9.4285
cc	1
eloc	4
nc	1
nop	0

<?php

namespace Task\TaskBundle\Command;

use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Helper\Table;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Task\Storage\StorageInterface;

/**
 * Run pending tasks.
 *
 * @author @wachterjohannes <[email protected]>
 */
class DebugTasksCommand extends Command
{
    /**
     * @var StorageInterface
     */
    private $storage;

    public function __construct($name, StorageInterface $storage)
    {
        parent::__construct($name);

        $this->storage = $storage;
    }

    /**
     * {@inheritdoc}
     */
    protected function configure()
    {
        $this->setDescription('Debug tasks')
            ->addOption('limit', 'l')
            ->addOption('key');
    }

    /**
     * {@inheritdoc}
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $key = $input->getOption('key');
        $limit = $input->getOption('limit');

        if (null !== $key) {
            $tasks = $this->storage->findByKey($key, $limit);
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.
    }
}
        } else {
            $tasks = $this->storage->findAll($limit);

        }

        $table = new Table($output);
        $table->setHeaders(array('uuid', 'key', 'task-name', 'execution-date', 'completed', 'start', 'duration'));

        foreach ($tasks as $task) {
            $start = null;
            $duration = null;
            if (null !== $task->getLastExecution()) {
                $start = $task->getLastExecution()->getFinishedAtAsDateTime()->format(\DateTime::RFC3339);
                $duration = $task->getLastExecution()->getExecutionDuration();
            }

            $table->addRow(
                [
                    $task->getUuid(),
                    $task->getKey(),
                    $task->getTaskName(),
                    $task->getExecutionDate()->format(\DateTime::RFC3339),
                    $task->isCompleted(),
                    $start,
                    $duration,
                ]
            );
        }

        $table->render();
    }
}


1			<?php
2
3			namespace Task\TaskBundle\Command;
4
5			use Symfony\Component\Console\Command\Command;
6			use Symfony\Component\Console\Helper\Table;
7			use Symfony\Component\Console\Input\InputInterface;
8			use Symfony\Component\Console\Output\OutputInterface;
9			use Task\Storage\StorageInterface;
10
11			/**
12			* Run pending tasks.
13			*
14			* @author @wachterjohannes <[email protected]>
15			*/
16			class DebugTasksCommand extends Command
17			{
18			/**
19			* @var StorageInterface
20			*/
21			private $storage;
22
23			public function __construct($name, StorageInterface $storage)
24			{
25			parent::__construct($name);
26
27			$this->storage = $storage;
28			}
29
30			/**
31			* {@inheritdoc}
32			*/
33			protected function configure()
34			{
35			$this->setDescription('Debug tasks')
36			->addOption('limit', 'l')
37			->addOption('key');
38			}
39
40			/**
41			* {@inheritdoc}
42			*/
43			protected function execute(InputInterface $input, OutputInterface $output)
44			{
45			$key = $input->getOption('key');
46			$limit = $input->getOption('limit');
47
48			if (null !== $key) {
49			$tasks = $this->storage->findByKey($key, $limit);
			0 ignored issues – show Bug introduced 2016-02-18 20:37 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Task\Storage\StorageInterface` as the method `findByKey()` does only exist in the following implementations of said interface: `Task\TaskBundle\Storage\DoctrineStorage`. 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...
50			} else {
51			$tasks = $this->storage->findAll($limit);
			0 ignored issues – show Unused Code introduced 2016-02-18 20:37 UTC by Report Bug Copy Issue Report The call to `StorageInterface::findAll()` has too many arguments starting with `$limit`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
52			}
53
54			$table = new Table($output);
55			$table->setHeaders(array('uuid', 'key', 'task-name', 'execution-date', 'completed', 'start', 'duration'));
56
57			foreach ($tasks as $task) {
58			$start = null;
59			$duration = null;
60			if (null !== $task->getLastExecution()) {
61			$start = $task->getLastExecution()->getFinishedAtAsDateTime()->format(\DateTime::RFC3339);
62			$duration = $task->getLastExecution()->getExecutionDuration();
63			}
64
65			$table->addRow(
66			[
67			$task->getUuid(),
68			$task->getKey(),
69			$task->getTaskName(),
70			$task->getExecutionDate()->format(\DateTime::RFC3339),
71			$task->isCompleted(),
72			$start,
73			$duration,
74			]
75			);
76			}
77
78			$table->render();
79			}
80			}
81

php-task / TaskBundle

Pull Request — master (#14)

DebugTasksCommand::configure() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like