Media - Code Metrics - Inspection of "Basic Media-RSS support" - alexdebril/feed-io - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#248)

unknown

created 2019-12-02 15:12 UTC

Media A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	99
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

97.37%

Importance

Changes

Metric	Value
wmc	15
lcom	1
cbo	3
dl	0
loc	99
ccs	37
cts	38
cp	0.9737
rs	10
c	0
b	0
f	0

6 Methods

Rating	Name	Size	Complexity
A	getUrlAttributeName()	4	1
A	setUrlAttributeName()	4	1
B	setProperty()	37	8
A	createMediaElement()	9	1
A	hasValue()	4	2
A	addElement()	6	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';

    const MRSS_NAMESPACE = "http://search.yahoo.com/mrss/";

    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->setNodeName($element->nodeName);

            if ($element->nodeName == "media:group" or $element->nodeName == "media:content")
            {
                $media->setTitle($this->getChildValue($element, 'title', static::MRSS_NAMESPACE));
                $media->setDescription($this->getChildValue($element, 'description', static::MRSS_NAMESPACE));
                $thumbnails = $element->getElementsByTagNameNS(static::MRSS_NAMESPACE, "thumbnail");
                if ($thumbnails->length > 0) {
                    $media->setThumbnail($this->getAttributeValue($thumbnails->item(0), "url"));

                }

                if ($element->nodeName == "media:content") {
                    $media->setUrl($this->getAttributeValue($element, "url"));
                }

                if ($element->nodeName == "media:group") {
                    $contents = $element->getElementsByTagNameNS(static::MRSS_NAMESPACE, "content");
                    if ($contents->length > 0) {
                        $media->setUrl($this->getAttributeValue($contents->item(0), "url"));

                    }
                }
            }
            else
            {
                $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		const MRSS_NAMESPACE = "http://search.yahoo.com/mrss/";
24
25		protected $urlAttributeName = 'url';
26
27		/**
28		* @return string
29		*/
30	5	public function getUrlAttributeName() : string
31		{
32	5	return $this->urlAttributeName;
33		}
34
35		/**
36		* @param string $name
37		*/
38	12	public function setUrlAttributeName(string $name) : void
39		{
40	12	$this->urlAttributeName = $name;
41	12	}
42
43		/**
44		* @param NodeInterface $node
45		* @param \DOMElement $element
46		*/
47	5	public function setProperty(NodeInterface $node, \DOMElement $element) : void
48		{
49	5	if ($node instanceof ItemInterface) {
50	5	$media = $node->newMedia();
51	5	$media->setNodeName($element->nodeName);
52
53	5	if ($element->nodeName == "media:group" or $element->nodeName == "media:content")
54		{
55	1	$media->setTitle($this->getChildValue($element, 'title', static::MRSS_NAMESPACE));
56	1	$media->setDescription($this->getChildValue($element, 'description', static::MRSS_NAMESPACE));
57	1	$thumbnails = $element->getElementsByTagNameNS(static::MRSS_NAMESPACE, "thumbnail");
58	1	if ($thumbnails->length > 0) {
59	1	$media->setThumbnail($this->getAttributeValue($thumbnails->item(0), "url"));
		0 ignored issues – show Compatibility introduced 2019-12-02 15:13 UTC by Report Bug Copy Issue Report `$thumbnails->item(0)` of type `object<DOMNode>` is not a sub-type of `object<DOMElement>`. It seems like you assume a child class of the class `DOMNode` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
60		}
61
62	1	if ($element->nodeName == "media:content") {
63		$media->setUrl($this->getAttributeValue($element, "url"));
64		}
65
66	1	if ($element->nodeName == "media:group") {
67	1	$contents = $element->getElementsByTagNameNS(static::MRSS_NAMESPACE, "content");
68	1	if ($contents->length > 0) {
69	1	$media->setUrl($this->getAttributeValue($contents->item(0), "url"));
		0 ignored issues – show Compatibility introduced 2019-12-02 15:13 UTC by Report Bug Copy Issue Report `$contents->item(0)` of type `object<DOMNode>` is not a sub-type of `object<DOMElement>`. It seems like you assume a child class of the class `DOMNode` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
70		}
71		}
72		}
73		else
74		{
75		$media
76	4	->setType($this->getAttributeValue($element, 'type'))
77	4	->setUrl($this->getAttributeValue($element, $this->getUrlAttributeName()))
78	4	->setLength($this->getAttributeValue($element, 'length'));
79
80		}
81	5	$node->addMedia($media);
82		}
83	5	}
84
85		/**
86		* @param \DomDocument $document
87		* @param MediaInterface $media
88		* @return \DomElement
89		*/
90	1	public function createMediaElement(\DomDocument $document, MediaInterface $media) : \DOMElement
91		{
92	1	$element = $document->createElement($this->getNodeName());
93	1	$element->setAttribute($this->getUrlAttributeName(), $media->getUrl());
94	1	$element->setAttribute('type', $media->getType() ?? '');
95	1	$element->setAttribute('length', $media->getLength() ?? '');
96
97	1	return $element;
98		}
99
100		/**
101		* @inheritDoc
102		*/
103	5	protected function hasValue(NodeInterface $node) : bool
104		{
105	5	return $node instanceof ItemInterface && !! $node->getMedias();
106		}
107
108		/**
109		* @inheritDoc
110		*/
111	5	protected function addElement(\DomDocument $document, \DOMElement $rootElement, NodeInterface $node) : void
112		{
113	5	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...
114	1	$rootElement->appendChild($this->createMediaElement($document, $media));
115		}
116	5	}
117		}
118

alexdebril / feed-io

Pull Request — master (#248)

Media A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

6 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like