Rename Extractable to Parsable

Crossroad.xcodeproj/project.pbxproj

@@ -11,16 +11,16 @@
 		07CBB57520B7074B00C272A5 /* ContextTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 07CBB57320B705A600C272A5 /* ContextTests.swift */; };
 		546DEA8420AD77F800923325 /* Crossroad.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 546DEA7A20AD77F800923325 /* Crossroad.framework */; };
 		546DEAB820B0991900923325 /* PatternURL.swift in Sources */ = {isa = PBXBuildFile; fileRef = 546DEAB020B0991800923325 /* PatternURL.swift */; };
-		546DEAB920B0991900923325 /* Extractable.swift in Sources */ = {isa = PBXBuildFile; fileRef = 546DEAB120B0991900923325 /* Extractable.swift */; };
 		546DEABA20B0991900923325 /* Crossroad.h in Headers */ = {isa = PBXBuildFile; fileRef = 546DEAB220B0991900923325 /* Crossroad.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		546DEABB20B0991900923325 /* Context.swift in Sources */ = {isa = PBXBuildFile; fileRef = 546DEAB320B0991900923325 /* Context.swift */; };
 		546DEABD20B0991900923325 /* Router.swift in Sources */ = {isa = PBXBuildFile; fileRef = 546DEAB520B0991900923325 /* Router.swift */; };
 		546DEABE20B0991900923325 /* Route.swift in Sources */ = {isa = PBXBuildFile; fileRef = 546DEAB620B0991900923325 /* Route.swift */; };
 		546DEAC020B0993100923325 /* PatternURLTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 546DEAB420B0991900923325 /* PatternURLTests.swift */; };
 		546DEAC120B0994800923325 /* RouterTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 546DEAAD20B0990500923325 /* RouterTests.swift */; };
-		54AB581620B09AD800E2FD28 /* ExtractableTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 54AB581420B09AD400E2FD28 /* ExtractableTests.swift */; };
 		54AB581820B0AED300E2FD28 /* OpenURLOption.swift in Sources */ = {isa = PBXBuildFile; fileRef = 54AB581720B0AED300E2FD28 /* OpenURLOption.swift */; };
 		54AB581A20B0B29700E2FD28 /* OpenURLOptionTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 54AB581920B0B29700E2FD28 /* OpenURLOptionTests.swift */; };
+		54D5D48722F8013F00317EBF /* Parsable.swift in Sources */ = {isa = PBXBuildFile; fileRef = 54D5D48622F8013E00317EBF /* Parsable.swift */; };
+		54D5D48922F8015500317EBF /* ParsableTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 54D5D48822F8015500317EBF /* ParsableTests.swift */; };
 /* End PBXBuildFile section */
 
 /* Begin PBXContainerItemProxy section */
@@ -41,16 +41,16 @@
 		546DEAAC20B0990500923325 /* Info.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
 		546DEAAD20B0990500923325 /* RouterTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = RouterTests.swift; sourceTree = "<group>"; };
 		546DEAB020B0991800923325 /* PatternURL.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = PatternURL.swift; sourceTree = "<group>"; };
-		546DEAB120B0991900923325 /* Extractable.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Extractable.swift; sourceTree = "<group>"; };
 		546DEAB220B0991900923325 /* Crossroad.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = Crossroad.h; sourceTree = "<group>"; };
 		546DEAB320B0991900923325 /* Context.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Context.swift; sourceTree = "<group>"; };
 		546DEAB420B0991900923325 /* PatternURLTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = PatternURLTests.swift; sourceTree = "<group>"; };
 		546DEAB520B0991900923325 /* Router.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Router.swift; sourceTree = "<group>"; };
 		546DEAB620B0991900923325 /* Route.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Route.swift; sourceTree = "<group>"; };
 		546DEAB720B0991900923325 /* Info.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
-		54AB581420B09AD400E2FD28 /* ExtractableTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ExtractableTests.swift; sourceTree = "<group>"; };
 		54AB581720B0AED300E2FD28 /* OpenURLOption.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OpenURLOption.swift; sourceTree = "<group>"; };
 		54AB581920B0B29700E2FD28 /* OpenURLOptionTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OpenURLOptionTests.swift; sourceTree = "<group>"; };
+		54D5D48622F8013E00317EBF /* Parsable.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Parsable.swift; sourceTree = "<group>"; };
+		54D5D48822F8015500317EBF /* ParsableTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ParsableTests.swift; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
 /* Begin PBXFrameworksBuildPhase section */
