Tidy up

Re-order var / funcs
Add some comments
Rename closure vars
Add notification example to harness app
Update README

Signed-off-by: Ashley Mills <ashleymills@mac.com>

README.md

@@ -14,24 +14,48 @@ To get around this, this reachability replacement uses an `NSTimer` firing at 1/
 
 Just drop the **Reachability.swift** file into your project. That's it!
 
-## Example
+## Example - closures
 
     let reachability = Reachability.reachabilityForInternetConnection()
 
-    reachability.reachableBlock = { reachability in
+    reachability.whenReachable = { reachability in
         if reachability.isReachableViaWiFi() {
             println("Reachable via WiFi")
         } else {
             println("Reachable via Cellular")
         }
     }
-    reachability.unreachableBlock = { reachability in
+    reachability.whenUnreachable = { reachability in
         println("Not reachable")
     }
 
     reachability.startNotifier()
 
-## Let me know
+## Example - notifications
+
+    let reachability = Reachability.reachabilityForInternetConnection()
+
+    NSNotificationCenter.defaultCenter().addObserver(self, selector: "reachabilityChanged:", name: ReachabilityChangedNotification, object: reachability)
+
+and
+
+    func reachabilityChanged(note: NSNotification) {
+
+        let reachability = note.object as Reachability
+
+        if reachability.isReachable() {
+            if reachability.isReachableViaWiFi() {
+                println("Reachable via WiFi")
+            } else {
+                println("Reachable via Cellular")
+            }
+        } else {
+            println("Not reachable")
+        }
+    }
+
+
+## Let me know!
 
 If you use **Reachability.swift**, please let me know… and tell your friends! 
 

Reachability Sample/Reachability Sample/ViewController.swift

@@ -8,6 +8,8 @@
 
 import UIKit
 
+let useClosures = false
+
 class ViewController: UIViewController {
 
     @IBOutlet weak var networkStatus: UILabel!
@@ -17,15 +19,20 @@ class ViewController: UIViewController {
     override func viewDidLoad() {
         super.viewDidLoad()
 
-        reachability.reachableBlock = { reachability in
-            self.updateLabelColourWhenReachable(reachability)
-        }
-        reachability.unreachableBlock = { reachability in
-            self.updateLabelColourWhenNotReachable(reachability)
+        if (useClosures) {
+            reachability.whenReachable = { reachability in
+                self.updateLabelColourWhenReachable(reachability)
+            }
+            reachability.whenUnreachable = { reachability in
+                self.updateLabelColourWhenNotReachable(reachability)
+            }
+        } else {
+            NSNotificationCenter.defaultCenter().addObserver(self, selector: "reachabilityChanged:", name: ReachabilityChangedNotification, object: reachability)
         }
         
         reachability.startNotifier()
         
+        // Initial reachability check
         if reachability.isReachable() {
             updateLabelColourWhenReachable(reachability)
         } else {
@@ -34,7 +41,12 @@ class ViewController: UIViewController {
     }
     
     deinit {
+
         reachability.stopNotifier()
+        
+        if (!useClosures) {
+            NSNotificationCenter.defaultCenter().removeObserver(self, name: ReachabilityChangedNotification, object: nil)
+        }
     }
     
     func updateLabelColourWhenReachable(reachability: Reachability) {
@@ -53,6 +65,16 @@ class ViewController: UIViewController {
         self.networkStatus.text = reachability.currentReachabilityString
     }
 
+    
+    func reachabilityChanged(note: NSNotification) {
+        let reachability = note.object as Reachability
+        
+        if reachability.isReachable() {
+            updateLabelColourWhenReachable(reachability)
+        } else {
+            updateLabelColourWhenNotReachable(reachability)
+        }
+    }
 }
 
 

Reachability.swift

@@ -34,34 +34,47 @@ class Reachability: NSObject, Printable {
     
     typealias NetworkReachable = (Reachability) -> ()
     typealias NetworkUneachable = (Reachability) -> ()
-    
-    enum NetworkStatus {
-        // Apple NetworkStatus Compatible Names.
+
+    enum NetworkStatus: Printable {
+        
         case NotReachable, ReachableViaWiFi, ReachableViaWWAN
+        
+        var description: String {
+            switch self {
+            case .ReachableViaWWAN:
+                return "Cellular"
+            case .ReachableViaWiFi:
+                return "WiFi"
+            case .NotReachable:
+                return "No Connection"
+            }
+        }
     }
     
-    var isRunningOnDevice: Bool = {
-        #if (arch(i386) || arch(x86_64)) && os(iOS)
-            return false
-            #else
-            return true
-        #endif
-        }()
+    // MARK: - *** Public properties ***
     
-    private var reachabilityRef: SCNetworkReachability?
-    //    private var reachabilitySerialQueue: dispatch_queue_t?
-    private var reachabilityObject: AnyObject?
-    var reachableBlock: NetworkReachable?
-    var unreachableBlock: NetworkUneachable?
+    var whenReachable: NetworkReachable?
+    var whenUnreachable: NetworkUneachable?
     var reachableOnWWAN: Bool
-    private var timer: NSTimer?
-    private var previousReachabilityFlags: SCNetworkReachabilityFlags?
+
+    var currentReachabilityStatus: NetworkStatus {
+        if isReachable() {
+            if isReachableViaWiFi() {
+                return .ReachableViaWiFi
+            }
+            if isRunningOnDevice {
+                return .ReachableViaWWAN;
+            }
+        }
+        
+        return .NotReachable
+    }
     
-    init(reachabilityRef: SCNetworkReachability) {
-        reachableOnWWAN = true;
-        self.reachabilityRef = reachabilityRef;
+    var currentReachabilityString: String {
+        return "\(currentReachabilityStatus)"
     }
     
+    // MARK: - *** Initialisation methods ***
     convenience init(hostname: String) {
         let ref = SCNetworkReachabilityCreateWithName(nil, (hostname as NSString).UTF8String).takeRetainedValue()
         self.init(reachabilityRef: ref)
@@ -94,6 +107,7 @@ class Reachability: NSObject, Printable {
         return Reachability(reachabilityRef: ref)
     }
     
+    // MARK: - *** Notifier methods ***
     func startNotifier() -> Bool {
         
         reachabilityObject = self
@@ -113,6 +127,70 @@ class Reachability: NSObject, Printable {
         timer = nil;
     }
     
+    // MARK: - *** Connection test methods ***
+    func isReachable() -> Bool {
+        return isReachableWithTest({ (flags: SCNetworkReachabilityFlags) -> (Bool) in
+            return self.isReachableWithFlags(flags)
+        })
+    }
+    
+    func isReachableViaWWAN() -> Bool {
+        
+        if isRunningOnDevice {
+            return isReachableWithTest() { flags -> Bool in
+                // Check we're REACHABLE
+                if self.isReachable(flags) {
+                    
+                    // Now, check we're on WWAN
+                    if self.isOnWWAN(flags) {
+                        return true
+                    }
+                }
+                return false
+            }
+        }
+        return false
+    }
+    
+    func isReachableViaWiFi() -> Bool {
+        
+        return isReachableWithTest() { flags -> Bool in
+            
+            // Check we're reachable
+            if self.isReachable(flags) {
+                
+                if self.isRunningOnDevice {
+                    // Check we're NOT on WWAN
+                    if self.isOnWWAN(flags) {
+                        return false
+                    }
+                }
+                return true
+            }
+            
+            return false
+        }
+    }
+    
+    // MARK: - *** Private methods ***
+    private var isRunningOnDevice: Bool = {
+        #if (arch(i386) || arch(x86_64)) && os(iOS)
+            return false
+            #else
+            return true
+        #endif
+        }()
+    
+    private var reachabilityRef: SCNetworkReachability?
+    private var reachabilityObject: AnyObject?
+    private var timer: NSTimer?
+    private var previousReachabilityFlags: SCNetworkReachabilityFlags?
+    
+    private init(reachabilityRef: SCNetworkReachability) {
+        reachableOnWWAN = true;
+        self.reachabilityRef = reachabilityRef;
+    }
+    
     func timerFired(timer: NSTimer) {
         
         let currentReachabilityFlags = reachabilityFlags
@@ -124,21 +202,18 @@ class Reachability: NSObject, Printable {
         }
     }
     
-    func reachabilityChanged(flags: SCNetworkReachabilityFlags) {
+    private func reachabilityChanged(flags: SCNetworkReachabilityFlags) {
         if isReachableWithFlags(flags) {
-            if let block = reachableBlock {
+            if let block = whenReachable {
                 block(self)
             }
         } else {
-            if let block = unreachableBlock {
+            if let block = whenUnreachable {
                 block(self)
             }
         }
         
-        // this makes sure the change notification happens on the MAIN THREAD
-        dispatch_async(dispatch_get_main_queue()) {
-            NSNotificationCenter.defaultCenter().postNotificationName(ReachabilityChangedNotification, object:self)
-        }
+        NSNotificationCenter.defaultCenter().postNotificationName(ReachabilityChangedNotification, object:self)
     }
     
     private func isReachableWithFlags(flags: SCNetworkReachabilityFlags) -> Bool {
@@ -173,50 +248,6 @@ class Reachability: NSObject, Printable {
         return false
     }
     
-    func isReachable() -> Bool {
-        return isReachableWithTest({ (flags: SCNetworkReachabilityFlags) -> (Bool) in
-            return self.isReachableWithFlags(flags)
-        })
-    }
-    
-    func isReachableViaWWAN() -> Bool {
-        
-        if isRunningOnDevice {
-            return isReachableWithTest() { flags -> Bool in
-                // Check we're REACHABLE
-                if self.isReachable(flags) {
-                    
-                    // Now, check we're on WWAN
-                    if self.isOnWWAN(flags) {
-                        return true
-                    }
-                }
-                return false
-            }
-        }
-        return false
-    }
-    
-    func isReachableViaWiFi() -> Bool {
-        
-        return isReachableWithTest() { flags -> Bool in
-            
-            // Check we're reachable
-            if self.isReachable(flags) {
-                
-                if self.isRunningOnDevice {
-                    // Check we're NOT on WWAN
-                    if self.isOnWWAN(flags) {
-                        return false
-                    }
-                }
-                return true
-            }
-            
-            return false
-        }
-    }
-    
     // WWAN may be available, but not active until a connection has been established.
     // WiFi may require a connection for VPN on Demand.
     private func isConnectionRequired() -> Bool {
@@ -278,21 +309,6 @@ class Reachability: NSObject, Printable {
         return flags & testcase == testcase
     }
     
-    // MARK: - *** xx methods ***
-    
-    var currentReachabilityStatus: NetworkStatus {
-        if isReachable() {
-            if isReachableViaWiFi() {
-                return .ReachableViaWiFi
-            }
-            if isRunningOnDevice {
-                return .ReachableViaWWAN;
-            }
-        }
-        
-        return .NotReachable
-    }
-    
     private var reachabilityFlags: SCNetworkReachabilityFlags {
         var flags: SCNetworkReachabilityFlags = 0
         let gotFlags = SCNetworkReachabilityGetFlags(reachabilityRef, &flags) != 0
@@ -303,18 +319,6 @@ class Reachability: NSObject, Printable {
         return 0
     }
     
-    var currentReachabilityString: String {
-        
-        switch currentReachabilityStatus {
-        case .ReachableViaWWAN:
-            return NSLocalizedString("Cellular", comment: "")
-        case .ReachableViaWiFi:
-            return NSLocalizedString("WiFi", comment: "")
-        case .NotReachable:
-            return NSLocalizedString("No Connection", comment: "");
-        }
-    }
-    
     override var description: String {
         
         var W: String
@@ -339,8 +343,8 @@ class Reachability: NSObject, Printable {
         stopNotifier()
         
         reachabilityRef = nil
-        reachableBlock = nil
-        unreachableBlock = nil
+        whenReachable = nil
+        whenUnreachable = nil
     }
 }