8 changed files with 729 additions and 119 deletions
@ -0,0 +1,331 @@ |
|||
<?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; |
|||
use MensBeam\Framework\MagicProperties, |
|||
MensBeam\HTML\DOM\Inner\Reflection; |
|||
|
|||
|
|||
class DOMTokenList implements \ArrayAccess, \Countable, \Iterator { |
|||
use MagicProperties; |
|||
|
|||
|
|||
protected string $localName; |
|||
protected \WeakReference $element; |
|||
|
|||
protected int $_length = 0; |
|||
protected int $position = 0; |
|||
# A DOMTokenList object has an associated token set (a set), which is initially |
|||
# empty. |
|||
protected array $tokenSet = []; |
|||
|
|||
private const ASCII_WHITESPACE_REGEX = '/[\t\n\x0c\r ]+/'; |
|||
|
|||
|
|||
protected function __get_length(): int { |
|||
return $this->_length; |
|||
} |
|||
|
|||
protected function __get_value(): string { |
|||
# The value attribute must return the result of running this’s serialize steps. |
|||
return $this->__toString(); |
|||
} |
|||
|
|||
protected function __set_value(string $value) { |
|||
# Setting the value attribute must set an attribute value for the associated |
|||
# element using associated attribute’s local name and the given value. |
|||
$element = Reflection::getProtectedProperty($this->element->get(), 'innerNode'); |
|||
$element->setAttribute($this->localName, $value); |
|||
// Also update the token set and the length. |
|||
$this->tokenSet = $this->parseOrderedSet($value); |
|||
$this->_length = count($this->tokenSet); |
|||
} |
|||
|
|||
|
|||
protected function __construct(Element $element, string $attributeLocalName) { |
|||
# A DOMTokenList object also has an associated element and an attribute’s local |
|||
# name. |
|||
|
|||
# When a DOMTokenList object is created, then: |
|||
# |
|||
# 1. Let element be associated element. |
|||
// Using a weak reference here to prevent a circular reference. We should be |
|||
// creating a weak reference to the inner element, but there are memory |
|||
// management issues concerning PHP's garbage reference counting. |
|||
$this->element = \WeakReference::create($element); |
|||
# 2. Let localName be associated attribute’s local name. |
|||
$this->localName = $attributeLocalName; |
|||
# 3. Let value be the result of getting an attribute value given element and |
|||
# localName. |
|||
$element = Reflection::getProtectedProperty($element, 'innerNode'); |
|||
$value = $element->getAttribute($attributeLocalName); |
|||
# 4. Run the attribute change steps for element, localName, value, value, and |
|||
# null. |
|||
$this->attributeChange($attributeLocalName, $value, $value); |
|||
} |
|||
|
|||
|
|||
public function add(...$tokens): void { |
|||
# 1. For each token in tokens: |
|||
foreach ($tokens as $token) { |
|||
# 1. If token is the empty string, then throw a "SyntaxError" DOMException. |
|||
if ($token === '') { |
|||
throw new DOMException(DOMException::SYNTAX_ERROR); |
|||
} |
|||
|
|||
# 2. If token contains any ASCII whitespace, then throw an |
|||
# "InvalidCharacterError" DOMException. |
|||
if (preg_match(self::ASCII_WHITESPACE_REGEX, $token)) { |
|||
throw new DOMException(DOMException::INVALID_CHARACTER); |
|||
} |
|||
} |
|||
|
|||
# 2. For each token in tokens, append token to this’s token set. |
|||
foreach ($tokens as $token) { |
|||
if (!in_array($token, $this->tokenSet)) { |
|||
$this->tokenSet[] = $token; |
|||
$this->_length++; |
|||
} |
|||
} |
|||
|
|||
# 3. Run the update steps. |
|||
$this->update(); |
|||
} |
|||
|
|||
public function contains(string $token): bool { |
|||
return (in_array($token, $this->tokenSet)); |
|||
} |
|||
|
|||
public function count(): int { |
|||
return $this->_length; |
|||
} |
|||
|
|||
public function current(): ?string { |
|||
return $this->item($this->position); |
|||
} |
|||
|
|||
public function item(int $index): ?string { |
|||
# The item(index) method steps are: |
|||
# 1. If index is equal to or greater than this’s token set’s size, then return null. |
|||
if ($index >= $this->_length) { |
|||
return null; |
|||
} |
|||
# 2. Return this’s token set[index]. |
|||
return $this->tokenSet[$index]; |
|||
} |
|||
|
|||
public function key(): int { |
|||
return $this->position; |
|||
} |
|||
|
|||
public function next(): void { |
|||
++$this->position; |
|||
} |
|||
|
|||
public function rewind(): void { |
|||
$this->position = 0; |
|||
} |
|||
|
|||
public function offsetExists($offset): bool { |
|||
return isset($this->tokenSet[$offset]); |
|||
} |
|||
|
|||
public function offsetGet($offset): string { |
|||
return $this->item($offset); |
|||
} |
|||
|
|||
public function offsetSet($offset, $value): void { |
|||
// Spec says nothing about setting values on DOMTokenList outside of add(); |
|||
// browsers silently fail here. |
|||
} |
|||
|
|||
public function offsetUnset($offset): void { |
|||
// Spec says nothing about unsetting values on DOMTokenList outside of remove(); |
|||
// browsers silently fail here. |
|||
} |
|||
|
|||
public function remove(...$tokens): void { |
|||
# 1. For each token in tokens: |
|||
foreach ($tokens as $token) { |
|||
# 1. If token is the empty string, then throw a "SyntaxError" DOMException. |
|||
if ($token === '') { |
|||
throw new DOMException(DOMException::SYNTAX_ERROR); |
|||
} |
|||
|
|||
# 2. If token contains any ASCII whitespace, then throw an |
|||
# "InvalidCharacterError" DOMException. |
|||
if (preg_match(self::ASCII_WHITESPACE_REGEX, $token)) { |
|||
throw new DOMException(DOMException::INVALID_CHARACTER); |
|||
} |
|||
} |
|||
|
|||
# For each token in tokens, remove token from this’s token set. |
|||
$changed = false; |
|||
foreach ($tokens as $token) { |
|||
if ($key = array_search($token, $this->tokenSet, true)) { |
|||
unset($this->tokenSet[$key]); |
|||
$this->_length--; |
|||
$changed = true; |
|||
} |
|||
} |
|||
|
|||
if ($changed) { |
|||
$this->tokenSet = array_values($this->tokenSet); |
|||
} |
|||
|
|||
# 3. Run the update steps. |
|||
$this->update(); |
|||
} |
|||
|
|||
public function replace(string $token, string $newToken): bool { |
|||
# 1. If either token or newToken is the empty string, then throw a "SyntaxError" |
|||
# DOMException. |
|||
if ($token === '' || $newToken === '') { |
|||
throw new DOMException(DOMException::SYNTAX_ERROR); |
|||
} |
|||
|
|||
# 2. If either token or newToken contains any ASCII whitespace, then throw an |
|||
# "InvalidCharacterError" DOMException. |
|||
if (preg_match(self::ASCII_WHITESPACE_REGEX, $token) || preg_match(self::ASCII_WHITESPACE_REGEX, $newToken)) { |
|||
throw new DOMException(DOMException::INVALID_CHARACTER); |
|||
} |
|||
|
|||
# 3. If this’s token set does not contain token, then return false. |
|||
if (!($key = array_search($token, $this->tokenSet))) { |
|||
return false; |
|||
} |
|||
|
|||
# 4. Replace token in this’s token set with newToken. |
|||
$this->tokenSet[$key] = $newToken; |
|||
|
|||
# 5. Run the update steps. |
|||
$this->update(); |
|||
|
|||
# 6. Return true. |
|||
return true; |
|||
} |
|||
|
|||
public function supports(string $token): bool { |
|||
# 1. Let result be the return value of validation steps called with token. |
|||
# 2. Return result. |
|||
# |
|||
# A DOMTokenList object’s validation steps for a given token are: |
|||
# |
|||
# 1. If the associated attribute’s local name does not define supported tokens, |
|||
# throw a TypeError. |
|||
# 2. Let lowercase token be a copy of token, in ASCII lowercase. |
|||
# 3. If lowercase token is present in supported tokens, return true. |
|||
# 4. Return false. |
|||
|
|||
// This class is presently only used for Element::classList, and it supports any |
|||
// valid class name as a token. So, there's nothing to do here at the moment. |
|||
// Just return true. |
|||
return true; |
|||
} |
|||
|
|||
public function toggle(string $token, ?bool $force = null): bool { |
|||
# 1. If token is the empty string, then throw a "SyntaxError" DOMException. |
|||
if ($token === '') { |
|||
throw new DOMException(DOMException::SYNTAX_ERROR); |
|||
} |
|||
|
|||
# 2. If token contains any ASCII whitespace, then throw an |
|||
# "InvalidCharacterError" DOMException. |
|||
if (preg_match(self::ASCII_WHITESPACE_REGEX, $token)) { |
|||
throw new DOMException(DOMException::INVALID_CHARACTER); |
|||
} |
|||
|
|||
# 3. If this’s token set[token] exists, then: |
|||
if (in_array($token, $this->tokenSet)) { |
|||
# 1. If force is either not given or is false, then remove token from this’s |
|||
# token set, run the update steps and return false. |
|||
if (!$force) { |
|||
$this->remove($token); |
|||
return false; |
|||
} |
|||
|
|||
# 2. Return true. |
|||
return true; |
|||
} |
|||
# 4. Otherwise, if force not given or is true, append token to this’s token set, |
|||
# run the update steps, and return true. |
|||
elseif ($force === null || $force === true) { |
|||
$this->add($token); |
|||
return true; |
|||
} |
|||
|
|||
# 5. Return false. |
|||
return false; |
|||
} |
|||
|
|||
public function valid(): bool { |
|||
return array_key_exists($this->position, $this->tokenSet); |
|||
} |
|||
|
|||
|
|||
protected function attributeChange(string $localName, ?string $oldValue = null, ?string $value = null, ?string $namespace = null): void { |
|||
# A DOMTokenList object has these attribute change steps for its associated |
|||
# element: |
|||
# |
|||
# 1. If localName is associated attribute’s local name, namespace is null, and |
|||
# value is null, then empty token set. |
|||
if ($localName === $this->localName && $namespace === null && $value === null) { |
|||
$this->tokenSet = []; |
|||
$this->_length = 0; |
|||
} |
|||
# 2. Otherwise, if localName is associated attribute’s local name, namespace is |
|||
# null, then set token set to value, parsed. |
|||
elseif ($localName === $this->localName && $namespace === null) { |
|||
$this->tokenSet = $this->parseOrderedSet($value); |
|||
$this->_length = count($this->tokenSet); |
|||
} |
|||
} |
|||
|
|||
protected function parseOrderedSet(string $input): array { |
|||
if ($input === '') { |
|||
return []; |
|||
} |
|||
|
|||
# The ordered set parser takes a string input and then runs these steps: |
|||
# |
|||
# 1. Let inputTokens be the result of splitting input on ASCII whitespace. |
|||
// There isn't a Set object in php, so make sure all the tokens are unique. |
|||
$inputTokens = array_unique(preg_split(self::ASCII_WHITESPACE_REGEX, $input)); |
|||
|
|||
# 2. Let tokens be a new ordered set. |
|||
# 3. For each token in inputTokens, append token to tokens. |
|||
# 4. Return tokens. |
|||
// There isn't a Set object in php, so just return the uniqued input tokens. |
|||
return $inputTokens; |
|||
} |
|||
|
|||
protected function update(): void { |
|||
# A DOMTokenList object’s update steps are: |
|||
# |
|||
# 1. If the associated element does not have an associated attribute and token |
|||
# set is empty, then return. |
|||
$element = Reflection::getProtectedProperty($this->element->get(), 'innerNode'); |
|||
if (!$element->hasAttribute('class') && count($this->tokenSet) === 0) { |
|||
return; |
|||
} |
|||
|
|||
# 2. Set an attribute value for the associated element using associated |
|||
# attribute’s local name and the result of running the ordered set serializer |
|||
# for token set. |
|||
$class = $element->ownerDocument->createAttribute($this->localName); |
|||
$class->value = $this->__toString(); |
|||
$element->setAttributeNode($class); |
|||
} |
|||
|
|||
|
|||
public function __toString(): string { |
|||
# The ordered set serializer takes a set and returns the concatenation of set |
|||
# using U+0020 SPACE. |
|||
return implode(' ', $this->tokenSet); |
|||
} |
|||
} |
|||
@ -0,0 +1,224 @@ |
|||
<?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, |
|||
Node, |
|||
Text, |
|||
XMLDocument |
|||
}; |
|||
|
|||
|
|||
/** @covers \MensBeam\HTML\DOM\DOMTokenList */ |
|||
class TestDOMTokenList extends \PHPUnit\Framework\TestCase { |
|||
public function provideMethod_add_remove_replace_toggle__errors(): iterable { |
|||
return [ |
|||
[ function() { |
|||
$d = new Document(); |
|||
$e = $d->createElement('html'); |
|||
$e->classList->add(''); |
|||
}, DOMException::SYNTAX_ERROR ], |
|||
[ function() { |
|||
$d = new Document(); |
|||
$e = $d->createElement('html'); |
|||
$e->classList->remove(''); |
|||
}, DOMException::SYNTAX_ERROR ], |
|||
[ function() { |
|||
$d = new Document(); |
|||
$e = $d->createElement('html'); |
|||
$e->classList->replace('ack', ''); |
|||
}, DOMException::SYNTAX_ERROR ], |
|||
[ function() { |
|||
$d = new Document(); |
|||
$e = $d->createElement('html'); |
|||
$e->classList->toggle(''); |
|||
}, DOMException::SYNTAX_ERROR ], |
|||
[ function() { |
|||
$d = new Document(); |
|||
$e = $d->createElement('html'); |
|||
$e->classList->add('fail fail'); |
|||
}, DOMException::INVALID_CHARACTER ], |
|||
[ function() { |
|||
$d = new Document(); |
|||
$e = $d->createElement('html'); |
|||
$e->classList->remove('fail fail'); |
|||
}, DOMException::INVALID_CHARACTER ], |
|||
[ function() { |
|||
$d = new Document(); |
|||
$e = $d->createElement('html'); |
|||
$e->classList->replace('ack', 'fail fail'); |
|||
}, DOMException::INVALID_CHARACTER ], |
|||
[ function() { |
|||
$d = new Document(); |
|||
$e = $d->createElement('html'); |
|||
$e->classList->toggle('fail fail'); |
|||
}, DOMException::INVALID_CHARACTER ] |
|||
]; |
|||
} |
|||
|
|||
/** @dataProvider provideMethod_add_remove_replace_toggle__errors */ |
|||
public function testMethod_add_remove_replace_toggle__errors(\Closure $closure, int $errorCode): void { |
|||
$this->expectException(DOMException::class); |
|||
$this->expectExceptionCode($errorCode); |
|||
$closure(); |
|||
} |
|||
|
|||
|
|||
/** |
|||
* @covers \MensBeam\HTML\DOM\DOMTokenList::contains |
|||
* |
|||
* @covers \MensBeam\HTML\DOM\Document::__construct |
|||
* @covers \MensBeam\HTML\DOM\Document::createElement |
|||
* @covers \MensBeam\HTML\DOM\DOMImplementation::__construct |
|||
* @covers \MensBeam\HTML\DOM\DOMTokenList::__construct |
|||
* @covers \MensBeam\HTML\DOM\DOMTokenList::__toString |
|||
* @covers \MensBeam\HTML\DOM\DOMTokenList::add |
|||
* @covers \MensBeam\HTML\DOM\DOMTokenList::attributeChange |
|||
* @covers \MensBeam\HTML\DOM\DOMTokenList::parseOrderedSet |
|||
* @covers \MensBeam\HTML\DOM\DOMTokenList::update |
|||
* @covers \MensBeam\HTML\DOM\Element::__construct |
|||
* @covers \MensBeam\HTML\DOM\Element::__get_classList |
|||
* @covers \MensBeam\HTML\DOM\Node::__construct |
|||
* @covers \MensBeam\HTML\DOM\Node::appendChild |
|||
* @covers \MensBeam\HTML\DOM\Node::getInnerDocument |
|||
* @covers \MensBeam\HTML\DOM\Node::getInnerNode |
|||
* @covers \MensBeam\HTML\DOM\Node::getRootNode |
|||
* @covers \MensBeam\HTML\DOM\Node::postInsertionBugFixes |
|||
* @covers \MensBeam\HTML\DOM\Node::preInsertionBugFixes |
|||
* @covers \MensBeam\HTML\DOM\Node::preInsertionValidity |
|||
* @covers \MensBeam\HTML\DOM\Inner\Document::__construct |
|||
* @covers \MensBeam\HTML\DOM\Inner\Document::getWrapperNode |
|||
* @covers \MensBeam\HTML\DOM\Inner\NodeCache::get |
|||
* @covers \MensBeam\HTML\DOM\Inner\NodeCache::has |
|||
* @covers \MensBeam\HTML\DOM\Inner\NodeCache::key |
|||
* @covers \MensBeam\HTML\DOM\Inner\NodeCache::set |
|||
* @covers \MensBeam\HTML\DOM\Inner\Reflection::createFromProtectedConstructor |
|||
* @covers \MensBeam\HTML\DOM\Inner\Reflection::getProtectedProperty |
|||
*/ |
|||
public function testMethod_contains() { |
|||
$d = new Document(); |
|||
$e = $d->appendChild($d->createElement('html')); |
|||
$e->classList->add('ook', 'eek', 'ack', 'ookeek'); |
|||
$this->assertTrue($e->classList->contains('ack')); |
|||
$this->assertFalse($e->classList->contains('fail')); |
|||
} |
|||
|
|||
|
|||
public function testMethod_count(): void { |
|||
$d = new Document(); |
|||
$e = $d->appendChild($d->createElement('html')); |
|||
$e->classList->add('ook', 'eek', 'ack', 'ookeek'); |
|||
$this->assertSame(4, count($e->classList)); |
|||
} |
|||
|
|||
|
|||
public function testMethod_item(): void { |
|||
$d = new Document(); |
|||
$e = $d->appendChild($d->createElement('html')); |
|||
$e->classList->add('ook', 'eek', 'ack', 'ookeek'); |
|||
$this->assertNull($e->classList->item(42)); |
|||
} |
|||
|
|||
|
|||
public function testMethod_replace(): void { |
|||
$d = new Document(); |
|||
$e = $d->appendChild($d->createElement('html')); |
|||
$e->setAttribute('class', 'ook eek ack ookeek'); |
|||
$this->assertTrue($e->classList->replace('ack', 'what')); |
|||
$this->assertSame('ook eek what ookeek', $e->classList->value); |
|||
$this->assertSame('ook eek what ookeek', $e->getAttribute('class')); |
|||
$this->assertFalse($e->classList->replace('fail', 'eekook')); |
|||
} |
|||
|
|||
|
|||
public function testMethod_remove(): void { |
|||
$d = new Document(); |
|||
$e = $d->appendChild($d->createElement('html')); |
|||
$e->setAttribute('class', 'ook eek ack ookeek'); |
|||
$e->classList->remove('ack'); |
|||
$this->assertSame('ook eek ookeek', $e->classList->value); |
|||
$this->assertSame('ook eek ookeek', $e->getAttribute('class')); |
|||
} |
|||
|
|||
|
|||
public function testMethod_supports(): void { |
|||
$d = new Document(); |
|||
$e = $d->appendChild($d->createElement('html')); |
|||
$e->classList->add('ook', 'eek', 'ack', 'ookeek'); |
|||
$this->assertTrue($e->classList->supports('ack')); |
|||
} |
|||
|
|||
|
|||
public function testMethod_toggle(): void { |
|||
$d = new Document(); |
|||
$e = $d->appendChild($d->createElement('html')); |
|||
$e->setAttribute('class', 'ook eek ack ookeek'); |
|||
$this->assertFalse($e->classList->toggle('ack')); |
|||
$this->assertSame('ook eek ookeek', $e->classList->value); |
|||
$this->assertSame('ook eek ookeek', $e->getAttribute('class')); |
|||
$this->assertTrue($e->classList->toggle('ack')); |
|||
$this->assertSame('ook eek ookeek ack', $e->classList->value); |
|||
$this->assertSame('ook eek ookeek ack', $e->getAttribute('class')); |
|||
$this->assertTrue($e->classList->toggle('ack', true)); |
|||
$this->assertSame('ook eek ookeek ack', $e->classList->value); |
|||
$this->assertSame('ook eek ookeek ack', $e->getAttribute('class')); |
|||
$this->assertFalse($e->classList->toggle('eekook', false)); |
|||
$this->assertSame('ook eek ookeek ack', $e->classList->value); |
|||
$this->assertSame('ook eek ookeek ack', $e->getAttribute('class')); |
|||
$this->assertTrue($e->classList->toggle('eekook', true)); |
|||
$this->assertSame('ook eek ookeek ack eekook', $e->classList->value); |
|||
$this->assertSame('ook eek ookeek ack eekook', $e->getAttribute('class')); |
|||
} |
|||
|
|||
|
|||
public function testProcess_iteration(): void { |
|||
$d = new Document(); |
|||
$e = $d->appendChild($d->createElement('html')); |
|||
$e->classList->add('ook', 'eek', 'ack', 'ookeek'); |
|||
|
|||
foreach ($e->classList as $key => $className) { |
|||
$this->assertSame($className, $e->classList[$key]); |
|||
// test offsetExists |
|||
$this->assertTrue(isset($e->classList[$key])); |
|||
} |
|||
} |
|||
|
|||
|
|||
public function testProperty_value(): void { |
|||
// Test it with and without an attached document element |
|||
$d = new Document(); |
|||
$e = $d->createElement('html'); |
|||
$e->classList->add('ook', 'eek', 'ack', 'ookeek'); |
|||
$this->assertSame('ook eek ack ookeek', $e->classList->value); |
|||
$this->assertSame('ook eek ack ookeek', $e->getAttribute('class')); |
|||
$e->classList->value = 'omg wtf bbq lol zor bor xxx'; |
|||
$this->assertSame('lol', $e->classList[3]); |
|||
$this->assertSame('omg wtf bbq lol zor bor xxx', $e->classList->value); |
|||
$this->assertSame('omg wtf bbq lol zor bor xxx', $e->getAttribute('class')); |
|||
$e->classList->value = ''; |
|||
$this->assertSame('', $e->classList->value); |
|||
$this->assertSame('', $e->getAttribute('class')); |
|||
|
|||
$d = new Document(); |
|||
$e = $d->appendChild($d->createElement('html')); |
|||
$e->classList->add('ook', 'eek', 'ack', 'ookeek'); |
|||
$this->assertSame('ook eek ack ookeek', $e->classList->value); |
|||
$this->assertSame('ook eek ack ookeek', $e->getAttribute('class')); |
|||
$e->classList->value = 'omg wtf bbq lol zor bor xxx'; |
|||
$this->assertSame('lol', $e->classList[3]); |
|||
$this->assertSame('omg wtf bbq lol zor bor xxx', $e->classList->value); |
|||
$this->assertSame('omg wtf bbq lol zor bor xxx', $e->getAttribute('class')); |
|||
$e->classList->value = ''; |
|||
$this->assertSame('', $e->classList->value); |
|||
$this->assertSame('', $e->getAttribute('class')); |
|||
} |
|||
} |
|||
Loading…
Reference in new issue