Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/RedMadRobot/flipper
Flipper is a simple and useful tool to deal with feature toggles
https://github.com/RedMadRobot/flipper
android android-library feature-flags feature-toggle feature-toggles kotlin kotlin-android kotlin-library
Last synced: about 2 months ago
JSON representation
Flipper is a simple and useful tool to deal with feature toggles
- Host: GitHub
- URL: https://github.com/RedMadRobot/flipper
- Owner: RedMadRobot
- License: mit
- Created: 2019-10-16T11:54:31.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-04-27T08:50:31.000Z (over 3 years ago)
- Last Synced: 2024-07-11T13:57:30.676Z (2 months ago)
- Topics: android, android-library, feature-flags, feature-toggle, feature-toggles, kotlin, kotlin-android, kotlin-library
- Language: Kotlin
- Size: 324 KB
- Stars: 71
- Watchers: 6
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
- awesome-list - RedMadRobot/flipper - Flipper is a simple and useful tool to deal with feature toggles (Kotlin)
README
# Flipper
[](https://androidweekly.net/issues/issue-384)
[](https://android-arsenal.com/api?level=16)
[](https://travis-ci.org/RedMadRobot/flipper)
Flipper is a simple and useful tool to deal with feature toggles. It's not some *secret weapon* but rather a set of best practices to work with flipping features in your application, which is shipped as a library.
### Quick start
Add this library to your gradle config
```groovy
implementation 'com.redmadrobot:flipper:1.0.6'
```
Create a class with a description of features
```kotlin
object Features {
object Feature1 : Feature() {
override val id = "Feature1"
}
}
```
Create some simplest configuration describing which features are enabled and which features are disabled:
```kotlin
class HardcodedConfig : FlipperConfig {
private val features = mapOf(
Features.Feature1.id to true
)
override fun featureIsEnabled(feature: Feature): Boolean {
return features[feature.id] ?: false
}
}
```
> If you want to manage your features with Firebase, look at [this](https://github.com/RedMadRobot/flipper/blob/master/app/src/main/java/com/redmadrobot/sample/configs/RemoteConfig.kt) config example.
Init the library in your **Application** class
```kotlin
ToggleRouter.init(HardcodedConfig())
```
Choose the necessary "feature edge" and place a toggle point (flipper point in this library terms).
```kotlin
val feature1Button = (Button) findViewById(R.id.feature1_button)
feature1Button.flipperPoint(Features.Feature1)
...
feature1Button.setOnClickListener { openFeature1Screen() }
```
Run and enjoy!
### Library components
- [`Feature`](https://github.com/RedMadRobot/flipper/blob/master/flipper/src/main/kotlin/com/redmadrobot/flipper/Feature.kt): base class for all your feature objects. You have to provide a unique identifier for each such object.
- [`ToggleRouter`](https://github.com/RedMadRobot/flipper/blob/master/flipper/src/main/kotlin/com/redmadrobot/flipper/ToggleRouter.kt): features orchestrator based on some variant of the configuration
- [`FlipperConfig`](https://github.com/RedMadRobot/flipper/blob/master/flipper/src/main/kotlin/com/redmadrobot/flipper/config/FlipperConfig.kt): base class for your variant of the feature toggle configuration
- [`flipperPoint`](https://github.com/RedMadRobot/flipper/blob/master/flipper/src/main/kotlin/com/redmadrobot/flipper/FlipperExt.kt): Kotlin extension function which you should place at the edge of your feature
### More information about the "feature edges"
When it comes to Android application, you have only three ways of transition between features.
- tap on the view (swipe like a special case)
- tap on the menu item
- an external event driven by business logic
In fact, all components that trigger transitions are the edges of the features. So, to prevent transition between features, we've got to disable the border component. You can do it using extension functions on View and MenuItem or a top-level function with flipping code blocks.
Some examples
```kotlin
with(feature4_button) {
setOnClickListener { findNavController().navigate(Feature1FragmentDirections.toFeature4()) }
flipperPoint(Features.Feature4)
}
```
```kotlin
with(bottom_nav.menu) {
findItem(R.id.feature1).flipperPoint(Features.Feature1)
findItem(R.id.feature2).flipperPoint(Features.Feature2)
findItem(R.id.feature3).flipperPoint(Features.Feature3)
}
```
```kotlin
flipperPoint(Features.Feature1) {
Log.d("Flipper", "I'll appear only when feature1 is enabled.")
}
```
```kotlin
if(flipperPointIsEnabled(Features.Feature1)) {
Log.d("Flipper", "Feature1 is enabled.")
} else {
Log.d("Flipper", "Feature1 is disabled.")
}
```
### Further reading
There is an almost "classic" article about feature toggles [Feature Toggles (aka Feature Flags)](https://www.martinfowler.com/articles/feature-toggles.html). You can read it to know more about this library underline concepts.
## Feedback
In case you have faced any bug or have a useful suggestion for improvement of this library, feel free to create an [issue](https://github.com/RedMadRobot/flipper/issues).
## LICENSE
>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.