poldz123 / canadatransit

Transit Schedule for Canada

CanadaTransit

Android mobile application for Bus tracking across Canada. That uses the TransitLand API to fetch for the bus schedules for each of the transit line operators.

Getting Started

Prerequisites

• Install the latest android studio
• Install the java jdk 8

Libraries

Most used libraries within the application which a developer must have knowledge with.

• Kotlin
• RxJava
• RxKotlin
• Room Database

Running the tests

Unit tests is an essential part to the development of the application. A good developer should test the code the've made to eliminate bug in production. This project has good amount of unit tests that mostly covered the source code.

You can either use the script through the terminal or command-line or run the test within android studio. After the unit test, it will then print the code coverage percentile which tell us how much code are covered by the test.

Terminal or Command line

Make sure that you are at the project's root.

./scripts/unit-test.sh

Running the static analysis

Static analysis is way to analyze the source code for code smells. Its main purpose is to check for buggy code, code format, or even suggest for a good code. After the analysis it will create a report which will contain a list of things that needed to be fixed, so make sure that they are all addressed.

Static analysis can only be executed through the terminal or command-line with a script.

./scripts/static-analysis.sh

Running the code formatter

Code formatter is a script that will automatically formats the source code based on the rules. It uses a default ktlint code formatter which is a list of standard to format the code in kotlin.

Code formatter can only be executed through the terminal or command-line with a script.

./scripts/code-formatter.sh

canadatransit's Issues

Update this gradle to google()

CanadaTransit/build.gradle

Line 67 in dafca10

maven {

call onCancel when error has occured

CanadaTransit/app/src/main/kotlin/com/rodolfonavalon/canadatransit/controller/manager/update/task/AbstractUpdateTask.kt

Line 21 in 9d3b0f2

observable.onError(error)

Model should be using Immutable List

Models should be using an immutable list or List<T> this is to prevent others from mutating the list from the model.

When saving to the database old object should be deleted instead of updating/modifying the current saved object this is to prevent wrong data to be updated on the objects.

Remove moshi-kotlin in favor or codegen

Removed extra default closure

CanadaTransit/app/build.gradle

Line 21 in b4a4d25

defaultConfig {

Add interface for APIs

Let's add an interface for the whole set of Apis such as the transiApi where it will inherit from an interface that consists of retrofit and composable instance and some helper method(extensions).

Make all disposable attachment as extension

All disposable are currently added through a static method since Kotlin is such a nice language lets make it an extension to the Disposable class itself.

http://kotlinlang.org/docs/reference/extensions.html

Change Proguard -> R8

Private constructor for Helper methods

If we are making a helper class that only used a static/object method then it would be better to just let its constructor as private instead of it being public, since we can only initialize it within its attached object.