This is a small lib (less than 70KB) that will help you through your Android features development in order to keep things simple, clear and tidy.
Please refer to this article to get a more in-depth explanation about how this library and its components work.
implementation "com.nerdscorner.mvp:events:LATEST_VERSION"
There are three different options to integrate this MVP library to your application, either extending a BaseActivity/BaseFragment that handles all the wiring and setup automagically (recommended), having a reference to the presenter within your Activity/Fragment, or using behaviours. For the three of them, the model, view and presenter behave the same so the only difference is in the activity/fragment
// Extending BaseActivity will automatically register and unregister the presenter to the bus whenever your activity get resumed or paused
class FeatureActivity : BaseActivity<FeaturePresenter>() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.feature_activity)
presenter = FeaturePresenter(
FeatureView(this),
FeatureModel()
)
}
}
// Extending BaseActivity will automatically register and unregister the presenter to the bus whenever your activity get resumed or paused
class FeatureFragment : BaseFragment<FeaturePresenter>() {
override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View? {
return inflater.inflate(R.layout.fragment_example, container, false)
}
override fun onActivityCreated(savedInstanceState: Bundle?) {
super.onActivityCreated(savedInstanceState)
presenter = FeaturePresenter(
FeatureView(this),
FeatureModel()
)
}
}
// Extending BaseActivity will automatically register and unregister the presenter to the bus whenever your activity get resumed or paused
class FeatureActivity : AppCompatActivity() {
private lateinit var presenter: FeaturePresenter
private var bus = Bus.newInstance
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.feature_activity)
presenter = FeaturePresenter(
FeatureView(this),
FeatureModel(),
bus
)
}
override fun onResume() {
super.onResume()
bus.register(presenter)
}
override fun onPause() {
bus.unregister(presenter)
super.onPause()
}
}
// Extending BaseActivity will automatically register and unregister the presenter to the bus whenever your activity get resumed or paused
class FeatureFragment : Fragment() {
private lateinit var presenter: FeaturePresenter
private var bus = Bus.newInstance
override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View? {
return inflater.inflate(R.layout.fragment_example, container, false)
}
override fun onActivityCreated(savedInstanceState: Bundle?) {
super.onActivityCreated(savedInstanceState)
presenter = FeaturePresenter(
FeatureView(this, bus),
FeatureModel(bus)
)
}
override fun onResume() {
super.onResume()
bus.register(presenter)
}
override fun onPause() {
bus.unregister(presenter)
super.onPause()
}
}
class FeaturePresenter(view: FeatureView, model: FeatureModel) : BaseActivityPresenter<FeatureView, FeatureModel>(view, model) {
//...
}
class FeatureView(activity: FeatureActivity) : BaseActivityView(activity) {
//...
}
class FeatureModel : BaseEventsModel() {
//...
}
class FeaturePresenter(view: FeatureView, model: FeatureModel) : BaseActivityPresenter<FeatureView, FeatureModel>(view, model) {
// Event posted by the view
@Subscribe
fun onActionClicked(event: FeatureView.ActionClickedEvent) {
view.setTextValue("Executing background task...")
model.doSomethingInBackground()
}
// Event posted by the model
@Subscribe
fun onBackgroundTaskCompleted(event: FeatureModel.BackgroundTaskCompletedEvent) {
view.setTextValue("Background task completed")
}
}
class FeatureView(activity: AppCompatActivity) : BaseActivityView(activity) {
private var textView: TextView = activity.findViewById(R.id.text)
init {
// Helper library method to handle click event
onClick(R.id.some_button, ActionClickedEvent())
// Optionally you can do
activity.findViewById<View>(R.id.some_button)?.setOnClickListener {
bus.post(ActionClickedEvent())
}
}
fun setTextValue(value: CharSequence) {
textView.text = value
}
class ActionClickedEvent
}
import com.nerdscorner.mvplib.events.model.BaseEventsModel
class FeatureModel : BaseEventsModel() {
fun doSomethingInBackground() {
backendCall().execute {
success = {
bus.post(BackgroundTaskCompletedEvent())
}
}
}
class BackgroundTaskCompletedEvent
}
Please fork this repository and contribute back using pull requests.
Any contributions, large or small, major features, bug fixes, unit tests are welcomed and appreciated but will be thoroughly reviewed and discussed.
Diego Marcher | [email protected]