RendererBuilderFixedText::instantiateRenderer() - Code Metrics - Inspection of "Refactor" - graze/ciff-renderer - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#18)

by John

created 2016-11-22 22:30 UTC

RendererBuilderFixedText::instantiateRenderer() A

↳ Parent: RendererBuilderFixedText

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	4
Ratio	100 %

Importance

Changes

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

<?php

namespace Graze\CiffRenderer\Field\Renderer\Builder;

use Graze\CiffRenderer\Field\Builder\AbstractBuilder;
use Graze\CiffRenderer\Field\Parser\FixedTextParser;
use Graze\CiffRenderer\Field\Renderer\FixedTextRenderer;
use Graze\CiffRenderer\Field\Parser\ParserInterface;
use Graze\CiffRenderer\Field\Renderer\RendererInterface;
use Graze\CiffRenderer\Exception\RuntimeException;

class RendererBuilderFixedText extends AbstractRendererBuilder

{
    /**
     * @return FixedTextParser
     */
    protected function instantiateParser()
    {
        return new FixedTextParser();
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 ParserInterface $parser
     *
     * @return ParserInterface

     */
    protected function instantiateRenderer(ParserInterface $parser)
    {
        return new FixedTextRenderer();
    }

    /**
     * @param RendererInterface $renderer
     * @param ParserInterface $parser
     *
     * @return RendererInterface
     *
     * @throws RuntimeException
     */
    public function buildRenderer(RendererInterface $renderer, ParserInterface $parser)
    {
        $render = parent::buildRenderer($renderer, $parser);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        $fontResolver = $this->getFontResolver();
        if (!$fontResolver) {
            throw new RuntimeException('Font resolver not set');
        }

        $renderer->setFontResolver($fontResolver);
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.
    }
}
        return $renderer;
    }
}


1		<?php
2
3		namespace Graze\CiffRenderer\Field\Renderer\Builder;
4
5		use Graze\CiffRenderer\Field\Builder\AbstractBuilder;
6		use Graze\CiffRenderer\Field\Parser\FixedTextParser;
7		use Graze\CiffRenderer\Field\Renderer\FixedTextRenderer;
8		use Graze\CiffRenderer\Field\Parser\ParserInterface;
9		use Graze\CiffRenderer\Field\Renderer\RendererInterface;
10		use Graze\CiffRenderer\Exception\RuntimeException;
11
12	View Code Duplication	class RendererBuilderFixedText extends AbstractRendererBuilder
		0 ignored issues – show Duplication introduced 2016-11-22 22:34 UTC by Report Bug Copy Issue Report This class seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
13		{
14		/**
15		* @return FixedTextParser
16		*/
17		protected function instantiateParser()
18		{
19		return new FixedTextParser();
		0 ignored issues – show Bug Best Practice introduced 2016-11-22 22:34 UTC by Report Bug Copy Issue Report The return type of `return new \Graze\CiffRe...rser\FixedTextParser();` (`Graze\CiffRenderer\Field\Parser\FixedTextParser`) is incompatible with the return type declared by the abstract method `Graze\CiffRenderer\Field...lder::instantiateParser` of type `Graze\CiffRenderer\Field\Parser\ParserInterface`. 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...
20		}
21
22		/**
23		* @param ParserInterface $parser
24		*
25		* @return ParserInterface
		0 ignored issues – show Documentation introduced 2016-11-17 21:37 UTC by Report Bug Copy Issue Report Should the return type not be `FixedTextRenderer`? 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...
26		*/
27		protected function instantiateRenderer(ParserInterface $parser)
28		{
29		return new FixedTextRenderer();
30		}
31
32		/**
33		* @param RendererInterface $renderer
34		* @param ParserInterface $parser
35		*
36		* @return RendererInterface
37		*
38		* @throws RuntimeException
39		*/
40		public function buildRenderer(RendererInterface $renderer, ParserInterface $parser)
41		{
42		$render = parent::buildRenderer($renderer, $parser);
		0 ignored issues – show Unused Code introduced 2016-04-23 16:33 UTC by Report Bug Copy Issue Report `$render` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
43
44		$fontResolver = $this->getFontResolver();
45		if (!$fontResolver) {
46		throw new RuntimeException('Font resolver not set');
47		}
48
49		$renderer->setFontResolver($fontResolver);
		0 ignored issues – show Bug introduced 2016-04-23 16:33 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Graze\CiffRenderer\Field...derer\RendererInterface` as the method `setFontResolver()` does only exist in the following implementations of said interface: `Graze\CiffRenderer\Field\Renderer\BarcodeRenderer`, `Graze\CiffRenderer\Field...derer\FixedTextRenderer`. 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		return $renderer;
51		}
52		}
53

graze / ciff-renderer

Pull Request — master (#18)

RendererBuilderFixedText::instantiateRenderer() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like