Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tommus/ktx-account
Android Account Manager schema processor that generates plethora of methods in either functional and reactive manner.
https://github.com/tommus/ktx-account
accountmanager android annotation-processor annotations compile-time kotlin kotlin-library utility
Last synced: 2 days ago
JSON representation
Android Account Manager schema processor that generates plethora of methods in either functional and reactive manner.
- Host: GitHub
- URL: https://github.com/tommus/ktx-account
- Owner: tommus
- License: apache-2.0
- Created: 2019-11-09T23:59:00.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-10-25T12:27:14.000Z (about 3 years ago)
- Last Synced: 2023-09-13T21:24:46.138Z (over 1 year ago)
- Topics: accountmanager, android, annotation-processor, annotations, compile-time, kotlin, kotlin-library, utility
- Language: Kotlin
- Size: 226 KB
- Stars: 3
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Ktx Account
[![Maven Central][mavenbadge-svg]][mavencentral] [![Travis (.org) branch][travisci-svg]][travisci] [![API][apibadge-svg]][apioverview] [![GitHub][license-svg]][license]
This library makes it simpler to use Account Manager to persist user-related data providing
reactive interface.
## Usage
### Add dependencies
Add dependencies to the *Kotlin-based* project:
```groovy
dependencies {
implementation "co.windly:ktx-account:1.1.4"
kapt "co.windly:ktx-account-compiler:1.1.4"
}
```
## Define schema
Use the `@AccountSchema` annotation on any POJO. All (non static) fields will be considered an
Account Manager property.
Minimal example:
```kotlin
@AccountScheme
class AccountDefinition(
//region Id
@DefaultLong(value = 0L)
internal val id: Long,
//endregion
//region Name
@DefaultString(value = "")
internal val firstName: String,
@DefaultString(value = "")
internal val lastName: String,
//endregion
//region Properties
@DefaultInt(value = 0)
internal val age: Int,
@DefaultFloat(value = 0.0f)
internal val height: Float,
//endregion
//region Location
@DefaultDouble(value = 0.0)
internal val latitude: Double,
@DefaultDouble(value = 0.0)
internal val longitude: Double,
//endregion
//region Token
@DefaultString(value = "")
internal val accessToken: String,
@DefaultString(value = "")
internal val refreshToken: String,
@DefaultLong(value = 0L)
internal val expirationDate: Long,
//endregion
//region Miscellaneous
@DefaultBoolean(value = false)
internal val active: Boolean
//endregion
)
```
Accepted property field types are:
- Boolean
- Double
- Float
- Int
- Long
- String
## Use generated scheme class
A class named `Scheme` will be generated in the same package (at compile time). Use it like this:
```kotlin
// Get access to scheme.
val scheme = AccountDefinitionScheme(/* Context */ this)
// Define account name.
val name = "[email protected]"
// Create account.
scheme
.saveAccount(name, "WinterIsComing")
.doOnComplete(onComplete)
.subscribe()
.addTo(disposables)
// Put a single value.
scheme
.saveRxId(name, 1L)
.subscribe()
.addTo(disposables)
// Put several values in chained stream.
Completable
.mergeArrayDelayError(
scheme.saveRxFirstName(name, "John"),
scheme.saveRxLastName(name, "Snow"),
scheme.saveRxAccessToken(name, "aaaaaaa (...)"),
scheme.saveRxRefreshToken(name, "bbbbbbb (...)"),
scheme.saveRxExpirationDate(name, 1573399868L)
)
.subscribe()
.addTo(disposables)
// Access properties one by one.
scheme
.getRxId(name)
.subscribe { id -> Log.d(TAG, "id -> $id.") }
.addTo(disposables)
// Clear all properties (mostly for testing purposes).
scheme
.clearRx(name)
.subscribe()
.addTo(disposables)
// Remove account.
scheme
.removeAccount(name)
.subscribe { Log.d(TAG, "Account has been removed.") }
.addTo(disposables)
```
## Reactive Extensions
Library supports generation of reactive methods (see sample above). You can disable this feature either by:
- annotating class with `@Reactive(value = false)`,
- annotating field with `@Reactive(value = false)`.
All property changes are emitted to given stream using `distinctUntilChanged()` method. You can configure this
behavior in `@Reactive` annotation (property `distinctUntilChanged`) for entire class or for each field separately.
## License
Copyright 2019 Tomasz Dzieniak
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
[apibadge-svg]: https://img.shields.io/badge/API-22%2B-brightgreen.svg?color=97ca00
[apioverview]: https://developer.android.com/about/versions/android-5.1
[license-svg]: https://img.shields.io/github/license/tommus/ktx-account.svg?color=97ca00
[license]: http://www.apache.org/licenses/LICENSE-2.0
[mavenbadge-svg]: https://img.shields.io/maven-central/v/co.windly/ktx-account.svg?color=97ca00
[mavencentral]: https://search.maven.org/artifact/co.windly/ktx-account
[travisci-svg]: https://img.shields.io/travis/tommus/ktx-account/master.svg?color=97ca00
[travisci]: https://travis-ci.org/tommus/ktx-account