Merge pull request #357 from sebthom/cleanup

robinst · web-flow · commit 9b56a4b80ed8 · 2025-01-06T22:13:02.000+11:00
refact: minor code cleanup
diff --git a/commonmark-ext-footnotes/src/main/java/org/commonmark/ext/footnotes/FootnotesExtension.java b/commonmark-ext-footnotes/src/main/java/org/commonmark/ext/footnotes/FootnotesExtension.java
@@ -3,7 +3,6 @@
 import org.commonmark.Extension;
 import org.commonmark.ext.footnotes.internal.*;
 import org.commonmark.parser.Parser;
-import org.commonmark.parser.beta.InlineContentParserFactory;
 import org.commonmark.renderer.NodeRenderer;
 import org.commonmark.renderer.html.HtmlRenderer;
 import org.commonmark.renderer.markdown.MarkdownNodeRendererContext;
diff --git a/commonmark-ext-footnotes/src/main/java/org/commonmark/ext/footnotes/internal/FootnoteLinkProcessor.java b/commonmark-ext-footnotes/src/main/java/org/commonmark/ext/footnotes/internal/FootnoteLinkProcessor.java
@@ -4,7 +4,6 @@
 import org.commonmark.ext.footnotes.FootnoteReference;
 import org.commonmark.ext.footnotes.InlineFootnote;
 import org.commonmark.node.LinkReferenceDefinition;
-import org.commonmark.node.Text;
 import org.commonmark.parser.InlineParserContext;
 import org.commonmark.parser.beta.LinkInfo;
 import org.commonmark.parser.beta.LinkProcessor;
diff --git a/commonmark-ext-footnotes/src/main/java/org/commonmark/ext/footnotes/internal/FootnoteMarkdownNodeRenderer.java b/commonmark-ext-footnotes/src/main/java/org/commonmark/ext/footnotes/internal/FootnoteMarkdownNodeRenderer.java
@@ -5,14 +5,9 @@
 import org.commonmark.ext.footnotes.InlineFootnote;
 import org.commonmark.node.*;
 import org.commonmark.renderer.NodeRenderer;
-import org.commonmark.renderer.html.HtmlNodeRendererContext;
-import org.commonmark.renderer.html.HtmlWriter;
 import org.commonmark.renderer.markdown.MarkdownNodeRendererContext;
 import org.commonmark.renderer.markdown.MarkdownWriter;
 
