UpgradeChanges::getOrder() - Code Metrics - Inspection of "upgrade context refactoring" - mikekamornikov/UpgradeSpec - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 57b1db...16daf9 )

by Mike

created 2017-02-06 15:10 UTC

UpgradeChanges::getOrder() A

↳ Parent: UpgradeChanges

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	0

<?php

namespace Sugarcrm\UpgradeSpec\Element\Section;

use Sugarcrm\UpgradeSpec\Data\DataAwareInterface;
use Sugarcrm\UpgradeSpec\Data\DataAwareTrait;
use Sugarcrm\UpgradeSpec\Element\ElementInterface;
use Sugarcrm\UpgradeSpec\Context\Upgrade;
use Sugarcrm\UpgradeSpec\Template\RendererAwareInterface;
use Sugarcrm\UpgradeSpec\Template\RendererAwareTrait;
use Symfony\Component\Finder\Finder;

class UpgradeChanges implements ElementInterface, RendererAwareInterface, DataAwareInterface
{
    use RendererAwareTrait, DataAwareTrait;

    /**
     * @return string
     */
    public function getTitle()
    {
        return 'Review upgrade changes and fix possible customization conflicts';
    }

    /**
     * @return int
     */
    public function getOrder()
    {
        return 3;
    }

    /**
     * @param Upgrade $context
     *
     * @return bool

     */
    public function isRelevantTo(Upgrade $context)
    {
        return $context->getTargetPath();
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 Upgrade $context
     *
     * @return string
     */
    public function getBody(Upgrade $context)
    {
        $customizations = $this->dataManager->getPotentiallyBrokenCustomizations($context);

        return $this->renderer->render('upgrade_changes', [
            'upgrade_steps' => $this->dataManager->getUpgradeSteps($context),
            'upgrade_to' => $context->getTargetVersion(),
            'upgrade_source' => $context->getTargetPath(),
            'modified_files' => $customizations['modified_files'],
            'deleted_files' => $customizations['deleted_files'],
        ]);
    }
}


1			<?php
2
3			namespace Sugarcrm\UpgradeSpec\Element\Section;
4
5			use Sugarcrm\UpgradeSpec\Data\DataAwareInterface;
6			use Sugarcrm\UpgradeSpec\Data\DataAwareTrait;
7			use Sugarcrm\UpgradeSpec\Element\ElementInterface;
8			use Sugarcrm\UpgradeSpec\Context\Upgrade;
9			use Sugarcrm\UpgradeSpec\Template\RendererAwareInterface;
10			use Sugarcrm\UpgradeSpec\Template\RendererAwareTrait;
11			use Symfony\Component\Finder\Finder;
12
13			class UpgradeChanges implements ElementInterface, RendererAwareInterface, DataAwareInterface
14			{
15			use RendererAwareTrait, DataAwareTrait;
16
17			/**
18			* @return string
19			*/
20			public function getTitle()
21			{
22			return 'Review upgrade changes and fix possible customization conflicts';
23			}
24
25			/**
26			* @return int
27			*/
28			public function getOrder()
29			{
30			return 3;
31			}
32
33			/**
34			* @param Upgrade $context
35			*
36			* @return bool
			0 ignored issues – show Documentation introduced 2017-02-06 15:13 UTC by Report Bug Copy Issue Report Should the return type not be `string`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
37			*/
38			public function isRelevantTo(Upgrade $context)
39			{
40			return $context->getTargetPath();
			0 ignored issues – show Bug Best Practice introduced 2017-02-06 15:13 UTC by Report Bug Copy Issue Report The return type of `return $context->getTargetPath();` (`string`) is incompatible with the return type declared by the interface `Sugarcrm\UpgradeSpec\Ele...Interface::isRelevantTo` of type `boolean`. 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...
41			}
42
43			/**
44			* @param Upgrade $context
45			*
46			* @return string
47			*/
48			public function getBody(Upgrade $context)
49			{
50			$customizations = $this->dataManager->getPotentiallyBrokenCustomizations($context);
51
52			return $this->renderer->render('upgrade_changes', [
53			'upgrade_steps' => $this->dataManager->getUpgradeSteps($context),
54			'upgrade_to' => $context->getTargetVersion(),
55			'upgrade_source' => $context->getTargetPath(),
56			'modified_files' => $customizations['modified_files'],
57			'deleted_files' => $customizations['deleted_files'],
58			]);
59			}
60			}
61

mikekamornikov / UpgradeSpec

Push — master ( 57b1db...16daf9 )

UpgradeChanges::getOrder() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like