Himotoki

Himotoki (紐解き) is a type-safe JSON decoding library purely written in Swift. This library is highly inspired by popular JSON parsing libraries in Swift: Argo and ObjectMapper.

Himotoki has the same meaning of 'decoding' in Japanese.

• Just do JSON decoding (deserialization) well. JSON encoding (serialization) would not be supported going forward.
• Much simpler API.
• Fail-fast conditional model building. This is useful for some structs with non-optional let properties.
• No external dependencies.

See a simple example from a test code:

struct Group: Decodable {
    let name: String
    let floor: Int
    let locationName: String
    let optional: [String]?

    // MARK: Decodable

    static func decode(e: Extractor) throws -> Group {
        return try Group(
            name: e <| "name",
            floor: e <| "floor",
            locationName: e <| [ "location", "name" ], // Parse nested objects
            optional: e <||? "optional" // Parse optional arrays of values
        )
    }
}

func testGroup() {
    var JSON: [String: AnyObject] = [ "name": "Himotoki", "floor": 12 ]

    let g: Group? = try? decode(JSON)
    XCTAssert(g != nil)
    XCTAssert(g?.name == "Himotoki")
    XCTAssert(g?.floor == 12)
    XCTAssert(g?.optional == nil)

    JSON["name"] = nil
    do {
        try decode(JSON) as Group
    } catch let DecodeError.MissingKeyPath(keyPath) {
        XCTAssert(keyPath == "name")
    } catch {
        XCTFail()
    }
}

Operators

Himotoki supports the following operators to decode JSON elements, where T is a generic type conforming to Decodable protocol.

Requirements

• Swift 2.1 / Xcode 7.2
• OS X 10.9 or later
• iOS 8.0 or later (by Carthage or CocoaPods) / iOS 7 (by copying the source files directly)
• tvOS 9.0 or later
• watchOS 2.0 or later

Installation

There are 3 options. If your app support iOS 7, you can only use the last way.

Framework with Carthage (preferable)

Himotoki is Carthage compatible.

• Add github "ikesyo/Himotoki" ~> 1.5 to your Cartfile.
• Run carthage update.

Framework with CocoaPods

Himotoki also can be used by CocoaPods.

• Add the followings to your Podfile:

  use_frameworks!
  pod "Himotoki", "~> 1.5"

• Run pod install.

Copying the source files directly

• Add this repository as a git submodule:

  $ git submodule add https://github.com/ikesyo/Himotoki.git PATH_TO_SUBMODULE
  
  // or
  
  $ carthage update --use-submodules

• Then just add references of Sources/*.swift to your Xcode project.

License

Himotoki is released under the MIT License.