Merge pull request #145 from jjw24/pluginInitFail

plugin init fail continue - create query builder and re-enable tests.

Author: jjw24

Plugins/Wox.Plugin.PluginIndicator/Main.cs

@@ -13,8 +13,7 @@ public List<Result> Query(Query query)
             var results = from keyword in PluginManager.NonGlobalPlugins.Keys
                           where keyword.StartsWith(query.Terms[0])
                           let metadata = PluginManager.NonGlobalPlugins[keyword].Metadata
-                          let disabled = PluginManager.Settings.Plugins[metadata.ID].Disabled
-                          where !disabled
+                          where !metadata.Disabled
                           select new Result
                           {
                               Title = keyword,

Wox.Core/Plugin/PluginManager.cs

@@ -120,7 +120,7 @@ public static void InitializePlugins(IPublicAPI api)
                 catch (Exception e)
                 {
                     Log.Exception(nameof(PluginManager), $"Fail to Init plugin: {pair.Metadata.Name}", e);
-                    pair.Metadata.Disabled = true; // TODO: not sure this really disable it later on
+                    pair.Metadata.Disabled = true; 
                     failedPlugins.Enqueue(pair);
                 }
             });
@@ -149,35 +149,6 @@ public static void InstallPlugin(string path)
             PluginInstaller.Install(path);
         }
 
-        public static Query QueryInit(string text) //todo is that possible to move it into type Query?
-        {
-            // replace multiple white spaces with one white space
-            var terms = text.Split(new[] { Query.TermSeperater }, StringSplitOptions.RemoveEmptyEntries);
-            var rawQuery = string.Join(Query.TermSeperater, terms);
-            var actionKeyword = string.Empty;
-            var search = rawQuery;
-            var actionParameters = terms.ToList();
-            if (terms.Length == 0) return null;
-            if (NonGlobalPlugins.ContainsKey(terms[0]) &&
-                !Settings.Plugins[NonGlobalPlugins[terms[0]].Metadata.ID].Disabled)
-            {
-                actionKeyword = terms[0];
-                actionParameters = terms.Skip(1).ToList();
-                search = string.Join(Query.TermSeperater, actionParameters.ToArray());
-            }
-            var query = new Query
-            {
-                Terms = terms,
-                RawQuery = rawQuery,
-                ActionKeyword = actionKeyword,
-                Search = search,
-                // Obsolete value initialisation
-                ActionName = actionKeyword,
-                ActionParameters = actionParameters
-            };
-            return query;
-        }
-
         public static List<PluginPair> ValidPluginsForQuery(Query query)
         {
             if (NonGlobalPlugins.ContainsKey(query.ActionKeyword))

Wox.Core/Plugin/QueryBuilder.cs

@@ -0,0 +1,50 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using Wox.Plugin;
+
+namespace Wox.Core.Plugin
+{
+    public static class QueryBuilder
+    {
+        public static Query Build(string text, Dictionary<string, PluginPair> nonGlobalPlugins)
+        {
+            // replace multiple white spaces with one white space
+            var terms = text.Split(new[] { Query.TermSeperater }, StringSplitOptions.RemoveEmptyEntries);
+            if (terms.Length == 0)
+            { // nothing was typed
+                return null;
+            }
+
+            var rawQuery = string.Join(Query.TermSeperater, terms);
+            string actionKeyword, search;
+            string possibleActionKeyword = terms[0];
+            List<string> actionParameters;
+            if (nonGlobalPlugins.TryGetValue(possibleActionKeyword, out var pluginPair) && !pluginPair.Metadata.Disabled)
+            { // use non global plugin for query
+                actionKeyword = possibleActionKeyword;
+                actionParameters = terms.Skip(1).ToList();
+                search = rawQuery.Substring(actionKeyword.Length + 1);
+            }
+            else
+            { // non action keyword
+                actionKeyword = string.Empty;
+                actionParameters = terms.ToList();
+                search = rawQuery;
+            }
+
+            var query = new Query
+            {
+                Terms = terms,
+                RawQuery = rawQuery,
+                ActionKeyword = actionKeyword,
+                Search = search,
+                // Obsolete value initialisation
+                ActionName = actionKeyword,
+                ActionParameters = actionParameters
+            };
+
+            return query;
+        }
+    }
+}

Wox.Core/Wox.Core.csproj

@@ -53,6 +53,7 @@
     </Compile>
     <Compile Include="Plugin\ExecutablePlugin.cs" />
     <Compile Include="Plugin\PluginsLoader.cs" />
+    <Compile Include="Plugin\QueryBuilder.cs" />
     <Compile Include="Updater.cs" />
     <Compile Include="Resource\AvailableLanguages.cs" />
     <Compile Include="Resource\Internationalization.cs" />

Wox.Infrastructure/UserSettings/PluginSettings.cs

@@ -28,7 +28,7 @@ public void UpdatePluginSettings(List<PluginMetadata> metadatas)
                     {
                         ID = metadata.ID,
                         Name = metadata.Name,
-                        ActionKeywords = metadata.ActionKeywords,
+                        ActionKeywords = metadata.ActionKeywords, 
                         Disabled = metadata.Disabled
                     };
                 }
