Apply a bunch of refactoring changes.

devicekit · Nov 6, 2019 · 371f1c3 · 371f1c3
1 parent f19f9f8
commit 371f1c3
Show file tree

Hide file tree

Showing 3 changed files with 131 additions and 67 deletions.
diff --git a/Source/Device.generated.swift b/Source/Device.generated.swift
@@ -579,11 +579,12 @@ public enum Device {
     }
 
     /// All X-Series Devices
+    @available(*, deprecated, renamed: "allDevicesWithSensorHousing")
     public static var allXSeriesDevices: [Device] {
       return [.iPhoneX, .iPhoneXS, .iPhoneXSMax, .iPhoneXR, .iPhone11, .iPhone11Pro, .iPhone11ProMax]
     }
 
-    /// All Plus-Sized Devices
+    /// All Plus and Max-Sized Devices
     public static var allPlusSizedDevices: [Device] {
       return [.iPhone6Plus, .iPhone6sPlus, .iPhone7Plus, .iPhone8Plus, .iPhoneXSMax, .iPhone11ProMax]
     }
@@ -619,11 +620,12 @@ public enum Device {
     }
 
     /// All simulator Plus-Sized Devices
+    @available(*, deprecated, renamed: "allSimulatorDevicesWithSensorHousing")
     public static var allSimulatorXSeriesDevices: [Device] {
-      return allXSeriesDevices.map(Device.simulator)
+      return allDevicesWithSensorHousing.map(Device.simulator)
     }
 
-    /// All simulator Plus-Sized Devices
+    /// All simulator Plus and Max-Sized Devices
     public static var allSimulatorPlusSizedDevices: [Device] {
       return allPlusSizedDevices.map(Device.simulator)
     }
@@ -684,6 +686,11 @@ public enum Device {
       return [.iPhoneX, .iPhoneXS, .iPhoneXSMax, .iPhoneXR, .iPhone11, .iPhone11Pro, .iPhone11ProMax, .iPadPro11Inch, .iPadPro12Inch3]
     }
 
