AbstractNightlyTaskCommand::fillTasks() - Code Metrics - Inspection of "Declare command for sf4" - dekalee/nightly-task-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#1)

by nicolas

created 2019-01-29 14:50 UTC

AbstractNightlyTaskCommand::fillTasks() A

↳ Parent: AbstractNightlyTaskCommand

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes

Metric	Value
dl	0
loc	9
ccs	0
cts	9
cp	0
rs	9.9666
c	0
b	0
f	0
cc	3
nc	3
nop	0
crap	12

<?php

namespace Dekalee\NightlyTaskBundle\Command;

use Dekalee\NightlyTaskBundle\Bag\TasksBag;
use Psr\Log\LoggerInterface;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Descriptor\ApplicationDescription;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

/**
 * Class AbstractNightlyTaskCommand
 */
abstract class AbstractNightlyTaskCommand extends Command
{
    /**
     * @var InputInterface
     */
    protected $input;

    /**
     * @var OutputInterface
     */
    protected $output;

    /**
     * @var LoggerInterface
     */
    protected $logger;

    /**
     * @var TasksBag
     */
    private $taskBag;

    /**
     * @param TasksBag        $taskBag
     * @param LoggerInterface $logger
     */
    public function __construct(TasksBag $taskBag, LoggerInterface $logger)
    {
        parent::__construct();
        $this->logger = $logger;
        $this->taskBag = $taskBag;
    }

    /**
     * @return array
     */
    protected function getTasks()
    {
        return $this->taskBag->getTasks();
    }

    /**
     * Initialize fields
     *
     * @param InputInterface  $input
     * @param OutputInterface $output
     */
    protected function beforeExecute(InputInterface $input, OutputInterface $output)
    {
        $this->input = $input;
        $this->output = $output;
    }

    /**
     * Fill task lists
     */
    protected function fillTasks()
    {
        $description = new ApplicationDescription($this->getApplication());
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        foreach ($description->getCommands() as $command) {
            if ($command instanceof NightlyCommandInterface) {
                $this->taskBag->addTask($command, $command->getPriority());
            }
        }
    }
}


1			<?php
2
3			namespace Dekalee\NightlyTaskBundle\Command;
4
5			use Dekalee\NightlyTaskBundle\Bag\TasksBag;
6			use Psr\Log\LoggerInterface;
7			use Symfony\Component\Console\Command\Command;
8			use Symfony\Component\Console\Descriptor\ApplicationDescription;
9			use Symfony\Component\Console\Input\InputInterface;
10			use Symfony\Component\Console\Output\OutputInterface;
11
12			/**
13			* Class AbstractNightlyTaskCommand
14			*/
15			abstract class AbstractNightlyTaskCommand extends Command
16			{
17			/**
18			* @var InputInterface
19			*/
20			protected $input;
21
22			/**
23			* @var OutputInterface
24			*/
25			protected $output;
26
27			/**
28			* @var LoggerInterface
29			*/
30			protected $logger;
31
32			/**
33			* @var TasksBag
34			*/
35			private $taskBag;
36
37			/**
38			* @param TasksBag $taskBag
39			* @param LoggerInterface $logger
40			*/
41			public function __construct(TasksBag $taskBag, LoggerInterface $logger)
42			{
43			parent::__construct();
44			$this->logger = $logger;
45			$this->taskBag = $taskBag;
46			}
47
48			/**
49			* @return array
50			*/
51			protected function getTasks()
52			{
53			return $this->taskBag->getTasks();
54			}
55
56			/**
57			* Initialize fields
58			*
59			* @param InputInterface $input
60			* @param OutputInterface $output
61			*/
62			protected function beforeExecute(InputInterface $input, OutputInterface $output)
63			{
64			$this->input = $input;
65			$this->output = $output;
66			}
67
68			/**
69			* Fill task lists
70			*/
71			protected function fillTasks()
72			{
73			$description = new ApplicationDescription($this->getApplication());
			0 ignored issues – show Bug introduced 2018-01-09 13:52 UTC by Report Bug Copy Issue Report It seems like `$this->getApplication()` can be `null`; however, `__construct()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
74			foreach ($description->getCommands() as $command) {
75			if ($command instanceof NightlyCommandInterface) {
76			$this->taskBag->addTask($command, $command->getPriority());
77			}
78			}
79			}
80			}
81

dekalee / nightly-task-bundle

Pull Request — master (#1)

AbstractNightlyTaskCommand::fillTasks() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like