Merge branch 'next' of https://github.com/rubberduck-vba/Rubberduck into extractMethodRefactoring_Testing

Author: grleachman

README.md

@@ -8,36 +8,31 @@
 [nextBuildStatus]:https://ci.appveyor.com/api/projects/status/we3pdnkeebo4nlck/branch/next?svg=true
 [masterBuildStatus]:https://ci.appveyor.com/api/projects/status/we3pdnkeebo4nlck/branch/master?svg=true
 
-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.
+[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/rubberduck-vba/rubberduck.svg)](http://isitmaintained.com/project/rubberduck-vba/rubberduck "Average time to resolve an issue") [![Percentage of issues still open](http://isitmaintained.com/badge/open/rubberduck-vba/rubberduck.svg)](http://isitmaintained.com/project/rubberduck-vba/rubberduck "Percentage of issues still open") 
 
-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/retailcoder/Rubberduck/wiki)
+> **[rubberduckvba.com](http://rubberduckvba.com)** [Wiki](https://github.com/retailcoder/Rubberduck/wiki) [Rubberduck News](https://rubberduckvba.wordpress.com/) 
+> contact@rubberduckvba.com  
+> Follow [@rubberduckvba](https://twitter.com/rubberduckvba) on Twitter 
 
 ---
 
-#[Contributing](https://github.com/rubberduck-vba/Rubberduck/wiki/Contributing)
+##What is Rubberduck?
 
-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 Rubberducking" chatroom][chat] - we'll be happy to answer your questions and help you help us!
+It's an add-in for the VBA IDE, the glorious *Visual Basic Editor* (VBE) - which hasn't seen an update in this century, but that's still in use everywhere around the world. Rubberduck wants to give its users access to features you would find in the VBE if it had kept up with the features of Visual Studio and other IDE's in the past, oh, *decade* or so.
 
-We follow a [development branch workflow][branch], so please submit any Pull Requests to the `next` branch.
+Rubberduck wants to help its users write better, cleaner, maintainable code. The many **code inspections** and **refactoring tools** help harmlessly making changes to the code, and **unit testing** helps writing a *safety net* that makes it easy to know exactly what broke when you made that *small little harmless modification*.
 
-  [chat]:http://chat.stackexchange.com/rooms/14929
-  [helpwanted]:https://github.com/rubberduck-vba/Rubberduck/labels/help-wanted
-  [branch]:https://github.com/rubberduck-vba/Rubberduck/issues/288
+Rubberduck wants to bring VBA into the 21st century, and wants to see more open-source VBA repositories on [GitHub](https://github.com/) - VBA code and **source control** don't traditionally exactly work hand in hand; unless you've automated it, exporting each module one by one to your local repository, fetching the remote changes, re-importing every module one by one back into the project, ...is *a little bit* tedious. Rubberduck integrates Git into the IDE, and handles all the file handling behind the scenes - a bit like Visual Studio's *Team Explorer*.
 
 ---
 
-#[Installing](https://github.com/rubberduck-vba/Rubberduck/wiki/Installing)
+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). See the [Installing](https://github.com/rubberduck-vba/Rubberduck/wiki/Installing) wiki page.
 
-This section was moved to a dedicated wiki page.
+If you're a C# developer looking for a fun project to contribute to, see the [Contributing](https://github.com/rubberduck-vba/Rubberduck/wiki/Contributing) wiki page.
 
 ---
 
-#License
+##License
 
 Rubberduck is a COM add-in for the VBA IDE (VBE).
 

RetailCoder.VBE/API/ParserState.cs

@@ -6,6 +6,8 @@
 using Rubberduck.Common;
 using Rubberduck.Parsing.VBA;
 using Rubberduck.UI.Command.MenuItems;
+using Rubberduck.Parsing.Preprocessing;
+using System.Globalization;
 
 namespace Rubberduck.API
 {
@@ -44,15 +46,13 @@ public sealed class ParserState : IParserState, IDisposable
         private const string ProgId = "Rubberduck.ParserState";
 
         private readonly RubberduckParserState _state;
-        private readonly AttributeParser _attributeParser;
-
+        private AttributeParser _attributeParser;
         private RubberduckParser _parser;
 
         public ParserState()
         {
             UiDispatcher.Initialize();
             _state = new RubberduckParserState();
-            _attributeParser = new AttributeParser(new ModuleExporter());
 
             _state.StateChanged += _state_StateChanged;
         }
@@ -63,8 +63,9 @@ public void Initialize(VBE vbe)
             {
                 throw new InvalidOperationException("ParserState is already initialized.");
             }
-
-            _parser = new RubberduckParser(vbe, _state, _attributeParser);
+            Func<IVBAPreprocessor> preprocessorFactory = () => new VBAPreprocessor(double.Parse(vbe.Version, CultureInfo.InvariantCulture));
+            _attributeParser = new AttributeParser(new ModuleExporter(), preprocessorFactory);
+            _parser = new RubberduckParser(vbe, _state, _attributeParser, preprocessorFactory);
         }
 
         /// <summary>

RetailCoder.VBE/App.cs

@@ -4,6 +4,7 @@
 using Rubberduck.Common;
 using Rubberduck.Common.Dispatch;
 using Rubberduck.Parsing;
+using Rubberduck.Parsing.Symbols;
 using Rubberduck.Parsing.VBA;
 using Rubberduck.Settings;
 using Rubberduck.SmartIndenter;
@@ -17,7 +18,7 @@
 using System.Runtime.InteropServices.ComTypes;
 using System.Threading.Tasks;
 using System.Windows.Forms;
-using Rubberduck.Parsing.Symbols;
+using Rubberduck.Common.Hotkeys;
 
 namespace Rubberduck
 {
@@ -132,40 +133,24 @@ private bool ShouldEvaluateCanExecute(Declaration selectedDeclaration, ParserSta
         private void _configService_SettingsChanged(object sender, EventArgs e)
         {
             _config = _configService.LoadConfiguration();
+            _hooks.HookHotkeys();
             // also updates the ShortcutKey text
             _appMenus.Localize();
-            _hooks.HookHotkeys();
             UpdateLoggingLevel();
         }
 
         private void UpdateLoggingLevel()
         {
-            var fileRule = LogManager.Configuration.LoggingRules.Where(rule => rule.Targets.Any(t => t.Name == FILE_TARGET_NAME)).FirstOrDefault();
-            if (fileRule == null)
-            {
-                return;
-            }
-            if (_config.UserSettings.GeneralSettings.DetailedLoggingEnabled)
-            {
-                // "Enable" should have been called "Add" perhaps?
-                fileRule.EnableLoggingForLevel(LogLevel.Trace);
-                fileRule.EnableLoggingForLevel(LogLevel.Debug);
-            }
-            else
-            {
-                fileRule.DisableLoggingForLevel(LogLevel.Trace);
-                fileRule.DisableLoggingForLevel(LogLevel.Debug);
-            }
-            LogManager.ReconfigExistingLoggers();
+            LogLevelHelper.SetMinimumLogLevel(LogLevel.FromOrdinal(_config.UserSettings.GeneralSettings.MinimumLogLevel));
         }
 
         public void Startup()
         {
             CleanReloadConfig();
             _appMenus.Initialize();
+            _hooks.HookHotkeys(); // need to hook hotkeys before we localize menus, to correctly display ShortcutTexts
             _appMenus.Localize();
             Task.Delay(1000).ContinueWith(t => UiDispatcher.Invoke(() => _parser.State.OnParseRequested(this))).ConfigureAwait(false);
-            _hooks.HookHotkeys();
             UpdateLoggingLevel();
         }
 
@@ -191,6 +176,8 @@ async void sink_ProjectRemoved(object sender, DispatcherEventArgs<VBProject> e)
             }
 
             var projectId = e.Item.HelpFile;
+            Debug.Assert(projectId != null);
+
             _componentsEventsSinks.Remove(projectId);
             _referencesEventsSinks.Remove(projectId);
             _parser.State.RemoveProject(e.Item);
@@ -347,7 +334,9 @@ async void sink_ProjectRenamed(object sender, DispatcherRenamedEventArgs<VBProje
             }
 
             _logger.Debug("Project '{0}' (ID {1}) was renamed to '{2}'.", e.OldName, e.Item.HelpFile, e.Item.Name);
-            _parser.State.RemoveProject(e.Item.HelpFile);
+
+            // note: if a bug is discovered with renaming a project, it may just need to be removed and readded.
+
             _parser.State.OnParseRequested(sender);
         }
 

RetailCoder.VBE/Common/ApplicationConstants.cs

@@ -0,0 +1,10 @@
+using System;
+using System.IO;
+
+namespace Rubberduck.Common
+{
+    public static class ApplicationConstants
+    {
+        public static readonly string LOG_FOLDER_PATH = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), "Rubberduck", "Logs");
+    }
+}

RetailCoder.VBE/Common/Hotkeys/Hotkey.cs

@@ -5,6 +5,7 @@
 using System.Windows.Input;
 using Rubberduck.Common.WinAPI;
 using NLog;
+using Rubberduck.UI.Command;
 
 namespace Rubberduck.Common.Hotkeys
 {
@@ -58,6 +59,7 @@ public void Attach()
             }
 
             HookKey(key, shift);
+            SetCommandShortcutText();
         }
 
         public void Detach()
