Merge branch 'master' of https://github.com/retailcoder/Rubberduck.git

rubberduck203 · rubberduck203 · commit e30069183932 · 2014-11-29T20:05:26.000-05:00
diff --git a/RetailCoder.VBE/App.cs b/RetailCoder.VBE/App.cs
@@ -30,17 +30,19 @@ public App(VBE vbe, AddIn addIn)
                                       var constructorInfo = type.GetConstructor(Type.EmptyTypes);
                                       return constructorInfo != null ? constructorInfo.Invoke(Type.EmptyTypes) : null;
                                   })
+                                  .Where(syntax => syntax != null)
                                   .Cast<ISyntax>()
                                   .ToList();
 
             _inspections = Assembly.GetExecutingAssembly()
                                    .GetTypes()
-                                   .Where(type => type.GetInterfaces().Contains(typeof(IInspection)))
+                                   .Where(type => type.BaseType ==  typeof(CodeInspection))
                                    .Select(type =>
                                    {
                                        var constructor = type.GetConstructor(Type.EmptyTypes);
                                        return constructor != null ? constructor.Invoke(Type.EmptyTypes) : null;
                                    })
+                                  .Where(inspection => inspection != null)
                                    .Cast<IInspection>()
                                    .ToList();
 
diff --git a/RetailCoder.VBE/Inspections/CodeInspection.cs b/RetailCoder.VBE/Inspections/CodeInspection.cs
@@ -0,0 +1,37 @@
+﻿using System.Collections.Generic;
+using System.Runtime.InteropServices;
+using Rubberduck.VBA.Parser;
+
+namespace Rubberduck.Inspections
+{
+    [ComVisible(false)]
+    public abstract class CodeInspection : IInspection
+    {
+        protected CodeInspection(string name, string message, CodeInspectionType type, CodeInspectionSeverity severity)
+        {
+            _name = name;
+            _message = message;
+            _inspectionType = type;
+            Severity = severity;
+        }
+
+        private readonly string _name;
+        public string Name { get { return _name; } }
+
+        private readonly string _message;
+        public string QuickFixMessage { get { return _message; } }
+
+        private readonly CodeInspectionType _inspectionType;
+        public CodeInspectionType InspectionType { get { return _inspectionType; } }
+
+        public CodeInspectionSeverity Severity { get; set; }
+        public bool IsEnabled { get; set; }
+
+        /// <summary>
+        /// Inspects specified tree node, searching for code issues.
+        /// </summary>
+        /// <param name="node"></param>
+        /// <returns></returns>
+        public abstract IEnumerable<CodeInspectionResultBase> Inspect(SyntaxTreeNode node);
+    }
+}
diff --git a/RetailCoder.VBE/Inspections/CodeInspectionResultBase.cs b/RetailCoder.VBE/Inspections/CodeInspectionResultBase.cs
@@ -7,13 +7,20 @@ namespace Rubberduck.Inspections
     [ComVisible(false)]
     public abstract class CodeInspectionResultBase
     {
-        public CodeInspectionResultBase(Instruction instruction, CodeInspectionSeverity type, string message)
+        public CodeInspectionResultBase(string inspection, Instruction instruction, CodeInspectionSeverity type, string message)
         {
+            _name = inspection;
             _instruction = instruction;
             _type = type;
             _message = message;
         }
 
+        private readonly string _name;
+        /// <summary>
+        /// Gets a string containing the name of the code inspection.
+        /// </summary>
+        public string Name { get { return _name; } }
+
         private readonly Instruction _instruction;
         /// <summary>
         /// Gets the <see cref="Instruction"/> containing a code issue.
diff --git a/RetailCoder.VBE/Inspections/CodeInspectionSeverity.cs b/RetailCoder.VBE/Inspections/CodeInspectionSeverity.cs
@@ -5,7 +5,10 @@ namespace Rubberduck.Inspections
     [ComVisible(false)]
     public enum CodeInspectionSeverity
     {
+        DoNotShow,
+        Hint,
         Suggestion,
-        Warning
+        Warning,
+        Error
     }
 }
