Merge branch 'main' into feature/diff_tool_args

Author: arietis

README.md

@@ -143,7 +143,7 @@ If you want to use SnapshotTesting in any other project that uses [SwiftPM](http
 
 ```swift
 dependencies: [
-  .package(name: "SnapshotTesting", url: "https://github.com/pointfreeco/swift-snapshot-testing.git", from: "1.8.1"),
+  .package(name: "SnapshotTesting", url: "https://github.com/pointfreeco/swift-snapshot-testing.git", from: "1.9.0"),
 ]
 ```
 
@@ -161,7 +161,7 @@ targets: [
 If you use [Carthage](https://github.com/Carthage/Carthage), you can add the following dependency to your `Cartfile`:
 
 ``` ruby
-github "pointfreeco/swift-snapshot-testing" ~> 1.8.0
+github "pointfreeco/swift-snapshot-testing" ~> 1.9.0
 ```
 
 > ⚠️ Warning: Carthage instructs you to drag frameworks into your Xcode project. Xcode may automatically attempt to link these frameworks to your app target. `SnapshotTesting.framework` is only compatible with test targets, so when you first add it to your project:
@@ -179,7 +179,7 @@ If your project uses [CocoaPods](https://cocoapods.org), add the pod to any appl
 
 ```ruby
 target 'MyAppTests' do
-  pod 'SnapshotTesting', '~> 1.8.1'
+  pod 'SnapshotTesting', '~> 1.9.0'
 end
 ```
 
@@ -195,7 +195,10 @@ end
   - **Supports any platform that supports Swift.** Write snapshot tests for iOS, Linux, macOS, and tvOS.
   - **SceneKit, SpriteKit, and WebKit support.** Most snapshot testing libraries don't support these view subclasses.
   - **`Codable` support**. Snapshot encodable data structures into their [JSON](Documentation/Available-Snapshot-Strategies.md#json) and [property list](Documentation/Available-Snapshot-Strategies.md#plist) representations.
-  - **Custom diff tool integration**.
+  - **Custom diff tool integration**. Configure failure messages to print diff commands for [Kaleidoscope](https://kaleidoscope.app) (or your diff tool of choice).
+    ``` swift
+    SnapshotTesting.diffTool = "ksdiff"
+    ```
 
 ## Plug-ins
 
@@ -209,6 +212,8 @@ end
 
   - [AccessibilitySnapshotColorBlindness](https://github.com/Sherlouk/AccessibilitySnapshotColorBlindness) adds snapshot strategies for color blindness simulation on iOS views, view controllers and images.
 
+  - [swift-snapshot-testing-stitch](https://github.com/Sherlouk/swift-snapshot-testing-stitch/) adds the ability to stitch multiple UIView's or UIViewController's together in a single test.
+
 Have you written your own SnapshotTesting plug-in? [Add it here](https://github.com/pointfreeco/swift-snapshot-testing/edit/master/README.md) and submit a pull request!
 
 ## Related Tools

SnapshotTesting.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name = "SnapshotTesting"
-  s.version = "1.8.1"
+  s.version = "1.9.0"
   s.summary = "Tests that save and assert against reference data"
 
   s.description = <<-DESC

Sources/SnapshotTesting/Common/View.swift

@@ -146,6 +146,38 @@ public struct ViewImageConfig {
     return .init(safeArea: safeArea, size: size, traits: .iPhoneXr(orientation))
   }
 
+  public static let iPhone12 = ViewImageConfig.iPhone12(.portrait)
+
+  public static func iPhone12(_ orientation: Orientation) -> ViewImageConfig {
+    let safeArea: UIEdgeInsets
+    let size: CGSize
+    switch orientation {
+    case .landscape:
+      safeArea = .init(top: 0, left: 47, bottom: 21, right: 47)
+      size = .init(width: 844, height: 390)
+    case .portrait:
+      safeArea = .init(top: 47, left: 0, bottom: 34, right: 0)
+      size = .init(width: 390, height: 844)
+    }
+    return .init(safeArea: safeArea, size: size, traits: .iPhone12(orientation))
+  }
+
+  public static let iPhone12ProMax = ViewImageConfig.iPhone12ProMax(.portrait)
+
+  public static func iPhone12ProMax(_ orientation: Orientation) -> ViewImageConfig {
+    let safeArea: UIEdgeInsets
+    let size: CGSize
+    switch orientation {
+    case .landscape:
+      safeArea = .init(top: 0, left: 47, bottom: 21, right: 47)
+      size = .init(width: 926, height: 428)
+    case .portrait:
+      safeArea = .init(top: 47, left: 0, bottom: 34, right: 0)
+      size = .init(width: 428, height: 926)
+    }
+    return .init(safeArea: safeArea, size: size, traits: .iPhone12ProMax(orientation))
+  }
+
   public static let iPadMini = ViewImageConfig.iPadMini(.landscape)
 
   public static func iPadMini(_ orientation: Orientation) -> ViewImageConfig {
@@ -192,6 +224,63 @@ public struct ViewImageConfig {
     return .init(safeArea: .init(top: 20, left: 0, bottom: 0, right: 0), size: size, traits: traits)
   }
 
+  public static let iPad9_7 = iPadMini
+
+  public static func iPad9_7(_ orientation: Orientation) -> ViewImageConfig {
+    return iPadMini(orientation)
+  }
+
+  public static func iPad9_7(_ orientation: TabletOrientation) -> ViewImageConfig {
+    return iPadMini(orientation)
+  }
+
+  public static let iPad10_2 = ViewImageConfig.iPad10_2(.landscape)
+
+  public static func iPad10_2(_ orientation: Orientation) -> ViewImageConfig {
+    switch orientation {
+    case .landscape:
+      return ViewImageConfig.iPad10_2(.landscape(splitView: .full))
+    case .portrait:
+      return ViewImageConfig.iPad10_2(.portrait(splitView: .full))
+    }
+  }
+
+  public static func iPad10_2(_ orientation: TabletOrientation) -> ViewImageConfig {
+    let size: CGSize
+    let traits: UITraitCollection
+    switch orientation {
+    case .landscape(let splitView):
+      switch splitView {
+      case .oneThird:
+        size = .init(width: 320, height: 810)
+        traits = .iPad10_2_Compact_SplitView
+      case .oneHalf:
+        size = .init(width: 535, height: 810)
+        traits = .iPad10_2_Compact_SplitView
+      case .twoThirds:
+        size = .init(width: 750, height: 810)
+        traits = .iPad10_2
+      case .full:
+        size = .init(width: 1080, height: 810)
+        traits = .iPad10_2
+      }
+    case .portrait(let splitView):
+      switch splitView {
+      case .oneThird:
+        size = .init(width: 320, height: 1080)
+        traits = .iPad10_2_Compact_SplitView
+      case .twoThirds:
+        size = .init(width: 480, height: 1080)
+        traits = .iPad10_2_Compact_SplitView
+      case .full:
+        size = .init(width: 810, height: 1080)
+        traits = .iPad10_2
+      }
+    }
+    return .init(safeArea: .init(top: 20, left: 0, bottom: 0, right: 0), size: size, traits: traits)
+  }
+
+
   public static let iPadPro10_5 = ViewImageConfig.iPadPro10_5(.landscape)
 
   public static func iPadPro10_5(_ orientation: Orientation) -> ViewImageConfig {
@@ -507,16 +596,76 @@ extension UITraitCollection {
         )
       case .portrait:
         return .init(
-          traitsFrom: [
+          traitsFrom: base + [
             .init(horizontalSizeClass: .compact),
             .init(verticalSizeClass: .regular)
           ]
         )
       }
   }
 
+  public static func iPhone12(_ orientation: ViewImageConfig.Orientation)
+  -> UITraitCollection {
+    let base: [UITraitCollection] = [
+//    .init(displayGamut: .P3),
+//    .init(displayScale: 3),
+      .init(forceTouchCapability: .available),
+      .init(layoutDirection: .leftToRight),
+      .init(preferredContentSizeCategory: .medium),
+      .init(userInterfaceIdiom: .phone)
+    ]
+    switch orientation {
+    case .landscape:
+      return .init(
+        traitsFrom: base + [
+          .init(horizontalSizeClass: .compact),
+          .init(verticalSizeClass: .compact)
+        ]
+      )
+    case .portrait:
+      return .init(
+        traitsFrom: base + [
+          .init(horizontalSizeClass: .compact),
+          .init(verticalSizeClass: .regular)
+        ]
+      )
+    }
+  }
+
+  public static func iPhone12ProMax(_ orientation: ViewImageConfig.Orientation)
+  -> UITraitCollection {
+    let base: [UITraitCollection] = [
+      //    .init(displayGamut: .P3),
+      //    .init(displayScale: 3),
+      .init(forceTouchCapability: .available),
+      .init(layoutDirection: .leftToRight),
+      .init(preferredContentSizeCategory: .medium),
+      .init(userInterfaceIdiom: .phone)
+    ]
+    switch orientation {
+    case .landscape:
+      return .init(
+        traitsFrom: base + [
+          .init(horizontalSizeClass: .regular),
+          .init(verticalSizeClass: .compact)
+        ]
+      )
+    case .portrait:
+      return .init(
+        traitsFrom: base + [
+          .init(horizontalSizeClass: .compact),
+          .init(verticalSizeClass: .regular)
+        ]
+      )
+    }
+  }
+
   public static let iPadMini = iPad
   public static let iPadMini_Compact_SplitView = iPadCompactSplitView
+  public static let iPad9_7 = iPad
+  public static let iPad9_7_Compact_SplitView = iPadCompactSplitView
+  public static let iPad10_2 = iPad
+  public static let iPad10_2_Compact_SplitView = iPadCompactSplitView
   public static let iPadPro10_5 = iPad
   public static let iPadPro10_5_Compact_SplitView = iPadCompactSplitView
   public static let iPadPro11 = iPad
@@ -604,7 +753,6 @@ extension View {
     #if os(iOS) || os(macOS)
     if let wkWebView = self as? WKWebView {
       return Async<Image> { callback in
-        let delegate = NavigationDelegate()
         let work = {
           if #available(iOS 11.0, macOS 10.13, *) {
             inWindow {
@@ -613,7 +761,6 @@ extension View {
                 return
               }
               wkWebView.takeSnapshot(with: nil) { image, _ in
-                _ = delegate
                 callback(image!)
               }
             }
@@ -627,8 +774,14 @@ extension View {
         }
 
         if wkWebView.isLoading {
-          delegate.didFinish = work
-          wkWebView.navigationDelegate = delegate
+          var subscription: NSKeyValueObservation?
+          subscription = wkWebView.observe(\.isLoading, options: [.initial, .new]) { (webview, change) in
+            subscription?.invalidate()
+            subscription = nil
+            if change.newValue == false {
+              work()
+            }
+          }
         } else {
           work()
         }
@@ -647,22 +800,6 @@ extension View {
   #endif
 }
 
-#if os(iOS) || os(macOS)
-private final class NavigationDelegate: NSObject, WKNavigationDelegate {
-  var didFinish: () -> Void
-
-  init(didFinish: @escaping () -> Void = {}) {
-    self.didFinish = didFinish
-  }
-
-  func webView(_ webView: WKWebView, didFinish navigation: WKNavigation!) {
-    webView.evaluateJavaScript("document.readyState") { _, _ in
-      self.didFinish()
-    }
-  }
-}
-#endif
-
 #if os(iOS) || os(tvOS)
 extension UIApplication {
     static var sharedIfAvailable: UIApplication? {

Sources/SnapshotTesting/Snapshotting/UIImage.swift

@@ -71,6 +71,11 @@ extension Snapshotting where Value == UIImage, Format == UIImage {
   }
 }
 
+// remap snapshot & reference to same colorspace
+let imageContextColorSpace = CGColorSpace(name: CGColorSpace.sRGB)
+let imageContextBitsPerComponent = 8
+let imageContextBytesPerPixel = 4
+
 private func compare(_ old: UIImage, _ new: UIImage, precision: Float) -> Bool {
   guard let oldCgImage = old.cgImage else { return false }
   guard let newCgImage = new.cgImage else { return false }
@@ -80,23 +85,18 @@ private func compare(_ old: UIImage, _ new: UIImage, precision: Float) -> Bool {
   guard oldCgImage.height != 0 else { return false }
   guard newCgImage.height != 0 else { return false }
   guard oldCgImage.height == newCgImage.height else { return false }
-  // Values between images may differ due to padding to multiple of 64 bytes per row,
-  // because of that a freshly taken view snapshot may differ from one stored as PNG.
-  // At this point we're sure that size of both images is the same, so we can go with minimal `bytesPerRow` value
-  // and use it to create contexts.
-  let minBytesPerRow = min(oldCgImage.bytesPerRow, newCgImage.bytesPerRow)
-  let byteCount = minBytesPerRow * oldCgImage.height
 
+  let byteCount = imageContextBytesPerPixel * oldCgImage.width * oldCgImage.height
   var oldBytes = [UInt8](repeating: 0, count: byteCount)
-  guard let oldContext = context(for: oldCgImage, bytesPerRow: minBytesPerRow, data: &oldBytes) else { return false }
+  guard let oldContext = context(for: oldCgImage, data: &oldBytes) else { return false }
   guard let oldData = oldContext.data else { return false }
-  if let newContext = context(for: newCgImage, bytesPerRow: minBytesPerRow), let newData = newContext.data {
+  if let newContext = context(for: newCgImage), let newData = newContext.data {
     if memcmp(oldData, newData, byteCount) == 0 { return true }
   }
   let newer = UIImage(data: new.pngData()!)!
   guard let newerCgImage = newer.cgImage else { return false }
   var newerBytes = [UInt8](repeating: 0, count: byteCount)
-  guard let newerContext = context(for: newerCgImage, bytesPerRow: minBytesPerRow, data: &newerBytes) else { return false }
+  guard let newerContext = context(for: newerCgImage, data: &newerBytes) else { return false }
   guard let newerData = newerContext.data else { return false }
   if memcmp(oldData, newerData, byteCount) == 0 { return true }
   if precision >= 1 { return false }
@@ -109,16 +109,17 @@ private func compare(_ old: UIImage, _ new: UIImage, precision: Float) -> Bool {
   return true
 }
 
-private func context(for cgImage: CGImage, bytesPerRow: Int, data: UnsafeMutableRawPointer? = nil) -> CGContext? {
+private func context(for cgImage: CGImage, data: UnsafeMutableRawPointer? = nil) -> CGContext? {
+  let bytesPerRow = cgImage.width * imageContextBytesPerPixel
   guard
-    let space = cgImage.colorSpace,
+    let colorSpace = imageContextColorSpace,
     let context = CGContext(
       data: data,
       width: cgImage.width,
       height: cgImage.height,
-      bitsPerComponent: cgImage.bitsPerComponent,
+      bitsPerComponent: imageContextBitsPerComponent,
       bytesPerRow: bytesPerRow,
-      space: space,
+      space: colorSpace,
       bitmapInfo: CGImageAlphaInfo.premultipliedLast.rawValue
     )
     else { return nil }
@@ -130,7 +131,8 @@ private func context(for cgImage: CGImage, bytesPerRow: Int, data: UnsafeMutable
 private func diff(_ old: UIImage, _ new: UIImage) -> UIImage {
   let width = max(old.size.width, new.size.width)
   let height = max(old.size.height, new.size.height)
-  UIGraphicsBeginImageContextWithOptions(CGSize(width: width, height: height), true, 0)
+  let scale = max(old.scale, new.scale)
+  UIGraphicsBeginImageContextWithOptions(CGSize(width: width, height: height), true, scale)
   new.draw(at: .zero)
   old.draw(at: .zero, blendMode: .difference, alpha: 1)
   let differenceImage = UIGraphicsGetImageFromCurrentImageContext()!

Sources/SnapshotTesting/Snapshotting/URLRequest.swift

@@ -12,7 +12,7 @@ extension Snapshotting where Value == URLRequest, Format == String {
   /// - Parameter pretty: Attempts to pretty print the body of the request (supports JSON).
   public static func raw(pretty: Bool) -> Snapshotting {
     return SimplySnapshotting.lines.pullback { (request: URLRequest) in
-      let method = "\(request.httpMethod ?? "GET") \(request.url?.absoluteString ?? "(null)")"
+      let method = "\(request.httpMethod ?? "GET") \(request.url?.sortingQueryItems()?.absoluteString ?? "(null)")"
 
       let headers = (request.allHTTPHeaderFields ?? [:])
         .map { key, value in "\(key): \(value)" }
@@ -76,8 +76,18 @@ extension Snapshotting where Value == URLRequest, Format == String {
     }
 
     // URL
-    components.append("\"\(request.url!.absoluteString)\"")
+    components.append("\"\(request.url!.sortingQueryItems()!.absoluteString)\"")
 
     return components.joined(separator: " \\\n\t")
   }
 }
+
+private extension URL {
+  func sortingQueryItems() -> URL? {
+    var components = URLComponents(url: self, resolvingAgainstBaseURL: false)
+    let sortedQueryItems = components?.queryItems?.sorted { $0.name < $1.name }
+    components?.queryItems = sortedQueryItems
+
+    return components?.url
+  }
+}