Bump to 0.15.1

Make AutoIdentifierExtension thread safe

.editorconfig

@@ -6,7 +6,6 @@ root = true
 # All Files
 [*]
 charset = utf-8
-end_of_line = crlf
 indent_style = space
 indent_size = 4
 insert_final_newline = false

changelog.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.15.1 (10 July 2018)
+- Add support for `netstandard2.0`
+- Make AutoIdentifierExtension thread safe
+
 ## 0.15.0 (4 Apr 2018)
 - Add `ConfigureNewLine` extension method to `MarkdownPipelineBuilder` ([(PR #214)](https://github.com/lunet-io/markdig/pull/214))
 - Add alternative `Use` extension method to `MarkdownPipelineBuilder` that receives an object instance ([(PR #213)](https://github.com/lunet-io/markdig/pull/213))

license.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2016, Alexandre Mutel
+Copyright (c) 2018, Alexandre Mutel
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification

src/Markdig.Tests/Markdig.Tests.csproj

@@ -57,6 +57,7 @@
       <DependentUpon>Specs.tt</DependentUpon>
     </Compile>
     <Compile Include="Specs\TestEmphasisPlus.cs" />
+    <Compile Include="TestConfigureNewLine.cs" />
     <Compile Include="TestHtmlAttributes.cs" />
     <Compile Include="TestHtmlHelper.cs" />
     <Compile Include="TestLineReader.cs" />

src/Markdig.Tests/TestConfigureNewLine.cs

@@ -0,0 +1,25 @@
+using NUnit.Framework;
+
+namespace Markdig.Tests
+{
+    [TestFixture]
+    public class TestConfigureNewLine
+    {
+        [Test]
+        [TestCase(/* newLineForWriting: */ "\n",   /* markdownText: */ "*1*\n*2*\n",     /* expected: */ "<p><em>1</em>\n<em>2</em></p>\n")]
+        [TestCase(/* newLineForWriting: */ "\n",   /* markdownText: */ "*1*\r\n*2*\r\n", /* expected: */ "<p><em>1</em>\n<em>2</em></p>\n")]
+        [TestCase(/* newLineForWriting: */ "\r\n", /* markdownText: */ "*1*\n*2*\n",     /* expected: */ "<p><em>1</em>\r\n<em>2</em></p>\r\n")]
+        [TestCase(/* newLineForWriting: */ "\r\n", /* markdownText: */ "*1*\r\n*2*\r\n", /* expected: */ "<p><em>1</em>\r\n<em>2</em></p>\r\n")]
+        [TestCase(/* newLineForWriting: */ "!!!" , /* markdownText: */ "*1*\n*2*\n",     /* expected: */ "<p><em>1</em>!!!<em>2</em></p>!!!")]
+        [TestCase(/* newLineForWriting: */ "!!!" , /* markdownText: */ "*1*\r\n*2*\r\n", /* expected: */ "<p><em>1</em>!!!<em>2</em></p>!!!")]
+        public void TestHtmlOutputWhenConfiguringNewLine(string newLineForWriting, string markdownText, string expected)
+        {
+            var pipeline = new MarkdownPipelineBuilder()
+                .ConfigureNewLine(newLineForWriting)
+                .Build();
+
+            var actual = Markdown.ToHtml(markdownText, pipeline);
+            Assert.AreEqual(expected, actual);
+        }
+    }
+}

src/Markdig/Extensions/AutoIdentifiers/AutoIdentifierExtension.cs

@@ -1,201 +1,199 @@
-// Copyright (c) Alexandre Mutel. All rights reserved.
-// This file is licensed under the BSD-Clause 2 license. 
-// See the license.txt file in the project root for more information.
-
-using System;
-using System.Collections.Generic;
-using System.IO;
-using Markdig.Helpers;
-using Markdig.Parsers;
-using Markdig.Renderers;
-using Markdig.Renderers.Html;
-using Markdig.Syntax;
-using Markdig.Syntax.Inlines;
-
-namespace Markdig.Extensions.AutoIdentifiers
-{
-    /// <summary>
-    /// The auto-identifier extension
-    /// </summary>
-    /// <seealso cref="Markdig.IMarkdownExtension" />
-    public class AutoIdentifierExtension : IMarkdownExtension
-    {
-        private const string AutoIdentifierKey = "AutoIdentifier";
-        private readonly HtmlRenderer stripRenderer;
-        private readonly StringWriter headingWriter;
-        private readonly AutoIdentifierOptions options;
-
-        /// <summary>
-        /// Initializes a new instance of the <see cref="AutoIdentifierExtension"/> class.
-        /// </summary>
-        /// <param name="options">The options.</param>
-        public AutoIdentifierExtension(AutoIdentifierOptions options)
-        {
-            this.options = options;
-            headingWriter = new StringWriter();
-            // Use internally a HtmlRenderer to strip links from a heading
-            stripRenderer = new HtmlRenderer(headingWriter)
-            {
-                // Set to false both to avoid having any HTML tags in the output
-                EnableHtmlForInline = false,
-                EnableHtmlEscape = false
-            };
-        }
-
-        public void Setup(MarkdownPipelineBuilder pipeline)
-        {
-            var headingBlockParser = pipeline.BlockParsers.Find<HeadingBlockParser>();
-            if (headingBlockParser != null)
-            {
-                // Install a hook on the HeadingBlockParser when a HeadingBlock is actually processed
-                headingBlockParser.Closed -= HeadingBlockParser_Closed;
-                headingBlockParser.Closed += HeadingBlockParser_Closed;
-            }
-            var paragraphBlockParser = pipeline.BlockParsers.FindExact<ParagraphBlockParser>();
-            if (paragraphBlockParser != null)
-            {
-                // Install a hook on the ParagraphBlockParser when a HeadingBlock is actually processed as a Setex heading
-                paragraphBlockParser.Closed -= HeadingBlockParser_Closed;
-                paragraphBlockParser.Closed += HeadingBlockParser_Closed;
-            }
-        }
-
-        public void Setup(MarkdownPipeline pipeline, IMarkdownRenderer renderer)
-        {
-        }
-
-        /// <summary>
-        /// Process on a new <see cref="HeadingBlock"/>
-        /// </summary>
-        /// <param name="processor">The processor.</param>
-        /// <param name="block">The heading block.</param>
-        private void HeadingBlockParser_Closed(BlockProcessor processor, Block block)
-        {
-            // We may have a ParagraphBlock here as we have a hook on the ParagraphBlockParser
-            var headingBlock = block as HeadingBlock;
-            if (headingBlock == null)
-            {
-                return;
-            }
-
-            // If the AutoLink options is set, we register a LinkReferenceDefinition at the document level
-            if ((options & AutoIdentifierOptions.AutoLink) != 0)
-            {
-                var headingLine = headingBlock.Lines.Lines[0];
-
-                var text = headingLine.ToString();
-
-                var linkRef = new HeadingLinkReferenceDefinition()
-                {
-                    Heading = headingBlock,
-                    CreateLinkInline = CreateLinkInlineForHeading
-                };
-
-                var doc = processor.Document;
-                var dictionary = doc.GetData(this) as Dictionary<string, HeadingLinkReferenceDefinition>;
-                if (dictionary == null)
-                {
-                    dictionary = new Dictionary<string, HeadingLinkReferenceDefinition>();
-                    doc.SetData(this, dictionary);
-                    doc.ProcessInlinesBegin += DocumentOnProcessInlinesBegin;
-                }
-                dictionary[text] = linkRef;
-            }
-
-            // Then we register after inline have been processed to actually generate the proper #id
-            headingBlock.ProcessInlinesEnd += HeadingBlock_ProcessInlinesEnd;
-        }
-
-        private void DocumentOnProcessInlinesBegin(InlineProcessor processor, Inline inline)
-        {
-            var doc = processor.Document;
-            doc.ProcessInlinesBegin -= DocumentOnProcessInlinesBegin;
-            var dictionary = (Dictionary<string, HeadingLinkReferenceDefinition>)doc.GetData(this);
-            foreach (var keyPair in dictionary)
-            {
-                // Here we make sure that auto-identifiers will not override an existing link definition
-                // defined in the document
-                // If it is the case, we skip the auto identifier for the Heading
-                if (!doc.TryGetLinkReferenceDefinition(keyPair.Key, out var linkDef))
-                {
-                    doc.SetLinkReferenceDefinition(keyPair.Key, keyPair.Value);
-                }
-            }
-            // Once we are done, we don't need to keep the intermediate dictionary arround
-            doc.RemoveData(this);
-        }
-
-        /// <summary>
-        /// Callback when there is a reference to found to a heading. 
-        /// Note that reference are only working if they are declared after.
-        /// </summary>
-        private Inline CreateLinkInlineForHeading(InlineProcessor inlineState, LinkReferenceDefinition linkRef, Inline child)
-        {
-            var headingRef = (HeadingLinkReferenceDefinition) linkRef;
-            return new LinkInline()
-            {
-                // Use GetDynamicUrl to allow late binding of the Url (as a link may occur before the heading is declared and
-                // the inlines of the heading are actually processed by HeadingBlock_ProcessInlinesEnd)
-                GetDynamicUrl = () => HtmlHelper.Unescape("#" + headingRef.Heading.GetAttributes().Id),
-                Title = HtmlHelper.Unescape(linkRef.Title),
-            };
-        }
-
-        /// <summary>
-        /// Process the inlines of the heading to create a unique identifier
-        /// </summary>
-        /// <param name="processor">The processor.</param>
-        /// <param name="inline">The inline.</param>
-        private void HeadingBlock_ProcessInlinesEnd(InlineProcessor processor, Inline inline)
-        {
-            var identifiers = processor.Document.GetData(AutoIdentifierKey) as HashSet<string>;
-            if (identifiers == null)
-            {
-                identifiers = new HashSet<string>();
-                processor.Document.SetData(AutoIdentifierKey, identifiers);
-            }
-
-            var headingBlock = (HeadingBlock) processor.Block;
-            if (headingBlock.Inline == null)
-            {
-                return;
-            }
-
-            // If id is already set, don't try to modify it
-            var attributes = processor.Block.GetAttributes();
-            if (attributes.Id != null)
-            {
-                return;
-            }
-
-            // Use a HtmlRenderer with 
-            stripRenderer.Render(headingBlock.Inline);
-            var headingText = headingWriter.ToString();
-            headingWriter.GetStringBuilder().Length = 0;
-
-            // Urilize the link
-            headingText = (options & AutoIdentifierOptions.GitHub) != 0
-                ? LinkHelper.UrilizeAsGfm(headingText)
-                : LinkHelper.Urilize(headingText, (options & AutoIdentifierOptions.AllowOnlyAscii) != 0);
-
-            // If the heading is empty, use the word "section" instead
-            var baseHeadingId = string.IsNullOrEmpty(headingText) ? "section" : headingText;
-
-            // Add a trailing -1, -2, -3...etc. in case of collision
-            int index = 0;
-            var headingId = baseHeadingId;
-            var headingBuffer = StringBuilderCache.Local();
-            while (!identifiers.Add(headingId))
-            {
-                index++;
-                headingBuffer.Append(baseHeadingId);
-                headingBuffer.Append('-');
-                headingBuffer.Append(index);
-                headingId = headingBuffer.ToString();
-                headingBuffer.Length = 0;
-            }
-
-            attributes.Id = headingId;
-        }
-    }
+// Copyright (c) Alexandre Mutel. All rights reserved.
+// This file is licensed under the BSD-Clause 2 license. 
+// See the license.txt file in the project root for more information.
+
+using System;
+using System.Collections.Generic;
+using System.IO;
+using Markdig.Helpers;
+using Markdig.Parsers;
+using Markdig.Renderers;
+using Markdig.Renderers.Html;
+using Markdig.Syntax;
+using Markdig.Syntax.Inlines;
+
+namespace Markdig.Extensions.AutoIdentifiers
+{
+    /// <summary>
+    /// The auto-identifier extension
+    /// </summary>
+    /// <seealso cref="Markdig.IMarkdownExtension" />
+    public class AutoIdentifierExtension : IMarkdownExtension
+    {
+        private const string AutoIdentifierKey = "AutoIdentifier";
+        private readonly AutoIdentifierOptions options;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="AutoIdentifierExtension"/> class.
+        /// </summary>
+        /// <param name="options">The options.</param>
+        public AutoIdentifierExtension(AutoIdentifierOptions options)
+        {
+            this.options = options;
+        }
+
+        public void Setup(MarkdownPipelineBuilder pipeline)
+        {
+            var headingBlockParser = pipeline.BlockParsers.Find<HeadingBlockParser>();
+            if (headingBlockParser != null)
+            {
+                // Install a hook on the HeadingBlockParser when a HeadingBlock is actually processed
+                headingBlockParser.Closed -= HeadingBlockParser_Closed;
+                headingBlockParser.Closed += HeadingBlockParser_Closed;
+            }
+            var paragraphBlockParser = pipeline.BlockParsers.FindExact<ParagraphBlockParser>();
+            if (paragraphBlockParser != null)
+            {
+                // Install a hook on the ParagraphBlockParser when a HeadingBlock is actually processed as a Setex heading
+                paragraphBlockParser.Closed -= HeadingBlockParser_Closed;
+                paragraphBlockParser.Closed += HeadingBlockParser_Closed;
+            }
+        }
+
+        public void Setup(MarkdownPipeline pipeline, IMarkdownRenderer renderer)
+        {
+        }
+
+        /// <summary>
+        /// Process on a new <see cref="HeadingBlock"/>
+        /// </summary>
+        /// <param name="processor">The processor.</param>
+        /// <param name="block">The heading block.</param>
+        private void HeadingBlockParser_Closed(BlockProcessor processor, Block block)
+        {
+            // We may have a ParagraphBlock here as we have a hook on the ParagraphBlockParser
+            var headingBlock = block as HeadingBlock;
+            if (headingBlock == null)
+            {
+                return;
+            }
+
+            // If the AutoLink options is set, we register a LinkReferenceDefinition at the document level
+            if ((options & AutoIdentifierOptions.AutoLink) != 0)
+            {
+                var headingLine = headingBlock.Lines.Lines[0];
+
+                var text = headingLine.ToString();
+
+                var linkRef = new HeadingLinkReferenceDefinition()
+                {
+                    Heading = headingBlock,
+                    CreateLinkInline = CreateLinkInlineForHeading
+                };
+
+                var doc = processor.Document;
+                var dictionary = doc.GetData(this) as Dictionary<string, HeadingLinkReferenceDefinition>;
+                if (dictionary == null)
+                {
+                    dictionary = new Dictionary<string, HeadingLinkReferenceDefinition>();
+                    doc.SetData(this, dictionary);
+                    doc.ProcessInlinesBegin += DocumentOnProcessInlinesBegin;
+                }
+                dictionary[text] = linkRef;
+            }
+
+            // Then we register after inline have been processed to actually generate the proper #id
+            headingBlock.ProcessInlinesEnd += HeadingBlock_ProcessInlinesEnd;
+        }
+
+        private void DocumentOnProcessInlinesBegin(InlineProcessor processor, Inline inline)
+        {
+            var doc = processor.Document;
+            doc.ProcessInlinesBegin -= DocumentOnProcessInlinesBegin;
+            var dictionary = (Dictionary<string, HeadingLinkReferenceDefinition>)doc.GetData(this);
+            foreach (var keyPair in dictionary)
+            {
+                // Here we make sure that auto-identifiers will not override an existing link definition
+                // defined in the document
+                // If it is the case, we skip the auto identifier for the Heading
+                if (!doc.TryGetLinkReferenceDefinition(keyPair.Key, out var linkDef))
+                {
+                    doc.SetLinkReferenceDefinition(keyPair.Key, keyPair.Value);
+                }
+            }
+            // Once we are done, we don't need to keep the intermediate dictionary arround
+            doc.RemoveData(this);
+        }
+
+        /// <summary>
+        /// Callback when there is a reference to found to a heading. 
+        /// Note that reference are only working if they are declared after.
+        /// </summary>
+        private Inline CreateLinkInlineForHeading(InlineProcessor inlineState, LinkReferenceDefinition linkRef, Inline child)
+        {
+            var headingRef = (HeadingLinkReferenceDefinition) linkRef;
+            return new LinkInline()
+            {
+                // Use GetDynamicUrl to allow late binding of the Url (as a link may occur before the heading is declared and
+                // the inlines of the heading are actually processed by HeadingBlock_ProcessInlinesEnd)
+                GetDynamicUrl = () => HtmlHelper.Unescape("#" + headingRef.Heading.GetAttributes().Id),
+                Title = HtmlHelper.Unescape(linkRef.Title),
+            };
+        }
+
+        /// <summary>
+        /// Process the inlines of the heading to create a unique identifier
+        /// </summary>
+        /// <param name="processor">The processor.</param>
+        /// <param name="inline">The inline.</param>
+        private void HeadingBlock_ProcessInlinesEnd(InlineProcessor processor, Inline inline)
+        {
+            var identifiers = processor.Document.GetData(AutoIdentifierKey) as HashSet<string>;
+            if (identifiers == null)
+            {
+                identifiers = new HashSet<string>();
+                processor.Document.SetData(AutoIdentifierKey, identifiers);
+            }
+
+            var headingBlock = (HeadingBlock) processor.Block;
+            if (headingBlock.Inline == null)
+            {
+                return;
+            }
+
+            // If id is already set, don't try to modify it
+            var attributes = processor.Block.GetAttributes();
+            if (attributes.Id != null)
+            {
+                return;
+            }
+
+            // Use internally a HtmlRenderer to strip links from a heading
+            var headingWriter = new StringWriter();
+            var stripRenderer = new HtmlRenderer(headingWriter)
+            {
+                // Set to false both to avoid having any HTML tags in the output
+                EnableHtmlForInline = false,
+                EnableHtmlEscape = false
+            };
+
+            stripRenderer.Render(headingBlock.Inline);
+            var headingText = headingWriter.ToString();
+            headingWriter.GetStringBuilder().Length = 0;
+
+            // Urilize the link
+            headingText = (options & AutoIdentifierOptions.GitHub) != 0
+                ? LinkHelper.UrilizeAsGfm(headingText)
+                : LinkHelper.Urilize(headingText, (options & AutoIdentifierOptions.AllowOnlyAscii) != 0);
+
+            // If the heading is empty, use the word "section" instead
+            var baseHeadingId = string.IsNullOrEmpty(headingText) ? "section" : headingText;
+
+            // Add a trailing -1, -2, -3...etc. in case of collision
+            int index = 0;
+            var headingId = baseHeadingId;
+            var headingBuffer = StringBuilderCache.Local();
+            while (!identifiers.Add(headingId))
+            {
+                index++;
+                headingBuffer.Append(baseHeadingId);
+                headingBuffer.Append('-');
+                headingBuffer.Append(index);
+                headingId = headingBuffer.ToString();
+                headingBuffer.Length = 0;
+            }
+
+            attributes.Id = headingId;
+        }
+    }
 }

src/Markdig/Helpers/CharHelper.cs

@@ -21,7 +21,7 @@ namespace Markdig.Helpers
         public const string ZeroSafeString = "\uFFFD";
 
         // We don't support LCDM
-        private static IDictionary<char, int> romanMap = new Dictionary<char, int> { { 'I', 1 }, { 'V', 5 }, { 'X', 10 } };
+        private static readonly Dictionary<char, int> romanMap = new Dictionary<char, int> { { 'I', 1 }, { 'V', 5 }, { 'X', 10 } };
 
         private static readonly char[] punctuationExceptions = { '−', '-', '†', '‡' };
 

src/Markdig/Markdig.csproj

@@ -1,13 +1,13 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <Description>A fast, powerfull, CommonMark compliant, extensible Markdown processor for .NET with 20+ builtin extensions (pipetables, footnotes, definition lists... etc.)</Description>
+    <Description>A fast, powerful, CommonMark compliant, extensible Markdown processor for .NET with 20+ builtin extensions (pipetables, footnotes, definition lists... etc.)</Description>
     <Copyright>Alexandre Mutel</Copyright>
     <AssemblyTitle>Markdig</AssemblyTitle>
     <NeutralLanguage>en-US</NeutralLanguage>
-    <VersionPrefix>0.15.0</VersionPrefix>
+    <VersionPrefix>0.15.1</VersionPrefix>
     <Authors>Alexandre Mutel</Authors>
-    <TargetFrameworks>net35;net40;portable40-net40+sl5+win8+wp8+wpa81;netstandard1.1;uap10.0</TargetFrameworks>
+    <TargetFrameworks>net35;net40;portable40-net40+sl5+win8+wp8+wpa81;netstandard1.1;netstandard2.0;uap10.0</TargetFrameworks>
     <AssemblyName>Markdig</AssemblyName>
     <PackageId>Markdig</PackageId>
     <PackageId Condition="'$(SignAssembly)' == 'true'">Markdig.Signed</PackageId>
@@ -51,6 +51,10 @@
     <DefineConstants>$(DefineConstants);NETSTANDARD_11;SUPPORT_UNSAFE</DefineConstants>
   </PropertyGroup>
 
+  <PropertyGroup Condition=" '$(TargetFramework)' == 'netstandard2.0' ">
+    <DefineConstants>$(DefineConstants);SUPPORT_FIXED_STRING;SUPPORT_UNSAFE</DefineConstants>
+  </PropertyGroup>
+  
   <PropertyGroup Condition=" '$(TargetFramework)' == 'uap10.0' ">
     <TargetPlatformIdentifier>UAP</TargetPlatformIdentifier>
     <TargetPlatformVersion Condition="'$(TargetPlatformVersion)' == ''">10.0.10240.0</TargetPlatformVersion>