Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zenangst/Tailor
:necktie:A super fast & convenient object mapper tailored for your needs
https://github.com/zenangst/Tailor
Last synced: 3 months ago
JSON representation
:necktie:A super fast & convenient object mapper tailored for your needs
- Host: GitHub
- URL: https://github.com/zenangst/Tailor
- Owner: zenangst
- License: other
- Created: 2015-04-14T12:30:30.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2017-08-17T11:10:23.000Z (over 7 years ago)
- Last Synced: 2024-10-20T00:53:00.371Z (3 months ago)
- Language: Swift
- Homepage: https://github.com/zenangst
- Size: 630 KB
- Stars: 241
- Watchers: 11
- Forks: 15
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-swift-cn - Tailor - A super fast & convenient object mapper tailored for your needs. (Libs / Data Management)
- awesome-swift - Tailor - A super fast & convenient object mapper tailored for your needs. (JSON/XML Manipulation)
README
[](https://travis-ci.org/zenangst/Tailor)
[](http://cocoadocs.org/docsets/Tailor)
[](https://github.com/Carthage/Carthage)
[](http://cocoadocs.org/docsets/Tailor)
[](http://cocoadocs.org/docsets/Tailor)
[](http://cocoadocs.org/docsets/Tailor)
A super fast & convenient object mapper tailored for your needs.
Mapping objects to arrays or dictionaries can be a really cumbersome task, but those
days are over. Tailor features a whole bunch of nifty methods for your model sewing needs.
## Mapping properties
Tailor features property, relation(s) mapping for both `struct` and `class` objects.
## Struct
```swift
struct Person: Mappable {
var firstName: String? = ""
var lastName: String? = ""
init(_ map: [String : Any]) {
firstName <- map.property("first_name")
lastName <- map.property("last_name")
}
}
let dictionary = ["first_name" : "Taylor", "last_name" : "Swift"]
let model = Person(dictionary)
```
## Class
```swift
class Person: Mappable {
var firstName: String? = ""
var lastName: String? = ""
required convenience init(_ map: [String : AnyObject]) {
self.init()
firstName <- map.property("first_name")
lastName <- map.property("last_name")
}
}
let dictionary = ["first_name" : "Taylor", "last_name" : "Swift"]
let model = Person(dictionary)
```
## Mapping objects
```swift
struct Person: Mappable {
var firstName: String? = ""
var lastName: String? = ""
var spouse: Person?
var parents = [Person]()
init(_ map: [String : Any]) {
firstName <- map.property("first_name")
lastName <- map.property("last_name")
spouse <- map.relation("spouse")
parents <- map.relations("parents")
}
}
let dictionary = [
"first_name" : "Taylor",
"last_name" : "Swift",
"spouse" : ["first_name" : "Calvin",
"last_name" : "Harris"],
"parents" : [
["first_name" : "Andrea",
"last_name" : "Swift"],
["first_name" : "Scott",
"last_name" : "Swift"]
]
]
let model = Person(dictionary)
```
## SafeMappable
```swift
struct ImmutablePerson: SafeMappable {
let firstName: String
let lastName: String
let spouse: Person
let parents = [Person]()
init(_ map: [String : Any]) throws {
firstName = try map.property("firstName").unwrapOrThrow()
lastName = try map.property("lastName").unwrapOrThrow()
spouse = try map.relationOrThrow("spouse").unwrapOrThrow()
parents = try map.relationsOrThrow("parents").unwrapOrThrow()
}
}
let immutablePerson: ImmutablePerson
do {
immutablePerson = try TestImmutable(["firstName" : "foo" , "lastName" : "bar"])
} catch {
print(error)
}
```
## Transforms
```swift
struct Person: Mappable {
var firstName: String? = ""
var lastName: String? = ""
var spouse: Person?
var parents = [Person]()
var birthDate = NSDate?
init(_ map: [String : Any]) {
firstName <- map.property("first_name")
lastName <- map.property("last_name")
spouse <- map.relation("spouse")
parents <- map.relations("parents")
birthDate <- map.transform("birth_date", transformer: { (value: String) -> NSDate? in
let dateFormatter = NSDateFormatter()
dateFormatter.dateFormat = "yyyy-MM-dd"
return dateFormatter.dateFromString(value)
})
}
}
let dictionary = [
"first_name" : "Taylor",
"last_name" : "Swift",
"spouse" : ["first_name" : "Calvin",
"last_name" : "Harris"],
"parents" : [
["first_name" : "Andrea",
"last_name" : "Swift"],
["first_name" : "Scott",
"last_name" : "Swift"]
],
"birth_date": "1989-12-13"
]
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.
```swift
dictionary.boolean("key")
dictionary.double("key")
dictionary.float("key")
dictionary.int("key")
dictionary.string("key")
```
You can also use `value(forKey:ofType:)`, it works like this.
```swift
dictionary.value(forKey: "key", ofType: Bool.self)
dictionary.value(forKey: "key", ofType: Double.self)
dictionary.value(forKey: "key", ofType: Float.self)
dictionary.value(forKey: "key", ofType: Int.self)
dictionary.value(forKey: "key", ofType: String.self)
```
All of these methods returns an optional value.
## Installation
**Tailor** is available through [CocoaPods](http://cocoapods.org). To install
it, simply add the following line to your Podfile:
```ruby
pod 'Tailor'
```
## Contribute
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create pull request
## Who made this?
- Christoffer Winterkvist ([@zenangst](https://twitter.com/zenangst))
- Vadym Markov ([@vadymmarkov](https://twitter.com/vadymmarkov))
- Khoa Pham ([@onmyway133](https://twitter.com/onmyway133))