Taisiya\PropelBundle\XMLAssertsTrait

Complexity

Total Complexity

8

Size/Duplication

Total Lines	56
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	assertXmlHasProlog()	0	4	1
A	assertXmlHasElements()	0	15	3
A	toXPath()	0	15	4

<?php

namespace Taisiya\PropelBundle;

/**
 * @target \PHPUnit_Framework_Assert
 */
trait XMLAssertsTrait
{
    /**
     * @param string|\DOMDocument $xml
     * @param string $version
     * @param string $encoding
     * @param string $message
     */
    public function assertXmlHasProlog($xml, $version = '1.0', $encoding = 'UTF-8', string $message = ''): void
    {
        $this->assertSame(0, strpos($xml, '<?xml version="'.$version.'" encoding="'.$encoding.'"?>'), $message);

It seems like assertSame() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * @param string|\DOMDocument $xml
     * @param string $query
     * @param int|null $count
     * @param string $message
     */
    public function assertXmlHasElements($xml, string $query, int $count = null, string $message = '')
    {
        if ($message === '') {
            $message = 'XML has elements (XPath query is \''.$query.'\')';
        }

        $xpath = $this->toXPath($xml);
        $list = $xpath->query($query);

        if ($count === null) {
            $this->assertGreaterThan(0, $list->length, $message);

It seems like assertGreaterThan() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        } else {
            $this->assertSame($count, $list->length, $message);

It seems like assertSame() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }
    }

    /**
     * @param string|\DOMDocument $xml
     * @throws \InvalidArgumentException
     * @return \DOMXPath
     */
    private function toXPath($xml): \DOMXPath
    {
        if ($xml instanceof \DOMDocument) {
            $dom = $xml;
        } elseif (is_string($xml)) {
            $dom = new \DOMDocument('1.0', 'UTF-8');
            if (!$dom->loadXML($xml)) {
                throw new \InvalidArgumentException('Couldn\'t load XML string to DOM object');
            }
        } else {
            throw new \InvalidArgumentException('XML must be a string or DOMDocument');
        }

        return new \DOMXPath($dom);
    }
}