Please use 🧢 Ballcap 🧢
Ballcap is new Cloud Firestore framework
Please donate to continue development.
https://github.com/1amageek/pring.ts
Firestore model framework. The concept of Document and Collection has been added to Firestore. Pring defines the Scheme of the Document and enables type - safe programming. SubCollection can also be defined in Scheme.
Please report issues here
- iOS 10 or later
- Swift 4.0 or later
- Firebase firestore
- Firebase storage
- Cocoapods 1.4 ❗️
gem install cocoapods --pre
- Insert
pod 'Pring'to your Podfile. - Run
pod install.
☑️ You can define Firestore's Document scheme.
☑️ Of course type safety.
☑️ It seamlessly works with Firestore and Storage.
☑️ You can easily associate subcollections.
☑️ Support GeoPoint.
If you are going to use Firestore and make products, I recommend you to read it.
- Implement DataType that Firestore can handle
- Implement data management
- Implement custom DataType (Specification under consideration)
- Implement linkage with Firestorage
- Implement the NestedCollection feature
- Implement the ReferenceCollection feature
- Implement DataSource
- Implement Query-enabled DataSource (Specification under consideration)
- Verify the implementation of DataType that Firestore can handle
- Verify the implementation of data management
- Verify the implementation of custom DataType
- Verify cooperation with Firestorage
- Verify the implementation of the NestedCollection feature
- Verify the implementation of the ReferenceCollection feature
- Verify the implementation of Query-enabled DataSource
If you have a Feature Request, please post an issue.
For example..
@objcMembers
class User: Object {
@objc enum UserType: Int {
case normal
case gold
case premium
}
dynamic var type: UserType = .normal
dynamic var name: String?
dynamic var thumbnail: File?
dynamic var followers: ReferenceCollection<User> = []
dynamic var items: NestedCollection<Item> = []
// Custom property
override func encode(_ key: String, value: Any?) -> Any? {
if key == "type" {
return self.type.rawValue
}
return nil
}
override func decode(_ key: String, value: Any?) -> Bool {
if key == "type" {
self.type = UserType(rawValue: value as! Int)
return true
}
return false
}
}@objcMembers
class Item: Object {
dynamic var thumbnail: File?
dynamic var name: String? = "OWABIISHI"
}// Set an arbitrary ID
let user: User = User(id: "ID")
user.save()let userA: User = User()
userA.name = "userA"
userA.thumbnail = File(data: UIImageJPEGRepresentation(IMAGE, 0.3)!, mimeType: .jpeg)
let userB: User = User()
userB.name = "userB"
userB.thumbnail = File(data: UIImageJPEGRepresentation(IMAGE, 0.3)!, mimeType: .jpeg)
let item: Item = Item()
item.thumbnail = File(data: UIImageJPEGRepresentation(IMAGE, 0.3)!, mimeType: .jpeg)
userA.followers.insert(userB)
userA.items.insert(item)
userA.save()Important❗️
Pring clearly separates save and update. This is to prevent unexpected overwriting. Pring provides three methods of initializing Object.
let user: User = User()let user: User = User(id: "YOUR_ID") // isSaved falseIf you are dealing with an Object that has already been saved, please perform the following initialization. In case of this initialization can not save Please update.
let user: User = User(id: "YOUR_ID", value: [:]) // isSaved trueIt is the developer's responsibility to manage the saved state of the Object.
Pring inherits Object class and defines the Model. Pring supports many data types.
@objcMembers
class User: Object {
dynamic var array: [String] = ["array"]
dynamic var set: Set<String> = ["set"]
dynamic var bool: Bool = true
dynamic var binary: Data = "data".data(using: .utf8)!
dynamic var file: File = File(data: UIImageJPEGRepresentation(UIImage(named: "")!, 1))
dynamic var url: URL = URL(string: "https://firebase.google.com/")!
dynamic var int: Int = Int.max
dynamic var float: Double = Double.infinity
dynamic var date: Date = Date(timeIntervalSince1970: 100)
dynamic var geoPoint: GeoPoint = GeoPoint(latitude: 0, longitude: 0)
dynamic var list: List<Group> = []
dynamic var dictionary: [String: Any] = ["key": "value"]
dynamic var string: String = "string"
let group: Reference<Group> = .init()
let nestedCollection: NestedCollection<Item> = []
let referenceCollection: ReferenceCollection<User> = []
}| DataType | Description |
|---|---|
| Array | It is Array type. |
| Set | It is Set type.In Firestore it is expressed as {"value": true}. |
| Bool | It is a boolean value. |
| File | It is File type. You can save large data files. |
| URL | It is URL type. It is saved as string in Firestore. |
| Int | It is Int type. |
| Float | It is Float type. In iOS, it will be a 64 bit Double type. |
| Date | It is Date type. |
| GeoPoint | It is GeoPoint type. |
| List | It is Object array type. |
| Dictionary | It is a Dictionary type. Save the structural data. |
| nestedCollection or referenceCollection | It is SubCollection type. |
| String | It is String type. |
| Reference | It is Reference type. It hold DocumentReference |
| Null | It is Null type. |
| Any | It is custom type. You can specify it as a custom type if it is a class that inherits from NSObject. |
Bool Int Float Double are not supported optional type.
Document can be saved only once.
let object: MyObject = MyObject()
object.save { (ref, error) in
// completion
}Retrieve document with ID.
MyObject.get(document!.id, block: { (document, error) in
// do something
})Document has an update method. Be careful as it is different from Salada.
MyObject.get(document!.id, block: { (document, error) in
document.string = "newString"
document.update { error in
// update
}
})Delete document with ID.
MyObject.get(document!.id, block: { (document, error) in
document.delete()
})let batch: WriteBatch = Firestore.firestore().batch()
batch.add(.save, object: userA) // ** File is not saved.
batch.add(.update, object: userB)
batch.add(.delete, object: userC)
batch.commit(completion: { (error) in
// error handling
})List can access the Object faster than NestedCollection. List holds data in Document, not SubCollection.
// save
let order: Order = Order()
do {
let orderItem: OrderItem = OrderItem()
orderItem.name = "aaaa"
orderItem.price = 39
order.items.append(orderItem)
}
do {
let orderItem: OrderItem = OrderItem()
orderItem.name = "bbb"
orderItem.price = 21
order.items.append(orderItem)
}
order.save()Be sure to update the parent's object when updating data.
// update
Order.get("ORDER_ID") { (order, error) in
order.items.first.name = "hoge"
order.update()
}Pring has a File class because it seamlessly works with Firebase Storage.
File is saved with Document Save at the same time.
let object: MyObject = MyObject()
object.thumbnailImage = File(data: PNG_DATA, mimeType: .png)
let tasks: [String: StorageUploadTask] = object.save { (ref, error) in
}save method returns the StorageUploadTask that is set with the key.
For details on how to use StorageUploadTask, refer to Firebase docs.
let task: StorageUploadTask = tasks["thumbnailImage"]Get data with size.
let task: StorageDownloadTask = object.thumbnail.getData(100000, block: { (data, error) in
// do something
})If the Document is already saved, please use update method.
update method also returns StorageUploadTask.
Running update method automatically deletes old files.
let newFile: File = File(data: PNG_DATA, mimeType: .png)
object.thumbnailImage = newFile
object.update()Delete it with delete method.
object.thumbnailImage = File.delete()
object.update()If it is held in an array, automatic file deletion is done by deleting from the array and updating it.
object.files.remove(at: 0)
object.update()NestedCollection and ReferenceCollection are classes that define SubCollection.
When holding File in SubCollection, saving of File will be executed first. When many Files are stored in SubCollection at once, the performance deteriorates.
- NestedCollection nests data and saves it under the document.
- The destination path of File is nested path.
- ReferenceCollection saves the documentID under the document.
- Data is saved separately.
@objcMembers
class User: Object {
dynamic var name: String?
dynamic var followers: ReferenceCollection<User> = []
dynamic var items: NestedCollection<Item> = []
}
@objcMembers
class Item: Object {
dynamic var thumbnail: File?
}
let userA: User = User()
userA.name = "userA"
let userB: User = User()
userB.name = "userB"
let item: Item = Item()
item.thumbnail = File(data: JPEG_DATA, mimeType: .jpeg)
userA.followers.insert(userB)
userA.items.insert(item)
userA.save()let item: Item = Item()
userA.items.insert(item)
userA.update() { error in
if let error = error {
// error handling
return
}
// do something
}DataSource is a class for easy handling of data retrieval from Collection.
class DataSourceViewController: UITableViewController {
var dataSource: DataSource<User>?
override func viewDidLoad() {
super.viewDidLoad()
self.dataSource = User.order(by: \User.createdAt).limit(to: 30).dataSource()
.on({ [weak self] (snapshot, changes) in
guard let tableView: UITableView = self?.tableView else { return }
switch changes {
case .initial:
tableView.reloadData()
case .update(let deletions, let insertions, let modifications):
tableView.beginUpdates()
tableView.insertRows(at: insertions.map { IndexPath(row: $0, section: 0) }, with: .automatic)
tableView.deleteRows(at: deletions.map { IndexPath(row: $0, section: 0) }, with: .automatic)
tableView.reloadRows(at: modifications.map { IndexPath(row: $0, section: 0) }, with: .automatic)
tableView.endUpdates()
case .error(let error):
print(error)
}
}).listen()
}
// MARK: - Table view data source
override func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int {
return self.dataSource?.count ?? 0
}
override func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
let cell: DataSourceViewCell = tableView.dequeueReusableCell(withIdentifier: "DataSourceViewCell", for: indexPath) as! DataSourceViewCell
configure(cell, atIndexPath: indexPath)
return cell
}
func configure(_ cell: DataSourceViewCell, atIndexPath indexPath: IndexPath) {
guard let user: User = self.dataSource?[indexPath.item] else { return }
cell.textLabel?.text = user.name
cell.disposer = user.listen { (user, error) in
cell.textLabel?.text = user?.name
}
}
func tableView(_ tableView: UITableView, didEndDisplaying cell: DataSourceViewCell, forRowAt indexPath: IndexPath) {
cell.disposer?.dispose()
}
override func tableView(_ tableView: UITableView, canPerformAction action: Selector, forRowAt indexPath: IndexPath, withSender sender: Any?) -> Bool {
return true
}
override func tableView(_ tableView: UITableView, commit editingStyle: UITableViewCellEditingStyle, forRowAt indexPath: IndexPath) {
if editingStyle == .delete {
self.dataSource?.removeDocument(at: indexPath.item)
}
}
}User.get("USER_ID") { (user, error) in
guard let user: User = user else { return }
self.dataSource = user.followers.order(by: \User.createdAt).dataSource()
.on { (snapshot, changes) in
// something
}.listen()
}@objcMembers
class User: Object {
let group: Reference<Group> = Reference()
}Please add on(parse:) to DataSource.
self.dataSource = User.order(by: \User.updatedAt).dataSource()
.on({ [weak self] (snapshot, changes) in
guard let tableView: UITableView = self?.tableView else { return }
debugPrint("On")
switch changes {
case .initial:
tableView.reloadData()
case .update(let deletions, let insertions, let modifications):
tableView.beginUpdates()
tableView.insertRows(at: insertions.map { IndexPath(row: $0, section: 0) }, with: .automatic)
tableView.deleteRows(at: deletions.map { IndexPath(row: $0, section: 0) }, with: .automatic)
tableView.reloadRows(at: modifications.map { IndexPath(row: $0, section: 0) }, with: .automatic)
tableView.endUpdates()
case .error(let error):
print(error)
}
})
.on(parse: { (snapshot, user, done) in
user.group.get({ (group, error) in
done(user)
})
})
.onCompleted({ (snapshot, users) in
debugPrint("completed")
})
.listen()User.where(\User.name, isEqualTo: "name").get { (snapshot, error) in
print(snapshot?.documents)
}WHERE
let user: User = User(id: "user_id")
user.items.where(\Item.name, isEqualTo: "item_name").get { (snapshot, error) in
print(snapshot?.documents)
}ORDER
let user: User = User(id: "user_id")
user.items.order(by: \Item.updatedAt).get { (snapshot, error) in
print(snapshot?.documents)
}Create DataSource from Query
let user: User = User(id: "user_id")
user.items
.where(\Item.name, isEqualTo: "item_name")
.dataSource()
.on({ (snapshot, change) in
// do something
})
.onCompleted { (snapshot, items) in
print(items)
}Please use ElasticSearch or Algolia when performing full-text search on Firebase. There is a library when implementing with Swift.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent