Merge branch 'rubberduck-vba-next' into CodeExplorer

Author: retailcoder

README.md

@@ -1,4 +1,4 @@
-![Rubberduck](http://i.stack.imgur.com/taIMg.png)
+![Rubberduck](http://i.stack.imgur.com/vmqXM.png)
 
 | Branch     | Build Status |
 |------------|--------------|
@@ -12,37 +12,38 @@
 
 Rubberduck is a COM Add-In for the VBA IDE that makes VBA development even more enjoyable, by extending the Visual Basic Editor (VBE) with menus, toolbars and toolwindows that enable things we didn't even think were possible when we first started this project.
 
-If you're learning VBA, Rubberduck can help you avoid a few common beginner mistakes, and can probably show you a trick or two - even if you're only ever writing *macros*. If you're a more advanced programmer, you will appreciate the richness of [Rubberduck's feature set](https://github.com/rubberduck-vba/Rubberduck/wiki/Features).
+If you're learning VBA, Rubberduck can help you avoid a few common beginner mistakes, and can probably show you a trick or two - even if you're only ever writing *macros*. If you're a more advanced programmer, you will appreciate the richness of [Rubberduck's feature set](https://github.com/retailcoder/Rubberduck/wiki/Features).
 
 [**Follow us on Twitter!**](https://twitter.com/rubberduckvba)
 
-[**Rubberduck Wiki**](https://github.com/rubberduck-vba/Rubberduck/wiki)
+[**Rubberduck Wiki**](https://github.com/retailcoder/Rubberduck/wiki)
 
 ---
 
-#Contributing
+#[Contributing](https://github.com/rubberduck-vba/Rubberduck/wiki/Contributing)
 
 If you're a C# developer looking for a fun project to contribute to, feel free to fork the project and 
-[come meet the devs in Code Review's "VBA" chatroom][chat] - we'll be happy to answer your questions and help you help us take the VBE into the 21st century!
-
-Some issues are tagged with [help-wanted][helpwanted], but that doesn't mean we can't use some help with anything else in the project - if this project interests you, we want to hear from you!
+[come meet the devs in Code Review's "VBA Rubberducking" chatroom][chat] - we'll be happy to answer your questions and help you help us!
 
 We follow a [development branch workflow][branch], so please submit any Pull Requests to the `next` branch.
 
-There is additonal information about [building the project in our wiki][install].
-
-  [chat]:http://chat.stackexchange.com/rooms/14929/vba
+  [chat]:http://chat.stackexchange.com/rooms/14929
   [helpwanted]:https://github.com/rubberduck-vba/Rubberduck/labels/help-wanted
-  [install]:https://github.com/rubberduck-vba/Rubberduck/wiki/Building-&-Installation
   [branch]:https://github.com/rubberduck-vba/Rubberduck/issues/288
 
 ---
 
+#[Installing](https://github.com/rubberduck-vba/Rubberduck/wiki/Installing)
+
+This section was moved to a dedicated wiki page.
+
+---
+
 #License
 
 Rubberduck is a COM add-in for the VBA IDE (VBE).
 
-Copyright (C) 2014-2015 Mathieu Guindon & Christopher McClellan
+Copyright (C) 2014-2016 Mathieu Guindon & Christopher McClellan
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -59,24 +60,6 @@ along with this program.  If not, see http://www.gnu.org/licenses/.
 
 ---
 
-#Installation
-
-Visit our releases page, [download the installer](https://github.com/rubberduck-vba/Rubberduck/releases/latest), and run the Setup.exe.
-
-If you're **upgrading** from version 1.0, you will need to completely uninstall it before installing the newest release. This isn't necessary when upgrading from newer versions. Also, be sure to back up the `rubberduck.config` file in the `\AppData\Roaming\Rubberduck\` directory prior to installation.
-
-##System Requirements
-
-- Windows Vista or more recent (tested on Win7 and Win8.1)
-- .Net Framework 4.5
-- Microsoft Office 97-2003 or higher
-
-Please feel free to test it on other versions and [submit any bugs on our issue tracker](https://github.com/rubberduck-vba/Rubberduck/issues).
-
-**Note:** The 1.2 installer doesn't work for 64 bit versions of office. You can find the [work around here](https://rubberduckvba.wordpress.com/2015/03/11/64-bit-rubberduck-a-work-around-until-release-1-21-soon/).
-
----
-
 #Attributions
 
 ##Software & Libraries
@@ -105,16 +88,6 @@ LibGit2Sharp is the library that has allowed us to integrate Git right into the
 
 Which basically means it's a reimplementation of Git in C. It also [happens to be the technology Microsoft uses for their own Git integration with Visual Studio](http://www.hanselman.com/blog/GitSupportForVisualStudioGitTFSAndVSPutIntoContext.aspx).
 
-###[Smart Indenter](http://www.oaltd.co.uk/Indenter/)
-
-**What is Smart Indenter?**
-
-> *The Smart Indenter is a utility to tidy up VBA code by rebuilding the indentation of each line. Most developers naturally indent code within control structures, such as For...Next, If...End If, etc. Many developers also indent all the code within a procedure, to ease identification of line labels, error handling blocks etc. From that point on, there is much more variety in indenting styles, ranging from how to treat declaration lines to handling end-of-line comments.*
-
-The Rubberduck project was graciously offered the source code for this formidable tool by Stephen Bullen and Rob Bovey. We've translated the VB6 source code to C# and embedded a managed indenting API that Rubberduck calls into, while decoupling the indenter logic from the Windows Registry so we could store indenter options together with the Rubberduck settings, and configure the indenter from Rubberduck's options dialog.
-
-If you're already using Smart Indenter, Rubberduck's options dialog allow importing the settings from the registry. If we did our part well, you can uninstall Smart Indenter after installing Rubberduck 2.0, and still benefit from the smartest indenting tool available for VBA.
-
 ##Icons
 
 We didn't come up with these icons ourselves! Here's who did what:
@@ -133,7 +106,7 @@ Icons in the `./Resources/Microsoft/` directory are licensed under Microsoft's S
 
 > You have a right to Use and Distribute these files. This means that you are free to copy and use these images in documents and projects that you create, but you may not modify them in anyway.
 
-For more information, please see the EULAs in the [./Resources/Microsoft/ directory](https://github.com/rubberduck-vba/Rubberduck/tree/master/RetailCoder.VBE/Resources/Microsoft).
+For more information, please see the EULAs in the [./Resources/Microsoft/ directory](https://github.com/retailcoder/Rubberduck/tree/master/RetailCoder.VBE/Resources/Microsoft).
 
- * [Visual Studio 2013 Image Library EULA](https://github.com/rubberduck-vba/Rubberduck/blob/master/RetailCoder.VBE/Resources/Microsoft/Visual%20Studio%202013%20Image%20Library%20EULA.rtf)
- * [Visual Studio 2012 Image Library EULA](https://github.com/rubberduck-vba/Rubberduck/blob/master/RetailCoder.VBE/Resources/Microsoft/Visual%20Studio%202012%20Image%20Library%20EULA.rtf)
+ * [Visual Studio 2013 Image Library EULA](https://github.com/retailcoder/Rubberduck/blob/master/RetailCoder.VBE/Resources/Microsoft/Visual%20Studio%202013%20Image%20Library%20EULA.rtf)
+ * [Visual Studio 2012 Image Library EULA](https://github.com/retailcoder/Rubberduck/blob/master/RetailCoder.VBE/Resources/Microsoft/Visual%20Studio%202012%20Image%20Library%20EULA.rtf)

RetailCoder.VBE/Inspections/ConvertToProcedureQuickFix.cs

@@ -0,0 +1,53 @@
+using Antlr4.Runtime;
+using Rubberduck.Parsing;
+using Rubberduck.Parsing.Grammar;
+using Rubberduck.UI;
+using Rubberduck.VBEditor;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text.RegularExpressions;
+
+namespace Rubberduck.Inspections
+{
+    public class ConvertToProcedureQuickFix : CodeInspectionQuickFix
+    {
+        private readonly IEnumerable<string> _returnStatements;
+
+        public ConvertToProcedureQuickFix(ParserRuleContext context, QualifiedSelection selection)
+            : this(context, selection, new List<string>())
+        {
+        }
+
+        public ConvertToProcedureQuickFix(ParserRuleContext context, QualifiedSelection selection, IEnumerable<string> returnStatements)
+            : base(context, selection, RubberduckUI.Inspections_ConvertFunctionToProcedure)
+        {
+            _returnStatements = returnStatements;
+        }
+
+        public override void Fix()
+        {
+            var context = (VBAParser.FunctionStmtContext)Context;
+            var visibility = context.visibility() == null ? string.Empty : context.visibility().GetText() + ' ';
+            var name = ' ' + context.ambiguousIdentifier().GetText();
+            var args = context.argList().GetText();
+            var asType = context.asTypeClause() == null ? string.Empty : ' ' + context.asTypeClause().GetText();
+
+            var oldSignature = visibility + Tokens.Function + name + args + asType;
+            var newSignature = visibility + Tokens.Sub + name + args;
+
+            var procedure = Context.GetText();
+            string noReturnStatements = procedure;
+            _returnStatements.ToList().ForEach(returnStatement =>
+                noReturnStatements = Regex.Replace(noReturnStatements, @"[ \t\f]*" + returnStatement + @"[ \t\f]*\r?\n?", ""));
+            var result = noReturnStatements.Replace(oldSignature, newSignature)
+                .Replace(Tokens.End + ' ' + Tokens.Function, Tokens.End + ' ' + Tokens.Sub)
+                .Replace(Tokens.Exit + ' ' + Tokens.Function, Tokens.Exit + ' ' + Tokens.Sub);
+
+            var module = Selection.QualifiedName.Component.CodeModule;
+            var selection = Context.GetSelection();
+
+            module.DeleteLines(selection.StartLine, selection.LineCount);
+            module.InsertLines(selection.StartLine, result);
+        }
+    }
+}

RetailCoder.VBE/Inspections/FunctionReturnValueNotUsedInspection.cs

@@ -0,0 +1,57 @@
+using System.Collections.Generic;
+using System.Linq;
+using Rubberduck.Parsing.Symbols;
+using Rubberduck.Parsing.VBA;
+using Rubberduck.Parsing.Grammar;
+using Antlr4.Runtime;
+using Rubberduck.UI;
+
+namespace Rubberduck.Inspections
+{
+    public sealed class FunctionReturnValueNotUsedInspection : InspectionBase
+    {
+        public FunctionReturnValueNotUsedInspection(RubberduckParserState state)
+            : base(state)
+        {
+            Severity = CodeInspectionSeverity.Warning;
+        }
+
+        public override string Description { get { return InspectionsUI.FunctionReturnValueNotUsedInspection; } }
+        public override CodeInspectionType InspectionType { get { return CodeInspectionType.CodeQualityIssues; } }
+
+        public override IEnumerable<CodeInspectionResultBase> GetInspectionResults()
+        {
+            var functions = UserDeclarations.Where(function => function.DeclarationType == DeclarationType.Function).ToList();
+            var returnValueNotUsedFunctions = functions.Where(function =>
+                    function.References.All(usage =>
+                            IsReturnStatement(function, usage) || IsAddressOfCall(usage) || IsCallWithoutAssignment(usage)));
+
+            var issues = returnValueNotUsedFunctions
+                .Select(function =>
+                        new FunctionReturnValueNotUsedInspectionResult(
+                            this,
+                            function.Context, 
+                            function.QualifiedName,
+                            function.References.Where(usage => IsReturnStatement(function, usage)).Select(usage => usage.Context.Parent.Parent.Parent.GetText())));
+
+            return issues;
+        }
+
+        private bool IsAddressOfCall(IdentifierReference usage)
+        {
+            RuleContext current = usage.Context;
+            while (current != null && !(current is VBAParser.VsAddressOfContext)) current = current.Parent;
+            return current != null;
+        }
+
+        private bool IsReturnStatement(Declaration function, IdentifierReference assignment)
+        {
+            return assignment.ParentScope == function.Scope;
+        }
+
+        private bool IsCallWithoutAssignment(IdentifierReference usage)
+        {
+            return usage.Context.Parent != null && usage.Context.Parent is VBAParser.ICS_B_ProcedureCallContext;
+        }
+    }
+}

RetailCoder.VBE/Inspections/FunctionReturnValueNotUsedInspectionResult.cs

@@ -0,0 +1,28 @@
+using System.Collections.Generic;
+using Antlr4.Runtime;
+using Rubberduck.Parsing.Grammar;
+using Rubberduck.UI;
+using Rubberduck.VBEditor;
+using System.Text.RegularExpressions;
+using System.Linq;
+using System;
+using Rubberduck.Parsing;
+
+namespace Rubberduck.Inspections
+{
+    public class FunctionReturnValueNotUsedInspectionResult : CodeInspectionResultBase
+    {
+        private readonly IEnumerable<CodeInspectionQuickFix> _quickFixes;
+
+        public FunctionReturnValueNotUsedInspectionResult(IInspection inspection, ParserRuleContext context, QualifiedMemberName qualifiedName, IEnumerable<string> returnStatements)
+            : base(inspection, string.Format(inspection.Description, qualifiedName.MemberName), qualifiedName.QualifiedModuleName, context)
+        {
+            _quickFixes = new[]
+            {
+                new ConvertToProcedureQuickFix(context, QualifiedSelection, returnStatements),
+            };
+        }
+
+        public override IEnumerable<CodeInspectionQuickFix> QuickFixes { get { return _quickFixes; } }
+    }
+}

RetailCoder.VBE/Inspections/InspectionsUI.Designer.cs

@@ -371,4 +371,10 @@
   <data name="SelfAssignedDeclarationInspectionName" xml:space="preserve">
     <value>Self-assigned property</value>
   </data>
+  <data name="FunctionReturnValueNotUsedInspectionName" xml:space="preserve">
+    <value>Function return value is never used.</value>
+  </data>
+  <data name="FunctionReturnValueNotUsedInspection" xml:space="preserve">
+    <value>Return value of function '{0}' is never used.</value>
+  </data>
 </root>

RetailCoder.VBE/Inspections/InspectionsUI.resx

@@ -7,11 +7,11 @@
 
 namespace Rubberduck.Inspections
 {
-    public sealed class MoveFieldCloseToUsageInspection : InspectionBase
+    public sealed class MoveFieldCloserToUsageInspection : InspectionBase
     {
         private readonly ICodePaneWrapperFactory _wrapperFactory;
 
-        public MoveFieldCloseToUsageInspection(RubberduckParserState state)
+        public MoveFieldCloserToUsageInspection(RubberduckParserState state)
             : base(state)
         {
             _wrapperFactory = new CodePaneWrapperFactory();
@@ -52,7 +52,7 @@ public override IEnumerable<CodeInspectionResultBase> GetInspectionResults()
                            }.Contains(parentDeclaration.DeclarationType);
                 })
                 .Select(issue =>
-                        new MoveFieldCloseToUsageInspectionResult(this, issue, State, _wrapperFactory, new MessageBox()));
+                        new MoveFieldCloserToUsageInspectionResult(this, issue, State, _wrapperFactory, new MessageBox()));
         }
 
         private Declaration ParentDeclaration(IdentifierReference reference)

RetailCoder.VBE/Inspections/MoveFieldCloserToUsageInspection.cs

@@ -9,11 +9,11 @@
 
 namespace Rubberduck.Inspections
 {
-    public class MoveFieldCloseToUsageInspectionResult : CodeInspectionResultBase
+    public class MoveFieldCloserToUsageInspectionResult : CodeInspectionResultBase
     {
         private readonly IEnumerable<CodeInspectionQuickFix> _quickFixes;
 
-        public MoveFieldCloseToUsageInspectionResult(IInspection inspection, Declaration target, RubberduckParserState parseResult, ICodePaneWrapperFactory wrapperFactory, IMessageBox messageBox)
+        public MoveFieldCloserToUsageInspectionResult(IInspection inspection, Declaration target, RubberduckParserState parseResult, ICodePaneWrapperFactory wrapperFactory, IMessageBox messageBox)
             : base(inspection, string.Format(inspection.Description, target.IdentifierName), target)
         {
             _quickFixes = new[]

RetailCoder.VBE/Inspections/MoveFieldCloserToUsageInspectionResult.cs

@@ -47,7 +47,7 @@ public override void Fix()
             var parameter = lines.Substring(adjustedStartColumn,
                 adjustedEndColumn - adjustedStartColumn)
                 .Replace("_", "")
-                .RemoveExtraSpaces();
+                .RemoveExtraSpacesLeavingIndentation();
 
             var start = startLine.Remove(adjustedStartColumn);
             var end = lines.Remove(0, adjustedEndColumn);

RetailCoder.VBE/Inspections/MultilineParameterInspectionResult.cs

@@ -5,6 +5,7 @@
 using Rubberduck.Parsing.Grammar;
 using Rubberduck.UI;
 using Rubberduck.VBEditor;
+using System.Text.RegularExpressions;
 
 namespace Rubberduck.Inspections
 {
@@ -27,35 +28,4 @@ public NonReturningFunctionInspectionResult(IInspection inspection, string resul
 
         public override IEnumerable<CodeInspectionQuickFix> QuickFixes { get { return _quickFixes; } }
     }
-
-    public class ConvertToProcedureQuickFix : CodeInspectionQuickFix
-    {
-        public ConvertToProcedureQuickFix(ParserRuleContext context, QualifiedSelection selection)
-            : base(context, selection, RubberduckUI.Inspections_ConvertFunctionToProcedure)
-        {
-        }
-
-        public override void Fix()
-        {
-            var context = (VBAParser.FunctionStmtContext) Context;
-            var visibility = context.visibility() == null ? string.Empty : context.visibility().GetText() + ' ';
-            var name = ' ' + context.ambiguousIdentifier().GetText();
-            var args = context.argList().GetText();
-            var asType = context.asTypeClause() == null ? string.Empty : ' ' + context.asTypeClause().GetText();
-
-            var oldSignature = visibility + Tokens.Function + name + args + asType;
-            var newSignature = visibility + Tokens.Sub + name + args;
-
-            var procedure = Context.GetText();
-            var result = procedure.Replace(oldSignature, newSignature)
-                .Replace(Tokens.End + ' ' + Tokens.Function, Tokens.End + ' ' + Tokens.Sub)
-                .Replace(Tokens.Exit + ' ' + Tokens.Function, Tokens.Exit + ' ' + Tokens.Sub);
-
-            var module = Selection.QualifiedName.Component.CodeModule;
-            var selection = Context.GetSelection();
-
-            module.DeleteLines(selection.StartLine, selection.LineCount);
-            module.InsertLines(selection.StartLine, result);
-        }
-    }
 }