Add new TODO marker tests

Author: tommy9

RubberduckTests/TodoExplorer/TodoExplorerTests.cs

@@ -18,17 +18,18 @@ public class TodoExplorerTests
         [TestCategory("Annotations")]
         public void PicksUpComments()
         {
-            var content =
+            const string inputCode =
                 @"' Todo this is a todo comment
 ' Note this is a note comment
 ' Bug this is a bug comment
 ";
 
             var builder = new MockVbeBuilder();
             var project = builder.ProjectBuilder("TestProject1", ProjectProtection.Unprotected)
-                .AddComponent("Module1", ComponentType.StandardModule, content);
+                .AddComponent("Module1", ComponentType.StandardModule, inputCode)
+                .Build();
 
-            var vbe = builder.AddProject(project.Build()).Build();
+            var vbe = builder.AddProject(project).Build();
             var parser = MockParser.Create(vbe.Object);
             using (var state = parser.State)
             {
@@ -51,7 +52,7 @@ public void PicksUpComments()
         [TestCategory("Annotations")]
         public void PicksUpComments_StrangeCasing()
         {
-            var content =
+            const string inputCode =
                 @"' tODO this is a todo comment
 ' NOTE  this is a note comment
 ' bug this is a bug comment
@@ -60,9 +61,10 @@ public void PicksUpComments_StrangeCasing()
 
             var builder = new MockVbeBuilder();
             var project = builder.ProjectBuilder("TestProject1", ProjectProtection.Unprotected)
-                .AddComponent("Module1", ComponentType.StandardModule, content);
+                .AddComponent("Module1", ComponentType.StandardModule, inputCode)
+                .Build();
 
-            var vbe = builder.AddProject(project.Build()).Build();
+            var vbe = builder.AddProject(project).Build();
             var parser = MockParser.Create(vbe.Object);
             using (var state = parser.State)
             {
@@ -81,19 +83,87 @@ public void PicksUpComments_StrangeCasing()
             }
         }
 
+        [TestMethod]
+        [TestCategory("Annotations")]
+        public void PicksUpComments_SpecialCharacters()
+        {
+            const string inputCode =
+                @"' To-do - this is a todo comment
+' N@TE this is a note comment
+' bug: this should work with a colon separator
+";
+
+            var builder = new MockVbeBuilder();
+            var project = builder.ProjectBuilder("TestProject1", ProjectProtection.Unprotected)
+                .AddComponent("Module1", ComponentType.StandardModule, inputCode)
+                .Build();
+
+            var vbe = builder.AddProject(project).Build();
+            var parser = MockParser.Create(vbe.Object);
+            using (var state = parser.State)
+            {
+                var cs = GetConfigService(new[] { "TO-DO", "N@TE", "BUG" });
+                var vm = new ToDoExplorerViewModel(state, cs, GetOperatingSystemMock().Object);
+
+                parser.Parse(new CancellationTokenSource());
+                if (state.Status >= ParserState.Error)
+                {
+                    Assert.Inconclusive("Parser Error");
+                }
+
+                var comments = vm.Items.Select(s => s.Type);
+
+                Assert.IsTrue(comments.SequenceEqual(new[] { "TO-DO", "N@TE", "BUG" }));
+            }
+        }
+
+        [TestMethod]
+        [TestCategory("Annotations")]
+        public void AvoidsFalsePositiveComments()
+        {
+            const string inputCode =
+                @"' Todon't should not get picked up
+' Debug.print() would trigger false positive if word boundaries not used
+' Denoted 
+";
+
+            var builder = new MockVbeBuilder();
+            var project = builder.ProjectBuilder("TestProject1", ProjectProtection.Unprotected)
+                .AddComponent("Module1", ComponentType.StandardModule, inputCode)
+                .Build();
+
+            var vbe = builder.AddProject(project).Build();
+            var parser = MockParser.Create(vbe.Object);
+            using (var state = parser.State)
+            {
+                var cs = GetConfigService(new[] { "TODO", "NOTE", "BUG" });
+                var vm = new ToDoExplorerViewModel(state, cs, GetOperatingSystemMock().Object);
+
+                parser.Parse(new CancellationTokenSource());
+                if (state.Status >= ParserState.Error)
+                {
+                    Assert.Inconclusive("Parser Error");
+                }
+
+                var comments = vm.Items.Select(s => s.Type);
+
+                Assert.IsTrue(comments.Count() == 0);
+            }
+        }
+
         [TestMethod]
         [TestCategory("Annotations")]
         public void RemoveRemovesComment()
         {
-            var input =
+            const string inputCode =
                 @"Dim d As Variant  ' bug should be Integer";
 
-            var expected =
+            const string expected =
                 @"Dim d As Variant  ";
 
             var builder = new MockVbeBuilder();
             var project = builder.ProjectBuilder("TestProject1", ProjectProtection.Unprotected)
-                .AddComponent("Module1", ComponentType.StandardModule, input)
+                .AddComponent("Module1", ComponentType.StandardModule, inputCode)
                 .Build();
 
             var vbe = builder.AddProject(project).Build();