adding test case for sections closing too far

[weaverryan]

I noticed a minor issue with the section tags. Take the following situation:

h1 Foo
=====

h2 Bar
------

h3 Baz
~~~~~

h2 Bazzles
-----------

The h2 Bazzles should still be a child inside the h1 Foo section. But the HTML markup closes and puts the h2 into a sibling div of the h1.

This includes a failing test case to show the behavior - but I'm not sure where this is controlled in the code.

Cheers!

[greg0ire]

@weaverryan I'm super late to the party but I think it is here:

rst-parser/lib/Parser/DocumentParser.php

Lines 486 to 496 in 55253fc

	if ($this->lastTitleNode !== null) {
	// current level is less than previous so we need to end all open sections
	if ($node->getLevel() < $this->lastTitleNode->getLevel()) {
	foreach ($this->openTitleNodes as $titleNode) {
	$this->endOpenSection($titleNode);
	}
	// same level as the last so just close the last open section
	} elseif ($node->getLevel() === $this->lastTitleNode->getLevel()) {
	$this->endOpenSection($this->lastTitleNode);
	}
	}

[greg0ire]

we need to end all open sections

No we don't! 😛

[greg0ire]

I fixed the test but broke other tests… whack-a-mole!

[greg0ire]

@weaverryan @wouterj please review carefully, it looks super suspicious to me that I had to edit these extra test files.

[wouterj]

Looks good!

Don't worry about having to edit other tests if you make a change: It's common in this package that the test files are copy-pasted from the output. E.g. the "titles" test is testing the h1, h2, etc. elements, the rest was just copy-pasted from the output and not looked at. In other words: tests may contain completely bad expectations