slowikj / quotable-android-app Goto Github PK

It is worth considering putting lastUpdated field (that is present in both AuthorsDao and QuotesDao) into the origin entity rather than the remote key entity.

Why?
Some of the origins are not related to remote keys such as those that are present in the dashboard.
Currently, in order to handle the aforementioned case, a fake key is put into the database.
It must be emphasized that such an approach is error-prone, as a programmer can easily forget to write this extra line of code.

Result.runCatching has two major flaws:

1. It consumes all Throwables (also Errors, such as OutOfMemoryException).
2. It doesn't work well with coroutines. More precisely, it doesn't rethrow CancellationException.

The following article shows how to avert the above problems:
https://proandroiddev.com/resilient-use-cases-with-kotlin-result-coroutines-and-annotations-511df10e2e16

In short, it recommends to use own, specialized implementation that replaces runCatching.

Possible paths to consider

• Each part of Dashboard should be encapsulated in a single Fragment with a corresponding ViewModel
• Dashboard entries should be represented in a RecyclerView that is fed by a single ViewModel that emits a generic stream of data (it is represented by a sealed class)

• all authors
• dashboard authors
• all tags
• dashboard tags
• tests for AuthorsDao
• tests for TagsDao

The issue occurs when in the local database there exists cached quotes of a particular author
and there is no internet connection.
Then, both quotes view and error and retry view are shown.

Fix: error and retry view should be invisible in this particular case.

The app consists of quotes that are presented in different contexts:

• All quotes
• Quotes of a particular author
• Quotes of a particular tag
• Random quote
• Dashboard exemplary quotes
• DAO tests

All of the above types should be stored in the local database.

According to https://medium.com/androiddevelopers/7-pro-tips-for-room-fbadea4bfbd1

ViewModel should be as reusable as possible, thus, it should not know anything
about specific screen navigation logic, since
it is not always the case that the current Fragment will be totally replaced by a new one.
For example, if we have a tablet, then it is possible that a new Fragment will be shown next to the current one.

In conclusion, we should leave specific navigation logic for UI layer and ViewModel should not be tainted by it.

Sometimes database of authors' images happens to return no response.
In order to handle this corner case and improve UX
the app should show a default placeholder (for example a default image that depicts a single person).

Change names of data source classes in order to be compliant with the latest Android App Architecture Guide.
In particular, change *Service -> *RemoteService

• Create a Room entity to store info about likes
• Adjust domain Quote model to store whether a particular quote has been liked
• Adjust quote DAOs to handle likes (querying, inserting, deleting)
• Add heart 🤍 view (both filled and empty one) for quotes' layouts
• Handle like click in OneQuoteRepository
• Handle like click in Fragment
• Handle like click in ViewModel
• Create getLikedQuotes(): Flow<PagingData<Int, Quote>> in AllQuotesRepository
• Create LikedQuotesFragment
• Create LikedQuotesViewModel
• Add liked quotes entry in the dashboard

The main reason beyond this idea is to remove the necessity of manually passing an object of type QuoteOriginParams.
After having introduced the DataSource layer, a programmer can call specialized methods,
for instance quotesLocalDataSource.getRandomQuoteFlow.

• Prepare sealed class that encompasses 2 types: normal and seeMore
• General the last item of type seeMore in the ViewModel
• Prepare see more layout
• Handle see more entry in ViewHolder
• Add onClick listener that navigates to a separate screen containing all items of a particular type

Inspiration: https://github.com/akshay2211/Paper/blob/master/media/dark.png

Use ViewPager:
The first tag related to quotes and the second on to the bio