Add basic Snapshot testing

ephread · Jun 16, 2018 · 613b46e · 613b46e
1 parent 12c8fd5
commit 613b46e
Show file tree

Hide file tree

Showing 17 changed files with 336 additions and 128 deletions.
diff --git a/.gitignore b/.gitignore
@@ -38,8 +38,7 @@ xcuserdata
 # Carthage
 #
 # Add this line if you want to avoid checking in source code from Carthage dependencies.
-# Carthage/Checkouts
+**/Carthage/Checkouts
+**/Carthage/Build
 
-Carthage/Build
-
-Skassets
+Skassets
diff --git a/Examples/Cartfile b/Examples/Cartfile
@@ -0,0 +1,2 @@
+github "uber/ios-snapshot-test-case" ~> 3.0.0
+
diff --git a/Examples/Cartfile.resolved b/Examples/Cartfile.resolved
@@ -0,0 +1 @@
+github "uber/ios-snapshot-test-case" "3.0.0"
diff --git a/Examples/Example/Sources/Core/Storyboards/Base.lproj/Main.storyboard b/Examples/Example/Sources/Core/Storyboards/Base.lproj/Main.storyboard
@@ -15,7 +15,7 @@
         <!--Profile-->
         <scene sceneID="WBD-GZ-Xaa">
             <objects>
-                <viewController title="Profile" id="YJG-tQ-EGf" customClass="DefaultViewController" customModule="Instructions_Example" customModuleProvider="target" sceneMemberID="viewController">
+                <viewController storyboardIdentifier="DefaultViewController" title="Profile" id="YJG-tQ-EGf" customClass="DefaultViewController" customModule="Instructions_Example" customModuleProvider="target" sceneMemberID="viewController">
                     <view key="view" contentMode="scaleToFill" id="yyL-TN-CqH">
                         <rect key="frame" x="0.0" y="0.0" width="375" height="603"/>
                         <autoresizingMask key="autoresizingMask" widthSizable="YES" heightSizable="YES"/>

diff --git a/Examples/Example/Sources/Core/View Controllers/Basic Examples/DefaultViewController.swift b/Examples/Example/Sources/Core/View Controllers/Basic Examples/DefaultViewController.swift
@@ -1,6 +1,6 @@
 // DefaultViewController.swift
 //
-// Copyright (c) 2015, 2016 Frédéric Maquin <fred@ephread.com>
+// Copyright (c) 2015-2018 Frédéric Maquin <fred@ephread.com>
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to deal
@@ -25,7 +25,8 @@ import Instructions
 
 // That's the default controller, using every defaults made available by Instructions.
 // It can't get any simpler.