@@ -95,10 +95,10 @@
 			children = (
 				546DEAB320B0991900923325 /* Context.swift */,
 				546DEAB220B0991900923325 /* Crossroad.h */,
-				546DEAB120B0991900923325 /* Extractable.swift */,
 				546DEAB720B0991900923325 /* Info.plist */,
 				54AB581720B0AED300E2FD28 /* OpenURLOption.swift */,
 				546DEAB020B0991800923325 /* PatternURL.swift */,
+				54D5D48622F8013E00317EBF /* Parsable.swift */,
 				546DEAB620B0991900923325 /* Route.swift */,
 				546DEAB520B0991900923325 /* Router.swift */,
 				079956D622F0304200FC48CF /* URLParser.swift */,
@@ -111,10 +111,10 @@
 			isa = PBXGroup;
 			children = (
 				07CBB57320B705A600C272A5 /* ContextTests.swift */,
-				54AB581420B09AD400E2FD28 /* ExtractableTests.swift */,
 				546DEAAC20B0990500923325 /* Info.plist */,
 				54AB581920B0B29700E2FD28 /* OpenURLOptionTests.swift */,
 				546DEAB420B0991900923325 /* PatternURLTests.swift */,
+				54D5D48822F8015500317EBF /* ParsableTests.swift */,
 				546DEAAD20B0990500923325 /* RouterTests.swift */,
 			);
 			name = CrossroadTests;
@@ -236,7 +236,7 @@
 				54AB581820B0AED300E2FD28 /* OpenURLOption.swift in Sources */,
 				546DEAB820B0991900923325 /* PatternURL.swift in Sources */,
 				546DEABB20B0991900923325 /* Context.swift in Sources */,
-				546DEAB920B0991900923325 /* Extractable.swift in Sources */,
+				54D5D48722F8013F00317EBF /* Parsable.swift in Sources */,
 				546DEABD20B0991900923325 /* Router.swift in Sources */,
 				546DEABE20B0991900923325 /* Route.swift in Sources */,
 			);
@@ -250,7 +250,7 @@
 				546DEAC120B0994800923325 /* RouterTests.swift in Sources */,
 				546DEAC020B0993100923325 /* PatternURLTests.swift in Sources */,
 				07CBB57520B7074B00C272A5 /* ContextTests.swift in Sources */,
