├── app
├── .gitignore
├── src
│ └── main
│ │ ├── res
│ │ ├── values
│ │ │ ├── strings.xml
│ │ │ ├── colors.xml
│ │ │ └── styles.xml
│ │ ├── mipmap-hdpi
│ │ │ ├── ic_launcher.png
│ │ │ └── ic_launcher_round.png
│ │ ├── mipmap-mdpi
│ │ │ ├── ic_launcher.png
│ │ │ └── ic_launcher_round.png
│ │ ├── mipmap-xhdpi
│ │ │ ├── ic_launcher.png
│ │ │ └── ic_launcher_round.png
│ │ ├── mipmap-xxhdpi
│ │ │ ├── ic_launcher.png
│ │ │ └── ic_launcher_round.png
│ │ ├── mipmap-xxxhdpi
│ │ │ ├── ic_launcher.png
│ │ │ └── ic_launcher_round.png
│ │ ├── mipmap-anydpi-v26
│ │ │ ├── ic_launcher.xml
│ │ │ └── ic_launcher_round.xml
│ │ ├── layout
│ │ │ └── activity_main.xml
│ │ ├── drawable-v24
│ │ │ └── ic_launcher_foreground.xml
│ │ └── drawable
│ │ │ └── ic_launcher_background.xml
│ │ ├── AndroidManifest.xml
│ │ └── java
│ │ └── com
│ │ └── hadilq
│ │ └── liveevent
│ │ └── sample
│ │ ├── LiveEventViewModel.kt
│ │ └── MainActivity.kt
└── build.gradle.kts
├── live-event
├── .gitignore
├── src
│ ├── main
│ │ ├── AndroidManifest.xml
│ │ └── java
│ │ │ └── com
│ │ │ └── hadilq
│ │ │ └── liveevent
│ │ │ ├── LiveEventConfig.kt
│ │ │ └── LiveEvent.kt
│ └── test
│ │ └── java
│ │ └── com
│ │ └── hadilq
│ │ └── liveevent
│ │ ├── TestLifecycleOwner.kt
│ │ └── LiveEventTest.kt
└── build.gradle.kts
├── gradle
└── wrapper
│ ├── gradle-wrapper.jar
│ └── gradle-wrapper.properties
├── .gitignore
├── .idea
├── codeStyles
│ ├── codeStyleConfig.xml
│ └── Project.xml
└── .gitignore
├── .github
└── workflows
│ ├── pr-check.yaml
│ └── main-check.yaml
├── CHANGELOG.md
├── settings.gradle.kts
├── gradle.properties
├── README.md
├── gradlew.bat
├── gradlew
└── LICENSE
/app/.gitignore:
--------------------------------------------------------------------------------
1 | /build
2 |
--------------------------------------------------------------------------------
/live-event/.gitignore:
--------------------------------------------------------------------------------
1 | /build
2 |
--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.jar:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/hadilq/LiveEvent/HEAD/gradle/wrapper/gradle-wrapper.jar
--------------------------------------------------------------------------------
/app/src/main/res/values/strings.xml:
--------------------------------------------------------------------------------
1 |
2 | LiveEvent
3 |
4 |
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-hdpi/ic_launcher.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/hadilq/LiveEvent/HEAD/app/src/main/res/mipmap-hdpi/ic_launcher.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-mdpi/ic_launcher.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/hadilq/LiveEvent/HEAD/app/src/main/res/mipmap-mdpi/ic_launcher.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xhdpi/ic_launcher.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/hadilq/LiveEvent/HEAD/app/src/main/res/mipmap-xhdpi/ic_launcher.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xxhdpi/ic_launcher.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/hadilq/LiveEvent/HEAD/app/src/main/res/mipmap-xxhdpi/ic_launcher.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/hadilq/LiveEvent/HEAD/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | *.iml
2 | .gradle
3 | /local.properties
4 | build-system/keystore.gradle
5 | .DS_Store
6 | /build
7 | /captures
8 | .externalNativeBuild
9 |
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-hdpi/ic_launcher_round.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/hadilq/LiveEvent/HEAD/app/src/main/res/mipmap-hdpi/ic_launcher_round.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-mdpi/ic_launcher_round.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/hadilq/LiveEvent/HEAD/app/src/main/res/mipmap-mdpi/ic_launcher_round.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/hadilq/LiveEvent/HEAD/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/hadilq/LiveEvent/HEAD/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/hadilq/LiveEvent/HEAD/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png
--------------------------------------------------------------------------------
/live-event/src/main/AndroidManifest.xml:
--------------------------------------------------------------------------------
1 |
3 |
--------------------------------------------------------------------------------
/.idea/codeStyles/codeStyleConfig.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
--------------------------------------------------------------------------------
/.idea/.gitignore:
--------------------------------------------------------------------------------
1 | compiler.xml
2 | caches
3 | libraries
4 | modules.xml
5 | workspace.xml
6 | navEditor.xml
7 | assetWizardSettings.xml
8 | gradle.xml
9 | jarRepositories.xml
10 | misc.xml
11 | runConfigurations.xml
12 | vcs.xml
13 |
--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.properties:
--------------------------------------------------------------------------------
1 | distributionBase=GRADLE_USER_HOME
2 | distributionPath=wrapper/dists
3 | distributionUrl=https\://services.gradle.org/distributions/gradle-6.8.3-all.zip
4 | zipStoreBase=GRADLE_USER_HOME
5 | zipStorePath=wrapper/dists
6 |
--------------------------------------------------------------------------------
/app/src/main/res/values/colors.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 | #008577
4 | #00574B
5 | #D81B60
6 |
7 |
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
--------------------------------------------------------------------------------
/.idea/codeStyles/Project.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
--------------------------------------------------------------------------------
/app/src/main/res/values/styles.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/.github/workflows/pr-check.yaml:
--------------------------------------------------------------------------------
1 | name: PR Health Check
2 | on:
3 | push:
4 | branches-ignore:
5 | - main
6 |
7 | workflow_dispatch:
8 | inputs:
9 | logLevel:
10 | description: 'Log level'
11 | required: true
12 | default: 'warning'
13 | tags:
14 | description: 'Test scenario tags'
15 | jobs:
16 | check:
17 | name: Run tests and checks
18 | runs-on: ubuntu-latest
19 | steps:
20 | - uses: actions/checkout@v2
21 | - uses: actions/setup-java@v1
22 | with:
23 | java-version: '8'
24 | - name: Run all checks
25 | run: ./gradlew check
26 |
--------------------------------------------------------------------------------
/live-event/src/main/java/com/hadilq/liveevent/LiveEventConfig.kt:
--------------------------------------------------------------------------------
1 | package com.hadilq.liveevent
2 |
3 | enum class LiveEventConfig {
4 | /**
5 | * Supports multi-observers on all cases the same.
6 | */
7 | Normal,
8 |
9 | /**
10 | * Prefer the first observer when user emit the event, register observer, then the `onStart`
11 | * get called. In this case the _first observer_ will receive the _last event_.
12 | *
13 | * This scenario is specially useful when you want to emit the event in the `init` of
14 | * `ViewModel`, and expect the first observer receive it after `onStart`.
15 | */
16 | PreferFirstObserver
17 | }
18 |
--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | Changelog
2 | =========
3 |
4 | 1.3.0
5 | ----
6 |
7 | _2021-06-26_
8 |
9 | - Create `LiveEventConfig` to handle `PreferFirstObserver` behavior.
10 |
11 | 1.2.3
12 | ----
13 |
14 | _2021-04-15_
15 |
16 | - Avoid adding existing observer.
17 |
18 | 1.2.2
19 | ----
20 |
21 | _2021-04-14_
22 |
23 | - Make it work with Android!
24 |
25 | 1.2.1
26 | ----
27 |
28 | _2021-04-13_
29 |
30 | - Change the group id from `com.github.hadilq.liveevent` to `com.github.hadilq`
31 | - Change the module name from `liveevent` to `live-event`
32 | - Update Kotlin
33 | - Update gradle and gradle plugin
34 | - Fix a reported lint error
35 |
36 |
37 | 1.2.0
38 | ----
39 |
40 | Have no record
41 |
--------------------------------------------------------------------------------
/settings.gradle.kts:
--------------------------------------------------------------------------------
1 | /**
2 | * Copyright 2019 Hadi Lashkari Ghouchani
3 |
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 |
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 |
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 | include(":app", ":live-event")
17 |
--------------------------------------------------------------------------------
/.github/workflows/main-check.yaml:
--------------------------------------------------------------------------------
1 | name: Health Check
2 | on:
3 | push:
4 | branches:
5 | - main
6 |
7 | workflow_dispatch:
8 | inputs:
9 | logLevel:
10 | description: 'Log level'
11 | required: true
12 | default: 'warning'
13 | tags:
14 | description: 'Test scenario tags'
15 | jobs:
16 | check:
17 | name: Run tests and checks
18 | runs-on: ubuntu-latest
19 | steps:
20 | - uses: actions/checkout@v2
21 | - uses: actions/setup-java@v1
22 | with:
23 | java-version: '8'
24 | - name: Run all checks
25 | run: ./gradlew check
26 | - name: Publish SNAPSHOT
27 | env:
28 | OSSRH_USERNAME: ${{ secrets.OSSRH_USERNAME }}
29 | OSSRH_PASSWORD: ${{ secrets.OSSRH_PASSWORD }}
30 | run: ./gradlew :live-event:publish
31 |
--------------------------------------------------------------------------------
/app/src/main/AndroidManifest.xml:
--------------------------------------------------------------------------------
1 |
3 |
4 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
--------------------------------------------------------------------------------
/gradle.properties:
--------------------------------------------------------------------------------
1 | # Project-wide Gradle settings.
2 | # IDE (e.g. Android Studio) users:
3 | # Gradle settings configured through the IDE *will override*
4 | # any settings specified in this file.
5 | # For more details on how to configure your build environment visit
6 | # http://www.gradle.org/docs/current/userguide/build_environment.html
7 | # Specifies the JVM arguments used for the daemon process.
8 | # The setting is particularly useful for tweaking memory settings.
9 | org.gradle.jvmargs=-Xmx1536m
10 | # When configured, Gradle will run in incubating parallel mode.
11 | # This option should only be used with decoupled projects. More details, visit
12 | # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
13 | # org.gradle.parallel=true
14 | # Kotlin code style for this project: "official" or "obsolete":
15 | kotlin.code.style=official
16 | android.useAndroidX=true
--------------------------------------------------------------------------------
/app/build.gradle.kts:
--------------------------------------------------------------------------------
1 | plugins {
2 | id("com.android.application")
3 | kotlin("android")
4 | kotlin("android.extensions")
5 | kotlin("kapt")
6 | }
7 |
8 | android {
9 | compileSdkVersion(Versions.compileSdkVersion)
10 | defaultConfig {
11 | applicationId = "com.hadilq.liveevent.sample"
12 | minSdkVersion(Versions.minSdkVersion)
13 | targetSdkVersion(Versions.targetSdkVersion)
14 | versionCode = 1
15 | versionName = "1.0"
16 | testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
17 | }
18 | }
19 |
20 | dependencies {
21 | kapt(Depends.archComponentsCompiler)
22 |
23 | // implementation(project(":live-event"))
24 | implementation("${Versions.groupId}:${Versions.artifactId}:${Versions.libVersion}")
25 |
26 | implementation(Depends.kotlin)
27 | implementation(Depends.supportCompat)
28 | implementation(Depends.constraintLayout)
29 | implementation(Depends.archComponents)
30 | }
31 |
--------------------------------------------------------------------------------
/app/src/main/java/com/hadilq/liveevent/sample/LiveEventViewModel.kt:
--------------------------------------------------------------------------------
1 | /**
2 | * Copyright 2019 Hadi Lashkari Ghouchani
3 |
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 |
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 |
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 | package com.hadilq.liveevent.sample
17 |
18 | import androidx.lifecycle.LiveData
19 | import androidx.lifecycle.ViewModel
20 | import com.hadilq.liveevent.LiveEvent
21 |
22 | class LiveEventViewModel : ViewModel() {
23 | private val clickedState = LiveEvent()
24 | val state: LiveData = clickedState
25 |
26 | fun clicked() {
27 | clickedState.value = "${if (clickedState.value == null) "" else clickedState.value} clicked!"
28 | }
29 | }
--------------------------------------------------------------------------------
/app/src/main/res/layout/activity_main.xml:
--------------------------------------------------------------------------------
1 |
2 |
8 |
9 |
21 |
22 |
31 |
32 |
--------------------------------------------------------------------------------
/live-event/build.gradle.kts:
--------------------------------------------------------------------------------
1 | /**
2 | * Copyright 2019 Hadi Lashkari Ghouchani
3 |
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 |
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 |
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 | plugins {
17 | id("com.android.library")
18 | kotlin("android")
19 | kotlin("android.extensions")
20 | }
21 |
22 | setupPublication()
23 |
24 | android {
25 | compileSdkVersion(Versions.compileSdkVersion)
26 |
27 | defaultConfig {
28 | minSdkVersion(Versions.minSdkVersion)
29 | targetSdkVersion(Versions.targetSdkVersion)
30 | versionName(Versions.libVersion)
31 | }
32 |
33 | buildTypes {
34 | getByName("release") {
35 | isMinifyEnabled = false
36 | }
37 | }
38 | }
39 |
40 | dependencies {
41 | implementation(Depends.kotlin)
42 | implementation(Depends.archComponents)
43 |
44 | testImplementation(Depends.kotlin)
45 | testImplementation(Depends.junit)
46 | testImplementation(Depends.coreTesting)
47 | testImplementation(Depends.mockito)
48 | }
49 |
--------------------------------------------------------------------------------
/app/src/main/java/com/hadilq/liveevent/sample/MainActivity.kt:
--------------------------------------------------------------------------------
1 | /**
2 | * Copyright 2019 Hadi Lashkari Ghouchani
3 |
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 |
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 |
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 | package com.hadilq.liveevent.sample
17 |
18 | import android.os.Bundle
19 | import android.util.Log
20 | import androidx.appcompat.app.AppCompatActivity
21 | import androidx.lifecycle.Observer
22 | import androidx.lifecycle.ViewModelProviders
23 | import kotlinx.android.synthetic.main.activity_main.*
24 |
25 | class MainActivity : AppCompatActivity() {
26 |
27 | private lateinit var viewModel: LiveEventViewModel
28 |
29 | override fun onCreate(savedInstanceState: Bundle?) {
30 | super.onCreate(savedInstanceState)
31 | setContentView(R.layout.activity_main)
32 |
33 | viewModel = ViewModelProviders.of(this).get(LiveEventViewModel::class.java)
34 |
35 | viewModel.state.observe(this, Observer {
36 | Log.d("MainActivity", "New click")
37 | titleView.text = it
38 | })
39 | buttonView.setOnClickListener { viewModel.clicked() }
40 | }
41 | }
--------------------------------------------------------------------------------
/app/src/main/res/drawable-v24/ic_launcher_foreground.xml:
--------------------------------------------------------------------------------
1 |
7 |
12 |
13 |
19 |
22 |
25 |
26 |
27 |
28 |
34 |
35 |
--------------------------------------------------------------------------------
/live-event/src/test/java/com/hadilq/liveevent/TestLifecycleOwner.kt:
--------------------------------------------------------------------------------
1 | /**
2 | * Copyright 2019 Hadi Lashkari Ghouchani
3 |
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 |
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 |
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 | package com.hadilq.liveevent
17 |
18 | import androidx.annotation.NonNull
19 | import androidx.lifecycle.Lifecycle
20 | import androidx.lifecycle.LifecycleOwner
21 | import androidx.lifecycle.LifecycleRegistry
22 |
23 |
24 | class TestLifecycleOwner() : LifecycleOwner {
25 | private val registry = LifecycleRegistry(this)
26 |
27 | val currentState: Lifecycle.State
28 | @NonNull
29 | get() = registry.currentState
30 |
31 | fun create(): TestLifecycleOwner {
32 | return handleLifecycleEvent(Lifecycle.Event.ON_CREATE)
33 | }
34 |
35 | fun start(): TestLifecycleOwner {
36 | return handleLifecycleEvent(Lifecycle.Event.ON_START)
37 | }
38 |
39 | fun resume(): TestLifecycleOwner {
40 | return handleLifecycleEvent(Lifecycle.Event.ON_RESUME)
41 | }
42 |
43 | fun pause(): TestLifecycleOwner {
44 | return handleLifecycleEvent(Lifecycle.Event.ON_PAUSE)
45 | }
46 |
47 | fun stop(): TestLifecycleOwner {
48 | return handleLifecycleEvent(Lifecycle.Event.ON_STOP)
49 | }
50 |
51 | fun destroy(): TestLifecycleOwner {
52 | return handleLifecycleEvent(Lifecycle.Event.ON_DESTROY)
53 | }
54 |
55 | private fun handleLifecycleEvent(@NonNull event: Lifecycle.Event): TestLifecycleOwner {
56 | registry.handleLifecycleEvent(event)
57 | return this
58 | }
59 |
60 | @NonNull
61 | override fun getLifecycle(): Lifecycle {
62 | return registry
63 | }
64 | }
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | 
2 | [](https://maven-badges.herokuapp.com/maven-central/com.github.hadilq/live-event)
3 |
4 | # Live Event
5 | This library holds a class to handle single live events in Android MVVM architectural pattern. This class is extended
6 | form LiveData class, from `androidx.lifecycle:lifecycle-extensions` library, to propagate the data as an event,
7 | which means it emits data just once, not after configuration changes again. Note that event will only be sent
8 | to active observers, any observers that started observing after the emit won't be notified of the event.
9 |
10 | # Usage
11 | This source has a sample app where you can find `LiveEventViewModel` in it, in which the `LiveEvent` class is used as
12 | follows.
13 | ```kotlin
14 | class LiveEventViewModel : ViewModel() {
15 | private val clickedState = LiveEvent()
16 | val state: LiveData = clickedState
17 |
18 | fun clicked() {
19 | clickedState.value = ...
20 | }
21 | }
22 | ```
23 |
24 | ## LiveEventConfig
25 | There are two behaviours of `LiveEvent` in-demand. First one is `LiveEventConfig.Normal`,
26 | where supports multi-observers on all cases the same. This config was originally implemented for
27 | this library so it's the default config, but if you want to be explicit, you can pass it to the
28 | constructor of `LiveEvent`.
29 |
30 | The second config is `LiveEventConfig.PreferFirstObserver`. This one is useful when you want to
31 | emit an event in the `init` method of `ViewModel` and expect the _first observer_ receive it.
32 | To set it up you need to pass it to the constructor
33 |
34 | ```kotlin
35 | private val clickedState = LiveEvent(config = LiveEventConfig.PreferFirstObserver)
36 | ```
37 |
38 | # Download
39 | Download via gradle
40 | ```groovy
41 | implementation "com.github.hadilq:live-event:$libVersion"
42 | ```
43 | where you can find the `libVersion` in the [Releases](https://github.com/hadilq/LiveEvent/releases) page of this repository.
44 |
45 | Snapshots of the development version are available in [Sonatype's snapshots repository](https://oss.sonatype.org/content/repositories/snapshots).
46 |
47 | # Contribution
48 | Just create your branch from the master branch, change it, write additional tests, satisfy all tests, create your pull
49 | request, thank you, you're awesome.
50 |
--------------------------------------------------------------------------------
/gradlew.bat:
--------------------------------------------------------------------------------
1 | @if "%DEBUG%" == "" @echo off
2 | @rem ##########################################################################
3 | @rem
4 | @rem Gradle startup script for Windows
5 | @rem
6 | @rem ##########################################################################
7 |
8 | @rem Set local scope for the variables with windows NT shell
9 | if "%OS%"=="Windows_NT" setlocal
10 |
11 | set DIRNAME=%~dp0
12 | if "%DIRNAME%" == "" set DIRNAME=.
13 | set APP_BASE_NAME=%~n0
14 | set APP_HOME=%DIRNAME%
15 |
16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
17 | set DEFAULT_JVM_OPTS="-Xmx64m"
18 |
19 | @rem Find java.exe
20 | if defined JAVA_HOME goto findJavaFromJavaHome
21 |
22 | set JAVA_EXE=java.exe
23 | %JAVA_EXE% -version >NUL 2>&1
24 | if "%ERRORLEVEL%" == "0" goto init
25 |
26 | echo.
27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
28 | echo.
29 | echo Please set the JAVA_HOME variable in your environment to match the
30 | echo location of your Java installation.
31 |
32 | goto fail
33 |
34 | :findJavaFromJavaHome
35 | set JAVA_HOME=%JAVA_HOME:"=%
36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe
37 |
38 | if exist "%JAVA_EXE%" goto init
39 |
40 | echo.
41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
42 | echo.
43 | echo Please set the JAVA_HOME variable in your environment to match the
44 | echo location of your Java installation.
45 |
46 | goto fail
47 |
48 | :init
49 | @rem Get command-line arguments, handling Windows variants
50 |
51 | if not "%OS%" == "Windows_NT" goto win9xME_args
52 |
53 | :win9xME_args
54 | @rem Slurp the command line arguments.
55 | set CMD_LINE_ARGS=
56 | set _SKIP=2
57 |
58 | :win9xME_args_slurp
59 | if "x%~1" == "x" goto execute
60 |
61 | set CMD_LINE_ARGS=%*
62 |
63 | :execute
64 | @rem Setup the command line
65 |
66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
67 |
68 | @rem Execute Gradle
69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
70 |
71 | :end
72 | @rem End local scope for the variables with windows NT shell
73 | if "%ERRORLEVEL%"=="0" goto mainEnd
74 |
75 | :fail
76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
77 | rem the _cmd.exe /c_ return code!
78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
79 | exit /b 1
80 |
81 | :mainEnd
82 | if "%OS%"=="Windows_NT" endlocal
83 |
84 | :omega
85 |
--------------------------------------------------------------------------------
/live-event/src/main/java/com/hadilq/liveevent/LiveEvent.kt:
--------------------------------------------------------------------------------
1 | /**
2 | * Copyright 2019 Hadi Lashkari Ghouchani
3 |
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 |
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 |
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 | package com.hadilq.liveevent
17 |
18 | import androidx.annotation.MainThread
19 | import androidx.collection.ArraySet
20 | import androidx.lifecycle.LifecycleOwner
21 | import androidx.lifecycle.MediatorLiveData
22 | import androidx.lifecycle.Observer
23 |
24 | open class LiveEvent(
25 | private val config: LiveEventConfig = LiveEventConfig.Normal
26 | ) : MediatorLiveData() {
27 |
28 | private val observers = ArraySet>()
29 | private var hasValueWithoutFirstObserver: Boolean = false
30 |
31 | @MainThread
32 | override fun observe(owner: LifecycleOwner, observer: Observer) {
33 | observers.find { it.observer === observer }?.let { _ -> // existing
34 | return
35 | }
36 | val wrapper = ObserverWrapper(observer)
37 | if (hasValueWithoutFirstObserver) {
38 | hasValueWithoutFirstObserver = false
39 | wrapper.newValue()
40 | }
41 | observers.add(wrapper)
42 | super.observe(owner, wrapper)
43 | }
44 |
45 | @MainThread
46 | override fun observeForever(observer: Observer) {
47 | observers.find { it.observer === observer }?.let { _ -> // existing
48 | return
49 | }
50 | val wrapper = ObserverWrapper(observer)
51 | observers.add(wrapper)
52 | super.observeForever(wrapper)
53 | }
54 |
55 | @MainThread
56 | override fun removeObserver(observer: Observer) {
57 | if (observer is ObserverWrapper && observers.remove(observer)) {
58 | super.removeObserver(observer)
59 | return
60 | }
61 | val iterator = observers.iterator()
62 | while (iterator.hasNext()) {
63 | val wrapper = iterator.next()
64 | if (wrapper.observer == observer) {
65 | iterator.remove()
66 | super.removeObserver(wrapper)
67 | break
68 | }
69 | }
70 | }
71 |
72 | @MainThread
73 | override fun setValue(t: T?) {
74 | if (config == LiveEventConfig.PreferFirstObserver &&
75 | observers.isEmpty()
76 | ) {
77 | hasValueWithoutFirstObserver = true
78 | }
79 | observers.forEach { it.newValue() }
80 | super.setValue(t)
81 | }
82 |
83 | private class ObserverWrapper(val observer: Observer) : Observer {
84 |
85 | private var pending = false
86 |
87 | override fun onChanged(t: T?) {
88 | if (pending) {
89 | pending = false
90 | observer.onChanged(t)
91 | }
92 | }
93 |
94 | fun newValue() {
95 | pending = true
96 | }
97 | }
98 | }
99 |
--------------------------------------------------------------------------------
/app/src/main/res/drawable/ic_launcher_background.xml:
--------------------------------------------------------------------------------
1 |
2 |
8 |
10 |
12 |
14 |
16 |
18 |
20 |
22 |
24 |
26 |
28 |
30 |
32 |
34 |
36 |
38 |
40 |
42 |
44 |
46 |
48 |
50 |
52 |
54 |
56 |
58 |
60 |
62 |
64 |
66 |
68 |
70 |
72 |
74 |
75 |
--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env sh
2 |
3 | ##############################################################################
4 | ##
5 | ## Gradle start up script for UN*X
6 | ##
7 | ##############################################################################
8 |
9 | # Attempt to set APP_HOME
10 | # Resolve links: $0 may be a link
11 | PRG="$0"
12 | # Need this for relative symlinks.
13 | while [ -h "$PRG" ] ; do
14 | ls=`ls -ld "$PRG"`
15 | link=`expr "$ls" : '.*-> \(.*\)$'`
16 | if expr "$link" : '/.*' > /dev/null; then
17 | PRG="$link"
18 | else
19 | PRG=`dirname "$PRG"`"/$link"
20 | fi
21 | done
22 | SAVED="`pwd`"
23 | cd "`dirname \"$PRG\"`/" >/dev/null
24 | APP_HOME="`pwd -P`"
25 | cd "$SAVED" >/dev/null
26 |
27 | APP_NAME="Gradle"
28 | APP_BASE_NAME=`basename "$0"`
29 |
30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
31 | DEFAULT_JVM_OPTS='"-Xmx64m"'
32 |
33 | # Use the maximum available, or set MAX_FD != -1 to use that value.
34 | MAX_FD="maximum"
35 |
36 | warn () {
37 | echo "$*"
38 | }
39 |
40 | die () {
41 | echo
42 | echo "$*"
43 | echo
44 | exit 1
45 | }
46 |
47 | # OS specific support (must be 'true' or 'false').
48 | cygwin=false
49 | msys=false
50 | darwin=false
51 | nonstop=false
52 | case "`uname`" in
53 | CYGWIN* )
54 | cygwin=true
55 | ;;
56 | Darwin* )
57 | darwin=true
58 | ;;
59 | MINGW* )
60 | msys=true
61 | ;;
62 | NONSTOP* )
63 | nonstop=true
64 | ;;
65 | esac
66 |
67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
68 |
69 | # Determine the Java command to use to start the JVM.
70 | if [ -n "$JAVA_HOME" ] ; then
71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
72 | # IBM's JDK on AIX uses strange locations for the executables
73 | JAVACMD="$JAVA_HOME/jre/sh/java"
74 | else
75 | JAVACMD="$JAVA_HOME/bin/java"
76 | fi
77 | if [ ! -x "$JAVACMD" ] ; then
78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
79 |
80 | Please set the JAVA_HOME variable in your environment to match the
81 | location of your Java installation."
82 | fi
83 | else
84 | JAVACMD="java"
85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
86 |
87 | Please set the JAVA_HOME variable in your environment to match the
88 | location of your Java installation."
89 | fi
90 |
91 | # Increase the maximum file descriptors if we can.
92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
93 | MAX_FD_LIMIT=`ulimit -H -n`
94 | if [ $? -eq 0 ] ; then
95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
96 | MAX_FD="$MAX_FD_LIMIT"
97 | fi
98 | ulimit -n $MAX_FD
99 | if [ $? -ne 0 ] ; then
100 | warn "Could not set maximum file descriptor limit: $MAX_FD"
101 | fi
102 | else
103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
104 | fi
105 | fi
106 |
107 | # For Darwin, add options to specify how the application appears in the dock
108 | if $darwin; then
109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
110 | fi
111 |
112 | # For Cygwin, switch paths to Windows format before running java
113 | if $cygwin ; then
114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"`
115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
116 | JAVACMD=`cygpath --unix "$JAVACMD"`
117 |
118 | # We build the pattern for arguments to be converted via cygpath
119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
120 | SEP=""
121 | for dir in $ROOTDIRSRAW ; do
122 | ROOTDIRS="$ROOTDIRS$SEP$dir"
123 | SEP="|"
124 | done
125 | OURCYGPATTERN="(^($ROOTDIRS))"
126 | # Add a user-defined pattern to the cygpath arguments
127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then
128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
129 | fi
130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh
131 | i=0
132 | for arg in "$@" ; do
133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
135 |
136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
138 | else
139 | eval `echo args$i`="\"$arg\""
140 | fi
141 | i=$((i+1))
142 | done
143 | case $i in
144 | (0) set -- ;;
145 | (1) set -- "$args0" ;;
146 | (2) set -- "$args0" "$args1" ;;
147 | (3) set -- "$args0" "$args1" "$args2" ;;
148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
154 | esac
155 | fi
156 |
157 | # Escape application args
158 | save () {
159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
160 | echo " "
161 | }
162 | APP_ARGS=$(save "$@")
163 |
164 | # Collect all arguments for the java command, following the shell quoting and substitution rules
165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
166 |
167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
169 | cd "$(dirname "$0")"
170 | fi
171 |
172 | exec "$JAVACMD" "$@"
173 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 |
2 | Apache License
3 | Version 2.0, January 2004
4 | http://www.apache.org/licenses/
5 |
6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7 |
8 | 1. Definitions.
9 |
10 | "License" shall mean the terms and conditions for use, reproduction,
11 | and distribution as defined by Sections 1 through 9 of this document.
12 |
13 | "Licensor" shall mean the copyright owner or entity authorized by
14 | the copyright owner that is granting the License.
15 |
16 | "Legal Entity" shall mean the union of the acting entity and all
17 | other entities that control, are controlled by, or are under common
18 | control with that entity. For the purposes of this definition,
19 | "control" means (i) the power, direct or indirect, to cause the
20 | direction or management of such entity, whether by contract or
21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
22 | outstanding shares, or (iii) beneficial ownership of such entity.
23 |
24 | "You" (or "Your") shall mean an individual or Legal Entity
25 | exercising permissions granted by this License.
26 |
27 | "Source" form shall mean the preferred form for making modifications,
28 | including but not limited to software source code, documentation
29 | source, and configuration files.
30 |
31 | "Object" form shall mean any form resulting from mechanical
32 | transformation or translation of a Source form, including but
33 | not limited to compiled object code, generated documentation,
34 | and conversions to other media types.
35 |
36 | "Work" shall mean the work of authorship, whether in Source or
37 | Object form, made available under the License, as indicated by a
38 | copyright notice that is included in or attached to the work
39 | (an example is provided in the Appendix below).
40 |
41 | "Derivative Works" shall mean any work, whether in Source or Object
42 | form, that is based on (or derived from) the Work and for which the
43 | editorial revisions, annotations, elaborations, or other modifications
44 | represent, as a whole, an original work of authorship. For the purposes
45 | of this License, Derivative Works shall not include works that remain
46 | separable from, or merely link (or bind by name) to the interfaces of,
47 | the Work and Derivative Works thereof.
48 |
49 | "Contribution" shall mean any work of authorship, including
50 | the original version of the Work and any modifications or additions
51 | to that Work or Derivative Works thereof, that is intentionally
52 | submitted to Licensor for inclusion in the Work by the copyright owner
53 | or by an individual or Legal Entity authorized to submit on behalf of
54 | the copyright owner. For the purposes of this definition, "submitted"
55 | means any form of electronic, verbal, or written communication sent
56 | to the Licensor or its representatives, including but not limited to
57 | communication on electronic mailing lists, source code control systems,
58 | and issue tracking systems that are managed by, or on behalf of, the
59 | Licensor for the purpose of discussing and improving the Work, but
60 | excluding communication that is conspicuously marked or otherwise
61 | designated in writing by the copyright owner as "Not a Contribution."
62 |
63 | "Contributor" shall mean Licensor and any individual or Legal Entity
64 | on behalf of whom a Contribution has been received by Licensor and
65 | subsequently incorporated within the Work.
66 |
67 | 2. Grant of Copyright License. Subject to the terms and conditions of
68 | this License, each Contributor hereby grants to You a perpetual,
69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70 | copyright license to reproduce, prepare Derivative Works of,
71 | publicly display, publicly perform, sublicense, and distribute the
72 | Work and such Derivative Works in Source or Object form.
73 |
74 | 3. Grant of Patent License. Subject to the terms and conditions of
75 | this License, each Contributor hereby grants to You a perpetual,
76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77 | (except as stated in this section) patent license to make, have made,
78 | use, offer to sell, sell, import, and otherwise transfer the Work,
79 | where such license applies only to those patent claims licensable
80 | by such Contributor that are necessarily infringed by their
81 | Contribution(s) alone or by combination of their Contribution(s)
82 | with the Work to which such Contribution(s) was submitted. If You
83 | institute patent litigation against any entity (including a
84 | cross-claim or counterclaim in a lawsuit) alleging that the Work
85 | or a Contribution incorporated within the Work constitutes direct
86 | or contributory patent infringement, then any patent licenses
87 | granted to You under this License for that Work shall terminate
88 | as of the date such litigation is filed.
89 |
90 | 4. Redistribution. You may reproduce and distribute copies of the
91 | Work or Derivative Works thereof in any medium, with or without
92 | modifications, and in Source or Object form, provided that You
93 | meet the following conditions:
94 |
95 | (a) You must give any other recipients of the Work or
96 | Derivative Works a copy of this License; and
97 |
98 | (b) You must cause any modified files to carry prominent notices
99 | stating that You changed the files; and
100 |
101 | (c) You must retain, in the Source form of any Derivative Works
102 | that You distribute, all copyright, patent, trademark, and
103 | attribution notices from the Source form of the Work,
104 | excluding those notices that do not pertain to any part of
105 | the Derivative Works; and
106 |
107 | (d) If the Work includes a "NOTICE" text file as part of its
108 | distribution, then any Derivative Works that You distribute must
109 | include a readable copy of the attribution notices contained
110 | within such NOTICE file, excluding those notices that do not
111 | pertain to any part of the Derivative Works, in at least one
112 | of the following places: within a NOTICE text file distributed
113 | as part of the Derivative Works; within the Source form or
114 | documentation, if provided along with the Derivative Works; or,
115 | within a display generated by the Derivative Works, if and
116 | wherever such third-party notices normally appear. The contents
117 | of the NOTICE file are for informational purposes only and
118 | do not modify the License. You may add Your own attribution
119 | notices within Derivative Works that You distribute, alongside
120 | or as an addendum to the NOTICE text from the Work, provided
121 | that such additional attribution notices cannot be construed
122 | as modifying the License.
123 |
124 | You may add Your own copyright statement to Your modifications and
125 | may provide additional or different license terms and conditions
126 | for use, reproduction, or distribution of Your modifications, or
127 | for any such Derivative Works as a whole, provided Your use,
128 | reproduction, and distribution of the Work otherwise complies with
129 | the conditions stated in this License.
130 |
131 | 5. Submission of Contributions. Unless You explicitly state otherwise,
132 | any Contribution intentionally submitted for inclusion in the Work
133 | by You to the Licensor shall be under the terms and conditions of
134 | this License, without any additional terms or conditions.
135 | Notwithstanding the above, nothing herein shall supersede or modify
136 | the terms of any separate license agreement you may have executed
137 | with Licensor regarding such Contributions.
138 |
139 | 6. Trademarks. This License does not grant permission to use the trade
140 | names, trademarks, service marks, or product names of the Licensor,
141 | except as required for reasonable and customary use in describing the
142 | origin of the Work and reproducing the content of the NOTICE file.
143 |
144 | 7. Disclaimer of Warranty. Unless required by applicable law or
145 | agreed to in writing, Licensor provides the Work (and each
146 | Contributor provides its Contributions) on an "AS IS" BASIS,
147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148 | implied, including, without limitation, any warranties or conditions
149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150 | PARTICULAR PURPOSE. You are solely responsible for determining the
151 | appropriateness of using or redistributing the Work and assume any
152 | risks associated with Your exercise of permissions under this License.
153 |
154 | 8. Limitation of Liability. In no event and under no legal theory,
155 | whether in tort (including negligence), contract, or otherwise,
156 | unless required by applicable law (such as deliberate and grossly
157 | negligent acts) or agreed to in writing, shall any Contributor be
158 | liable to You for damages, including any direct, indirect, special,
159 | incidental, or consequential damages of any character arising as a
160 | result of this License or out of the use or inability to use the
161 | Work (including but not limited to damages for loss of goodwill,
162 | work stoppage, computer failure or malfunction, or any and all
163 | other commercial damages or losses), even if such Contributor
164 | has been advised of the possibility of such damages.
165 |
166 | 9. Accepting Warranty or Additional Liability. While redistributing
167 | the Work or Derivative Works thereof, You may choose to offer,
168 | and charge a fee for, acceptance of support, warranty, indemnity,
169 | or other liability obligations and/or rights consistent with this
170 | License. However, in accepting such obligations, You may act only
171 | on Your own behalf and on Your sole responsibility, not on behalf
172 | of any other Contributor, and only if You agree to indemnify,
173 | defend, and hold each Contributor harmless for any liability
174 | incurred by, or claims asserted against, such Contributor by reason
175 | of your accepting any such warranty or additional liability.
176 |
177 | END OF TERMS AND CONDITIONS
178 |
179 | APPENDIX: How to apply the Apache License to your work.
180 |
181 | To apply the Apache License to your work, attach the following
182 | boilerplate notice, with the fields enclosed by brackets "[]"
183 | replaced with your own identifying information. (Don't include
184 | the brackets!) The text should be enclosed in the appropriate
185 | comment syntax for the file format. We also recommend that a
186 | file or class name and description of purpose be included on the
187 | same "printed page" as the copyright notice for easier
188 | identification within third-party archives.
189 |
190 | Copyright [yyyy] [name of copyright owner]
191 |
192 | Licensed under the Apache License, Version 2.0 (the "License");
193 | you may not use this file except in compliance with the License.
194 | You may obtain a copy of the License at
195 |
196 | http://www.apache.org/licenses/LICENSE-2.0
197 |
198 | Unless required by applicable law or agreed to in writing, software
199 | distributed under the License is distributed on an "AS IS" BASIS,
200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201 | See the License for the specific language governing permissions and
202 | limitations under the License.
--------------------------------------------------------------------------------
/live-event/src/test/java/com/hadilq/liveevent/LiveEventTest.kt:
--------------------------------------------------------------------------------
1 | /**
2 | * Copyright 2019 Hadi Lashkari Ghouchani
3 |
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 |
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 |
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 | package com.hadilq.liveevent
17 |
18 | import androidx.arch.core.executor.testing.InstantTaskExecutorRule
19 | import androidx.lifecycle.Observer
20 | import com.nhaarman.mockitokotlin2.mock
21 | import com.nhaarman.mockitokotlin2.never
22 | import com.nhaarman.mockitokotlin2.times
23 | import com.nhaarman.mockitokotlin2.verify
24 | import org.junit.Before
25 | import org.junit.Rule
26 | import org.junit.Test
27 | import org.junit.rules.TestRule
28 | import org.junit.runner.RunWith
29 | import org.junit.runners.Parameterized
30 |
31 | @RunWith(Parameterized::class)
32 | class LiveEventTest(
33 | private val config: LiveEventConfig
34 | ) {
35 |
36 | @get:Rule
37 | var rule: TestRule = InstantTaskExecutorRule()
38 |
39 | companion object {
40 | @Parameterized.Parameters
41 | @JvmStatic
42 | fun data(): Collection> {
43 | return listOf(
44 | arrayOf(LiveEventConfig.Normal),
45 | arrayOf(LiveEventConfig.PreferFirstObserver)
46 | )
47 | }
48 | }
49 |
50 | private lateinit var liveEvent: LiveEvent
51 | private lateinit var owner: TestLifecycleOwner
52 | private lateinit var observer: Observer
53 |
54 | @Before
55 | fun setup() {
56 | liveEvent = LiveEvent(config = config)
57 | owner = TestLifecycleOwner()
58 | observer = mock()
59 | }
60 |
61 | @Test
62 | fun observe() {
63 | // Given
64 | owner.start()
65 | liveEvent.observe(owner, observer)
66 |
67 | val event = "event"
68 |
69 | // When
70 | liveEvent.value = event
71 |
72 | // Then
73 | verify(observer, times(1)).onChanged(event)
74 | }
75 |
76 | @Test
77 | fun observeForever() {
78 | // Given
79 | liveEvent.observeForever(observer)
80 |
81 | val event = "event"
82 |
83 | // When
84 | liveEvent.value = event
85 |
86 | // Then
87 | verify(observer, times(1)).onChanged(event)
88 | }
89 |
90 | @Test
91 | fun `observe multi observers`() {
92 | // Given
93 | owner.start()
94 | val observer1 = mock>()
95 | liveEvent.observe(owner, observer)
96 | liveEvent.observe(owner, observer1)
97 |
98 | val event = "event"
99 |
100 | // When
101 | liveEvent.value = event
102 |
103 | // Then
104 | verify(observer, times(1)).onChanged(event)
105 | verify(observer1, times(1)).onChanged(event)
106 | }
107 |
108 | @Test
109 | fun `observeForever multi observers`() {
110 | // Given
111 | val observer1 = mock>()
112 | liveEvent.observeForever(observer)
113 | liveEvent.observeForever(observer1)
114 |
115 | val event = "event"
116 |
117 | // When
118 | liveEvent.value = event
119 |
120 | // Then
121 | verify(observer, times(1)).onChanged(event)
122 | verify(observer1, times(1)).onChanged(event)
123 | }
124 |
125 | @Test
126 | fun `observe after start`() {
127 | // Given
128 | owner.create()
129 | liveEvent.observe(owner, observer)
130 |
131 | val event = "event"
132 |
133 | // When
134 | liveEvent.value = event
135 |
136 | // Then
137 | verify(observer, never()).onChanged(event)
138 |
139 | // When
140 | owner.start()
141 |
142 | // Then
143 | verify(observer, times(1)).onChanged(event)
144 | }
145 |
146 | @Test
147 | fun `observe after emit event`() {
148 | // Given
149 | owner.create()
150 | val event = "event"
151 | liveEvent.value = event
152 | liveEvent.observe(owner, observer)
153 |
154 | // When
155 | owner.start()
156 |
157 | // Then
158 | if (config == LiveEventConfig.Normal) {
159 | verify(observer, never()).onChanged(event)
160 | } else {
161 | verify(observer, times(1)).onChanged(event)
162 | }
163 | }
164 |
165 | @Test
166 | fun `observe after start with multi observers`() {
167 | // Given
168 | owner.create()
169 | val observer1 = mock>()
170 | liveEvent.observe(owner, observer)
171 | liveEvent.observe(owner, observer1)
172 |
173 | val event = "event"
174 |
175 | // When
176 | liveEvent.value = event
177 |
178 | // Then
179 | verify(observer, never()).onChanged(event)
180 | verify(observer1, never()).onChanged(event)
181 |
182 | // When
183 | owner.start()
184 |
185 | // Then
186 | verify(observer, times(1)).onChanged(event)
187 | verify(observer1, times(1)).onChanged(event)
188 | }
189 |
190 | @Test
191 | fun `observe after stop`() {
192 | // Given
193 | owner.stop()
194 | liveEvent.observe(owner, observer)
195 |
196 | val event = "event"
197 |
198 | // When
199 | liveEvent.value = event
200 |
201 | // Then
202 | verify(observer, never()).onChanged(event)
203 | }
204 |
205 | @Test
206 | fun `observe after start again`() {
207 | // Given
208 | owner.stop()
209 | liveEvent.observe(owner, observer)
210 |
211 | val event = "event"
212 |
213 | // When
214 | liveEvent.value = event
215 |
216 | // Then
217 | verify(observer, never()).onChanged(event)
218 |
219 | // When
220 | owner.start()
221 |
222 | // Then
223 | verify(observer, times(1)).onChanged(event)
224 | }
225 |
226 | @Test
227 | fun `observe after one observation`() {
228 | // Given
229 | owner.start()
230 | liveEvent.observe(owner, observer)
231 |
232 | val event = "event"
233 |
234 | // When
235 | liveEvent.value = event
236 |
237 | // Then
238 | verify(observer, times(1)).onChanged(event)
239 |
240 | // When
241 | owner.stop()
242 |
243 | // Then
244 | verify(observer, times(1)).onChanged(event)
245 |
246 | // When
247 | owner.start()
248 |
249 | // Then
250 | verify(observer, times(1)).onChanged(event)
251 | }
252 |
253 | @Test
254 | fun `observe after one observation multi owner`() {
255 | // Given
256 | owner.start()
257 | liveEvent.observe(owner, observer)
258 | val owner1 = TestLifecycleOwner()
259 | val observer1 = mock>()
260 | owner1.start()
261 |
262 | val event = "event"
263 |
264 | // When
265 | liveEvent.value = event
266 |
267 | // Then
268 | verify(observer, times(1)).onChanged(event)
269 |
270 | // Given
271 | liveEvent.observe(owner1, observer1)
272 |
273 | // Then
274 | verify(observer1, never()).onChanged(event)
275 |
276 | // When
277 | liveEvent.value = event
278 |
279 | // Then
280 | verify(observer, times(2)).onChanged(event)
281 | verify(observer1, times(1)).onChanged(event)
282 | }
283 |
284 | @Test
285 | fun `observe after one observation with new owner`() {
286 | // Given
287 | owner.start()
288 | liveEvent.observe(owner, observer)
289 |
290 | val event = "event"
291 |
292 | // When
293 | liveEvent.value = event
294 |
295 | // Then
296 | verify(observer, times(1)).onChanged(event)
297 |
298 | // When
299 | owner.destroy()
300 |
301 | // Then
302 | verify(observer, times(1)).onChanged(event)
303 |
304 | // When
305 | owner = TestLifecycleOwner()
306 | observer = mock()
307 | liveEvent.observe(owner, observer)
308 | owner.start()
309 |
310 | // Then
311 | verify(observer, never()).onChanged(event)
312 | }
313 |
314 | @Test
315 | fun `observe after one observation with new owner after start`() {
316 | // Given
317 | owner.start()
318 | liveEvent.observe(owner, observer)
319 |
320 | val event = "event"
321 |
322 | // When
323 | liveEvent.value = event
324 |
325 | // Then
326 | verify(observer, times(1)).onChanged(event)
327 |
328 | // When
329 | owner.destroy()
330 |
331 | // Then
332 | verify(observer, times(1)).onChanged(event)
333 |
334 | // When
335 | owner = TestLifecycleOwner()
336 | observer = mock()
337 | owner.start()
338 | liveEvent.observe(owner, observer)
339 |
340 | // Then
341 | verify(observer, never()).onChanged(event)
342 | }
343 |
344 | @Test
345 | fun `observe after remove`() {
346 | // Given
347 | owner.start()
348 | liveEvent.observe(owner, observer)
349 |
350 | val event = "event"
351 |
352 | // When
353 | liveEvent.value = event
354 |
355 | // Then
356 | verify(observer, times(1)).onChanged(event)
357 |
358 | // When
359 | liveEvent.removeObserver(observer)
360 | liveEvent.value = event
361 |
362 | // Then
363 | verify(observer, times(1)).onChanged(event)
364 | }
365 |
366 | @Test
367 | fun `observe after remove before emit`() {
368 | // Given
369 | owner.start()
370 | liveEvent.observe(owner, observer)
371 | liveEvent.removeObserver(observer)
372 |
373 | val event = "event"
374 |
375 | // When
376 | liveEvent.value = event
377 |
378 | // Then
379 | verify(observer, never()).onChanged(event)
380 | }
381 |
382 | @Test
383 | fun `observe after remove owner`() {
384 | // Given
385 | owner.start()
386 | liveEvent.observe(owner, observer)
387 |
388 | val event = "event"
389 |
390 | // When
391 | liveEvent.value = event
392 |
393 | // Then
394 | verify(observer, times(1)).onChanged(event)
395 |
396 | // When
397 | liveEvent.removeObservers(owner)
398 | liveEvent.value = event
399 |
400 | // Then
401 | verify(observer, times(1)).onChanged(event)
402 | }
403 |
404 | @Test
405 | fun `observe after remove owner before emit`() {
406 | // Given
407 | owner.start()
408 | liveEvent.observe(owner, observer)
409 | liveEvent.removeObservers(owner)
410 |
411 | val event = "event"
412 |
413 | // When
414 | liveEvent.value = event
415 |
416 | // Then
417 | verify(observer, never()).onChanged(event)
418 | }
419 |
420 | @Test
421 | fun `observe after remove multi owner`() {
422 | // Given
423 | owner.start()
424 | liveEvent.observe(owner, observer)
425 | val owner1 = TestLifecycleOwner()
426 | val observer1 = mock>()
427 | owner1.start()
428 |
429 | val event = "event"
430 |
431 | // When
432 | liveEvent.value = event
433 |
434 | // Then
435 | verify(observer, times(1)).onChanged(event)
436 | verify(observer1, never()).onChanged(event)
437 |
438 | // When
439 | liveEvent.observe(owner1, observer1)
440 | liveEvent.removeObserver(observer)
441 | liveEvent.value = event
442 |
443 | // Then
444 | verify(observer, times(1)).onChanged(event)
445 | verify(observer1, times(1)).onChanged(event)
446 | }
447 |
448 | @Test
449 | fun `observe after remove owner multi owner`() {
450 | // Given
451 | owner.start()
452 | liveEvent.observe(owner, observer)
453 | val owner1 = TestLifecycleOwner()
454 | val observer1 = mock>()
455 | owner1.start()
456 |
457 | val event = "event"
458 |
459 | // When
460 | liveEvent.value = event
461 |
462 | // Then
463 | verify(observer, times(1)).onChanged(event)
464 | verify(observer1, never()).onChanged(event)
465 |
466 | // When
467 | liveEvent.observe(owner1, observer1)
468 | liveEvent.removeObservers(owner)
469 | liveEvent.value = event
470 |
471 | // Then
472 | verify(observer, times(1)).onChanged(event)
473 | verify(observer1, times(1)).onChanged(event)
474 | }
475 | }
--------------------------------------------------------------------------------