HTML-DOM/tests/cases/TestElement.php

<?php
/**
 * @license MIT
 * Copyright 2017, Dustin Wilson, J. King et al.
 * See LICENSE and AUTHORS files for details
 */

declare(strict_types=1);
namespace MensBeam\HTML\DOM\TestCase;

use MensBeam\HTML\DOM\{
    Document,
    DOMException,
    Element,
    ElementMap,
    HTMLTemplateElement
};
use MensBeam\HTML\Parser;


/** @covers \MensBeam\HTML\DOM\Element */
class TestElement extends \PHPUnit\Framework\TestCase {
    /** @covers \MensBeam\HTML\DOM\Element::getAttributeNames */
    public function testGetAttributeNames(): void {
        $d = new Document();
        $e = $d->createElement('html');
        $d->appendChild($e);

        $this->assertSame([], $e->getAttributeNames());

        $e->setAttribute('ook:eek', 'ook');
        $e->setAttributeNS(Parser::XMLNS_NAMESPACE, 'xmlns:xlink', Parser::XLINK_NAMESPACE);
        $e->setAttribute('ook', 'eek');

        $this->assertSame([
            'ook:eek',
            'xmlns:xlink',
            'ook'
        ], $e->getAttributeNames());
    }

    public function provideGetHasSetAttribute(): iterable {
        return [
            [ 'ook', 'eek', 'ook', 'eek' ],
            [ 'ook:eek', 'ook', 'ook:eek', 'ook' ],
            [ 'poop💩', 'soccer', 'poop💩', 'soccer' ]
        ];
    }

    /**
     * @dataProvider provideGetHasSetAttribute
     * @covers \MensBeam\HTML\DOM\Element::getAttribute
     * @covers \MensBeam\HTML\DOM\Element::hasAttribute
     * @covers \MensBeam\HTML\DOM\Element::setAttribute
     */
    public function testGetHasSetAttribute(string $nameIn, string $valueIn, string $nameExpected, string $valueExpected): void {
        $d = new Document();
        $d->appendChild($d->createElement('html'));
        $e = $d->documentElement;
        $e->setAttribute($nameIn, $valueIn);
        $this->assertTrue($e->hasAttribute($nameExpected));
        $this->assertSame($valueExpected, $e->getAttribute($nameExpected));
    }


    public function provideGetHasSetAttributeNS(): iterable {
        return [
            [ 'fake_ns', 'ook', 'eek', 'ookeek', 'ook', 'eek', 'ookeek' ],
            [ 'another_fake_ns', 'steaming💩', 'poop💩', 'soccer', 'steaming💩', 'poop💩', 'soccer' ],
            [ Parser::XMLNS_NAMESPACE, 'xmlns', 'xlink', Parser::XLINK_NAMESPACE, 'xmlns', 'xlink', Parser::XLINK_NAMESPACE ]
        ];
    }

    /**
     * @dataProvider provideGetHasSetAttributeNS
     * @covers \MensBeam\HTML\DOM\Element::getAttributeNS
     * @covers \MensBeam\HTML\DOM\Element::hasAttributeNS
     * @covers \MensBeam\HTML\DOM\Element::setAttributeNS
     */
    public function testGetHasSetAttributeNS(?string $namespaceIn, ?string $prefixIn, string $localNameIn, string $valueIn, ?string $prefixExpected, string $localNameExpected, string $valueExpected): void {
        $d = new Document();
        $d->appendChild($d->createElement('html'));
        $e = $d->documentElement;
        $qualifiedNameIn = ($prefixIn === null || $prefixIn === '') ? $localNameIn : "{$prefixIn}:{$localNameIn}";
        $e->setAttributeNS($namespaceIn, $qualifiedNameIn, $valueIn);
        $this->assertTrue($e->hasAttributeNS($namespaceIn, $localNameExpected));
        $this->assertSame($valueExpected, $e->getAttributeNS($namespaceIn, $localNameExpected));
    }


