github/wulkanowy-mirror
1
0
Fork 1
mirror of https://github.com/wulkanowy/wulkanowy.git synced 2025-01-18 13:16:45 -06:00
Code

Add docs to Resource, changing networkBoundResource generics naming (#2483)

Browse Source
This commit is contained in:
Michael 2024-03-13 19:13:56 +01:00 committed by GitHub
parent 8a90b61b97
commit 961bc24f27
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 38 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
app/play-publish-lint.sh
View File

@ -1,7 +1,8 @@
#!/bin/bash - #!/bin/bash -
content=$(cat < "app/src/main/play/release-notes/pl-PL/default.txt") || exit content=$(cat < "app/src/main/play/release-notes/pl-PL/default.txt") || exit
if [[ "${#content}" -gt 500 ]]; then content2=echo "$content" | dos2unix
if [[ "${#content2}" -gt 500 ]]; then
echo >&2 "Release notes content has reached the limit of 500 characters" echo >&2 "Release notes content has reached the limit of 500 characters"
exit 1 exit 1
fi fi

51
app/src/main/java/io/github/wulkanowy/data/Resource.kt
View File

@ -24,13 +24,34 @@ import kotlin.time.Duration
import kotlin.time.Duration.Companion.seconds import kotlin.time.Duration.Companion.seconds
sealed interface Resource<out T> { sealed interface Resource<out T> {
/**
* The initial value of a resource flow. Indicates no data that is currently available to be shown,
* however with the expectation that the state will transition to another one soon.
*/
open class Loading<T> : Resource<T> open class Loading<T> : Resource<T>
/**
* A semi-loading state with some data available to be displayed (usually cached data loaded from
* the database). Still not the target state and it's expected to transition into another one soon.
*/
data class Intermediate<T>(val data: T) : Loading<T>() data class Intermediate<T>(val data: T) : Loading<T>()
/**
* The happy-path target state. Data can either be:
* - loaded from the database - while it may seem like this case is already handled by the
* Intermediate state, the difference here is semantic. Cached data is returned as Intermediate
* when there's a API request in progress (or soon expected to be), however when there is no
* intention of immediately querying the API, the cached data is returned as a Success.
* - fetched from the API.
*/
data class Success<T>(val data: T) : Resource<T> data class Success<T>(val data: T) : Resource<T>
/**
* Something bad happened and we were unable to get the requested data. This can be caused by
* a database error, a network error, or really just any other error. Upon receiving this state
* the UI can either: display a full screen error, or, when it has received any data previously,
* display a snack bar informing of the problem.
*/
data class Error<T>(val error: Throwable) : Resource<T> data class Error<T>(val error: Throwable) : Resource<T>
} }
@ -215,14 +236,14 @@ fun <T> Flow<Resource<T>>.debounceIntermediates(timeout: Duration = 5.seconds) =
} }
inline fun <ResultType, RequestType> networkBoundResource( inline fun <OutputType, ApiType> networkBoundResource(
mutex: Mutex = Mutex(), mutex: Mutex = Mutex(),
crossinline isResultEmpty: (ResultType) -> Boolean, crossinline isResultEmpty: (OutputType) -> Boolean,
crossinline query: () -> Flow<ResultType>, crossinline query: () -> Flow<OutputType>,
crossinline fetch: suspend () -> RequestType, crossinline fetch: suspend () -> ApiType,
crossinline saveFetchResult: suspend (old: ResultType, new: RequestType) -> Unit, crossinline saveFetchResult: suspend (old: OutputType, new: ApiType) -> Unit,
crossinline shouldFetch: (ResultType) -> Boolean = { true }, crossinline shouldFetch: (OutputType) -> Boolean = { true },
crossinline filterResult: (ResultType) -> ResultType = { it } crossinline filterResult: (OutputType) -> OutputType = { it }
) = networkBoundResource( ) = networkBoundResource(
mutex = mutex, mutex = mutex,
isResultEmpty = isResultEmpty, isResultEmpty = isResultEmpty,
@ -234,14 +255,14 @@ inline fun <ResultType, RequestType> networkBoundResource(
) )
@JvmName("networkBoundResourceWithMap") @JvmName("networkBoundResourceWithMap")
inline fun <ResultType, RequestType, MappedResultType> networkBoundResource( inline fun <DatabaseType, ApiType, OutputType> networkBoundResource(
mutex: Mutex = Mutex(), mutex: Mutex = Mutex(),
crossinline isResultEmpty: (MappedResultType) -> Boolean, crossinline isResultEmpty: (OutputType) -> Boolean,
crossinline query: () -> Flow<ResultType>, crossinline query: () -> Flow<DatabaseType>,
crossinline fetch: suspend () -> RequestType, crossinline fetch: suspend () -> ApiType,
crossinline saveFetchResult: suspend (old: ResultType, new: RequestType) -> Unit, crossinline saveFetchResult: suspend (old: DatabaseType, new: ApiType) -> Unit,
crossinline shouldFetch: (ResultType) -> Boolean = { true }, crossinline shouldFetch: (DatabaseType) -> Boolean = { true },
crossinline mapResult: (ResultType) -> MappedResultType, crossinline mapResult: (DatabaseType) -> OutputType,
) = flow { ) = flow {
emit(Resource.Loading()) emit(Resource.Loading())