This is an automated email from the ASF dual-hosted git repository. juanpablo pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/jspwiki.git
commit 06ee24657e279e9261475cc21255e8eaa3156c9d Author: juanpablo <[email protected]> AuthorDate: Sat Jan 11 01:31:07 2020 +0100 apply suggested fixes + formatting by intellij --- .../wiki/render/CustomXMLOutputProcessor.java | 5 +- .../java/org/apache/wiki/render/XHTMLRenderer.java | 5 +- .../wiki/render/WysiwygEditingRendererTest.java | 43 +++---- .../InterWikiLinkAttributeProviderState.java | 2 +- .../WysiwygEditingAttributeProviderState.java | 14 +-- .../AccessRuleLinkNodePostProcessorState.java | 2 +- .../InterWikiLinkNodePostProcessorState.java | 2 +- .../JSPWikiLinkNodePostProcessor.java | 8 +- .../MetadataLinkNodePostProcessorState.java | 4 +- .../NodePostProcessorStateCommonOperations.java | 2 +- .../PluginLinkNodePostProcessorState.java | 2 +- .../VariableLinkNodePostProcessorState.java | 2 +- .../markdown/renderer/JSPWikiLinkRenderer.java | 15 ++- .../wiki/parser/markdown/MarkdownDocument.java | 2 +- .../wiki/parser/markdown/MarkdownParser.java | 13 +-- .../apache/wiki/render/MarkdownRendererTest.java | 126 ++++++++++----------- 16 files changed, 115 insertions(+), 132 deletions(-) diff --git a/jspwiki-main/src/main/java/org/apache/wiki/render/CustomXMLOutputProcessor.java b/jspwiki-main/src/main/java/org/apache/wiki/render/CustomXMLOutputProcessor.java index da68a9d..de5cb56 100644 --- a/jspwiki-main/src/main/java/org/apache/wiki/render/CustomXMLOutputProcessor.java +++ b/jspwiki-main/src/main/java/org/apache/wiki/render/CustomXMLOutputProcessor.java @@ -33,11 +33,8 @@ import java.io.Writer; */ public class CustomXMLOutputProcessor extends AbstractXMLOutputProcessor { - protected void attributeEscapedEntitiesFilter( final Writer out, - final FormatStack fstack, final String value ) throws IOException { - + protected void attributeEscapedEntitiesFilter( final Writer out, final FormatStack fstack, final String value ) throws IOException { write( out, Format.escapeAttribute( fstack.getEscapeStrategy(), value ) ); - } } diff --git a/jspwiki-main/src/main/java/org/apache/wiki/render/XHTMLRenderer.java b/jspwiki-main/src/main/java/org/apache/wiki/render/XHTMLRenderer.java index 49e6a4d..5ffe2f9 100644 --- a/jspwiki-main/src/main/java/org/apache/wiki/render/XHTMLRenderer.java +++ b/jspwiki-main/src/main/java/org/apache/wiki/render/XHTMLRenderer.java @@ -27,9 +27,8 @@ import java.io.IOException; import java.io.StringWriter; /** - * Implements a WikiRendered that outputs XHTML. Because the internal DOM - * representation is in XHTML already, this just basically dumps out everything - * out in a non-prettyprinted format. + * Implements a WikiRendered that outputs XHTML. Because the internal DOM representation is in XHTML already, this just basically + * dumps out everything out in a non-prettyprinted format. * * @since 2.4 */ diff --git a/jspwiki-main/src/test/java/org/apache/wiki/render/WysiwygEditingRendererTest.java b/jspwiki-main/src/test/java/org/apache/wiki/render/WysiwygEditingRendererTest.java index fc55cb7..5dd12c5 100644 --- a/jspwiki-main/src/test/java/org/apache/wiki/render/WysiwygEditingRendererTest.java +++ b/jspwiki-main/src/test/java/org/apache/wiki/render/WysiwygEditingRendererTest.java @@ -18,10 +18,6 @@ */ package org.apache.wiki.render; -import java.io.IOException; -import java.io.StringReader; -import java.util.Properties; - import org.apache.wiki.TestEngine; import org.apache.wiki.WikiContext; import org.apache.wiki.WikiPage; @@ -32,45 +28,41 @@ import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; -public class WysiwygEditingRendererTest -{ - protected TestEngine testEngine; +import java.io.IOException; +import java.io.StringReader; + +public class WysiwygEditingRendererTest { - @BeforeEach - public void setUp() throws Exception - { - Properties props = TestEngine.getTestProperties(); - testEngine = new TestEngine(props); + TestEngine testEngine = TestEngine.build(); + @BeforeEach + public void setUp() throws Exception { testEngine.saveText( "WysiwygEditingRendererTest", "test page" ); testEngine.saveText( "This Pagename Has Spaces", "This Pagename Has Spaces" ); } @AfterEach - public void tearDown() - { + public void tearDown() { testEngine.deleteTestPage( "WysiwygEditingRendererTest" ); testEngine.deleteTestPage( "This Pagename Has Spaces" ); } - private String render(String s) throws IOException - { - WikiPage dummyPage = new WikiPage(testEngine,"TestPage"); - WikiContext ctx = new WikiContext(testEngine,dummyPage); + private String render( final String s ) throws IOException { + final WikiPage dummyPage = new WikiPage(testEngine,"TestPage"); + final WikiContext ctx = new WikiContext(testEngine,dummyPage); - StringReader in = new StringReader(s); + final StringReader in = new StringReader(s); - JSPWikiMarkupParser p = new JSPWikiMarkupParser( ctx, in ); - WikiDocument d = p.parse(); + final JSPWikiMarkupParser p = new JSPWikiMarkupParser( ctx, in ); + final WikiDocument d = p.parse(); - WysiwygEditingRenderer wer = new WysiwygEditingRenderer( ctx, d ); + final WysiwygEditingRenderer wer = new WysiwygEditingRenderer( ctx, d ); return wer.getString(); } @Test - public void testDefinedPageLink() throws Exception - { + public void testDefinedPageLink() throws Exception { String src = "[WysiwygEditingRendererTest]"; Assertions.assertEquals( "<a class=\"wikipage\" href=\"WysiwygEditingRendererTest\">WysiwygEditingRendererTest</a>", render(src) ); @@ -85,8 +77,7 @@ public class WysiwygEditingRendererTest } @Test - public void testUndefinedPageLink() throws Exception - { + public void testUndefinedPageLink() throws Exception { String src = "[UndefinedPageLinkHere]"; Assertions.assertEquals( "<a class=\"createpage\" href=\"UndefinedPageLinkHere\">UndefinedPageLinkHere</a>", render(src) ); diff --git a/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/extensions/jspwikilinks/attributeprovider/InterWikiLinkAttributeProviderState.java b/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/extensions/jspwikilinks/attributeprovider/InterWikiLinkAttributeProviderState.java index 1a82aee..3c7daf4 100755 --- a/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/extensions/jspwikilinks/attributeprovider/InterWikiLinkAttributeProviderState.java +++ b/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/extensions/jspwikilinks/attributeprovider/InterWikiLinkAttributeProviderState.java @@ -45,7 +45,7 @@ public class InterWikiLinkAttributeProviderState implements NodeAttributeProvide this.wikiContext = wikiContext; this.linkOperations = new LinkParsingOperations( wikiContext ); final Boolean wysiwygVariable = ( Boolean )wikiContext.getVariable( RenderingManager.WYSIWYG_EDITOR_MODE ); - m_wysiwygEditorMode = wysiwygVariable != null ? wysiwygVariable.booleanValue() : false; + m_wysiwygEditorMode = wysiwygVariable != null ? wysiwygVariable : false; } /** diff --git a/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/extensions/jspwikilinks/attributeprovider/WysiwygEditingAttributeProviderState.java b/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/extensions/jspwikilinks/attributeprovider/WysiwygEditingAttributeProviderState.java index 704cd70..48c5406 100755 --- a/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/extensions/jspwikilinks/attributeprovider/WysiwygEditingAttributeProviderState.java +++ b/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/extensions/jspwikilinks/attributeprovider/WysiwygEditingAttributeProviderState.java @@ -40,7 +40,7 @@ public class WysiwygEditingAttributeProviderState implements NodeAttributeProvid public WysiwygEditingAttributeProviderState( final WikiContext wikiContext ) { this.wikiContext = wikiContext; final Boolean wysiwygVariable = ( Boolean )wikiContext.getVariable( RenderingManager.WYSIWYG_EDITOR_MODE ); - m_wysiwygEditorMode = wysiwygVariable != null ? wysiwygVariable.booleanValue() : false; + m_wysiwygEditorMode = wysiwygVariable != null ? wysiwygVariable : false; } /** @@ -52,17 +52,15 @@ public class WysiwygEditingAttributeProviderState implements NodeAttributeProvid public void setAttributes( final Attributes attributes, final JSPWikiLink link ) { if( m_wysiwygEditorMode ) { if( attributes.getValue( "class" ) != null ) { - String href = attributes.getValue( "href" ); - XHtmlToWikiConfig wikiConfig = new XHtmlToWikiConfig( wikiContext ); + final String href = attributes.getValue( "href" ); + final XHtmlToWikiConfig wikiConfig = new XHtmlToWikiConfig( wikiContext ); // Get the url for wiki page link - it's typically "Wiki.jsp?page=MyPage" // or when using the ShortURLConstructor option, it's "wiki/MyPage" . - String wikiPageLinkUrl = wikiConfig.getWikiJspPage(); - String editPageLinkUrl = wikiConfig.getEditJspPage(); + final String wikiPageLinkUrl = wikiConfig.getWikiJspPage(); + final String editPageLinkUrl = wikiConfig.getEditJspPage(); if( href != null && href.startsWith( wikiPageLinkUrl ) ) { - // Remove the leading url string so that users will only see the - // wikipage's name when editing an existing wiki link. + // Remove the leading url string so that users will only see the wikipage's name when editing an existing wiki link. // For example, change "Wiki.jsp?page=MyPage" to just "MyPage". - String newHref = href.substring( wikiPageLinkUrl.length() ); // Convert "This%20Pagename%20Has%20Spaces" to "This Pagename Has Spaces" diff --git a/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/extensions/jspwikilinks/postprocessor/AccessRuleLinkNodePostProcessorState.java b/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/extensions/jspwikilinks/postprocessor/AccessRuleLinkNodePostProcessorState.java index cbbf04a..c7e46d4 100755 --- a/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/extensions/jspwikilinks/postprocessor/AccessRuleLinkNodePostProcessorState.java +++ b/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/extensions/jspwikilinks/postprocessor/AccessRuleLinkNodePostProcessorState.java @@ -41,7 +41,7 @@ public class AccessRuleLinkNodePostProcessorState implements NodePostProcessorSt public AccessRuleLinkNodePostProcessorState( final WikiContext wikiContext ) { this.wikiContext = wikiContext; final Boolean wysiwygVariable = ( Boolean )wikiContext.getVariable( RenderingManager.WYSIWYG_EDITOR_MODE ); - m_wysiwygEditorMode = wysiwygVariable != null ? wysiwygVariable.booleanValue() : false; + m_wysiwygEditorMode = wysiwygVariable != null ? wysiwygVariable : false; } /** diff --git a/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/extensions/jspwikilinks/postprocessor/InterWikiLinkNodePostProcessorState.java b/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/extensions/jspwikilinks/postprocessor/InterWikiLinkNodePostProcessorState.java index 128b6dd..66b9cd7 100755 --- a/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/extensions/jspwikilinks/postprocessor/InterWikiLinkNodePostProcessorState.java +++ b/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/extensions/jspwikilinks/postprocessor/InterWikiLinkNodePostProcessorState.java @@ -54,7 +54,7 @@ public class InterWikiLinkNodePostProcessorState implements NodePostProcessorSta this.document = document; this.m_useOutlinkImage = wikiContext.getBooleanWikiProperty( MarkupParser.PROP_USEOUTLINKIMAGE, m_useOutlinkImage ); final Boolean wysiwygVariable = ( Boolean )wikiContext.getVariable( RenderingManager.WYSIWYG_EDITOR_MODE ); - m_wysiwygEditorMode = wysiwygVariable != null ? wysiwygVariable.booleanValue() : false; + m_wysiwygEditorMode = wysiwygVariable != null ? wysiwygVariable : false; } /** diff --git a/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/extensions/jspwikilinks/postprocessor/JSPWikiLinkNodePostProcessor.java b/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/extensions/jspwikilinks/postprocessor/JSPWikiLinkNodePostProcessor.java index f9e7d76..2aba7de 100755 --- a/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/extensions/jspwikilinks/postprocessor/JSPWikiLinkNodePostProcessor.java +++ b/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/extensions/jspwikilinks/postprocessor/JSPWikiLinkNodePostProcessor.java @@ -59,7 +59,7 @@ public class JSPWikiLinkNodePostProcessor extends NodePostProcessor { @Override public void process( final NodeTracker state, final Node node ) { if( node instanceof Link ) { - JSPWikiLink link = replaceLinkWithJSPWikiLink( state, node ); + final JSPWikiLink link = replaceLinkWithJSPWikiLink( state, node ); final NodePostProcessorState< JSPWikiLink > linkPostProcessor; if( linkOperations.isAccessRule( link.getUrl().toString() ) ) { @@ -86,9 +86,9 @@ public class JSPWikiLinkNodePostProcessor extends NodePostProcessor { } JSPWikiLink replaceLinkWithJSPWikiLink( final NodeTracker state, final Node node ) { - JSPWikiLink link = new JSPWikiLink( ( Link )node ); - Node previous = node.getPrevious(); - Node parent = node.getParent(); + final JSPWikiLink link = new JSPWikiLink( ( Link )node ); + final Node previous = node.getPrevious(); + final Node parent = node.getParent(); link.takeChildren( node ); node.unlink(); diff --git a/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/extensions/jspwikilinks/postprocessor/MetadataLinkNodePostProcessorState.java b/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/extensions/jspwikilinks/postprocessor/MetadataLinkNodePostProcessorState.java index bc5526b..99a9ed5 100755 --- a/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/extensions/jspwikilinks/postprocessor/MetadataLinkNodePostProcessorState.java +++ b/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/extensions/jspwikilinks/postprocessor/MetadataLinkNodePostProcessorState.java @@ -43,7 +43,7 @@ public class MetadataLinkNodePostProcessorState implements NodePostProcessorStat public MetadataLinkNodePostProcessorState( final WikiContext wikiContext ) { this.wikiContext = wikiContext; final Boolean wysiwygVariable = ( Boolean )wikiContext.getVariable( RenderingManager.WYSIWYG_EDITOR_MODE ); - m_wysiwygEditorMode = wysiwygVariable != null ? wysiwygVariable.booleanValue() : false; + m_wysiwygEditorMode = wysiwygVariable != null ? wysiwygVariable : false; } /** @@ -57,7 +57,7 @@ public class MetadataLinkNodePostProcessorState implements NodePostProcessorStat try { final String args = metadataLine.substring( metadataLine.indexOf(' '), metadataLine.length() - 1 ); String name = args.substring( 0, args.indexOf( '=' ) ); - String val = args.substring( args.indexOf( '=' ) + 1, args.length() ); + String val = args.substring( args.indexOf( '=' ) + 1 ); name = name.trim(); val = val.trim(); diff --git a/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/extensions/jspwikilinks/postprocessor/NodePostProcessorStateCommonOperations.java b/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/extensions/jspwikilinks/postprocessor/NodePostProcessorStateCommonOperations.java index 635d3e7..87d5b3c 100755 --- a/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/extensions/jspwikilinks/postprocessor/NodePostProcessorStateCommonOperations.java +++ b/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/extensions/jspwikilinks/postprocessor/NodePostProcessorStateCommonOperations.java @@ -48,7 +48,7 @@ class NodePostProcessorStateCommonOperations { static void addOutlinkImage( final NodeTracker state, final Node node, final WikiContext wikiContext, final boolean useOutlinkImage ) { final Boolean wysiwygVariable = ( Boolean )wikiContext.getVariable( RenderingManager.WYSIWYG_EDITOR_MODE ); - final boolean wysiwygEditorMode = wysiwygVariable != null && wysiwygVariable.booleanValue(); + final boolean wysiwygEditorMode = wysiwygVariable != null && wysiwygVariable; if( useOutlinkImage && !wysiwygEditorMode ) { final String m_outlinkImageURL = wikiContext.getURL( WikiContext.NONE, MarkupParser.OUTLINK_IMAGE ); diff --git a/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/extensions/jspwikilinks/postprocessor/PluginLinkNodePostProcessorState.java b/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/extensions/jspwikilinks/postprocessor/PluginLinkNodePostProcessorState.java index e40d75a..4e13e3d 100755 --- a/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/extensions/jspwikilinks/postprocessor/PluginLinkNodePostProcessorState.java +++ b/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/extensions/jspwikilinks/postprocessor/PluginLinkNodePostProcessorState.java @@ -48,7 +48,7 @@ public class PluginLinkNodePostProcessorState implements NodePostProcessorState< public PluginLinkNodePostProcessorState( final WikiContext wikiContext ) { this.wikiContext = wikiContext; final Boolean wysiwygVariable = ( Boolean )wikiContext.getVariable( RenderingManager.WYSIWYG_EDITOR_MODE ); - m_wysiwygEditorMode = wysiwygVariable != null ? wysiwygVariable.booleanValue() : false; + m_wysiwygEditorMode = wysiwygVariable != null ? wysiwygVariable : false; } /** diff --git a/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/extensions/jspwikilinks/postprocessor/VariableLinkNodePostProcessorState.java b/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/extensions/jspwikilinks/postprocessor/VariableLinkNodePostProcessorState.java index bea0820..8855af5 100755 --- a/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/extensions/jspwikilinks/postprocessor/VariableLinkNodePostProcessorState.java +++ b/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/extensions/jspwikilinks/postprocessor/VariableLinkNodePostProcessorState.java @@ -40,7 +40,7 @@ public class VariableLinkNodePostProcessorState implements NodePostProcessorStat public VariableLinkNodePostProcessorState( final WikiContext wikiContext ) { this.wikiContext = wikiContext; final Boolean wysiwygVariable = ( Boolean )wikiContext.getVariable( RenderingManager.WYSIWYG_EDITOR_MODE ); - m_wysiwygEditorMode = wysiwygVariable != null && wysiwygVariable.booleanValue(); + m_wysiwygEditorMode = wysiwygVariable != null && wysiwygVariable; } /** diff --git a/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/renderer/JSPWikiLinkRenderer.java b/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/renderer/JSPWikiLinkRenderer.java index befdc7d..70895c7 100755 --- a/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/renderer/JSPWikiLinkRenderer.java +++ b/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/renderer/JSPWikiLinkRenderer.java @@ -18,11 +18,6 @@ */ package org.apache.wiki.markdown.renderer; -import java.util.HashSet; -import java.util.Set; - -import org.apache.wiki.markdown.nodes.JSPWikiLink; - import com.vladsch.flexmark.html.CustomNodeRenderer; import com.vladsch.flexmark.html.HtmlWriter; import com.vladsch.flexmark.html.renderer.LinkType; @@ -30,6 +25,10 @@ import com.vladsch.flexmark.html.renderer.NodeRenderer; import com.vladsch.flexmark.html.renderer.NodeRendererContext; import com.vladsch.flexmark.html.renderer.NodeRenderingHandler; import com.vladsch.flexmark.html.renderer.ResolvedLink; +import org.apache.wiki.markdown.nodes.JSPWikiLink; + +import java.util.HashSet; +import java.util.Set; /** @@ -44,8 +43,8 @@ public class JSPWikiLinkRenderer implements NodeRenderer { */ @Override public Set< NodeRenderingHandler< ? > > getNodeRenderingHandlers() { - HashSet< NodeRenderingHandler< ? > > set = new HashSet< NodeRenderingHandler< ? > >(); - set.add( new NodeRenderingHandler< JSPWikiLink >( JSPWikiLink.class, new CustomNodeRenderer< JSPWikiLink >() { + final HashSet< NodeRenderingHandler< ? > > set = new HashSet<>(); + set.add( new NodeRenderingHandler<>( JSPWikiLink.class, new CustomNodeRenderer< JSPWikiLink >() { /** * {@inheritDoc} @@ -56,7 +55,7 @@ public class JSPWikiLinkRenderer implements NodeRenderer { context.renderChildren( node ); } else { // standard Link Rendering - ResolvedLink resolvedLink = context.resolveLink( LinkType.LINK, node.getUrl().unescape(), null ); + final ResolvedLink resolvedLink = context.resolveLink( LinkType.LINK, node.getUrl().unescape(), null ); html.attr( "href", resolvedLink.getUrl() ); if( node.getTitle().isNotNull() ) { diff --git a/jspwiki-markdown/src/main/java/org/apache/wiki/parser/markdown/MarkdownDocument.java b/jspwiki-markdown/src/main/java/org/apache/wiki/parser/markdown/MarkdownDocument.java index 64a2e20..b8b0e28 100755 --- a/jspwiki-markdown/src/main/java/org/apache/wiki/parser/markdown/MarkdownDocument.java +++ b/jspwiki-markdown/src/main/java/org/apache/wiki/parser/markdown/MarkdownDocument.java @@ -59,7 +59,7 @@ public class MarkdownDocument extends WikiDocument { * @return configuration options for MarkdownRenderers. */ public static MutableDataSet options( final WikiContext context ) { - MutableDataSet options = new MutableDataSet(); + final MutableDataSet options = new MutableDataSet(); options.setFrom( ParserEmulationProfile.COMMONMARK ); // align style of Markdown's footnotes extension with jspwiki footnotes refs options.set( FootnoteExtension.FOOTNOTE_LINK_REF_CLASS, JSPWikiMarkupParser.CLASS_FOOTNOTE_REF ); diff --git a/jspwiki-markdown/src/main/java/org/apache/wiki/parser/markdown/MarkdownParser.java b/jspwiki-markdown/src/main/java/org/apache/wiki/parser/markdown/MarkdownParser.java index 4d39810..c98f4ef 100755 --- a/jspwiki-markdown/src/main/java/org/apache/wiki/parser/markdown/MarkdownParser.java +++ b/jspwiki-markdown/src/main/java/org/apache/wiki/parser/markdown/MarkdownParser.java @@ -18,15 +18,14 @@ */ package org.apache.wiki.parser.markdown; -import java.io.IOException; -import java.io.Reader; - +import com.vladsch.flexmark.parser.Parser; +import com.vladsch.flexmark.util.ast.Node; import org.apache.wiki.WikiContext; import org.apache.wiki.parser.MarkupParser; import org.apache.wiki.parser.WikiDocument; -import com.vladsch.flexmark.parser.Parser; -import com.vladsch.flexmark.util.ast.Node; +import java.io.IOException; +import java.io.Reader; /** @@ -49,8 +48,8 @@ public class MarkdownParser extends MarkupParser { */ @Override public WikiDocument parse() throws IOException { - Node document = parser.parseReader( m_in ); - MarkdownDocument md = new MarkdownDocument( m_context.getPage(), document ); + final Node document = parser.parseReader( m_in ); + final MarkdownDocument md = new MarkdownDocument( m_context.getPage(), document ); md.setContext( m_context ); return md; diff --git a/jspwiki-markdown/src/test/java/org/apache/wiki/render/MarkdownRendererTest.java b/jspwiki-markdown/src/test/java/org/apache/wiki/render/MarkdownRendererTest.java index 4ae2dde..19bbb2d 100755 --- a/jspwiki-markdown/src/test/java/org/apache/wiki/render/MarkdownRendererTest.java +++ b/jspwiki-markdown/src/test/java/org/apache/wiki/render/MarkdownRendererTest.java @@ -50,7 +50,7 @@ public class MarkdownRendererTest { @Test public void testMarkupSimpleMarkdown() throws Exception { - String src = "This should be a **bold**"; + final String src = "This should be a **bold**"; Assertions.assertEquals( "<p>This should be a <strong>bold</strong></p>\n", translate( src ) ); } @@ -58,123 +58,123 @@ public class MarkdownRendererTest { @Test public void testMarkupExtensionSelfViewLink() throws Exception { newPage( "MarkupExtensionSelfViewLink" ); - String src = "This should be a [MarkupExtensionSelfViewLink]()"; + final String src = "This should be a [MarkupExtensionSelfViewLink]()"; Assertions.assertEquals( "<p>This should be a <a href=\"/test/Wiki.jsp?page=MarkupExtensionSelfViewLink\" class=\"wikipage\">MarkupExtensionSelfViewLink</a></p>\n", - translate( src ) ); + translate( src ) ); } @Test public void testMarkupExtensionSelfEditLink() throws Exception { - String src = "This should be a [self<->link]()"; + final String src = "This should be a [self<->link]()"; Assertions.assertEquals( "<p>This should be a <a href=\"/test/Edit.jsp?page=self%3C-%3Elink\" title=\"Create "self<->link"\" class=\"createpage\">self<->link</a></p>\n", - translate( src ) ); + translate( src ) ); } @Test public void testMarkupExtensionExternalLink() throws Exception { testEngine.getWikiProperties().setProperty( "jspwiki.translatorReader.useOutlinkImage", "true" ); - String src = "This should be an [external link](https://jspwiki.apache.org)"; + final String src = "This should be an [external link](https://jspwiki.apache.org)"; Assertions.assertEquals( "<p>This should be an <a href=\"https://jspwiki.apache.org\"; class=\"external\">external link</a><img class=\"outlink\" alt=\"\" src=\"/test/images/out.png\" /></p>\n", - translate( src ) ); + translate( src ) ); testEngine.getWikiProperties().remove( "jspwiki.translatorReader.useOutlinkImage" ); } @Test public void testMarkupExtensionInterWikiLink() throws Exception { - String src = "This should be an [interwiki link](JSPWiki:About)"; + final String src = "This should be an [interwiki link](JSPWiki:About)"; Assertions.assertEquals( "<p>This should be an <a href=\"http://jspwiki-wiki.apache.org/Wiki.jsp?page=About\"; class=\"interwiki\">interwiki link</a></p>\n", - translate( src ) ); + translate( src ) ); } @Test public void testMarkupExtensionWrongInterWikiLink() throws Exception { - String src = "This should be an [interwiki link](JSPWiko:About)"; + final String src = "This should be an [interwiki link](JSPWiko:About)"; Assertions.assertEquals( "<p>This should be an <span class=\"error\">No InterWiki reference defined in properties for Wiki called \"JSPWiko\"!</span></p>\n", - translate( src ) ); + translate( src ) ); } @Test public void testMarkupExtensionACL() throws Exception { - String src = "[{ALLOW view PerryMason}]() This should be visible if the ACL allows you to see it"; + final String src = "[{ALLOW view PerryMason}]() This should be visible if the ACL allows you to see it"; // text is seen because although ACL is added to the page, it is not applied while parsing / rendering Assertions.assertEquals( "<p> This should be visible if the ACL allows you to see it</p>\n", translate( src ) ); // in any case, we also check that the created wikipage has the ACL added Assertions.assertEquals( " user = PerryMason: ((\"org.apache.wiki.auth.permissions.PagePermission\",\"JSPWiki:testpage\",\"view\"))\n", - testEngine.getPageManager().getPage( PAGE_NAME ).getAcl().toString() ); + testEngine.getPageManager().getPage( PAGE_NAME ).getAcl().toString() ); } @Test public void testMarkupExtensionMetadata() throws Exception { - String src = "[{SET Perry='Mason'}]() Some text after setting metadata"; + final String src = "[{SET Perry='Mason'}]() Some text after setting metadata"; Assertions.assertEquals( "<p> Some text after setting metadata</p>\n", translate( src ) ); Assertions.assertEquals( "Mason", testEngine.getPageManager().getPage( PAGE_NAME ).getAttribute( "Perry" ) ); } @Test public void testMarkupExtensionPlugin() throws Exception { - String src = "[{SamplePlugin text=test}]()"; + final String src = "[{SamplePlugin text=test}]()"; Assertions.assertEquals( "<p>test</p>\n", translate( src ) ); } @Test public void testMarkupExtensionTOCPluginGetsSubstitutedWithMDTocExtension() throws Exception { - String src = "[{TableOfContents}]()\n" + - "# Header 1\n" + - "## Header 2\n" + - "## Header 2\n"; + final String src = "[{TableOfContents}]()\n" + + "# Header 1\n" + + "## Header 2\n" + + "## Header 2\n"; Assertions.assertEquals( "<p><div class=\"toc\">\n" + - "<div class=\"collapsebox\">\n" + - "<h4 id=\"section-TOC\">Table of Contents</h4>\n" + - "<ul>\n" + - "<li><a href=\"#header-1\">Header 1</a>\n" + - "<ul>\n" + - "<li><a href=\"#header-2\">Header 2</a></li>\n" + - "<li><a href=\"#header-2-1\">Header 2</a></li>\n" + - "</ul>\n" + - "</li>\n" + - "</ul>\n" + - "</div>\n" + - "</div>\n" + - "</p>\n" + - "<h1 id=\"header-1\">Header 1</h1>\n" + - "<h2 id=\"header-2\">Header 2</h2>\n" + - "<h2 id=\"header-2-1\">Header 2</h2>\n", translate( src ) ); + "<div class=\"collapsebox\">\n" + + "<h4 id=\"section-TOC\">Table of Contents</h4>\n" + + "<ul>\n" + + "<li><a href=\"#header-1\">Header 1</a>\n" + + "<ul>\n" + + "<li><a href=\"#header-2\">Header 2</a></li>\n" + + "<li><a href=\"#header-2-1\">Header 2</a></li>\n" + + "</ul>\n" + + "</li>\n" + + "</ul>\n" + + "</div>\n" + + "</div>\n" + + "</p>\n" + + "<h1 id=\"header-1\">Header 1</h1>\n" + + "<h2 id=\"header-2\">Header 2</h2>\n" + + "<h2 id=\"header-2-1\">Header 2</h2>\n", translate( src ) ); } @Test public void testMarkupExtensionNonExistentPlugin() throws Exception { - String src = "[{PampleSlugin text=test}]()"; + final String src = "[{PampleSlugin text=test}]()"; Assertions.assertEquals( "<p><span class=\"error\">JSPWiki : testpage - Plugin insertion failed: Could not find plugin PampleSlugin</span></p>\n", translate( src ) ); } @Test public void testMarkupExtensionVariable0() throws Exception { - String src = "Some text with some pre-set variable: [{$applicationname}]()"; + final String src = "Some text with some pre-set variable: [{$applicationname}]()"; Assertions.assertEquals( "<p>Some text with some pre-set variable: JSPWiki</p>\n", translate( src ) ); } @Test public void testMarkupExtensionVariable1() throws Exception { - String src = "[{SET Perry='Mason'}]() Some text after setting some metadata: [{$Perry}]()"; + final String src = "[{SET Perry='Mason'}]() Some text after setting some metadata: [{$Perry}]()"; Assertions.assertEquals( "<p> Some text after setting some metadata: Mason</p>\n", translate( src ) ); } @Test public void testMarkupExtensionFootnote0() throws Exception { - String src = "Footnote[1]()"; + final String src = "Footnote[1]()"; Assertions.assertEquals( "<p>Footnote<a href=\"#ref-testpage-1\" class=\"footnoteref\">[1]</a></p>\n", translate( src ) ); } @Test public void testMarkupExtensionFootnoteMD() throws Exception { - String src = "text [^footnote] embedded.\n\n" + - "[^footnote]: footnote text\n" + - "with continuation"; + final String src = "text [^footnote] embedded.\n\n" + + "[^footnote]: footnote text\n" + + "with continuation"; Assertions.assertEquals( "<p>text <sup id=\"fnref-1\"><a class=\"footnoteref\" href=\"#fn-1\">1</a></sup> embedded.</p>\n" + "<div class=\"footnotes\">\n" + "<hr />\n" + @@ -190,44 +190,44 @@ public class MarkdownRendererTest { @Test public void testAttachmentLink() throws Exception { - String src = "This should be an [attachment link](Test/TestAtt.txt)"; + final String src = "This should be an [attachment link](Test/TestAtt.txt)"; newPage( "Test" ); - Attachment att = new Attachment( testEngine, "Test", "TestAtt.txt" ); + final Attachment att = new Attachment( testEngine, "Test", "TestAtt.txt" ); att.setAuthor( "FirstPost" ); testEngine.getAttachmentManager().storeAttachment( att, testEngine.makeAttachmentFile() ); Assertions.assertEquals( "<p>This should be an <a href=\"/test/attach/Test/TestAtt.txt\" class=\"attachment\">attachment link</a>" + - "<a href=\"/test/PageInfo.jsp?page=Test/TestAtt.txt\" class=\"infolink\">" + - "<img src=\"/test/images/attachment_small.png\" border=\"0\" alt=\"(info)\" />" + - "</a></p>\n", - translate( src ) ); + "<a href=\"/test/PageInfo.jsp?page=Test/TestAtt.txt\" class=\"infolink\">" + + "<img src=\"/test/images/attachment_small.png\" border=\"0\" alt=\"(info)\" />" + + "</a></p>\n", + translate( src ) ); } @Test public void testInlineImages() throws Exception { - String src = "Link [test](http://www.ecyrd.com/test.png)"; + final String src = "Link [test](http://www.ecyrd.com/test.png)"; Assertions.assertEquals( "<p>Link <img class=\"inline\" src=\"http://www.ecyrd.com/test.png\"; alt=\"test\" /></p>\n", translate( src ) ); } @Test public void testInlineImages2() throws Exception { - String src = "Link [test](http://www.ecyrd.com/test.ppm)"; + final String src = "Link [test](http://www.ecyrd.com/test.ppm)"; Assertions.assertEquals( "<p>Link <a href=\"http://www.ecyrd.com/test.ppm\"; class=\"external\">test</a></p>\n", translate( src ) ); } @Test public void testInlineImages3() throws Exception { - String src = "Link [test](http://images.com/testi)"; + final String src = "Link [test](http://images.com/testi)"; Assertions.assertEquals( "<p>Link <img class=\"inline\" src=\"http://images.com/testi\"; alt=\"test\" /></p>\n", translate( src ) ); } @Test public void testInlineImages4() throws Exception { - String src = "Link [test](http://foobar.jpg)"; + final String src = "Link [test](http://foobar.jpg)"; Assertions.assertEquals( "<p>Link <img class=\"inline\" src=\"http://foobar.jpg\"; alt=\"test\" /></p>\n", translate( src ) ); } @@ -235,33 +235,33 @@ public class MarkdownRendererTest { // No link text should be just embedded link. @Test public void testInlineImagesLink2() throws Exception { - String src = "Link [http://foobar.jpg]()"; + final String src = "Link [http://foobar.jpg]()"; Assertions.assertEquals( "<p>Link <img class=\"inline\" src=\"http://foobar.jpg\"; alt=\"http://foobar.jpg\"; /></p>\n", translate( src ) ); } @Test public void testInlineImagesLink() throws Exception { - String src = "Link [http://link.to/](http://foobar.jpg)"; + final String src = "Link [http://link.to/](http://foobar.jpg)"; Assertions.assertEquals( "<p>Link <a href=\"http://link.to/\"; class=\"external\"><img class=\"inline\" src=\"http://foobar.jpg\"; alt=\"http://link.to/\"; /></a></p>\n", - translate( src ) ); + translate( src ) ); } @Test public void testInlineImagesLink3() throws Exception { - String src = "Link [SandBox](http://foobar.jpg)"; + final String src = "Link [SandBox](http://foobar.jpg)"; newPage( "SandBox" ); Assertions.assertEquals( "<p>Link <a href=\"/test/Wiki.jsp?page=SandBox\" class=\"wikipage\"><img class=\"inline\" src=\"http://foobar.jpg\"; alt=\"SandBox\" /></a></p>\n", - translate( src ) ); + translate( src ) ); } @Test public void testHeadersWithSameNameGetIdWithCounter() throws Exception { - String src = "### Awesome H3\n" + - "### Awesome H3"; + final String src = "### Awesome H3\n" + + "### Awesome H3"; Assertions.assertEquals( "<h3 id=\"awesome-h3\">Awesome H3</h3>\n" + "<h3 id=\"awesome-h3-1\">Awesome H3</h3>\n", @@ -279,7 +279,7 @@ public class MarkdownRendererTest { @AfterEach public void tearDown() { - for( String name : created ) { + for( final String name : created ) { testEngine.deleteTestPage(name); TestEngine.deleteAttachments(name); } @@ -301,9 +301,9 @@ public class MarkdownRendererTest { } String translate( final WikiEngine e, final WikiPage p, final String src ) throws Exception { - WikiContext context = new WikiContext( e, testEngine.newHttpRequest(), p ); - MarkdownParser tr = new MarkdownParser( context, new BufferedReader( new StringReader( src ) ) ); - MarkdownRenderer conv = new MarkdownRenderer( context, tr.parse() ); + final WikiContext context = new WikiContext( e, testEngine.newHttpRequest(), p ); + final MarkdownParser tr = new MarkdownParser( context, new BufferedReader( new StringReader( src ) ) ); + final MarkdownRenderer conv = new MarkdownRenderer( context, tr.parse() ); newPage( p.getName(), src ); return conv.getString();
![http://www.ecyrd.com/test.png\"](http://www.ecyrd.com/test.png\"){kind=link}
![http://foobar.jpg\"](http://foobar.jpg\"){kind=link}