Merge branch 'release/2.0.3'

Author: Alexander Perechnev

CHANGELOG.md

@@ -1,3 +1,8 @@
+# 2.0.3
+
+* `UIViewController` class extension moved to a new file and fully documented
+* Documentation for a few properties of `SOContainerViewController`
+
 # 2.0.2
 
 * Code improvements for `UIViewController` class extension

SidebarOverlay.podspec

@@ -1,14 +1,14 @@
 Pod::Spec.new do |s|
   s.name         = "SidebarOverlay"
-  s.version      = "2.0.2"
+  s.version      = "2.0.3"
   s.summary      = "Yet another implementation of sidebar menu, but here your menu appears over the top view controller."
 
   s.description  = "Yet another implementation of sidebar menu, but here your menu appears over the top view controller. You questions and pull requests are wolcome."
 
   s.homepage     = "https://github.com/alexkrzyzanowski/SidebarOverlay"
   s.license      = { :type => 'MIT', :file => 'LICENSE' }
   s.author       = { "Alex Krzyzanowski" => "alexkrzyzanowski@icloud.com" }
-  s.source       = { :git => "https://github.com/alexkrzyzanowski/SidebarOverlay.git", :tag => "2.0.2" }
+  s.source       = { :git => "https://github.com/alexkrzyzanowski/SidebarOverlay.git", :tag => "2.0.3" }
 
   s.platform     = :ios, '8.0'
   s.source_files = 'SidebarOverlay/SidebarOverlay/*.{h,m,swift}'

SidebarOverlay/SidebarOverlay.xcodeproj/project.pbxproj

@@ -7,6 +7,7 @@
 	objects = {
 
 /* Begin PBXBuildFile section */
+		320B85EB1C5E2612003A6736 /* UIViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 320B85EA1C5E2612003A6736 /* UIViewController.swift */; };
 		322EAC131C2B3F820077D684 /* SidebarOverlay.h in Headers */ = {isa = PBXBuildFile; fileRef = 322EAC121C2B3F820077D684 /* SidebarOverlay.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		322EAC1A1C2B3F820077D684 /* SidebarOverlay.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 322EAC0F1C2B3F820077D684 /* SidebarOverlay.framework */; };
 		322EAC2B1C2B40420077D684 /* SOContainerViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 322EAC2A1C2B40420077D684 /* SOContainerViewController.swift */; };
@@ -24,6 +25,7 @@
 /* End PBXContainerItemProxy section */
 
 /* Begin PBXFileReference section */
+		320B85EA1C5E2612003A6736 /* UIViewController.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = UIViewController.swift; sourceTree = "<group>"; };
 		322EAC0F1C2B3F820077D684 /* SidebarOverlay.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = SidebarOverlay.framework; sourceTree = BUILT_PRODUCTS_DIR; };
 		322EAC121C2B3F820077D684 /* SidebarOverlay.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = SidebarOverlay.h; sourceTree = "<group>"; };
 		322EAC141C2B3F820077D684 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
@@ -76,6 +78,7 @@
 				322EAC121C2B3F820077D684 /* SidebarOverlay.h */,
 				322EAC141C2B3F820077D684 /* Info.plist */,
 				322EAC2A1C2B40420077D684 /* SOContainerViewController.swift */,
+				320B85EA1C5E2612003A6736 /* UIViewController.swift */,
 			);
 			path = SidebarOverlay;
 			sourceTree = "<group>";
