Skip to content

Split definition list content by blank lines into separate dd elements #48

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

Closed
dereuromark wants to merge 3 commits into from
Closed

Split definition list content by blank lines into separate dd elements #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d433cbc
Split definition list content by blank lines into separate dd elements
dereuromark Dec 13, 2025
4fc46e1
Add skip mechanism for intentional spec deviations in official test s…
dereuromark Dec 13, 2025
6a74a14
Fix CS.
dereuromark Dec 13, 2025
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
46 changes: 5 additions & 41 deletions src/Parser/BlockParser.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1847,9 +1847,8 @@ protected function tryParseDjotDefinitionList(Node $parent, array $lines, int $s
}

// Now collect definition content (after blank line, 2-space indent)
// When multiple terms share definitions, each paragraph block becomes a separate dd
// Blank lines within definition content create separate dd elements
$defLines = [];
$multipleTerms = count($terms) > 1;

// If term started with code fence, add it to definition content
if ($codeFenceInfo !== null) {
Expand Down Expand Up @@ -1881,8 +1880,8 @@ protected function tryParseDjotDefinitionList(Node $parent, array $lines, int $s
}

// Create definition node(s)
if ($multipleTerms && $defLines !== []) {
// Split by blank lines - each block becomes a separate dd
// Split by blank lines - each block becomes a separate dd
if ($defLines !== []) {
$blocks = $this->splitByBlankLines($defLines);
foreach ($blocks as $block) {
$def = new DefinitionDescription();
Expand All @@ -1906,43 +1905,8 @@ protected function tryParseDjotDefinitionList(Node $parent, array $lines, int $s
$defList->appendChild($def);
}
} else {
// Single term: all content goes in one dd
$def = new DefinitionDescription();
$defAttributes = [];
if ($defLines !== []) {
// Skip leading blank lines using index (avoid O(n) array_shift)
$defStart = 0;
$defLineCount = count($defLines);
while ($defStart < $defLineCount && $defLines[$defStart] === '') {
$defStart++;
}
// Remove trailing blank lines (but preserve potential attribute line)
$defEnd = $defLineCount;
while ($defEnd > $defStart + 1 && $defLines[$defEnd - 1] === '') {
$defEnd--;
}

// Check if last line is a standalone attribute block for the dd
if ($defEnd > $defStart && preg_match('/^\{([^{}]+)\}\s*$/', $defLines[$defEnd - 1], $attrMatch)) {
$defAttributes = AttributeParser::parse($attrMatch[1]);
$defEnd--;
// Remove any trailing blank lines before the attribute
while ($defEnd > $defStart && $defLines[$defEnd - 1] === '') {
$defEnd--;
}
}

if ($defEnd > $defStart) {
$this->parseBlocks($def, array_slice($defLines, $defStart, $defEnd - $defStart), 0);
}
}
// Apply definition attributes
if ($defAttributes !== []) {
foreach ($defAttributes as $key => $value) {
$def->setAttribute($key, $value);
}
}
$defList->appendChild($def);
// Term with no definition content - create empty dd
$defList->appendChild(new DefinitionDescription());
}
}

Expand Down
19 changes: 19 additions & 0 deletions tests/OfficialTestSuiteTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,19 @@
#[Group('official')]
class OfficialTestSuiteTest extends TestCase
{
/**
* Tests to skip due to intentional spec deviations
*
* Format: 'filename_index' => 'reason for deviation'
*
* @var array<string, string>
*/
protected const INTENTIONAL_DEVIATIONS = [
// We split definition content by blank lines into separate <dd> elements
// for more semantic HTML structure. Spec keeps all in one <dd>.
'definition_lists_2' => 'Blank lines split into separate <dd> elements',
];

protected DjotConverter $converter;

protected function setUp(): void
Expand Down Expand Up @@ -135,6 +148,12 @@ public static function officialTestProvider(): array
#[DataProvider('officialTestProvider')]
public function testOfficialSuite(string $input, string $expected, string $file, int $index): void
{
$testName = basename($file, '.test') . '_' . $index;

if (isset(self::INTENTIONAL_DEVIATIONS[$testName])) {
$this->markTestSkipped('Intentional deviation: ' . self::INTENTIONAL_DEVIATIONS[$testName]);
}

$result = $this->converter->convert($input);

// Normalize whitespace for comparison
Expand Down
29 changes: 29 additions & 0 deletions tests/TestCase/Parser/BlockParserTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,35 @@ public function testParseDefinitionListDdAttributeBeforeContentNotParsed(): void
$this->assertNull($dd->getAttribute('class'));
}

public function testParseDefinitionListBlankLineSplitsDd(): void
{
// Blank lines within definition content create separate dd elements
$djot = ": Term\n\n First paragraph\n\n Second paragraph";
$doc = $this->parser->parse($djot);

$dl = $doc->getChildren()[0];
$this->assertInstanceOf(DefinitionList::class, $dl);

// Should have: dt + dd + dd = 3 children
$children = $dl->getChildren();
$dds = array_filter($children, fn ($c) => $c->getType() === 'definition_description');
$this->assertCount(2, $dds);
}

public function testParseDefinitionListEmptyDd(): void
{
// Term with no definition content should still create empty dd
$djot = ': Term';
$doc = $this->parser->parse($djot);

$dl = $doc->getChildren()[0];
$this->assertInstanceOf(DefinitionList::class, $dl);

$children = $dl->getChildren();
$dds = array_filter($children, fn ($c) => $c->getType() === 'definition_description');
$this->assertCount(1, $dds);
}

public function testParseThematicBreak(): void
{
$doc = $this->parser->parse('---');
Expand Down