Merge pull request #681 from Flow-Launcher/QueryTermsRefactor

Fixes Typo TermSeparator & remove the actionkeyword in Terms

Author: jjw24

Flow.Launcher.Core/Plugin/QueryBuilder.cs

@@ -10,35 +10,31 @@ 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);
+            var terms = text.Split(Query.TermSeparator, StringSplitOptions.RemoveEmptyEntries);
             if (terms.Length == 0)
             { // nothing was typed
                 return null;
             }
 
-            var rawQuery = string.Join(Query.TermSeperater, terms);
+            var rawQuery = string.Join(Query.TermSeparator, terms);
             string actionKeyword, search;
             string possibleActionKeyword = terms[0];
-            List<string> actionParameters;
+            string[] searchTerms;
+
             if (nonGlobalPlugins.TryGetValue(possibleActionKeyword, out var pluginPair) && !pluginPair.Metadata.Disabled)
             { // use non global plugin for query
                 actionKeyword = possibleActionKeyword;
-                actionParameters = terms.Skip(1).ToList();
-                search = actionParameters.Count > 0 ? rawQuery.Substring(actionKeyword.Length + 1) : string.Empty;
+                search = terms.Length > 1 ? rawQuery[(actionKeyword.Length + 1)..] : string.Empty;
+                searchTerms = terms[1..];
             }
             else
             { // non action keyword
                 actionKeyword = string.Empty;
                 search = rawQuery;
+                searchTerms = terms;
             }
 
-            var query = new Query
-            {
-                Terms = terms,
-                RawQuery = rawQuery,
-                ActionKeyword = actionKeyword,
-                Search = search
-            };
+            var query = new Query(rawQuery, search,terms, searchTerms, actionKeyword);
 
             return query;
         }

Flow.Launcher.Plugin/Query.cs

@@ -1,4 +1,5 @@
-using System;
+using JetBrains.Annotations;
+using System;
 using System.Collections.Generic;
 using System.Linq;
 
@@ -11,65 +12,74 @@ public Query() { }
         /// <summary>
         /// to allow unit tests for plug ins
         /// </summary>
-        public Query(string rawQuery, string search, string[] terms, string actionKeyword = "")
+        public Query(string rawQuery, string search, string[] terms, string[] searchTerms, string actionKeyword = "")
         {
             Search = search;
             RawQuery = rawQuery;
             Terms = terms;
+            SearchTerms = searchTerms;
             ActionKeyword = actionKeyword;
         }
 
         /// <summary>
         /// Raw query, this includes action keyword if it has
         /// We didn't recommend use this property directly. You should always use Search property.
         /// </summary>
-        public string RawQuery { get; internal set; }
+        public string RawQuery { get; internal init; }
 
         /// <summary>
         /// Search part of a query.
         /// This will not include action keyword if exclusive plugin gets it, otherwise it should be same as RawQuery.
         /// Since we allow user to switch a exclusive plugin to generic plugin, 
         /// so this property will always give you the "real" query part of the query
         /// </summary>
-        public string Search { get; internal set; }
+        public string Search { get; internal init; }
 
         /// <summary>
-        /// The raw query splited into a string array.
+        /// The search string split into a string array.
         /// </summary>
-        public string[] Terms { get; set; }
+        public string[] SearchTerms { get; init; }
+
+        /// <summary>
+        /// The raw query split into a string array
+        /// </summary>
+        [Obsolete("It may or may not include action keyword, which can be confusing. Use SearchTerms instead")]
+        public string[] Terms { get; init; }
 
         /// <summary>
         /// Query can be splited into multiple terms by whitespace
         /// </summary>
-        public const string TermSeperater = " ";
+        public const string TermSeparator = " ";
+
+        [Obsolete("Typo")]
+        public const string TermSeperater = TermSeparator;
         /// <summary>
         /// User can set multiple action keywords seperated by ';'
         /// </summary>
-        public const string ActionKeywordSeperater = ";";
+        public const string ActionKeywordSeparator = ";";
+
+        [Obsolete("Typo")]
+        public const string ActionKeywordSeperater = ActionKeywordSeparator;
+
 
         /// <summary>
         /// '*' is used for System Plugin
         /// </summary>
         public const string GlobalPluginWildcardSign = "*";
 
-        public string ActionKeyword { get; set; }
+        public string ActionKeyword { get; init; }
 
         /// <summary>
         /// Return first search split by space if it has
         /// </summary>
         public string FirstSearch => SplitSearch(0);
 
+        private string _secondToEndSearch;
+
         /// <summary>
         /// strings from second search (including) to last search
         /// </summary>
