- Adds simple calls to include NULL values in output JSON.
- Adds ability to simply type cast JSON values to specified type.
- Adds ability to map Swift base type arrays into Realm arrays.
- Adds
TimestampTransform
to simply transform to/from UNIX timestamps. - Adds
ISO8601JustDateTransform
to simplty transform to/from ISO8601 date string. Because ObjectMapper'sISO8601DateTransform
actually is date and time transform.
To run the example project, clone the repo, and run pod install
from the Example directory first.
Please check official guide
Cartfile:
github "APUtils/ObjectMapperAdditions" ~> 10.0
If you do not need Realm part, add those frameworks: ObjectMapperAdditions
, ObjectMapper
, RoutableLogger
.
If you are going to use Realm part, add those frameworks: ObjectMapperAdditions
, ObjectMapperAdditionsRealm
, ObjectMapper
, Realm
, RealmSwift
, RoutableLogger
.
ObjectMapperAdditions is available through CocoaPods.
To install Core features, simply add the following line to your Podfile:
pod 'ObjectMapperAdditions/Core', '~> 10.0'
To add Realm transform to your project add the following line to your Podfile:
pod 'ObjectMapperAdditions/Realm', '~> 10.0'
The Swift Package Manager is a tool for automating the distribution of Swift code and is integrated into the swift compiler.
Once you have your Swift package set up, adding ObjectMapperAdditions
as a dependency is as easy as adding it to the dependencies value of your Package.swift
.
dependencies: [
.package(url: "https://github.com/APUtils/ObjectMapperAdditions.git", .upToNextMajor(from: "9.0.0"))
]
It's a common case when app gets Int in JSON instead of String even if backend guy said you it'll be String. Worst of all sometimes it could be String and sometimes something else so it'll look like you released broken app even if you tested it well.
After several projects I made a rule for myself: Never trust a backend!
. I always make optional fields and cast values to type I'll use. Right now I'm using a great framework ObjectMapper
to map my objects but it doesn't have transforms I need so I wrote them as this separate pod.
Example model:
import Foundation
import ObjectMapper
import ObjectMapperAdditions
struct MyModel: Mappable {
var string: String?
var stringsArray: [String]?
var double: Double?
var myOtherModel: MyOtherModel?
var myOtherModelsArray: [MyOtherModel]?
init?(map: Map) {}
mutating func mapping(map: Map) {
// You could specify proper type transform directly
string <- (map["string"], StringTransform.shared)
// Or you could just use TypeCastTransform
string <- (map["string"], TypeCastTransform())
// No doubt it also works with Double
double <- (map["double"], TypeCastTransform())
// Works with arrays too but for TypeCastTransform you must specify type
stringsArray <- (map["stringsArray"], TypeCastTransform<String>())
// Or just use StringTransform directly
stringsArray <- (map["stringsArray"], StringTransform.shared)
// No need to transform your types. They should specify transforms by themselfs.
myOtherModel <- map["myOtherModel"]
myOtherModelsArray <- map["myOtherModelsArray"]
}
}
Right now there are 4 base type transforms you could use: BoolTransform
, DoubleTransform
, IntTransform
and StringTransform
. But for basic types it's easier to just use TypeCastTransform
which will type cast to proper type automatically.
Typecasting for Bool
, Double
, Int
and String
raw representable enums are also supported with EnumTypeCastTransform
.
Moreover this pod has extension to simplify creation of JSON with NULL values included from objects. Just call .toJSON(shouldIncludeNilValues: true)
on BaseMappable
object or array/set.
Date transformers example usage:
// If date in timestamp format (1506423767)
date <- (map["date"], TimestampTransform.shared)
// If date in ISO8601 full-date format (yyyy-MM-dd)
date <- (map["date"], ISO8601JustDateTransform.shared)
See example and tests projects for more details.
This part of ObjectMapperAdditions solves issues that prevent simply using ObjectMapper and Realm in one model. RealmListTransform
to transform custom types into realm lists was taken from ObjectMapper-Realm but it can't transform simple type arrays nor optional values.
import Foundation
import ObjectMapper
import ObjectMapperAdditions
import RealmSwift
class MyRealmModel: Object, Mappable {
@objc dynamic var double: Double = 0
// Please take a note it's `var` and is not optional
// However new value should be assigned through `.value`
private(set) var optionalDouble = RealmProperty<Double?>()
@objc dynamic var string: String?
@objc dynamic var myOtherRealmModel: MyOtherRealmModel?
// Please take a note it's `var` and is not optional
// However, new value should be assigned through `.append(_:)`
private(set) var myOtherRealmModels = List<MyOtherRealmModel>()
// Strings array will be casted to List<RealmString>
var strings: List<String> = List<String>()
required convenience init?(map: ObjectMapper.Map) { self.init() }
func mapping(map: ObjectMapper.Map) {
// .toJSON() requires Realm write transaction or it'll crash
let isWriteRequired = realm != nil && realm?.isInWriteTransaction == false
isWriteRequired ? realm?.beginWrite() : ()
// Same as for ordinary model
double <- (map["double"], DoubleTransform.shared)
// Using ObjectMapperAdditions's RealmPropertyTypeCastTransform
optionalDouble <- (map["optionalDouble"], RealmPropertyTypeCastTransform())
// You could also use RealmPropertyTransform if you don't like type cast
// optionalDouble <- (map["optionalDouble"], RealmPropertyTransform<Double>())
string <- (map["string"], StringTransform.shared)
myOtherRealmModel <- map["myOtherRealmModel"]
// Using ObjectMapper+Realm's RealmListTransform to transform custom types
myOtherRealmModels <- (map["myOtherRealmModels"], RealmListTransform<MyOtherRealmModel>())
// Using ObjectMapperAdditions's RealmTypeCastTransform
strings <- (map["strings"], RealmTypeCastTransform())
// You could also use RealmTransform if you don't like type cast
// strings <- (map["strings"], RealmTransform())
isWriteRequired ? try? realm?.commitWrite() : ()
}
}
Swift optionals cast to realm optionals this way: Int?
-> RealmProperty<Int>>
, Double?
-> RealmProperty<Double?>
, Bool?
-> RealmProperty<Bool?>
, etc.
Swift arrays cast to realm arrays this way: [String]
-> List<String>
, [Int]
-> List<String>
, [Double]
-> List<Double>
, [Bool]
-> List<Bool>
, etc.
Be sure to check that properties of type RealmProperty
and List
are not dynamic nor optional. Also despite of they defined as var
they should be handled as constants if model is added to Realm. Use .value
to change RealmOptional
value or use .removeAll()
and append(objectsIn:)
methods to change List
content
See example and tests projects for more details.
Any contribution is more than welcome! You can contribute through pull requests and issues on GitHub.
Anton Plebanovich, anton.plebanovich@gmail.com
ObjectMapperAdditions is available under the MIT license. See the LICENSE file for more info.