Fix building SwiftUI previews on macOS. (#389)

Zandor300 · honghaoz · web-flow · commit 6c01329de425 · 2024-02-06T21:07:10.000+01:00
* fixes macOS build

* Use description instead of safeDescription inside description.

* Version bump (v5.2.2)

---------

Co-authored-by: Honghao Zhang &lt;m@honghao.dev&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,22 @@
 # Changelog
 
+## Version 5.2.2
+
+Releasedate: 2024-02-06
+
+```ruby
+pod 'DeviceKit', '~> 5.2'
+```
+
+### Bugfixes
+
+- Fix building SwiftUI previews on macOS properly. ([#389](https://github.com/devicekit/DeviceKit/pull/389))
+
+### Contributors
+
+Thanks to all the contributers of this release!
+- [honghaoz](https://github.com/honghaoz)
+
 ## Version 5.2.1
 
 Releasedate: 2024-01-17
diff --git a/DeviceKit.podspec b/DeviceKit.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name         = 'DeviceKit'
-  s.version      = '5.2.1'
+  s.version      = '5.2.2'
   s.summary      = 'DeviceKit is a µ-framework that provides a value-type replacement of UIDevice.'
 
   s.description                = <<-DESC
diff --git a/DeviceKit.xcodeproj/project.pbxproj b/DeviceKit.xcodeproj/project.pbxproj
@@ -384,7 +384,7 @@
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MARKETING_VERSION = 5.2.1;
+				MARKETING_VERSION = 5.2.2;
 				MTL_ENABLE_DEBUG_INFO = YES;
 				PRODUCT_BUNDLE_IDENTIFIER = me.dennisweissmann.DeviceKit;
 				PRODUCT_NAME = "$(TARGET_NAME)";
@@ -441,7 +441,7 @@
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MARKETING_VERSION = 5.2.1;
+				MARKETING_VERSION = 5.2.2;
 				MTL_ENABLE_DEBUG_INFO = NO;
 				PRODUCT_BUNDLE_IDENTIFIER = me.dennisweissmann.DeviceKit;
 				PRODUCT_NAME = "$(TARGET_NAME)";
diff --git a/README.md b/README.md
@@ -18,7 +18,7 @@
 
 `DeviceKit` is a value-type replacement of [`UIDevice`](https://developer.apple.com/library/ios/documentation/UIKit/Reference/UIDevice_Class/).
 
-## Current version 5.2.1
+## Current version 5.2.2
 See our detailed [changelog](CHANGELOG.md) for the latest features, improvements and bug fixes.
 
 ## Features
diff --git a/Source/Device.generated.swift b/Source/Device.generated.swift
@@ -628,6 +628,8 @@ public enum Device {
       case "i386", "x86_64", "arm64": return simulator(mapToDevice(identifier: ProcessInfo().environment["SIMULATOR_MODEL_IDENTIFIER"] ?? "watchOS"))
       default: return unknown(identifier)
       }
+    #else
+      return unknown(identifier)
     #endif
   }
 
@@ -879,6 +881,8 @@ public enum Device {
       }
     #elseif os(tvOS)
       return (width: -1, height: -1)
+    #else
+      return (width: -1, height: -1)
     #endif
   }
 
@@ -1158,6 +1162,8 @@ public enum Device {
       return allTVs
     #elseif os(watchOS)
       return allWatches
+    #else
+      return []
     #endif
   }
 
@@ -1219,8 +1225,10 @@ public enum Device {
     guard isCurrent else { return nil }
     #if os(watchOS)
     return WKInterfaceDevice.current().name
-    #else
+    #elseif canImport(UIKit)
     return UIDevice.current.name
+    #else
+    return nil
     #endif
   }
 
@@ -1235,8 +1243,10 @@ public enum Device {
     } else {
       return UIDevice.current.systemName
     }
-    #else
+    #elseif canImport(UIKit)
     return UIDevice.current.systemName
+    #else
+    return nil
     #endif
   }
 
@@ -1245,8 +1255,10 @@ public enum Device {
     guard isCurrent else { return nil }
     #if os(watchOS)
     return WKInterfaceDevice.current().systemVersion
-    #else
+    #elseif canImport(UIKit)
     return UIDevice.current.systemVersion
+    #else
+    return nil
     #endif
   }
 
@@ -1255,8 +1267,10 @@ public enum Device {
     guard isCurrent else { return nil }
     #if os(watchOS)
     return WKInterfaceDevice.current().model
-    #else
+    #elseif canImport(UIKit)
     return UIDevice.current.model
+    #else
+    return nil
     #endif
   }
 
@@ -1265,8 +1279,10 @@ public enum Device {
     guard isCurrent else { return nil }
     #if os(watchOS)
     return WKInterfaceDevice.current().localizedModel
-    #else
+    #elseif canImport(UIKit)
     return UIDevice.current.localizedModel
+    #else
+    return nil
     #endif
   }
 
@@ -1385,6 +1401,8 @@ public enum Device {
     }
     #elseif os(tvOS)
     return nil
+    #else
+    return nil
     #endif
   }
 
@@ -1536,6 +1554,11 @@ extension Device: CustomStringConvertible {
       case .simulator(let model): return "Simulator (\(model.description))"
       case .unknown(let identifier): return identifier
       }
+    #else
+      switch self {
+      case .simulator(let model): return "Simulator (\(model.description))"
+      case .unknown(let identifier): return identifier
+      }
     #endif
   }
 