@@ -198,6 +201,7 @@
 			isa = PBXSourcesBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				320B85EB1C5E2612003A6736 /* UIViewController.swift in Sources */,
 				322EAC2B1C2B40420077D684 /* SOContainerViewController.swift in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;

SidebarOverlay/SidebarOverlay/Info.plist

@@ -15,7 +15,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>2.0.2</string>
+	<string>2.0.3</string>
 	<key>CFBundleSignature</key>
 	<string>????</string>
 	<key>CFBundleVersion</key>

SidebarOverlay/SidebarOverlay/SOContainerViewController.swift

@@ -9,35 +9,22 @@
 import UIKit
 
 
-public extension UIViewController {
-    
-    ///
-    /// Use this computed property to access the container view controller from any view controller.
-    ///
-    /// - returns: An instance of `SOContainerViewController` that holds current view controller
-    ///     or `nil` if there is not container view controller.
-    var so_containerViewController: SOContainerViewController? {
-        if self is SOContainerViewController {
-            return self as? SOContainerViewController
-        }
-        if let parentVC = self.parentViewController {
-            return parentVC.so_containerViewController
-        }
-        return nil
-    }
-    
-}
-
-
 public class SOContainerViewController: UIViewController, UIGestureRecognizerDelegate {
 
-    let LeftViewControllerRightIndent: CGFloat = 56.0
-    let LeftViewControllerOpenedLeftOffset: CGFloat = 0.0
-    let SideViewControllerOpenAnimationDuration: NSTimeInterval = 0.24
-    
-    var _topViewController: UIViewController?
-    var _leftViewController: UIViewController?
-    
+    /**
+     A view controller that is currently presented to user.
+     
+     Assign this property to any view controller, that should be presented on the top of your application.
+     
+     In most cases you have to set this property when user selects an item in sidebar menu:
+     
+     ```swift
+     func tableView(tableView: UITableView, didSelectRowAtIndexPath indexPath: NSIndexPath) {
+        let vc = self.storyboard!.instantiateViewControllerWithIdentifier("newsScreen")
+        self.so_containerViewController!.topViewController = vc
+     }
+     ```
+    */
     public var topViewController: UIViewController? {
         get {
             return _topViewController
@@ -61,6 +48,13 @@ public class SOContainerViewController: UIViewController, UIGestureRecognizerDel
         }
     }
 
+    /**
+     A view controller that represents the sidebar menu.
+     
+     A view controller, that is assigned to this property, is hidden under the left edge of the screen. When user makes a left-to-right swipe gesture, it follows the finger and becomes visible.
+     
+     Usually you have to set it only once, when you prepare an instance of `SOContainerViewController` to be presented.
+    */
     public var leftViewController: UIViewController? {
         get {
             return _leftViewController
@@ -113,7 +107,27 @@ public class SOContainerViewController: UIViewController, UIGestureRecognizerDel
         }
     }
 
-    public func moveMenu(panGesture: UIPanGestureRecognizer) {
+    //
+    // MARK: Gesture recognizer delegate
+    
+    public func gestureRecognizerShouldBegin(gestureRecognizer: UIGestureRecognizer) -> Bool {
+        let panGestureRecognizer = gestureRecognizer as! UIPanGestureRecognizer
+        let translation = panGestureRecognizer.translationInView(self.view)
+        return self.vectorIsMoreHorizontal(translation)
+    }
+    
+    //
+    // MARK: Internal usage
+    
+    let LeftViewControllerRightIndent: CGFloat = 56.0
+    let LeftViewControllerOpenedLeftOffset: CGFloat = 0.0
+    let SideViewControllerOpenAnimationDuration: NSTimeInterval = 0.24
+    
+    var _topViewController: UIViewController?
+    var _leftViewController: UIViewController?
+    
+    
+    func moveMenu(panGesture: UIPanGestureRecognizer) {
         panGesture.view?.layer.removeAllAnimations()
 
         let translatedPoint = panGesture.translationInView(self.view)
@@ -132,15 +146,6 @@ public class SOContainerViewController: UIViewController, UIGestureRecognizerDel
         }
     }
 
-    public func gestureRecognizerShouldBegin(gestureRecognizer: UIGestureRecognizer) -> Bool {
-        let panGestureRecognizer = gestureRecognizer as! UIPanGestureRecognizer
-        let translation = panGestureRecognizer.translationInView(self.view)
-        return self.vectorIsMoreHorizontal(translation)
-    }
-    
-    //
-    // MARK: Internal usage
-    
     func brindLeftViewToFront() {
         if let vc = self.leftViewController {
             self.view.bringSubviewToFront(vc.view)

SidebarOverlay/SidebarOverlay/UIViewController.swift

@@ -0,0 +1,32 @@
+//
+//  UIViewController.swift
+//  SidebarOverlay
+//
+//  Created by Alex Krzyżanowski on 31.01.16.
+//  Copyright © 2016 Alex Krzyżanowski. All rights reserved.
+//
+
+import UIKit
+
+
+/**
+ The `UIViewController` class is extended to be compatible with `SidebarOverlay`.
+*/
+public extension UIViewController {
+    
+    /**
+     Use this computed property to access the container view controller from any view controller.
+     
+     - returns: An instance of `SOContainerViewController` that holds current view controller or `nil` if there is no container view controller.
+    */
+    var so_containerViewController: SOContainerViewController? {
+        if self is SOContainerViewController {
+            return self as? SOContainerViewController
+        }
+        if let parentVC = self.parentViewController {
+            return parentVC.so_containerViewController
+        }
+        return nil
+    }
+    
+}