Merging 1.0.0 branch

Author: Pietro Rea

Example/SpringAnimationController/Base.lproj/Main.storyboard

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="14113" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES" colorMatched="YES" initialViewController="r9E-DI-q2Y">
+<document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="14113" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES" colorMatched="YES" initialViewController="V4X-9O-Iwd">
     <device id="retina4_7" orientation="portrait">
         <adaptation id="fullscreen"/>
     </device>
@@ -10,17 +10,18 @@
         <capability name="documents saved in the Xcode 8 format" minToolsVersion="8.0"/>
     </dependencies>
     <scenes>
-        <!--View Controller-->
+        <!--Presenting-->
         <scene sceneID="3Il-X6-dIP">
             <objects>
-                <viewController id="r9E-DI-q2Y" customClass="ViewController" customModule="SpringAnimationController" customModuleProvider="target" sceneMemberID="viewController">
+                <viewController title="Presenting" id="r9E-DI-q2Y" customClass="ViewController" customModule="SpringAnimationController_Example" customModuleProvider="target" sceneMemberID="viewController">
                     <view key="view" contentMode="scaleToFill" id="08J-eO-oD5">
                         <rect key="frame" x="0.0" y="0.0" width="375" height="667"/>
                         <autoresizingMask key="autoresizingMask" widthSizable="YES" heightSizable="YES"/>
                         <subviews>
                             <button opaque="NO" contentMode="scaleToFill" contentHorizontalAlignment="center" contentVerticalAlignment="center" buttonType="roundedRect" lineBreakMode="middleTruncation" translatesAutoresizingMaskIntoConstraints="NO" id="nyn-IW-b3z">
-                                <rect key="frame" x="161" y="578" width="53" height="30"/>
-                                <state key="normal" title="Present"/>
+                                <rect key="frame" x="126" y="575" width="123" height="33"/>
+                                <fontDescription key="fontDescription" type="system" pointSize="17"/>
+                                <state key="normal" title="Present Modally"/>
                                 <connections>
                                     <action selector="presentViewController:" destination="r9E-DI-q2Y" eventType="touchUpInside" id="w1A-hu-MM1"/>
                                 </connections>
@@ -33,50 +34,75 @@
                         </constraints>
                         <viewLayoutGuide key="safeArea" id="RYU-TX-ztu"/>
                     </view>
+                    <navigationItem key="navigationItem" title="Presenting" id="Ykk-UK-gX0"/>
                     <connections>
                         <outlet property="presentButton" destination="nyn-IW-b3z" id="bZ7-7L-C00"/>
                     </connections>
                 </viewController>
                 <placeholder placeholderIdentifier="IBFirstResponder" id="Ckr-64-9eL" sceneMemberID="firstResponder"/>
             </objects>
-            <point key="canvasLocation" x="58" y="129"/>
+            <point key="canvasLocation" x="996" y="128.18590704647679"/>
         </scene>
-        <!--Presented View Controller-->
+        <!--Presented-->
         <scene sceneID="YQk-Os-YLa">
             <objects>
-                <viewController storyboardIdentifier="PresentedViewController" id="5aQ-jH-G1A" customClass="PresentedViewController" customModule="SpringAnimationController" customModuleProvider="target" sceneMemberID="viewController">
+                <viewController storyboardIdentifier="PresentedViewController" title="Presented" id="5aQ-jH-G1A" customClass="PresentedViewController" customModule="SpringAnimationController_Example" customModuleProvider="target" sceneMemberID="viewController">
                     <view key="view" contentMode="scaleToFill" id="rn3-3u-nMc">
                         <rect key="frame" x="0.0" y="0.0" width="375" height="667"/>
                         <autoresizingMask key="autoresizingMask" widthSizable="YES" heightSizable="YES"/>
-                        <subviews>
-                            <navigationBar contentMode="scaleToFill" translatesAutoresizingMaskIntoConstraints="NO" id="VBS-dl-lL6">
-                                <rect key="frame" x="0.0" y="0.0" width="375" height="44"/>
-                                <items>
-                                    <navigationItem title="Title" id="qaP-qK-Vz9">
-                                        <barButtonItem key="leftBarButtonItem" title="Close" id="Cc7-P1-bWf">
-                                            <connections>
-                                                <action selector="close:" destination="5aQ-jH-G1A" id="fns-HL-6rA"/>
-                                            </connections>
-                                        </barButtonItem>
-                                    </navigationItem>
-                                </items>
-                            </navigationBar>
-                        </subviews>
                         <color key="backgroundColor" red="0.60392156860000001" green="0.27450980390000002" blue="0.81960784310000001" alpha="1" colorSpace="calibratedRGB"/>
