Merge pull request #902 from Hosch250/UseMeaningfulNameInspection

Use meaningful name inspection

Author: retailcoder

RetailCoder.VBE/Inspections/InspectionsUI.Designer.cs

@@ -123,4 +123,10 @@
   <data name="EmptyStringLiteralInspectionQuickFix" xml:space="preserve">
     <value>Replace '""' with 'vbNullString'.</value>
   </data>
+  <data name="UseMeaningfulNameInspection" xml:space="preserve">
+    <value>Suboptimal Name Detected.</value>
+  </data>
+  <data name="UseMeaningfulNameInspectionQuickFix" xml:space="preserve">
+    <value>Rename</value>
+  </data>
 </root>

RetailCoder.VBE/Inspections/InspectionsUI.resx

@@ -0,0 +1,38 @@
+using System.Collections.Generic;
+using System.Linq;
+using Rubberduck.Parsing.VBA;
+using Rubberduck.UI;
+using Rubberduck.VBEditor.VBEInterfaces.RubberduckCodePane;
+
+namespace Rubberduck.Inspections
+{
+    public class UseMeaningfulNameInspection : IInspection
+    {
+        private readonly ICodePaneWrapperFactory _wrapperFactory;
+
+        public UseMeaningfulNameInspection()
+        {
+            _wrapperFactory = new CodePaneWrapperFactory();
+            Severity = CodeInspectionSeverity.Suggestion;
+        }
+
+        public string Name { get { return "UseMeaningfulNameInspection"; } }
+        public string Description { get { return InspectionsUI.UseMeaningfulNameInspection; } }
+        public CodeInspectionType InspectionType { get { return CodeInspectionType.MaintainabilityAndReadabilityIssues; } }
+        public CodeInspectionSeverity Severity { get; set; }
+
+        public IEnumerable<CodeInspectionResultBase> GetInspectionResults(RubberduckParserState state)
+        {
+            var issues = state.AllDeclarations
+                            .Where(declaration => !declaration.IsBuiltIn &&
+                                                  (declaration.IdentifierName.Length < 3 ||
+                                                   char.IsDigit(declaration.IdentifierName.Last()) ||
+                                                   !declaration.IdentifierName.Any(c => new[] {'a', 'e', 'i', 'o', 'u', 'y'}.Contains(c))
+                                                  ))
+                            .Select(issue => new UseMeaningfulNameInspectionResult(this, issue, state, _wrapperFactory, new MessageBox()))
+                            .ToList();
+
+            return issues;
+        }
+    }
+}

RetailCoder.VBE/Inspections/UseMeaningfulNameInspection.cs

@@ -0,0 +1,63 @@
+using System.Collections.Generic;
+using Antlr4.Runtime;
+using Rubberduck.Parsing.Symbols;
+using Rubberduck.Parsing.VBA;
+using Rubberduck.Refactorings.Rename;
+using Rubberduck.UI;
+using Rubberduck.UI.Refactorings;
+using Rubberduck.VBEditor;
+using Rubberduck.VBEditor.VBEInterfaces.RubberduckCodePane;
+
+namespace Rubberduck.Inspections
+{
+    public class UseMeaningfulNameInspectionResult : CodeInspectionResultBase
+    {
+        private readonly IEnumerable<CodeInspectionQuickFix> _quickFixes;
+
+        public UseMeaningfulNameInspectionResult(IInspection inspection, Declaration target, RubberduckParserState parserState, ICodePaneWrapperFactory wrapperFactory, IMessageBox messageBox)
+            : base(inspection, string.Format(inspection.Description, target.IdentifierName), target)
+        {
+            _quickFixes = new[]
+            {
+                new RenameDeclarationQuickFix(target.Context, target.QualifiedSelection, target, parserState, wrapperFactory, messageBox),
+            };
+        }
+
+        public override IEnumerable<CodeInspectionQuickFix> QuickFixes { get { return _quickFixes; } }
+    }
+
+    /// <summary>
+    /// A code inspection quickfix that addresses a VBProject bearing the default name.
+    /// </summary>
+    public class RenameDeclarationQuickFix : CodeInspectionQuickFix
+    {
+        private readonly Declaration _target;
+        private readonly RubberduckParserState _parserState;
+        private readonly ICodePaneWrapperFactory _wrapperFactory;
+        private readonly IMessageBox _messageBox;
+
+        public RenameDeclarationQuickFix(ParserRuleContext context, QualifiedSelection selection, Declaration target, RubberduckParserState parserState, ICodePaneWrapperFactory wrapperFactory, IMessageBox messageBox)
+            : base(context, selection, string.Format(RubberduckUI.Rename_DeclarationType, RubberduckUI.ResourceManager.GetString("DeclarationType_" + target.DeclarationType, RubberduckUI.Culture)))
+        {
+            _target = target;
+            _parserState = parserState;
+            _wrapperFactory = wrapperFactory;
+            _messageBox = messageBox;
+        }
+
+        public override void Fix()
+        {
+            var vbe = Selection.QualifiedName.Project.VBE;
+
+            using (var view = new RenameDialog())
+            {
+                var factory = new RenamePresenterFactory(vbe, view, _parserState, _messageBox, _wrapperFactory);
+                var refactoring = new RenameRefactoring(factory, new ActiveCodePaneEditor(vbe, _wrapperFactory), _messageBox);
+                refactoring.Refactor(_target);
+            }
+        }
+
+        public override bool CanFixInModule { get { return false; } }
+        public override bool CanFixInProject { get { return false; } }
+    }
+}

RetailCoder.VBE/Inspections/UseMeaningfulNameInspectionResult.cs

@@ -303,6 +303,8 @@
       <DependentUpon>InspectionsUI.resx</DependentUpon>
     </Compile>
     <Compile Include="Inspections\UntypedFunctionUsageInspectionResult.cs" />
+    <Compile Include="Inspections\UseMeaningfulNameInspection.cs" />
+    <Compile Include="Inspections\UseMeaningfulNameInspectionResult.cs" />
     <Compile Include="Inspections\WriteOnlyPropertyInspection.cs" />
     <Compile Include="Inspections\UntypedFunctionUsageInspection.cs" />
     <Compile Include="Navigation\NavigateAllReferences.cs" />