code review feedback

This commit is contained in:
Ruud Poutsma
2021-03-07 16:14:48 +01:00
parent 19e409ceca
commit bb42ee42ca
18 changed files with 43 additions and 65 deletions

View File

@@ -1,10 +0,0 @@
using System;
using System.Collections.Generic;
using System.Text;
namespace Markdig.Tests.RoundtripSpecs.Inlines
{
class TestLiteralInline
{
}
}

View File

@@ -1,8 +0,0 @@
using System;
namespace Markdig.Tests
{
internal class TestClassAttribute : Attribute
{
}
}

View File

@@ -62,21 +62,21 @@ namespace Markdig.Tests
}
}
//[Test]
//[TestCase("![p1](https://sample.com/video.mp4)", "<p><iframe src=\"https://example.com/video.mp4\" class=\"regex\" width=\"500\" height=\"281\" frameborder=\"0\"></iframe></p>\n", @"^https?://sample.com/(.+)$", @"https://example.com/$1")]
//[TestCase("![p1](//sample.com/video.mp4)", "<p><iframe src=\"https://example.com/video.mp4\" class=\"regex\" width=\"500\" height=\"281\" frameborder=\"0\"></iframe></p>\n", @"^//sample.com/(.+)$", @"https://example.com/$1")]
//[TestCase("![p1](https://sample.com/video.mp4)", "<p><iframe src=\"https://example.com/video.mp4?token=aaabbb\" class=\"regex\" width=\"500\" height=\"281\" frameborder=\"0\"></iframe></p>\n", @"^https?://sample.com/(.+)$", @"https://example.com/$1?token=aaabbb")]
//public void TestCustomHostProvider(string markdown, string expected, string provider, string replace)
//{
// string html = Markdown.ToHtml(markdown, GetPipeline(new MediaOptions
// {
// Hosts =
// {
// new TestHostProvider(provider, replace),
// }
// }));
// Assert.AreEqual(html, expected);
//}
[Test]
[TestCase("![p1](https://sample.com/video.mp4)", "<p><iframe src=\"https://example.com/video.mp4\" class=\"regex\" width=\"500\" height=\"281\" frameborder=\"0\"></iframe></p>\n", @"^https?://sample.com/(.+)$", @"https://example.com/$1")]
[TestCase("![p1](//sample.com/video.mp4)", "<p><iframe src=\"https://example.com/video.mp4\" class=\"regex\" width=\"500\" height=\"281\" frameborder=\"0\"></iframe></p>\n", @"^//sample.com/(.+)$", @"https://example.com/$1")]
[TestCase("![p1](https://sample.com/video.mp4)", "<p><iframe src=\"https://example.com/video.mp4?token=aaabbb\" class=\"regex\" width=\"500\" height=\"281\" frameborder=\"0\"></iframe></p>\n", @"^https?://sample.com/(.+)$", @"https://example.com/$1?token=aaabbb")]
public void TestCustomHostProvider(string markdown, string expected, string provider, string replace)
{
string html = Markdown.ToHtml(markdown, GetPipeline(new MediaOptions
{
Hosts =
{
new TestHostProvider(provider, replace),
}
}));
Assert.AreEqual(html, expected);
}
[Test]
[TestCase("![static mp4](//sample.com/video.mp4)", "<p><video width=\"500\" height=\"281\" controls=\"\"><source type=\"video/mp4\" src=\"//sample.com/video.mp4\"></source></video></p>\n", "")]

View File

@@ -221,7 +221,7 @@ namespace Markdig.Helpers
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static bool IsNewLineLineFeed(this char c)
public static bool IsNewLineOrLineFeed(this char c)
{
return c == '\n' || c == '\r';
}

View File

@@ -759,7 +759,7 @@ namespace Markdig.Helpers
continue;
}
if (c.IsNewLineLineFeed())
if (c.IsNewLineOrLineFeed())
{
break;
}
@@ -902,7 +902,7 @@ namespace Markdig.Helpers
continue;
}
if (c.IsNewLineLineFeed())
if (c.IsNewLineOrLineFeed())
{
break;
}