    /**
     * @covers \MensBeam\HTML\DOM\Element::__get_classList
     * @covers \MensBeam\HTML\DOM\TokenList::__construct
     */
    public function testPropertyGetClassList(): void {
        $d = new Document();
        $d->appendChild($d->createElement('html'));
        $d->documentElement->setAttribute('class', 'ook eek ack  ookeek');
        $this->assertSame(4, $d->documentElement->classList->length);
    }


    /**
     * @covers \MensBeam\HTML\DOM\Element::__get_innerHTML
     * @covers \MensBeam\HTML\DOM\Element::__set_innerHTML
     */
    public function testPropertyGetSetInnerHTML(): void {
        $d = new Document();
        $d->appendChild($d->createElement('html'));
        $d->documentElement->appendChild($d->createElement('body'));
        $s = $d->body->appendChild($d->createElement('span'));
        $s->appendChild($d->createTextNode('ook'));
        $this->assertSame('<span>ook</span>', $d->body->innerHTML);

        $d->body->innerHTML = '<div>eek</div>';
        $this->assertSame('<div>eek</div>', $d->body->innerHTML);

        $t = $d->body->appendChild($d->createElement('template'));
        $t->innerHTML = 'ook';
        $this->assertSame('ook', $t->innerHTML);
    }


    /**
     * @covers \MensBeam\HTML\DOM\Element::__get_outerHTML
     * @covers \MensBeam\HTML\DOM\Element::__set_outerHTML
     */
    public function testPropertyGetSetOuterHTML(): void {
        $d = new Document();
        $d->appendChild($d->createElement('html'));
        $d->documentElement->appendChild($d->createElement('body'));
        $d->body->setAttribute('class', 'ook');
        $s = $d->body->appendChild($d->createElement('span'));
        $s->appendChild($d->createTextNode('ook'));
        $this->assertSame('<body class="ook"><span>ook</span></body>', $d->body->outerHTML);

        $d->body->outerHTML = '<body>eek</body>';
        $this->assertSame('<body>eek</body>', $d->body->outerHTML);

        $f = $d->createDocumentFragment();
        $div = $f->appendChild($d->createElement('div'));
        $div->outerHTML = 'ook';
        $this->assertSame('ook', (string)$f);

        $div = $d->createElement('div');
        $div->appendChild($d->createTextNode('ook'));
        $div->outerHTML = '<div>eek</div>';
        $this->assertSame('<div>ook</div>', (string)$div);
    }


    /**
     * @covers \MensBeam\HTML\DOM\Element::__set_outerHTML
     */
    public function testPropertySetOuterHTMLFailure(): void {
        $this->expectException(DOMException::class);
        $this->expectExceptionCode(DOMException::NO_MODIFICATION_ALLOWED);
        $d = new Document();
        $d->appendChild($d->createElement('html'));
        $d->documentElement->outerHTML = '<html>FAIL</html>';
    }


    /**
     * @covers \MensBeam\HTML\DOM\Element::getAttribute
     */
    public function testGetAttribute(): void {
        // Just need to test nonexistent attributes
        $d = new Document();
        $d->appendChild($d->createElement('html'));
        $this->assertNull($d->documentElement->getAttribute('ook'));
    }


    /**
     * @covers \MensBeam\HTML\DOM\Element::getAttributeNodeNS
     */
    public function testGetAttributeNodeNS(): void {
        $d = new Document();
        $d->appendChild($d->createElement('html'));
        $d->documentElement->setAttribute('ook', 'eek');
        // Empty string namespace
        $ook = $d->documentElement->getAttributeNodeNS('', 'ook');
        $this->assertSame('eek', $ook->value);
        // Bogus attribute
        $this->assertNull($d->documentElement->getAttributeNodeNS(null, 'what'));

        /*$d->documentElement->setAttributeNS(Parser::XMLNS_NAMESPACE, 'xmlns', Parser::HTML_NAMESPACE);
        die(var_export($d->documentElement->getAttributeNodeNS(Parser::XMLNS_NAMESPACE, 'xmlns')));*/
    }
}