Add Sparkle for auto update

melonamin · melonamin · commit 3bcaa50e5632 · 2025-07-14T15:09:21.000-04:00
Signed-off-by: Alex Mazanov &lt;alexandr.mazanov@gmail.com&gt;
diff --git a/Packages/TRexCore/Sources/TRexCore/Preferences.swift b/Packages/TRexCore/Sources/TRexCore/Preferences.swift
@@ -25,6 +25,7 @@ public class Preferences: ObservableObject {
         case TesseractEnabled
         case TesseractLanguages
         case TesseractPath
+        case IncludeBetaUpdates
     }
 
     public enum MenuBarIcon: String, CaseIterable {
@@ -228,6 +229,12 @@ public class Preferences: ObservableObject {
             Preferences.setValue(value: tesseractPath, key: .TesseractPath)
         }
     }
+    
+    @Published public var includeBetaUpdates: Bool {
+        didSet {
+            Preferences.setValue(value: includeBetaUpdates, key: .IncludeBetaUpdates)
+        }
+    }
 
     init() {
         needsOnboarding = Preferences.getValue(key: .NeedsOnboarding) as? Bool ?? true
@@ -257,6 +264,7 @@ public class Preferences: ObservableObject {
         tesseractEnabled = Preferences.getValue(key: .TesseractEnabled) as? Bool ?? false
         tesseractLanguages = Preferences.getValue(key: .TesseractLanguages) as? [String] ?? ["eng"]
         tesseractPath = Preferences.getValue(key: .TesseractPath) as? String ?? ""
+        includeBetaUpdates = Preferences.getValue(key: .IncludeBetaUpdates) as? Bool ?? false
     }
 
     static func removeAll() {
diff --git a/TRex.xcodeproj/project.pbxproj b/TRex.xcodeproj/project.pbxproj
@@ -35,6 +35,7 @@
 		FA1EE63D2E1F2F5F009D86D8 /* QLImage.swift in Sources */ = {isa = PBXBuildFile; fileRef = FA1EE63C2E1F2F5F009D86D8 /* QLImage.swift */; };
 		FA1EE6412E1F32C0009D86D8 /* step2.gif in Resources */ = {isa = PBXBuildFile; fileRef = FA1EE63E2E1F32C0009D86D8 /* step2.gif */; };
 		FA1EE6422E1F32C0009D86D8 /* step3.gif in Resources */ = {isa = PBXBuildFile; fileRef = FA1EE63F2E1F32C0009D86D8 /* step3.gif */; };
+		FA1EE6452E254E54009D86D8 /* Sparkle in Frameworks */ = {isa = PBXBuildFile; productRef = FA1EE6442E254E54009D86D8 /* Sparkle */; };
 		FA2B835B25DEBF8200B23F25 /* Credits.rtf in Resources */ = {isa = PBXBuildFile; fileRef = FA2B835A25DEBF8200B23F25 /* Credits.rtf */; };
 		FA3AEAA82C9B85710096CCA5 /* TRexCore in Frameworks */ = {isa = PBXBuildFile; productRef = FA3AEAA72C9B85710096CCA5 /* TRexCore */; };
 		FA3AEAAA2C9B85790096CCA5 /* TRexCore in Frameworks */ = {isa = PBXBuildFile; productRef = FA3AEAA92C9B85790096CCA5 /* TRexCore */; };
@@ -172,6 +173,7 @@
 			buildActionMask = 2147483647;
 			files = (
 				FA3AEAA82C9B85710096CCA5 /* TRexCore in Frameworks */,
+				FA1EE6452E254E54009D86D8 /* Sparkle in Frameworks */,
 				FA5F875F25DD637300B1AF77 /* KeyboardShortcuts in Frameworks */,
 				FA6648712E18469400EF497A /* TesseractSwift in Frameworks */,
 			);
@@ -457,6 +459,7 @@
 				FA5F875E25DD637300B1AF77 /* KeyboardShortcuts */,
 				FA3AEAA72C9B85710096CCA5 /* TRexCore */,
 				FA6648702E18469400EF497A /* TesseractSwift */,
+				FA1EE6442E254E54009D86D8 /* Sparkle */,
 			);
 			productName = TRex;
 			productReference = FA5F872E25DC243200B1AF77 /* TRex.app */;
@@ -493,6 +496,7 @@
 			packageReferences = (
 				FA5F875D25DD637300B1AF77 /* XCRemoteSwiftPackageReference "KeyboardShortcuts" */,
 				FA58E3DF27AE31DF0034837F /* XCRemoteSwiftPackageReference "swift-argument-parser" */,
+				FA1EE6432E254E54009D86D8 /* XCRemoteSwiftPackageReference "Sparkle" */,
 			);
 			productRefGroup = FA5F872F25DC243200B1AF77 /* Products */;
 			projectDirPath = "";
@@ -835,7 +839,9 @@
 					"@executable_path/../Frameworks",
 				);
 				MACOSX_DEPLOYMENT_TARGET = 13.5;