@@ -1664,6 +1687,11 @@ extension Device: CustomStringConvertible {
       case .simulator(let model): return "Simulator (\(model.safeDescription))"
       case .unknown(let identifier): return identifier
       }
+    #else
+      switch self {
+      case .simulator(let model): return "Simulator (\(model.safeDescription))"
+      case .unknown(let identifier): return identifier
+      }
     #endif
   }
 
@@ -2298,6 +2326,8 @@ extension Device {
       case .simulator(let model): return model.cpu
       case .unknown: return .unknown
     }
+  #else
+    return .unknown
   #endif
   }
 }
@@ -2347,6 +2377,8 @@ extension Device.CPU: CustomStringConvertible {
       case .s9: return "S9"
       case .unknown: return "unknown"
     }
+  #else
+    return "unknown"
   #endif
   }
 }
diff --git a/Source/Device.swift.gyb b/Source/Device.swift.gyb
@@ -421,6 +421,8 @@ public enum Device {
       case "i386", "x86_64", "arm64": return simulator(mapToDevice(identifier: ProcessInfo().environment["SIMULATOR_MODEL_IDENTIFIER"] ?? "watchOS"))
       default: return unknown(identifier)
       }
+    #else
+      return unknown(identifier)
     #endif
   }
 
@@ -482,6 +484,8 @@ public enum Device {
       }
     #elseif os(tvOS)
       return (width: -1, height: -1)
+    #else
+      return (width: -1, height: -1)
     #endif
   }
 
@@ -761,6 +765,8 @@ public enum Device {
       return allTVs
     #elseif os(watchOS)
       return allWatches
+    #else
+      return []
     #endif
   }
 
@@ -822,8 +828,10 @@ public enum Device {
     guard isCurrent else { return nil }
     #if os(watchOS)
     return WKInterfaceDevice.current().name
-    #else
+    #elseif canImport(UIKit)
     return UIDevice.current.name
+    #else
+    return nil
     #endif
   }
 
@@ -838,8 +846,10 @@ public enum Device {
     } else {
       return UIDevice.current.systemName
     }
-    #else
+    #elseif canImport(UIKit)
     return UIDevice.current.systemName
+    #else
+    return nil
     #endif
   }
 
@@ -848,8 +858,10 @@ public enum Device {
     guard isCurrent else { return nil }
     #if os(watchOS)
     return WKInterfaceDevice.current().systemVersion
-    #else
+    #elseif canImport(UIKit)
     return UIDevice.current.systemVersion
+    #else
+    return nil
     #endif
   }
 
@@ -858,8 +870,10 @@ public enum Device {
     guard isCurrent else { return nil }
     #if os(watchOS)
     return WKInterfaceDevice.current().model
-    #else
+    #elseif canImport(UIKit)
     return UIDevice.current.model
+    #else
+    return nil
     #endif
   }
 
