├── .github └── workflows │ ├── main-check.yaml │ └── pr-check.yaml ├── .gitignore ├── .idea ├── .gitignore └── codeStyles │ ├── Project.xml │ └── codeStyleConfig.xml ├── CHANGELOG.md ├── LICENSE ├── README.md ├── app ├── .gitignore ├── build.gradle.kts └── src │ └── main │ ├── AndroidManifest.xml │ ├── java │ └── com │ │ └── hadilq │ │ └── liveevent │ │ └── sample │ │ ├── LiveEventViewModel.kt │ │ └── MainActivity.kt │ └── res │ ├── drawable-v24 │ └── ic_launcher_foreground.xml │ ├── drawable │ └── ic_launcher_background.xml │ ├── layout │ └── activity_main.xml │ ├── mipmap-anydpi-v26 │ ├── ic_launcher.xml │ └── ic_launcher_round.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 │ └── values │ ├── colors.xml │ ├── strings.xml │ └── styles.xml ├── build.gradle.kts ├── buildSrc ├── .gitignore ├── build.gradle.kts └── src │ └── main │ └── kotlin │ ├── Depends.kt │ ├── PublishConfig.kt │ └── Versions.kt ├── gradle.properties ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── live-event ├── .gitignore ├── build.gradle.kts └── src │ ├── main │ ├── AndroidManifest.xml │ └── java │ │ └── com │ │ └── hadilq │ │ └── liveevent │ │ ├── LiveEvent.kt │ │ └── LiveEventConfig.kt │ └── test │ └── java │ └── com │ └── hadilq │ └── liveevent │ ├── LiveEventTest.kt │ └── TestLifecycleOwner.kt └── settings.gradle.kts /.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 | -------------------------------------------------------------------------------- /.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 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.iml 2 | .gradle 3 | /local.properties 4 | build-system/keystore.gradle 5 | .DS_Store 6 | /build 7 | /captures 8 | .externalNativeBuild 9 | -------------------------------------------------------------------------------- /.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 | -------------------------------------------------------------------------------- /.idea/codeStyles/Project.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 6 | 7 | 9 | 10 | -------------------------------------------------------------------------------- /.idea/codeStyles/codeStyleConfig.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /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. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ![Health Check](https://github.com/hadilq/LiveEvent/workflows/Health%20Check/badge.svg?branch=main) 2 | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.hadilq/live-event/badge.svg)](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 | -------------------------------------------------------------------------------- /app/.gitignore: -------------------------------------------------------------------------------- 1 | /build 2 | -------------------------------------------------------------------------------- /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/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 3 | 4 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | -------------------------------------------------------------------------------- /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/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 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /app/src/main/res/layout/activity_main.xml: -------------------------------------------------------------------------------- 1 | 2 | 8 | 9 | 21 | 22 |