diff --git a/RetailCoder.VBE/Inspections/ObsoleteCommentSyntaxInspection.cs b/RetailCoder.VBE/Inspections/ObsoleteCommentSyntaxInspection.cs
@@ -7,38 +7,24 @@
 namespace Rubberduck.Inspections
 {
     [ComVisible(false)]
-    public class ObsoleteCommentSyntaxInspection : IInspection
+    public class ObsoleteCommentSyntaxInspection : CodeInspection
     {
         /// <summary>
         /// Parameterless constructor required for discovery of implemented code inspections.
         /// </summary>
         public ObsoleteCommentSyntaxInspection()
+            : base("Use of obsolete Rem comment syntax", 
+                   "Replace Rem reserved keyword with single quote.", 
+                   CodeInspectionType.MaintainabilityAndReadabilityIssues, 
+                   CodeInspectionSeverity.Suggestion)
         {
-            _name = "Use of obsolete Rem comment syntax";
-            _quickFixMessage = "Replace Rem reserved keyword with single quote.";
-            _inspectionType = CodeInspectionType.MaintainabilityAndReadabilityIssues;
-            _severity = CodeInspectionSeverity.Suggestion;
         }
 
-        private readonly string _name;
-        public string Name { get { return _name; } }
-
-        private readonly string _quickFixMessage;
-        public string QuickFixMessage { get { return _quickFixMessage; } }
-
-        private readonly CodeInspectionType _inspectionType;
-        public CodeInspectionType InspectionType { get { return _inspectionType; } }
-
-        private readonly CodeInspectionSeverity _severity;
-        public CodeInspectionSeverity Severity { get { return _severity; } }
-
-        public bool IsEnabled { get; set; }
-
-        public IEnumerable<CodeInspectionResultBase> Inspect(SyntaxTreeNode node)
+        public override IEnumerable<CodeInspectionResultBase> Inspect(SyntaxTreeNode node)
         {
-            return node.FindAllComments()
-                       .Where(instruction => instruction.Value == ReservedKeywords.Rem)
-                       .Select(instruction => new ObsoleteCommentSyntaxInspectionResult(instruction, _severity, _quickFixMessage));
+            var comments = node.FindAllComments();
+            var remComments = comments.Where(instruction => instruction.Value.Trim().StartsWith(ReservedKeywords.Rem));
+            return remComments.Select(instruction => new ObsoleteCommentSyntaxInspectionResult(Name, instruction, Severity, QuickFixMessage));
         }
     }
 }