@@ -71,6 +73,7 @@ public void Detach()
             Kernel32.GlobalDeleteAtom(HotkeyInfo.HookId);
 
             IsAttached = false;
+            ClearCommandShortcutText();
         }
 
         private void HookKey(Keys key, uint shift)
@@ -90,9 +93,29 @@ private void HookKey(Keys key, uint shift)
 
             HotkeyInfo = new HotkeyInfo(hookId, Combo);
             IsAttached = true;
+
             _logger.Debug("Hotkey '{0}' hooked successfully to command '{1}'", Key, Command.GetType());  //no translation needed for Debug.Writeline
         }
 
+        private void SetCommandShortcutText()
+        {
+            var command = Command as CommandBase;
+            if (command != null)
+            {
+                command.ShortcutText = HotkeyInfo.ToString();
+            }
+        }
+
+        private void ClearCommandShortcutText()
+        {
+            var command = Command as CommandBase;
+            if (command != null)
+            {
+                command.ShortcutText = string.Empty;
+            }
+        }
+
+
         private static readonly IDictionary<char,uint> Modifiers = new Dictionary<char, uint>
         {
             { '+', (uint)KeyModifier.SHIFT },

RetailCoder.VBE/Common/Hotkeys/HotkeyInfo.cs

@@ -25,17 +25,17 @@ public override string ToString()
             var builder = new StringBuilder();
             if (_keys.HasFlag(Keys.Alt))
             {
-                builder.Append("Alt");
+                builder.Append(Rubberduck.UI.RubberduckUI.GeneralSettings_HotkeyAlt);
                 builder.Append('+');
             }
             if (_keys.HasFlag(Keys.Control))
             {
-                builder.Append("Ctrl");
+                builder.Append(Rubberduck.UI.RubberduckUI.GeneralSettings_HotkeyCtrl);
                 builder.Append('+');
             }
             if (_keys.HasFlag(Keys.Shift))
             {
-                builder.Append("Shift");
+                builder.Append(Rubberduck.UI.RubberduckUI.GeneralSettings_HotkeyShift);
                 builder.Append('+');
             }
             builder.Append(_keys & ~Modifiers);

RetailCoder.VBE/Common/IOperatingSystem.cs

@@ -0,0 +1,7 @@
+namespace Rubberduck.Common
+{
+    public interface IOperatingSystem
+    {
+        void ShowFolder(string folderPath);
+    }
+}

RetailCoder.VBE/Common/LogLevelHelper.cs

@@ -0,0 +1,69 @@
+using NLog;
+using NLog.Config;
+using System;
+using System.Collections.Generic;
+
+namespace Rubberduck.Common
+{
+    public static class LogLevelHelper
+    {
+        private static readonly Lazy<IEnumerable<LogLevel>> _logLevels = new Lazy<IEnumerable<LogLevel>>(GetLogLevels);
+
+        public static IEnumerable<LogLevel> LogLevels
+        {
+            get
+            {
+                return _logLevels.Value;
+            }
+        }
+
+        private static IEnumerable<LogLevel> GetLogLevels()
+        {
+            var logLevels = new List<LogLevel>();
+            logLevels.Add(LogLevel.Off);
+            for (int logLevelOrdinal = 0; logLevelOrdinal <= 5; logLevelOrdinal++)
+            {
+                logLevels.Add(LogLevel.FromOrdinal(logLevelOrdinal));
+            }
+            return logLevels;
+        }
+
+        public static void SetMinimumLogLevel(LogLevel minimumLogLevel)
+        {
+            var loggingRules = LogManager.Configuration.LoggingRules;
+            foreach (var loggingRule in loggingRules)
+            {
+                ClearLogLevels(loggingRule);
+            }
+            if (minimumLogLevel == LogLevel.Off)
+            {
+                LogManager.DisableLogging();
+                LogManager.ReconfigExistingLoggers();
+                return;
+            }
+            LogManager.EnableLogging();
+            foreach (var loggingRule in loggingRules)
+            {
+                foreach (var logLevel in LogLevels)
+                {
+                    if (logLevel != LogLevel.Off && logLevel >= minimumLogLevel)
+                    {
+                        loggingRule.EnableLoggingForLevel(logLevel);
+                    }
+                }
+            }
+            LogManager.ReconfigExistingLoggers();
+        }
+
+        private static void ClearLogLevels(LoggingRule loggingRule)
+        {
+            foreach (var logLevel in LogLevels)
+            {
+                if (logLevel != LogLevel.Off && loggingRule.IsLoggingEnabledForLevel(logLevel))
+                {
+                    loggingRule.DisableLoggingForLevel(logLevel);
+                }
+            }
+        }
+    }
+}

RetailCoder.VBE/Common/RubberduckHooks.cs

@@ -4,6 +4,7 @@
 using System.Diagnostics;
 using System.Linq;
 using System.Runtime.InteropServices;
+using System.Windows.Forms;
 using System.Windows.Input;
 using Microsoft.Vbe.Interop;
 using Rubberduck.Common.Hotkeys;
@@ -106,9 +107,16 @@ private void Mouse_RawMouseInputReceived(object sender, RawMouseEventArgs e)
             }
         }
 
