TaskCommand - Code Metrics - Inspection of "Split up the AbstractTaskCommand and TaskCommand t..." - jarobe42/task-runner - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#11)

by Jim

created 2017-11-12 22:59 UTC

TaskCommand A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	38
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

Metric	Value
wmc	4
lcom	1
cbo	5
dl	0
loc	38
rs	10
c	0
b	0
f	0

2 Methods

Rating	Name	Duplication	Size	Complexity
B	execute()	0	23	4
	buildTaskBuilder()	0	1	?

<?php

namespace Jarobe\TaskRunnerBundle\Command;

use Jarobe\TaskRunnerBundle\Entity\TaskEvent;
use Jarobe\TaskRunnerBundle\Manager\TaskEventManager;
use Jarobe\TaskRunnerBundle\Manager\TaskManager;
use Jarobe\TaskRunnerBundle\Model\TaskBuilder;
use Jarobe\TaskRunnerBundle\TaskType\TaskTypeInterface;
use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Validator\ConstraintViolationInterface;
use Symfony\Component\Validator\Validator\ValidatorInterface;

abstract class TaskCommand extends AbstractTaskCommand
{
    /**
     * @param InputInterface $input
     * @param OutputInterface $output
     * @return int|null
     */
    public function execute(InputInterface $input, OutputInterface $output)
    {
        $taskBuilder = new TaskBuilder();
        $taskBuilder = $this->buildTaskBuilder($taskBuilder, $input);

        $validationErrors = $this->validateTask($taskBuilder->getTask());
        foreach ($validationErrors as $validationError) {
            $taskBuilder->addError($validationError);
        }

        if ($taskBuilder->hasErrors()) {
            foreach ($taskBuilder->getErrors() as $error) {
                $output->writeln("<error>".$error."</error>");
            }
            return null;
        }

        //Create the TaskEvent
        $taskEvent = new TaskEvent();
        $taskEvent = $this->taskEventManager->createTaskEvent($taskEvent, $taskBuilder->getTask());
        $taskEvent = $this->process($taskEvent, $input, $output);
        return $taskEvent->getCompletedAt() !== null;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * @param TaskBuilder $taskBuilder
     * @param InputInterface $input
     * @return TaskBuilder
     */
    abstract protected function buildTaskBuilder(TaskBuilder $taskBuilder, InputInterface $input);
}


1			<?php
2
3			namespace Jarobe\TaskRunnerBundle\Command;
4
5			use Jarobe\TaskRunnerBundle\Entity\TaskEvent;
6			use Jarobe\TaskRunnerBundle\Manager\TaskEventManager;
7			use Jarobe\TaskRunnerBundle\Manager\TaskManager;
8			use Jarobe\TaskRunnerBundle\Model\TaskBuilder;
9			use Jarobe\TaskRunnerBundle\TaskType\TaskTypeInterface;
10			use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
11			use Symfony\Component\Console\Input\InputInterface;
12			use Symfony\Component\Console\Output\OutputInterface;
13			use Symfony\Component\Validator\ConstraintViolationInterface;
14			use Symfony\Component\Validator\Validator\ValidatorInterface;
15
16			abstract class TaskCommand extends AbstractTaskCommand
17			{
18			/**
19			* @param InputInterface $input
20			* @param OutputInterface $output
21			* @return int\|null
22			*/
23			public function execute(InputInterface $input, OutputInterface $output)
24			{
25			$taskBuilder = new TaskBuilder();
26			$taskBuilder = $this->buildTaskBuilder($taskBuilder, $input);
27
28			$validationErrors = $this->validateTask($taskBuilder->getTask());
29			foreach ($validationErrors as $validationError) {
30			$taskBuilder->addError($validationError);
31			}
32
33			if ($taskBuilder->hasErrors()) {
34			foreach ($taskBuilder->getErrors() as $error) {
35			$output->writeln("<error>".$error."</error>");
36			}
37			return null;
38			}
39
40			//Create the TaskEvent
41			$taskEvent = new TaskEvent();
42			$taskEvent = $this->taskEventManager->createTaskEvent($taskEvent, $taskBuilder->getTask());
43			$taskEvent = $this->process($taskEvent, $input, $output);
44			return $taskEvent->getCompletedAt() !== null;
			0 ignored issues – show Bug Best Practice introduced 2017-11-12 23:01 UTC by Report Bug Copy Issue Report The return type of `return $taskEvent->getCompletedAt() !== null;` (`boolean`) is incompatible with the return type of the parent method `Symfony\Component\Console\Command\Command::execute` of type `null\|integer`. 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 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('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...
45			}
46
47			/**
48			* @param TaskBuilder $taskBuilder
49			* @param InputInterface $input
50			* @return TaskBuilder
51			*/
52			abstract protected function buildTaskBuilder(TaskBuilder $taskBuilder, InputInterface $input);
53			}
54

jarobe42 / task-runner

Pull Request — master (#11)

TaskCommand A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

2 Methods

Duplication Side-by-Side

Filter issues like