View File

@@ -6,7 +6,7 @@ namespace Markdig.Helpers
/// Represents a character or set of characters that represent a separation
/// between two lines of text
/// </summary>
public enum NewLine
public enum NewLine : byte
{
None,
CarriageReturn,

View File

@@ -115,7 +115,6 @@ namespace Markdig.Parsers
c = processor.NextChar(); // Skip quote marker char
if (c == ' ')
{
//processor.NextChar();
processor.NextColumn();
hasSpaceAfterQuoteChar = true;
processor.SkipFirstUnwindSpace = true;

View File

@@ -8,13 +8,11 @@ using System.Collections.Generic;
namespace Markdig.Renderers.Roundtrip
{
/// <summary>
/// An Normalize renderer for a <see cref="CodeBlock"/> and <see cref="FencedCodeBlock"/>.
/// An Roundtrip renderer for a <see cref="CodeBlock"/> and <see cref="FencedCodeBlock"/>.
/// </summary>
/// <seealso cref="NormalizeObjectRenderer{CodeBlock}" />
public class CodeBlockRenderer : RoundtripObjectRenderer<CodeBlock>
{
public bool OutputAttributesOnPre { get; set; }
protected override void Write(RoundtripRenderer renderer, CodeBlock obj)
{
renderer.RenderLinesBefore(obj);

View File

@@ -7,7 +7,7 @@ using Markdig.Syntax;
namespace Markdig.Renderers.Roundtrip
{
/// <summary>
/// An Normalize renderer for a <see cref="HeadingBlock"/>.
/// An Roundtrip renderer for a <see cref="HeadingBlock"/>.
/// </summary>
/// <seealso cref="NormalizeObjectRenderer{HeadingBlock}" />
public class HeadingRenderer : RoundtripObjectRenderer<HeadingBlock>

View File

@@ -12,17 +12,11 @@ namespace Markdig.Renderers.Roundtrip.Inlines
/// <seealso cref="NormalizeObjectRenderer{LineBreakInline}" />
public class LineBreakInlineRenderer : RoundtripObjectRenderer<LineBreakInline>
{
/// <summary>
/// Gets or sets a value indicating whether to render this softline break as a Normalize hardline break tag (&lt;br /&gt;)
/// </summary>
public bool RenderAsHardlineBreak { get; set; }
protected override void Write(RoundtripRenderer renderer, LineBreakInline obj)
{
if (obj.IsHard && obj.IsBackslash)
{
renderer.Write("\\");
//renderer.Write(obj.IsBackslash ? "\\" : " ");
}
renderer.WriteLine(obj.NewLine);
}

View File

@@ -9,7 +9,7 @@ using Markdig.Syntax;
namespace Markdig.Renderers.Roundtrip
{
/// <summary>
/// A Normalize renderer for a <see cref="ListBlock"/>.
/// A Roundtrip renderer for a <see cref="ListBlock"/>.
/// </summary>
/// <seealso cref="NormalizeObjectRenderer{ListBlock}" />
public class ListRenderer : RoundtripObjectRenderer<ListBlock>

View File

@@ -8,7 +8,7 @@ using System.Diagnostics;
namespace Markdig.Renderers.Roundtrip
{
/// <summary>
/// A Normalize renderer for a <see cref="ParagraphBlock"/>.
/// A Roundtrip renderer for a <see cref="ParagraphBlock"/>.
/// </summary>
/// <seealso cref="NormalizeObjectRenderer{ParagraphBlock}" />
[DebuggerDisplay("renderer.Writer.ToString()")]

View File

@@ -9,9 +9,8 @@ using System.Collections.Generic;
namespace Markdig.Renderers.Roundtrip
{
/// <summary>
/// A Normalize renderer for a <see cref="QuoteBlock"/>.
/// A Roundtrip renderer for a <see cref="QuoteBlock"/>.
/// </summary>
/// <seealso cref="NormalizeObjectRenderer{QuoteBlock}" />
public class QuoteBlockRenderer : RoundtripObjectRenderer<QuoteBlock>
{
protected override void Write(RoundtripRenderer renderer, QuoteBlock quoteBlock)

View File

@@ -6,19 +6,21 @@ using System.IO;
using Markdig.Syntax;
using Markdig.Renderers.Roundtrip.Inlines;
using Markdig.Helpers;
using Markdig.Parsers;
namespace Markdig.Renderers.Roundtrip
{
/// <summary>
/// Default HTML renderer for a Markdown <see cref="MarkdownDocument"/> object.
/// Markdown renderer honoring trivia for a <see cref="MarkdownDocument"/> object.
/// </summary>
/// Ensure to enable the <see cref="MarkdownParser.TrackTrivia"/> property when
/// parsing markdown to have trivia available for rendering.
public class RoundtripRenderer : TextRendererBase<RoundtripRenderer>
{
/// <summary>
/// Initializes a new instance of the <see cref="NormalizeRenderer"/> class.
/// Initializes a new instance of the <see cref="RoundtripRenderer"/> class.
/// </summary>
/// <param name="writer">The writer.</param>
/// <param name="options">The normalize options</param>
public RoundtripRenderer(TextWriter writer) : base(writer)
{
// Default block renderers

View File

@@ -7,7 +7,7 @@ using Markdig.Syntax;
namespace Markdig.Renderers.Roundtrip
{
/// <summary>
/// A Normalize renderer for a <see cref="ThematicBreakBlock"/>.
/// A Roundtrip renderer for a <see cref="ThematicBreakBlock"/>.
/// </summary>
/// <seealso cref="NormalizeObjectRenderer{ThematicBreakBlock}" />
public class ThematicBreakRenderer : RoundtripObjectRenderer<ThematicBreakBlock>
@@ -16,11 +16,7 @@ namespace Markdig.Renderers.Roundtrip
{
renderer.RenderLinesBefore(obj);
// for now, render always a newline
// TODO: only render a newline when not last line
//renderer.Write(obj.BeforeWhitespace);
renderer.Write(obj.Content);
//renderer.Write(obj.AfterWhitespace);
renderer.WriteLine(obj.NewLine);
renderer.RenderLinesAfter(obj);
}

View File

@@ -4,10 +4,10 @@ Markdig supports parsing trivia characters and tracks the source position of the
To use this functionality, set the optional `trackTrivia` parameter to true when using the static `Markdown` class:
```csharp
MarkdownDocument markdownDocument = Markdown.Parse(inputMarkdown, trackTrivia = true);
MarkdownDocument markdownDocument = Markdown.Parse(inputMarkdown, pipeline, trackTrivia = true);
true);
```
You will get a parse tree where various `Trivia*` properties of `Block` and `Inline` instances now have instances. To write a document to Markdown using this tree, use the `RoundtripRenderer`:
```csharp
```csharpTestLiteralInline
var sw = new StringWriter();
var rr = new RoundtripRenderer(sw);
rr.Write(markdownDocument);

View File

@@ -58,8 +58,16 @@ namespace Markdig.Syntax
/// </summary>
event ProcessInlineDelegate ProcessInlinesEnd;
public StringSlice TriviaBefore { get; set; }
public StringSlice TriviaAfter { get; set; }
/// <summary>
/// Trivia occurring before this block
/// </summary>
/// Trivia: only parsed when <see cref="MarkdownParser.TrackTrivia"/> is enabled, otherwise <see cref="StringSlice.IsEmpty"/>.
StringSlice TriviaBefore { get; set; }
/// <summary>
/// Trivia occurring after this block
/// </summary>
/// Trivia: only parsed when <see cref="MarkdownParser.TrackTrivia"/> is enabled, otherwise <see cref="StringSlice.IsEmpty"/>.
StringSlice TriviaAfter { get; set; }
}
}

View File

@@ -20,7 +20,7 @@ namespace Markdig.Syntax
/// <summary>
/// Gets or sets the fenced character count used to open this fenced code block.
/// </summary>
public int OpeningFencedCharCount { get; set; }
int OpeningFencedCharCount { get; set; }
/// <summary>
/// Gets or sets the trivia after the <see cref="FencedChar"/>.