@@ -868,8 +882,10 @@ public enum Device {
     guard isCurrent else { return nil }
     #if os(watchOS)
     return WKInterfaceDevice.current().localizedModel
-    #else
+    #elseif canImport(UIKit)
     return UIDevice.current.localizedModel
+    #else
+    return nil
     #endif
   }
 
@@ -893,6 +909,8 @@ public enum Device {
     }
     #elseif os(tvOS)
     return nil
+    #else
+    return nil
     #endif
   }
 
@@ -948,6 +966,11 @@ extension Device: CustomStringConvertible {
       case .simulator(let model): return "Simulator (\(model.description))"
       case .unknown(let identifier): return identifier
       }
+    #else
+      switch self {
+      case .simulator(let model): return "Simulator (\(model.description))"
+      case .unknown(let identifier): return identifier
+      }
     #endif
   }
 
@@ -980,6 +1003,11 @@ extension Device: CustomStringConvertible {
       case .simulator(let model): return "Simulator (\(model.safeDescription))"
       case .unknown(let identifier): return identifier
       }
+    #else
+      switch self {
+      case .simulator(let model): return "Simulator (\(model.safeDescription))"
+      case .unknown(let identifier): return identifier
+      }
     #endif
   }
 
@@ -1468,6 +1496,8 @@ extension Device {
       case .simulator(let model): return model.cpu
       case .unknown: return .unknown
     }
+  #else
+    return .unknown
   #endif
   }
 }
@@ -1490,6 +1520,8 @@ extension Device.CPU: CustomStringConvertible {
 % end
       case .unknown: return "unknown"
     }
+  #else
+    return "unknown"
   #endif
   }
 }
