Fix issue with de-duplicating MamlLinks (#282)

Author: vors

build.ps1

@@ -2,7 +2,8 @@
 
 param(
     [ValidateSet('Debug', 'Release')]
-    $Configuration = "Debug"
+    $Configuration = "Debug",
+    [switch]$SkipDocs
 )
 
 # build .dll
@@ -46,7 +47,9 @@ if ($env:APPVEYOR_REPO_TAG_NAME)
 # dogfooding: generate help for the module
 Remove-Module platyPS -ErrorAction SilentlyContinue
 Import-Module $pwd\out\platyPS
-New-ExternalHelp docs -OutputPath out\platyPS\en-US -Force
 
-# reload module, to apply generated help
-Import-Module $pwd\out\platyPS -Force
+if (-not $SkipDocs) {
+    New-ExternalHelp docs -OutputPath out\platyPS\en-US -Force
+    # reload module, to apply generated help
+    Import-Module $pwd\out\platyPS -Force
+}

src/Markdown.MAML/Transformer/MamlMultiModelMerger.cs

@@ -85,30 +85,55 @@ public MamlCommand Merge(Dictionary<string, MamlCommand> applicableTag2Model)
                 Extent = referenceModel.Extent
             };
 
-            // post all links, exclude dups
-            result.Links.AddRange(MergeEntityList(tagsModel.ToDictionary(pair => pair.Key, pair => pair.Value.Links)));
+            result.Links.AddRange(MergeSimplifiedLinks(tagsModel.Select(pair => pair.Value.Links)));
 
             MergeExamples(result, applicableTag2Model);
 
-            result.Inputs.AddRange(MergeEntityList(tagsModel.ToDictionary(pair => pair.Key, pair => pair.Value.Inputs)));
-            result.Outputs.AddRange(MergeEntityList(tagsModel.ToDictionary(pair => pair.Key, pair => pair.Value.Outputs)));
+            result.Inputs.AddRange(MergeEntityList(tagsModel.Select(pair => pair.Value.Inputs)));
+            result.Outputs.AddRange(MergeEntityList(tagsModel.Select(pair => pair.Value.Outputs)));
 
             MergeParameters(result, applicableTag2Model);
             return result;
         }
 
+        private IEnumerable<MamlLink> MergeSimplifiedLinks(IEnumerable<List<MamlLink>> linksList)
+        {
+            // In theory we could simply use MergeEntityList, but we have this SimplifiedLinks hack:
+            // we just put whole paragraphs of text into LinkName.
+
+            // To acoount for it we should
+            // split any simplified link into separate ones.
+            // Then we can combine them and return in the form of simplified links.
+
+            List<List<MamlLink>> candidates = new List<List<MamlLink>>();
+            foreach (var links in linksList)
+            {
+                foreach (var link in links)
+                {
+                    if (!link.IsSimplifiedTextLink)
+                    {
+                        throw new ArgumentException("All links are expected in simplified form");
+                    }
+                    string[] segments = link.LinkName.Split(new string[] { Environment.NewLine }, StringSplitOptions.RemoveEmptyEntries);
+                    candidates.Add(segments.Select(s => new MamlLink(isSimplifiedTextLink: true) { LinkName = s.Trim() + "\r\n\r\n" }).ToList());
+                }
+            }
+
+            return MergeEntityList(candidates);
+        }
+
         /// <summary>
         /// Merge entities, exclude duplicates and preserve the order.
         /// </summary>
         /// <param name="links"></param>
         /// <returns></returns>
-        private List<TEntity> MergeEntityList<TEntity>(Dictionary<string, List<TEntity>> applicableTag2Model) 
+        private List<TEntity> MergeEntityList<TEntity>(IEnumerable<List<TEntity>> entities) 
             where TEntity : IEquatable<TEntity>
         {
             List<TEntity> result = new List<TEntity>();
-            foreach(var pair in applicableTag2Model)
+            foreach(var entity in entities)
             {
-                foreach (var candidate in pair.Value)
+                foreach (var candidate in entity)
                 {
                     // this cycle can be optimized but that's fine
                     bool found = false; 

test/Markdown.MAML.Test/Transformer/MamlMultiModelMergerTests.cs

@@ -18,7 +18,7 @@ public void Merge3SimpleModels()
             input["Second"] = GetModel2();
             input["Third"] = GetModel3();
 
-            var result = merger.Merge(input);
+             var result = merger.Merge(input);
 
             Assert.Equal(result.Synopsis, @"! First, Second
 
@@ -54,8 +54,8 @@ Third Command
 
             // Links
             Assert.Equal(2, result.Links.Count);
-            Assert.Equal("", result.Links.ElementAt(0).LinkName);
-            Assert.Equal("foo", result.Links.ElementAt(1).LinkName);
+            Assert.Equal("[foo]()\r\n\r\n", result.Links.ElementAt(0).LinkName);
+            Assert.Equal("[bar]()\r\n\r\n", result.Links.ElementAt(1).LinkName);
 
             // Examples
             Assert.Equal(2, result.Examples.Count);
@@ -103,10 +103,9 @@ private MamlCommand GetModel1()
                 Notes = "This is a multiline note.\r\nSecond line.\r\nFirst Command"
             };
 
-            command.Links.Add(new MamlLink()
+            command.Links.Add(new MamlLink(true)
             {
-                LinkName = "", // if name is empty, it would be populated with uri
-                LinkUri = "http://foo.com"
+                LinkName = "[foo]()\r\n",
             });
 
             command.Inputs.Add(new MamlInputOutput()
@@ -160,16 +159,9 @@ private MamlCommand GetModel2()
                 Notes = "This is a multiline note.\r\nSecond line.\r\nSecond Command"
             };
 
-            command.Links.Add(new MamlLink()
-            {
-                LinkName = "", // if name is empty, it would be populated with uri
-                LinkUri = "http://foo.com"
-            });
-
-            command.Links.Add(new MamlLink()
+            command.Links.Add(new MamlLink(true)
             {
-                LinkName = "foo",
-                LinkUri = ""
+                LinkName = "[foo]()\r\n[bar]()",
             });
 
             command.Examples.Add(new MamlExample()
@@ -224,10 +216,9 @@ private MamlCommand GetModel3()
                 Notes = "This is a multiline note.\r\nSecond line.\r\nThird Command"
             };
 
-            command.Links.Add(new MamlLink()
+            command.Links.Add(new MamlLink(true)
             {
-                LinkName = "foo",
-                LinkUri = ""
+                LinkName = "[bar]()",
             });
 
             command.Examples.Add(new MamlExample()