Merge pull request #2102 from Hosch250/obsoleteCommentBugs

Fix obsolete comment inspection bugs

Author: Hosch250

RetailCoder.VBE/Inspections/ObsoleteCommentSyntaxInspectionResult.cs

@@ -48,7 +48,7 @@ public override void Fix()
                 return;
             }
 
-            var content = module.get_Lines(Selection.Selection.StartLine, Selection.Selection.LineCount);
+            var content = module.Lines[Selection.Selection.StartLine, Selection.Selection.LineCount];
 
             int markerPosition;
             if (!content.HasComment(out markerPosition))
@@ -59,7 +59,7 @@ public override void Fix()
             var code = string.Empty;
             if (markerPosition > 0)
             {
-                code = content.Substring(0, markerPosition - 1);
+                code = content.Substring(0, markerPosition).TrimEnd();
             }
 
             if (_comment.QualifiedSelection.Selection.LineCount > 1)
@@ -89,7 +89,7 @@ public override void Fix()
                 return;
             }
 
-            var content = module.get_Lines(Selection.Selection.StartLine, Selection.Selection.LineCount);
+            var content = module.Lines[Selection.Selection.StartLine, Selection.Selection.LineCount];
 
             int markerPosition;
             if (!content.HasComment(out markerPosition))
@@ -100,7 +100,7 @@ public override void Fix()
             var code = string.Empty;
             if (markerPosition > 0)
             {
-                code = content.Substring(0, markerPosition - 1);
+                code = content.Substring(0, markerPosition);
             }
 
             var newContent = code + Tokens.CommentMarker + " " + _comment.CommentText;

RubberduckTests/Inspections/ObsoleteCommentSyntaxInspectionTests.cs

@@ -61,6 +61,33 @@ public void ObsoleteCommentSyntax_DoesNotReturnResult()
             Assert.AreEqual(0, inspectionResults.Count());
         }
 
+        [TestMethod]
+        [TestCategory("Inspections")]
+        public void ObsoleteCommentSyntax_DoesNotReturnResult_RemInStringLiteral()
+        {
+            const string inputCode = 
+@"Sub Foo()
+    Dim bar As String
+    bar = ""iejo rem oernp"" ' test
+End Sub";
+
+            //Arrange
+            var builder = new MockVbeBuilder();
+            VBComponent component;
+            var vbe = builder.BuildFromSingleStandardModule(inputCode, out component);
+            var mockHost = new Mock<IHostApplication>();
+            mockHost.SetupAllProperties();
+            var parser = MockParser.Create(vbe.Object, new RubberduckParserState(vbe.Object, new Mock<ISinks>().Object));
+
+            parser.Parse(new CancellationTokenSource());
+            if (parser.State.Status >= ParserState.Error) { Assert.Inconclusive("Parser Error"); }
+
+            var inspection = new ObsoleteCommentSyntaxInspection(parser.State);
+            var inspectionResults = inspection.GetInspectionResults();
+
+            Assert.AreEqual(0, inspectionResults.Count());
+        }
+
         [TestMethod]
         [TestCategory("Inspections")]
         public void ObsoleteCommentSyntax_ReturnsMultipleResults()
@@ -198,6 +225,68 @@ public void ObsoleteCommentSyntax_QuickFixWorks_RemoveComment()
             Assert.AreEqual(expectedCode, module.Lines());
         }
 
+        [TestMethod]
+        [TestCategory("Inspections")]
+        public void ObsoleteCommentSyntax_QuickFixWorks_UpdateComment_LineHasCode()
+        {
+            const string inputCode =
+@"Dim Foo As Integer: Rem This is a comment";
+
+            const string expectedCode =
+@"Dim Foo As Integer: ' This is a comment";
+
+            //Arrange
+            var builder = new MockVbeBuilder();
+            VBComponent component;
+            var vbe = builder.BuildFromSingleStandardModule(inputCode, out component);
+            var project = vbe.Object.VBProjects.Item(0);
+            var module = project.VBComponents.Item(0).CodeModule;
+            var mockHost = new Mock<IHostApplication>();
+            mockHost.SetupAllProperties();
+            var parser = MockParser.Create(vbe.Object, new RubberduckParserState(vbe.Object, new Mock<ISinks>().Object));
+
+            parser.Parse(new CancellationTokenSource());
+            if (parser.State.Status >= ParserState.Error) { Assert.Inconclusive("Parser Error"); }
+
+            var inspection = new ObsoleteCommentSyntaxInspection(parser.State);
+            var inspectionResults = inspection.GetInspectionResults();
+
+            inspectionResults.First().QuickFixes.First().Fix();
+
+            Assert.AreEqual(expectedCode, module.Lines());
+        }
+
+        [TestMethod]
+        [TestCategory("Inspections")]
+        public void ObsoleteCommentSyntax_QuickFixWorks_RemoveComment_LineHasCode()
+        {
+            const string inputCode =
+@"Dim Foo As Integer: Rem This is a comment";
+
+            const string expectedCode =
+@"Dim Foo As Integer:";
+
+            //Arrange
+            var builder = new MockVbeBuilder();
+            VBComponent component;
+            var vbe = builder.BuildFromSingleStandardModule(inputCode, out component);
+            var project = vbe.Object.VBProjects.Item(0);
+            var module = project.VBComponents.Item(0).CodeModule;
+            var mockHost = new Mock<IHostApplication>();
+            mockHost.SetupAllProperties();
+            var parser = MockParser.Create(vbe.Object, new RubberduckParserState(vbe.Object, new Mock<ISinks>().Object));
+
+            parser.Parse(new CancellationTokenSource());
+            if (parser.State.Status >= ParserState.Error) { Assert.Inconclusive("Parser Error"); }
+
+            var inspection = new ObsoleteCommentSyntaxInspection(parser.State);
+            var inspectionResults = inspection.GetInspectionResults();
+
+            inspectionResults.First().QuickFixes.ElementAt(1).Fix();
+
+            Assert.AreEqual(expectedCode, module.Lines());
+        }
+
         [TestMethod]
         [TestCategory("Inspections")]
         public void ObsoleteCommentSyntax_IgnoreQuickFixWorks()