Fix SwiftKickMobile#185 incorrect margin adjustments in landscape

Author: wtmoose

CHANGELOG.md

@@ -1,6 +1,10 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## 4.1.3
+### Bug Fixes
+* Fix #185 Incorrect margin adjustments in landscape
+
 ## 4.1.2
 
 ### Features

SwiftMessages.podspec

@@ -1,11 +1,11 @@
 Pod::Spec.new do |spec|
     spec.name             = 'SwiftMessages'
-    spec.version          = '4.1.2'
+    spec.version          = '4.1.3'
     spec.license          = { :type => 'MIT' }
     spec.homepage         = 'https://github.com/SwiftKickMobile/SwiftMessages'
     spec.authors          = { 'Timothy Moose' => 'tim@swiftkick.it' }
     spec.summary          = 'A very flexible message bar for iOS written in Swift.'
-    spec.source           = {:git => 'https://github.com/SwiftKickMobile/SwiftMessages.git', :tag => '4.1.2'}
+    spec.source           = {:git => 'https://github.com/SwiftKickMobile/SwiftMessages.git', :tag => '4.1.3'}
     spec.platform         = :ios, '8.0'
     spec.ios.deployment_target = '8.0'
     spec.source_files     = 'SwiftMessages/**/*.swift'

SwiftMessages/Animator.swift

@@ -17,8 +17,9 @@ public protocol AnimationDelegate: class {
 }
 
 /**
- An option set that represents the known types of safe zone conflicts
- that may need custom margin adustments.
+ An option set representing the known types of safe area conflicts
+ that could require margin adustments on the message view in order to
+ get the layouts to look right.
  */
 public struct SafeZoneConflicts: OptionSet {
     public let rawValue: Int
@@ -36,11 +37,10 @@ public struct SafeZoneConflicts: OptionSet {
     /// Message view behind home indicator on iPhone X
     public static let homeIndicator = SafeZoneConflicts(rawValue: 1 << 2)
 
-    /// Message view covering status bar on iPhone 8 or lower. One would expect the
-    /// top safe zone to be 0, but in the current version of iOS 11, it is non-zero (20),
-    /// which SwiftMessages will automatically compensate for by subtracting that amount
-    /// form the layout margins.
-    public static let coveredStatusBar = SafeZoneConflicts(rawValue: 1 << 3)
+    /// Message view is over the status bar on an iPhone 8 or lower. This is a special
+    /// case because we logically expect the top safe area to be zero, but it is reported as 20
+    /// (which seems like an iOS bug). We use the `overStatusBar` to indicate this special case.
+    public static let overStatusBar = SafeZoneConflicts(rawValue: 1 << 3)
 }
 
 public class AnimationContext {

SwiftMessages/MarginAdjustable+Animation.swift

@@ -14,17 +14,19 @@ public extension MarginAdjustable where Self: UIView {
         var top: CGFloat = 0
         top += bounceAnimationOffset
         if !context.safeZoneConflicts.isDisjoint(with: [.sensorNotch, .statusBar]) {
-            if #available(iOS 11, *), container.safeAreaInsets.top > 0  {
-                // Linear formula based on:
-                // iPhone 8 - 20pt top safe area with 0pt adjustment
-                // iPhone X - 44pt top safe area with -6pt adjustment
-                top -= 6 * (container.safeAreaInsets.top - 20) / (44 - 20)
+            if #available(iOS 11, *)  {
+                do {
+                    // To accommodate future safe areas, using a linear formula based on
+                    // two data points:
+                    // iPhone 8 - 20pt top safe area needs 0pt adjustment
+                    // iPhone X - 44pt top safe area needs -6pt adjustment
+                    top -= 6 * (container.safeAreaInsets.top - 20) / (44 - 20)
+                }
                 top += safeAreaTopOffset
-            } else {
+            } else if UIApplication.shared.statusBarOrientation == .portrait || UIApplication.shared.statusBarOrientation == .portraitUpsideDown {
                 top += statusBarOffset
             }
-        }
-        if #available(iOS 11, *), !context.safeZoneConflicts.isDisjoint(with: .coveredStatusBar) {
+        } else if #available(iOS 11, *), !context.safeZoneConflicts.isDisjoint(with: .overStatusBar) {
             top -= safeAreaInsets.top
         }
         return top
@@ -35,6 +37,14 @@ public extension MarginAdjustable where Self: UIView {
         bottom += bounceAnimationOffset
         if !context.safeZoneConflicts.isDisjoint(with: [.homeIndicator]) {
             if #available(iOS 11, *), container.safeAreaInsets.bottom > 0  {
+                do {
+                    // This adjustment was added to fix a layout issue with iPhone X in
+                    // landscape mode. Using a linear formula based on two data points to help
+                    // future proof against future safe areas:
+                    // iPhone X portrait: 34pt bottom safe area needs 0pt adjustment
+                    // iPhone X landscape: 21pt bottom safe area needs 12pt adjustment
+                    bottom -= 12 * (container.safeAreaInsets.bottom - 34) / (34 - 21)
+                }
                 bottom += safeAreaBottomOffset
             }
         }

SwiftMessages/PhysicsAnimation.swift

@@ -99,10 +99,10 @@ public class PhysicsAnimation: NSObject, Animator {
         }
         adjustable.preservesSuperviewLayoutMargins = false
         if #available(iOS 11, *) {
