Stock Trade Tracking

About

Stock Trade Tracking is an app where you can register your Ibovespa shares and track your profit or loss automatically (Hopefully your profit).

It is a simple showcase for a modern and well-crafted Android application, powered by Kotlin Coroutines and Clean Architecture. It is a real modularized MVVM application.

Project Overview

The code is structured in a multi-module fashion, with semantics guided by Clean Architecture.

The domain is a horizontal module that defines all business rules and the core protocols to be implemented by low-level details, while aggregates them in high-level policies by using the UseCase concept from Clean Architecture.

Below you can see a better representation of how the project is structured in terms of modules dependencies. If you look at the diagram arrows you are going to see that the domain layer does not depend on any other module. It is a pure Kotlin module.

Related Libs

Here are some personal libraries used to develop this app:

Roadmap

You can check out the Project Board to see the next steps.

Testing

When I have said this architecture was very simple to be tested I was being serious. Here is a little example of a code testing two differents LiveDatas at the same time with the same action trigger.

class TimelineBalanceListViewModelTest : BaseViewModelTest() {
    private val loaderUseCase	    = mock<GetCurrentPeriodBalanceCase>()
    private val expectedList        = TimelineBalanceFactory.listOf(10)

    private lateinit var viewModel  : TimelineBalanceListViewModel

    @Before
    fun `before each test`() {
        viewModel = TimelineBalanceListViewModel(loaderUseCase)
    }

    @Test
    fun `should initialize components`() = testLiveDataScenario {
        assertLiveDataFlow(viewModel.periodList){
            it.assertFlow(ComponentState.Initializing)
        }

        assertLiveDataFlow(viewModel.finalBalance){
            it.assertFlow(ComponentState.Initializing)
        }
    }

    @Test
    fun `should return list`() = testLiveDataScenario {
        whenThisScenario{
            whenever(loaderUseCase.execute()).thenReturn(Result.Success(expectedList))
        }

        onThisAction {
            viewModel.interact(TimelineBalanceListInteraction.LoadTimelineComponent)
        }

        assertLiveDataFlow(viewModel.periodList){
            it.assertFlow(
                ComponentState.Initializing,
                ComponentState.Loading.FromEmpty,
                ComponentState.Success(expectedList)
            )
        }

        assertLiveDataFlow(viewModel.finalBalance){
            it.assertFlow(
                ComponentState.Initializing,
                ComponentState.Loading.FromEmpty,
                ComponentState.Success(expectedList.first())
            )
        }
    }
}

License

The MIT License (MIT)

Copyright (c) 2020 Maycon Cardoso

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.

jhanay / stocktradetracking Goto Github PK