diff --git a/RetailCoder.VBE/Inspections/ObsoleteCommentSyntaxInspectionResult.cs b/RetailCoder.VBE/Inspections/ObsoleteCommentSyntaxInspectionResult.cs
@@ -6,8 +6,8 @@ namespace Rubberduck.Inspections
 {
     public class ObsoleteCommentSyntaxInspectionResult : CodeInspectionResultBase
     {
-        public ObsoleteCommentSyntaxInspectionResult(Instruction instruction, CodeInspectionSeverity type, string message) 
-            : base(instruction, type, message)
+        public ObsoleteCommentSyntaxInspectionResult(string inspection, Instruction instruction, CodeInspectionSeverity type, string message) 
+            : base(inspection, instruction, type, message)
         {
         }
 
diff --git a/RetailCoder.VBE/Properties/Resources.Designer.cs b/RetailCoder.VBE/Properties/Resources.Designer.cs
diff --git a/RetailCoder.VBE/Properties/Resources.resx b/RetailCoder.VBE/Properties/Resources.resx
@@ -166,4 +166,10 @@
   <data name="TestManager_8590_32" type="System.Resources.ResXFileRef, System.Windows.Forms">
     <value>..\Resources\Microsoft\TestManager_8590_32.bmp;System.Drawing.Bitmap, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a</value>
   </data>
+  <data name="ListsofTests_8643_24" type="System.Resources.ResXFileRef, System.Windows.Forms">
+    <value>..\Resources\ListsofTests_8643_24.bmp;System.Drawing.Bitmap, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a</value>
+  </data>
+  <data name="Step_RunTest_8814_32" type="System.Resources.ResXFileRef, System.Windows.Forms">
+    <value>..\Resources\Step-RunTest_8814_32.bmp;System.Drawing.Bitmap, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a</value>
+  </data>
 </root>
diff --git a/RetailCoder.VBE/Resources/ListsofTests_8643_24.bmp b/RetailCoder.VBE/Resources/ListsofTests_8643_24.bmp
diff --git a/RetailCoder.VBE/Resources/Step-RunTest_8814_32.bmp b/RetailCoder.VBE/Resources/Step-RunTest_8814_32.bmp
diff --git a/RetailCoder.VBE/Rubberduck.csproj b/RetailCoder.VBE/Rubberduck.csproj
@@ -52,6 +52,7 @@
     <Compile Include="Extensions\CodeModuleSelection.cs" />
     <Compile Include="Extensions\Selection.cs" />
     <Compile Include="Extensions\VbeExtensions.cs" />
+    <Compile Include="Inspections\CodeInspection.cs" />
     <Compile Include="Inspections\CodeInspectionResultBase.cs" />
     <Compile Include="Inspections\CodeInspectionSeverity.cs" />
     <Compile Include="Inspections\CodeInspectionType.cs" />
@@ -321,11 +322,13 @@
     <None Include="Resources\plus-circle.png" />
   </ItemGroup>
   <ItemGroup>
+    <None Include="Resources\Step-RunTest_8814_32.bmp" />
     <None Include="Resources\Warning.bmp" />
     <None Include="Resources\Serious.bmp" />
     <None Include="Resources\OK.bmp" />
     <None Include="Resources\GoLtrHS.bmp" />
     <None Include="Resources\Critical.bmp" />
+    <None Include="Resources\ListsofTests_8643_24.bmp" />
     <Content Include="Resources\Microsoft\AddClass_5561_32.bmp" />
     <Content Include="Resources\Microsoft\AddEvent_5539_32.bmp" />
     <Content Include="Resources\Microsoft\AddForm_369_32.bmp" />
diff --git a/RetailCoder.VBE/UI/CodeInspections/CodeInspectionsDockablePresenter.cs b/RetailCoder.VBE/UI/CodeInspections/CodeInspectionsDockablePresenter.cs
@@ -4,6 +4,7 @@
 using System.Runtime.InteropServices;
 using System.Text;
 using System.Threading.Tasks;
+using System.Windows.Forms;
 using Microsoft.Vbe.Interop;
 using Rubberduck.Inspections;
 using Rubberduck.VBA.Parser;
@@ -33,7 +34,11 @@ private void OnRefreshCodeInspections(object sender, EventArgs e)
             var results = new List<CodeInspectionResultBase>();
             foreach (var inspection in _inspections.Where(inspection => inspection.IsEnabled))
             {
-                results.AddRange(inspection.Inspect(code));
+                var result = inspection.Inspect(code).ToArray();
+                if (result.Length != 0)
+                {
+                    results.AddRange(result);
+                }
             }
 
             DrawResultTree(results);
@@ -44,8 +49,10 @@ private void DrawResultTree(IEnumerable<CodeInspectionResultBase> results)
             var tree = Control.CodeInspectionResultsTree;
             tree.Nodes.Clear();
 
-            foreach (var result in results)
+            foreach (var result in results.OrderBy(r => r.Severity))
             {
+                var node = new TreeNode(result.Message);
+
                 tree.Nodes.Add(result.Message);
             }
         }
diff --git a/RetailCoder.VBE/UI/CodeInspections/CodeInspectionsWindow.cs b/RetailCoder.VBE/UI/CodeInspections/CodeInspectionsWindow.cs
@@ -22,6 +22,19 @@ public CodeInspectionsWindow()
         {
             InitializeComponent();
             RefreshButton.Click += RefreshButtonClicked;
+            CodeInspectionResultsTree.NodeMouseDoubleClick += TreeNodeMouseDoubleClicked;
+        }
+
+        public event EventHandler NavigateCodeIssue;
+        private void TreeNodeMouseDoubleClicked(object sender, TreeNodeMouseClickEventArgs e)
+        {
+            var handler = NavigateCodeIssue;
+            if (handler == null)
+            {
+                return;
+            }
+
+            handler(this, EventArgs.Empty);
         }
 
         public event EventHandler RefreshCodeInspections;
@@ -35,7 +48,5 @@ private void RefreshButtonClicked(object sender, EventArgs e)
 
             handler(this, EventArgs.Empty);
         }
-
-        public event EventHandler NavigateCodeIssue;
     }
 }
diff --git a/RetailCoder.VBE/UI/Menu.cs b/RetailCoder.VBE/UI/Menu.cs
@@ -1,8 +1,10 @@
 ﻿using System;
+using System.Drawing;
 using System.Runtime.InteropServices;
 using Microsoft.Office.Core;
 using Microsoft.Vbe.Interop;
 using System.Windows.Forms;
+using Rubberduck.Properties;
 
 namespace Rubberduck.UI
 {
@@ -20,9 +22,31 @@ public Menu(VBE vbe, AddIn addInInstance)
             this.addInInstance = addInInstance;
         }
 
-        protected CommandBarButton AddMenuButton(CommandBarPopup menu)
+        protected CommandBarButton AddMenuButton(CommandBarPopup menu, string caption, Bitmap image)
         {
-            return menu.Controls.Add(MsoControlType.msoControlButton, Temporary: true) as CommandBarButton;
+            var result = menu.Controls.Add(MsoControlType.msoControlButton, Temporary: true) as CommandBarButton;
+            if (result == null)
+            {
+                throw new InvalidOperationException("Failed to create menu control.");
+            }
+
+            result.Caption = caption;
+            SetButtonImage(result, image);
+
+            return result;
+        }
+
+
+
+        private static void SetButtonImage(CommandBarButton result, Bitmap image)
+        {
+            result.FaceId = 0;
+
+            if (image != null)
+            {
+                Clipboard.SetDataObject(image, true);
+                result.PasteFace();
+            }
         }
 
         /// <summary>
