RssParser - Code Metrics - Inspection of "Release/2.5" - alexdebril/rss-atom-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#122)

by Alex

created 2016-10-04 21:37 UTC

RssParser A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	204
Duplicated Lines	4.41 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

86.81%

Importance

Changes

Metric	Value
wmc	22
lcom	1
cbo	5
dl	9
loc	204
ccs	79
cts	91
cp	0.8681
rs	10
c	0
b	0
f	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	canHandle()	0	4	1
B	parseBody()	0	49	5
A	detectAndSetLastModified()	0	10	3
A	setLastModified()	0	6	1
A	handleEnclosure()	0	11	3
A	handleDescription()	0	11	2
A	handleMediaExtension()	0	12	2
A	parseCategories()	9	9	2
A	handleAuthor()	0	10	2

How to fix Duplicated Code

<?php

/**
 * Rss/Atom Bundle for Symfony.
 *
 *
 * @license http://opensource.org/licenses/lgpl-3.0.html LGPL
 * @copyright (c) 2013, Alexandre Debril
 */
namespace Debril\RssAtomBundle\Protocol\Parser;

use Debril\RssAtomBundle\Protocol\FeedInterface;
use Debril\RssAtomBundle\Protocol\ItemInInterface;
use Debril\RssAtomBundle\Protocol\Parser;
use SimpleXMLElement;

/**
 * Class RssParser.
 * @deprecated removed in version 3.0
 */
class RssParser extends Parser
{
    protected $mandatoryFields = array(
        'channel',
    );

    /**
     *
     * @deprecated removed in version 3.0
     */
    public function __construct()
    {
        $this->setdateFormats(array(\DateTime::RSS));

    }

    /**
     * @param SimpleXMLElement $xmlBody
     *
     * @return bool
     * @deprecated removed in version 3.0
     */
    public function canHandle(SimpleXMLElement $xmlBody)
    {
        return 'rss' === strtolower($xmlBody->getName());
    }

    /**
     * @param SimpleXMLElement $xmlBody
     * @param FeedInterface    $feed
     * @param array            $filters
     *
     * @return FeedInterface
     */
    protected function parseBody(SimpleXMLElement $xmlBody, FeedInterface $feed, array $filters)
    {
        $namespaces = $xmlBody->getNamespaces(true);

        $feed->setPublicId($xmlBody->channel->link);

        $feed->setLink($xmlBody->channel->link);

        $feed->setTitle($xmlBody->channel->title);

        $feed->setDescription($xmlBody->channel->description);


        $latest = new \DateTime('@0');
        $date = new \DateTime('now');
        foreach ($xmlBody->channel->item as $xmlElement) {
            $item = $this->newItem();


            if (isset($xmlElement->pubDate)) {
                $readDate = trim($xmlElement->pubDate);

                $format = isset($format) ? $format : $this->guessDateFormat($readDate);

                $date = static::convertToDateTime($readDate, $format);

            }

            $item->setTitle($xmlElement->title)

                 ->setDescription($xmlElement->description)
                 ->setPublicId($xmlElement->guid)
                 ->setUpdated($date)
                 ->setLink($xmlElement->link)
                 ->setComment($xmlElement->comments);

            if ($date > $latest) {
                $latest = $date;
            }

            $this->parseCategories($xmlElement, $item);

            $this->handleAuthor($xmlElement, $item);
            $this->handleDescription($xmlElement, $item);

            $item->setAdditional($this->getAdditionalNamespacesElements($xmlElement, $namespaces));

            $this->handleEnclosure($xmlElement, $item);
            $this->handleMediaExtension($xmlElement, $item);

            $this->addValidItem($feed, $item, $filters);

        }

        $this->detectAndSetLastModified($xmlBody, $feed, $latest);

        return $feed;
    }

    /**
     * @param SimpleXMLElement $xmlBody
     * @param FeedInterface    $feed
     * @param $latestItemDate
     */
    protected function detectAndSetLastModified(SimpleXMLElement $xmlBody, FeedInterface $feed, $latestItemDate)
    {
        if (isset($xmlBody->channel->lastBuildDate)) {
            $this->setLastModified($feed, $xmlBody->channel->lastBuildDate);
        } elseif (isset($xmlBody->channel->pubDate)) {
            $this->setLastModified($feed, $xmlBody->channel->pubDate);
        } else {
            $feed->setLastModified($latestItemDate);

        }
    }