+    /// All Devices with Touch ID or Face ID
+    public static var allBiometricAuthenticationCapableDevices: [Device] {
+      return [.iPhone5s, .iPhone6, .iPhone6Plus, .iPhone6s, .iPhone6sPlus, .iPhone7, .iPhone7Plus, .iPhoneSE, .iPhone8, .iPhone8Plus, .iPhoneX, .iPhoneXS, .iPhoneXSMax, .iPhoneXR, .iPhone11, .iPhone11Pro, .iPhone11ProMax, .iPadAir2, .iPad5, .iPad6, .iPadAir3, .iPad7, .iPadMini3, .iPadMini4, .iPadMini5, .iPadPro9Inch, .iPadPro12Inch, .iPadPro12Inch2, .iPadPro10Inch, .iPadPro11Inch, .iPadPro12Inch3]
+    }
+
     /// Returns whether or not the device has Touch ID
     public var isTouchIDCapable: Bool {
       return isOneOf(Device.allTouchIDCapableDevices)
@@ -704,6 +711,11 @@ public enum Device {
       return [.iPhoneX, .iPhoneXS, .iPhoneXSMax, .iPhoneXR, .iPhone11, .iPhone11Pro, .iPhone11ProMax]
     }
 
+    /// All simulator devices that feature a sensor housing in the screen
+    public static var allSimulatorDevicesWithSensorHousing: [Device] {
+      return allDevicesWithSensorHousing.map(Device.simulator)
+    }
+
     /// Returns whether or not the device has a sensor housing
     public var hasSensorHousing: Bool {
       return isOneOf(Device.allDevicesWithSensorHousing)
@@ -1331,59 +1343,62 @@ extension Device {
 // MARK: - Cameras
 extension Device {
 
-  public enum CameraTypes {
+  public enum CameraType {
+    @available(*, deprecated, renamed: "wide")
     case normal
+
+    case wide
     case telephoto
     case ultraWide
   }
 
   /// Returns an array of the types of cameras the device has
-  public var cameras: [CameraTypes] {
+  public var cameras: [CameraType] {
     switch self {
-      case .iPodTouch5: return [.normal]
-      case .iPodTouch6: return [.normal]
-      case .iPodTouch7: return [.normal]
-      case .iPhone4: return [.normal]
-      case .iPhone4s: return [.normal]
-      case .iPhone5: return [.normal]
-      case .iPhone5c: return [.normal]
-      case .iPhone5s: return [.normal]
-      case .iPhone6: return [.normal]
-      case .iPhone6Plus: return [.normal]
-      case .iPhone6s: return [.normal]
-      case .iPhone6sPlus: return [.normal]
-      case .iPhone7: return [.normal]
-      case .iPhoneSE: return [.normal]
-      case .iPhone8: return [.normal]
-      case .iPhoneXR: return [.normal]
-      case .iPad2: return [.normal]
-      case .iPad3: return [.normal]
-      case .iPad4: return [.normal]
-      case .iPadAir: return [.normal]
-      case .iPadAir2: return [.normal]
-      case .iPad5: return [.normal]
-      case .iPad6: return [.normal]
-      case .iPadAir3: return [.normal]
-      case .iPad7: return [.normal]
-      case .iPadMini: return [.normal]
-      case .iPadMini2: return [.normal]
-      case .iPadMini3: return [.normal]
-      case .iPadMini4: return [.normal]
-      case .iPadMini5: return [.normal]
-      case .iPadPro9Inch: return [.normal]
-      case .iPadPro12Inch: return [.normal]
-      case .iPadPro12Inch2: return [.normal]
-      case .iPadPro10Inch: return [.normal]
-      case .iPadPro11Inch: return [.normal]
-      case .iPadPro12Inch3: return [.normal]
-      case .iPhone7Plus: return [.normal, .telephoto]
-      case .iPhone8Plus: return [.normal, .telephoto]
-      case .iPhoneX: return [.normal, .telephoto]
-      case .iPhoneXS: return [.normal, .telephoto]
-      case .iPhoneXSMax: return [.normal, .telephoto]
-      case .iPhone11: return [.normal, .ultraWide]
-      case .iPhone11Pro: return [.normal, .telephoto, .ultraWide]
-      case .iPhone11ProMax: return [.normal, .telephoto, .ultraWide]
+      case .iPodTouch5: return [.wide]
+      case .iPodTouch6: return [.wide]
+      case .iPodTouch7: return [.wide]
+      case .iPhone4: return [.wide]
+      case .iPhone4s: return [.wide]
+      case .iPhone5: return [.wide]
+      case .iPhone5c: return [.wide]
+      case .iPhone5s: return [.wide]
+      case .iPhone6: return [.wide]
+      case .iPhone6Plus: return [.wide]
+      case .iPhone6s: return [.wide]
+      case .iPhone6sPlus: return [.wide]
+      case .iPhone7: return [.wide]
+      case .iPhoneSE: return [.wide]
+      case .iPhone8: return [.wide]
+      case .iPhoneXR: return [.wide]
+      case .iPad2: return [.wide]
+      case .iPad3: return [.wide]
+      case .iPad4: return [.wide]
+      case .iPadAir: return [.wide]
+      case .iPadAir2: return [.wide]
+      case .iPad5: return [.wide]
+      case .iPad6: return [.wide]
+      case .iPadAir3: return [.wide]
+      case .iPad7: return [.wide]
+      case .iPadMini: return [.wide]
+      case .iPadMini2: return [.wide]
+      case .iPadMini3: return [.wide]
+      case .iPadMini4: return [.wide]
+      case .iPadMini5: return [.wide]
+      case .iPadPro9Inch: return [.wide]
+      case .iPadPro12Inch: return [.wide]
+      case .iPadPro12Inch2: return [.wide]
+      case .iPadPro10Inch: return [.wide]
+      case .iPadPro11Inch: return [.wide]
+      case .iPadPro12Inch3: return [.wide]
+      case .iPhone7Plus: return [.wide, .telephoto]
+      case .iPhone8Plus: return [.wide, .telephoto]
+      case .iPhoneX: return [.wide, .telephoto]
+      case .iPhoneXS: return [.wide, .telephoto]
+      case .iPhoneXSMax: return [.wide, .telephoto]
+      case .iPhone11: return [.wide, .ultraWide]
+      case .iPhone11Pro: return [.wide, .telephoto, .ultraWide]
+      case .iPhone11ProMax: return [.wide, .telephoto, .ultraWide]
       default: return []
     }
   }
@@ -1394,10 +1409,16 @@ extension Device {
   }
 
   /// All devices that feature a normal camera
+  @available(*, deprecated, renamed: "allDevicesWithWideCamera")
   public static var allDevicesWithNormalCamera: [Device] {
     return [.iPodTouch5, .iPodTouch6, .iPodTouch7, .iPhone4, .iPhone4s, .iPhone5, .iPhone5c, .iPhone5s, .iPhone6, .iPhone6Plus, .iPhone6s, .iPhone6sPlus, .iPhone7, .iPhone7Plus, .iPhoneSE, .iPhone8, .iPhone8Plus, .iPhoneX, .iPhoneXS, .iPhoneXSMax, .iPhoneXR, .iPhone11, .iPhone11Pro, .iPhone11ProMax, .iPad2, .iPad3, .iPad4, .iPadAir, .iPadAir2, .iPad5, .iPad6, .iPadAir3, .iPad7, .iPadMini, .iPadMini2, .iPadMini3, .iPadMini4, .iPadMini5, .iPadPro9Inch, .iPadPro12Inch, .iPadPro12Inch2, .iPadPro10Inch, .iPadPro11Inch, .iPadPro12Inch3]
   }
 
+  /// All devices that feature a wide camera
+  public static var allDevicesWithWideCamera: [Device] {
+    return [.iPodTouch5, .iPodTouch6, .iPodTouch7, .iPhone4, .iPhone4s, .iPhone5, .iPhone5c, .iPhone5s, .iPhone6, .iPhone6Plus, .iPhone6s, .iPhone6sPlus, .iPhone7, .iPhone7Plus, .iPhoneSE, .iPhone8, .iPhone8Plus, .iPhoneX, .iPhoneXS, .iPhoneXSMax, .iPhoneXR, .iPhone11, .iPhone11Pro, .iPhone11ProMax, .iPad2, .iPad3, .iPad4, .iPadAir, .iPadAir2, .iPad5, .iPad6, .iPadAir3, .iPad7, .iPadMini, .iPadMini2, .iPadMini3, .iPadMini4, .iPadMini5, .iPadPro9Inch, .iPadPro12Inch, .iPadPro12Inch2, .iPadPro10Inch, .iPadPro11Inch, .iPadPro12Inch3]
+  }
+
   /// All devices that feature a telephoto camera
   public static var allDevicesWithTelephotoCamera: [Device] {
     return [.iPhone7Plus, .iPhone8Plus, .iPhoneX, .iPhoneXS, .iPhoneXSMax, .iPhone11Pro, .iPhone11ProMax]
@@ -1414,8 +1435,14 @@ extension Device {
   }
 
   /// Returns whether or not the current device has a normal camera
+  @available(*, deprecated, renamed: "hasWideCamera")
   public var hasNormalCamera: Bool {
-    return self.cameras.contains(.normal)
+    return self.cameras.contains(.wide)
+  }
+
+  /// Returns whether or not the current device has a wide camera
+  public var hasWideCamera: Bool {
+    return self.cameras.contains(.wide)
   }
 
   /// Returns whether or not the current device has a telephoto camera

diff --git a/Source/Device.swift.gyb b/Source/Device.swift.gyb
@@ -375,11 +375,12 @@ public enum Device {
     }
 
     /// All X-Series Devices
+    @available(*, deprecated, renamed: "allDevicesWithSensorHousing")
     public static var allXSeriesDevices: [Device] {
       return [${', '.join(list(map(lambda device: "." + device.caseName, list(filter(lambda device: device.isXSeries == True, iOSDevices)))))}]
     }
 
-    /// All Plus-Sized Devices
+    /// All Plus and Max-Sized Devices
     public static var allPlusSizedDevices: [Device] {
       return [${', '.join(list(map(lambda device: "." + device.caseName, list(filter(lambda device: device.isPlusFormFactor == True, iOSDevices)))))}]
     }
@@ -415,11 +416,12 @@ public enum Device {
     }
 
     /// All simulator Plus-Sized Devices
+    @available(*, deprecated, renamed: "allSimulatorDevicesWithSensorHousing")
     public static var allSimulatorXSeriesDevices: [Device] {
-      return allXSeriesDevices.map(Device.simulator)
+      return allDevicesWithSensorHousing.map(Device.simulator)
     }
 
-    /// All simulator Plus-Sized Devices
+    /// All simulator Plus and Max-Sized Devices
     public static var allSimulatorPlusSizedDevices: [Device] {
       return allPlusSizedDevices.map(Device.simulator)
     }
@@ -480,6 +482,11 @@ public enum Device {
       return [${', '.join(list(map(lambda device: "." + device.caseName, list(filter(lambda device: device.hasFaceID == True, iOSDevices)))))}]
     }
 
+    /// All Devices with Touch ID or Face ID
+    public static var allBiometricAuthenticationCapableDevices: [Device] {
+      return [${', '.join(list(map(lambda device: "." + device.caseName, list(filter(lambda device: device.hasTouchID == True or device.hasFaceID == True, iOSDevices)))))}]
+    }
+
     /// Returns whether or not the device has Touch ID
     public var isTouchIDCapable: Bool {
       return isOneOf(Device.allTouchIDCapableDevices)
@@ -500,6 +507,11 @@ public enum Device {
       return [${', '.join(list(map(lambda device: "." + device.caseName, list(filter(lambda device: device.hasSensorHousing == True, iOSDevices)))))}]
     }
 
+    /// All simulator devices that feature a sensor housing in the screen
+    public static var allSimulatorDevicesWithSensorHousing: [Device] {
+      return allDevicesWithSensorHousing.map(Device.simulator)
+    }
+
     /// Returns whether or not the device has a sensor housing
     public var hasSensorHousing: Bool {
       return isOneOf(Device.allDevicesWithSensorHousing)
@@ -1022,17 +1034,20 @@ extension Device {
 // MARK: - Cameras
 extension Device {
 
-  public enum CameraTypes {
+  public enum CameraType {
+    @available(*, deprecated, renamed: "wide")
     case normal
+
+    case wide
     case telephoto
     case ultraWide
   }
 
   /// Returns an array of the types of cameras the device has
-  public var cameras: [CameraTypes] {
+  public var cameras: [CameraType] {
     switch self {
   % for device in list(filter(lambda device: device.cameras == 1, iOSDevices)):
-      case .${device.caseName}: return [.normal]
+      case .${device.caseName}: return [.wide]
   % end
   % for device in list(filter(lambda device: device.cameras == 2, iOSDevices)):
     case .${device.caseName}: return [.telephoto]
@@ -1041,13 +1056,16 @@ extension Device {
     case .${device.caseName}: return [.ultraWide]
   % end
   % for device in list(filter(lambda device: device.cameras == 12, iOSDevices)):
-      case .${device.caseName}: return [.normal, .telephoto]
+      case .${device.caseName}: return [.wide, .telephoto]
   % end
   % for device in list(filter(lambda device: device.cameras == 13, iOSDevices)):
-      case .${device.caseName}: return [.normal, .ultraWide]
+      case .${device.caseName}: return [.wide, .ultraWide]
+  % end
+  % for device in list(filter(lambda device: device.cameras == 23, iOSDevices)):
+      case .${device.caseName}: return [.telephoto, .ultraWide]
   % end
   % for device in list(filter(lambda device: device.cameras == 123, iOSDevices)):
-      case .${device.caseName}: return [.normal, .telephoto, .ultraWide]
+      case .${device.caseName}: return [.wide, .telephoto, .ultraWide]
   % end
       default: return []
     }
@@ -1059,10 +1077,16 @@ extension Device {
   }
 
   /// All devices that feature a normal camera
+  @available(*, deprecated, renamed: "allDevicesWithWideCamera")
   public static var allDevicesWithNormalCamera: [Device] {
     return [${', '.join(list(map(lambda device: "." + device.caseName, list(filter(lambda device: device.cameras == 1 or device.cameras == 12 or device.cameras == 13 or device.cameras == 123, iOSDevices)))))}]
   }
 
+  /// All devices that feature a wide camera
+  public static var allDevicesWithWideCamera: [Device] {
+    return [${', '.join(list(map(lambda device: "." + device.caseName, list(filter(lambda device: device.cameras == 1 or device.cameras == 12 or device.cameras == 13 or device.cameras == 123, iOSDevices)))))}]
+  }
+
   /// All devices that feature a telephoto camera
   public static var allDevicesWithTelephotoCamera: [Device] {
     return [${', '.join(list(map(lambda device: "." + device.caseName, list(filter(lambda device: device.cameras == 2 or device.cameras == 12 or device.cameras == 123, iOSDevices)))))}]
@@ -1079,8 +1103,14 @@ extension Device {
   }
 
   /// Returns whether or not the current device has a normal camera
+  @available(*, deprecated, renamed: "hasWideCamera")
   public var hasNormalCamera: Bool {
-    return self.cameras.contains(.normal)
+    return self.cameras.contains(.wide)
+  }
+
+  /// Returns whether or not the current device has a wide camera
+  public var hasWideCamera: Bool {
+    return self.cameras.contains(.wide)
   }
 
   /// Returns whether or not the current device has a telephoto camera

diff --git a/Tests/Tests.swift b/Tests/Tests.swift
@@ -387,29 +387,36 @@ class DeviceKitTests: XCTestCase {
 
   func testCameras() {
     for device in Device.allDevicesWithCamera {
-      XCTAssertTrue(device.cameras.contains(.normal) || device.cameras.contains(.telephoto))
+      XCTAssertTrue(device.cameras.contains(.wide) || device.cameras.contains(.telephoto) || device.cameras.contains(.ultraWide))
       XCTAssertTrue(device.hasCamera)
-      XCTAssertTrue(device.hasNormalCamera || device.hasTelephotoCamera)
+      XCTAssertTrue(device.hasWideCamera || device.hasTelephotoCamera || device.hasUltraWideCamera)
     }
     for device in Device.allPhones + Device.allPads + Device.allPods {
       if !Device.allDevicesWithCamera.contains(device) {
-        XCTAssertFalse(device.cameras.contains(.normal))
+        XCTAssertFalse(device.cameras.contains(.wide))
         XCTAssertFalse(device.cameras.contains(.telephoto))
+        XCTAssertFalse(device.cameras.contains(.ultraWide))
         XCTAssertFalse(device.hasCamera)
-        XCTAssertFalse(device.hasNormalCamera)
+        XCTAssertFalse(device.hasWideCamera)
         XCTAssertFalse(device.hasTelephotoCamera)
+        XCTAssertFalse(device.hasUltraWideCamera)
       }
     }
-    for device in Device.allDevicesWithNormalCamera {
-      XCTAssertTrue(device.cameras.contains(.normal))
+    for device in Device.allDevicesWithWideCamera {
+      XCTAssertTrue(device.cameras.contains(.wide))
       XCTAssertTrue(device.hasCamera)
-      XCTAssertTrue(device.hasNormalCamera)
+      XCTAssertTrue(device.hasWideCamera)
     }
     for device in Device.allDevicesWithTelephotoCamera {
       XCTAssertTrue(device.cameras.contains(.telephoto))
       XCTAssertTrue(device.hasCamera)
       XCTAssertTrue(device.hasTelephotoCamera)
     }
+    for device in Device.allDevicesWithUltraWideCamera {
+      XCTAssertTrue(device.cameras.contains(.ultraWide))
+      XCTAssertTrue(device.hasCamera)
+      XCTAssertTrue(device.hasUltraWideCamera)
+    }
   }
 
   #endif