-            var margins = adjustable.directionalLayoutMargins
+            var margins = adjustable.safeAreaInsets
             margins.top = top
             margins.bottom = bottom
-            adjustable.directionalLayoutMargins = margins
+            adjustable.layoutMargins = margins
         } else {
             var margins = adjustable.layoutMargins
             margins.top = top

SwiftMessages/Presenter.swift

@@ -219,12 +219,12 @@ class Presenter: NSObject {
 
     private func safeZoneConflicts() -> SafeZoneConflicts {
         guard let window = maskingView.window else { return [] }
-        let inNormalWindowLevel: Bool = {
+        let windowLevel: UIWindowLevel = {
             if let vc = presentationContext.viewControllerValue() as? WindowViewController {
-                return vc.windowLevel == UIWindowLevelNormal
+                return vc.windowLevel
             }
-            return true
-        } ()
+            return UIWindowLevelNormal
+        }()
         // TODO `underNavigationBar` and `underTabBar` should look up the presentation context's hierarchy
         // TODO for cases where both should be true (probably not an issue for typical height messages, though).
         let underNavigationBar: Bool = {
@@ -236,15 +236,24 @@ class Presenter: NSObject {
             return false
         }()
         if #available(iOS 11, *) {
-            if !inNormalWindowLevel {
+            if windowLevel > UIWindowLevelNormal {
                 // TODO seeing `maskingView.safeAreaInsets.top` value of 20 on
-                // iPhone 8 with status bar window level, which doesn't seem right
-                // since the status bar is covered by the window. Applying a special rule
+                // iPhone 8 with status bar window level. This seems like an iOS bug since
+                // the message view's window is above the status bar. Applying a special rule
                 // to allow the animator to revove this amount from the layout margins if needed.
-                if maskingView.safeAreaInsets.top <= 20 {
-                    return [.coveredStatusBar]
+                // This may need to be reworked if any future device has a legitimate 20pt top safe area,
+                // such as with a potentially smaller notch.
+                if maskingView.safeAreaInsets.top == 20 {
+                    return [.overStatusBar]
                 } else {
-                    return [.sensorNotch, .homeIndicator]
+                    var conflicts: SafeZoneConflicts = []
+                    if maskingView.safeAreaInsets.top > 0 {
+                        conflicts.formUnion(.sensorNotch)
+                    }
+                    if maskingView.safeAreaInsets.bottom > 0 {
+                        conflicts.formUnion(.homeIndicator)
+                    }
+                    return conflicts
                 }
             }
             var conflicts: SafeZoneConflicts = []
@@ -257,7 +266,7 @@ class Presenter: NSObject {
             return conflicts
         } else {
             if UIApplication.shared.isStatusBarHidden { return [] }
-            if !inNormalWindowLevel || underNavigationBar { return [] }
+            if (windowLevel > UIWindowLevelNormal) || underNavigationBar { return [] }
             let statusBarFrame = UIApplication.shared.statusBarFrame
             let statusBarWindowFrame = window.convert(statusBarFrame, from: nil)
             let statusBarViewFrame = maskingView.convert(statusBarWindowFrame, from: nil)

SwiftMessages/Resources/StatusLine.xib

@@ -1,12 +1,13 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<document type="com.apple.InterfaceBuilder3.CocoaTouch.XIB" version="3.0" toolsVersion="13196" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES" colorMatched="YES">
+<document type="com.apple.InterfaceBuilder3.CocoaTouch.XIB" version="3.0" toolsVersion="14109" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES" useSafeAreas="YES" colorMatched="YES">
     <device id="retina4_7" orientation="portrait">
         <adaptation id="fullscreen"/>
     </device>
     <dependencies>
-        <deployment identifier="iOS"/>
-        <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="13173"/>
+        <deployment version="2304" identifier="iOS"/>
+        <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="14088"/>
         <capability name="Constraints to layout margins" minToolsVersion="6.0"/>
+        <capability name="Safe area layout guides" minToolsVersion="9.0"/>
         <capability name="documents saved in the Xcode 8 format" minToolsVersion="8.0"/>
     </dependencies>
     <objects>
@@ -37,6 +38,7 @@
                 <constraint firstAttribute="trailingMargin" secondItem="Jtv-Px-mvN" secondAttribute="trailing" constant="30" id="hII-4c-bJX"/>
             </constraints>
             <freeformSimulatedSizeMetrics key="simulatedDestinationMetrics"/>
+            <viewLayoutGuide key="safeArea" id="yBK-G0-nSP"/>
             <userDefinedRuntimeAttributes>
                 <userDefinedRuntimeAttribute type="number" keyPath="statusBarOffset">
                     <real key="value" value="14"/>

SwiftMessages/TopBottomAnimation.swift

@@ -110,10 +110,10 @@ public class TopBottomAnimation: NSObject, Animator {
         }
         adjustable.preservesSuperviewLayoutMargins = false
         if #available(iOS 11, *) {
-            var margins = adjustable.directionalLayoutMargins
+            var margins = adjustable.safeAreaInsets
             margins.top = top
             margins.bottom = bottom
-            adjustable.directionalLayoutMargins = margins
+            adjustable.layoutMargins = margins
         } else {
             var margins = adjustable.layoutMargins
             margins.top = top