diff --git a/RetailCoder.VBE/UI/UnitTesting/TestMenu.cs b/RetailCoder.VBE/UI/UnitTesting/TestMenu.cs
@@ -1,4 +1,5 @@
 ﻿using System.Diagnostics;
+using System.Drawing;
 using System.Runtime.InteropServices;
 using System.Windows.Forms;
 using Microsoft.Office.Core;
@@ -38,19 +39,11 @@ public void Initialize(CommandBarControls menuControls)
 
             menu.Caption = "Te&st";
 
-            _windowsTestExplorerButton = AddMenuButton(menu);
-            _windowsTestExplorerButton.Caption = "&Test Explorer";
-            _windowsTestExplorerButton.FaceId = 0;
-
-            Clipboard.SetDataObject(Resources.TestManager_8590_32, true);
-            _windowsTestExplorerButton.PasteFace();
-
+            _windowsTestExplorerButton = AddMenuButton(menu, "&Test Explorer", Resources.TestManager_8590_32);
             _windowsTestExplorerButton.Click += OnTestExplorerButtonClick;
 
-            _runAllTestsButton = AddMenuButton(menu);
+            _runAllTestsButton = AddMenuButton(menu, "&Run All Tests", Resources.AllLoadedTests_8644_24);
             _runAllTestsButton.BeginGroup = true;
-            _runAllTestsButton.Caption = "&Run All Tests";
-            _runAllTestsButton.FaceId = 186; // a "play" icon
             _runAllTestsButton.Click += OnRunAllTestsButtonClick;
         }
 
diff --git a/RetailCoder.VBE/VBA/Parser/Grammar/StringExtensions.cs b/RetailCoder.VBE/VBA/Parser/Grammar/StringExtensions.cs
@@ -37,12 +37,13 @@ public static bool HasComment(this string line, out int index)
             index = -1;
             var instruction = line.StripStringLiterals();
 
-            for (var cursor = 0; cursor < instruction.Length - 1; cursor++)
+            var firstIndex = instruction.TakeWhile(c => c == ' ').Count();
+            for (var cursor = firstIndex; cursor < instruction.Length - 1; cursor++)
             {
                 if (!string.IsNullOrWhiteSpace(instruction.Trim()) 
                     &&(instruction[cursor] == CommentMarker 
                     || (cursor == ReservedKeywords.Rem.Length 
-                        && instruction.TrimStart().Substring(0, ReservedKeywords.Rem.Length) == ReservedKeywords.Rem)))
+                        && instruction.Trim().Substring(0, ReservedKeywords.Rem.Length) == ReservedKeywords.Rem)))
                 {
                     index = cursor;
                     return true;
diff --git a/RetailCoder.VBE/VBA/Parser/Instruction.cs b/RetailCoder.VBE/VBA/Parser/Instruction.cs
@@ -21,7 +21,7 @@ public Instruction(LogicalCodeLine line, int startColumn, int endColumn, string
             if (_content.HasComment(out index))
             {
                 _comment = _content.Substring(index);
-                _instruction = _content.Substring(0, index);
+                _instruction = _content.Trim().Substring(0, index);
             }
             else
             {

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,10 @@ namespace Rubberduck.Inspections`
`5`	`5`	`[ComVisible(false)]`
`6`	`6`	`public enum CodeInspectionSeverity`
`7`	`7`	`{`
	`8`	`+ DoNotShow,`
	`9`	`+ Hint,`
`8`	`10`	`Suggestion,`
`9`		`- Warning`
	`11`	`+ Warning,`
	`12`	`+ Error`
`10`	`13`	`}`
`11`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,8 +6,8 @@ namespace Rubberduck.Inspections`
`6`	`6`	`{`
`7`	`7`	`public class ObsoleteCommentSyntaxInspectionResult : CodeInspectionResultBase`
`8`	`8`	`{`
`9`		`- public ObsoleteCommentSyntaxInspectionResult(Instruction instruction, CodeInspectionSeverity type, string message)`
`10`		`- : base(instruction, type, message)`
	`9`	`+ public ObsoleteCommentSyntaxInspectionResult(string inspection, Instruction instruction, CodeInspectionSeverity type, string message)`
	`10`	`+ : base(inspection, instruction, type, message)`
`11`	`11`	`{`
`12`	`12`	`}`
`13`	`13`