{"id":15695842,"url":"https://github.com/prongbang/mvi-rx","last_synced_at":"2025-03-30T13:22:20.571Z","repository":{"id":87919741,"uuid":"409265533","full_name":"prongbang/mvi-rx","owner":"prongbang","description":"MVI = Rx3 + Relay Android","archived":false,"fork":false,"pushed_at":"2021-09-23T06:29:57.000Z","size":120,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-25T22:52:06.861Z","etag":null,"topics":["mvi","mvi-android","mvi-rxjava","mvi-rxkotlin"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/prongbang.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-09-22T15:51:22.000Z","updated_at":"2022-05-22T03:48:59.000Z","dependencies_parsed_at":null,"dependency_job_id":"c23d18c4-a480-4753-a55a-88d3f67568b4","html_url":"https://github.com/prongbang/mvi-rx","commit_stats":{"total_commits":11,"total_committers":1,"mean_commits":11.0,"dds":0.0,"last_synced_commit":"9541681f6feb9e9ca74dd79bdb19a37dafb5cab5"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prongbang%2Fmvi-rx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prongbang%2Fmvi-rx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prongbang%2Fmvi-rx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prongbang%2Fmvi-rx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/prongbang","download_url":"https://codeload.github.com/prongbang/mvi-rx/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246321068,"owners_count":20758566,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mvi","mvi-android","mvi-rxjava","mvi-rxkotlin"],"created_at":"2024-10-03T19:05:08.827Z","updated_at":"2025-03-30T13:22:20.544Z","avatar_url":"https://github.com/prongbang.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mvi-rx\n\n[![](https://jitpack.io/v/prongbang/mvi-rx.svg)](https://jitpack.io/#prongbang/mvi-rx)\n\n## Setup\n\n- `build.gradle`\n\n```groovy\nbuildscript {\n    repositories {\n        maven { url 'https://jitpack.io' }\n    }\n}\n```\n\n- `settings.gradle`\n\n```groovy\ndependencyResolutionManagement {\n    repositories {\n        maven { url 'https://jitpack.io' }\n    }\n}\n```\n\n- `app/build.gradle`\n\n```groovy\nimplementation 'com.github.prongbang:mvi-rx:1.0.5'\n```\n\n## How to use\n\n- MainIntent.kt\n\n```kotlin\nimport com.prongbang.mvirx.RxIntent\n\nsealed class MainIntent : RxIntent {\n\tobject GetData : MainIntent()\n}\n```\n\n- MainSate.kt\n\n```kotlin\nimport com.prongbang.mvirx.RxState\n\nsealed class MainState : RxState {\n\tobject Idle : MainState()\n\tdata class Result(val data: String) : MainState()\n}\n```\n\n- MainEffect.kt\n\n```kotlin\nimport com.prongbang.mvirx.RxEffect\n\nsealed class MainEffect : RxEffect {\n\tobject Idle : MainEffect()\n\tdata class Error(val data: String) : MainEffect()\n}\n```\n\n- GetMessageUseCase.kt\n\n```kotlin\nimport com.prongbang.mvirx.RxUseCase\nimport io.reactivex.rxjava3.core.Observable\n\nclass GetMessageUseCase : RxUseCase\u003cUnit, String\u003e {\n\toverride fun execute(params: Unit): Observable\u003cString\u003e {\n\t\treturn Observable.fromCallable {\n\t\t\t\"Hello MVI Rx\"\n\t\t}\n\t}\n}\n```\n\n- MainViewModel.kt\n\n```kotlin\nimport com.prongbang.mvirx.RxViewModel\n\nclass MainViewModel(\n\t\tprivate val getMessageUseCase: GetMessageUseCase\n) : RxViewModel\u003cMainIntent, MainState, MainEffect\u003e() {\n\n\toverride fun process(intent: MainIntent) {\n\t\twhen (intent) {\n\t\t\tMainIntent.GetData -\u003e processGetData()\n\t\t}\n\t}\n\n\tprivate fun processGetData() {\n\t\tgetMessageUseCase.execute(Unit)\n\t\t\t\t.subscribeOn(Schedulers.io())\n\t\t\t\t.observeOn(AndroidSchedulers.mainThread())\n\t\t\t\t.subscribeBy(onNext = { result -\u003e\n\t\t\t\t\tsetState(MainState.Result(result))\n\t\t\t\t}, onError = {\n\t\t\t\t\tsetEffect(MainEffect.Error(\"${it.message}\"))\n\t\t\t\t})\n\t\t\t\t.addTo(compositeDisposable)\n\t}\n}\n```\n\n- MainActivity.kt\n\n```kotlin\nimport com.prongbang.mvirx.RxViewRenderer\n\nclass MainActivity : AppCompatActivity(), RxViewRenderer\u003cMainState, MainEffect\u003e {\n\n\tprivate val mainViewModel: MainViewModel by viewModels()\n    \n\toverride fun onCreate(savedInstanceState: Bundle?) {\n\t\tsuper.onCreate(savedInstanceState)\n\t\tsetContentView(binding.root)\n\n\t\tmainViewModel.subscribe(::render, ::renderEffect)\n\n\t\tmainViewModel.process(MainIntent.GetData)\n\t}\n\n\toverride fun initObserve() {\n\t\tmainViewModel.subscribe(::render, ::renderEffect)\n\t}\n\n\tprivate fun initLoad() {\n\t\tmainViewModel.process(MainIntent.GetData)\n\t}\n\n\toverride fun render(state: MainState) {\n\t\twhen (state) {\n\t\t\tis MainState.Result -\u003e {\n\t\t\t\tfindViewById\u003cTextView\u003e(R.id.messageText).text = state.data\n\t\t\t}\n\t\t}\n\t}\n\n\toverride fun renderEffect(effect: MainEffect) {\n\t\twhen (effect) {\n\t\t\tis MainEffect.Error -\u003e {\n\t\t\t\tfindViewById\u003cTextView\u003e(R.id.messageText).text = effect.data\n\t\t\t}\n\t\t}\n\t}\n}\n```\n\n## Unit Test\n\n```kotlin\nimport io.reactivex.rxjava3.core.Observable\nimport io.reactivex.rxjava3.observers.TestObserver\nimport org.junit.Test\n\nclass MainViewModelTest : CoreTest() {\n\n\t@MockK\n\tprivate lateinit var getMessageUseCase: GetMessageUseCase\n\n\tprivate val viewModel by lazy { MainViewModel(getMessageUseCase) }\n\n\t@Test\n\tfun `Should return message when get message success`() {\n\t\t// Given\n\t\tval result = \"Hello MVI Rx\"\n\t\tval testObserverState = TestObserver.create\u003cMainState\u003e()\n\t\tevery { getMessageUseCase.execute(Unit) } returns Observable.just(result)\n\n\t\t// When\n\t\tviewModel.stateSubscribe(testObserverState)\n\t\tviewModel.process(MainIntent.GetData)\n\n\t\t// Then\n\t\ttestObserverState.assertValues(\n\t\t\t\tMainState.Result(result)\n\t\t)\n\t}\n}\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprongbang%2Fmvi-rx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprongbang%2Fmvi-rx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprongbang%2Fmvi-rx/lists"}