Merge pull request #2652 from Flow-Launcher/code-cleanup/Flow.Launcher.Plugin.BrowserBookmark

Code cleanup: Flow.Launcher.Plugin.BrowserBookmark

Author: VictoriousRaptor

.github/actions/spelling/allow.txt

@@ -3,3 +3,6 @@ https
 ssh
 ubuntu
 runcount
+Firefox
+Português
+Português (Brasil)

.github/actions/spelling/expect.txt

@@ -74,6 +74,7 @@ WCA_ACCENT_POLICY
 HGlobal
 dopusrt
 firefox
+Firefox
 msedge
 svgc
 ime

Plugins/Flow.Launcher.Plugin.BrowserBookmark/ChromeBookmarkLoader.cs

@@ -3,23 +3,22 @@
 using System.Collections.Generic;
 using System.IO;
 
-namespace Flow.Launcher.Plugin.BrowserBookmark
+namespace Flow.Launcher.Plugin.BrowserBookmark;
+
+public class ChromeBookmarkLoader : ChromiumBookmarkLoader
 {
-    public class ChromeBookmarkLoader : ChromiumBookmarkLoader
+    public override List<Bookmark> GetBookmarks()
     {
-        public override List<Bookmark> GetBookmarks()
-        {
-            return LoadChromeBookmarks();
-        }
+        return LoadChromeBookmarks();
+    }
 
-        private List<Bookmark> LoadChromeBookmarks()
-        {
-            var bookmarks = new List<Bookmark>();
-            var platformPath = Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData);
-            bookmarks.AddRange(LoadBookmarks(Path.Combine(platformPath, @"Google\Chrome\User Data"), "Google Chrome"));
-            bookmarks.AddRange(LoadBookmarks(Path.Combine(platformPath, @"Google\Chrome SxS\User Data"), "Google Chrome Canary"));
-            bookmarks.AddRange(LoadBookmarks(Path.Combine(platformPath, @"Chromium\User Data"), "Chromium"));
-            return bookmarks;
-        }
+    private List<Bookmark> LoadChromeBookmarks()
+    {
+        var bookmarks = new List<Bookmark>();
+        var platformPath = Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData);
+        bookmarks.AddRange(LoadBookmarks(Path.Combine(platformPath, @"Google\Chrome\User Data"), "Google Chrome"));
+        bookmarks.AddRange(LoadBookmarks(Path.Combine(platformPath, @"Google\Chrome SxS\User Data"), "Google Chrome Canary"));
+        bookmarks.AddRange(LoadBookmarks(Path.Combine(platformPath, @"Chromium\User Data"), "Chromium"));
+        return bookmarks;
     }
-}
+}

Plugins/Flow.Launcher.Plugin.BrowserBookmark/ChromiumBookmarkLoader.cs

@@ -4,92 +4,91 @@
 using System.Text.Json;
 using Flow.Launcher.Infrastructure.Logger;
 
-namespace Flow.Launcher.Plugin.BrowserBookmark
+namespace Flow.Launcher.Plugin.BrowserBookmark;
+
+public abstract class ChromiumBookmarkLoader : IBookmarkLoader
 {
-    public abstract class ChromiumBookmarkLoader : IBookmarkLoader
+    public abstract List<Bookmark> GetBookmarks();
+
+    protected List<Bookmark> LoadBookmarks(string browserDataPath, string name)
     {
-        public abstract List<Bookmark> GetBookmarks();
+        var bookmarks = new List<Bookmark>();
+        if (!Directory.Exists(browserDataPath)) return bookmarks;
+        var paths = Directory.GetDirectories(browserDataPath);
 
-        protected List<Bookmark> LoadBookmarks(string browserDataPath, string name)
+        foreach (var profile in paths)
         {
-            var bookmarks = new List<Bookmark>();
-            if (!Directory.Exists(browserDataPath)) return bookmarks;
-            var paths = Directory.GetDirectories(browserDataPath);
-
-            foreach (var profile in paths)
-            {
-                var bookmarkPath = Path.Combine(profile, "Bookmarks");
-                if (!File.Exists(bookmarkPath))
-                    continue;
-
-                Main.RegisterBookmarkFile(bookmarkPath);
+            var bookmarkPath = Path.Combine(profile, "Bookmarks");
+            if (!File.Exists(bookmarkPath))
+                continue;
 
-                var source = name + (Path.GetFileName(profile) == "Default" ? "" : $" ({Path.GetFileName(profile)})");
-                bookmarks.AddRange(LoadBookmarksFromFile(bookmarkPath, source));
-            }
+            Main.RegisterBookmarkFile(bookmarkPath);
 
-            return bookmarks;
+            var source = name + (Path.GetFileName(profile) == "Default" ? "" : $" ({Path.GetFileName(profile)})");
+            bookmarks.AddRange(LoadBookmarksFromFile(bookmarkPath, source));
         }
 
-        protected List<Bookmark> LoadBookmarksFromFile(string path, string source)
-        {
-            var bookmarks = new List<Bookmark>();
+        return bookmarks;
+    }
 
-            if (!File.Exists(path))
-                return bookmarks;
+    protected List<Bookmark> LoadBookmarksFromFile(string path, string source)
+    {
+        var bookmarks = new List<Bookmark>();
 
-            using var jsonDocument = JsonDocument.Parse(File.ReadAllText(path));
-            if (!jsonDocument.RootElement.TryGetProperty("roots", out var rootElement))
-                return bookmarks;
-            EnumerateRoot(rootElement, bookmarks, source);
+        if (!File.Exists(path))
             return bookmarks;
-        }
 
-        private void EnumerateRoot(JsonElement rootElement, ICollection<Bookmark> bookmarks, string source)
+        using var jsonDocument = JsonDocument.Parse(File.ReadAllText(path));
+        if (!jsonDocument.RootElement.TryGetProperty("roots", out var rootElement))
+            return bookmarks;
+        EnumerateRoot(rootElement, bookmarks, source);
+        return bookmarks;
+    }
+
+    private void EnumerateRoot(JsonElement rootElement, ICollection<Bookmark> bookmarks, string source)
+    {
+        foreach (var folder in rootElement.EnumerateObject())
         {
-            foreach (var folder in rootElement.EnumerateObject())
-            {
-                if (folder.Value.ValueKind != JsonValueKind.Object)
-                    continue;
+            if (folder.Value.ValueKind != JsonValueKind.Object)
+                continue;
 
-                // Fix for Opera. It stores bookmarks slightly different than chrome. See PR and bug report for this change for details.
-                // If various exceptions start to build up here consider splitting this Loader into multiple separate ones.
-                if (folder.Name == "custom_root") 
-                    EnumerateRoot(folder.Value, bookmarks, source);
-                else
-                    EnumerateFolderBookmark(folder.Value, bookmarks, source);
-            }
+            // Fix for Opera. It stores bookmarks slightly different than chrome. See PR and bug report for this change for details.
+            // If various exceptions start to build up here consider splitting this Loader into multiple separate ones.
+            if (folder.Name == "custom_root")
+                EnumerateRoot(folder.Value, bookmarks, source);
+            else
+                EnumerateFolderBookmark(folder.Value, bookmarks, source);
         }
+    }
 
-        private void EnumerateFolderBookmark(JsonElement folderElement, ICollection<Bookmark> bookmarks,
-            string source)
+    private void EnumerateFolderBookmark(JsonElement folderElement, ICollection<Bookmark> bookmarks,
+        string source)
+    {
+        if (!folderElement.TryGetProperty("children", out var childrenElement))
+            return;
+        foreach (var subElement in childrenElement.EnumerateArray())
         {
-            if (!folderElement.TryGetProperty("children", out var childrenElement))
-                return;
-            foreach (var subElement in childrenElement.EnumerateArray())
+            if (subElement.TryGetProperty("type", out var type))
             {
-                if (subElement.TryGetProperty("type", out var type))
-                {
-                    switch (type.GetString())
-                    {
-                        case "folder":
-                        case "workspace": // Edge Workspace
-                            EnumerateFolderBookmark(subElement, bookmarks, source);
-                            break;
-                        default:
-                            bookmarks.Add(new Bookmark(
-                                subElement.GetProperty("name").GetString(),
-                                subElement.GetProperty("url").GetString(),
-                                source));
-                            break;
-                    }
-                }
-                else
+                switch (type.GetString())
                 {
-                    Log.Error(
-                        $"ChromiumBookmarkLoader: EnumerateFolderBookmark: type property not found for {subElement.GetString()}");
+                    case "folder":
+                    case "workspace": // Edge Workspace
+                        EnumerateFolderBookmark(subElement, bookmarks, source);
+                        break;
+                    default:
+                        bookmarks.Add(new Bookmark(
+                            subElement.GetProperty("name").GetString(),
+                            subElement.GetProperty("url").GetString(),
+                            source));
+                        break;
                 }
             }
+            else
+            {
+                Log.Error(
+                    $"ChromiumBookmarkLoader: EnumerateFolderBookmark: type property not found for {subElement.GetString()}");
+            }
         }
     }
 }

