Home Original page

GitHub - stspvs/Moxy

Bintray Maven Central

Moxy is a library that helps to use MVP pattern when you do the Android Application. Without problems of lifecycle and boilerplate code!

The main idea of using Moxy: schematic_using

Capabilities

Moxy has a few killer features in other ways:

  • Presenter stay alive when Activity recreated(it simplify work with multithreading)
  • Automatically restore all that user see when Activity recreated(including dynamic content is added)
  • Capability to changes of many Views from one Presenter

Sample

View interface

interface MainView : MvpView {

    @StateStrategyType(AddToEndSingleStrategy::class)
	fun printLog(msg: String)
}

class MainActivity : MvpAppCompatActivity(), MainView {
	
	@InjectPresenter
	internal lateinit var presenter: MainPresenter
	
	override fun onCreate(savedInstanceState: Bundle?) {
		super.onCreate(savedInstanceState)
		setContentView(R.layout.activity_main)
	}
	
	override fun printLog(msg: String) {
		Log.e(TAG, "printLog : msg : $msg activity hash code : ${hashCode()}")
	}
	
	companion object {
		const val TAG = "MoxyDebug"
	}
}

Presenter

@InjectViewState
class MainPresenter : MvpPresenter<MainView>() {
	override fun onFirstViewAttach() {
		super.onFirstViewAttach()
		Log.e(MainActivity.TAG, "presenter hash code : ${hashCode()}")
		viewState.printLog("TEST")
	}
}

Inject with Dagger2

	@Inject
	lateinit var daggerPresenter: Lazy<MainPresenter>
	
	@InjectPresenter
	lateinit var presenter: MainPresenter
	
	@ProvidePresenter
	fun providePresenter(): MainPresenter = daggerPresenter.get()

Android studio and Intellij templates

We will change this template in future In order to avoid boilerplate code creating for binding activity, fragments and its presentation part, we propose to use Android Studio templates for Moxy.

Links

Telegram channels from original moxy community

Telegram channel (en)
Telegram channel (ru)

Integration

(Please replace moxyVersion with the latest version number: Maven Central)

Base modules integration:

implementation 'com.github.moxy-community:moxy:moxyVersion'

Java project

annotationProcessor 'com.github.moxy-community:moxy-compiler:moxyVersion'

Kotlin

apply plugin: 'kotlin-kapt'
kapt 'com.github.moxy-community:moxy-compiler:moxyVersion'

Default android module integration

For additional base view classes MvpActivity and MvpFragment add this:

implementation 'com.github.moxy-community:moxy-android:moxyVersion'

AppCompat module integration

If you use AppCompat, use MvpAppCompatActivity and MvpAppCompatFragment add this:

implementation 'com.github.moxy-community:moxy-app-compat:moxyVersion'

AndroidX module integration

If you use AndroidX, use MvpAppCompatActivity and MvpAppCompatFragment add this:

implementation 'com.github.moxy-community:moxy-androidx:moxyVersion'

AndroidX(Google material) module integration

If you use google material, use MvpBottomSheetDialogFragment add this:

implementation 'com.github.moxy-community:moxy-material:moxyVersion'

New Features and Compiler option for Migration from old version

By default, each MvpView method must have an annotation @StateStrategyType. In the old version of Moxy, it was allowed to miss strategy for methods. In this case, the default strategy was applied.

You can fallback to the old behavior. To do this, set the disableEmptyStrategyCheck parameter to true.

disableEmptyStrategyCheck : ‘true’

In this case, the default strategy will be AddToEndSingleStrategy. In old version default strategy was AddToEndStrategy.

To change default strategy, provide for defaultMoxyStrategy parameter the full class name of new default strategy.

defaultMoxyStrategy : 'moxy.viewstate.strategy.OneExecutionStateStrategy'

If compiler finds MvpView method without annotation @StateStrategyType it show this error with standard method for notifying about compilation problems.For ease of migration from older versions, we have provided an additional mechanism: EmptyStrategyHelper. It collects all the errors associated with an empty strategy in one place. Using it, you can easily navigate from the EmptyStrategyHelper directly to the method with a missing strategy.

To switch the error output method, enable the option

enableEmptyStrategyHelper : 'true'

How to correctly use compilation flags see at sample-app build.gradle file

ProGuard\R8

Moxy project already includes ProGuard rule files, no additional configuration required.

Road Map

  • [✓] Provide a migration tool from com.arello-mobile.moxy and its default strategy
  • [✓] Kotlin incremental compilation support
  • [✓] Remove reflectors and common presenter store
  • [ ]Provide Runtime Implementation

Moxy Community

Brave people how created library

@senneco @ekursakov @jordan1997 @xanderblinov @SavinMike @AlexeyKorshun @dmdevgo @rsajob @terrakok @mohaxspb @CherryPerry @fl1pflops @phoenixxt @Dosssik @AcoustickSan @seven332 @v-grishechko @sbogolepov @A-Zaiats @lion4ik

You may also find them in contributors page of old project

Contributing

Install code style to your IntelliJ or Android Studio. MoxyAndroid.xml For import file use or Mac OS: Preferences -> Editor -> Code style -> Scheme -> Import Scheme -> IntelliJ IDEA code style XML -> choose the MoxyAndroid.xml file in finder

License

The MIT License (MIT)

Copyright (c) 2019 Moxy Community

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

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.