Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mtzaquia/loadablereducer
An extension to TCA's ReducerProtocol for features that will start, load additional data asynchronously, and shift to a ready state once done.
https://github.com/mtzaquia/loadablereducer
asynchronous loading reducer swift-composable-architecture tca
Last synced: 13 days ago
JSON representation
An extension to TCA's ReducerProtocol for features that will start, load additional data asynchronously, and shift to a ready state once done.
- Host: GitHub
- URL: https://github.com/mtzaquia/loadablereducer
- Owner: mtzaquia
- Created: 2023-07-16T08:16:48.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-08T18:11:55.000Z (12 months ago)
- Last Synced: 2024-12-09T01:37:45.438Z (15 days ago)
- Topics: asynchronous, loading, reducer, swift-composable-architecture, tca
- Language: Swift
- Homepage:
- Size: 132 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# LoadableReducer
An extension to TCA's `Reducer` to create a reducer that starts with initial data, loads what it needs asynchronously, and shifts to a ready state once done.
## Instalation
`LoadableReducer` is available via Swift Package Manager.
```swift
dependencies: [
.package(url: "https://github.com/mtzaquia/LoadableReducer.git", .upToNextMajor(from: "1.0.0")),
],
```
> **Note:**
> If you haven't migrated to TCA `1.0.0`, the branch `zaquia/0.9.0` uses TCA `0.55.1`.
## Usage
You can use the `LoadableReducer` in 3 simple steps: reducer, view, and store.
### The reducer
Conform your new reducer with `LoadableReducer`, and implement your TCA reducer as you normally would:
```swift
struct MyFeature: LoadableReducer { // instead of `Reducer`
// ...
}
```
There are three required steps to conform to `LoadableReducer`:
1. Conform your `State` to `LoadedState`. This will require you to hold on to an instance of your `LoadingState`;
2. Provide a `LoadingState` type that includes data you will have available when the feature starts, but before it fully loads;
3. Declare the `load(_:)` function. It receives the `LoadingState` and returns the reducer's `State`.
```swift
struct MyFeature: LoadableReducer {
struct State: LoadedState { // 1. conform your state to `LoadedState`
var loadingState: LoadingState
/* ... */
}
enum Action { /* ... */ }
var body: some ReducerOf { /* ... */ }
}
extension MyFeature {
struct LoadingState: Equatable { // 2. Declare a `LoadingState` type.
/* ... */
}
func load(_ loadingState: LoadingState) async throws -> State { // 3. Add the `load(_:)` function.
/* ... */
}
}
```
> **Note:**
> By default, your reducer does the first load when the initial view appears, but you can customise that by providing your own initial view (see [The view](#the-view)).
**[Optional]** You may refresh or reload the reducer based on a "ready" action. Refreshing will preserve your current loaded content, but reloading will not.
```swift
struct MyFeature: LoadableReducer {
/* ... */
enum Action {
case somethingChanged
/* ... */
}
func updateRequest(for action: Action) -> UpdateRequest? {
if action == .somethingChanged {
return .reload // the reducer will discard the current data and will fetch new data.
}
return nil // does nothing.
}
}
```
### The view
You can build a view for your loadable reducer with `WithLoadableStore(...)`. An optional `animation` parameter gives you control over the transition animation between states.
```swift
struct MyFeatureView: View {
// 1. Declare a store to your loadable reducer using the convenience alias.
let store: LoadableStoreOf
var body: some View {
// 2. Build your views with the `WithLoadableStore(...)` helper.
WithLoadableStore(store) { loadedStore in
WithViewStore(loadedStore) { viewStore in
VStack {
Text("Ready!")
Button("Reload") { viewStore.send(.reload) }
}
}
}
}
}
```
**[Optional]** You may override the default loading view. When doing so, make sure to trigger the built-in `.load` action at some point, or the loading will never start.
> **Note:**
> The same applies for the error view and its `.retry` action.
```swift
struct MyFeatureView: View {
/* ... */
var body: some View {
WithLoadableStore(store) { loadedStore in
/* ... */
} loading: { loadingStore in
WithViewStore(loadingStore) { viewStore in
Text("Loading...")
.onAppear {
// You must explicitly call `.load` when overriding the default loading view.
viewStore.send(.load)
}
}
}
}
}
```
### The store
When creating your store, make sure to wrap your `LoadableReducer` within a `LoadingReducer`.
```swift
MyFeatureView(
store: .init(
initialState: .loading(.init(/* ... */))
) {
LoadingReducer(reducer: MyFeature())
}
)
```
### Composing
When composing features, refer to the `LoadableState` and `LoadableAction` of your `LoadableReducer`, and don't forget to wrap your composed reducer in a `LoadingReducer`, too.
```swift
struct MyFeature: LoadableReducer {
struct State: LoadedState {
// Refer to the `LoadableState` instead of `State`.
@PresentationState var other: OtherFeature.LoadableState?
/* ... */
}
enum Action {
// Refer to the `LoadableAction` instead of `Action`.
case other(PresentationAction)
/* ... */
}
var body: some ReducerOf {
Reduce { /* ... */ }
.ifLet(\.$other, action: /Action.other) {
// Don't forget to wrap your reducer in a `LoadingReducer`!
LoadingReducer(reducer: OtherFeature())
}
}
}
```
## Missing features
- [X] Proper error handling: built-in error view and `retry` action.
- [X] Task cancellation tweaks.
## License
Copyright (c) 2023 @mtzaquia
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.