SwiftyRemoteConfig
Modern Swift API for FirebaseRemoteConfig
SwiftyRemoteConfig makes Firebase Remote Config enjoyable to use by combining expressive Swifty API with the benefits fo static typing. This library is strongly inspired by SwiftyUserDefaults.
Features
There is only one step to start using SwiftyRemoteConfig.
Define your Keys !
extension RemoteConfigKeys {
var recommendedAppVersion: RemoteConfigKey<String?> { .init("recommendedAppVersion")}
var isEnableExtendedFeature: RemoteConfigKey<Bool> { .init("isEnableExtendedFeature", defaultValue: false) }
}
... and just use it !
// get remote config value easily
let recommendedVersion = RemoteConfigs[.recommendedAppVersion]
// eality work with custom deserialized types
let themaColor: UIColor = RemoteConfigs[.themaColor]
If you use Swift 5.1 or later, you can also use keyPath dynamicMemberLookup
:
let subColor: UIColor = RemoteConfigs.subColor
Usage
Define your keys
To get the most out of SwiftyRemoteConfig, define your remote config keys ahead of time:
let flag = RemoteConfigKey<Bool>("flag", defaultValue: false)
Just create a RemoteConfigKey
object. If you want to have a non-optional value, just provide a defaultValue
in the key (look at the example above).
You can now use RemoteConfig
shortcut to access those values:
RemoteConfigs[key: flag] // => false, type as "Bool"
THe compiler won't let you fetching conveniently returns Bool
.
Take shortcuts
For extra convenience, define your keys by extending magic RemoteConfigKeys
class and adding static properties:
extension RemoteConfigKeys {
var flag: RemoteConfigKey<Bool> { .init("flag", defaultValue: false) }
var userSectionName: RemoteConfigKey<String?> { .init("default") }
}
and use the shortcut dot syntax:
RemoteConfigs[\.flag] // => false
Supported types
SwiftyRemoteConfig supports standard types as following:
Single value | Array |
---|---|
String |
[String] |
Int |
[Int] |
Double |
[Double] |
Bool |
[Bool] |
Data |
[Data] |
Date |
[Date] |
URL |
[URL] |
[String: Any] |
[[String: Any]] |
and that's not all !
Extending existing types
Codable
SwiftyRemoteConfig
supports Codable
! Just conform to RemoteConfigSerializable
in your type:
final class UserSection: Codable, RemoteConfigSerializable {
let name: String
}
No implementation needed ! By doing this you will get an option to specify an optional RemoteConfigKey
:
let userSection = RemoteConfigKey<UserSection?>("userSection")
Additionally, you've get an array support for free:
let userSections = RemoteConfigKey<[UserSection]?>("userSections")
NSCoding
Support your custom NSCoding type the same way as with Codable support:
final class UserSection: NSObject, NSCoding, RemoteConfigSerializable {
...
}
RawRepresentable
And the last, RawRepresentable
support ! Again, the same situation like with Codable
and NSCoding
:
enum UserSection: String, RemoteConfigSerializable {
case Basic
case Royal
}
Custom types
If you want to add your own custom type that we don't support yet. we've got you covered. We use RemoteConfigBridge
s of many kinds to specify how you get values and arrays of values. WHen you look at RemoteConfigSerializable
protocol, it expects two properties in eacy type: _remoteConfig
and _remoteConfigArray
, where both are of type RemoteConfigBridge
.
For instance, this is a bridge for single value data retrieving using NSKeyedUnarchiver
:
public struct RemoteConfigKeyedArchiveBridge<T>: RemoteConfigBridge {
public func get(key: String, remoteConfig: RemoteConfig) -> T? {
remoteConfig.data(forKey: key).flatMap(NSKyedUnarchiver.unarchiveObject) as? T
}
public func deserialize(_ object: RemoteConfigValue) -> T? {
guard let data = object as? Data else {
return nil
}
NSKyedUnarchiver.unarchiveObject(with: data)
}
}
Bridge for default retrieving array values:
public struct RemoteConfigArrayBridge<T: Collection>: RemoteConfigBridge {
public func get(key: String, remoteConfig: RemoteConfig) -> T? {
remoteConfig.array(forKey: key) as? T
}
public func deserialize(_ object: RemoteConfigValue) -> T? {
return nil
}
}
Now, to use these bridges in your type you simply declare it as follows:
struct CustomSerializable: RemoteConfigSerializable {
static var _remoteConfig: RemoteConfigBridge<CustomSerializable> { RemoteConfigKeyedArchiverBridge() }
static var _remoteConfigArray: RemoteConfigBridge<[CustomSerializable]> { RemoteConfigKeyedArchiverBridge() }
let key: String
}
Unfortunately, if you find yourself in a situation where you need a custom bridge, you'll probably need to write your own:
final class RemoteConfigCustomBridge: RemoteConfigBridge {
func get(key: String, remoteConfig: RemoteConfig) -> RemoteConfigCustomSerializable? {
let value = remoteConfig.string(forKey: key)
return value.map(RemoteConfigCustomSerializable.init)
}
func deserializa(_ object: Any) -> RemoteConfigCustomSerializable? {
guard let value = object as? String {
return nil
}
return RemoteConfigCustomSerializable(value: value)
}
}
final class RemoteConfigCustomArrayBridge: RemoteConfigBridge {
func get(key: String, remoteConfig: RemoteConfig) -> [RemoteConfigCustomSerializable]? {
remoteConfig.array(forKey: key)?
.compactMap({ $0 as? String })
.map(RemoteConfigCustomSerializable.init)
}
func deserializa(_ object: Any) -> [RemoteConfigCustomSerializable]? {
guard let values as? [String] else {
return nil
}
return values.map({ RemoteConfigCustomSerializable.init })
}
}
struct RemoteConfigCustomSerializable: RemoteConfigSerializable, Equatable {
static var _remoteConfig: RemoteConfigCustomBridge { RemoteConfigCustomBridge() }
static var _remoteConfigArrray: RemoteConfigCustomArrayBridge: { RemoteConfigCustomArrayBridge() }
let value: String
}
To support existing types with different bridges, you can extend it similarly:
extension Data: RemoteConfigSerializable {
public static var _remoteConfigArray: RemoteConfigArrayBridge<[T]> { RemoteConfigArrayBridge() }
public static var _remoteConfig: RemoteConfigBridge<T> { RemoteConfigBridge() }
}d
Also, take a look at our source code or tests to see more examples of bridges. If you find yourself confused with all these bridges, please create an issue and we will figure something out.
Property Wrappers
SwiftyRemoteConfig provides property wrappers for Swift 5.1! The property wrapper, @SwiftyRemoteConfig
, provides an option to use it with key path.
Note: This propety wrappers only read
support. You can set new value to the property, but any changes will NOT be reflected to remote config value
usage
Given keys:
extension RemoteConfigKeys {
var userColorScheme: RemoteConfigKey<String> { .init("userColorScheme", defaultValue: "default") }
}
You can declare a Settings struct:
struct Settings {
@SwiftyRemoteConfig(keyPath: \.userColorScheme)
var userColorScheme: String
}
KeyPath dynamicMemberLookup
SwiftyRemoteConfig makes KeyPath dynamicMemberLookpu usable in Swift 5.1.
extension RemoteConfigKeys {
var recommendedAppVersion: RemoteConfigKey<String?> { .init("recommendedAppVersion")}
var themaColor: RemoteConfigKey<UIColor> { .init("themaColor", defaultValue: .white) }
}
and just use it ;-)
// get remote config value easily
let recommendedVersion = RemoteConfig.recommendedAppVersion
// eality work with custom deserialized types
let themaColor: UIColor = RemoteConfig.themaColor
Dependencies
- Swift version >= 5.0
SDKs
- iOS version >= 11.0
- macOS version >= 10.12
- tvOS version >= 12.0
- watchOS version >= 6.0
Frameworks
- Firebase iOS SDK >= 8.0.0
Installation
Cocoapods
If you're using Cocoapods, just add this line to your Podfile
:
pod 'SwiftyRemoteConfig`, `~> 0.1.1`
Install by running this command in your terminal:
$ pod install
Then import the library in all files where you use it:
import SwiftyRemoteConfig
Carthage
Just add your Cartfile
github "fumito-ito/SwiftyRemoteConfig" ~> 0.1.1
Swift Package Manager
Just add to your Package.swift
under dependencies
let package = Package(
name: "MyPackage",
products: [...],
dependencies: [
.package(url: "https://github.com/fumito-ito/SwiftyRemoteConfig.git", .upToNextMajor(from: "0.1.1"))
]
)
SwiftyRemoteConfig is available under the Apache License 2.0. See the LICENSE file for more detail.