- documentation for KeyboardHelper, KeyboardAppearanceInfo and KeyboardAppearanceInfoTests

- test for animateAlong

Author: Timmi Trinks

KeyboardHelper.xcodeproj/xcshareddata/xcschemes/KeyboardHelper.xcscheme

@@ -0,0 +1,99 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Scheme
+   LastUpgradeVersion = "0720"
+   version = "1.3">
+   <BuildAction
+      parallelizeBuildables = "YES"
+      buildImplicitDependencies = "YES">
+      <BuildActionEntries>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "YES"
+            buildForProfiling = "YES"
+            buildForArchiving = "YES"
+            buildForAnalyzing = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "275BCA761C57C9F800FF3647"
+               BuildableName = "KeyboardHelper.framework"
+               BlueprintName = "KeyboardHelper"
+               ReferencedContainer = "container:KeyboardHelper.xcodeproj">
+            </BuildableReference>
+         </BuildActionEntry>
+      </BuildActionEntries>
+   </BuildAction>
+   <TestAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      shouldUseLaunchSchemeArgsEnv = "YES">
+      <Testables>
+         <TestableReference
+            skipped = "NO">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "275BCA801C57C9F800FF3647"
+               BuildableName = "KeyboardHelperTests.xctest"
+               BlueprintName = "KeyboardHelperTests"
+               ReferencedContainer = "container:KeyboardHelper.xcodeproj">
+            </BuildableReference>
+         </TestableReference>
+      </Testables>
+      <MacroExpansion>
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "275BCA761C57C9F800FF3647"
+            BuildableName = "KeyboardHelper.framework"
+            BlueprintName = "KeyboardHelper"
+            ReferencedContainer = "container:KeyboardHelper.xcodeproj">
+         </BuildableReference>
+      </MacroExpansion>
+      <AdditionalOptions>
+      </AdditionalOptions>
+   </TestAction>
+   <LaunchAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      launchStyle = "0"
+      useCustomWorkingDirectory = "NO"
+      ignoresPersistentStateOnLaunch = "NO"
+      debugDocumentVersioning = "YES"
+      debugServiceExtension = "internal"
+      allowLocationSimulation = "YES">
+      <MacroExpansion>
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "275BCA761C57C9F800FF3647"
+            BuildableName = "KeyboardHelper.framework"
+            BlueprintName = "KeyboardHelper"
+            ReferencedContainer = "container:KeyboardHelper.xcodeproj">
+         </BuildableReference>
+      </MacroExpansion>
+      <AdditionalOptions>
+      </AdditionalOptions>
+   </LaunchAction>
+   <ProfileAction
+      buildConfiguration = "Release"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      savedToolIdentifier = ""
+      useCustomWorkingDirectory = "NO"
+      debugDocumentVersioning = "YES">
+      <MacroExpansion>
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "275BCA761C57C9F800FF3647"
+            BuildableName = "KeyboardHelper.framework"
+            BlueprintName = "KeyboardHelper"
+            ReferencedContainer = "container:KeyboardHelper.xcodeproj">
+         </BuildableReference>
+      </MacroExpansion>
+   </ProfileAction>
+   <AnalyzeAction
+      buildConfiguration = "Debug">
+   </AnalyzeAction>
+   <ArchiveAction
+      buildConfiguration = "Release"
+      revealArchiveInOrganizer = "YES">
+   </ArchiveAction>
+</Scheme>

KeyboardHelper/Classes/KeyboardAppearanceInfo.swift

@@ -9,6 +9,9 @@
 import Foundation
 import UIKit
 