+        // keys that change the current selection.
+        private static readonly HashSet<Keys> NavKeys = new HashSet<Keys>
+        {
+            Keys.Up, Keys.Down, Keys.Left, Keys.Right, Keys.PageDown, Keys.PageUp, Keys.Enter
+        };
+
         private void Keyboard_RawKeyboardInputReceived(object sender, RawKeyEventArgs e)
         {
-            if (e.Message == WM.KEYUP)
+            // note: handling *all* keys causes annoying RTrim of current line, making editing code a PITA.
+            if (e.Message == WM.KEYUP && NavKeys.Contains((Keys)e.VKey))
             {
                 OnMessageReceived(this, HookEventArgs.Empty);
             }

RetailCoder.VBE/Common/WinAPI/RawKeyboard.cs

@@ -10,7 +10,7 @@ public RawKeyboard(IntPtr hwnd, bool captureOnlyInForeground)
             var rid = new RawInputDevice[1];
             rid[0].UsagePage = HidUsagePage.GENERIC;
             rid[0].Usage = HidUsage.Keyboard;
-            rid[0].Flags = (captureOnlyInForeground ? RawInputDeviceFlags.NONE : RawInputDeviceFlags.INPUTSINK) | RawInputDeviceFlags.DEVNOTIFY;
+            rid[0].Flags = (captureOnlyInForeground ? RawInputDeviceFlags.NONE : RawInputDeviceFlags.INPUTSINK);
             rid[0].Target = hwnd;
             if (!User32.RegisterRawInputDevices(rid, (uint)rid.Length, (uint)Marshal.SizeOf(rid[0])))
             {