Plugins/Flow.Launcher.Plugin.BrowserBookmark/Commands/BookmarkLoader.cs

@@ -4,56 +4,55 @@
 using Flow.Launcher.Plugin.BrowserBookmark.Models;
 using Flow.Launcher.Plugin.SharedModels;
 
-namespace Flow.Launcher.Plugin.BrowserBookmark.Commands
+namespace Flow.Launcher.Plugin.BrowserBookmark.Commands;
+
+internal static class BookmarkLoader
 {
-    internal static class BookmarkLoader
+    internal static MatchResult MatchProgram(Bookmark bookmark, string queryString)
     {
-        internal static MatchResult MatchProgram(Bookmark bookmark, string queryString)
-        {
-            var match = StringMatcher.FuzzySearch(queryString, bookmark.Name);
-            if (match.IsSearchPrecisionScoreMet())
-                return match;
+        var match = StringMatcher.FuzzySearch(queryString, bookmark.Name);
+        if (match.IsSearchPrecisionScoreMet())
+            return match;
 
-            return StringMatcher.FuzzySearch(queryString, bookmark.Url);
-        }
+        return StringMatcher.FuzzySearch(queryString, bookmark.Url);
+    }
 
-        internal static List<Bookmark> LoadAllBookmarks(Settings setting)
-        {
-            var allBookmarks = new List<Bookmark>();
+    internal static List<Bookmark> LoadAllBookmarks(Settings setting)
+    {
+        var allBookmarks = new List<Bookmark>();
 
-            if (setting.LoadChromeBookmark)
-            {
-                // Add Chrome bookmarks
-                var chromeBookmarks = new ChromeBookmarkLoader();
-                allBookmarks.AddRange(chromeBookmarks.GetBookmarks());
-            }
+        if (setting.LoadChromeBookmark)
+        {
+            // Add Chrome bookmarks
+            var chromeBookmarks = new ChromeBookmarkLoader();
+            allBookmarks.AddRange(chromeBookmarks.GetBookmarks());
+        }
 
-            if (setting.LoadFirefoxBookmark)
-            {
-                // Add Firefox bookmarks
-                var mozBookmarks = new FirefoxBookmarkLoader();
-                allBookmarks.AddRange(mozBookmarks.GetBookmarks());
-            }
+        if (setting.LoadFirefoxBookmark)
+        {
+            // Add Firefox bookmarks
+            var mozBookmarks = new FirefoxBookmarkLoader();
+            allBookmarks.AddRange(mozBookmarks.GetBookmarks());
+        }
 
-            if (setting.LoadEdgeBookmark)
-            {
-                // Add Edge (Chromium) bookmarks
-                var edgeBookmarks = new EdgeBookmarkLoader();
-                allBookmarks.AddRange(edgeBookmarks.GetBookmarks());
-            }
+        if (setting.LoadEdgeBookmark)
+        {
+            // Add Edge (Chromium) bookmarks
+            var edgeBookmarks = new EdgeBookmarkLoader();
+            allBookmarks.AddRange(edgeBookmarks.GetBookmarks());
+        }
 
-            foreach (var browser in setting.CustomChromiumBrowsers)
+        foreach (var browser in setting.CustomChromiumBrowsers)
+        {
+            IBookmarkLoader loader = browser.BrowserType switch
             {
-                IBookmarkLoader loader = browser.BrowserType switch
-                {
-                    BrowserType.Chromium => new CustomChromiumBookmarkLoader(browser),
-                    BrowserType.Firefox => new CustomFirefoxBookmarkLoader(browser),
-                    _ => new CustomChromiumBookmarkLoader(browser),
-                };
-                allBookmarks.AddRange(loader.GetBookmarks());
-            }
-
-            return allBookmarks.Distinct().ToList();
+                BrowserType.Chromium => new CustomChromiumBookmarkLoader(browser),
+                BrowserType.Firefox => new CustomFirefoxBookmarkLoader(browser),
+                _ => new CustomChromiumBookmarkLoader(browser),
+            };
+            allBookmarks.AddRange(loader.GetBookmarks());
         }
+
+        return allBookmarks.Distinct().ToList();
     }
 }