+/**
+ A struct holding all keyboard view information when it's being shown or hidden.
+*/
 public struct KeyboardAppearanceInfo {
 
     public let notification: NSNotification
@@ -20,16 +23,26 @@ public struct KeyboardAppearanceInfo {
     }
 
     /**
-    Getter for the UIKeyboard Info
+     Getter for the UIKeyboard frame begin infokey.
+     Return a `CGRect` or `CGRectZero`.
     */
     public var beginFrame: CGRect {
         return userInfo[UIKeyboardFrameBeginUserInfoKey]?.CGRectValue ?? CGRectZero
     }
 
+    /**
+     Getter for the UIKeyboard frame end infokey.
+     Return a `CGRect` or `CGRectZero`.
+     */
     public var endFrame: CGRect {
         return userInfo[UIKeyboardFrameEndUserInfoKey]?.CGRectValue ?? CGRectZero
     }
 
+    /**
+     Getter for the UIKeyboard info if the keyboard is in the current app.
+     That variable will help to keep track of which app uses the keyboard at the moment.
+     If it is the current app it is true, if not it is false.
+     */
     public var belongsToCurrentApp: Bool {
         if #available(iOS 9.0, *) {
             return userInfo[UIKeyboardIsLocalUserInfoKey]?.boolValue ?? true
@@ -38,20 +51,40 @@ public struct KeyboardAppearanceInfo {
         }
     }
 
+    /**
+     Getter for the duration of the keyboard appear/disappear animation.
+     By default: `0.25`.
+     */
     public var animationDuration: Double {
         return userInfo[UIKeyboardAnimationDurationUserInfoKey]?.doubleValue ?? 0.25
     }
 
+    /**
+     Getter for the animation curve.
+     By default: `EaseInOut`.
+     */
     public var animationCurve: UIViewAnimationCurve {
         guard let value = userInfo[UIKeyboardAnimationCurveUserInfoKey] as? Int else { return .EaseInOut }
         return UIViewAnimationCurve(rawValue: value) ?? .EaseInOut
     }
 
+    /**
+     Getter for the animation option.
+     That variable will help to keep track of the keyboard appearence.
+     */
     public var animationOptions: UIViewAnimationOptions {
         return UIViewAnimationOptions(rawValue: UInt(animationCurve.rawValue << 16))
     }
 
-    func animateAlong(animationBlock: () -> Void, completion: (finished: Bool) -> Void) {
+    /**
+     Animate a `UView` while the keyboard appears and check if animation is finished.
+     If finished do completion.
+     
+     Parameters:
+        - animationBlock: Animation that should happen.
+        - completion: Function that happens after the animation is finished.
+    */
+    public func animateAlong(animationBlock: () -> Void, completion: (finished: Bool) -> Void) {
         UIView.animateWithDuration(
             animationDuration,
             delay: 0.0,

KeyboardHelper/Classes/KeyboardHelper.swift

@@ -9,15 +9,39 @@
 import Foundation
 import UIKit
 
+/**
+    Protocol `KeyboardNotificationDelegate` requires two functions.
+    Function `keyboardWillAppear` and `keyboardWillDisappear` with parameter `info` struct `KeyboardAppearanceInfo`.
+*/
 public protocol KeyboardNotificationDelegate {
+    
+    /**
+        This function will recongnize a change of `KeyboardAppearanceInfo` and will be fired when the keyboard will appaear.
+        - Parameter info: Struct `KeyboardAppearanceInfo`.
+     */
     func keyboardWillAppear(info: KeyboardAppearanceInfo)
+    
+    /**
+        This function will recongnize a change of `KeyboardAppearanceInfo` and will be fired when the keyboard will disappaear.
+        - Parameter info: Struct `KeyboardAppearanceInfo`.
+     */
     func keyboardWillDisappear(info: KeyboardAppearanceInfo)
 }
 
+/**
+    Useful helper to keep track of keyboard changes.
+*/
 public class KeyboardHelper {
 
+    /**
+        Delegate that conforms with the `KeyboardNotificationDelegate`.
+    */
     public let delegate: KeyboardNotificationDelegate?
 
+    /**
+        Initialize the `delegate` and add the two observer for `keyboardWillAppear` and `keyboardWillDisappear`.
+        Observers are nessecary for tracking the `UIKeyboardWillShowNotification` and `UIKeyboardWillHideNotification`, so the function that are connectet are getting fired.
+    */
     required public init(delegate: KeyboardNotificationDelegate) {
         self.delegate = delegate
 
@@ -29,12 +53,12 @@ public class KeyboardHelper {
         delegate = nil
     }
 
-    public func keyboardWillAppear(note: NSNotification) {
+    private func keyboardWillAppear(note: NSNotification) {
         let info = KeyboardAppearanceInfo(notification: note)
         self.delegate?.keyboardWillAppear(info)
     }
 
-    public func keyboardWillDisappear(note: NSNotification) {
+    private func keyboardWillDisappear(note: NSNotification) {
         let info = KeyboardAppearanceInfo(notification: note)
         self.delegate?.keyboardWillDisappear(info)
     }

KeyboardHelperTests/Tests/KeyboardAppearanceInfoTests.swift

@@ -15,16 +15,13 @@ class KeyboardAppearanceInfoTests: XCTestCase {
 
     override func setUp() {
         super.setUp()
-        
-        var animationCurve = UIViewAnimationCurve.EaseInOut
-        NSNumber(integer: 7).getValue(&animationCurve)
 
         // Create test info
         var testUserInfo: [String: AnyObject] = [
             UIKeyboardFrameBeginUserInfoKey: NSValue(CGRect: CGRect(x: 100, y: 100, width: 100, height: 100)),
             UIKeyboardFrameEndUserInfoKey: NSValue(CGRect: CGRect(x: 200, y: 200, width: 200, height: 200)),
-            UIKeyboardAnimationDurationUserInfoKey: Double(3),
-            UIKeyboardAnimationCurveUserInfoKey: animationCurve.rawValue,
+            UIKeyboardAnimationDurationUserInfoKey: 3.0,
+            UIKeyboardAnimationCurveUserInfoKey: UIViewAnimationCurve.EaseOut.rawValue,
         ]
 
         if #available(iOS 9.0, *) {
@@ -51,7 +48,7 @@ class KeyboardAppearanceInfoTests: XCTestCase {
     @available(iOS 9.0, *)
     func testBelongsToCurrentApp() {
         XCTAssertEqual(apperanceInfo.belongsToCurrentApp, false,
-            "Parsing endFrame from keyboard appearance info failed.")
+            "Parsing belongsToCurrentApp from keyboard appearance info failed.")
     }
 
     func testAnimationDuration() {
@@ -60,12 +57,22 @@ class KeyboardAppearanceInfoTests: XCTestCase {
     }
 
     func testAnimationCurve() {
-        XCTAssertEqual(apperanceInfo.animationCurve, UIViewAnimationCurve(rawValue: 7),
+        XCTAssertEqual(apperanceInfo.animationCurve, UIViewAnimationCurve(rawValue: 2),
             "Parsing animationCurve from keyboard appearance info failed.")
     }
 
-//    func testAnimateAlong() {
-//        XCTAssertEqual(apperanceInfo., <#T##expression2: T?##T?#>, <#T##message: String##String#>)
-//    }
+    func testAnimateAlong() {
+        let expectation = expectationWithDescription("Animate along should take 3 seconds")
+        
+        apperanceInfo.animateAlong({ () -> Void in
+            // Do animations
+            }) { (finished) -> Void in
+                if finished {
+                    expectation.fulfill()
+                }
+        }
+        
+        waitForExpectationsWithTimeout(3.005, handler: nil)
+    }
 
 }