-                        <constraints>
-                            <constraint firstItem="VBS-dl-lL6" firstAttribute="trailing" secondItem="KBe-yB-s40" secondAttribute="trailing" id="Dp6-qS-AgP"/>
-                            <constraint firstItem="VBS-dl-lL6" firstAttribute="leading" secondItem="KBe-yB-s40" secondAttribute="leading" id="JCx-bB-MC8"/>
-                            <constraint firstItem="VBS-dl-lL6" firstAttribute="top" secondItem="rn3-3u-nMc" secondAttribute="top" id="pUn-o0-61z"/>
-                        </constraints>
                         <viewLayoutGuide key="safeArea" id="KBe-yB-s40"/>
                     </view>
+                    <navigationItem key="navigationItem" title="Presented" id="7uG-Lq-xnj">
+                        <barButtonItem key="leftBarButtonItem" title="Done" id="rjw-hG-t8s">
+                            <connections>
+                                <action selector="close:" destination="5aQ-jH-G1A" id="fX8-q1-GHz"/>
+                            </connections>
+                        </barButtonItem>
+                    </navigationItem>
                     <connections>
-                        <outlet property="closeBarButtonItem" destination="Cc7-P1-bWf" id="JET-dI-Jd4"/>
+                        <outlet property="closeBarButtonItem" destination="rjw-hG-t8s" id="LU8-vq-uXl"/>
                     </connections>
                 </viewController>
                 <placeholder placeholderIdentifier="IBFirstResponder" id="Z1L-TD-S68" userLabel="First Responder" sceneMemberID="firstResponder"/>
             </objects>
-            <point key="canvasLocation" x="780" y="128"/>
+            <point key="canvasLocation" x="2452" y="126.38680659670166"/>
+        </scene>
+        <!--Navigation Controller-->
+        <scene sceneID="XzB-ub-cUf">
+            <objects>
+                <navigationController storyboardIdentifier="PresentedViewControllerNavigationController" automaticallyAdjustsScrollViewInsets="NO" id="7Zc-nO-qTG" sceneMemberID="viewController">
+                    <toolbarItems/>
+                    <navigationBar key="navigationBar" contentMode="scaleToFill" insetsLayoutMarginsFromSafeArea="NO" id="rnF-12-xth">
+                        <rect key="frame" x="0.0" y="20" width="375" height="44"/>
+                        <autoresizingMask key="autoresizingMask"/>
+                    </navigationBar>
+                    <nil name="viewControllers"/>
+                    <connections>
+                        <segue destination="5aQ-jH-G1A" kind="relationship" relationship="rootViewController" id="jOw-yU-Qi8"/>
+                    </connections>
+                </navigationController>
+                <placeholder placeholderIdentifier="IBFirstResponder" id="X2g-jS-hcY" userLabel="First Responder" sceneMemberID="firstResponder"/>
+            </objects>
+            <point key="canvasLocation" x="1719.2" y="127.28635682158921"/>
+        </scene>
+        <!--Navigation Controller-->
+        <scene sceneID="40C-vr-8jv">
+            <objects>
+                <navigationController automaticallyAdjustsScrollViewInsets="NO" id="V4X-9O-Iwd" sceneMemberID="viewController">
+                    <toolbarItems/>
+                    <navigationBar key="navigationBar" contentMode="scaleToFill" insetsLayoutMarginsFromSafeArea="NO" id="Wqn-5O-w7S">
+                        <rect key="frame" x="0.0" y="20" width="375" height="44"/>
+                        <autoresizingMask key="autoresizingMask"/>
+                    </navigationBar>
+                    <nil name="viewControllers"/>
+                    <connections>
+                        <segue destination="r9E-DI-q2Y" kind="relationship" relationship="rootViewController" id="2p2-CK-xWO"/>
+                    </connections>
+                </navigationController>
+                <placeholder placeholderIdentifier="IBFirstResponder" id="3dJ-c6-NNB" userLabel="First Responder" sceneMemberID="firstResponder"/>
+            </objects>
+            <point key="canvasLocation" x="56.799999999999997" y="128.18590704647679"/>
         </scene>
     </scenes>
 </document>

