Skip to content

Commit

Permalink
Merge pull request #66 from zenangst/fix/readme
Browse files Browse the repository at this point in the history
Update README
  • Loading branch information
onmyway133 authored Jul 6, 2017
2 parents eb8587e + 0f0478c commit bfd9071
Showing 1 changed file with 25 additions and 29 deletions.
54 changes: 25 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,31 +52,6 @@ let dictionary = ["first_name" : "Taylor", "last_name" : "Swift"]
let model = Person(dictionary)
```

## Object mapping

```swift
struct Person: Mappable {

var firstName: String? = ""
var lastName: String? = ""
var spouse: Person?

init(_ map: [String : Any]) {
firstName <- map.property("first_name")
lastName <- map.property("last_name")
spouse <- map.relation("spouse")
}
}

let dictionary = [
"first_name" : "Taylor",
"last_name" : "Swift",
"spouse" : ["first_name" : "Calvin",
"last_name" : "Harris"]
]
let model = Person(dictionary)
```

## Mapping objects

```swift
Expand Down Expand Up @@ -119,10 +94,10 @@ struct ImmutablePerson: SafeMappable {
let parents = [Person]()

init(_ map: [String : Any]) throws {
firstName = try <-map.property("firstName")
lastName = try <-map.property("lastName")
spouse = try <-map.relationOrThrow("spouse")
parents = try <-map.relationsOrThrow("parents")
firstName = try map.property("firstName").unwrapOrThrow()
lastName = try map.property("lastName").unwrapOrThrow()
spouse = try map.relationOrThrow("spouse").unwrapOrThrow()
parents = try map.relationsOrThrow("parents").unwrapOrThrow()
}
}

Expand Down Expand Up @@ -174,6 +149,27 @@ let dictionary = [
let model = Person(dictionary)
```

## KeyPath

Tailor supports mapping values using deep keyPath

```swift
struct Book: Mappable {

var title: String = ""
var publisherName: String = ""
var authorName: String = ""
var firstReviewerName: String = ""

init(_ map: [String : Any]) {
title <- map.resolve(keyPath: "title")
publisherName <- map.resolve(keyPath: "publisher.name")
authorName <- map.resolve(keyPath: "info.author.name")
firstReviewerName <- map.resolve(keyPath: "meta.reviewers.0.info.name.first_name")
}
}
```

## Resolving value types.

Tailor supports mapping values from dictionaries using type specific functions.
Expand Down

0 comments on commit bfd9071

Please sign in to comment.