Skip to content
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.

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

Fix error when getting parents() for HTML elements #58

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ QueryPath Changelog
- Fix for :nth-child(n+B) to select B-th and all following elements
- Fix for :nth-child(-n+B) to select first B elements
- Update PHPUnit Test Suite to use @dataProvider in testPseudoClassNthChild() to reduce code repetition
- Fix error when getting parents() for HTML elements

# 4.0.0

Expand Down
1 change: 0 additions & 1 deletion src/CSS/DOMTraverser/PseudoClass.php
Original file line number Diff line number Diff line change
Expand Up @@ -441,7 +441,6 @@ protected function isNthChild($node, $value, $reverse = false, $byType = false):
$parent = $node->parentNode;
if (empty($parent)
|| ($groupSize === 0 && $elementInGroup === 0)
|| ($groupSize > 0 && $elementInGroup > $groupSize)
) {
return false;
}
Expand Down
2 changes: 2 additions & 0 deletions src/CSS/DOMTraverser/Util.php
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,8 @@ public static function parseAnB($rule): array
$aVal = $matches[1] ?? 1;
if ($aVal === '-') {
$aVal = -1;
} elseif ($aVal === '') {
$aVal = 1;
} else {
$aVal = (int) $aVal;
}
Expand Down
49 changes: 28 additions & 21 deletions src/Helpers/QueryFilters.php
Original file line number Diff line number Diff line change
Expand Up @@ -796,26 +796,7 @@ public function closest($selector): Query
*/
public function parent($selector = null): Query
{
$found = new SplObjectStorage();
foreach ($this->matches as $m) {
while ($m->parentNode->nodeType !== XML_DOCUMENT_NODE) {
$m = $m->parentNode;
// Is there any case where parent node is not an element?
if ($m->nodeType === XML_ELEMENT_NODE) {
if (! empty($selector)) {
if (QueryPath::with($m, null, $this->options)->is($selector) > 0) {
$found->attach($m);
break;
}
} else {
$found->attach($m);
break;
}
}
}
}

return $this->inst($found, null);
return $this->getParentElements($selector, true);
}

/**
Expand All @@ -835,19 +816,45 @@ public function parent($selector = null): Query
* @see siblings()
*/
public function parents($selector = null): Query
{
return $this->getParentElements($selector, false);
}

