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.

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

Jump to bottom

Text content line break rendering #344

Merged
merged 6 commits into from
Sep 24, 2024
Merged

Text content line break rendering #344

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
42a025f
TextContentRenderer: Replace stripNewlines with lineBreakRendering
robinst Sep 23, 2024
03d2843
Make test case more compact
robinst Sep 23, 2024
97eeb6a
Tests for separate blocks, implement tight/loose
robinst Sep 23, 2024
1906ee9
Document lineBreakRendering
robinst Sep 24, 2024
6e529d4
Fix tables rendering
robinst Sep 24, 2024
6cef998
Add test for heading
robinst Sep 24, 2024
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
30 changes: 11 additions & 19 deletions ...es/src/main/java/org/commonmark/ext/gfm/tables/internal/TableTextContentNodeRenderer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,11 @@ public TableTextContentNodeRenderer(TextContentNodeRendererContext context) {
}

protected void renderBlock(TableBlock tableBlock) {
// Render rows tight
textContentWriter.pushTight(true);
renderChildren(tableBlock);
if (tableBlock.getNext() != null) {
textContentWriter.write("\n");
}
textContentWriter.popTight();
textContentWriter.block();
}

protected void renderHead(TableHead tableHead) {
Expand All @@ -38,33 +39,24 @@ protected void renderBody(TableBody tableBody) {
}

protected void renderRow(TableRow tableRow) {
textContentWriter.line();
renderChildren(tableRow);
textContentWriter.line();
textContentWriter.block();
}

protected void renderCell(TableCell tableCell) {
renderChildren(tableCell);
textContentWriter.write('|');
textContentWriter.whitespace();
}

private void renderLastCell(TableCell tableCell) {
renderChildren(tableCell);
// For the last cell in row, don't render the delimiter
if (tableCell.getNext() != null) {
textContentWriter.write('|');
textContentWriter.whitespace();
}
}

private void renderChildren(Node parent) {
Node node = parent.getFirstChild();
while (node != null) {
Node next = node.getNext();

// For last cell in row, we dont render the delimiter.
if (node instanceof TableCell && next == null) {
renderLastCell((TableCell) node);
} else {
context.render(node);
}

context.render(node);
node = next;
}
}
Expand Down
102 changes: 65 additions & 37 deletions ...ark-ext-gfm-tables/src/test/java/org/commonmark/ext/gfm/tables/TablesTextContentTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,137 +2,165 @@

import org.commonmark.Extension;
import org.commonmark.parser.Parser;
import org.commonmark.renderer.text.LineBreakRendering;
import org.commonmark.renderer.text.TextContentRenderer;
import org.commonmark.testutil.RenderingTestCase;
import org.commonmark.testutil.Asserts;
import org.junit.Test;

import java.util.Set;

public class TablesTextContentTest extends RenderingTestCase {
public class TablesTextContentTest {

private static final Set<Extension> EXTENSIONS = Set.of(TablesExtension.create());
private static final Parser PARSER = Parser.builder().extensions(EXTENSIONS).build();
private static final TextContentRenderer RENDERER = TextContentRenderer.builder().extensions(EXTENSIONS).build();

private static final TextContentRenderer COMPACT_RENDERER = TextContentRenderer.builder().extensions(EXTENSIONS).build();
private static final TextContentRenderer SEPARATE_RENDERER = TextContentRenderer.builder().extensions(EXTENSIONS)
.lineBreakRendering(LineBreakRendering.SEPARATE_BLOCKS).build();
private static final TextContentRenderer STRIPPED_RENDERER = TextContentRenderer.builder().extensions(EXTENSIONS)
.lineBreakRendering(LineBreakRendering.STRIP).build();

@Test
public void oneHeadNoBody() {
assertRendering("Abc|Def\n---|---", "Abc| Def\n");
assertCompact("Abc|Def\n---|---", "Abc| Def");
}

@Test
public void oneColumnOneHeadNoBody() {
String expected = "Abc\n";
assertRendering("|Abc\n|---\n", expected);
assertRendering("|Abc|\n|---|\n", expected);
assertRendering("Abc|\n---|\n", expected);
String expected = "Abc";
assertCompact("|Abc\n|---\n", expected);
assertCompact("|Abc|\n|---|\n", expected);
assertCompact("Abc|\n---|\n", expected);

// Pipe required on separator
assertRendering("|Abc\n---\n", "|Abc");
assertCompact("|Abc\n---\n", "|Abc");
// Pipe required on head
assertRendering("Abc\n|---\n", "Abc\n|---");
assertCompact("Abc\n|---\n", "Abc\n|---");
}

@Test
public void oneColumnOneHeadOneBody() {
String expected = "Abc\n1\n";
assertRendering("|Abc\n|---\n|1", expected);
assertRendering("|Abc|\n|---|\n|1|", expected);
assertRendering("Abc|\n---|\n1|", expected);
String expected = "Abc\n1";
assertCompact("|Abc\n|---\n|1", expected);
assertCompact("|Abc|\n|---|\n|1|", expected);
assertCompact("Abc|\n---|\n1|", expected);

// Pipe required on separator
assertRendering("|Abc\n---\n|1", "|Abc\n|1");
assertCompact("|Abc\n---\n|1", "|Abc\n|1");
}

@Test
public void oneHeadOneBody() {
assertRendering("Abc|Def\n---|---\n1|2", "Abc| Def\n1| 2\n");
assertCompact("Abc|Def\n---|---\n1|2", "Abc| Def\n1| 2");
}

@Test
public void separatorMustNotHaveLessPartsThanHead() {
assertRendering("Abc|Def|Ghi\n---|---\n1|2|3", "Abc|Def|Ghi\n---|---\n1|2|3");
assertCompact("Abc|Def|Ghi\n---|---\n1|2|3", "Abc|Def|Ghi\n---|---\n1|2|3");
}

@Test
public void padding() {
assertRendering(" Abc | Def \n --- | --- \n 1 | 2 ", "Abc| Def\n1| 2\n");
assertCompact(" Abc | Def \n --- | --- \n 1 | 2 ", "Abc| Def\n1| 2");
}

@Test
public void paddingWithCodeBlockIndentation() {
assertRendering("Abc|Def\n---|---\n 1|2", "Abc| Def\n1| 2\n");
assertCompact("Abc|Def\n---|---\n 1|2", "Abc| Def\n1| 2");
}

@Test
public void pipesOnOutside() {
assertRendering("|Abc|Def|\n|---|---|\n|1|2|", "Abc| Def\n1| 2\n");
assertCompact("|Abc|Def|\n|---|---|\n|1|2|", "Abc| Def\n1| 2");
}

@Test
public void inlineElements() {
assertRendering("*Abc*|Def\n---|---\n1|2", "Abc| Def\n1| 2\n");
assertCompact("*Abc*|Def\n---|---\n1|2", "Abc| Def\n1| 2");
}

@Test
public void escapedPipe() {
assertRendering("Abc|Def\n---|---\n1\\|2|20", "Abc| Def\n1|2| 20\n");
assertCompact("Abc|Def\n---|---\n1\\|2|20", "Abc| Def\n1|2| 20");
}

@Test
public void alignLeft() {
assertRendering("Abc|Def\n:---|---\n1|2", "Abc| Def\n1| 2\n");
assertCompact("Abc|Def\n:---|---\n1|2", "Abc| Def\n1| 2");
}

@Test
public void alignRight() {
assertRendering("Abc|Def\n---:|---\n1|2", "Abc| Def\n1| 2\n");
assertCompact("Abc|Def\n---:|---\n1|2", "Abc| Def\n1| 2");
}

@Test
public void alignCenter() {
assertRendering("Abc|Def\n:---:|---\n1|2", "Abc| Def\n1| 2\n");
assertCompact("Abc|Def\n:---:|---\n1|2", "Abc| Def\n1| 2");
}

@Test
public void alignCenterSecond() {
assertRendering("Abc|Def\n---|:---:\n1|2", "Abc| Def\n1| 2\n");
assertCompact("Abc|Def\n---|:---:\n1|2", "Abc| Def\n1| 2");
}

@Test
public void alignLeftWithSpaces() {
assertRendering("Abc|Def\n :--- |---\n1|2", "Abc| Def\n1| 2\n");
assertCompact("Abc|Def\n :--- |---\n1|2", "Abc| Def\n1| 2");
}

@Test
public void alignmentMarkerMustBeNextToDashes() {
assertRendering("Abc|Def\n: ---|---", "Abc|Def\n: ---|---");
assertRendering("Abc|Def\n--- :|---", "Abc|Def\n--- :|---");
assertRendering("Abc|Def\n---|: ---", "Abc|Def\n---|: ---");
assertRendering("Abc|Def\n---|--- :", "Abc|Def\n---|--- :");
assertCompact("Abc|Def\n: ---|---", "Abc|Def\n: ---|---");
assertCompact("Abc|Def\n--- :|---", "Abc|Def\n--- :|---");
assertCompact("Abc|Def\n---|: ---", "Abc|Def\n---|: ---");
assertCompact("Abc|Def\n---|--- :", "Abc|Def\n---|--- :");
}

@Test
public void bodyCanNotHaveMoreColumnsThanHead() {
assertRendering("Abc|Def\n---|---\n1|2|3", "Abc| Def\n1| 2\n");
assertCompact("Abc|Def\n---|---\n1|2|3", "Abc| Def\n1| 2");
}

@Test
public void bodyWithFewerColumnsThanHeadResultsInEmptyCells() {
assertRendering("Abc|Def|Ghi\n---|---|---\n1|2", "Abc| Def| Ghi\n1| 2| \n");
assertCompact("Abc|Def|Ghi\n---|---|---\n1|2", "Abc| Def| Ghi\n1| 2| ");
}

@Test
public void insideBlockQuote() {
assertRendering("> Abc|Def\n> ---|---\n> 1|2", "«\nAbc| Def\n1| 2\n»");
assertCompact("> Abc|Def\n> ---|---\n> 1|2", "«Abc| Def\n1| 2»");
}

@Test
public void tableWithLazyContinuationLine() {
assertRendering("Abc|Def\n---|---\n1|2\nlazy", "Abc| Def\n1| 2\nlazy| \n");
assertCompact("Abc|Def\n---|---\n1|2\nlazy", "Abc| Def\n1| 2\nlazy| ");
}

@Test
public void tableBetweenOtherBlocks() {
var s = "Foo\n\nAbc|Def\n---|---\n1|2\n\nBar";
assertCompact(s, "Foo\nAbc| Def\n1| 2\nBar");
assertSeparate(s, "Foo\n\nAbc| Def\n1| 2\n\nBar");
assertStripped(s, "Foo Abc| Def 1| 2 Bar");
}

private void assertCompact(String source, String expected) {
var doc = PARSER.parse(source);
var actualRendering = COMPACT_RENDERER.render(doc);
Asserts.assertRendering(source, expected, actualRendering);
}

private void assertSeparate(String source, String expected) {
var doc = PARSER.parse(source);
var actualRendering = SEPARATE_RENDERER.render(doc);
Asserts.assertRendering(source, expected, actualRendering);
}

@Override
protected String render(String source) {
return RENDERER.render(PARSER.parse(source));
private void assertStripped(String source, String expected) {
var doc = PARSER.parse(source);
var actualRendering = STRIPPED_RENDERER.render(doc);
Asserts.assertRendering(source, expected, actualRendering);
}
}
Loading