Installation

WithCocoaPods

use_frameworks!pod"ModelMapper"

WithCarthage

github "lyft/mapper"

Usage

Simple example:

import Mapper// Conform to the Mappable protocolstructUser:Mappable{letid:StringletphotoURL:URL?  // Implement this initializerinit(map:Mapper)throws{try id= map.from("id")    photoURL= map.optionalFrom("avatar_url")}}// Create a user!letJSON:NSDictionary=...letuser=User.from(JSON) // This is a 'User?'

Using with enums:

enumUserType:String{case Normal="normal"case Admin="admin"}structUser:Mappable{letid:Stringlettype:UserTypeinit(map:Mapper)throws{try id= map.from("id")try type= map.from("user_type")}}

NestedMappable objects:

structUser:Mappable{letid:Stringletname:Stringinit(map:Mapper)throws{try id= map.from("id")try name= map.from("name")}}structGroup:Mappable{letid:Stringletusers:[User]init(map:Mapper)throws{try id= map.from("id")    users= map.optionalFrom("users")??[]}}

UseConvertible to transparently convert other types from JSON:

extensionCLLocationCoordinate2D:Convertible{publicstaticfunc fromMap(_ value:Any)throws->CLLocationCoordinate2D{guardlet location= valueas?NSDictionary,let latitude=location["lat"]as?Double,let longitude=location["lng"]as?Doubleelse{throwMapperError.convertibleError(value: value, type:[String:Double].self)}returnCLLocationCoordinate2D(latitude: latitude, longitude: longitude)}}structPlace:Mappable{letname:Stringletlocation:CLLocationCoordinate2Dinit(map:Mapper)throws{try name= map.from("name")try location= map.from("location")}}letJSON:NSDictionary=["name":"Lyft HQ","location":["lat":37.7603392,"lng":-122.41267249999999,],]letplace=Place.from(JSON)

Custom Transformations

privatefunc extractFirstName(object:Any?)throws->String{guardlet fullName= objectas?Stringelse{throwMapperError.convertibleError(value: object, type:String.self)}letparts= fullName.characters.split{ $0==""}.map(String.init)iflet firstName= parts.first{return firstName}throwMapperError.customError(field:nil, message:"Couldn't split the string!")}structUser:Mappable{letfirstName:Stringinit(map:Mapper)throws{try firstName= map.from("name", transformation: extractFirstName)}}

Parse nested or entire objects

structUser:Mappable{letname:StringletJSON:AnyObjectinit(map:Mapper)throws{    // Access the 'first' key nested in a 'name' dictionarytry name= map.from("name.first")    // Access the original JSON (maybe for use with a transformation)try JSON= map.from("")}}

Open Radars

License