Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hodinkee/alexander
An extremely simple JSON helper written in Swift.
https://github.com/hodinkee/alexander
Last synced: 6 days ago
JSON representation
An extremely simple JSON helper written in Swift.
- Host: GitHub
- URL: https://github.com/hodinkee/alexander
- Owner: hodinkee
- License: mit
- Archived: true
- Created: 2015-07-20T23:59:26.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-03-29T12:54:13.000Z (over 5 years ago)
- Last Synced: 2024-11-07T07:47:36.168Z (about 1 month ago)
- Language: Swift
- Homepage:
- Size: 134 KB
- Stars: 36
- Watchers: 14
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ios - alexander - An extremely simple JSON helper written in Swift. (Parsing / JSON)
- awesome-ios-star - alexander - An extremely simple JSON helper written in Swift. (Parsing / JSON)
- awesome-swift-cn - Alexander - An extremely simple JSON helper written in Swift. (Libs / Data Management)
README
# Alexander
[](https://github.com/Carthage/Carthage)
[](https://cocoapods.org/pods/Alexander)
Alexander is an extremely simple JSON helper written in Swift. It brings type safety and Foundation helpers to the cumbersome task of JSON unpacking.
## Requirements
| Xcode | Swift | iOS | tvOS | OS X |
| :-----: | :-----: | :---: | :----: | :----: |
| 10.2 | 5.0 | 8.0 | 9.0 | 10.9 |
## Installation
##### [Carthage](https://github.com/carthage/carthage)
> `github "hodinkee/alexander"`
##### [CocoaPods](https://github.com/cocoapods/cocoapods)
> `pod 'Alexander'`
## Usage
### DecoderType
Make a new `DecoderType` that can unpack your object.
```swift
struct User {
var ID: String
var name: String
var email: String
}
struct UserDecoder: DecoderType {
typealias Value = User
static func decode(JSON: Alexander.JSON) -> Value? {
guard
let ID = JSON["id"]?.stringValue,
let name = JSON["name"]?.stringValue,
let email = JSON["email"]?.stringValue
else {
return nil
}
return User(ID: ID, name: name, email: email)
}
}
```
Now you can do `let author = JSON["user"]?.decode(UserDecoder)` to get a single user, or `let users = JSON["users"]?.decodeArray(UserDecoder)` to get an array of users.
You can make `DecodableType`s for all kinds of things.
```swift
struct SizeDecoder {
typealias Value = CGSize
static func decode(JSON: Alexander.JSON) -> Value? {
guard
let width = JSON["width"]?.doubleValue,
let height = JSON["height"]?.doubleValue
else {
return nil
}
return CGSize(width: width, height: height)
}
}
```
Alexander ships with a handful of decoders for common types:
- `DateTimeIntervalSince1970Decoder`
- `DateTimeIntervalSinceReferenceDateDecoder`
- `URLDecoder`
- `RawRepresentableDecoder`
### Nested Objects
Most of Alexander's power comes from its two subscript operators: `subscript[key: String] -> JSON?` and `subscript[index: Int] -> JSON?`. These operators allow you to unpack nested objects without having to refer to each intermediate step by hand. Something like `let nextCursor = JSON["meta"]?["pagination"]?["next_cursor"]?.stringValue` is a single line of code.
### Enums & RawRepresentable
You can also decode anything that conforms to the `RawRepresentable` type. For example, assume the following enum:
```swift
enum Planet: String {
case Mercury = "mercury"
case Venus = "venus"
case Earth = "earth"
case Mars = "mars"
case Jupiter = "jupiter"
case Saturn = "saturn"
case Uranus = "uranus"
case Neptune = "neptune"
// case Pluto = "pluto" =(
}
```
Because `Planet` is backed by a `String` raw value type, it is inheriently `RawRepresentable`. This means you can do `let planet = JSON["planet"]?.decode(RawRepresentableDecoder)` or `let planets = JSON["planets"]?.decodeArray(RawRepresentableDecoder)`.