Merge pull request #29 from dteoh/28-enable-io

Enable preferences import + export

Author: dteoh

devdocs-macos/DocumentationViewController.swift

@@ -18,6 +18,7 @@ class DocumentationViewController: NSViewController {
         case ready
     }
 
+    weak var delegate: DocumentationViewDelegate?
     private var webView: WKWebView!
     private var searchCVC: SearchControlViewController?
 
@@ -140,6 +141,10 @@ class DocumentationViewController: NSViewController {
         }
     }
 
+    func overridePreferencesExport() {
+        webView.evaluateJavaScript("overridePreferencesExport();")
+    }
+
     private func addFeatureScripts(_ controller: WKUserContentController) {
         if let pageObserverScript = readUserScript("page-observer") {
             let pageObserver = WKUserScript(source: pageObserverScript,
@@ -201,6 +206,19 @@ class DocumentationViewController: NSViewController {
     private func handleAppReboot() {
         webView.reload()
     }
+
+    private func handleExportPreferences(_ args: [AnyHashable: Any]) {
+        guard let preferences = args["preferences"] as! String? else {
+            return
+        }
+        delegate?.savePreferencesToFile(preferences)
+    }
+}
+
+protocol DocumentationViewDelegate: class {
+    typealias OpenPanelParameters = WKOpenPanelParameters
+    func selectFileToOpen(_ parameters: OpenPanelParameters, completionHandler: @escaping ([URL]?) -> Void)
+    func savePreferencesToFile(_ preferences: String)
 }
 
 // MARK:- WKUIDelegate
@@ -229,6 +247,13 @@ extension DocumentationViewController: WKUIDelegate {
 
         return nil
     }
+
+    func webView(_ webView: WKWebView,
+                 runOpenPanelWith parameters: WKOpenPanelParameters,
+                 initiatedByFrame frame: WKFrameInfo,
+                 completionHandler: @escaping ([URL]?) -> Void) {
+        delegate?.selectFileToOpen(parameters, completionHandler: completionHandler)
+    }
 }
 
 // MARK:- WKNavigationDelegate
@@ -264,6 +289,11 @@ extension DocumentationViewController: WKScriptMessageHandler {
             handleLocationNotification(args)
         case "appReboot":
             handleAppReboot()
+        case "exportPreferences":
+            guard let args = msg["args"] as? [AnyHashable: Any] else {
+                return
+            }
+            handleExportPreferences(args)
         default:
             return
         }

devdocs-macos/DocumentationWindowController.swift

@@ -14,6 +14,7 @@ class DocumentationWindowController: NSWindowController {
 
     override func awakeFromNib() {
         guard let dvc = documentationViewController else { return }
+        dvc.delegate = self
         dvc.documentURL = documentation.url
     }
 
@@ -56,6 +57,7 @@ class DocumentationWindowController: NSWindowController {
             return
         }
 
+        dvc.overridePreferencesExport()
         dvc.useNativeScrollbars(true)
 
         guard let window = self.window else { return }
@@ -110,3 +112,40 @@ class DocumentationWindowController: NSWindowController {
         )
     }
 }
+
+// MARK:- DocumentationViewDelegate
+extension DocumentationWindowController: DocumentationViewDelegate {
+    func selectFileToOpen(_ parameters: OpenPanelParameters, completionHandler: @escaping ([URL]?) -> Void) {
+        let panel = NSOpenPanel()
+        panel.canChooseFiles = true
+        panel.canChooseDirectories = parameters.allowsDirectories
+        panel.allowsMultipleSelection = parameters.allowsMultipleSelection
+        panel.allowedFileTypes = ["json"]
+        panel.allowsOtherFileTypes = false
+        panel.resolvesAliases = true
+
+        panel.beginSheetModal(for: self.window!) { modalResponse in
+            if modalResponse == NSApplication.ModalResponse.OK, let url = panel.url {
+                completionHandler([url])
+            }
+        }
+    }
+
+    func savePreferencesToFile(_ preferences: String) {
+        let panel = NSSavePanel()
+        panel.nameFieldStringValue = "devdocs-preferences.json"
+        panel.allowedFileTypes = ["json"]
+        panel.allowsOtherFileTypes = false
+        panel.isExtensionHidden = false
+
+        panel.beginSheetModal(for: self.window!) { modalResponse in
+            if modalResponse == NSApplication.ModalResponse.OK, let url = panel.url {
+                do {
+                    try preferences.write(to: url, atomically: true, encoding: .utf8)
+                } catch {
+                    NSApplication.shared.presentError(error)
+                }
+            }
+        }
+    }
+}

devdocs-macos/user-scripts/ui-settings.js

@@ -20,3 +20,17 @@ window.useNativeScrollbars = function (enable) {
     sp.toggleLayout('_native-scrollbars', enable)
   })
 }
+
+window.overridePreferencesExport = function () {
+  requestAnimationFrame(() => {
+    app.document.content.settingsPage.export = () => {
+      const preferences = JSON.stringify(app.settings.export())
+      window.webkit.messageHandlers.vcBus.postMessage({
+        type: 'exportPreferences',
+        args: {
+          preferences
+        }
+      })
+    }
+  })
+}