+				MAC_APP_STORE = NO;
 				MARKETING_VERSION = 1.9.0;
+				MTL_ENABLE_DEBUG_INFO = "";
 				OTHER_LDFLAGS = "-lc++";
 				PRODUCT_BUNDLE_IDENTIFIER = com.ameba.TRex;
 				PRODUCT_NAME = "$(TARGET_NAME)";
@@ -870,6 +876,7 @@
 					"@executable_path/../Frameworks",
 				);
 				MACOSX_DEPLOYMENT_TARGET = 13.5;
+				MAC_APP_STORE = NO;
 				MARKETING_VERSION = 1.9.0;
 				OTHER_LDFLAGS = "-lc++";
 				PRODUCT_BUNDLE_IDENTIFIER = com.ameba.TRex;
@@ -911,6 +918,14 @@
 /* End XCConfigurationList section */
 
 /* Begin XCRemoteSwiftPackageReference section */
+		FA1EE6432E254E54009D86D8 /* XCRemoteSwiftPackageReference "Sparkle" */ = {
+			isa = XCRemoteSwiftPackageReference;
+			repositoryURL = "https://github.com/sparkle-project/Sparkle";
+			requirement = {
+				kind = upToNextMajorVersion;
+				minimumVersion = 2.7.1;
+			};
+		};
 		FA58E3DF27AE31DF0034837F /* XCRemoteSwiftPackageReference "swift-argument-parser" */ = {
 			isa = XCRemoteSwiftPackageReference;
 			repositoryURL = "https://github.com/apple/swift-argument-parser.git";
@@ -930,6 +945,11 @@
 /* End XCRemoteSwiftPackageReference section */
 
 /* Begin XCSwiftPackageProductDependency section */
+		FA1EE6442E254E54009D86D8 /* Sparkle */ = {
+			isa = XCSwiftPackageProductDependency;
+			package = FA1EE6432E254E54009D86D8 /* XCRemoteSwiftPackageReference "Sparkle" */;
+			productName = Sparkle;
+		};
 		FA3AEAA72C9B85710096CCA5 /* TRexCore */ = {
 			isa = XCSwiftPackageProductDependency;
 			productName = TRexCore;
diff --git a/TRex/App/UI/Onboarding/Views/Components/BrandBackground.swift b/TRex/App/UI/Onboarding/Views/Components/BrandBackground.swift
@@ -0,0 +1,12 @@
+import SwiftUI
+
+struct BrandBackground: View {
+    var body: some View {
+        LinearGradient(
+            gradient: Gradient(colors: Color.brandBackgroundGradientColors),
+            startPoint: .topLeading,
+            endPoint: .bottomTrailing
+        )
+        .ignoresSafeArea()
+    }
+}
diff --git a/TRex/App/UI/Settings/AboutSettingsView.swift b/TRex/App/UI/Settings/AboutSettingsView.swift
@@ -1,6 +1,9 @@
 import SwiftUI
+import TRexCore
 
 struct AboutSettingsView: View {
+    @EnvironmentObject var preferences: Preferences
+    
     var body: some View {
         VStack {
             HStack {
diff --git a/TRex/App/UI/Settings/GeneralSettingsView.swift b/TRex/App/UI/Settings/GeneralSettingsView.swift
@@ -64,10 +64,37 @@ struct GeneralSettingsView: View {
                         .foregroundColor(.secondary)
                 }
             }
+            
+            #if !MAC_APP_STORE
+            Spacer()
+            Divider()
+            Section(header: Text("Updates")) {
+                HStack {
+                    Button("Check for Updates", action: {
+                        checkForUpdates()
+                    })
+                    Spacer()
+                    Toggle("Include beta updates", isOn: $preferences.includeBetaUpdates)
+                        .toggleStyle(.checkbox)
+                }
+            }
+            #endif
         }
         .padding(20)
+        #if MAC_APP_STORE
         .frame(width: 410, height: preferences.showMenuBarIcon ? (preferences.tesseractEnabled ? 220 : 280) : (preferences.tesseractEnabled ? 140 : 200))
+        #else
+        .frame(width: 410, height: preferences.showMenuBarIcon ? (preferences.tesseractEnabled ? 280 : 340) : (preferences.tesseractEnabled ? 200 : 260))
+        #endif
+    }
+    
+    #if !MAC_APP_STORE
+    func checkForUpdates() {
+        if let appDelegate = NSApp.delegate as? AppDelegate {
+            appDelegate.softwareUpdater.checkForUpdates()
+        }
     }
+    #endif
 }
 
 struct MenuBarIconView: View {
diff --git a/TRex/App/UI/Settings/TesseractSettingsView.swift b/TRex/App/UI/Settings/TesseractSettingsView.swift
@@ -50,7 +50,7 @@ struct TesseractSettingsView: View {
                         .toggleStyle(SwitchToggleStyle())
                 }
                 
-                Text("Enable additional OCR languages beyond Apple Vision's built-in support")
+                Text("Additional OCR languages beyond Apple Vision's built-in support")
                     .font(.system(size: 12))
                     .foregroundColor(.secondary)
                     .fixedSize(horizontal: false, vertical: true)
@@ -149,7 +149,7 @@ struct TesseractSettingsView: View {
                 .padding(.bottom, 16)
             }
         }
-        .frame(width: 550, height: preferences.tesseractEnabled ? 430 : 140)
+        .frame(width: 410, height: preferences.tesseractEnabled ? 430 : 140)
         .onAppear {
             refreshLanguageList()
             selectedLanguages = Set(preferences.tesseractLanguages)
@@ -321,4 +321,4 @@ struct LanguageRow: View {
                 .fill(Color.clear)
         )
     }
-}
+}
diff --git a/TRex/AppDelegate.swift b/TRex/AppDelegate.swift
@@ -2,6 +2,9 @@ import Combine
 import KeyboardShortcuts
 import SwiftUI
 import TRexCore