-        public string SecondToEndSearch
-        {
-            get
-            {
-                var index = string.IsNullOrEmpty(ActionKeyword) ? 1 : 2;
-                return string.Join(TermSeperater, Terms.Skip(index).ToArray());
-            }
-        }
+        public string SecondToEndSearch => SearchTerms.Length > 1 ? (_secondToEndSearch ??= string.Join(' ', SearchTerms[1..])) : "";
 
         /// <summary>
         /// Return second search split by space if it has
@@ -83,16 +93,9 @@ public string SecondToEndSearch
 
         private string SplitSearch(int index)
         {
-            try
-            {
-                return string.IsNullOrEmpty(ActionKeyword) ? Terms[index] : Terms[index + 1];
-            }
-            catch (IndexOutOfRangeException)
-            {
-                return string.Empty;
-            }
+            return index < SearchTerms.Length ? SearchTerms[index] : string.Empty;
         }
 
         public override string ToString() => RawQuery;
     }
-}
+}

Flow.Launcher/ActionKeywords.xaml.cs

@@ -30,7 +30,7 @@ public ActionKeywords(string pluginId, Settings settings, PluginViewModel plugin
 
         private void ActionKeyword_OnLoaded(object sender, RoutedEventArgs e)
         {
-            tbOldActionKeyword.Text = string.Join(Query.ActionKeywordSeperater, plugin.Metadata.ActionKeywords.ToArray());
+            tbOldActionKeyword.Text = string.Join(Query.ActionKeywordSeparator, plugin.Metadata.ActionKeywords.ToArray());
             tbAction.Focus();
         }
 

Flow.Launcher/ViewModel/PluginViewModel.cs

@@ -22,7 +22,7 @@ public bool PluginState
         public Visibility ActionKeywordsVisibility => PluginPair.Metadata.ActionKeywords.Count == 1 ? Visibility.Visible : Visibility.Collapsed;
         public string InitilizaTime => PluginPair.Metadata.InitTime.ToString() + "ms";
         public string QueryTime => PluginPair.Metadata.AvgQueryTime + "ms";
-        public string ActionKeywordsText => string.Join(Query.ActionKeywordSeperater, PluginPair.Metadata.ActionKeywords);
+        public string ActionKeywordsText => string.Join(Query.ActionKeywordSeparator, PluginPair.Metadata.ActionKeywords);
         public int Priority => PluginPair.Metadata.Priority;
 
         public void ChangeActionKeyword(string newActionKeyword, string oldActionKeyword)

Plugins/Flow.Launcher.Plugin.PluginIndicator/Main.cs

@@ -12,11 +12,11 @@ public List<Result> Query(Query query)
         {
             // if query contains more than one word, eg. github tips 
             // user has decided to type something else rather than wanting to see the available action keywords
-            if (query.Terms.Length > 1)
+            if (query.SearchTerms.Length > 1)
                 return new List<Result>();
 
             var results = from keyword in PluginManager.NonGlobalPlugins.Keys
-                          where keyword.StartsWith(query.Terms[0])
+                          where keyword.StartsWith(query.SearchTerms[0])
                           let metadata = PluginManager.NonGlobalPlugins[keyword].Metadata
                           where !metadata.Disabled
                           select new Result
@@ -27,7 +27,7 @@ where keyword.StartsWith(query.Terms[0])
                               IcoPath = metadata.IcoPath,
                               Action = c =>
                               {
-                                  context.API.ChangeQuery($"{keyword}{Plugin.Query.TermSeperater}");
+                                  context.API.ChangeQuery($"{keyword}{Plugin.Query.TermSeparator}");
                                   return false;
                               }
                           };

Plugins/Flow.Launcher.Plugin.ProcessKiller/Main.cs

@@ -23,9 +23,7 @@ public void Init(PluginInitContext context)
 
         public List<Result> Query(Query query)
         {
-            var termToSearch = query.Terms.Length <= 1
-                ? null
-                : string.Join(Plugin.Query.TermSeperater, query.Terms.Skip(1)).ToLower();
+            var termToSearch = query.Search;
 
             var processlist = processHelper.GetMatchingProcesses(termToSearch);
 

Plugins/Flow.Launcher.Plugin.Shell/Main.cs

@@ -325,7 +325,7 @@ bool API_GlobalKeyboardEvent(int keyevent, int vkcode, SpecialKeyState state)
 
         private void OnWinRPressed()
         {
-            context.API.ChangeQuery($"{context.CurrentPluginMetadata.ActionKeywords[0]}{Plugin.Query.TermSeperater}");
+            context.API.ChangeQuery($"{context.CurrentPluginMetadata.ActionKeywords[0]}{Plugin.Query.TermSeparator}");
 
             // show the main window and set focus to the query box
             Window mainWindow = Application.Current.MainWindow;