/**
* Get ancestor(s) of each element in the DOMQuery.
*
* If a selector is present, only matching ancestors will be retrieved.
*
* @param string|null $selector
* A valid CSS 3 Selector.
* @param bool $immediate
* If function should return only the immediate parent
*
* @return DOMQuery
* A DOMNode object containing the matching ancestors.
* @throws ParseException
* @throws Exception
*/
private function getParentElements(?string $selector, bool $immediate): Query
{
$found = new SplObjectStorage();
foreach ($this->matches as $m) {
while ($m->parentNode->nodeType !== XML_DOCUMENT_NODE) {
while ($m->parentNode && $m->parentNode->nodeType !== XML_DOCUMENT_NODE) {
$m = $m->parentNode;
// Is there any case where parent node is not an element?
if ($m->nodeType === XML_ELEMENT_NODE) {
if (! empty($selector)) {
if (QueryPath::with($m, null, $this->options)->is($selector) > 0) {
$found->attach($m);
if ($immediate) {
break;
}
}
} else {
$found->attach($m);
if ($immediate) {
break;
}
}
}
}
Expand Down
168 changes: 35 additions & 133 deletions tests/QueryPath/CSS/PseudoClassTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -428,7 +428,29 @@ public function testNthLastChild()
$this->assertEquals(3, $i);
}

public function testNthChild()
public function nthChildProvider(): array
{
return [
['2n+1', 10, ['a', 'c']], // Every odd row
['odd', 10, ['a', 'c']], // Every odd row
['2n', 10, ['b', 'd']], // Every even row
['even', 10, ['b', 'd']], // Even (2n)
['4n-1', 5, 'c' ], // 4n - 1 == 4n + 3
['6n-1', 3, null ], // 6n - 1
['26n-1', 0, null ], // 26n - 1
['0n+0', 0, null ], // 0n + 0 -- spec says this is always FALSE
['3', 1, 'c' ], // 3 (0n+3)
['-n+3', 3, null ], // -n+3: First three elements
['n+3', 18, null ], // third+ elements
['2n+4', 9, ['d', 'b']], // fourth+ even elements
['6n+30', 0, null ], // 6n + 30. These should always fail to match
];
}

/**
* @dataProvider nthChildProvider
*/
public function testNthChild($pattern, $matchesCount, $matchTag)
{
$xml = '<?xml version="1.0"?><root>';
$xml .= str_repeat('<a/><b/><c/><d/>', 5);
Expand All @@ -438,145 +460,25 @@ public function testNthChild()
[$ele, $root] = $this->doc($xml, 'root');
$nl = $root->childNodes;

// 2n + 1 -- Every odd row.
$i = 0;
$expects = ['a', 'c'];
$j = 0;
foreach ($nl as $n) {
$res = $ps->elementMatches('nth-child', $n, $root, '2n+1');
if ($res) {
++$i;
$name = $n->tagName;
$this->assertContains($name, $expects, sprintf('Expected b or d, got %s in slot %s', $name, ++$j));
}
}
$this->assertEquals(10, $i, '2n+1 is ten items.');

// Odd
$i = 0;
$expects = ['a', 'c'];
$j = 0;
foreach ($nl as $n) {
$res = $ps->elementMatches('nth-child', $n, $root, 'odd');
if ($res) {
++$i;
$name = $n->tagName;
$this->assertContains($name, $expects, sprintf('Expected b or d, got %s in slot %s', $name, ++$j));
}
}
$this->assertEquals(10, $i, '2n+1 is ten items.');

// 2n + 0 -- every even row
$i = 0;
$expects = ['b', 'd'];
foreach ($nl as $n) {
$res = $ps->elementMatches('nth-child', $n, $root, '2n');
if ($res) {
++$i;
$name = $n->tagName;
$this->assertContains($name, $expects, 'Expected a or c, got ' . $name);
}
}
$this->assertEquals(10, $i, '2n+0 is ten items.');

// Even (2n)
$i = 0;
$expects = ['b', 'd'];
foreach ($nl as $n) {
$res = $ps->elementMatches('nth-child', $n, $root, 'even');
if ($res) {
++$i;
$name = $n->tagName;
$this->assertContains($name, $expects, 'Expected a or c, got ' . $name);
}
}
$this->assertEquals(10, $i, ' even is ten items.');

// 4n - 1 == 4n + 3
$i = 0;
$j = 0;
foreach ($nl as $n) {
$res = $ps->elementMatches('nth-child', $n, $root, '4n-1');
$res = $ps->elementMatches('nth-child', $n, $root, $pattern);
if ($res) {
++$i;
$name = $n->tagName;
$this->assertEquals('c', $name, 'Expected c, got ' . $name);
}
}
$this->assertEquals(5, $i);

// 6n - 1
$i = 0;
foreach ($nl as $n) {
$res = $ps->elementMatches('nth-child', $n, $root, '6n-1');
if ($res) {
++$i;
}
}
$this->assertEquals(3, $i);

// 6n + 1
$i = 0;
foreach ($nl as $n) {
$res = $ps->elementMatches('nth-child', $n, $root, '6n+1');
if ($res) {
++$i;
}
}
$this->assertEquals(4, $i);

// 26n - 1
$i = 0;
foreach ($nl as $n) {
$res = $ps->elementMatches('nth-child', $n, $root, '26n-1');
if ($res) {
++$i;
}
}
$this->assertEquals(0, $i);

// 0n + 0 -- spec says this is always FALSE.
$i = 0;
foreach ($nl as $n) {
$res = $ps->elementMatches('nth-child', $n, $root, '0n+0');
if ($res) {
++$i;
}
}
$this->assertEquals(0, $i);

// 3 (0n+3)
$i = 0;
foreach ($nl as $n) {
$res = $ps->elementMatches('nth-child', $n, $root, '3');
if ($res) {
++$i;
$this->assertEquals('c', $n->tagName);
}
}
$this->assertEquals(1, $i);

// -n+3: First three elements.
$i = 0;
foreach ($nl as $n) {
$res = $ps->elementMatches('nth-child', $n, $root, '-n+3');
if ($res) {
++$i;
//$this->assertEquals('c', $n->tagName);
}
}
$this->assertEquals(3, $i);

// BROKEN RULES -- these should always fail to match.

// 6n + 7;
$i = 0;
foreach ($nl as $n) {
$res = $ps->elementMatches('nth-child', $n, $root, '6n+7');
if ($res) {
++$i;
if (is_string($matchTag)) {
$this->assertEquals($matchTag, $name, 'Invalid tagName match');
} elseif (is_array($matchTag)) {
$this->assertContains(
$name,
$matchTag,
'Expected only ['.implode(', ', $matchTag).'] tags, got '.$name.' in slot '.++$j
);
}
}
}
$this->assertEquals(0, $i);
$this->assertEquals($matchesCount, $i, 'Invalid matches count');
}

public function testEven()
Expand Down
1 change: 1 addition & 0 deletions tests/QueryPath/CSS/UtilTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ public function testParseAnB()
$this->assertEquals([2, -1], Util::parseAnB('2n - 1'));
// -n + 3
$this->assertEquals([-1, 3], Util::parseAnB('-n+3'));
$this->assertEquals([1, 3], Util::parseAnB('n+3'));

// Test invalid values
$this->assertEquals([0, 0], Util::parseAnB('obviously + invalid'));
Expand Down
2 changes: 2 additions & 0 deletions tests/QueryPath/DOMQueryTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -1676,6 +1676,8 @@ public function testParent()
$this->assertEquals('root', qp($file, 'unary')->parent()->tag());
$this->assertEquals('root', qp($file, 'li')->parent('root')->tag());
$this->assertEquals(2, qp($file, 'li')->parent()->count());
$this->assertEquals(0, qp(DATA_HTML_FILE, 'html')->parent()->count());
$this->assertEquals(2, qp(DATA_HTML_FILE, 'table')->parents()->count());
}

public function testClosest()
Expand Down