diff --git a/Tests/Tests.swift b/Tests/Tests.swift
@@ -17,20 +17,31 @@ class DeviceKitTests: XCTestCase {
   let device = Device.current
 
   func testDeviceSimulator() {
+    #if os(macOS)
+    XCTAssertFalse(device.isOneOf(Device.allSimulators))
+    #else
     XCTAssertTrue(device.isOneOf(Device.allSimulators))
+    #endif
   }
 
   func testIsSimulator() {
+    #if os(macOS)
+    XCTAssertFalse(device.isSimulator)
+    #else
     XCTAssertTrue(device.isSimulator)
+    #endif
   }
 
   func testDeviceDescription() {
+    #if os(macOS)
+    #else
     XCTAssertTrue(device.description.hasPrefix("Simulator"))
     XCTAssertTrue(device.description.contains("iPhone")
       || device.description.contains("iPad")
       || device.description.contains("iPod")
       || device.description.contains("TV")
       || device.description.contains("Apple Watch"))
+    #endif
   }
 
   func testIsCanvas() {
@@ -40,6 +51,8 @@ class DeviceKitTests: XCTestCase {
     let otherDevice: Device = device == .appleTVHD ? .appleTV4K : .appleTVHD
     #elseif os(watchOS)
     let otherDevice: Device = device == .appleWatchUltra ? .appleWatchSeries8_41mm : .appleWatchUltra
+    #else
+    let otherDevice: Device = .unknown("mac")
     #endif
     XCTAssertEqual(otherDevice.isCanvas, nil)
     XCTAssertEqual(device.isCanvas, false)

Original file line number	Diff line number	Diff line change
`@@ -628,6 +628,8 @@ public enum Device {`
`628`	`628`	`case "i386", "x86_64", "arm64": return simulator(mapToDevice(identifier: ProcessInfo().environment["SIMULATOR_MODEL_IDENTIFIER"] ?? "watchOS"))`
`629`	`629`	`default: return unknown(identifier)`
`630`	`630`	`}`
	`631`	`+ #else`
	`632`	`+ return unknown(identifier)`
`631`	`633`	`#endif`
`632`	`634`	`}`
`633`	`635`
`@@ -879,6 +881,8 @@ public enum Device {`
`879`	`881`	`}`
`880`	`882`	`#elseif os(tvOS)`
`881`	`883`	`return (width: -1, height: -1)`
	`884`	`+ #else`
	`885`	`+ return (width: -1, height: -1)`
`882`	`886`	`#endif`
`883`	`887`	`}`
`884`	`888`
`@@ -1158,6 +1162,8 @@ public enum Device {`
`1158`	`1162`	`return allTVs`
`1159`	`1163`	`#elseif os(watchOS)`
`1160`	`1164`	`return allWatches`
	`1165`	`+ #else`
	`1166`	`+ return []`
`1161`	`1167`	`#endif`
`1162`	`1168`	`}`
`1163`	`1169`
`@@ -1219,8 +1225,10 @@ public enum Device {`
`1219`	`1225`	`guard isCurrent else { return nil }`
`1220`	`1226`	`#if os(watchOS)`
`1221`	`1227`	`return WKInterfaceDevice.current().name`
`1222`		`- #else`
	`1228`	`+ #elseif canImport(UIKit)`
`1223`	`1229`	`return UIDevice.current.name`
	`1230`	`+ #else`
	`1231`	`+ return nil`
`1224`	`1232`	`#endif`
`1225`	`1233`	`}`
`1226`	`1234`
`@@ -1235,8 +1243,10 @@ public enum Device {`
`1235`	`1243`	`} else {`
`1236`	`1244`	`return UIDevice.current.systemName`
`1237`	`1245`	`}`
`1238`		`- #else`
	`1246`	`+ #elseif canImport(UIKit)`
`1239`	`1247`	`return UIDevice.current.systemName`
	`1248`	`+ #else`
	`1249`	`+ return nil`
`1240`	`1250`	`#endif`
`1241`	`1251`	`}`
`1242`	`1252`
`@@ -1245,8 +1255,10 @@ public enum Device {`
`1245`	`1255`	`guard isCurrent else { return nil }`
`1246`	`1256`	`#if os(watchOS)`
`1247`	`1257`	`return WKInterfaceDevice.current().systemVersion`
`1248`		`- #else`
	`1258`	`+ #elseif canImport(UIKit)`
`1249`	`1259`	`return UIDevice.current.systemVersion`
	`1260`	`+ #else`
	`1261`	`+ return nil`
`1250`	`1262`	`#endif`
`1251`	`1263`	`}`
`1252`	`1264`
`@@ -1255,8 +1267,10 @@ public enum Device {`
`1255`	`1267`	`guard isCurrent else { return nil }`
`1256`	`1268`	`#if os(watchOS)`
`1257`	`1269`	`return WKInterfaceDevice.current().model`
`1258`		`- #else`
	`1270`	`+ #elseif canImport(UIKit)`
`1259`	`1271`	`return UIDevice.current.model`
	`1272`	`+ #else`
	`1273`	`+ return nil`
`1260`	`1274`	`#endif`
`1261`	`1275`	`}`
`1262`	`1276`
`@@ -1265,8 +1279,10 @@ public enum Device {`
`1265`	`1279`	`guard isCurrent else { return nil }`
`1266`	`1280`	`#if os(watchOS)`
`1267`	`1281`	`return WKInterfaceDevice.current().localizedModel`
`1268`		`- #else`
	`1282`	`+ #elseif canImport(UIKit)`
`1269`	`1283`	`return UIDevice.current.localizedModel`
	`1284`	`+ #else`
	`1285`	`+ return nil`
`1270`	`1286`	`#endif`
`1271`	`1287`	`}`
`1272`	`1288`
`@@ -1385,6 +1401,8 @@ public enum Device {`
`1385`	`1401`	`}`
`1386`	`1402`	`#elseif os(tvOS)`
`1387`	`1403`	`return nil`
	`1404`	`+ #else`
	`1405`	`+ return nil`
`1388`	`1406`	`#endif`
`1389`	`1407`	`}`
`1390`	`1408`
`@@ -1536,6 +1554,11 @@ extension Device: CustomStringConvertible {`
`1536`	`1554`	`case .simulator(let model): return "Simulator (\(model.description))"`
`1537`	`1555`	`case .unknown(let identifier): return identifier`
`1538`	`1556`	`}`
	`1557`	`+ #else`
	`1558`	`+ switch self {`
	`1559`	`+ case .simulator(let model): return "Simulator (\(model.description))"`
	`1560`	`+ case .unknown(let identifier): return identifier`
	`1561`	`+ }`
`1539`	`1562`	`#endif`
`1540`	`1563`	`}`
`1541`	`1564`
`@@ -1664,6 +1687,11 @@ extension Device: CustomStringConvertible {`
`1664`	`1687`	`case .simulator(let model): return "Simulator (\(model.safeDescription))"`
`1665`	`1688`	`case .unknown(let identifier): return identifier`
`1666`	`1689`	`}`
	`1690`	`+ #else`
	`1691`	`+ switch self {`
	`1692`	`+ case .simulator(let model): return "Simulator (\(model.safeDescription))"`
	`1693`	`+ case .unknown(let identifier): return identifier`
	`1694`	`+ }`
`1667`	`1695`	`#endif`
`1668`	`1696`	`}`
`1669`	`1697`
`@@ -2298,6 +2326,8 @@ extension Device {`
`2298`	`2326`	`case .simulator(let model): return model.cpu`
`2299`	`2327`	`case .unknown: return .unknown`
`2300`	`2328`	`}`
	`2329`	`+ #else`
	`2330`	`+ return .unknown`
`2301`	`2331`	`#endif`
`2302`	`2332`	`}`
`2303`	`2333`	`}`
`@@ -2347,6 +2377,8 @@ extension Device.CPU: CustomStringConvertible {`
`2347`	`2377`	`case .s9: return "S9"`
`2348`	`2378`	`case .unknown: return "unknown"`
`2349`	`2379`	`}`
	`2380`	`+ #else`
	`2381`	`+ return "unknown"`
`2350`	`2382`	`#endif`
`2351`	`2383`	`}`
`2352`	`2384`	`}`
Original file line number	Diff line number	Diff line change
`@@ -421,6 +421,8 @@ public enum Device {`
`421`	`421`	`case "i386", "x86_64", "arm64": return simulator(mapToDevice(identifier: ProcessInfo().environment["SIMULATOR_MODEL_IDENTIFIER"] ?? "watchOS"))`
`422`	`422`	`default: return unknown(identifier)`
`423`	`423`	`}`
	`424`	`+ #else`
	`425`	`+ return unknown(identifier)`
`424`	`426`	`#endif`
`425`	`427`	`}`
`426`	`428`
`@@ -482,6 +484,8 @@ public enum Device {`
`482`	`484`	`}`
`483`	`485`	`#elseif os(tvOS)`
`484`	`486`	`return (width: -1, height: -1)`
	`487`	`+ #else`
	`488`	`+ return (width: -1, height: -1)`
`485`	`489`	`#endif`
`486`	`490`	`}`
`487`	`491`
`@@ -761,6 +765,8 @@ public enum Device {`
`761`	`765`	`return allTVs`
`762`	`766`	`#elseif os(watchOS)`
`763`	`767`	`return allWatches`
	`768`	`+ #else`
	`769`	`+ return []`
`764`	`770`	`#endif`
`765`	`771`	`}`
`766`	`772`
`@@ -822,8 +828,10 @@ public enum Device {`
`822`	`828`	`guard isCurrent else { return nil }`
`823`	`829`	`#if os(watchOS)`
`824`	`830`	`return WKInterfaceDevice.current().name`
`825`		`- #else`
	`831`	`+ #elseif canImport(UIKit)`
`826`	`832`	`return UIDevice.current.name`
	`833`	`+ #else`
	`834`	`+ return nil`
`827`	`835`	`#endif`
`828`	`836`	`}`
`829`	`837`
`@@ -838,8 +846,10 @@ public enum Device {`
`838`	`846`	`} else {`
`839`	`847`	`return UIDevice.current.systemName`
`840`	`848`	`}`
`841`		`- #else`
	`849`	`+ #elseif canImport(UIKit)`
`842`	`850`	`return UIDevice.current.systemName`
	`851`	`+ #else`
	`852`	`+ return nil`
`843`	`853`	`#endif`
`844`	`854`	`}`
`845`	`855`
`@@ -848,8 +858,10 @@ public enum Device {`
`848`	`858`	`guard isCurrent else { return nil }`
`849`	`859`	`#if os(watchOS)`
`850`	`860`	`return WKInterfaceDevice.current().systemVersion`
`851`		`- #else`
	`861`	`+ #elseif canImport(UIKit)`
`852`	`862`	`return UIDevice.current.systemVersion`
	`863`	`+ #else`
	`864`	`+ return nil`
`853`	`865`	`#endif`
`854`	`866`	`}`
`855`	`867`
`@@ -858,8 +870,10 @@ public enum Device {`
`858`	`870`	`guard isCurrent else { return nil }`
`859`	`871`	`#if os(watchOS)`
`860`	`872`	`return WKInterfaceDevice.current().model`
`861`		`- #else`
	`873`	`+ #elseif canImport(UIKit)`
`862`	`874`	`return UIDevice.current.model`
	`875`	`+ #else`
	`876`	`+ return nil`
`863`	`877`	`#endif`
`864`	`878`	`}`
`865`	`879`
`@@ -868,8 +882,10 @@ public enum Device {`
`868`	`882`	`guard isCurrent else { return nil }`
`869`	`883`	`#if os(watchOS)`
`870`	`884`	`return WKInterfaceDevice.current().localizedModel`
`871`		`- #else`
	`885`	`+ #elseif canImport(UIKit)`
`872`	`886`	`return UIDevice.current.localizedModel`
	`887`	`+ #else`
	`888`	`+ return nil`
`873`	`889`	`#endif`
`874`	`890`	`}`
`875`	`891`
`@@ -893,6 +909,8 @@ public enum Device {`
`893`	`909`	`}`
`894`	`910`	`#elseif os(tvOS)`
`895`	`911`	`return nil`
	`912`	`+ #else`
	`913`	`+ return nil`
`896`	`914`	`#endif`
`897`	`915`	`}`
`898`	`916`
`@@ -948,6 +966,11 @@ extension Device: CustomStringConvertible {`
`948`	`966`	`case .simulator(let model): return "Simulator (\(model.description))"`
`949`	`967`	`case .unknown(let identifier): return identifier`
`950`	`968`	`}`
	`969`	`+ #else`
	`970`	`+ switch self {`
	`971`	`+ case .simulator(let model): return "Simulator (\(model.description))"`
	`972`	`+ case .unknown(let identifier): return identifier`
	`973`	`+ }`
`951`	`974`	`#endif`
`952`	`975`	`}`
`953`	`976`
`@@ -980,6 +1003,11 @@ extension Device: CustomStringConvertible {`
`980`	`1003`	`case .simulator(let model): return "Simulator (\(model.safeDescription))"`
`981`	`1004`	`case .unknown(let identifier): return identifier`
`982`	`1005`	`}`
	`1006`	`+ #else`
	`1007`	`+ switch self {`
	`1008`	`+ case .simulator(let model): return "Simulator (\(model.safeDescription))"`
	`1009`	`+ case .unknown(let identifier): return identifier`
	`1010`	`+ }`
`983`	`1011`	`#endif`
`984`	`1012`	`}`
`985`	`1013`
`@@ -1468,6 +1496,8 @@ extension Device {`
`1468`	`1496`	`case .simulator(let model): return model.cpu`
`1469`	`1497`	`case .unknown: return .unknown`
`1470`	`1498`	`}`
	`1499`	`+ #else`
	`1500`	`+ return .unknown`
`1471`	`1501`	`#endif`
`1472`	`1502`	`}`
`1473`	`1503`	`}`
`@@ -1490,6 +1520,8 @@ extension Device.CPU: CustomStringConvertible {`
`1490`	`1520`	`% end`
`1491`	`1521`	`case .unknown: return "unknown"`
`1492`	`1522`	`}`
	`1523`	`+ #else`
	`1524`	`+ return "unknown"`
`1493`	`1525`	`#endif`
`1494`	`1526`	`}`
`1495`	`1527`	`}`