tutubalinry / jj

Super simple json parser for Swift

JJ

Super simple json parser for Swift

Requirements

• iOS 8.0+ / Mac OS X 10.10+ / tvOS 8.0+ / watchOS 2.0+
• Xcode 7.3.1
• Swift 2.2

No dependences. You can copy JJ.swift into your project if you want.

Installation

CocoaPods

JJ is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod "JJ"

Carthage

To integrate JJ into your Xcode project using Carthage, specify it in your Cartfile:

github "anjlab/JJ"

Run carthage update to build the framework and drag the built JJ.framework into your Xcode project.

JSON Example

import UIKit

struct Branch {
    let branch: String
}

struct MyRepository {
    let name: String
    let desc: String
    let stargazersCount: Int
    let language: String?
    let sometimesMissingKey: String?

    let defaultBranch: Branch

    init(anyObject: AnyObject?) throws {
        let obj = try jj(anyObject).obj()
        self.name = try obj["name"].string()
        self.desc = try obj["description"].string()
        self.stargazersCount = try obj["stargazersCount"].int()
        self.language = obj["language"].asString
        self.sometimesMissingKey = obj["sometimesMissingKey"].asString

        self.defaultBranch = Branch(branch: obj["branch"].toString())
    }
}


let json = [
    "name" : "JJ",
    "description" : "Super simple json parser for Swift",
    "stargazersCount" : 999999,
    "language" : "RU",
    "sometimesMissingKey" : NSNull(),
    "branch" : "master"
]

do {
    let r = try MyRepository(anyObject: json)
} catch {
    debugPrint(error)
}

NSCoder Example

class RepositoryAuthor: NSCoding {
    var name: String!
    var headquarters: String!

    init(name: String, headquarters: String) {
        super.init()
        self.name = name
        self.headquarters = headquarters
    }

    required convenience init?(coder aDecoder: NSCoder) {
        let dec = jj(decoder: aDecoder)

        do {
            let name = try dec["name"].string()
            let headquarters = try dec["headquarters"].string()

            self.init(name: name, headquarters: headquarters)
        } catch {
            debugPrint(error)
            return nil
        }
    }

    func encodeWithCoder(aCoder: NSCoder) {
        aCoder.encodeObject(self.name, forKey: "name")
        aCoder.encodeObject(self.headquarters, forKey: "headquarters")
    }
}

let data = NSMutableData()
let coder = NSKeyedArchiver(forWritingWithMutableData: data)
let enc = jj(encoder: coder)

enc.put("Yury", at: "name")
enc.put("AnjLab", at: "headquarters")
coder.finishEncoding()

let decoder = NSKeyedUnarchiver(forReadingWithData: data)
let author = RepositoryAuthor(coder: decoder)

Features

• No protocols
• Informative errors
• Extensible
• Leverages Swift 2's error handling
• Support classes conforming NSCoding

Parsing Types

• Bool
• Int & UInt
• Float
• Double
• NSNumber
• String
• NSDate
• NSURL
• NSTimeZone
• [AnyObject]
• [String : AnyObject]

Errors

JJError conforming ErrorType and there are currently two error-structs conforming to it

• WrongType throws when it is impossible to convert the element
• NotFound throws if the element is missing

let arr = ["element"]

do {
    let _ = try jj(arr).obj()
} catch {
    print(error)
}

//  JJError.WrongType: Can't convert Optional(<_TtCs21_SwiftDeferredNSArray 0x7fa3be4acb40>(
//  element
//  )
//  ) at path: '<root>' to type '[String: AnyObject]'

Handling Errors

Expressions like .<Type>() will throw directly, and catch-statements can be used to create the most complex error handling behaviours. This also means that try? can be used to return nil if anything goes wrong instead of throwing.

For required values is most useful methods .to<Type>(defaultValue). If the value is missing or does not match its type, will be used the default value.

For optional values there's methods .as<Type>.

Method	Examples	Null Behaviour	Missing Key Behaviour	Type Mismatch Behaviour
.<Type>()	.int()	throws	throws	throws
.to<Type>(defaultValue)	.toString() or .toString("Default")	defaultValue	defaultValue	defaultValue
.as<Type>	.asObj	nil	nil	nil
.decode()	.decode() as NSNumber	throws	throws	throws
.decodeAs()	.decodeAs()	nil	nil	nil

Author

Yury Korolev, [email protected]

License

JJ is available under the MIT license. See the LICENSE file for more info.