-import java.util.ArrayList;
-import java.util.LinkedHashMap;
-import java.util.List;
 import java.util.Set;
 
 public class FootnoteMarkdownNodeRenderer implements NodeRenderer {
diff --git a/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/internal/TableHtmlNodeRenderer.java b/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/internal/TableHtmlNodeRenderer.java
@@ -17,6 +17,7 @@ public TableHtmlNodeRenderer(HtmlNodeRendererContext context) {
         this.context = context;
     }
 
+    @Override
     protected void renderBlock(TableBlock tableBlock) {
         htmlWriter.line();
         htmlWriter.tag("table", getAttributes(tableBlock, "table"));
@@ -25,6 +26,7 @@ protected void renderBlock(TableBlock tableBlock) {
         htmlWriter.line();
     }
 
+    @Override
     protected void renderHead(TableHead tableHead) {
         htmlWriter.line();
         htmlWriter.tag("thead", getAttributes(tableHead, "thead"));
@@ -33,6 +35,7 @@ protected void renderHead(TableHead tableHead) {
         htmlWriter.line();
     }
 
+    @Override
     protected void renderBody(TableBody tableBody) {
         htmlWriter.line();
         htmlWriter.tag("tbody", getAttributes(tableBody, "tbody"));
@@ -41,6 +44,7 @@ protected void renderBody(TableBody tableBody) {
         htmlWriter.line();
     }
 
+    @Override
     protected void renderRow(TableRow tableRow) {
         htmlWriter.line();
         htmlWriter.tag("tr", getAttributes(tableRow, "tr"));
@@ -49,6 +53,7 @@ protected void renderRow(TableRow tableRow) {
         htmlWriter.line();
     }
 
+    @Override
     protected void renderCell(TableCell tableCell) {
         String tagName = tableCell.isHeader() ? "th" : "td";
         htmlWriter.line();
diff --git a/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/internal/TableMarkdownNodeRenderer.java b/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/internal/TableMarkdownNodeRenderer.java
@@ -2,7 +2,6 @@
 
 import org.commonmark.ext.gfm.tables.*;
 import org.commonmark.node.Node;
-import org.commonmark.renderer.NodeRenderer;
 import org.commonmark.renderer.markdown.MarkdownNodeRendererContext;
 import org.commonmark.renderer.markdown.MarkdownWriter;
 import org.commonmark.text.AsciiMatcher;
@@ -13,7 +12,7 @@
 /**
  * The Table node renderer that is needed for rendering GFM tables (GitHub Flavored Markdown) to text content.
  */
-public class TableMarkdownNodeRenderer extends TableNodeRenderer implements NodeRenderer {
+public class TableMarkdownNodeRenderer extends TableNodeRenderer {
     private final MarkdownWriter writer;
     private final MarkdownNodeRendererContext context;
 
diff --git a/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/internal/TableTextContentNodeRenderer.java b/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/internal/TableTextContentNodeRenderer.java
@@ -22,6 +22,7 @@ public TableTextContentNodeRenderer(TextContentNodeRendererContext context) {
         this.context = context;
     }
 
+    @Override
     protected void renderBlock(TableBlock tableBlock) {
         // Render rows tight
         textContentWriter.pushTight(true);
@@ -30,19 +31,23 @@ protected void renderBlock(TableBlock tableBlock) {
         textContentWriter.block();
     }
 
+    @Override
     protected void renderHead(TableHead tableHead) {
         renderChildren(tableHead);
     }
 
+    @Override
     protected void renderBody(TableBody tableBody) {
         renderChildren(tableBody);
     }
 
+    @Override
     protected void renderRow(TableRow tableRow) {
         renderChildren(tableRow);
         textContentWriter.block();
     }
 
+    @Override
     protected void renderCell(TableCell tableCell) {
         renderChildren(tableCell);
         // For the last cell in row, don't render the delimiter
diff --git a/commonmark-ext-gfm-tables/src/test/java/org/commonmark/ext/gfm/tables/TablesTest.java b/commonmark-ext-gfm-tables/src/test/java/org/commonmark/ext/gfm/tables/TablesTest.java
@@ -15,8 +15,8 @@
 import java.util.*;
 
 import static org.hamcrest.CoreMatchers.is;
+import static org.hamcrest.MatcherAssert.assertThat;
 import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertThat;
 
 public class TablesTest extends RenderingTestCase {
 
diff --git a/commonmark-integration-test/src/test/java/org/commonmark/integration/ExtensionsIntegrationTest.java b/commonmark-integration-test/src/test/java/org/commonmark/integration/ExtensionsIntegrationTest.java
@@ -31,6 +31,7 @@ public void testTaskListItems() {
 
     }
 
+    @Override
     protected String render(String source) {
         return RENDERER.render(PARSER.parse(source));
     }
diff --git a/commonmark-test-util/src/main/java/org/commonmark/testutil/SpecTestCase.java b/commonmark-test-util/src/main/java/org/commonmark/testutil/SpecTestCase.java
@@ -2,16 +2,13 @@
 
 import org.commonmark.testutil.example.Example;
 import org.commonmark.testutil.example.ExampleReader;
-import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.junit.runners.Parameterized;
 import org.junit.runners.Parameterized.Parameters;
 
 import java.util.ArrayList;
 import java.util.List;
 
-import static org.commonmark.testutil.Asserts.assertRendering;
-
 @RunWith(Parameterized.class)
 public abstract class SpecTestCase {
 
diff --git a/commonmark/src/main/java/org/commonmark/internal/BlockQuoteParser.java b/commonmark/src/main/java/org/commonmark/internal/BlockQuoteParser.java
@@ -46,6 +46,7 @@ private static boolean isMarker(ParserState state, int index) {
     }
 
     public static class Factory extends AbstractBlockParserFactory {
+        @Override
         public BlockStart tryStart(ParserState state, MatchedBlockParser matchedBlockParser) {
             int nextNonSpace = state.getNextNonSpaceIndex();
             if (isMarker(state, nextNonSpace)) {
diff --git a/commonmark/src/main/java/org/commonmark/internal/DocumentParser.java b/commonmark/src/main/java/org/commonmark/internal/DocumentParser.java
@@ -13,7 +13,6 @@
 import org.commonmark.parser.delimiter.DelimiterProcessor;
 import org.commonmark.text.Characters;
 
-import java.io.BufferedReader;
 import java.io.IOException;
 import java.io.Reader;
 import java.util.*;
diff --git a/commonmark/src/main/java/org/commonmark/internal/LinkReferenceDefinitionParser.java b/commonmark/src/main/java/org/commonmark/internal/LinkReferenceDefinitionParser.java
@@ -2,7 +2,6 @@
 
 import org.commonmark.internal.util.Escaping;
 import org.commonmark.internal.util.LinkScanner;
-import org.commonmark.node.DefinitionMap;
 import org.commonmark.node.LinkReferenceDefinition;
 import org.commonmark.node.SourceSpan;
 import org.commonmark.parser.SourceLine;
diff --git a/commonmark/src/main/java/org/commonmark/internal/ParagraphParser.java b/commonmark/src/main/java/org/commonmark/internal/ParagraphParser.java
@@ -9,7 +9,6 @@
 import org.commonmark.parser.block.ParserState;
 
 import java.util.List;
-import java.util.Map;
 
 public class ParagraphParser extends AbstractBlockParser {
 
diff --git a/commonmark/src/main/java/org/commonmark/internal/util/Escaping.java b/commonmark/src/main/java/org/commonmark/internal/util/Escaping.java
@@ -1,6 +1,5 @@
 package org.commonmark.internal.util;
 
-import java.nio.charset.Charset;
 import java.nio.charset.StandardCharsets;
 import java.util.Locale;
 import java.util.regex.Matcher;
diff --git a/commonmark/src/main/java/org/commonmark/node/Block.java b/commonmark/src/main/java/org/commonmark/node/Block.java
@@ -5,6 +5,7 @@
  */
 public abstract class Block extends Node {
 
+    @Override
     public Block getParent() {
         return (Block) super.getParent();
     }
diff --git a/commonmark/src/main/java/org/commonmark/renderer/markdown/MarkdownRenderer.java b/commonmark/src/main/java/org/commonmark/renderer/markdown/MarkdownRenderer.java
@@ -130,7 +130,7 @@ private class RendererContext implements MarkdownNodeRendererContext {
         private RendererContext(MarkdownWriter writer) {
             // Set fields that are used by interface
             this.writer = writer;
-            Set<Character> escapes = new HashSet<Character>();
+            Set<Character> escapes = new HashSet<>();
             for (MarkdownNodeRendererFactory factory : nodeRendererFactories) {
                 escapes.addAll(factory.getSpecialCharacters());
             }
diff --git a/commonmark/src/test/java/org/commonmark/internal/DocumentParserTest.java b/commonmark/src/test/java/org/commonmark/internal/DocumentParserTest.java
@@ -9,7 +9,7 @@
 import java.util.Set;
 
 import static org.hamcrest.CoreMatchers.is;
-import static org.junit.Assert.assertThat;
+import static org.hamcrest.MatcherAssert.assertThat;
 import static org.junit.Assert.assertTrue;
 
 public class DocumentParserTest {
diff --git a/commonmark/src/test/java/org/commonmark/renderer/markdown/MarkdownRendererTest.java b/commonmark/src/test/java/org/commonmark/renderer/markdown/MarkdownRendererTest.java
@@ -2,7 +2,6 @@
 
 import org.commonmark.node.*;
 import org.commonmark.parser.Parser;
-import org.commonmark.testutil.Asserts;
 import org.junit.Test;
 
 import static org.commonmark.testutil.Asserts.assertRendering;
diff --git a/commonmark/src/test/java/org/commonmark/test/HtmlRendererTest.java b/commonmark/src/test/java/org/commonmark/test/HtmlRendererTest.java
@@ -4,8 +4,6 @@
 import org.commonmark.parser.Parser;
 import org.commonmark.renderer.NodeRenderer;
 import org.commonmark.renderer.html.*;
-import org.commonmark.testutil.Asserts;
-import org.commonmark.testutil.RenderingTestCase;
 import org.commonmark.testutil.TestResources;
 import org.junit.Test;
 
@@ -19,8 +17,8 @@
 import java.util.concurrent.Future;
 
 import static org.hamcrest.CoreMatchers.is;
+import static org.hamcrest.MatcherAssert.assertThat;
 import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertThat;
 
 public class HtmlRendererTest {
 
diff --git a/commonmark/src/test/java/org/commonmark/test/LinkReferenceDefinitionNodeTest.java b/commonmark/src/test/java/org/commonmark/test/LinkReferenceDefinitionNodeTest.java
@@ -8,7 +8,7 @@
 
 import static org.hamcrest.CoreMatchers.instanceOf;
 import static org.hamcrest.CoreMatchers.is;
-import static org.junit.Assert.assertThat;
+import static org.hamcrest.MatcherAssert.assertThat;
 
 public class LinkReferenceDefinitionNodeTest {
 
diff --git a/commonmark/src/test/java/org/commonmark/test/ListBlockParserTest.java b/commonmark/src/test/java/org/commonmark/test/ListBlockParserTest.java
@@ -6,7 +6,6 @@
 import org.junit.Test;
 
 import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertNotNull;
 
 public class ListBlockParserTest {
 
diff --git a/commonmark/src/test/java/org/commonmark/test/ParserTest.java b/commonmark/src/test/java/org/commonmark/test/ParserTest.java
@@ -21,8 +21,8 @@
 import java.util.concurrent.Future;
 
 import static org.hamcrest.CoreMatchers.*;
+import static org.hamcrest.MatcherAssert.assertThat;
 import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertThat;
 
 public class ParserTest {
 
diff --git a/commonmark/src/test/java/org/commonmark/test/SourceSpanRenderer.java b/commonmark/src/test/java/org/commonmark/test/SourceSpanRenderer.java
@@ -2,7 +2,6 @@
 
 import org.commonmark.node.AbstractVisitor;
 import org.commonmark.node.Node;
-import org.commonmark.node.SourceSpan;
 
 import java.util.*;
 
diff --git a/commonmark/src/test/java/org/commonmark/test/TextContentRendererTest.java b/commonmark/src/test/java/org/commonmark/test/TextContentRendererTest.java
@@ -13,15 +13,14 @@
 
 import java.util.Set;
 
-import static org.junit.Assert.assertEquals;
-
 public class TextContentRendererTest {
 
     private static final Parser PARSER = Parser.builder().build();
     private static final TextContentRenderer COMPACT_RENDERER = TextContentRenderer.builder().build();
     private static final TextContentRenderer SEPARATE_RENDERER = TextContentRenderer.builder()
             .lineBreakRendering(LineBreakRendering.SEPARATE_BLOCKS).build();
-    private static final TextContentRenderer STRIPPED_RENDERER = TextContentRenderer.builder().stripNewlines(true).build();
+    private static final TextContentRenderer STRIPPED_RENDERER = TextContentRenderer.builder()
+            .lineBreakRendering(LineBreakRendering.STRIP).build();
 
     @Test
     public void textContentText() {
@@ -47,7 +46,6 @@ public void textContentHeading() {
     @Test
     public void textContentEmphasis() {
         String s;
-        String rendered;
 
         s = "***foo***";
         assertCompact(s, "foo");
diff --git a/commonmark/src/test/java/org/commonmark/test/ThematicBreakParserTest.java b/commonmark/src/test/java/org/commonmark/test/ThematicBreakParserTest.java
@@ -5,7 +5,6 @@
 import org.junit.Test;
 
 import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertNotNull;
 
 public class ThematicBreakParserTest {
 
diff --git a/commonmark/src/test/java/org/commonmark/test/UsageExampleTest.java b/commonmark/src/test/java/org/commonmark/test/UsageExampleTest.java
@@ -79,6 +79,7 @@ public void addAttributes() {
         Parser parser = Parser.builder().build();
         HtmlRenderer renderer = HtmlRenderer.builder()
                 .attributeProviderFactory(new AttributeProviderFactory() {
+                    @Override
                     public AttributeProvider create(AttributeProviderContext context) {
                         return new ImageAttributeProvider();
                     }
@@ -95,6 +96,7 @@ public void customizeRendering() {
         Parser parser = Parser.builder().build();
         HtmlRenderer renderer = HtmlRenderer.builder()
                 .nodeRendererFactory(new HtmlNodeRendererFactory() {
+                    @Override
                     public NodeRenderer create(HtmlNodeRendererContext context) {
                         return new IndentedCodeBlockNodeRenderer(context);
                     }

Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@ public TableTextContentNodeRenderer(TextContentNodeRendererContext context) {`
`22`	`22`	`this.context = context;`
`23`	`23`	`}`
`24`	`24`
	`25`	`+ @Override`
`25`	`26`	`protected void renderBlock(TableBlock tableBlock) {`
`26`	`27`	`// Render rows tight`
`27`	`28`	`textContentWriter.pushTight(true);`
`@@ -30,19 +31,23 @@ protected void renderBlock(TableBlock tableBlock) {`
`30`	`31`	`textContentWriter.block();`
`31`	`32`	`}`
`32`	`33`
	`34`	`+ @Override`
`33`	`35`	`protected void renderHead(TableHead tableHead) {`
`34`	`36`	`renderChildren(tableHead);`
`35`	`37`	`}`
`36`	`38`
	`39`	`+ @Override`
`37`	`40`	`protected void renderBody(TableBody tableBody) {`
`38`	`41`	`renderChildren(tableBody);`
`39`	`42`	`}`
`40`	`43`
	`44`	`+ @Override`
`41`	`45`	`protected void renderRow(TableRow tableRow) {`
`42`	`46`	`renderChildren(tableRow);`
`43`	`47`	`textContentWriter.block();`
`44`	`48`	`}`
`45`	`49`
	`50`	`+ @Override`
`46`	`51`	`protected void renderCell(TableCell tableCell) {`
`47`	`52`	`renderChildren(tableCell);`
`48`	`53`	`// For the last cell in row, don't render the delimiter`
Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,7 @@ public void testTaskListItems() {`
`31`	`31`
`32`	`32`	`}`
`33`	`33`
	`34`	`+ @Override`
`34`	`35`	`protected String render(String source) {`
`35`	`36`	`return RENDERER.render(PARSER.parse(source));`
`36`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,7 @@ private static boolean isMarker(ParserState state, int index) {`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`public static class Factory extends AbstractBlockParserFactory {`
	`49`	`+ @Override`
`49`	`50`	`public BlockStart tryStart(ParserState state, MatchedBlockParser matchedBlockParser) {`
`50`	`51`	`int nextNonSpace = state.getNextNonSpaceIndex();`
`51`	`52`	`if (isMarker(state, nextNonSpace)) {`