    /**
     * @param FeedInterface $feed
     * @param string        $rssDate
     */
    protected function setLastModified(FeedInterface $feed, $rssDate)
    {
        $format = $this->guessDateFormat($rssDate);

        $updated = static::convertToDateTime($rssDate, $format);

        $feed->setLastModified($updated);

    }

    /**
     * Handles enclosures if any.
     *
     * @param SimpleXMLElement $element
     * @param ItemInInterface  $item
     *
     * @return $this
     */
    protected function handleEnclosure(SimpleXMLElement $element, ItemInInterface $item)
    {
        if (isset($element->enclosure)) {
            foreach ($element->enclosure as $enclosure) {
                $media = $this->createMedia($enclosure);

                $item->addMedia($media);

            }
        }

        return $this;
    }

    /**
     * According to RSS specs, either we can have a summary in description ;
     * full content in description ; or a summary in description AND full content in content:encoded
     *
     * @param SimpleXMLElement $xmlElement
     * @param ItemInInterface $item
     */
    protected function handleDescription(SimpleXMLElement $xmlElement, ItemInInterface $item)
    {
        $contentChild = $xmlElement->children('http://purl.org/rss/1.0/modules/content/');

        if (isset($contentChild->encoded)) {
            $item->setDescription($contentChild->encoded);

            $item->setSummary($xmlElement->description);

        } else {
            $item->setDescription($xmlElement->description);

        }
    }

    /**
     * Parse elements from Yahoo RSS Media extension
     *
     * @param SimpleXMLElement $xmlElement
     * @param ItemInInterface $item with Media added
     */
    protected function handleMediaExtension(SimpleXMLElement $xmlElement, ItemInInterface $item)
    {
        foreach ($xmlElement->children('http://search.yahoo.com/mrss/') as $xmlMedia) {
            $media = new Media();

            $media->setUrl($this->getAttributeValue($xmlMedia, 'url'))

                ->setType($this->searchAttributeValue($xmlMedia, array('type', 'medium')))

                ->setLength($this->getAttributeValue($xmlMedia, 'fileSize'))

            ;

            $item->addMedia($media);

        }
    }

    /**
     * Parse category elements.
     * We may have more than one.
     *
     * @param SimpleXMLElement $element
     * @param ItemInInterface $item
     */
    protected function parseCategories(SimpleXMLElement $element, ItemInInterface $item)

    {
        foreach ($element->category as $xmlCategory) {
            $category = new Category();

            $category->setName((string) $xmlCategory);


            $item->addCategory($category);

        }
    }

    /**
     * Parse author:
     * first we look at optional dc:creator, which is the author name
     * if no, we fallback to the RSS author element which is the author email
     *
     * @param SimpleXMLElement $element
     * @param ItemInInterface $item
     */
    protected function handleAuthor(SimpleXMLElement $element, ItemInInterface $item)
    {
        $dcChild = $element->children('http://purl.org/dc/elements/1.1/');

        if (isset($dcChild->creator)) {
            $item->setAuthor((string) $dcChild->creator);

        } else {
            $item->setAuthor((string) $element->author);

        }
    }
}


1		<?php
2
3		/**
4		* Rss/Atom Bundle for Symfony.
5		*
6		*
7		* @license http://opensource.org/licenses/lgpl-3.0.html LGPL
8		* @copyright (c) 2013, Alexandre Debril
9		*/
10		namespace Debril\RssAtomBundle\Protocol\Parser;
11
12		use Debril\RssAtomBundle\Protocol\FeedInterface;
13		use Debril\RssAtomBundle\Protocol\ItemInInterface;
14		use Debril\RssAtomBundle\Protocol\Parser;
15		use SimpleXMLElement;
16
17		/**
18		* Class RssParser.
19		* @deprecated removed in version 3.0
20		*/
21		class RssParser extends Parser
22		{
23		protected $mandatoryFields = array(
24		'channel',
25		);
26
27		/**
28		*
29		* @deprecated removed in version 3.0
30		*/
31	3	public function __construct()
32		{
33	3	$this->setdateFormats(array(\DateTime::RSS));
		0 ignored issues – show Deprecated Code introduced 2016-10-04 21:39 UTC by Report Bug Copy Issue Report The method `Debril\RssAtomBundle\Pro...arser::setDateFormats()` has been deprecated with message: removed in version 3.0 This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
34	3	}
35
36		/**
37		* @param SimpleXMLElement $xmlBody
38		*
39		* @return bool

alexdebril / rss-atom-bundle

Pull Request — master (#122)

RssParser A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

10 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like