Add `completed` boolean state for a book

[pichfl]

Tracking via the duration has caused issues while working on 3.0 which are solved but maybe it's better to have this around.

[ryantstone]

Is there a visual element that is going to be displayed or are we just wanting to have a boolean internally to denote completion?

[GianniCarlo]

the 'pie' progress should be replaced with a checkmark, it sometimes does and sometimes doesn't. Currently we have a computed-value for isCompleted, and although we round off the currentTime vs duration it obviously isn't perfect, having a boolean as a core data property should be the better option

[GianniCarlo]

we could set it to true when the AVAudioPlayer delegate calls the audioPlayerDidFinishPlaying

[GianniCarlo]

also when it's explicitly marked by the user inside the player 'more' options

[pichfl]

The reason the checkmark rarely shows up is that I'm still struggling with typed languages and comparing two floats is a bad idea. I put a preliminary fix into #266, casting the values to Int before comparing them:

BookPlayer/BookPlayer/Models/Book+CoreDataClass.swift

Lines 51 to 55 in aa50c2e

	// TODO: This is a makeshift version of a proper completion property.
	// See https://github.com/TortugaPower/BookPlayer/issues/201
	override var isCompleted: Bool {
	return Int(round(self.currentTime)) == Int(round(self.duration))
	}

[bryanrezende]

I've been away from this project for ages now, but for what it's worth - you may not have to compare floats for equivalency to mark a book as complete. A book that's within (let's say) a minute of completion is likely complete due to the legal fluff that fills the end of a lot of books. The audible app counts things as complete as long as they are close enough to the end if I remember correctly, because at that point the book is functionally finished for the listener.

A completed flag might still be nice to have though - if you wanted to record a completion date for whatever reason (stat/listening tracking?), the presence of a nonnull completion date could also function as a flag?

[pichfl]

@bryanrezende welcome back 🙂 your remark is true for Audible as they strictly use M4B containers, but it doesn't work for MP3 based books which can be split into parts of 5 minutes or less and we have to account for those as well, as not all our users are willing to convert their books.

[ryantstone]

I've got this started but have a few questions. We have a few ways to handle completion.

1. Detect when a book is close to done and when a user pauses present a dialog asking if they are done within 1-2 minutes (if it's a book that's split we can write some logic surround this functionality to overcome the 5 minute files)
2. Add a UITableViewRowAction for marking complete
3. When time is complete mark complete

Also, when adding this I went ahead and added isComplete to LibraryItem so this will encompass playlists too and we can have a callback when a book within a playlist completes and once all books are complete in a playlist update it's state too.