Localisation and internationalisation (#10)

* Add French, Spanish and German translations

* Clear defaults preferences before running UI tests, and improve preference restoration afterwards

* Make window resizable and have minimum size

* Add undo and redo capability

With thanks to Alex Nicol, Ted Byrne and Andreas Scheriau for reviewing and updating the French, Spanish and German translations!

Co-authored-by: Alexandre Nicol <nicol.alexandre1@gmail.com>

Author: abyrne10

Big Sur Font Smoothing Toggler.xcodeproj/project.xcworkspace/contents.xcworkspacedata

@@ -6,7 +6,7 @@
         <capability name="documents saved in the Xcode 8 format" minToolsVersion="8.0"/>
     </dependencies>
     <objects>
-        <customObject id="-2" userLabel="File's Owner" customClass="MainWindowController" customModule="Big_Sur_Font_Smoothing_Toggler" customModuleProvider="target">
+        <customObject id="-2" userLabel="File's Owner" customClass="MainWindowController" customModule="Font_Smoothing_Adjuster" customModuleProvider="target">
             <connections>
                 <outlet property="disabledFontSmoothingRadioButton" destination="yAH-xX-66R" id="B7B-Yy-ouv"/>
                 <outlet property="heavyFontSmoothingRadioButton" destination="bnW-ud-KsD" id="mBs-QY-5dx"/>
@@ -18,12 +18,12 @@
         <customObject id="-1" userLabel="First Responder" customClass="FirstResponder"/>
         <customObject id="-3" userLabel="Application" customClass="NSObject"/>
         <window title="Font Smoothing Adjuster" allowsToolTipsWhenApplicationIsInactive="NO" autorecalculatesKeyViewLoop="NO" releasedWhenClosed="NO" visibleAtLaunch="NO" animationBehavior="default" titlebarAppearsTransparent="YES" id="F0z-JX-Cv5">
-            <windowStyleMask key="styleMask" titled="YES" closable="YES"/>
+            <windowStyleMask key="styleMask" titled="YES" closable="YES" miniaturizable="YES" resizable="YES"/>
             <windowPositionMask key="initialPositionMask" leftStrut="YES" rightStrut="YES" topStrut="YES" bottomStrut="YES"/>
             <rect key="contentRect" x="196" y="240" width="417" height="203"/>
             <rect key="screenRect" x="0.0" y="0.0" width="1440" height="875"/>
             <view key="contentView" id="se5-gp-TjO">
-                <rect key="frame" x="0.0" y="0.0" width="417" height="203"/>
+                <rect key="frame" x="0.0" y="0.0" width="417" height="204"/>
                 <autoresizingMask key="autoresizingMask" widthSizable="YES" heightSizable="YES"/>
                 <subviews>
                     <stackView distribution="fill" orientation="horizontal" alignment="top" spacing="6" horizontalStackHuggingPriority="249.99998474121094" verticalStackHuggingPriority="249.99998474121094" detachesHiddenViews="YES" translatesAutoresizingMaskIntoConstraints="NO" id="xCM-7O-UeI">
@@ -106,8 +106,12 @@
                     </stackView>
                 </subviews>
                 <constraints>
+                    <constraint firstAttribute="trailing" relation="greaterThanOrEqual" secondItem="xCM-7O-UeI" secondAttribute="trailing" constant="92" id="0Jz-50-Mad"/>
+                    <constraint firstItem="xCM-7O-UeI" firstAttribute="leading" relation="greaterThanOrEqual" secondItem="se5-gp-TjO" secondAttribute="leading" constant="92" id="9kz-Eu-azC"/>
                     <constraint firstItem="xCM-7O-UeI" firstAttribute="centerY" secondItem="se5-gp-TjO" secondAttribute="centerY" id="RAD-Wn-FKq"/>
                     <constraint firstItem="xCM-7O-UeI" firstAttribute="centerX" secondItem="se5-gp-TjO" secondAttribute="centerX" id="hWk-9A-986"/>
+                    <constraint firstItem="xCM-7O-UeI" firstAttribute="top" relation="greaterThanOrEqual" secondItem="se5-gp-TjO" secondAttribute="top" constant="61" id="lqp-IG-hK7"/>
+                    <constraint firstAttribute="bottom" relation="greaterThanOrEqual" secondItem="xCM-7O-UeI" secondAttribute="bottom" constant="61" id="uty-4G-18H"/>
                 </constraints>
             </view>
             <connections>

Big Sur Font Smoothing Toggler/Base.lproj/MainMenu.xib

@@ -15,7 +15,8 @@ class MainWindowController: NSWindowController {
     @IBOutlet weak var mediumFontSmoothingRadioButton: NSButton!
     @IBOutlet weak var heavyFontSmoothingRadioButton: NSButton!
 
-    let fontSmoothingDefaults = FontSmoothingDefaults()
+    private let fontSmoothingDefaults = FontSmoothingDefaults()
+    private typealias FontSmoothingOption = FontSmoothingDefaults.FontSmoothingOptions
 
     override var windowNibName: NSNib.Name? {
         return NSNib.Name.mainWindowController
@@ -27,48 +28,53 @@ class MainWindowController: NSWindowController {
         setRadioButtonsToCurrentDefaultsState()
     }
 
-    func setRadioButtonsToCurrentDefaultsState() {
+    private func setRadioButtonsToCurrentDefaultsState() {
         do {
-            let fontSmoothingState = try fontSmoothingDefaults.getFontSmoothingState()
-            switch fontSmoothingState {
-            case .noFontSmoothing:
-                disabledFontSmoothingRadioButton.state = .on
-            case .lightFontSmoothing:
-                lightFontSmoothingRadioButton.state = .on
-            case .mediumFontSmoothing:
-                mediumFontSmoothingRadioButton.state = .on
-            case .heavyFontSmoothing:
-                heavyFontSmoothingRadioButton.state = .on
-            }
+            let currentFontSmoothingState = try fontSmoothingDefaults.getFontSmoothingState()
+            updateUIWithState(fontSmoothingState: currentFontSmoothingState)
         } catch {
             os_log(.error, "Error getting font smoothing defaults: %s", error.localizedDescription)
             Analytics.trackEvent("Error getting font smoothing defaults: \(error.localizedDescription)")
             presentErrorSheet(error)
         }
-            
+    }
+    
+    private func updateUIWithState(fontSmoothingState: FontSmoothingOption) {
+        switch fontSmoothingState {
+        case .noFontSmoothing:
+            disabledFontSmoothingRadioButton.state = .on
+        case .lightFontSmoothing:
+            lightFontSmoothingRadioButton.state = .on
+        case .mediumFontSmoothing:
+            mediumFontSmoothingRadioButton.state = .on
+        case .heavyFontSmoothing:
+            heavyFontSmoothingRadioButton.state = .on
+        }
     }
 
     @IBAction func toggleFontSmoothing(_ sender: NSButton) {
-        let fontSmoothingOption: FontSmoothingDefaults.FontSmoothingOptions
+        let newFontSmoothingState: FontSmoothingOption
         switch sender {
         case disabledFontSmoothingRadioButton:
-            fontSmoothingOption = .noFontSmoothing
+            newFontSmoothingState = .noFontSmoothing
         case lightFontSmoothingRadioButton:
-            fontSmoothingOption = .lightFontSmoothing
+            newFontSmoothingState = .lightFontSmoothing
         case mediumFontSmoothingRadioButton:
-            fontSmoothingOption = .mediumFontSmoothing
+            newFontSmoothingState = .mediumFontSmoothing
         case heavyFontSmoothingRadioButton:
-            fontSmoothingOption = .heavyFontSmoothing
+            newFontSmoothingState = .heavyFontSmoothing
         default:
             Analytics.trackEvent("Unsupported font smoothing radio button option selected")
             fatalError("Unsupported font smoothing radio button option selected.")
         }
         do {
-            let fontSmoothingState = try fontSmoothingDefaults.getFontSmoothingState()
-            guard fontSmoothingOption != fontSmoothingState else {
+            let currentFontSmoothingState = try fontSmoothingDefaults.getFontSmoothingState()
+            guard newFontSmoothingState != currentFontSmoothingState else {
                 return
             }
-            try fontSmoothingDefaults.setFontSmoothing(option: fontSmoothingOption)
+                       
+            try updateFontSmoothingPreferences(newState: newFontSmoothingState, oldState: currentFontSmoothingState)
+            
             Analytics.trackEvent("Font smoothing preferences updated")
             presentSuccessSheet()
         } catch {
@@ -80,13 +86,31 @@ class MainWindowController: NSWindowController {
         }
     }
 
-    func presentSuccessSheet() {
+    private func updateFontSmoothingPreferences(newState: FontSmoothingOption, oldState: FontSmoothingOption) throws {
+        try fontSmoothingDefaults.setFontSmoothing(option: newState)
+        setRadioButtonsToCurrentDefaultsState()
+        window?.undoManager?.registerUndo(withTarget: self, handler: { target in
+            try? target.undoUpdateFontSmoothingPreferences(oldState: oldState, newState: newState)
+            target.setRadioButtonsToCurrentDefaultsState()
+        })
+    }
+    
+    private func undoUpdateFontSmoothingPreferences(oldState: FontSmoothingOption, newState: FontSmoothingOption) throws {
+        try fontSmoothingDefaults.setFontSmoothing(option: oldState)
+        setRadioButtonsToCurrentDefaultsState()
+        window?.undoManager?.registerUndo(withTarget: self, handler: { target in
+            try? target.updateFontSmoothingPreferences(newState: newState, oldState: oldState)
+            target.setRadioButtonsToCurrentDefaultsState()
+        })
+    }
+    
+    private func presentSuccessSheet() {
         guard let window = self.window else { return }
         let alert = NSAlert()
-        alert.messageText = "Font smoothing preferences successfully updated"
-        alert.informativeText = "Log off or restart your computer for the changes to take effect."
-        alert.addButton(withTitle: "Log out now")
-        alert.addButton(withTitle: "Log out later")
+        alert.messageText = NSLocalizedString("Font smoothing preferences successfully updated", comment: "Title for preferences update success sheet modal")
+        alert.informativeText = NSLocalizedString("Log out or restart your Mac for the changes to take effect.", comment: "Informative text for preferences update success sheet modal")
+        alert.addButton(withTitle: NSLocalizedString("Log out now", comment: "Log out now button text"))
+        alert.addButton(withTitle: NSLocalizedString("Log out later", comment: "Log out later button text"))
         alert.alertStyle = .informational
         alert.beginSheetModal(for: window) { (response) in
             switch response {
@@ -116,11 +140,11 @@ class MainWindowController: NSWindowController {
         }
     }
 
-    func presentErrorSheet(_ error: Error) {
+    private func presentErrorSheet(_ error: Error) {
         guard let window = self.window else { return }
         let alert = NSAlert(error: error)
-        alert.messageText = "The operation couldn't be completed"
-        alert.informativeText = "An unexpected error occurred. Please view the logs in the Console app for details."
+        alert.messageText = NSLocalizedString("The operation couldn't be completed", comment: "Title for error sheet")
+        alert.informativeText = NSLocalizedString("An unexpected error occurred. Please view the logs in the Console app for details.", comment: "Informative text for error sheet")
         alert.alertStyle = .critical
         alert.beginSheetModal(for: window)
     }

Big Sur Font Smoothing Toggler/MainWindowController.xib renamed to Big Sur Font Smoothing Toggler/Base.lproj/MainWindowController.xib

@@ -0,0 +1,90 @@
+
+/* Class = "NSMenuItem"; title = "Font Smoothing Adjuster"; ObjectID = "1Xt-HY-uBw"; */
+"1Xt-HY-uBw.title" = "Font Smoothing Adjuster";
+
+/* Class = "NSMenuItem"; title = "Enter Full Screen"; ObjectID = "4J7-dP-txa"; */
+"4J7-dP-txa.title" = "Vollbildmodus";
+
+/* Class = "NSMenuItem"; title = "Quit Font Smoothing Adjuster"; ObjectID = "4sb-4s-VLi"; */
+"4sb-4s-VLi.title" = "Font Smoothing Adjuster beenden";
+
+/* Class = "NSMenuItem"; title = "Edit"; ObjectID = "5QF-Oa-p0T"; */
+"5QF-Oa-p0T.title" = "Bearbeiten";
+
+/* Class = "NSMenuItem"; title = "About Font Smoothing Adjuster"; ObjectID = "5kV-Vb-QxS"; */
+"5kV-Vb-QxS.title" = "Über Font Smoothing Adjuster";
+
+/* Class = "NSMenuItem"; title = "Redo"; ObjectID = "6dh-zS-Vam"; */
+"6dh-zS-Vam.title" = "Wiederholen";
+
+/* Class = "NSMenu"; title = "Main Menu"; ObjectID = "AYu-sK-qS6"; */
+"AYu-sK-qS6.title" = "Hauptmenü";
+
+/* Class = "NSMenuItem"; title = "Preferences…"; ObjectID = "BOF-NM-1cW"; */
+"BOF-NM-1cW.title" = "Einstellungen…";
+
+/* Class = "NSMenuItem"; title = "Close"; ObjectID = "DVo-aG-piG"; */
+"DVo-aG-piG.title" = "Schließen";
+
+/* Class = "NSMenu"; title = "Help"; ObjectID = "F2S-fz-NVQ"; */
+"F2S-fz-NVQ.title" = "Hilfe";
+
+/* Class = "NSMenuItem"; title = "Font Smoothing Adjuster Help"; ObjectID = "FKE-Sm-Kum"; */
+"FKE-Sm-Kum.title" = "Font Smoothing Adjuster-Hilfe";
+
+/* Class = "NSMenuItem"; title = "View"; ObjectID = "H8h-7b-M4v"; */
+"H8h-7b-M4v.title" = "Darstellung";
+
+/* Class = "NSMenu"; title = "View"; ObjectID = "HyV-fh-RgO"; */
+"HyV-fh-RgO.title" = "Darstellung";
+
+/* Class = "NSMenuItem"; title = "Show All"; ObjectID = "Kd2-mp-pUS"; */
+"Kd2-mp-pUS.title" = "Alle einblenden";
+
+/* Class = "NSMenuItem"; title = "Bring All to Front"; ObjectID = "LE2-aR-0XJ"; */
+"LE2-aR-0XJ.title" = "Alle nach vorne bringen";
+
+/* Class = "NSMenuItem"; title = "Services"; ObjectID = "NMo-om-nkz"; */
+"NMo-om-nkz.title" = "Dienste";
+
+/* Class = "NSMenuItem"; title = "Minimize"; ObjectID = "OY7-WF-poV"; */
+"OY7-WF-poV.title" = "Im Dock ablegen";
+
+/* Class = "NSMenuItem"; title = "Hide Font Smoothing Adjuster"; ObjectID = "Olw-nP-bQN"; */
+"Olw-nP-bQN.title" = "Font Smoothing Adjuster ausblenden";
+
+/* Class = "NSMenuItem"; title = "Check For Updates..."; ObjectID = "Pqk-XC-P99"; */
+"Pqk-XC-P99.title" = "Nach Updates suchen...";
+
+/* Class = "NSMenuItem"; title = "Zoom"; ObjectID = "R4o-n2-Eq4"; */
+"R4o-n2-Eq4.title" = "Zoomen";
+
+/* Class = "NSMenu"; title = "Window"; ObjectID = "Td7-aD-5lo"; */
+"Td7-aD-5lo.title" = "Fenster";
+
+/* Class = "NSMenuItem"; title = "Hide Others"; ObjectID = "Vdr-fp-XzO"; */
+"Vdr-fp-XzO.title" = "Andere ausblenden";
+
+/* Class = "NSMenu"; title = "Edit"; ObjectID = "W48-6f-4Dl"; */
+"W48-6f-4Dl.title" = "Bearbeiten";
+
+/* Class = "NSMenuItem"; title = "Window"; ObjectID = "aUF-d1-5bR"; */
+"aUF-d1-5bR.title" = "Fenster";
+
+/* Class = "NSMenu"; title = "File"; ObjectID = "bib-Uj-vzu"; */
+"bib-Uj-vzu.title" = "Ablage";
+
+/* Class = "NSMenuItem"; title = "File"; ObjectID = "dMs-cI-mzQ"; */
+"dMs-cI-mzQ.title" = "Ablage";
+
+/* Class = "NSMenuItem"; title = "Undo"; ObjectID = "dRJ-4n-Yzg"; */
+"dRJ-4n-Yzg.title" = "Widerrufen";
+
+/* Class = "NSMenu"; title = "Services"; ObjectID = "hz9-B4-Xy5"; */
+"hz9-B4-Xy5.title" = "Dienste";
+
+/* Class = "NSMenu"; title = "Font Smoothing Adjuster"; ObjectID = "uQy-DD-JDr"; */
+"uQy-DD-JDr.title" = "Font Smoothing Adjuster";
+
+/* Class = "NSMenuItem"; title = "Help"; ObjectID = "wpr-3q-Mcd"; */
+"wpr-3q-Mcd.title" = "Hilfe";

Big Sur Font Smoothing Toggler/MainWindowController.swift

@@ -0,0 +1,18 @@
+
+/* Class = "NSTextFieldCell"; title = "Font smoothing:"; ObjectID = "3bW-X9-caa"; */
+"3bW-X9-caa.title" = "Schriftglättung:";
+
+/* Class = "NSWindow"; title = "Font Smoothing Adjuster"; ObjectID = "F0z-JX-Cv5"; */
+"F0z-JX-Cv5.title" = "Font Smoothing Adjuster";
+
+/* Class = "NSButtonCell"; title = "Light"; ObjectID = "Qbv-If-yJ0"; */
+"Qbv-If-yJ0.title" = "Dünn";
+
+/* Class = "NSButtonCell"; title = "Medium (default)"; ObjectID = "Uan-kw-Wxq"; */
+"Uan-kw-Wxq.title" = "Mittel (standard)";
+
+/* Class = "NSButtonCell"; title = "Heavy"; ObjectID = "cd3-89-pg3"; */
+"cd3-89-pg3.title" = "Fett";
+
+/* Class = "NSButtonCell"; title = "Disabled"; ObjectID = "ym3-OR-J9l"; */
+"ym3-OR-J9l.title" = "Deaktiviert";