Example/SpringAnimationController/PresentedViewController.swift

@@ -15,7 +15,6 @@ class PresentedViewController: UIViewController {
     override func viewDidLoad() {
         super.viewDidLoad()
 
-        // Do any additional setup after loading the view.
     }
 
     @IBAction func close(_ sender: UIBarButtonItem) {

Example/SpringAnimationController/ViewController.swift

@@ -21,7 +21,7 @@ class ViewController: UIViewController {
     @IBAction func presentViewController(_ sender: UIButton) {
 
         let storyboard = UIStoryboard(name: "Main", bundle: nil)
-        guard let presentedViewController = storyboard.instantiateViewController(withIdentifier: "PresentedViewController") as? PresentedViewController else {
+        guard let presentedViewController = storyboard.instantiateViewController(withIdentifier: "PresentedViewControllerNavigationController") as? UINavigationController else {
             return
         }
 

README.md

@@ -1,17 +1,60 @@
 # SpringAnimationController
 
-[![CI Status](https://img.shields.io/travis/pietrorea/SpringAnimationController.svg?style=flat)](https://travis-ci.org/pietrorea/SpringAnimationController)
 [![Version](https://img.shields.io/cocoapods/v/SpringAnimationController.svg?style=flat)](https://cocoapods.org/pods/SpringAnimationController)
 [![License](https://img.shields.io/cocoapods/l/SpringAnimationController.svg?style=flat)](https://cocoapods.org/pods/SpringAnimationController)
 [![Platform](https://img.shields.io/cocoapods/p/SpringAnimationController.svg?style=flat)](https://cocoapods.org/pods/SpringAnimationController)
 
+`SpringAnimationController` provides a subtle way to spice up the default modal presentation style on iOS using spring animations. Simply implement the `UIViewControllerTransitioningDelegate`  protocol and return this animation controller to add some bounce at the top of your modal presentation.
+
+![Demo](https://user-images.githubusercontent.com/1264371/41214965-f2636130-6d1b-11e8-8ac3-5e415d56664c.gif)
+
+## Usage
+
+First, set up the view controller that you want to present modally and trigger the model presentation as you normally would.
+
+```swift
+let viewControllerToPresent = PresentedViewController()
+viewControllerToPresent.transitioningDelegate = self
+viewControllerToPresent.modalPresentationStyle = .custom
+
+present(viewControllerToPresent, animated: true)
+```
+
+Next, implement `UIViewControllerTransitioningDelegate`  to return an instance of `SpringyAnimationController`
+
+```swift
+func animationController(forPresented presented: UIViewController,
+presenting: UIViewController,
+source: UIViewController) -> UIViewControllerAnimatedTransitioning? {
+
+    let bouncyTransition = SpringAnimationController(isPresenting: true)
+    return bouncyTransition
+}
+
+func animationController(forDismissed dismissed: UIViewController) -> UIViewControllerAnimatedTransitioning? {
+
+    let bouncyTransition = SpringAnimationController(isPresenting: false)
+    return bouncyTransition
+}
+```
+You can also customize the animation duration, spring damping and spring velocity before returning the animation controller.
+
+```swift
+let bouncyTransition = SpringAnimationController(isPresenting: true)
+bouncyTransition.transitionDuration = 0.35
+bouncyTransition.springDamping = 0.5
+bouncyTransition.springVelocity = 0.7
+```
+
 ## Example
 
-To run the example project, clone the repo, and run `pod install` from the Example directory first.
+To run the example project,  simply run `pod try SpringAnimationController` .
 
 ## Requirements
 
-## Installation
+iOS 10 and above
+
+## Installation Instructions
 
 SpringAnimationController is available through [CocoaPods](https://cocoapods.org). To install
 it, simply add the following line to your Podfile:
@@ -20,10 +63,6 @@ it, simply add the following line to your Podfile:
 pod 'SpringAnimationController'
 ```
 
-## Author
-
-pietrorea, pietro@sweetpeamobile.com
-
 ## License
 
 SpringAnimationController is available under the MIT license. See the LICENSE file for more info.

SpringAnimationController.podspec

@@ -18,7 +18,7 @@ Pod::Spec.new do |s|
   s.license          = { :type => 'MIT', :file => 'LICENSE' }
   s.author           = { 'pietrorea' => 'pietro@sweetpeamobile.com' }
   s.social_media_url = 'https://twitter.com/pietrorea'
-  s.source           = { :git => 'https://github.com/pietrorea/SpringAnimationController.git', :branch => s.version.to_s }
+  s.source           = { :git => 'https://github.com/pietrorea/SpringAnimationController.git', :tag => s.version.to_s }
   s.ios.deployment_target = '10.0'
   s.swift_version = '4.1'
 

SpringAnimationController/Classes/SpringAnimationController.swift

@@ -1,33 +1,39 @@
 //
-//  BouncyTransition.swift
-//  BouncyTransition
+//  SpringAnimationController.swift
+//  SpringAnimationController
 //
 //  Created by Pietro Rea on 6/8/18.
 //  Copyright © 2018 Pietro Rea. All rights reserved.
 //
 
 import UIKit
 
+/// The `SpringAnimationController` class. It conforms to `UIViewControllerAnimatedTransitioning` and plugs into the custom view controller transition infrastructure provided by iOS.
 public class SpringAnimationController: NSObject {
 
     private static let defaultTransitionDuration: TimeInterval = 0.45
-    private static let defaultDelay: TimeInterval = 0.0
     private static let defaultSpringDamping: CGFloat = 0.70
     private static let defaultInitialSpringVelocity: CGFloat = 0.9
 
-    private let isPresenting: Bool
+    /// Determines how long the animation will take. Defaults to 0.45 seconds.
+    public var transitionDuration: TimeInterval = SpringAnimationController.defaultTransitionDuration
 
-    var transitionDuration: TimeInterval = SpringAnimationController.defaultTransitionDuration
-    var delay: TimeInterval = SpringAnimationController.defaultDelay
-    var springDamping: CGFloat = SpringAnimationController.defaultSpringDamping
-    var springVelocity: CGFloat = SpringAnimationController.defaultInitialSpringVelocity
+    /// Determines how smoothly the spring animation will decelerate to its final position. If `springDamping` is 1, there will be no bouncing. Damping ratios less than 1 will oscillate more and more before coming to a complete stop. The default value is 0.7. Only supported if `isPresenting` is true.
+    public var springDamping: CGFloat = SpringAnimationController.defaultSpringDamping
 
+    /// Determines how fast the view controller was traveling upwards before attaching to the invisible spring at the top of the screen. Higher velocities will result in more oscillation. The default value is 0.9. Only supported if `isPresenting` is true.
+    public var springVelocity: CGFloat = SpringAnimationController.defaultInitialSpringVelocity
+
+    let isPresenting: Bool
+
+    /// Designated initializer for the class.
+    ///
+    /// - Parameter isPresenting: True if the view controller is being presented (upwards animation). False if the view controller is being dismissed (downwards animation). Spring-like bouncing is only supported if `isPresenting` is true.
     public init(isPresenting: Bool) {
         self.isPresenting = isPresenting
     }
 }
 
-
 extension SpringAnimationController: UIViewControllerAnimatedTransitioning {
 
     public func transitionDuration(using transitionContext: UIViewControllerContextTransitioning?) -> TimeInterval {
@@ -49,7 +55,7 @@ extension SpringAnimationController: UIViewControllerAnimatedTransitioning {
             newFrame.origin.y = presentedVC.view.frame.size.height
             presentedVC.view.frame = newFrame
 
-            UIView.animate(withDuration: transitionDuration(using: transitionContext), delay: delay, usingSpringWithDamping: springDamping, initialSpringVelocity: springVelocity,  options: [], animations: {
+            UIView.animate(withDuration: transitionDuration(using: transitionContext), delay: 0.0, usingSpringWithDamping: springDamping, initialSpringVelocity: springVelocity,  options: [], animations: {
 
                 let finalFrame = transitionContext.finalFrame(for: presentedVC)
                 presentedVC.view.frame = finalFrame