عکس AbolfaZlRezaEe
NMock is an application that you can use to mock your trips with fake locations. This application uses Neshan SDK and Neshan API for Map and location information.Kotlin
موضوع‌ها
۱۵
فورک‌ها
۲
ستاره‌ها
۱۸
تاریخ ایجاد
۲۷ اردیبهشت ۱۴۰۱
آخرین بروزرسانی
حدود ۱۵ ساعت قبل

NMock Banner

Maybe you think about how map android developers test their features and functionalities? should every person that wanna test the map applications have a car and go to the streets to test? actually, the answer is No! in Android, we have some applications that we call them "Mock", and these applications help us to generate fake locations or fake trips to test our Map application and for other purposes.

💥 What is the NMock?

NMock is an Application that helps you to generate fake locations, share fake trips to your friends, test your Map product, and so on... we build this application with Neshan SDK, Kotlin Language, Kotlin Coroutines and also Dagger-Hilt Dependency Injection. follow this document to know how this application developed and works!

✌️ Contribute

If you want to make me happy, you can contribute to this project😊! all of the time, we have some bugs, issues, and tasks that we can do in this project and help NMock to grow. so, if you want to contribute to this project, you can see the Issues Section or you can create a new issue and then create your pull request for that.

also, we have an opportunity for those people that don't have programming knowledge. if you haven't programming knowledge, you can ask, report, or do anything you want in Issues Section.

📐 Architecture

after some experience that I've taken in some private or public projects like Niky, I've learned some good things that help me to build this project.

at the first, I use MVVM and a piece of MVI architecture in this project. so, the application can be summarized in the chart below:

architecture picture

as you can see, we have two sources for our data in the application. remote API and Database. with remote API, we can request location information(reverse Geocoding) and also routing information for our trip. and if we want to save our trip, the database does that for us.

also, we use Neshan API to receive these informations. you can check the documentation as well.

after that, we have three repositories that help us to manage these requests from ViewModels. this section is important because all of the processes make and control here. so, we receive data and convert that to a model that ViewModels can use and parse it for Views. in the picture below, you can see the difference between the two of them:

architecture models

the left model represents the data that we receive from the server. and the right picture represents the data that we need for our view.

in ViewModels, we have a different approach for giving access to the Views. every ViewModel can have two outputs and Views can use those for managing their views and actions. at the first, we have a Stateflow that represents the state for the view. this flow contains all of the information that the view needs to show(like MVI approach).

and the second output that works with Sharedflow sends some actions that can have a message or not. Views parse these actions and then, do an action in view like showing an error and so on... for example:

private fun initObservers() {
        lifecycleScope.launch {
            repeatOnLifecycle(Lifecycle.State.STARTED) {
                viewModel.mockEditorState.collect { state ->
                    showLoadingProgressbar(false)

                    state.originAddress?.let {
                        it.ifNotHandled { address -> processOriginAddress(address) }
                    }

                    state.destinationAddress?.let {
                        it.ifNotHandled { address -> processDestinationAddress(address) }
                    }

                    state.lineVector?.let {
                        it.ifNotHandled { lineVector -> processLineVector(lineVector) }
                    }

                    state.originLocation?.let {
                        it.ifNotHandled { location -> processMarker(true, location) }
                    }

                    state.destinationLocation?.let {
                        it.ifNotHandled { location -> processMarker(false, location) }
                    }
                }
            }
        }
        lifecycleScope.launchWhenStarted {
            viewModel.oneTimeEmitter.collect { processAction(it) }
        }
    }

an important thing that these Sharedflows can do is when an action receives from viewModel, it can be parsed and do an action to undo a thing in view. for example we call a function that requests receiving information from the server, and this request will be failed. for that, we send an action to view and cancel some stuff that we turned on before. you can see an example of that below:

error architecture

📑 Tips that help you...

for developing this application, we have some tips that maybe can help you:

  • If you want to Contribute, before starting that, please create an issue and describe your idea and assign that to me. I will check that as soon as possible.
  • We publish this application in GooglePlay as soon as possible. so for now, you can install application from release section in repository.