-internal class DefaultViewController: ProfileViewController {
+internal class DefaultViewController: ProfileViewController,
+                                      CoachMarksControllerDataSource {
     var windowLevel: UIWindowLevel?
     var presentationContext: Context = .independantWindow
 
@@ -63,10 +64,8 @@ internal class DefaultViewController: ProfileViewController {
     enum Context {
         case independantWindow, controllerWindow, controller
     }
-}
 
-// MARK: - Protocol Conformance | CoachMarksControllerDataSource
-extension DefaultViewController: CoachMarksControllerDataSource {
+    // MARK: - Protocol Conformance | CoachMarksControllerDataSource
     func numberOfCoachMarks(for coachMarksController: CoachMarksController) -> Int {
         return 5
     }
@@ -117,9 +116,8 @@ extension DefaultViewController: CoachMarksControllerDataSource {
 
         return (bodyView: coachViews.bodyView, arrowView: coachViews.arrowView)
     }
-}
 
-extension DefaultViewController: CoachMarksControllerDelegate {
+    // MARK: Protocol Conformance - CoachMarkControllerDelegate
     func coachMarksController(_ coachMarksController: CoachMarksController,
                               willLoadCoachMarkAt index: Int) -> Bool {
         if index == 0 && presentationContext == .controller {

diff --git a/...ples/Example/Sources/Core/View Controllers/Debug/BackgroundNetworkingViewController.swift b/...ples/Example/Sources/Core/View Controllers/Debug/BackgroundNetworkingViewController.swift
@@ -74,7 +74,7 @@ internal class BackgroundNetworkingViewController: DefaultViewController {
     }
 
     // MARK: CoachMarksControllerDelegate
-    func coachMarksController(_ coachMarksController: CoachMarksController,
+    override func coachMarksController(_ coachMarksController: CoachMarksController,
                               willShow coachMark: inout CoachMark, afterSizeTransition: Bool,
                               at index: Int) {
         if index == 2 && !afterSizeTransition {

diff --git a/Examples/Example/Sources/Core/View Controllers/Debug/TestFlowViewController.swift b/Examples/Example/Sources/Core/View Controllers/Debug/TestFlowViewController.swift
@@ -60,6 +60,57 @@ class TestFlowViewController: ProfileViewController {
         self.coachMarksController.stop(immediately: true)
         self.coachMarksController.start(in: .window(over: self))
     }
+
+    // MARK: - Protocol Conformance | CoachMarksControllerDelegate
+    func coachMarksController(_ coachMarksController: CoachMarksController,
+                              willLoadCoachMarkAt index: Int) -> Bool {
+        print("willLoadCoachMarkAt: \(index)")
+        return true
+    }
+
+    override func coachMarksController(_ coachMarksController: CoachMarksController,
+                              willShow coachMark: inout CoachMark,
+                              afterSizeTransition: Bool,
+                              at index: Int) {
+        print("willShow at: \(index), afterSizeTransition: \(afterSizeTransition)")
+    }
+
+    override func coachMarksController(_ coachMarksController: CoachMarksController,
+                              didShow coachMark: CoachMark,
+                              afterSizeTransition: Bool,
+                              at index: Int) {
+        print("didShow at: \(index), afterSizeTransition: \(afterSizeTransition)")
+    }
+
+    override func coachMarksController(_ coachMarksController: CoachMarksController,
+                              willHide coachMark: CoachMark,
+                              at index: Int) {
+        print("willHide at: \(index)")
+    }
+
+    override func coachMarksController(_ coachMarksController: CoachMarksController,
+                              didHide coachMark: CoachMark,
+                              at index: Int) {
+        print("didHide at: \(index)")
+    }
+
+    override func coachMarksController(_ coachMarksController: CoachMarksController,
+                              didEndShowingBySkipping skipped: Bool) {
+        print("didEndShowingBySkipping: \(skipped)")
+    }
+
+    func shouldHandleOverlayTap(in coachMarksController: CoachMarksController,
+                                at index: Int) -> Bool {
+        print("shouldHandleOverlayTap at index: \(index)")
+
+        if index >= 2 {
+            print("Index greater than or equal to 2, skipping")
+            coachMarksController.stop()
+            return false
+        } else {
+            return true
+        }
+    }
 }
 
 // MARK: - Protocol Conformance | CoachMarksControllerDataSource
@@ -115,56 +166,3 @@ extension TestFlowViewController: CoachMarksControllerDataSource {
         return (bodyView: coachViews.bodyView, arrowView: coachViews.arrowView)
     }
 }
-
-// MARK: - Protocol Conformance | CoachMarksControllerDelegate
-extension TestFlowViewController: CoachMarksControllerDelegate {
-    func coachMarksController(_ coachMarksController: CoachMarksController,
-                              willLoadCoachMarkAt index: Int) -> Bool {
-        print("willLoadCoachMarkAt: \(index)")
-        return true
-    }
-
-    func coachMarksController(_ coachMarksController: CoachMarksController,
-                              willShow coachMark: inout CoachMark,
-                              afterSizeTransition: Bool,
-                              at index: Int) {
-        print("willShow at: \(index), afterSizeTransition: \(afterSizeTransition)")
-    }
-
-    func coachMarksController(_ coachMarksController: CoachMarksController,
-                              didShow coachMark: CoachMark,
-                              afterSizeTransition: Bool,
-                              at index: Int) {
-        print("didShow at: \(index), afterSizeTransition: \(afterSizeTransition)")
-    }
-
-    func coachMarksController(_ coachMarksController: CoachMarksController,
-                              willHide coachMark: CoachMark,
-                              at index: Int) {
-        print("willHide at: \(index)")
-    }
-
-    func coachMarksController(_ coachMarksController: CoachMarksController,
-                              didHide coachMark: CoachMark,
-                              at index: Int) {
-        print("didHide at: \(index)")
-    }
-
-    func coachMarksController(_ coachMarksController: CoachMarksController,
-                              didEndShowingBySkipping skipped: Bool) {
-        print("didEndShowingBySkipping: \(skipped)")
-    }
-
-    func shouldHandleOverlayTap(in coachMarksController: CoachMarksController,
-                                at index: Int) -> Bool {
-        print("shouldHandleOverlayTap at index: \(index)")
-
-        if index >= 2 {
-            print("Index greater than or equal to 2, skipping")
-            coachMarksController.stop()
-            return false
-        } else {
-            return true
-        }
-    }
-}
diff --git a/...ples/Example/Sources/Core/View Controllers/Delegate Examples/DelegateViewController.swift b/...ples/Example/Sources/Core/View Controllers/Delegate Examples/DelegateViewController.swift
@@ -25,7 +25,7 @@ import Instructions
 
 // MARK: - Main Controller
 // This class is an example of what can be achieved with the delegate methods.
-class DelegateViewController: ProfileViewController {
+class DelegateViewController: ProfileViewController, CoachMarksControllerDataSource {
 
     // MARK: IBOutlets
     @IBOutlet weak var profileBackgroundView: UIView?
@@ -48,10 +48,8 @@ class DelegateViewController: ProfileViewController {
 
         coachMarksController.skipView = skipView
     }
-}
 
-// MARK: - Protocol Conformance | CoachMarksControllerDataSource
-extension DelegateViewController: CoachMarksControllerDataSource {
+    // MARK: - Protocol Conformance | CoachMarksControllerDataSource
     func numberOfCoachMarks(for coachMarksController: CoachMarksController) -> Int {
         return 5
     }
@@ -110,12 +108,10 @@ extension DelegateViewController: CoachMarksControllerDataSource {
 
         return (bodyView: coachViews.bodyView, arrowView: coachViews.arrowView)
     }
-}
 
-// MARK: - Protocol Conformance | CoachMarksControllerDelegate
-extension DelegateViewController: CoachMarksControllerDelegate {
-    func coachMarksController(_ coachMarksController: CoachMarksController,
-                              configureOrnamentsOfOverlay overlay: UIView) {
+    // MARK: - Protocol Conformance | CoachMarksControllerDelegate
+    override func coachMarksController(_ coachMarksController: CoachMarksController,
+                                       configureOrnamentsOfOverlay overlay: UIView) {
         let label = UILabel()
         label.translatesAutoresizingMaskIntoConstraints = false
         overlay.addSubview(label)
@@ -128,7 +124,7 @@ extension DelegateViewController: CoachMarksControllerDelegate {
         label.topAnchor.constraint(equalTo: overlay.topAnchor, constant: 100).isActive = true
     }
 
-    func coachMarksController(_ coachMarksController: CoachMarksController,
+    override func coachMarksController(_ coachMarksController: CoachMarksController,
                               willShow coachMark: inout CoachMark,
                               afterSizeTransition: Bool, at index: Int) {
         if index == 0 && !afterSizeTransition {
@@ -160,7 +156,7 @@ extension DelegateViewController: CoachMarksControllerDelegate {
         }
     }
 
-    func coachMarksController(_ coachMarksController: CoachMarksController,
+    override func coachMarksController(_ coachMarksController: CoachMarksController,
                               willHide coachMark: CoachMark, at index: Int) {
         if index == 1 {
             avatarVerticalPositionConstraint?.constant = 0
@@ -172,7 +168,7 @@ extension DelegateViewController: CoachMarksControllerDelegate {
         }
     }
 
-    func coachMarksController(_ coachMarksController: CoachMarksController,
+    override func coachMarksController(_ coachMarksController: CoachMarksController,
                               didEndShowingBySkipping skipped: Bool) {
         let newColor: UIColor
 

diff --git a/...s/Example/Sources/Core/View Controllers/Delegate Examples/PausingCodeViewController.swift b/...s/Example/Sources/Core/View Controllers/Delegate Examples/PausingCodeViewController.swift
@@ -63,6 +63,15 @@ internal class PausingCodeViewController: ProfileViewController {
         // The user tapped on the button, so let's carry on!
         coachMarksController.flow.resume()
     }
+
+    // MARK: - Protocol Conformance | CoachMarksControllerDelegate
+    override func coachMarksController(_ coachMarksController: CoachMarksController,
+                              willShow coachMark: inout CoachMark,
+                              afterSizeTransition: Bool, at index: Int) {
+        if index == 2 && !afterSizeTransition {
+            coachMarksController.flow.pause(and: pauseStyle)
+        }
+    }
 }
 
 // MARK: - Protocol Conformance | CoachMarksControllerDataSource
@@ -121,14 +130,3 @@ extension PausingCodeViewController: CoachMarksControllerDataSource {
         return (bodyView: coachViews.bodyView, arrowView: coachViews.arrowView)
     }
 }
-
-// MARK: - Protocol Conformance | CoachMarksControllerDelegate
-extension PausingCodeViewController: CoachMarksControllerDelegate {
-    func coachMarksController(_ coachMarksController: CoachMarksController,
-                              willShow coachMark: inout CoachMark,
-                              afterSizeTransition: Bool, at index: Int) {
-        if index == 2 && !afterSizeTransition {
-            coachMarksController.flow.pause(and: pauseStyle)
-        }
-    }
-}
diff --git a/...le/Sources/Core/View Controllers/Delegate Examples/TransitionFromCodeViewController.swift b/...le/Sources/Core/View Controllers/Delegate Examples/TransitionFromCodeViewController.swift
@@ -140,10 +140,8 @@ extension TransitionFromCodeViewController: CoachMarksControllerDataSource {
 
         return (bodyView: coachViews.bodyView, arrowView: coachViews.arrowView)
     }
-}
 
-// MARK: - Protocol Conformance | CoachMarksControllerDelegate
-extension TransitionFromCodeViewController: CoachMarksControllerDelegate {
+    // MARK: - Protocol Conformance | CoachMarksControllerDelegate
     func coachMarksController(_ coachMarksController: CoachMarksController, willLoadCoachMarkAt index: Int) -> Bool {
         switch(index) {
         case 1: