change socketparser into a protocol

nuclearace · nuclearace · commit fe02b8eff21e · 2016-01-03T13:11:18.000-05:00
diff --git a/Socket.IO-Client-Swift.xcodeproj/project.pbxproj b/Socket.IO-Client-Swift.xcodeproj/project.pbxproj
diff --git a/Socket.IO-Client-Swift.xcodeproj/xcshareddata/xcschemes/SocketIO-Mac.xcscheme b/Socket.IO-Client-Swift.xcodeproj/xcshareddata/xcschemes/SocketIO-Mac.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "0640"
+   LastUpgradeVersion = "0720"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"
diff --git a/Socket.IO-Client-Swift.xcodeproj/xcshareddata/xcschemes/SocketIO-iOS.xcscheme b/Socket.IO-Client-Swift.xcodeproj/xcshareddata/xcschemes/SocketIO-iOS.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "0640"
+   LastUpgradeVersion = "0720"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"
diff --git a/Socket.IO-Client-Swift.xcodeproj/xcshareddata/xcschemes/SocketIO-tvOS.xcscheme b/Socket.IO-Client-Swift.xcodeproj/xcshareddata/xcschemes/SocketIO-tvOS.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "0710"
+   LastUpgradeVersion = "0720"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"
diff --git a/SocketIO-Mac/Info.plist b/SocketIO-Mac/Info.plist
@@ -7,7 +7,7 @@
 	<key>CFBundleExecutable</key>
 	<string>$(EXECUTABLE_NAME)</string>
 	<key>CFBundleIdentifier</key>
-	<string>io.socket.$(PRODUCT_NAME:rfc1034identifier)</string>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
 	<key>CFBundleInfoDictionaryVersion</key>
 	<string>6.0</string>
 	<key>CFBundleName</key>
diff --git a/SocketIO-MacTests/Info.plist b/SocketIO-MacTests/Info.plist
@@ -7,7 +7,7 @@
 	<key>CFBundleExecutable</key>
 	<string>$(EXECUTABLE_NAME)</string>
 	<key>CFBundleIdentifier</key>
-	<string>io.socket.$(PRODUCT_NAME:rfc1034identifier)</string>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
 	<key>CFBundleInfoDictionaryVersion</key>
 	<string>6.0</string>
 	<key>CFBundleName</key>
diff --git a/SocketIO-MacTests/SocketParserTest.swift b/SocketIO-MacTests/SocketParserTest.swift
@@ -10,6 +10,7 @@ import XCTest
 @testable import SocketIO
 
 class SocketParserTest: XCTestCase {
+    let testSocket = SocketIOClient(socketURL: "")
     
     //Format key: message; namespace-data-binary-id
     static let packetTypes: Dictionary<String, (String, [AnyObject], [NSData], Int)> = [
@@ -93,7 +94,7 @@ class SocketParserTest: XCTestCase {
     
     func testInvalidInput() {
         let message = "8"
-        switch SocketParser.parseString(message) {
+        switch testSocket.parseString(message) {
         case .Left(_):
             return
         case .Right(_):
@@ -111,7 +112,7 @@ class SocketParserTest: XCTestCase {
     
     func validateParseResult(message: String) {
         let validValues = SocketParserTest.packetTypes[message]!
-        let packet = SocketParser.parseString(message)
+        let packet = testSocket.parseString(message)
         let type = message.substringWithRange(Range<String.Index>(start: message.startIndex, end: message.startIndex.advancedBy(1)))
         if case let .Right(packet) = packet {
             XCTAssertEqual(packet.type, SocketPacket.PacketType(rawValue: Int(type) ?? -1)!)
@@ -128,7 +129,7 @@ class SocketParserTest: XCTestCase {
         let keys = Array(SocketParserTest.packetTypes.keys)
         measureBlock({
             for item in keys.enumerate() {
-                SocketParser.parseString(item.element)
+                self.testSocket.parseString(item.element)
             }
         })
     }
diff --git a/SocketIO-iOS/Info.plist b/SocketIO-iOS/Info.plist
@@ -7,7 +7,7 @@
 	<key>CFBundleExecutable</key>
 	<string>$(EXECUTABLE_NAME)</string>
 	<key>CFBundleIdentifier</key>
-	<string>io.socket.$(PRODUCT_NAME:rfc1034identifier)</string>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
 	<key>CFBundleInfoDictionaryVersion</key>
 	<string>6.0</string>
 	<key>CFBundleName</key>
diff --git a/SocketIO-iOSTests/Info.plist b/SocketIO-iOSTests/Info.plist
@@ -7,7 +7,7 @@
 	<key>CFBundleExecutable</key>
 	<string>$(EXECUTABLE_NAME)</string>
 	<key>CFBundleIdentifier</key>
-	<string>io.socket.$(PRODUCT_NAME:rfc1034identifier)</string>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
 	<key>CFBundleInfoDictionaryVersion</key>
 	<string>6.0</string>
 	<key>CFBundleName</key>
diff --git a/Source/SocketClientSpec.swift b/Source/SocketClientSpec.swift
@@ -0,0 +1,37 @@
+//
+//  SocketClientSpec.swift
+//  Socket.IO-Client-Swift
+//
+//  Created by Erik Little on 1/3/16.
+//
+//  Permission is hereby granted, free of charge, to any person obtaining a copy
+//  of this software and associated documentation files (the "Software"), to deal
+//  in the Software without restriction, including without limitation the rights
+//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  copies of the Software, and to permit persons to whom the Software is
+//  furnished to do so, subject to the following conditions:
+//
+//  The above copyright notice and this permission notice shall be included in
+//  all copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+//  THE SOFTWARE.
+
+import Foundation
+
+protocol SocketClientSpec: class {
+    var nsp: String { get set }
+    var waitingData: [SocketPacket] { get set }
+    
+    func didConnect()
+    func didDisconnect(reason: String)
+    func didError(reason: AnyObject)
+    func handleAck(ack: Int, data: [AnyObject])
+    func handleEvent(event: String, data: [AnyObject], isInternalMessage: Bool, withAck ack: Int)
+    func joinNamespace(namespace: String)
+}
diff --git a/Source/SocketEngine.swift b/Source/SocketEngine.swift
@@ -154,7 +154,7 @@ public final class SocketEngine: NSObject, SocketEngineSpec, WebSocketDelegate {
 
             if let data = NSData(base64EncodedString: noPrefix,
                 options: .IgnoreUnknownCharacters) {
-                    client?.parseBinaryData(data)
+                    client?.parseEngineBinaryData(data)
             }
             
             return true
@@ -299,7 +299,7 @@ public final class SocketEngine: NSObject, SocketEngineSpec, WebSocketDelegate {
     }
 
     private func handleMessage(message: String) {
-        client?.parseSocketMessage(message)
+        client?.parseEngineMessage(message)
     }
 
     private func handleNOOP() {
@@ -414,7 +414,7 @@ public final class SocketEngine: NSObject, SocketEngineSpec, WebSocketDelegate {
 
     private func parseEngineData(data: NSData) {
         DefaultSocketLogger.Logger.log("Got binary data: %@", type: "SocketEngine", args: data)
-        client?.parseBinaryData(data.subdataWithRange(NSMakeRange(1, data.length - 1)))
+        client?.parseEngineBinaryData(data.subdataWithRange(NSMakeRange(1, data.length - 1)))
     }
 
     private func parseEngineMessage(message: String, fromPolling: Bool) {
diff --git a/Source/SocketEngineClient.swift b/Source/SocketEngineClient.swift
@@ -28,6 +28,6 @@ import Foundation
 @objc public protocol SocketEngineClient {
     func didError(reason: AnyObject)
     func engineDidClose(reason: String)
-    func parseSocketMessage(msg: String)
-    func parseBinaryData(data: NSData)
+    func parseEngineMessage(msg: String)
+    func parseEngineBinaryData(data: NSData)
 }
diff --git a/Source/SocketIOClient.swift b/Source/SocketIOClient.swift
@@ -24,7 +24,7 @@
 
 import Foundation
 
-public final class SocketIOClient: NSObject, SocketEngineClient {
+public final class SocketIOClient: NSObject, SocketEngineClient, SocketParsable {
     public let socketURL: String
     
     public private(set) var engine: SocketEngineSpec?
@@ -319,13 +319,12 @@ public final class SocketIOClient: NSObject, SocketEngineClient {
     }
     
     // Called when the socket gets an ack for something it sent
-    func handleAck(ack: Int, data: AnyObject?) {
+    func handleAck(ack: Int, data: [AnyObject]) {
         guard status == .Connected else {return}
         
         DefaultSocketLogger.Logger.log("Handling ack: %@ with data: %@", type: logType, args: ack, data ?? "")
         
-        ackHandlers.executeAck(ack,
-            items: (data as? [AnyObject]) ?? (data != nil ? [data!] : []))
+        ackHandlers.executeAck(ack, items: data)
     }
     
     /**
@@ -436,15 +435,16 @@ public final class SocketIOClient: NSObject, SocketEngineClient {
         connect()
     }
     
-    public func parseSocketMessage(msg: String) {
+    public func parseEngineMessage(msg: String) {
+        DefaultSocketLogger.Logger.log("Should parse message", type: "SocketIOClient")
         dispatch_async(parseQueue) {
-            SocketParser.parseSocketMessage(msg, socket: self)
+            self.parseSocketMessage(msg)
         }
     }
     
-    public func parseBinaryData(data: NSData) {
+    public func parseEngineBinaryData(data: NSData) {
         dispatch_async(parseQueue) {
-            SocketParser.parseBinaryData(data, socket: self)
+            self.parseBinaryData(data)
         }
     }
     
diff --git a/Source/SocketParsable.swift b/Source/SocketParsable.swift
@@ -1,5 +1,5 @@
 //
-//  SocketParser.swift
+//  SocketParsable.swift
 //  Socket.IO-Client-Swift
 //
 //  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -22,46 +22,50 @@
 
 import Foundation
 
-class SocketParser {
-    
-    private static func isCorrectNamespace(nsp: String, _ socket: SocketIOClient) -> Bool {
-        return nsp == socket.nsp
-    }
+protocol SocketParsable: class, SocketClientSpec {
+    func parseBinaryData(data: NSData)
+    func parseSocketMessage(message: String)
+}
 
-    private static func handleConnect(p: SocketPacket, socket: SocketIOClient) {
-        if p.nsp == "/" && socket.nsp != "/" {
-            socket.joinNamespace(socket.nsp)
-        } else if p.nsp != "/" && socket.nsp == "/" {
-            socket.didConnect()
+extension SocketParsable {
+    private func isCorrectNamespace(nsp: String) -> Bool {
+        return nsp == self.nsp
+    }
+    
+    private func handleConnect(p: SocketPacket) {
+        if p.nsp == "/" && nsp != "/" {
+            joinNamespace(nsp)
+        } else if p.nsp != "/" && nsp == "/" {
+            didConnect()
         } else {
-            socket.didConnect()
+            didConnect()
         }
     }
     
-    private static func handlePacket(pack: SocketPacket, withSocket socket: SocketIOClient) {
+    private func handlePacket(pack: SocketPacket) {
         switch pack.type {
-        case .Event where isCorrectNamespace(pack.nsp, socket):
-            socket.handleEvent(pack.event, data: pack.args,
+        case .Event where isCorrectNamespace(pack.nsp):
+            handleEvent(pack.event, data: pack.args,
                 isInternalMessage: false, withAck: pack.id)
-        case .Ack where isCorrectNamespace(pack.nsp, socket):
-            socket.handleAck(pack.id, data: pack.data)
-        case .BinaryEvent where isCorrectNamespace(pack.nsp, socket):
-            socket.waitingData.append(pack)
-        case .BinaryAck where isCorrectNamespace(pack.nsp, socket):
-            socket.waitingData.append(pack)
+        case .Ack where isCorrectNamespace(pack.nsp):
+            handleAck(pack.id, data: pack.data)
+        case .BinaryEvent where isCorrectNamespace(pack.nsp):
+            waitingData.append(pack)
+        case .BinaryAck where isCorrectNamespace(pack.nsp):
+            waitingData.append(pack)
         case .Connect:
-            handleConnect(pack, socket: socket)
+            handleConnect(pack)
         case .Disconnect:
-            socket.didDisconnect("Got Disconnect")
+            didDisconnect("Got Disconnect")
         case .Error:
-            socket.didError(pack.data)
+            didError(pack.data)
         default:
             DefaultSocketLogger.Logger.log("Got invalid packet: %@", type: "SocketParser", args: pack.description)
         }
     }
     
     /// Parses a messsage from the engine. Returning either a string error or a complete SocketPacket
-    static func parseString(message: String) -> Either<String, SocketPacket> {
+    func parseString(message: String) -> Either<String, SocketPacket> {
         var parser = SocketStringReader(message: message)
         
         guard let type = SocketPacket.PacketType(rawValue: Int(parser.read(1)) ?? -1) else {
@@ -79,7 +83,7 @@ class SocketParser {
             if let holders = Int(parser.readUntilStringOccurence("-")) {
                 placeholders = holders
             } else {
-               return .Left("Invalid packet")
+                return .Left("Invalid packet")
             }
         }
         
@@ -126,7 +130,7 @@ class SocketParser {
     }
     
     // Parses data for events
-    private static func parseData(data: String) -> Either<String, [AnyObject]> {
+    private func parseData(data: String) -> Either<String, [AnyObject]> {
         let stringData = data.dataUsingEncoding(NSUTF8StringEncoding, allowLossyConversion: false)
         do {
             if let arr = try NSJSONSerialization.JSONObjectWithData(stringData!,
@@ -141,7 +145,7 @@ class SocketParser {
     }
     
     // Parses messages recieved
-    static func parseSocketMessage(message: String, socket: SocketIOClient) {
+    func parseSocketMessage(message: String) {
         guard !message.isEmpty else { return }
         
         DefaultSocketLogger.Logger.log("Parsing %@", type: "SocketParser", args: message)
@@ -151,28 +155,28 @@ class SocketParser {
             DefaultSocketLogger.Logger.error("\(err): %@", type: "SocketParser", args: message)
         case let .Right(pack):
             DefaultSocketLogger.Logger.log("Decoded packet as: %@", type: "SocketParser", args: pack.description)
-            handlePacket(pack, withSocket: socket)
+            handlePacket(pack)
         }
     }
     
-    static func parseBinaryData(data: NSData, socket: SocketIOClient) {
-        guard !socket.waitingData.isEmpty else {
+    func parseBinaryData(data: NSData) {
+        guard !waitingData.isEmpty else {
             DefaultSocketLogger.Logger.error("Got data when not remaking packet", type: "SocketParser")
             return
         }
         
         // Should execute event?
-        guard socket.waitingData[socket.waitingData.count - 1].addData(data) else {
+        guard waitingData[waitingData.count - 1].addData(data) else {
             return
         }
         
-        let packet = socket.waitingData.removeLast()
+        let packet = waitingData.removeLast()
         
         if packet.type != .BinaryAck {
-            socket.handleEvent(packet.event, data: packet.args ?? [],
+            handleEvent(packet.event, data: packet.args ?? [],
                 isInternalMessage: false, withAck: packet.id)
         } else {
-            socket.handleAck(packet.id, data: packet.args)
+            handleAck(packet.id, data: packet.args)
         }
     }
 }