+#if !MAC_APP_STORE
+import Sparkle
+#endif
 
 // TesseractWrapper bridge removed - now using TesseractSwift directly in TRexCore
 
@@ -12,6 +15,9 @@ class AppDelegate: NSObject, NSApplicationDelegate {
     var cancellable: Set<AnyCancellable> = []
     var onboardingWindowController: NSWindowController?
     let bundleID = Bundle.main.bundleIdentifier!
+    #if !MAC_APP_STORE
+    var softwareUpdater: SPUUpdater!
+    #endif
     
     func applicationDidFinishLaunching(_: Notification) {
         NSApp.servicesProvider = self
@@ -20,6 +26,10 @@ class AppDelegate: NSObject, NSApplicationDelegate {
             NSWorkspace.shared.open(URL(string: "trex://showPreferences")!)
             NSApp.terminate(nil)
         }
+        
+        #if !MAC_APP_STORE
+        setupSparkle()
+        #endif
 
         preferences.$showMenuBarIcon.sink(receiveValue: { [weak self] show in
             guard let self = self else { return }
@@ -143,3 +153,26 @@ extension AppDelegate {
         }
     }
 }
+
+#if !MAC_APP_STORE
+extension AppDelegate: SPUUpdaterDelegate, SPUStandardUserDriverDelegate {
+    func setupSparkle() {
+        let hostBundle = Bundle.main
+        let updateDriver = SPUStandardUserDriver(hostBundle: hostBundle, delegate: self)
+        softwareUpdater = SPUUpdater(hostBundle: hostBundle, applicationBundle: hostBundle, userDriver: updateDriver, delegate: self)
+        
+        do {
+            try softwareUpdater.start()
+        } catch {
+            print("Failed to start software updater with error: \(error)")
+        }
+    }
+    
+    func feedURLString(for updater: SPUUpdater) -> String? {
+        if preferences.includeBetaUpdates {
+            return "https://ameba.github.io/TRex/appcast_beta.xml"
+        }
+        return "https://ameba.github.io/TRex/appcast.xml"
+    }
+}
+#endif
diff --git a/TRex/Resources/Info.plist b/TRex/Resources/Info.plist
@@ -33,6 +33,10 @@
 	<string>$(CURRENT_PROJECT_VERSION)</string>
 	<key>LSApplicationCategoryType</key>
 	<string>public.app-category.utilities</string>
+	<key>SUPublicEDKey</key>
+	<string>c1vnuzkyrl2y6GNfNk/N91wC0S2w0PYxfbBonj+QrT0=</string>
+	<key>SUEnableAutomaticChecks</key>
+	<true/>
 	<key>LSMinimumSystemVersion</key>
 	<string>$(MACOSX_DEPLOYMENT_TARGET)</string>
 	<key>LSUIElement</key>
diff --git a/docs/release-notes/v1.9.0-BETA-4.md b/docs/release-notes/v1.9.0-BETA-4.md
@@ -0,0 +1,10 @@
+# TRex v1.9.0-BETA-4 Release Notes
+
+## ✨ What's New
+
+### Auto-Update Support
+- **Sparkle Integration**: TRex now supports automatic updates! The app will check for new versions on launch and notify you when updates are available.
+- **Update Preferences**: Control update behavior in Settings → General:
+  - Check for updates manually with the "Check for Updates" button
+  - Opt into beta updates with the "Include beta updates" checkbox
+- **Menu Bar Access**: Quickly check for updates from the TRex menu bar icon

Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,7 @@ public class Preferences: ObservableObject {`
`25`	`25`	`case TesseractEnabled`
`26`	`26`	`case TesseractLanguages`
`27`	`27`	`case TesseractPath`
	`28`	`+ case IncludeBetaUpdates`
`28`	`29`	`}`
`29`	`30`
`30`	`31`	`public enum MenuBarIcon: String, CaseIterable {`
`@@ -228,6 +229,12 @@ public class Preferences: ObservableObject {`
`228`	`229`	`Preferences.setValue(value: tesseractPath, key: .TesseractPath)`
`229`	`230`	`}`
`230`	`231`	`}`
	`232`	`+`
	`233`	`+ @Published public var includeBetaUpdates: Bool {`
	`234`	`+ didSet {`
	`235`	`+ Preferences.setValue(value: includeBetaUpdates, key: .IncludeBetaUpdates)`
	`236`	`+ }`
	`237`	`+ }`
`231`	`238`
`232`	`239`	`init() {`
`233`	`240`	`needsOnboarding = Preferences.getValue(key: .NeedsOnboarding) as? Bool ?? true`
`@@ -257,6 +264,7 @@ public class Preferences: ObservableObject {`
`257`	`264`	`tesseractEnabled = Preferences.getValue(key: .TesseractEnabled) as? Bool ?? false`
`258`	`265`	`tesseractLanguages = Preferences.getValue(key: .TesseractLanguages) as? [String] ?? ["eng"]`
`259`	`266`	`tesseractPath = Preferences.getValue(key: .TesseractPath) as? String ?? ""`
	`267`	`+ includeBetaUpdates = Preferences.getValue(key: .IncludeBetaUpdates) as? Bool ?? false`
`260`	`268`	`}`
`261`	`269`
`262`	`270`	`static func removeAll() {`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ struct TesseractSettingsView: View {`
`50`	`50`	`.toggleStyle(SwitchToggleStyle())`
`51`	`51`	`}`
`52`	`52`
`53`		`- Text("Enable additional OCR languages beyond Apple Vision's built-in support")`
	`53`	`+ Text("Additional OCR languages beyond Apple Vision's built-in support")`
`54`	`54`	`.font(.system(size: 12))`
`55`	`55`	`.foregroundColor(.secondary)`
`56`	`56`	`.fixedSize(horizontal: false, vertical: true)`
`@@ -149,7 +149,7 @@ struct TesseractSettingsView: View {`
`149`	`149`	`.padding(.bottom, 16)`
`150`	`150`	`}`
`151`	`151`	`}`
`152`		`- .frame(width: 550, height: preferences.tesseractEnabled ? 430 : 140)`
	`152`	`+ .frame(width: 410, height: preferences.tesseractEnabled ? 430 : 140)`
`153`	`153`	`.onAppear {`
`154`	`154`	`refreshLanguageList()`
`155`	`155`	`selectedLanguages = Set(preferences.tesseractLanguages)`
`@@ -321,4 +321,4 @@ struct LanguageRow: View {`
`321`	`321`	`.fill(Color.clear)`
`322`	`322`	`)`
`323`	`323`	`}`
`324`		`-}`
	`324`	`+}`