Skip to content

Latest commit

 

History

History
187 lines (137 loc) · 12.7 KB

README.md

File metadata and controls

187 lines (137 loc) · 12.7 KB
Raw

CleanNyTimesApp

CleanNyTimesApp is a project that downloads most popular articles from RestFul API of most popular articles - nytimes

The goal of the project is to combine popular libraries/tools and demonstrate the best development practices by utilizing up to date tech-stack and presenting modern Android application Architecture that is modular, scalable, maintainable, and testable. This application could be useful for providing a base for larger scalable real world projects.

Project characteristics and tech-stack

Screenshot_listScreenshot_list_filteredScreenshot_detail

This project takes advantage of best practices, many popular libraries and tools in the Android ecosystem. Most of the libraries are in the stable version unless there is a good reason to use non-stable dependency.

Architecture

Presentation layer

This layer is closest to what the user sees on the screen. The presentation layer is a mix of MVVM (Jetpack ViewModel used to preserve data across activity restart) and MVI (actions modify the common state of the view and then new state is edited to a view via LiveData to be rendered).

common state (for each view) approach derives from Unidirectional Data Flow and Redux principles.

Components:

  • View (Fragment) - presents data on the screen and pass user interactions to View Model. Views are hard to test, so they should be as simple as possible.
  • ViewModel - dispatches (through LiveData) state changes to the view and deals with user interactions (these view models are not simply POJO classes).
  • ViewState - common state for a single view
  • NavManager - singleton that facilitates handling all navigation events inside NavHostActivity (instead of separately, inside each view)

Domain layer

This is the core layer of the application. Notice that the domain layer is independent of any other layers. This allows to make domain models and business logic independent from other layers. In other words, changes in other layers will have no effect on domain layer eg. changing database (data layer) or screen UI (presentation layer) ideally will not result in any code change withing domain layer.

Components:

  • UseCase - contains business logic
  • DomainModel - defines the core structure of the data that will be used within the application. This is the source of truth for application data.
  • Repository interface - required to keep the domain layer independent from the data layer (Dependency inversion).

Data layer

Manages application data and exposes these data sources as repositories to the domain layer. Typical responsibilities of this layer would be to retrieve data from the internet and optionally cache this data locally.

Components:

  • Repository is exposing data to the domain layer. Depending on application structure and quality of the external APIs repository can also merge, filter, and transform the data. The intention of these operations is to create high-quality data source for the domain layer, not to perform any business logic (domain layer use case responsibility).

  • Mapper - maps entity to domain model (to keep domain layer independent from the data layer).

  • RetrofitService - defines a set of API endpoints.

  • DataModel - defines the structure of the data retrieved from the network and contains annotations, so Retrofit (Gson) understands how to parse this network data (XML, JSON, Binary...) this data into objects.

Data-Flow

Structure

Dependency management

This project utilizes multiple mechanics to easily share the same versions of dependencies.

App library dependencies

External dependencies (libraries) are defined using versions catalog feature in the settings.gradle.kts file. These dynamic library versions are locked using Gradle locking dependency mechanism - concrete dependency versions are stored in MODULE_NAME/gradle.lockfile files.

To update lock files run ./gradlew test lint s --write-locks command and commit updated gradle.lockfile files to repository.

Gradle plugin dependencies

Gradle plugins are defined in pluginManagement block (settings.gradle.kts file).

Dynamic versions aren't supported for Gradle plugins, so locking dependency mechanism can't be used (like for app library dependencies), and thus versions of some libraries & plugins have to be hardcoded in the gradle.properties file.

There is no easy way to share id between pluginManagement block and buildSrc folder, so plugin ids (also used within build scripts), have to be duplicated in the GradlePluginId file.

Design decisions

Read related articles to have a better understanding of underlying design decisions and various trade-offs.

Getting started

There are a few ways to open this project.

Android Studio

  1. Android Studio -> File -> New -> From Version control -> Git
  2. Enter https://github.com/roymithun/CleanNyTimesApp.git into URL field an press Clone button

Command-line + Android Studio

  1. Run git clone https://github.com/roymithun/CleanNyTimesApp.git command to clone project
  2. Open Android Studio and select File | Open... from the menu. Select cloned directory and press Open button

Code Coverage for Unit Tests

Code coverage of java and kotlin files can measured using Jacoco scripts. Currently, :presentation and :data modules have jacoco gradle configured. To run code coverage, following command can be run on terminal

./gradlew fullCoverageReport

The generated report can be found at

<your system name>/<your project location>/app/build/coverage-report/index.html

Code format validation with KtLint

Use following command on terminal to run ktlint rules report of which can be found at build/reports/ktlint

./gradlew ktlintCheck

Static code analysis with Detekt

Use following command to generate config file to be found at $rootDir/config/detekt/detekt.yml

./gradlew detektGenerateConfig

Use following command to run code analysis report of which can be found at build/reports/detekt

./gradlew detekt

Known issues

How to consume NyTimes API?

Most Popular API from nytimes developer have been used.

For example: https://api.nytimes.com/svc/mostpopular/v2/mostviewed/all-sections/7.json?api-key=yourkey

Where your_key has to be generated following get-started page from nytimes.

Once you have yourkey, please add a new entry in local.properties inside your project directory. Since local.properties is added in .gitignore. it is never added to VCS. This way your appKey can be kept somehow secured.

  • appKey = your_key