tests/FeedIo/Rule/OptionalFieldTest.php
<?php
/**
 * Created by PhpStorm.
 * User: alex
 * Date: 11/12/14
 * Time: 22:54
 */

namespace FeedIo\Rule;

use FeedIo\Feed\Item;
use FeedIo\Feed\Node\Element;
use FeedIo\Feed\Node\ElementInterface;

use PHPUnit\Framework\TestCase;

class OptionalFieldTest extends TestCase
{
    /**
     * @var OptionalField
     */
    protected $object;

    protected function setUp(): void
    {
        $this->object = new OptionalField();
    }

    public function testSetProperty()
    {
        $document = new \DomDocument();
        $element = $document->createElement('test', 'a test value');
        $element->setAttribute('foo', 'bar');

        $item = new Item();
        $this->object->setProperty($item, $element);

        $this->assertTrue($item->hasElement('test'));
        $this->assertEquals('a test value', $item->getValue('test'));

        $itemElements = $item->getElementIterator('test');

        $count = 0;
        /** @var Element $itemElement */
        foreach ($itemElements as $itemElement) {
            $count++;
            $this->assertEquals('bar', $itemElement->getAttribute('foo'));
        }

        $this->assertEquals(1, $count);

        $subCount = 0;
        foreach ($itemElement->getAllElements() as $subElement) {
            $count++;
        }

        $this->assertEquals(0, $subCount);
    }

    public function testSetPropertyElementWithSubElements()
    {
        $document = new \DOMDocument();
        $element = $document->createElement('test');

        $subElementValues = [
            'sub-test' => 'a test value',
            'sub-test-2' => 'a test value 2'
        ];

        foreach ($subElementValues as $name => $value) {
            $element->appendChild($document->createElement($name, $value));
        }

        $item = new Item();
        $this->object->setProperty($item, $element);

        $testElementIterator = $item->getElementIterator('test');

        $subElementCount = 0;
        /** @var ElementInterface $testElement */
        foreach ($testElementIterator as $testElement) {
            $subTestElementIterator = $testElement->getAllElements();

            if (null === $subTestElementIterator) {
                $this->fail('No sub elements found but expected');
                return;
            }

            $subTestElement = null;
            foreach ($subTestElementIterator as $subTestElement) {
                $subElementCount++;
                $expectedValue = array_shift($subElementValues);
                /** @var ElementInterface $subTestElement */
                $this->assertEquals($expectedValue, $subTestElement->getValue());
            }
        }
        $this->assertEquals(2, $subElementCount);
    }

    public function testCreateElement()
    {
        $item = new Item();
        $item->set('default', 'a test value');

        $document = new \DOMDocument();
        $rootElement = $document->createElement('feed');

        $this->object->apply($document, $rootElement, $item);
        $addedElement = $rootElement->firstChild;

        $this->assertEquals('default', $addedElement->nodeName);
        $this->assertEquals('a test value', $addedElement->nodeValue);
    }

    public function testCreateElementWithSubElements()
    {
        $subElement = new Element();
        $subElement->setName('subDefault');
        $subElement->setValue('defaultValue');

        $element = new Element();
        $element->setName('default');
        $element->addElement($subElement);

        $item = new Item();
        $item->addElement($element);

        $document = new \DOMDocument();
        $rootElement = $document->createElement('feed');

        $this->object->apply($document, $rootElement, $item);

        $firstElement = $rootElement->firstChild;
        $subElementCount = 0;

        /** @var \DOMNode $childNode */
        foreach ($firstElement->childNodes as $childNode) {
            if ($childNode instanceof \DOMText) {
                continue;
            }
            $subElementCount++;

            $this->assertEquals('subDefault', $childNode->nodeName);
            $this->assertEquals('defaultValue', $childNode->nodeValue);
        }

        $this->assertEquals(1, $subElementCount);
        $document->appendChild($rootElement);

        $this->assertXmlStringEqualsXmlString('<feed><default><subDefault>defaultValue</subDefault></default></feed>', $document->saveXML());
    }

    public function testCreateElementWithAttributes()
    {
        $element = new Element();
        $element->setName('default');
        $element->setValue('value');
        $element->setAttribute('foo', 'bar');

        $item = new Item();
        $item->addElement($element);

        $document = new \DOMDocument();
        $rootElement = $document->createElement('feed');

        $this->object->apply($document, $rootElement, $item);

        $domElement = $rootElement->firstChild;
        $this->assertEquals('default', $domElement->nodeName);
        $this->assertEquals('value', $domElement->nodeValue);

        $this->assertTrue($domElement->hasAttribute('foo'));
    }

    public function testCreateMultipleElements()
    {
        $item = new Item();
        $item->set('default', 'first value');
        $item->set('default', 'second value');

        $document = new \DOMDocument();
        $rootElement = $document->createElement('feed');

        $this->object->apply($document, $rootElement, $item);

        $this->assertEquals(2, $rootElement->childNodes->count());

        $this->assertEquals('default', $rootElement->childNodes->item(0)->nodeName);
        $this->assertEquals('first value', $rootElement->childNodes->item(0)->nodeValue);

        $this->assertEquals('default', $rootElement->childNodes->item(1)->nodeName);
        $this->assertEquals('second value', $rootElement->childNodes->item(1)->nodeValue);
    }

    public function testDontCreateElement()
    {
        $item = new Item();
        $item->set('another', 'a test value');

        $document = new \DOMDocument();
        $rootElement = $document->createElement('feed');

        $this->object->apply($document, $rootElement, $item);

        $element = $rootElement->firstChild;

        $this->assertEquals('default', $element->nodeName);
        $this->assertEquals('', $element->nodeValue);
    }
}
