Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New feature: allow users to automatically skip certain days of the week #2012

Open
wants to merge 24 commits into
base: dev
Choose a base branch
from

Conversation

dharux
Copy link

@dharux dharux commented Jun 25, 2024

With this, the user can select days of the week to be skipped automatically every week.

The use case I wrote this for is as follows: (closes #1980)
I have some tasks which I do only on working days and some tasks I do only on weekends/holidays. Therefore, I needed to automatically skip the weekend for some tasks and the working days for other tasks. To generalize it, any days of the week can be set for automatic skipping.

I added a new class, SkipDays, which is an attribute of the Habit class. It holds information on whether automatic skipping is turned on or off and which days of the week should be skipped. The skip days option is only available in the EditHabitAcitivity when it (isSkipEnabled) is enabled in preferences. It is also only enabled for daily and weekly habits. Auto-skipping days can be enabled in the edit habit activity. It uses the same weekday picker as the reminder to select the days to skip.

Auto skipping days affects the following:

  • HabitList: the automatically skipped days are marked as skipped for every week. If a user tries to add an entry for an auto-skipped day, the entry is blocked, and a toast message is displayed.
  • TargetCard: for weekly numerical habits, the target is equally divided between the non-skipped days; so that the target is calculated properly for all intervals
  • HistoryCard: the automatically skipped days are marked as skip for every week, starting from the day of the first manual entry, to prevent clutter. When the user tries to add an entry for an auto-skipped day, the entry is blocked, and a toast message is displayed.
  • Streaks: the automatically skipped days are counted as part of a streak, so that a streak is not broken every week. However, any streaks with just skip entries are ignored.

If the auto-skip feature is turned on for a habit with already existing entries, the entries are not modified in any way. If there already exists entries on the now auto-skip days, then those entries are simply ignored.

The database version is bumped, and a new SQL file is added so that the update from the current version works.

I have also written some unit tests to test the streak and target card behavior with auto skip turned on.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant