From ceef07f1ae1a39d563cafddb676093d4ac829d74 Mon Sep 17 00:00:00 2001 From: Dustin Wilson Date: Wed, 3 Nov 2021 16:27:58 -0500 Subject: [PATCH] Cleaning up test docblocks --- composer.json | 13 ++-- composer.lock | 58 +++++++++++++- tests/cases/TestDocument.php | 145 ++++++++++++++++++++++++++++++++++- tests/cases/TestNode.php | 5 +- 4 files changed, 211 insertions(+), 10 deletions(-) diff --git a/composer.json b/composer.json index cf94be7..82b4e22 100644 --- a/composer.json +++ b/composer.json @@ -7,7 +7,13 @@ "ext-dom": "*", "mensbeam/html-parser": "dev-master", "mensbeam/framework": "dev-main", - "symfony/css-selector": "^5.3" + "symfony/css-selector": "^5.3", + }, + "require-dev": { + "bamarni/composer-bin-plugin": "^1.3", + "daux/daux.io": "^0.16.0", + "mikey179/vfsstream": "^1.6", + "nikic/php-parser": "^4.13" }, "scripts": { "post-install-cmd": ["@composer bin all install"], @@ -44,11 +50,6 @@ ] } }, - "require-dev": { - "bamarni/composer-bin-plugin": "^1.3", - "daux/daux.io": "^0.16.0", - "mikey179/vfsstream": "^1.6" - }, "repositories": [ { "type": "git", diff --git a/composer.lock b/composer.lock index fd6cb4b..a46c033 100644 --- a/composer.lock +++ b/composer.lock @@ -4,7 +4,7 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "This file is @generated automatically" ], - "content-hash": "64e0c3baf9ecd7960acc83f89ab580bd", + "content-hash": "e1ae676c649645ea27cced9dd2587393", "packages": [ { "name": "mensbeam/framework", @@ -238,6 +238,62 @@ }, "time": "2021-03-07T03:58:00+00:00" }, + { + "name": "nikic/php-parser", + "version": "v4.13.0", + "source": { + "type": "git", + "url": "https://github.com/nikic/PHP-Parser.git", + "reference": "50953a2691a922aa1769461637869a0a2faa3f53" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/nikic/PHP-Parser/zipball/50953a2691a922aa1769461637869a0a2faa3f53", + "reference": "50953a2691a922aa1769461637869a0a2faa3f53", + "shasum": "" + }, + "require": { + "ext-tokenizer": "*", + "php": ">=7.0" + }, + "require-dev": { + "ircmaxell/php-yacc": "^0.0.7", + "phpunit/phpunit": "^6.5 || ^7.0 || ^8.0 || ^9.0" + }, + "bin": [ + "bin/php-parse" + ], + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "4.9-dev" + } + }, + "autoload": { + "psr-4": { + "PhpParser\\": "lib/PhpParser" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "BSD-3-Clause" + ], + "authors": [ + { + "name": "Nikita Popov" + } + ], + "description": "A PHP parser written in PHP", + "keywords": [ + "parser", + "php" + ], + "support": { + "issues": "https://github.com/nikic/PHP-Parser/issues", + "source": "https://github.com/nikic/PHP-Parser/tree/v4.13.0" + }, + "time": "2021-09-20T12:20:58+00:00" + }, { "name": "psr/http-message", "version": "1.0.1", diff --git a/tests/cases/TestDocument.php b/tests/cases/TestDocument.php index 63a9056..6183998 100644 --- a/tests/cases/TestDocument.php +++ b/tests/cases/TestDocument.php @@ -20,6 +20,41 @@ use MensBeam\HTML\Parser, /** @covers \MensBeam\HTML\DOM\Document */ class TestDocument extends \PHPUnit\Framework\TestCase { + /** + * @covers \MensBeam\HTML\DOM\Document::adoptNode + * + * @covers \MensBeam\HTML\DOM\Document::__construct + * @covers \MensBeam\HTML\DOM\Document::createDocumentFragment + * @covers \MensBeam\HTML\DOM\Document::createElement + * @covers \MensBeam\HTML\DOM\Document::importNode + * @covers \MensBeam\HTML\DOM\DocumentFragment::__construct + * @covers \MensBeam\HTML\DOM\DOMImplementation::__construct + * @covers \MensBeam\HTML\DOM\Element::__construct + * @covers \MensBeam\HTML\DOM\HTMLTemplateElement::__construct + * @covers \MensBeam\HTML\DOM\HTMLTemplateElement::__get_content + * @covers \MensBeam\HTML\DOM\Node::__construct + * @covers \MensBeam\HTML\DOM\Node::__get_ownerDocument + * @covers \MensBeam\HTML\DOM\Node::__get_parentNode + * @covers \MensBeam\HTML\DOM\Node::appendChild + * @covers \MensBeam\HTML\DOM\Node::cloneInnerNode + * @covers \MensBeam\HTML\DOM\Node::cloneWrapperNode + * @covers \MensBeam\HTML\DOM\Node::getInnerDocument + * @covers \MensBeam\HTML\DOM\Node::getInnerNode + * @covers \MensBeam\HTML\DOM\Node::hasChildNodes + * @covers \MensBeam\HTML\DOM\Node::preInsertionValidity + * @covers \MensBeam\HTML\DOM\Node::removeChild + * @covers \MensBeam\HTML\DOM\InnerNode\Document::__construct + * @covers \MensBeam\HTML\DOM\InnerNode\Document::__get_wrapperNode + * @covers \MensBeam\HTML\DOM\InnerNode\Document::getWrapperNode + * @covers \MensBeam\HTML\DOM\InnerNode\NodeCache::delete + * @covers \MensBeam\HTML\DOM\InnerNode\NodeCache::get + * @covers \MensBeam\HTML\DOM\InnerNode\NodeCache::has + * @covers \MensBeam\HTML\DOM\InnerNode\NodeCache::key + * @covers \MensBeam\HTML\DOM\InnerNode\NodeCache::set + * @covers \MensBeam\HTML\DOM\InnerNode\Reflection::createFromProtectedConstructor + * @covers \MensBeam\HTML\DOM\InnerNode\Reflection::getProtectedProperty + * @covers \MensBeam\HTML\DOM\InnerNode\Reflection::setProtectedProperties + */ public function testMethod_adoptNode(): void { $d = new Document(); $documentElement = $d->appendChild($d->createElement('html')); @@ -35,6 +70,15 @@ class TestDocument extends \PHPUnit\Framework\TestCase { } + /** + * @covers \MensBeam\HTML\DOM\Document::adoptNode + * + * @covers \MensBeam\HTML\DOM\Document::__construct + * @covers \MensBeam\HTML\DOM\DOMException::__construct + * @covers \MensBeam\HTML\DOM\DOMImplementation::__construct + * @covers \MensBeam\HTML\DOM\Node::__construct + * @covers \MensBeam\HTML\DOM\InnerNode\Document::__construct + */ public function testMethod_adoptNode_errors(): void { $this->expectException(DOMException::class); $this->expectExceptionCode(DOMException::NOT_SUPPORTED); @@ -44,6 +88,15 @@ class TestDocument extends \PHPUnit\Framework\TestCase { } + /** + * @covers \MensBeam\HTML\DOM\Document::createAttribute + * + * @covers \MensBeam\HTML\DOM\Document::__construct + * @covers \MensBeam\HTML\DOM\DOMException::__construct + * @covers \MensBeam\HTML\DOM\DOMImplementation::__construct + * @covers \MensBeam\HTML\DOM\Node::__construct + * @covers \MensBeam\HTML\DOM\InnerNode\Document::__construct + */ public function testMethod_createAttribute_errors(): void { $this->expectException(DOMException::class); $this->expectExceptionCode(DOMException::INVALID_CHARACTER); @@ -65,7 +118,16 @@ class TestDocument extends \PHPUnit\Framework\TestCase { ]; } - /** @dataProvider provideMethod_createCDATASection_errors */ + /** + * @dataProvider provideMethod_createCDATASection_errors + * @covers \MensBeam\HTML\DOM\Document::createCDATASection + * + * @covers \MensBeam\HTML\DOM\Document::__construct + * @covers \MensBeam\HTML\DOM\DOMException::__construct + * @covers \MensBeam\HTML\DOM\DOMImplementation::__construct + * @covers \MensBeam\HTML\DOM\Node::__construct + * @covers \MensBeam\HTML\DOM\InnerNode\Document::__construct + */ public function testMethod_createCDATASection_errors(\Closure $closure, int $errorCode): void { $this->expectException(DOMException::class); $this->expectExceptionCode($errorCode); @@ -73,6 +135,15 @@ class TestDocument extends \PHPUnit\Framework\TestCase { } + /** + * @covers \MensBeam\HTML\DOM\Document::createElement + * + * @covers \MensBeam\HTML\DOM\Document::__construct + * @covers \MensBeam\HTML\DOM\DOMException::__construct + * @covers \MensBeam\HTML\DOM\DOMImplementation::__construct + * @covers \MensBeam\HTML\DOM\Node::__construct + * @covers \MensBeam\HTML\DOM\InnerNode\Document::__construct + */ public function testMethod_createElement_errors(): void { $this->expectException(DOMException::class); $this->expectExceptionCode(DOMException::INVALID_CHARACTER); @@ -81,6 +152,15 @@ class TestDocument extends \PHPUnit\Framework\TestCase { } + /** + * @covers \MensBeam\HTML\DOM\Document::importNode + * + * @covers \MensBeam\HTML\DOM\Document::__construct + * @covers \MensBeam\HTML\DOM\DOMException::__construct + * @covers \MensBeam\HTML\DOM\DOMImplementation::__construct + * @covers \MensBeam\HTML\DOM\Node::__construct + * @covers \MensBeam\HTML\DOM\InnerNode\Document::__construct + */ public function testMethod_importNode_errors(): void { $this->expectException(DOMException::class); $this->expectExceptionCode(DOMException::NOT_SUPPORTED); @@ -89,6 +169,28 @@ class TestDocument extends \PHPUnit\Framework\TestCase { } + /** + * @covers \MensBeam\HTML\DOM\Document::load + * + * @covers \MensBeam\HTML\DOM\Document::__construct + * @covers \MensBeam\HTML\DOM\Document::createElement + * @covers \MensBeam\HTML\DOM\DOMException::__construct + * @covers \MensBeam\HTML\DOM\DOMImplementation::__construct + * @covers \MensBeam\HTML\DOM\Element::__construct + * @covers \MensBeam\HTML\DOM\Node::__construct + * @covers \MensBeam\HTML\DOM\Node::appendChild + * @covers \MensBeam\HTML\DOM\Node::getInnerNode + * @covers \MensBeam\HTML\DOM\Node::hasChildNodes + * @covers \MensBeam\HTML\DOM\Node::preInsertionValidity + * @covers \MensBeam\HTML\DOM\InnerNode\Document::__construct + * @covers \MensBeam\HTML\DOM\InnerNode\Document::getWrapperNode + * @covers \MensBeam\HTML\DOM\InnerNode\NodeCache::get + * @covers \MensBeam\HTML\DOM\InnerNode\NodeCache::has + * @covers \MensBeam\HTML\DOM\InnerNode\NodeCache::key + * @covers \MensBeam\HTML\DOM\InnerNode\NodeCache::set + * @covers \MensBeam\HTML\DOM\InnerNode\Reflection::createFromProtectedConstructor + * @covers \MensBeam\HTML\DOM\InnerNode\Reflection::getProtectedProperty + */ public function testMethod_load_errors(): void { $this->expectException(DOMException::class); $this->expectExceptionCode(DOMException::NO_MODIFICATION_ALLOWED); @@ -98,6 +200,19 @@ class TestDocument extends \PHPUnit\Framework\TestCase { } + /** + * @covers \MensBeam\HTML\DOM\Document::loadFile + * + * @covers \MensBeam\HTML\DOM\Document::__construct + * @covers \MensBeam\HTML\DOM\Document::__get_charset + * @covers \MensBeam\HTML\DOM\Document::__get_URL + * @covers \MensBeam\HTML\DOM\Document::load + * @covers \MensBeam\HTML\DOM\DOMImplementation::__construct + * @covers \MensBeam\HTML\DOM\Node::__construct + * @covers \MensBeam\HTML\DOM\Node::cloneInnerNode + * @covers \MensBeam\HTML\DOM\Node::hasChildNodes + * @covers \MensBeam\HTML\DOM\InnerNode\Document::__construct + */ public function testMethod_loadFile(): void { $d = new Document(); @@ -125,6 +240,15 @@ class TestDocument extends \PHPUnit\Framework\TestCase { } + /** + * @covers \MensBeam\HTML\DOM\Document::loadFile + * + * @covers \MensBeam\HTML\DOM\Document::__construct + * @covers \MensBeam\HTML\DOM\DOMException::__construct + * @covers \MensBeam\HTML\DOM\DOMImplementation::__construct + * @covers \MensBeam\HTML\DOM\Node::__construct + * @covers \MensBeam\HTML\DOM\InnerNode\Document::__construct + */ public function testMethod_loadFile_errors(): void { $this->expectException(DOMException::class); $this->expectExceptionCode(DOMException::FILE_NOT_FOUND); @@ -133,6 +257,25 @@ class TestDocument extends \PHPUnit\Framework\TestCase { } + /** + * @covers \MensBeam\HTML\DOM\Document::serialize + * + * @covers \MensBeam\HTML\DOM\Document::__construct + * @covers \MensBeam\HTML\DOM\Document::createTextNode + * @covers \MensBeam\HTML\DOM\DOMException::__construct + * @covers \MensBeam\HTML\DOM\DOMImplementation::__construct + * @covers \MensBeam\HTML\DOM\Node::__construct + * @covers \MensBeam\HTML\DOM\Node::__get_ownerDocument + * @covers \MensBeam\HTML\DOM\Text::__construct + * @covers \MensBeam\HTML\DOM\InnerNode\Document::__construct + * @covers \MensBeam\HTML\DOM\InnerNode\Document::__get_wrapperNode + * @covers \MensBeam\HTML\DOM\InnerNode\Document::getWrapperNode + * @covers \MensBeam\HTML\DOM\InnerNode\NodeCache::get + * @covers \MensBeam\HTML\DOM\InnerNode\NodeCache::has + * @covers \MensBeam\HTML\DOM\InnerNode\NodeCache::key + * @covers \MensBeam\HTML\DOM\InnerNode\NodeCache::set + * @covers \MensBeam\HTML\DOM\InnerNode\Reflection::createFromProtectedConstructor + */ public function testMethod_serialize_errors(): void { $this->expectException(DOMException::class); $this->expectExceptionCode(DOMException::WRONG_DOCUMENT); diff --git a/tests/cases/TestNode.php b/tests/cases/TestNode.php index 08847ea..9e33489 100644 --- a/tests/cases/TestNode.php +++ b/tests/cases/TestNode.php @@ -136,9 +136,8 @@ class TestNode extends \PHPUnit\Framework\TestCase { * @covers \MensBeam\HTML\DOM\Collection::item * @covers \MensBeam\HTML\DOM\Document::__construct * @covers \MensBeam\HTML\DOM\Document::__get_body - * @covers \MensBeam\HTML\DOM\Document::getElementById - * @covers \MensBeam\HTML\DOM\Document::getElementsByTagName * @covers \MensBeam\HTML\DOM\Document::load + * @covers \MensBeam\HTML\DOM\DocumentOrElement::getElementsByTagName * @covers \MensBeam\HTML\DOM\DOMImplementation::__construct * @covers \MensBeam\HTML\DOM\Element::__construct * @covers \MensBeam\HTML\DOM\Element::__get_namespaceURI @@ -150,9 +149,11 @@ class TestNode extends \PHPUnit\Framework\TestCase { * @covers \MensBeam\HTML\DOM\Node::__get_parentNode * @covers \MensBeam\HTML\DOM\Node::cloneInnerNode * @covers \MensBeam\HTML\DOM\Node::containsInner + * @covers \MensBeam\HTML\DOM\Node::getInnerDocument * @covers \MensBeam\HTML\DOM\Node::getInnerNode * @covers \MensBeam\HTML\DOM\Node::hasChildNodes * @covers \MensBeam\HTML\DOM\Node::removeChild + * @covers \MensBeam\HTML\DOM\NonElementParentNode::getElementById * @covers \MensBeam\HTML\DOM\InnerNode\Document::__construct * @covers \MensBeam\HTML\DOM\InnerNode\Document::__get_wrapperNode * @covers \MensBeam\HTML\DOM\InnerNode\Document::getWrapperNode