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.

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

Add code block parsing #22

Merged
merged 3 commits into from
Aug 30, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ public MarkdownHeadedBlock(HeadingBlock header, IReadOnlyCollection<Block> conte
// TODO: remove this method and pass header text instead of header block
public string GetHeaderText()
{
var roundtripRendererTextExtractor = new RoundtripRendererPlainTextExtractor(MarkdownPipelineProvider.GetDefault());
return roundtripRendererTextExtractor.ExtractText(Header);
var plainTextExtractor = new PlainTextExtractor(MarkdownPipelineProvider.GetDefault());
return plainTextExtractor.ExtractText(Header);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
using Markdig;
using Markdig.Renderers;
using Markdig.Syntax;
using System.Text;
using System.Web;

namespace Kysect.Configuin.Core.MarkdownParsing.TextExtractor;

public class PlainTextExtractor : IMarkdownTextExtractor
{
private readonly MarkdownPipeline _markdownPipeline;

public PlainTextExtractor(MarkdownPipeline markdownPipeline)
{
_markdownPipeline = markdownPipeline;
}

public string ExtractText(Block block)
{
var memoryStream = new MemoryStream();
using var streamWriter = new StreamWriter(memoryStream);
var renderer = new HtmlRenderer(streamWriter)
{
EnableHtmlForBlock = false,
EnableHtmlForInline = false,
};
_markdownPipeline.Setup(renderer);

renderer.Render(block);

streamWriter.Flush();
string result = Encoding.ASCII.GetString(memoryStream.ToArray());
return HttpUtility.HtmlDecode(result.Trim());
FrediKats marked this conversation as resolved.
Show resolved Hide resolved
}
}

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,12 @@ private RoslynStyleRuleOption ParseOption(MarkdownHeadedBlock optionBlock)
MsLearnPropertyValueDescriptionTable table = _msLearnTableParser.Parse(markdownTableContent);

var codeBlocks = optionBlock.Content.OfType<CodeBlock>().ToList();
// TODO: implement code block filtering (C# / VB) and parsing
CodeBlock? csharpCodeBlock = codeBlocks
.OfType<FencedCodeBlock>()
.FirstOrDefault(cb => cb.Info == "csharp");
string csharpCodeSample = csharpCodeBlock is null
? ""
FrediKats marked this conversation as resolved.
Show resolved Hide resolved
: _textExtractor.ExtractText(csharpCodeBlock);

MsLearnPropertyValueDescriptionTableRow optionName = table.GetSingleValue("Option name");
IReadOnlyList<MsLearnPropertyValueDescriptionTableRow> optionValues = table.GetValues("Option values");
Expand All @@ -151,7 +156,6 @@ private RoslynStyleRuleOption ParseOption(MarkdownHeadedBlock optionBlock)
optionName.Value,
optionValues.Select(v => new RoslynStyleRuleOptionValue(v.Value, v.Description)).ToList(),
defaultValue.Value,
// TODO: replace with real value
CsharpCodeSample: string.Empty);
csharpCodeSample);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ public class MarkdownTableParserTests
public void Setup()
{
MarkdownPipeline markdownPipeline = MarkdownPipelineProvider.GetDefault();
_parser = new MarkdownTableParser(new RoundtripRendererPlainTextExtractor(markdownPipeline));
_parser = new MarkdownTableParser(new PlainTextExtractor(markdownPipeline));
}

[Test]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ public class MsLearnDocumentationParserTests
[SetUp]
public void Setup()
{
_parser = new MsLearnDocumentationParser(new RoundtripRendererPlainTextExtractor(MarkdownPipelineProvider.GetDefault()));
_parser = new MsLearnDocumentationParser(new PlainTextExtractor(MarkdownPipelineProvider.GetDefault()));
}

[Test]
Expand Down Expand Up @@ -48,9 +48,23 @@ public void ParseStyleRule_IDE0040_ReturnExpectedResult()
roslynStyleRule.Options.Single().DefaultValue
.Should().Be("for_non_interface_members");

// TODO: should add validation for code samples
//roslynStyleRule.Options.Single().CsharpCodeSample
// .Should().Be("");
var codeSample = """
// dotnet_style_require_accessibility_modifiers = always
// dotnet_style_require_accessibility_modifiers = for_non_interface_members
class MyClass
{
private const string thisFieldIsConst = "constant";
}

// dotnet_style_require_accessibility_modifiers = never
class MyClass
{
const string thisFieldIsConst = "constant";
}
""".Replace("\r\n", "\n", StringComparison.InvariantCultureIgnoreCase);

FrediKats marked this conversation as resolved.
Show resolved Hide resolved
roslynStyleRule.Options.Single().CsharpCodeSample
.Should().Be(codeSample);
}

[Test]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ public void Parse_PropertyValueWithDescriptionTable_ReturnExpectedResult()

private MarkdownTableContent ConvertToMarkdownTable(string content)
{
var parser = new MarkdownTableParser(new RoundtripRendererPlainTextExtractor(MarkdownPipelineProvider.GetDefault()));
var parser = new MarkdownTableParser(new PlainTextExtractor(MarkdownPipelineProvider.GetDefault()));
MarkdownDocument markdownDocument = MarkdownDocumentExtensions.CreateFromString(content);
Table table = markdownDocument.Single().To<Table>();
return parser.ParseToSimpleContent(table);
Expand Down