Author::addElement() - Code Metrics - Inspection of "Issue/121" - alexdebril/feed-io - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — project/php-7 (#133)

by Alex

created 2017-08-02 09:52 UTC

Author::addElement() A

↳ Parent: Author

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	4
ccs	3
cts	3
cp	1
rs	10
cc	1
eloc	2
nc	1
nop	3
crap	1

<?php
/*
 * This file is part of the feed-io package.
 *
 * (c) Alexandre Debril <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace FeedIo\Rule;

use FeedIo\Feed\ItemInterface;
use FeedIo\Feed\NodeInterface;
use FeedIo\RuleAbstract;

class Author extends RuleAbstract
{
    const NODE_NAME = 'author';

    /**
     * Sets the accurate $item property according to the DomElement content
     *
     * @param  NodeInterface $node
     * @param  \DOMElement   $element
     * @return mixed
     */
    public function setProperty(NodeInterface $node, \DOMElement $element)
    {
        if ($node instanceof ItemInterface) {
            $author = $node->newAuthor();
            $author->setName($element->nodeValue);
            $node->setAuthor($author);
        }

        return $this;
    }

    /**
     * Tells if the node contains the expected value
     *
     * @param NodeInterface $node
     * @return bool
     */
    protected function hasValue(NodeInterface $node) : bool
    {
        return $node instanceof ItemInterface && !! $node->getAuthor();
    }

    /**
     * Creates and adds the element(s) to the docuement's rootElement
     *
     * @param \DomDocument $document
     * @param \DOMElement $rootElement
     * @param NodeInterface $node
     */
    protected function addElement(\DomDocument $document, \DOMElement $rootElement, NodeInterface $node) : void
    {
        $rootElement->appendChild($document->createElement($this->getNodeName(), $node->getAuthor()->getName()));
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.
    }
}
    }
}


1		<?php
2		/*
3		* This file is part of the feed-io package.
4		*
5		* (c) Alexandre Debril <[email protected]>
6		*
7		* For the full copyright and license information, please view the LICENSE
8		* file that was distributed with this source code.
9		*/
10
11		namespace FeedIo\Rule;
12
13		use FeedIo\Feed\ItemInterface;
14		use FeedIo\Feed\NodeInterface;
15		use FeedIo\RuleAbstract;
16
17		class Author extends RuleAbstract
18		{
19		const NODE_NAME = 'author';
20
21		/**
22		* Sets the accurate $item property according to the DomElement content
23		*
24		* @param NodeInterface $node
25		* @param \DOMElement $element
26		* @return mixed
27		*/
28	3	public function setProperty(NodeInterface $node, \DOMElement $element)
29		{
30	3	if ($node instanceof ItemInterface) {
31	3	$author = $node->newAuthor();
32	3	$author->setName($element->nodeValue);
33	3	$node->setAuthor($author);
34		}
35
36	3	return $this;
37		}
38
39		/**
40		* Tells if the node contains the expected value
41		*
42		* @param NodeInterface $node
43		* @return bool
44		*/
45	4	protected function hasValue(NodeInterface $node) : bool
46		{
47	4	return $node instanceof ItemInterface && !! $node->getAuthor();
48		}
49
50		/**
51		* Creates and adds the element(s) to the docuement's rootElement
52		*
53		* @param \DomDocument $document
54		* @param \DOMElement $rootElement
55		* @param NodeInterface $node
56		*/
57	1	protected function addElement(\DomDocument $document, \DOMElement $rootElement, NodeInterface $node) : void
58		{
59	1	$rootElement->appendChild($document->createElement($this->getNodeName(), $node->getAuthor()->getName()));
		0 ignored issues – show Bug introduced 2017-08-01 15:46 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `FeedIo\Feed\NodeInterface` as the method `getAuthor()` does only exist in the following implementations of said interface: `FeedIo\Feed\Item`. 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...
60	1	}
61		}
62

alexdebril / feed-io

Pull Request — project/php-7 (#133)

Author::addElement() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like