Plugins/Flow.Launcher.Plugin.BrowserBookmark/CustomChromiumBookmarkLoader.cs

@@ -1,19 +1,18 @@
 using Flow.Launcher.Plugin.BrowserBookmark.Models;
 using System.Collections.Generic;
 
-namespace Flow.Launcher.Plugin.BrowserBookmark
+namespace Flow.Launcher.Plugin.BrowserBookmark;
+
+public class CustomChromiumBookmarkLoader : ChromiumBookmarkLoader
 {
-    public class CustomChromiumBookmarkLoader : ChromiumBookmarkLoader
+    public CustomChromiumBookmarkLoader(CustomBrowser browser)
     {
-        public CustomChromiumBookmarkLoader(CustomBrowser browser)
-        {
-            BrowserName = browser.Name;
-            BrowserDataPath = browser.DataDirectoryPath;
-        }
-        public string BrowserDataPath { get; init; }
-        public string BookmarkFilePath { get; init; }
-        public string BrowserName { get; init; }
-
-        public override List<Bookmark> GetBookmarks() => BrowserDataPath != null ? LoadBookmarks(BrowserDataPath, BrowserName) : LoadBookmarksFromFile(BookmarkFilePath, BrowserName);
+        BrowserName = browser.Name;
+        BrowserDataPath = browser.DataDirectoryPath;
     }
-}
+    public string BrowserDataPath { get; init; }
+    public string BookmarkFilePath { get; init; }
+    public string BrowserName { get; init; }
+
+    public override List<Bookmark> GetBookmarks() => BrowserDataPath != null ? LoadBookmarks(BrowserDataPath, BrowserName) : LoadBookmarksFromFile(BookmarkFilePath, BrowserName);
+}

Plugins/Flow.Launcher.Plugin.BrowserBookmark/CustomFirefoxBookmarkLoader.cs

@@ -2,26 +2,25 @@
 using System.IO;
 using Flow.Launcher.Plugin.BrowserBookmark.Models;
 
-namespace Flow.Launcher.Plugin.BrowserBookmark
+namespace Flow.Launcher.Plugin.BrowserBookmark;
+
+public class CustomFirefoxBookmarkLoader : FirefoxBookmarkLoaderBase
 {
-    public class CustomFirefoxBookmarkLoader : FirefoxBookmarkLoaderBase
+    public CustomFirefoxBookmarkLoader(CustomBrowser browser)
     {
-        public CustomFirefoxBookmarkLoader(CustomBrowser browser)
-        {
-            BrowserName = browser.Name;
-            BrowserDataPath = browser.DataDirectoryPath;
-        }
-        
-        /// <summary>
-        /// Path to places.sqlite
-        /// </summary>
-        public string BrowserDataPath { get; init; }
-        
-        public string BrowserName { get; init; }
+        BrowserName = browser.Name;
+        BrowserDataPath = browser.DataDirectoryPath;
+    }
+
+    /// <summary>
+    /// Path to places.sqlite
+    /// </summary>
+    public string BrowserDataPath { get; init; }
 
-        public override List<Bookmark> GetBookmarks()
-        {
-            return GetBookmarksFromPath(Path.Combine(BrowserDataPath, "places.sqlite"));
-        }
+    public string BrowserName { get; init; }
+
+    public override List<Bookmark> GetBookmarks()
+    {
+        return GetBookmarksFromPath(Path.Combine(BrowserDataPath, "places.sqlite"));
     }
 }