Added ability to mark a card as done

[TehThanos]

• Resolves: Mark card as done #534
• Target version: master

Summary

This adds the ability to mark a card as done.
When the card is marked as done if it has a due date then it makes it un-editable, if it doesn't it simply displays "No due date"
Marking a card as done also hides it from the upcoming section.

TODO

• Add Rest API documentation
• Design changes requested form @nimishavijay
• Remove l10n changes
• lint issues
• style lint issues
• document headline number wrong here
• missing cypress tests
• Move from boolean column to datetime to store that exact timestamp when a card was marked as done
  • Change migration
  • Properly handle the datetime in the backend
  • Maybe indicate the done timestamp in the frontend on hover of the icon or in the details view next to the done label
  • Expose it through the caldav backend Added ability to mark a card as done #4137 (comment)
  • Double check visibility of icons in archived state
• Find a proper layout for modal/sidebar for the done state and buttons

Follow up issues

• Done by to store which user marked it (as suggested by @z0rgster)

Checklist

• Code is properly formatted
• Sign-off message is added to all commits
• Tests (unit, integration, api and/or acceptance) are included
• Documentation (manuals or wiki) has been updated or is not required

Screenshots

Current state (12th September)

[TehThanos]

I ran the tests and the only ones failing are the ones in this file tests/integration/features/acl.feature.
The weird thing is they fail regardless of if I include my commits or not, is this expected or do I have a server configuration error?

[juliusknorr]

Very nice, really cool to see this pull request :) I've left a few comments inline, but it looks good to me in general.

Maybe you could post some screenshots of the frontend changes as well in order to get a review from our designers @nimishavijay and @jancborchardt :)

[juliusknorr]

Translations are handled through http://transifex.com/nextcloud/nextcloud/ so those changes would get overwritten by the nightly sync unless the translation is added there, but fine to keep them for the pr.

[juliusknorr]

This one is still valid

[TehThanos]

I am not sure what's up with my dev environment but now when I try to run the integration tests I get APM: Locking APM for 300 seconds for reason: Cannot connect to the agent and while the do run, it takes forever. I don't have time today so I haven't run them but I'll take a look at it tomorrow, sorry.

[TehThanos]

composer run psalm still returns ERROR: MoreSpecificImplementedParamType - lib/Migration/Version10900Date20221020074643.php:44:56 and I am not sure how to fix it since I also get UndefinedClass for SimpleMigrationStep on my system. If anyone can help me I would appreciate it. Please also take a closer look at commit 44fbb5a6

[raimund-schluessler]

Since Deck offers an exposure of its cards via CalDAV, I think it would make sense to align with the RFC 5545. Specifically, the done/completed state of a todo is tracked by the COMPLETED property which stores the Date-Time the todo was completed at. See https://datatracker.ietf.org/doc/html/rfc5545#section-3.8.2.1.

So instead of storing a boolean value done in the database, I would propose to call the property completed and let it store a date with UTC time instead. That would better map to the properties of a todo defined in RFC 5545.

Edit:
I would then also adjust these lines

deck/lib/Db/Card.php

Lines 142 to 148 in bd9538d

	$event->STATUS = $this->getArchived() ? "COMPLETED" : "NEEDS-ACTION";
	if ($this->getArchived()) {
	$date = new DateTime();
	$date->setTimestamp($this->getLastModified());
	$event->COMPLETED = $date;
	//$event->add('PERCENT-COMPLETE', 100);
	}

to correctly respect the COMPLETED property instead of the date the card was archived/last-modified.

[Flix6x]

Small linguistic suggestions in my review. (Really looking forward to this feature, thank you for putting in the work!)

[juliusknorr]

I'll try to collect open topics now in the first post to make the conversation a bit cleaner.

[juliusknorr]

Note you can ignore the one cypress failure, this is also an issue on the main branch

[juliusknorr]

Thanks again for the nice PR. I did a rebase onto the latest main branch, i'd pick this up to adapt to storing the datetime instead of a boolean during the next days so we can get this in soonish. Hope that works for you :)

[TehThanos]

Yes, I'm very sorry I haven't been more active.

[juliusknorr]

Moved to a datetime now and rebased again. Will put a checklist on what is still missing above

[stefan-niedermann]

So how does this feature eventually work?

• The REST endpoints are the same as before?
• The card properties do have an additional timestamp property from Done?
• Is there an UI toggle for the Done property or a automatism when moving from / to the last list? Or both?
• Are ETags updated properly when the flag changes?

[donty]

Seen the update for v 1.11.1 come through on our Nextcloud but I don't see the Done option in the UI anywhere logical - to me anyhow ;-) Looks like it was merged before the update so just wondering if I missed something?

[shoetten]

Seen the update for v 1.11.1 come through on our Nextcloud but I don't see the Done option in the UI anywhere logical - to me anyhow ;-) Looks like it was merged before the update so just wondering if I missed something?

It was merged before, but not backported to the v1.11 / stable27 branch ;) See the release notes. It will ship with v1.12.0, probably with the next major of nextcloud, i guess.

[donty]

Thanks! So I did miss something ;-)

[sickstee]

Would it be possible to implement marking a card as done in the "reminders" app on IOS or any other to-do app that pulls infos via CalDav from the server? By now, marking a card as done in the "reminders" app doesn't pull the state to the deck app

[stefan-niedermann]

@TehThanos and @juliushaertl would you mind having a look at some open questions to be able to ship this feature also for the Deck Android app? 🙂

[TehThanos]

The REST endpoints are the same as before?

Yes, with the addition of /cards/[id]/done and /cards/[id]/undone

The card properties do have an additional timestamp property from Done?

The done property is a datetime if the card isn't done it will be null

Is there an UI toggle for the Done property or a automatism when moving from / to the last list? Or both?

I'm not sure what exactly you mean, there is a button to mark the card as done or not done, I'm don't know about any automations.

Are ETags updated properly when the flag changes?

I believe so.