Base::doClean() - Code Metrics - Inspection of "Added Null Object pattern for logger. Added tests..." - kevintweber/Groundskeeper - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a17ead...35004c )

by Kevin

created 2016-05-04 01:42 UTC

Base::doClean() B

↳ Parent: Base

Complexity

Conditions	5
Paths	3

Size

Total Lines	18
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	14.6179

Importance

Changes	3
Bugs	0	Features	2

Metric	Value
c	3
b	0
f	2
dl	0
loc	18
ccs	3
cts	11
cp	0.2727
rs	8.8571
cc	5
eloc	8
nc	3
nop	1
crap	14.6179

<?php

namespace Groundskeeper\Tokens\Elements;

use Groundskeeper\Tokens\Element;
use Groundskeeper\Tokens\ElementTypes\ClosedElement;
use Groundskeeper\Tokens\ElementTypes\MetadataContent;
use Psr\Log\LoggerInterface;

/**
 * "base" element
 */
class Base extends ClosedElement implements MetadataContent
{
    protected function getAllowedAttributes()
    {
        $baseAllowedAttributes = array(
            '/^href$/i' => Element::ATTR_URI,
            '/^target$/i' => Element::ATTR_CS_STRING
        );

        return array_merge(
            $baseAllowedAttributes,
            parent::getAllowedAttributes()
        );
    }

    protected function doClean(LoggerInterface $logger)
    {
        // "base" element must be child of "head" element.
        if ($this->getParent() !== null && $this->getParent()->getName() !== 'head') {
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.
    }
}
            $logger->debug('Element "base" must be a "head" element child.');

            return false;
        }

        // Must have either "href" or "target" attribute or both.
        if (!$this->hasAttribute('href') && !$this->hasAttribute('target')) {
            $logger->debug('Element "base" must have either the "href" or "target" attribute or both.');

            return false;
        }

        return true;
    }
}


1		<?php
2
3		namespace Groundskeeper\Tokens\Elements;
4
5		use Groundskeeper\Tokens\Element;
6		use Groundskeeper\Tokens\ElementTypes\ClosedElement;
7		use Groundskeeper\Tokens\ElementTypes\MetadataContent;
8		use Psr\Log\LoggerInterface;
9
10		/**
11		* "base" element
12		*/
13		class Base extends ClosedElement implements MetadataContent
14		{
15	1	protected function getAllowedAttributes()
16		{
17		$baseAllowedAttributes = array(
18	1	'/^href$/i' => Element::ATTR_URI,
19		'/^target$/i' => Element::ATTR_CS_STRING
20	1	);
21
22	1	return array_merge(
23	1	$baseAllowedAttributes,
24	1	parent::getAllowedAttributes()
25	1	);
26		}
27
28	1	protected function doClean(LoggerInterface $logger)
29		{
30		// "base" element must be child of "head" element.
31	1	if ($this->getParent() !== null && $this->getParent()->getName() !== 'head') {
		0 ignored issues – show Bug introduced 2016-05-02 01:49 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Groundskeeper\Tokens\Token` as the method `getName()` does only exist in the following implementations of said interface: `Groundskeeper\Tokens\Element`, `Groundskeeper\Tokens\ElementTypes\ClosedElement`, `Groundskeeper\Tokens\ElementTypes\OpenElement`, `Groundskeeper\Tokens\Elements\Article`, `Groundskeeper\Tokens\Elements\Aside`, `Groundskeeper\Tokens\Elements\Base`, `Groundskeeper\Tokens\Elements\Body`, `Groundskeeper\Tokens\Elements\Br`, `Groundskeeper\Tokens\Elements\Footer`, `Groundskeeper\Tokens\Elements\H1`, `Groundskeeper\Tokens\Elements\H2`, `Groundskeeper\Tokens\Elements\H3`, `Groundskeeper\Tokens\Elements\H4`, `Groundskeeper\Tokens\Elements\H5`, `Groundskeeper\Tokens\Elements\H6`, `Groundskeeper\Tokens\Elements\Head`, `Groundskeeper\Tokens\Elements\Header`, `Groundskeeper\Tokens\Elements\Hgroup`, `Groundskeeper\Tokens\Elements\Hr`, `Groundskeeper\Tokens\Elements\Html`, `Groundskeeper\Tokens\Elements\Link`, `Groundskeeper\Tokens\Elements\Main`, `Groundskeeper\Tokens\Elements\Meta`, `Groundskeeper\Tokens\Elements\Nav`, `Groundskeeper\Tokens\Elements\Noscript`, `Groundskeeper\Tokens\Elements\Script`, `Groundskeeper\Tokens\Elements\Section`, `Groundskeeper\Tokens\Elements\Style`, `Groundskeeper\Tokens\Elements\Template`, `Groundskeeper\Tokens\Elements\Title`. 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...
32		$logger->debug('Element "base" must be a "head" element child.');
33
34		return false;
35		}
36
37		// Must have either "href" or "target" attribute or both.
38		if (!$this->hasAttribute('href') && !$this->hasAttribute('target')) {
39		$logger->debug('Element "base" must have either the "href" or "target" attribute or both.');
40	1
41		return false;
42		}
43
44		return true;
45		}
46		}
47

kevintweber / Groundskeeper

Push — master ( a17ead...35004c )

Base::doClean() B

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like