Skip to content

Use PHP native html parsing (drops support for PHP < 8.4) #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
acoulton merged 4 commits into from
Mar 10, 2026
Merged

Use PHP native html parsing (drops support for PHP < 8.4) #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3a25bda
test: Fix test data for cell containing `<time>`
acoulton Mar 10, 2026
b254318
fix: Correctly handle parse errors in html tables
acoulton Mar 10, 2026
a5a1f27
chore: Drop support for PHP < 8.4
acoulton Mar 10, 2026
23b87f0
feat: Use native html5 parsing instead of masterminds/html5
acoulton Mar 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 0 additions & 12 deletions .github/workflows/test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,10 @@ jobs:
fail-fast: false
matrix:
php_version:
- '8.0'
- '8.1'
- '8.2'
- '8.3'
- '8.4'
dependencies:
- 'default'
include:
- php_version: '8.0'
dependencies: 'lowest'
- php_version: '8.1'
dependencies: 'lowest'
- php_version: '8.2'
dependencies: 'lowest'
- php_version: '8.3'
dependencies: 'lowest'
- php_version: '8.4'
dependencies: 'lowest'
steps:
Expand Down
7 changes: 7 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@ This project adheres to [Semantic Versioning](http://semver.org/).

## Unreleased

* Use native `HTMLDocument` parsing instead of masterminds/html5
* Drop support for PHP < 8.4 (to allow us to use native HTML parsing)

## 1.3.3 / 2026-03-10

* Fix handling and reporting parse errors when parsing an html table.

## 1.3.2 / 2025-05-06

* Support PHP 8.4 (thanks @mharmuth)
Expand Down
3 changes: 1 addition & 2 deletions composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@
"minimum-stability": "stable",
"require": {
"behat/gherkin": ">=2.0.0 <5.0.0",
"masterminds/html5": "^2.7.5",
"php": "~8.0.0 || ~8.1.0 || ~8.2.0 || ~8.3.0 || ~8.4.0",
"php": ">= 8.4 < 8.5",
"ext-dom": "*",
"ext-SimpleXML": "*",
"ext-libxml": "*"
Expand Down
48 changes: 31 additions & 17 deletions src/TableParser/HTML/HTMLStringTableParser.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,13 @@
namespace Ingenerator\BehatTableAssert\TableParser\HTML;


use Behat\Gherkin\Node\TableNode;
use Dom\HTMLDocument;
use Dom\HTMLElement;
use Ingenerator\BehatTableAssert\TableNode\PaddedTableNode;
use LibXMLError;
use Masterminds\HTML5;
use function Dom\import_simplexml;

/**
* Parses an HTML string for a <table> element into a TableNode. The table must have a single row
Expand Down Expand Up @@ -90,33 +94,43 @@ public function parse($html)
*/
protected function parseHTMLString($html)
{
$old_use_internal_errors = \libxml_use_internal_errors(TRUE);
try {
$html5 = new HTML5();
$dom = $html5->loadHTML(
'<!DOCTYPE html><html>'
.'<head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"></head>'
.'<body>'.\trim($html).'</body>'
.'</html>'
set_error_handler(
fn($errno, $errstr) => throw new \InvalidArgumentException(
sprintf("Invalid HTML: %s\n\n===HTML===\n%s", $errstr, $html),
),
);

$table_elem = $dom->getElementsByTagName('body')->item(0)->firstChild;
$table = \simplexml_import_dom($table_elem);
if ($errors = \libxml_get_errors()) {
$this->throwInvalidHTMLException($html, $errors);
}
$dom = HTMLDocument::createFromString(
sprintf(
<<<'HTML'
<!DOCTYPE html>
<html>
<head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"></head>
<body>%s</body>
</html>
HTML,
trim($html),
),
);
} finally {
\libxml_clear_errors();
\libxml_use_internal_errors($old_use_internal_errors);
restore_error_handler();
}

$table_elem = $dom->getElementsByTagName('body')->item(0)->firstChild;

if (!$table_elem instanceof HTMLElement) {
throw new \InvalidArgumentException(
sprintf("Expected html root element but got %s\n\n===HTML===\n%s", get_debug_type($table_elem), $html),
);
}
$table = \simplexml_import_dom($table_elem);
Copy link
Member Author

@acoulton acoulton Mar 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could in theory drop a bunch of the to/from simplexml stuff, the problem is we'd need a 2.0 release as the internal API of this class is all protected rather than private and the implementation expects to be passing simplexml nodes around.

There's a bigger set of tidying / refactoring we'd need to do for a 2.0 so I've gone with just the minimum to use the native parser without breaking BC.


return $table;
}

/**
* @param string $html
* @param LibXMLError[] $errors
* @deprecated no longer called by the library
*/
protected function throwInvalidHTMLException($html, $errors)
{
Expand Down Expand Up @@ -224,7 +238,7 @@ protected function findCellTextValues(\SimpleXMLElement $table_row)
*/
protected function parseCellText(\SimpleXmlElement $cell)
{
$text = \trim(\preg_replace('/\s+/', ' ', \dom_import_simplexml($cell)->textContent));
$text = \trim(\preg_replace('/\s+/', ' ', import_simplexml($cell)->textContent));

if ($prefix = (string) $cell['data-behat-table-prefix']) {
$text = $prefix.' '.$text;
Expand Down
35 changes: 7 additions & 28 deletions test/TableParser/HTML/HTMLStringTableParserTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,37 +35,16 @@ public function test_it_throws_when_parsing_non_or_empty_string($value)
}

/**
* @testWith ["random", false]
* ["random", true]
* ["<div></div>", false]
* ["<table><thead><tr><td>1</td></tr></thead><tbody></tbody></table>", false]
* @testWith ["random text", "Expected html root element but got Dom\\Text"]
* ["<div><17sd>illegal tag name</17sd></div>", "Invalid HTML: Dom\\HTMLDocument::createFromString(): tokenizer error invalid-first-character-of-tag-name"]
* ["<div></div>", "Expected a <table> but got div"]
*/
public function test_it_always_restores_state_of_libxml_error_handling(
$html,
$use_errors_before
) {
$old_setting = \libxml_use_internal_errors($use_errors_before);
try {
$this->newSubject()->parse($html);
} catch (\Exception $e) { /* ignore */
}
$errors_after = \libxml_get_errors();
$use_errors_after = \libxml_use_internal_errors($old_setting);

$this->assertSame([], $errors_after, 'Should clear libxml errors');
$this->assertEquals(
$use_errors_before,
$use_errors_after,
'Should restore libxml_use_internal_errors'
);
}

public function test_it_throws_when_parsing_html_that_is_not_a_table()
public function test_it_throws_when_parsing_html_that_is_not_a_table_or_not_valid(string $input, string $expect_msg)
{
$this->expectException(\InvalidArgumentException::class);
$this->expectExceptionMessage('Expected a <table>');
$this->expectExceptionMessage($expect_msg);

$this->newSubject()->parse('<div></div>');
$this->newSubject()->parse($input);
}

public function test_it_throws_when_parsing_table_without_thead()
Expand Down Expand Up @@ -224,7 +203,7 @@ public function provider_valid_html_tables()
'<table>'.
'<thead><tr><td>Header</td><th>Date</th></tr></thead>'.
'<tbody>'.
'<tr><td>Cell1</td><time datetime="2016-08-30T12:00:00Z">30 Aug 2016</time></tr>'.
'<tr><td>Cell1</td><td><time datetime="2016-08-30T12:00:00Z">30 Aug 2016</time></td></tr>'.
'</tbody></table>',
[
['Header', 'Date'],
Expand Down
Loading