@@ -39,7 +39,11 @@ public class Plugin
     {
         public string ID { get; set; }
         public string Name { get; set; }
-        public List<string> ActionKeywords { get; set; }
+        public List<string> ActionKeywords { get; set; } // a reference of the action keywords from plugin manager
+
+        /// <summary>
+        /// Used only to save the state of the plugin in settings
+        /// </summary>
         public bool Disabled { get; set; }
     }
 }

Wox.Test/QueryBuilderTest.cs

@@ -0,0 +1,51 @@
+using System.Collections.Generic;
+using NUnit.Framework;
+using Wox.Core.Plugin;
+using Wox.Plugin;
+
+namespace Wox.Test
+{
+    public class QueryBuilderTest
+    {
+        [Test]
+        public void ExclusivePluginQueryTest()
+        {
+            var nonGlobalPlugins = new Dictionary<string, PluginPair>
+            {
+                {">", new PluginPair {Metadata = new PluginMetadata {ActionKeywords = new List<string> {">"}}}}
+            };
+
+            Query q = QueryBuilder.Build(">   file.txt    file2 file3", nonGlobalPlugins);
+
+            Assert.AreEqual("file.txt file2 file3", q.Search);
+            Assert.AreEqual(">", q.ActionKeyword);
+        }
+
+        [Test]
+        public void ExclusivePluginQueryIgnoreDisabledTest()
+        {
+            var nonGlobalPlugins = new Dictionary<string, PluginPair>
+            {
+                {">", new PluginPair {Metadata = new PluginMetadata {ActionKeywords = new List<string> {">"}, Disabled = true}}}
+            };
+
+            Query q = QueryBuilder.Build(">   file.txt    file2 file3", nonGlobalPlugins);
+
+            Assert.AreEqual("> file.txt file2 file3", q.Search);
+        }
+
+        [Test]
+        public void GenericPluginQueryTest()
+        {
+            Query q = QueryBuilder.Build("file.txt file2 file3", new Dictionary<string, PluginPair>());
+
+            Assert.AreEqual("file.txt file2 file3", q.Search);
+            Assert.AreEqual("", q.ActionKeyword);
+
+            Assert.AreEqual("file.txt", q.FirstSearch);
+            Assert.AreEqual("file2", q.SecondSearch);
+            Assert.AreEqual("file3", q.ThirdSearch);
+            Assert.AreEqual("file2 file3", q.SecondToEndSearch);
+        }
+    }
+}

Wox.Test/QueryTest.cs

@@ -45,7 +45,7 @@
     </Compile>
     <Compile Include="FuzzyMatcherTest.cs" />
     <Compile Include="Plugins\PluginInitTest.cs" />
-    <Compile Include="QueryTest.cs" />
+    <Compile Include="QueryBuilderTest.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="UrlPluginTest.cs" />
   </ItemGroup>

Wox.Test/Wox.Test.csproj

@@ -215,7 +215,8 @@ private void OnAddCustomeHotkeyClick(object sender, RoutedEventArgs e)
         private void OnPluginToggled(object sender, RoutedEventArgs e)
         {
             var id = _viewModel.SelectedPlugin.PluginPair.Metadata.ID;
-            _settings.PluginSettings.Plugins[id].Disabled = _viewModel.SelectedPlugin.PluginPair.Metadata.Disabled;
+            // used to sync the current status from the plugin manager into the setting to keep consistency after save
+            _settings.PluginSettings.Plugins[id].Disabled = _viewModel.SelectedPlugin.PluginPair.Metadata.Disabled; 
         }
 
         private void OnPluginActionKeywordsClick(object sender, MouseButtonEventArgs e)

Wox/SettingWindow.xaml.cs

@@ -377,7 +377,7 @@ private void QueryResults()
 
                 ProgressBarVisibility = Visibility.Hidden;
                 _isQueryRunning = true;
-                var query = PluginManager.QueryInit(QueryText.Trim());
+                var query = QueryBuilder.Build(QueryText.Trim(), PluginManager.NonGlobalPlugins);
                 if (query != null)
                 {
                     // handle the exclusiveness of plugin using action keyword
@@ -401,8 +401,7 @@ private void QueryResults()
                         {
                             Parallel.ForEach(plugins, parallelOptions, plugin =>
                             {
-                                var config = _settings.PluginSettings.Plugins[plugin.Metadata.ID];
-                                if (!config.Disabled)
+                                if (!plugin.Metadata.Disabled)
                                 {
                                     var results = PluginManager.QueryForPlugin(plugin, query);
                                     UpdateResultView(results, plugin.Metadata, query);