Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iomega8561/tools4swiftdata
A Swift 5.9 package that bundles amazing reusable utilities to deal with SwiftData in any scenario
https://github.com/iomega8561/tools4swiftdata
apple concurrency ios ipados macos swift swiftdata tvos visionos
Last synced: about 5 hours ago
JSON representation
A Swift 5.9 package that bundles amazing reusable utilities to deal with SwiftData in any scenario
- Host: GitHub
- URL: https://github.com/iomega8561/tools4swiftdata
- Owner: iOmega8561
- License: mit
- Created: 2024-12-31T15:35:26.000Z (24 days ago)
- Default Branch: master
- Last Pushed: 2025-01-12T15:54:41.000Z (12 days ago)
- Last Synced: 2025-01-12T16:36:39.459Z (12 days ago)
- Topics: apple, concurrency, ios, ipados, macos, swift, swiftdata, tvos, visionos
- Language: Swift
- Homepage:
- Size: 19.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Tools4SwiftData
[](https://swift.org/download/)
A comprehensive framework for streamlined data persistence, transfer, and management in Swift.
Leverages Swift's concurrency model and structured protocols for reliable data workflows.
---
## Features
**Tools4SwiftData** simplifies data operations in Swift with robust and flexible tools, including:
### **Protocols**
- **`SwiftDataTransferable`**: Represents a model suitable for data transfer, initialized from a persistent model.
- **`SwiftDataPersistable`**: Defines a model capable of persisting data, ensuring all stored models are validated.
- **`SwiftDataConfigurable`**: A configurable model interface with validation logic to guarantee correctness before use.
### **Components**
- **`SwiftDataProvider`**: A class providing shared access to the persistence container for data management.
- **`SwiftDataManager`**: An actor designed for thread-safe CRUD operations on your data store, ensuring data integrity across contexts.
### **Concurrency-Safe Design**
- Strict adherence to Swift’s concurrency model using `Sendable` and `@ModelActor`.
---
## Installation
### Swift Package Manager (SPM)
Add the package to your Xcode project:
1. In Xcode, go to **File > Add Packages**.
2. Enter the URL for this repository:
```plaintext
https://github.com/iOmega8561/Tools4SwiftData.git
```
3. Choose the appropriate version rules and add the package.
---
## Usage
### **SwiftDataTransferable**
Define a model suitable for data transfer:
```swift
struct MyTransferableModel: SwiftDataTransferable {
typealias PersistableType = MyPersistableModel
let persistentModelID: PersistentIdentifier
init(_ persistentModel: MyPersistableModel) {
self.persistentModelID = persistentModel.persistentModelID
}
}
```
### **SwiftDataPersistable**
Implement a persistent model initialized from a validated configuration:
```swift
struct MyPersistableModel: SwiftDataPersistable {
typealias ConfigurableType = MyConfigurableModel
static let filePrefix = "MyModel"
init(_ configurableModel: MyConfigurableModel) {
// Initialize from configuration
}
}
```
### **SwiftDataProvider**
Create a shared persistence container:
```swift
let dataProvider = try SwiftDataProvider(
writeDataStoreAt: FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first!
)
```
### **SwiftDataManager**
Perform CRUD operations safely using `SwiftDataManager`:
```swift
let dataManager = dataProvider.managerCreator()
// Add an item
try await dataManager.addItem(configurableModel)
// Fetch items
let items = try await dataManager.fetch()
// Update an item
try await dataManager.updateItem(id: itemID) { item in
item.property = newValue
}
// Delete an item
try await dataManager.deleteItem(id: itemID)
```
---
## Concurrency and Safety
This package is built with Swift’s strict concurrency rules in mind, ensuring data integrity and safe access across multiple threads. By leveraging actors, all data operations are thread-safe and efficient.