[Feature] Reading statistics like Kobo "Reading Life"

mantonelli commented 9 years ago

Would be nice see statistics about reading habits per book, like time expended and percentage read.

liquiddandruff commented 9 years ago

I would love to see this as well. Stats are always so awesome to look at.

liquiddandruff commented 9 years ago

With some thought, I have decided to modify LibraryTree to allow unique views so that the statistics view can be tweaked. Is this okay, geometer? It can be done using the default view (but it might not look as good), so I can revert to that if necessary. There may be a better way.. suggestions?

liquiddandruff commented 9 years ago

https://github.com/PhilJay/MPAndroidChart

I would love the chance to integrate these charts into FBReader. It would add a ton of functionality and variability in showing the user their reading statistics (pie chart for time spent per genre, clicking each slice would bring up the list of each genre's books, sorted by time spent; line chart with date on x axis and time spent reading on y axis, clicking on data points would show the books read that day; etc, etc, countless options).

The library seems to support all the platforms that FBReader targets, and the charts are also very pretty. Displaying the user's reading statistics in such accessible ways would be very interesting to anyone who would like to know how they read! Gimme your thoughts about this, geometer!

Putting the integration of this on hold for now while I get the "model" aspect of this more complete.

liquiddandruff commented 9 years ago

Here's what the WIP layout looks like currently. The statistics calculations are separate from the view calculations, so complete layout changes in the future should be simple. I have tested this extensively through the following situations and things appear to be working normally.

first install cases
upgrade cases
0 books in library
general usage

Implementation details

when a book is detected and determined to be new, a BookStatistics is created and assigned to that book with System.currentTimeMillis to mark date added (in addBook(), where FireBookEvent(BookEvent.Added, book) is called)
database upgrade
- BookStatistics table is created, all books currently in Books are inserted into the new table with System.currentTimeMillis to mark date added.
onResume marks the start of a session, onPause marks the end of a session, difference is used to calculate the total time spent on the current book
- session date and duration is logged as a CSV pair in the book's statistics
- session history size currently has a max length of 350 characters
- is serialized with the book (length will be lowered should it impact performance too much)
every page flip increments a number in the current book's statistics
every page flip saves the current book's statistics to the database (uses mySaverThread like savePosition())

To do

override the onClick() of each statistic to show relevant information
graph?
clean up (remove logs, deduplicate code)
use resource files
invalidate view to update statistics when current book is modified (eg when books are removed from favorites/deleted)
test layout on other dpi devices (tested on Nexus 5)

Bugs

Not sure if I just started noticing or what, but flipping a page forward/backward sometimes doesn't update the current page number, or it changes the displayed total amount of pages in a book (weird)
- probably has something to do with the saving of an out of date book