From 6ac7ef7807157dfc432fe859fc3bc29088d060e2 Mon Sep 17 00:00:00 2001 From: Alinson Xavier Date: Sun, 31 Mar 2019 17:15:39 -0500 Subject: [PATCH] Add stubs for Score and Streak --- .../kotlin/org/isoron/uhabits/models/Score.kt | 39 +++++++++++++++++++ .../org/isoron/uhabits/models/ScoreList.kt | 38 ++++++++++++++++++ .../org/isoron/uhabits/models/Streak.kt | 34 ++++++++++++++++ .../org/isoron/uhabits/models/StreakList.kt | 34 ++++++++++++++++ 4 files changed, 145 insertions(+) create mode 100644 core/src/commonMain/kotlin/org/isoron/uhabits/models/Score.kt create mode 100644 core/src/commonMain/kotlin/org/isoron/uhabits/models/ScoreList.kt create mode 100644 core/src/commonMain/kotlin/org/isoron/uhabits/models/Streak.kt create mode 100644 core/src/commonMain/kotlin/org/isoron/uhabits/models/StreakList.kt diff --git a/core/src/commonMain/kotlin/org/isoron/uhabits/models/Score.kt b/core/src/commonMain/kotlin/org/isoron/uhabits/models/Score.kt new file mode 100644 index 000000000..35382dc8a --- /dev/null +++ b/core/src/commonMain/kotlin/org/isoron/uhabits/models/Score.kt @@ -0,0 +1,39 @@ +/* + * Copyright (C) 2016-2019 Álinson Santos Xavier + * + * This file is part of Loop Habit Tracker. + * + * Loop Habit Tracker is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by the + * Free Software Foundation, either version 3 of the License, or (at your + * option) any later version. + * + * Loop Habit Tracker is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY + * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + * more details. + * + * You should have received a copy of the GNU General Public License along + * with this program. If not, see . + */ + +package org.isoron.uhabits.models + +import org.isoron.platform.time.* + +/** + * A Score is a number which indicates how strong the habit is at a given date. + * + * Scores are computed by taking an exponential moving average of the values of + * the checkmarks in preceding days. For boolean habits, when computing the + * average, each checked day (whether the check was manual or automatic) has + * value as 1, while days without checkmarks have value 0. + * + * For numerical habits, each day that exceeded the target has value 1, while + * days which failed to exceed the target receive a partial value, based on the + * proportion that was completed. For example, if the target is 100 units and + * the user completed 70 units, then the value for that day is 0.7 when + * computing the average. + */ +data class Score(val date: LocalDate, + val value: Double) \ No newline at end of file diff --git a/core/src/commonMain/kotlin/org/isoron/uhabits/models/ScoreList.kt b/core/src/commonMain/kotlin/org/isoron/uhabits/models/ScoreList.kt new file mode 100644 index 000000000..91b2b0c3f --- /dev/null +++ b/core/src/commonMain/kotlin/org/isoron/uhabits/models/ScoreList.kt @@ -0,0 +1,38 @@ +/* + * Copyright (C) 2016-2019 Álinson Santos Xavier + * + * This file is part of Loop Habit Tracker. + * + * Loop Habit Tracker is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by the + * Free Software Foundation, either version 3 of the License, or (at your + * option) any later version. + * + * Loop Habit Tracker is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY + * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + * more details. + * + * You should have received a copy of the GNU General Public License along + * with this program. If not, see . + */ + +package org.isoron.uhabits.models + +import org.isoron.platform.time.* + +class ScoreList(private val frequency: Frequency, + private val checkmarkList: CheckmarkList) { + + /** + * Returns a list of all scores, from the beginning of the habit history + * until the specified date. + * + * The interval is inclusive, and the list is sorted from newest to oldest. + * That is, the first element of the returned list corresponds to the date + * provided. + */ + fun getValuesUntil(date: LocalDate): List { + TODO() + } +} \ No newline at end of file diff --git a/core/src/commonMain/kotlin/org/isoron/uhabits/models/Streak.kt b/core/src/commonMain/kotlin/org/isoron/uhabits/models/Streak.kt new file mode 100644 index 000000000..1bcdc2d37 --- /dev/null +++ b/core/src/commonMain/kotlin/org/isoron/uhabits/models/Streak.kt @@ -0,0 +1,34 @@ +/* + * Copyright (C) 2016-2019 Álinson Santos Xavier + * + * This file is part of Loop Habit Tracker. + * + * Loop Habit Tracker is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by the + * Free Software Foundation, either version 3 of the License, or (at your + * option) any later version. + * + * Loop Habit Tracker is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY + * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + * more details. + * + * You should have received a copy of the GNU General Public License along + * with this program. If not, see . + */ + +package org.isoron.uhabits.models + +import org.isoron.platform.time.* + +/** + * A streak is an uninterrupted sequence of days where the habit was performed. + * + * For daily boolean habits, the definition is straightforward: a streak is a + * sequence of days that have checkmarks. For non-daily habits, note + * that automatic checkmarks (the ones added by the app) can also keep the + * streak going. For numerical habits, a streak is a sequence of days where the + * user has consistently exceeded the target for the habit. + */ +data class Streak(val start: LocalDate, + val end: LocalDate) \ No newline at end of file diff --git a/core/src/commonMain/kotlin/org/isoron/uhabits/models/StreakList.kt b/core/src/commonMain/kotlin/org/isoron/uhabits/models/StreakList.kt new file mode 100644 index 000000000..0d037b6c8 --- /dev/null +++ b/core/src/commonMain/kotlin/org/isoron/uhabits/models/StreakList.kt @@ -0,0 +1,34 @@ +/* + * Copyright (C) 2016-2019 Álinson Santos Xavier + * + * This file is part of Loop Habit Tracker. + * + * Loop Habit Tracker is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by the + * Free Software Foundation, either version 3 of the License, or (at your + * option) any later version. + * + * Loop Habit Tracker is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY + * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + * more details. + * + * You should have received a copy of the GNU General Public License along + * with this program. If not, see . + */ + +package org.isoron.uhabits.models + +class StreakList(private val checkmarkList: CheckmarkList) { + + /** + * Returns the longest streaks. + * + * The argument specifies the maximum number of streaks to find. The + * returned list is sorted by date (descending). That is, the first element + * corresponds to the most recent streak. + */ + fun getBest(limit: Int): List { + TODO() + } +} \ No newline at end of file