morristech / marietje-android

Android application for https://marietje-noord.science.ru.nl

Marietje for Android

Ever wondered how to add music to the queues of Marietje in the Noord- and Zuidkantine in the Radboud University's Huygensbuilding? Why not use an app to do it? And now you've found it. Or, at least the source code.

Libraries and tools used in this project:

• Support libraries
  • AppCompat
  • RecyclerView
  • Design
  • Support Annotations
  • And their dependencies
• RxJava and RxAndroid
• Retrofit 2
• Dagger 2
• Butterknife
• Timber
• Glide
• AutoValue with extensions AutoValueParcel and AutoValueGson
• Functional tests with Espresso
• Robolectric
• Mockito
• Code analysis tools
  • Checkstyle
  • PMD
  • Findbugs

Requirements

• JDK 1.8
• Android SDK.
• Android N (API 25) .
• Latest Android SDK Tools and build tools.

Architecture

We use an Android architecture that is based on the MVP (Model View Presenter) pattern.

How to implement a new screen following MVP

Imagine you have to implement a sign in screen.

1. Create a new package under ui called signin
2. Create an new Activity called ActivitySignIn. You could also use a Fragment.
3. Define the view interface that your Activity is going to implement. Create a new interface called SignInView that extends MvpView. Add the methods that you think will be necessary, e.g. showSignInSuccessful()
4. Create a SignInPresenter class that extends BasePresenter<SignInView>
5. Implement the methods in SignInPresenter that your Activity requires to perform the necessary actions, e.g. signIn(String email). Once the sign in action finishes you should call view().showSignInSuccessful().
6. Create a SignInPresenterTestand write unit tests for signIn(email). Remember to mock the SignInView and also the DataManager.
7. Make your ActivitySignIn implement SignInView and implement the required methods like showSignInSuccessful()
8. In your activity, inject a new instance of SignInPresenter and call presenter.attachView(this) from onCreate and presenter.detachView() from onDestroy(). Also, set up a click listener in your button that calls presenter.signIn(email).

Code Quality

This project has basic unit tests and functional tests. And it includes code analysis tools.

Tests

To run unit tests on your machine:

./gradlew test

To run functional tests on connected devices:

./gradlew connectedAndroidTest

Note: For Android Studio to use syntax highlighting for Automated tests and Unit tests you must switch the Build Variant to the desired mode.

Code Analysis tools

The following code analysis tools are set up on this project:

• PMD: It finds common programming flaws like unused variables, empty catch blocks, unnecessary object creation, and so forth. See this project's PMD ruleset.

./gradlew pmd

• Findbugs: This tool uses static analysis to find bugs in Java code. Unlike PMD, it uses compiled Java bytecode instead of source code.

./gradlew findbugs

• Checkstyle: It ensures that the code style follows our code guidelines. See our [checkstyle config file] (config/quality/checkstyle/checkstyle-config.xml).

./gradlew checkstyle

The check task

./gradlew check

This gradle task will run all the code analysis tools and unit tests.

Distribution

The project can be distributed using either Crashlytics or the Google Play Store.

Play Store

We use the Gradle Play Publisher plugin. Once set up correctly, you will be able to push new builds to the Alpha, Beta or production channels like this

./gradlew publishApkProdRelease

For more information, read the plugin's documentation.

Crashlytics

You can also use Fabric's Crashlytics for distributing beta releases. Remember to add your fabric account details to app/src/fabric.properties.

To upload a release build to Crashlytics:

./gradlew assembleRelease crashlyticsUploadDistributionProdRelease

New project setup

To quickly start a new project from this boilerplate follow the next steps:

• Download this repository (as zip).
• Change the package name.
  • Rename packages in main, androidTest and test using Android Studio.
  • In app/build.gradle file, packageName and testInstrumentationRunner.
  • In src/main/AndroidManifest.xml and src/debug/AndroidManifest.xml.
• Create a new git repository, see GitHub tutorial.
• Replace the example code with your app code following the same architecture.
• In app/build.gradle add the signing config to enable release versions.
• Add Fabric API key and secret to fabric.properties and uncomment Fabric plugin set up in app/build.gradle
• Update proguard-rules.pro to keep models (see TODO in file) and add extra rules to file if needed.
• Update README with information relevant to the new project.
• Update LICENSE to match the requirements of the new project.

License

    Copyright 2016 Sébastiaan

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.