100% code coverage on php 8, need to test earlier php versions

lib/TokenList.php

@@ -15,8 +15,6 @@ class TokenList implements \ArrayAccess, \Countable, \Iterator {
     use MagicProperties;
 
 
-    public bool $rebuild = false;
-
     protected string $localName;
     protected \WeakReference $element;
 
@@ -34,10 +32,16 @@ class TokenList implements \ArrayAccess, \Countable, \Iterator {
     }
 
     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 = $this->element->get();
+        $element->setAttribute($this->localName, $value);
+        // Also update the token set and the length.
         $this->tokenSet = $this->parseOrderedSet($value);
         $this->_length = count($this->tokenSet);
     }
@@ -67,7 +71,7 @@ class TokenList implements \ArrayAccess, \Countable, \Iterator {
         $this->attributeChange($attributeLocalName, $value, $value);
     }
 
-    public function add(...$tokens) {
+    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.
@@ -103,7 +107,7 @@ class TokenList implements \ArrayAccess, \Countable, \Iterator {
         return $this->_length;
     }
 
-    public function current() {
+    public function current(): string {
         return $this->item($this->position);
     }
 
@@ -111,35 +115,37 @@ class TokenList implements \ArrayAccess, \Countable, \Iterator {
         return $this->tokenSet[$index];
     }
 
-    public function key() {
+    public function key(): int {
         return $this->position;
     }
 
-    public function next() {
+    public function next(): void {
         ++$this->position;
     }
 
-    public function rewind() {
+    public function rewind(): void {
         $this->position = 0;
     }
 
-    public function offsetExists($offset) {
-        return $this->contains($offset);
+    public function offsetExists($offset): bool {
+        return isset($this->tokenSet[$offset]);
     }
 
     public function offsetGet($offset): string {
         return $this->item($offset);
     }
 
-    public function offsetSet($offset, $value) {
-        $this->add($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) {
-        $this->remove($offset);
+    public function offsetUnset($offset): void {
+        // Spec says nothing about unsetting values on DOMTokenList outside of remove();
+        // browsers silently fail here.
     }
 
-    public function remove(...$tokens) {
+    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.
@@ -157,8 +163,8 @@ class TokenList implements \ArrayAccess, \Countable, \Iterator {
         # For each token in tokens, remove token from this’s token set.
         $changed = false;
         foreach ($tokens as $token) {
-            if (in_array($token, $this->tokenSet)) {
-                unset($this->tokenSet[$token]);
+            if ($key = array_search($token, $this->tokenSet, true)) {
+                unset($this->tokenSet[$key]);
                 $this->_length--;
                 $changed = true;
             }
@@ -187,16 +193,15 @@ class TokenList implements \ArrayAccess, \Countable, \Iterator {
 
         // The spec does not say to trim, but browsers do.
         $token = trim($token);
-        $newToken = trim($token);
+        $newToken = trim($newToken);
 
         # 3. If this’s token set does not contain token, then return false.
-        if (!isset($this->tokenSet[$token])) {
+        if (!($key = array_search($token, $this->tokenSet))) {
             return false;
         }
 
         # 4. Replace token in this’s token set with newToken.
-        $index = array_search($token, $this->tokenSet);
-        $this->tokenSet[$index] = $newToken;
+        $this->tokenSet[$key] = $newToken;
 
         # 5. Run the update steps.
         $this->update();
@@ -223,7 +228,7 @@ class TokenList implements \ArrayAccess, \Countable, \Iterator {
         return true;
     }
 
-    public function toggle(string $token, ?bool $force = false): bool {
+    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);
@@ -236,7 +241,7 @@ class TokenList implements \ArrayAccess, \Countable, \Iterator {
         }
 
         # 3. If this’s token set[token] exists, then:
-        if (isset($this->tokenSet[$token])) {
+        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) {
@@ -249,7 +254,7 @@ class TokenList implements \ArrayAccess, \Countable, \Iterator {
         }
         # 4. Otherwise, if force not given or is true, append token to this’s token set,
         # run the update steps, and return true.
-        else {
+        elseif ($force === null || $force === true) {
             $this->add($token);
             return true;
         }
@@ -269,17 +274,13 @@ class TokenList implements \ArrayAccess, \Countable, \Iterator {
         #
         # 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) {
-            return;
-        }
-
-        if ($value === null) {
+        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.
-        else {
+        elseif ($localName === $this->localName && $namespace === null) {
             $this->tokenSet = $this->parseOrderedSet($value);
             $this->_length = count($this->tokenSet);
         }

tests/cases/TestTokenList.php

@@ -17,11 +17,206 @@ use MensBeam\HTML\Parser;
 
 /** @covers \MensBeam\HTML\DOM\TokenList */
 class TestTokenList extends \PHPUnit\Framework\TestCase {
+    public function provideAddRemoveReplaceToggleFailures(): 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 provideAddRemoveReplaceToggleFailures
+     * @covers \MensBeam\HTML\DOM\TokenList::add
+     * @covers \MensBeam\HTML\DOM\TokenList::remove
+     * @covers \MensBeam\HTML\DOM\TokenList::replace
+     * @covers \MensBeam\HTML\DOM\TokenList::toggle
+     */
+    public function testAddRemoveReplaceFailures(\Closure $closure, int $errorCode): void {
+        $this->expectException(DOMException::class);
+        $this->expectExceptionCode($errorCode);
+        $closure();
+    }
+
+
+    /** @covers \MensBeam\HTML\DOM\TokenList::contains */
+    public function testContains(): void {
+        $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'));
+    }
+
+
+    /** @covers \MensBeam\HTML\DOM\TokenList::count */
+    public function testCount(): void {
+        $d = new Document();
+        $e = $d->appendChild($d->createElement('html'));
+        $e->classList->add('ook', 'eek', 'ack', 'ookeek');
+        $this->assertSame(4, count($e->classList));
+    }
+
+
+    /**
+     * @covers \MensBeam\HTML\DOM\TokenList::current
+     * @covers \MensBeam\HTML\DOM\TokenList::item
+     * @covers \MensBeam\HTML\DOM\TokenList::key
+     * @covers \MensBeam\HTML\DOM\TokenList::next
+     * @covers \MensBeam\HTML\DOM\TokenList::rewind
+     * @covers \MensBeam\HTML\DOM\TokenList::offsetExists
+     * @covers \MensBeam\HTML\DOM\TokenList::offsetGet
+     * @covers \MensBeam\HTML\DOM\TokenList::valid
+     */
+    public function testIteration(): 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]));
+        }
+    }
+
     /** @covers \MensBeam\HTML\DOM\TokenList::__get_length */
     public function testPropertyGetLength(): void {
+        // Test it with and without an attached document element
+        $d = new Document();
+        $e = $d->appendChild($d->createElement('html'));
+        $e->classList->add('ook', 'eek', 'ack', 'ookeek');
+        $this->assertSame(4, $e->classList->length);
+
         $d = new Document();
         $e = $d->createElement('html');
         $e->classList->add('ook', 'eek', 'ack', 'ookeek');
         $this->assertSame(4, $e->classList->length);
     }
+
+
+    /**
+     * @covers \MensBeam\HTML\DOM\TokenList::__get_value
+     * @covers \MensBeam\HTML\DOM\TokenList::__set_value
+     */
+    public function testPropertyGetSetValue(): 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'));
+    }
+
+
+    /** @covers \MensBeam\HTML\DOM\TokenList::replace */
+    public function testReplace(): 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'));
+    }
+
+
+    /** @covers \MensBeam\HTML\DOM\TokenList::remove */
+    public function testRemove(): 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'));
+    }
+
+
+    /** @covers \MensBeam\HTML\DOM\TokenList::supports */
+    public function testSupports(): void {
+        $d = new Document();
+        $e = $d->appendChild($d->createElement('html'));
+        $e->classList->add('ook', 'eek', 'ack', 'ookeek');
+        $this->assertTrue($e->classList->supports('ack'));
+    }
+
+
+    /** @covers \MensBeam\HTML\DOM\TokenList::toggle */
+    public function testToggle(): 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'));
+    }
 }