-				54AB581620B09AD800E2FD28 /* ExtractableTests.swift in Sources */,
+				54D5D48922F8015500317EBF /* ParsableTests.swift in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};

README.md

@@ -96,10 +96,10 @@ Currently supported type is `Int`, `Int64`, `Float`, `Double`, `Bool`, `String`
 
 ### Enum argument
 
-You can use enum as arguments by implementing `Extractable`.
+You can use enum as arguments by implementing `Parsable`.
 
 ```swift
-enum Type: String, Extractable {
+enum Type: String, Parsable {
     case normal
     case fire
     case water
@@ -122,16 +122,16 @@ let types: [Type]? = context.parameter(for: "types") // [.water, .grass]
 
 ### Custom argument
 
-You can also define own arguments by implementing `Extractable`.
+You can also define own arguments by implementing `Parsable`.
 This is an example to parse custom struct.
 
 ```swift
 struct User {
     let name: String
 }
-extension User: Extractable {
-    static func extract(from string: String) -> User? {
-        return User(name: string)
+extension User: Parsable {
+    init?(from string: String) {
+        self.name = string
     }
 }
 ```

Sources/Crossroad/Context.swift

@@ -20,29 +20,29 @@ public struct Context<UserInfo> {
         self.userInfo = userInfo
     }
 
-    public func argument<T: Extractable>(for key: String) throws -> T {
+    public func argument<T: Parsable>(for key: String) throws -> T {
         if let argument = arguments[key] {
-            if let value = T.extract(from: argument) {
+            if let value = T(from: argument) {
                 return value
             }
         }
         throw Error.parsingArgumentFailed
     }
 
-    public func parameter<T: Extractable>(for key: String) -> T? {
+    public func parameter<T: Parsable>(for key: String) -> T? {
         if let queryItem = queryItem(from: key) {
             if let queryValue = queryItem.value,
-                let value = T.extract(from: queryValue) {
+                let value = T(from: queryValue) {
                 return value
             }
         }
         return nil
     }
 
-    public func parameter<T: Extractable>(matchesIn regexp: NSRegularExpression) -> T? {
+    public func parameter<T: Parsable>(matchesIn regexp: NSRegularExpression) -> T? {
         if let queryItem = queryItem(matchesIn: regexp) {
             if let queryValue = queryItem.value,
-                let value = T.extract(from: queryValue) {
+                let value = T(from: queryValue) {
                 return value
             }
         }

Sources/Crossroad/Parsable.swift

@@ -0,0 +1,80 @@
+import Foundation
+
+@available(*, deprecated, renamed: "Parsable")
+public protocol Extractable {
+    @available(*, deprecated, renamed: "init(from:)")
+    static func extract(from: String) -> Self?
+}
+
+public protocol Parsable {
+    init?(from: String)
+}
+
+private extension Parsable {
+    init?(_ string: String, conversion: (String) -> Self?) {
+        guard let value = conversion(string) else {
+            return nil
+        }
+        self = value
+    }
+}
+
+extension Int: Parsable {
+    public init?(from string: String) {
+        self.init(string, conversion: Int.init(_:))
+    }
+}
+
+extension Int64: Parsable {
+    public init?(from string: String) {
+        self.init(string, conversion: Int64.init(_:))
+    }
+}
+
+extension Float: Parsable {
+    public init?(from string: String) {
+        self.init(string, conversion: Float.init(_:))
+    }
+}
+
+extension Double: Parsable {
+    public init?(from string: String) {
+        self.init(string, conversion: Double.init(_:))
+    }
+}
+
+extension Bool: Parsable {
+    public init?(from string: String) {
+        self.init(string, conversion: Bool.init(_:))
+    }
+}
+
+extension String: Parsable {
+    public init?(from string: String) {
+        self = string
+    }
+}
+
+extension Array: Parsable where Array.Element: Parsable {
+    public init?(from string: String) {
+        let components = string.split(separator: ",")
+        self = components
+            .map { String($0) }
+            .compactMap(Element.init(from:))
+    }
+}
+
+extension URL: Parsable {
+    public init?(from string: String) {
+        self.init(string, conversion: URL.init(string:))
+    }
+}
+
+extension RawRepresentable where Self: Parsable, Self.RawValue == String {
+    public init?(from string: String) {
+        guard let value = Self(rawValue: string) else {
+            return nil
+        }
+        self = value
+    }
+}

Tests/CrossroadTests/ContextTests.swift

@@ -5,7 +5,7 @@ import XCTest
 final class ContextTests: XCTestCase {
     let url = URL(string: "pokedex://searches")!
 
-    enum Region: String, Extractable {
+    enum Region: String, Parsable {
         case kanto
         case johto
         case hoenn

Tests/CrossroadTests/ParsableTests.swift

@@ -0,0 +1,47 @@
+import Foundation
+import XCTest
+@testable import Crossroad
+
+class RegularExpression: NSRegularExpression, Parsable {
+    required public init?(from string: String) {
+        try! super.init(pattern: string, options: .caseInsensitive)
+    }
+
+    required init?(coder: NSCoder) {
+        fatalError("init(coder:) has not been implemented")
+    }
+}
+
+final class ParsableTests: XCTestCase {
+    enum PokemonType: String, Parsable {
+        case fire
+        case grass
+        case water
+    }
+
+    func testWithPrimitives() {
+        XCTAssertEqual(Int(from: "10"), 10)
+        XCTAssertEqual(Double(from: "10.0"), 10.0)
+        XCTAssertEqual(Int64(from: "10"), 10)
+        XCTAssertEqual(Float(from: "10.0"), 10.0)
+        XCTAssertFalse(Bool(from: "false")!)
+        XCTAssertEqual(String(from: "pokèball"), "pokèball")
+        XCTAssertEqual(URL(from: "https://pokedex.com")!, URL(string: "https://pokedex.com"))
+    }
+
+    func testWithEnum() {
+        XCTAssertEqual(PokemonType(from: "fire"), .fire)
+        XCTAssertNil(PokemonType(from: "faily"))
+    }
+
+    func testWithCommaSeparatedList() {
+        XCTAssertEqual([Int](from: "1,2,3,4,5"), [1, 2, 3, 4, 5])
+        XCTAssertEqual([String](from: "a,,c,d,,,,f"), ["a", "c", "d", "f"])
+        XCTAssertEqual([Double](from: "1.1"), [1.1])
+        XCTAssertEqual([PokemonType](from: "water,grass"), [.water, .grass])
+    }
+
+    func testWithCustomClass() {
+        XCTAssertNotNil(RegularExpression(from: ".+"))
+    }
+}