Media::addElement() - Code Metrics - Inspection of "Merge pull request #147 from alexdebril/project/ph..." - alexdebril/feed-io - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 4c7da2...64af60 )

by Alex

created 2017-10-04 12:43 UTC

Media::addElement() A

↳ Parent: Media

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Importance

Changes

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

<?php declare(strict_types=1);
/*
 * 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\Item;
use FeedIo\Feed\Item\MediaInterface;
use FeedIo\Feed\ItemInterface;
use FeedIo\Feed\NodeInterface;
use FeedIo\RuleAbstract;

class Media extends RuleAbstract
{
    const NODE_NAME = 'enclosure';

    protected $urlAttributeName = 'url';

    /**
     * @return string
     */
    public function getUrlAttributeName() : string
    {
        return $this->urlAttributeName;
    }

    /**
     * @param  string $name
     */
    public function setUrlAttributeName(string $name) : void
    {
        $this->urlAttributeName = $name;
    }

    /**
     * @param  NodeInterface $node
     * @param  \DOMElement   $element
     */
    public function setProperty(NodeInterface $node, \DOMElement $element) : void
    {
        if ($node instanceof ItemInterface) {
            $media = $node->newMedia();
            $media->setType($this->getAttributeValue($element, 'type'))
                ->setUrl($this->getAttributeValue($element, $this->getUrlAttributeName()))
                ->setLength($this->getAttributeValue($element, 'length'));

            $node->addMedia($media);
        }
    }

    /**
     * @param  \DomDocument   $document
     * @param  MediaInterface $media
     * @return \DomElement
     */
    public function createMediaElement(\DomDocument $document, MediaInterface $media) : \DOMElement

    {
        $element = $document->createElement($this->getNodeName());
        $element->setAttribute($this->getUrlAttributeName(), $media->getUrl());
        $element->setAttribute('type', $media->getType() ?? '');
        $element->setAttribute('length', $media->getLength() ?? '');

        return $element;
    }

    /**
     * @inheritDoc
     */
    protected function hasValue(NodeInterface $node) : bool
    {
        return $node instanceof ItemInterface && !! $node->getMedias();
    }

    /**
     * @inheritDoc
     */
    protected function addElement(\DomDocument $document, \DOMElement $rootElement, NodeInterface $node) : void
    {
        foreach ($node->getMedias() as $media) {
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.
    }
}
            $rootElement->appendChild($this->createMediaElement($document, $media));
        }
    }
}


1			<?php declare(strict_types=1);
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\Item;
14			use FeedIo\Feed\Item\MediaInterface;
15			use FeedIo\Feed\ItemInterface;
16			use FeedIo\Feed\NodeInterface;
17			use FeedIo\RuleAbstract;
18
19			class Media extends RuleAbstract
20			{
21			const NODE_NAME = 'enclosure';
22
23			protected $urlAttributeName = 'url';
24
25			/**
26			* @return string
27			*/
28	5		public function getUrlAttributeName() : string
29			{
30	5		return $this->urlAttributeName;
31			}
32
33			/**
34			* @param string $name
35			*/
36	9		public function setUrlAttributeName(string $name) : void
37			{
38	9		$this->urlAttributeName = $name;
39	9		}
40
41			/**
42			* @param NodeInterface $node
43			* @param \DOMElement $element
44			*/
45	4		public function setProperty(NodeInterface $node, \DOMElement $element) : void
46			{
47	4		if ($node instanceof ItemInterface) {
48	4		$media = $node->newMedia();
49	4		$media->setType($this->getAttributeValue($element, 'type'))
50	4		->setUrl($this->getAttributeValue($element, $this->getUrlAttributeName()))
51	4		->setLength($this->getAttributeValue($element, 'length'));
52
53	4		$node->addMedia($media);
54			}
55	4		}
56
57			/**
58			* @param \DomDocument $document
59			* @param MediaInterface $media
60			* @return \DomElement
61			*/
62	1	View Code Duplication	public function createMediaElement(\DomDocument $document, MediaInterface $media) : \DOMElement
			0 ignored issues – show Duplication introduced 2017-08-08 20:55 UTC by Report Bug Copy Issue Report This method 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...
63			{
64	1		$element = $document->createElement($this->getNodeName());
65	1		$element->setAttribute($this->getUrlAttributeName(), $media->getUrl());
66	1		$element->setAttribute('type', $media->getType() ?? '');
67	1		$element->setAttribute('length', $media->getLength() ?? '');
68
69	1		return $element;
70			}
71
72			/**
73			* @inheritDoc
74			*/
75	2		protected function hasValue(NodeInterface $node) : bool
76			{
77	2		return $node instanceof ItemInterface && !! $node->getMedias();
78			}
79
80			/**
81			* @inheritDoc
82			*/
83	2		protected function addElement(\DomDocument $document, \DOMElement $rootElement, NodeInterface $node) : void
84			{
85	2		foreach ($node->getMedias() as $media) {
			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 `getMedias()` 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...
86	1		$rootElement->appendChild($this->createMediaElement($document, $media));
87			}
88	2		}
89			}
90

alexdebril / feed-io

Push — master ( 4c7da2...64af60 )

Media::addElement() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like