isoron/loop
1
1
Fork 0
mirror of https://github.com/iSoron/uhabits.git synced 2025-12-07 09:38:52 -06:00
Code Issues Packages Projects Releases Wiki Activity

Refactor and write docs for Score and ScoreList

Browse Source
This commit is contained in:
Alinson S. Xavier
2016-03-18 07:16:15 -04:00
parent eb017bf99b
commit 0921f9346e
14 changed files with 585 additions and 101 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
app/src/main/java/org/isoron/helpers/ActiveAndroidHelper.java Normal file
View File

@@ -0,0 +1,29 @@
package org.isoron.helpers;
import com.activeandroid.ActiveAndroid;
public class ActiveAndroidHelper
{
public interface Command
{
void execute();
}
public static void executeAsTransaction(Command command)
{
ActiveAndroid.beginTransaction();
try
{
command.execute();
ActiveAndroid.setTransactionSuccessful();
}
catch (RuntimeException e)
{
throw e;
}
finally
{
ActiveAndroid.endTransaction();
}
}
}

4
app/src/main/java/org/isoron/uhabits/commands/EditHabitCommand.java
View File

@@ -50,7 +50,7 @@ public class EditHabitCommand extends Command
{
habit.checkmarks.deleteNewerThan(0);
habit.streaks.deleteNewerThan(0);
habit.scores.deleteNewerThan(0);
habit.scores.invalidateNewerThan(0);
}
}
@@ -65,7 +65,7 @@ public class EditHabitCommand extends Command
{
habit.checkmarks.deleteNewerThan(0);
habit.streaks.deleteNewerThan(0);
habit.scores.deleteNewerThan(0);
habit.scores.invalidateNewerThan(0);
}
}

2
app/src/main/java/org/isoron/uhabits/fragments/ShowHabitFragment.java
View File

@@ -133,7 +133,7 @@ public class ShowHabitFragment extends Fragment
{
RingView scoreRing = (RingView) view.findViewById(R.id.scoreRing);
scoreRing.setColor(habit.color);
scoreRing.setPercentage((float) habit.scores.getNewestValue() / Score.MAX_SCORE);
scoreRing.setPercentage((float) habit.scores.getTodayValue() / Score.MAX_VALUE);
}
private void updateHeaders(View view)

2
app/src/main/java/org/isoron/uhabits/io/CSVExporter.java
View File

@@ -75,7 +75,7 @@ public class CSVExporter
public String formatScore(int score)
{
return String.format("%.2f", ((float) score) / Score.MAX_SCORE);
return String.format("%.2f", ((float) score) / Score.MAX_VALUE);
}
private void writeScores(String dirPath, Habit habit) throws IOException

4
app/src/main/java/org/isoron/uhabits/loaders/HabitListLoader.java
View File

@@ -144,7 +144,7 @@ public class HabitListLoader
if (isCancelled()) return null;
Long id = h.getId();
newScores.put(id, h.scores.getNewestValue());
newScores.put(id, h.scores.getTodayValue());
newCheckmarks.put(id, h.checkmarks.getValues(dateFrom, dateTo));
publishProgress(current++, newHabits.size());
@@ -213,7 +213,7 @@ public class HabitListLoader
Habit h = Habit.get(id);
habits.put(id, h);
scores.put(id, h.scores.getNewestValue());
scores.put(id, h.scores.getTodayValue());
checkmarks.put(id, h.checkmarks.getValues(dateFrom, dateTo));
return null;

16
app/src/main/java/org/isoron/uhabits/models/Habit.java
View File

@@ -117,21 +117,25 @@ public class Habit extends Model
/**
* List of streaks belonging to this habit.
*/
@NonNull
public StreakList streaks;
/**
* List of scores belonging to this habit.
*/
@NonNull
public ScoreList scores;
/**
* List of repetitions belonging to this habit.
*/
@NonNull
public RepetitionList repetitions;
/**
* List of checkmarks belonging to this habit.
*/
@NonNull
public CheckmarkList checkmarks;
/**
@@ -142,7 +146,11 @@ public class Habit extends Model
public Habit(Habit model)
{
copyAttributes(model);
initializeLists();
checkmarks = new CheckmarkList(this);
streaks = new StreakList(this);
scores = new ScoreList(this);
repetitions = new RepetitionList(this);
}
/**
@@ -157,15 +165,11 @@ public class Habit extends Model
this.archived = 0;
this.freqDen = 7;
this.freqNum = 3;
initializeLists();
}
private void initializeLists()
{
checkmarks = new CheckmarkList(this);
streaks = new StreakList(this);
scores = new ScoreList(this);
repetitions = new RepetitionList(this);
checkmarks = new CheckmarkList(this);
}
/**

2
app/src/main/java/org/isoron/uhabits/models/RepetitionList.java
View File

@@ -107,7 +107,7 @@ public class RepetitionList
rep.save();
}
habit.scores.deleteNewerThan(timestamp);
habit.scores.invalidateNewerThan(timestamp);
habit.checkmarks.deleteNewerThan(timestamp);
habit.streaks.deleteNewerThan(timestamp);
}

82
app/src/main/java/org/isoron/uhabits/models/Score.java
View File

@@ -26,16 +26,94 @@ import com.activeandroid.annotation.Table;
@Table(name = "Score")
public class Score extends Model
{
/**
* Minimum score value required to earn half a star.
*/
public static final int HALF_STAR_CUTOFF = 9629750;
public static final int FULL_STAR_CUTOFF = 15407600;
public static final int MAX_SCORE = 19259500;
/**
* Minimum score value required to earn a full star.
*/
public static final int FULL_STAR_CUTOFF = 15407600;
/**
* Maximum score value attainable by any habit.
*/
public static final int MAX_VALUE = 19259478;
/**
* Status indicating that the habit has not earned any star.
*/
public static final int EMPTY_STAR = 0;
/**
* Status indicating that the habit has earned half a star.
*/
public static final int HALF_STAR = 1;
/**
* Status indicating that the habit has earned a full star.
*/
public static final int FULL_STAR = 2;
/**
* Habit to which this score belongs to.
*/
@Column(name = "habit")
public Habit habit;
/**
* Timestamp of the day to which this score applies. Time of day should be midnight (UTC).
*/
@Column(name = "timestamp")
public Long timestamp;
/**
* Value of the score.
*/
@Column(name = "score")
public Integer score;
/**
* Given the frequency of the habit, the previous score, and the value of the current checkmark,
* computes the current score for the habit.
*
* The frequency of the habit is the number of repetitions divided by the length of the
* interval. For example, a habit that should be repeated 3 times in 8 days has frequency 3.0 /
* 8.0 = 0.375.
*
* The checkmarkValue should be UNCHECKED, CHECKED_IMPLICITLY or CHECK_EXPLICITLY.
*
* @param frequency the frequency of the habit
* @param previousScore the previous score of the habit
* @param checkmarkValue the value of the current checkmark
*
* @return the current score
*/
public static int compute(double frequency, int previousScore, int checkmarkValue)
{
double multiplier = Math.pow(0.5, 1.0 / (14.0 / frequency - 1));
int score = (int) (previousScore * multiplier);
if (checkmarkValue == Checkmark.CHECKED_EXPLICITLY)
{
score += 1000000;
score = Math.min(score, Score.MAX_VALUE);
}
return score;
}
/**
* Return the current star status for the habit, which can one of EMPTY_STAR, HALF_STAR or
* FULL_STAR.
*
* @return current star status
*/
public int getStarStatus()
{
if(score >= Score.FULL_STAR_CUTOFF) return Score.FULL_STAR;
if(score >= Score.HALF_STAR_CUTOFF) return Score.HALF_STAR;
return Score.EMPTY_STAR;
}
}

272
app/src/main/java/org/isoron/uhabits/models/ScoreList.java
View File

@@ -21,42 +21,73 @@ package org.isoron.uhabits.models;
import android.database.Cursor;
import android.database.sqlite.SQLiteDatabase;
import android.support.annotation.NonNull;
import android.support.annotation.Nullable;
import com.activeandroid.ActiveAndroid;
import com.activeandroid.Cache;
import com.activeandroid.query.Delete;
import com.activeandroid.query.From;
import com.activeandroid.query.Select;
import org.isoron.helpers.ActiveAndroidHelper;
import org.isoron.helpers.DateHelper;
public class ScoreList
{
@NonNull
private Habit habit;
public ScoreList(Habit habit)
/**
* Constructs a new ScoreList associated with the given habit.
*
* @param habit the habit this list should be associated with
*/
public ScoreList(@NonNull Habit habit)
{
this.habit = habit;
}
public int getCurrentStarStatus()
protected From select()
{
int score = getNewestValue();
if(score >= Score.FULL_STAR_CUTOFF) return 2;
else if(score >= Score.HALF_STAR_CUTOFF) return 1;
else return 0;
}
public Score getNewest()
{
return new Select().from(Score.class)
return new Select()
.from(Score.class)
.where("habit = ?", habit.getId())
.orderBy("timestamp desc")
.limit(1)
.executeSingle();
.orderBy("timestamp desc");
}
public void deleteNewerThan(long timestamp)
/**
* Returns the most recent score already computed. If no score has been computed yet, returns
* null.
*
* @return newest score, or null if none exist
*/
@Nullable
protected Score findNewest()
{
return select().limit(1).executeSingle();
}
/**
* Returns the value of the most recent score that was already computed. If no score has been
* computed yet, returns zero.
*
* @return value of newest score, or zero if none exist
*/
protected int findNewestValue()
{
Score newest = findNewest();
if(newest == null) return 0;
else return newest.score;
}
/**
* Marks all scores that have timestamp equal to or newer than the given timestamp as invalid.
* Any following getValue calls will trigger the scores to be recomputed.
*
* @param timestamp the oldest timestamp that should be invalidated
*/
public void invalidateNewerThan(long timestamp)
{
new Delete().from(Score.class)
.where("habit = ?", habit.getId())
@@ -64,79 +95,137 @@ public class ScoreList
.execute();
}
public Integer getNewestValue()
/**
* Computes and saves the scores that are missing inside a given time interval. Scores that
* have already been computed are skipped, therefore there is no harm in calling this function
* more times, or with larger intervals, than strictly needed. The endpoints of the interval are
* included.
*
* This function assumes that there are no gaps on the scores. That is, if the newest score has
* timestamp t, then every score with timestamp lower than t has already been computed.
*
* @param from timestamp of the beginning of the interval
* @param to timestamp of the end of the time interval
*/
protected void compute(long from, long to)
{
int beginningScore;
long beginningTime;
final long day = DateHelper.millisecondsInOneDay;
final double freq = ((double) habit.freqNum) / habit.freqDen;
long today = DateHelper.getStartOfDay(DateHelper.getLocalTime());
long day = DateHelper.millisecondsInOneDay;
int newestScoreValue = findNewestValue();
Score newestScore = findNewest();
double freq = ((double) habit.freqNum) / habit.freqDen;
double multiplier = Math.pow(0.5, 1.0 / (14.0 / freq - 1));
if(newestScore != null)
from = newestScore.timestamp + day;
Score newestScore = getNewest();
if (newestScore == null)
final int checkmarkValues[] = habit.checkmarks.getValues(from, to);
final int firstScore = newestScoreValue;
final long beginning = from;
ActiveAndroidHelper.executeAsTransaction(new ActiveAndroidHelper.Command()
{
Repetition oldestRep = habit.repetitions.getOldest();
if (oldestRep == null) return 0;
beginningTime = oldestRep.timestamp;
beginningScore = 0;
}
else
{
beginningTime = newestScore.timestamp + day;
beginningScore = newestScore.score;
}
long nDays = (today - beginningTime) / day;
if (nDays < 0) return newestScore.score;
int reps[] = habit.checkmarks.getValues(beginningTime, today);
ActiveAndroid.beginTransaction();
int lastScore = beginningScore;
try
{
for (int i = 0; i < reps.length; i++)
@Override
public void execute()
{
Score s = new Score();
s.habit = habit;
s.timestamp = beginningTime + day * i;
s.score = (int) (lastScore * multiplier);
if (reps[reps.length - i - 1] == 2)
int lastScore = firstScore;
for (int i = 0; i < checkmarkValues.length; i++)
{
s.score += 1000000;
s.score = Math.min(s.score, Score.MAX_SCORE);
int checkmarkValue = checkmarkValues[checkmarkValues.length - i - 1];
Score s = new Score();
s.habit = habit;
s.timestamp = beginning + day * i;
s.score = lastScore = Score.compute(freq, lastScore, checkmarkValue);
s.save();
}
s.save();
lastScore = s.score;
}
ActiveAndroid.setTransactionSuccessful();
} finally
{
ActiveAndroid.endTransaction();
}
return lastScore;
});
}
public int[] getAllValues(Long fromTimestamp, Long toTimestamp, Long divisor)
/**
* Returns the score for a certain day.
*
* @param timestamp the timestamp for the day
* @return the score for the day
*/
@Nullable
protected Score get(long timestamp)
{
// Force rebuild of the score table
getNewestValue();
Repetition oldestRep = habit.repetitions.getOldest();
if(oldestRep == null) return null;
Long offset = toTimestamp - (divisor - 1) * DateHelper.millisecondsInOneDay;
compute(oldestRep.timestamp, timestamp);
return select().where("timestamp = ?", timestamp).executeSingle();
}
/**
* Returns the value of the score for a given day.
*
* @param timestamp the timestamp of a day
* @return score for that day
*/
public int getValue(long timestamp)
{
Score s = get(timestamp);
if(s == null) return 0;
else return s.score;
}
/**
* Returns the values of all the scores, from day of the first repetition until today, grouped
* in chunks of specified size.
*
* If the group size is one, then the value of each score is returned individually. If the group
* is, for example, seven, then the days are grouped in groups of seven consecutive days.
*
* The values are returned in an array of integers, with one entry for each group of days in the
* interval. This value corresponds to the average of the scores for the days inside the group.
* The first entry corresponds to the ending of the interval (that is, the most recent group of
* days). The last entry corresponds to the beginning of the interval. As usual, the time of the
* day for the timestamps should be midnight (UTC). The endpoints of the interval are included.
*
* The values are returned in an integer array. There is one entry for each day inside the
* interval. The first entry corresponds to today, while the last entry corresponds to the
* day of the oldest repetition.
*
* @param divisor the size of the groups
* @return array of values, with one entry for each group of days
*/
@NonNull
public int[] getAllValues(long divisor)
{
Repetition oldestRep = habit.repetitions.getOldest();
if(oldestRep == null) return new int[0];
long fromTimestamp = oldestRep.timestamp;
long toTimestamp = DateHelper.getStartOfToday();
return getValues(fromTimestamp, toTimestamp, divisor);
}
/**
* Same as getAllValues(long), but using a specified interval.
*
* @param from beginning of the interval (included)
* @param to end of the interval (included)
* @param divisor size of the groups
* @return array of values, with one entry for each group of days
*/
@NonNull
protected int[] getValues(long from, long to, long divisor)
{
compute(from, to);
divisor *= DateHelper.millisecondsInOneDay;
Long offset = to + divisor - 1;
String query = "select ((timestamp - ?) / ?) as time, avg(score) from Score " +
"where habit = ? and timestamp > ? and timestamp <= ? " +
"where habit = ? and timestamp >= ? and timestamp <= ? " +
"group by time order by time desc";
String params[] = { offset.toString(), divisor.toString(), habit.getId().toString(),
fromTimestamp.toString(), toTimestamp.toString()};
String params[] = { offset.toString(), Long.toString(divisor), habit.getId().toString(),
Long.toString(from), Long.toString(to) };
SQLiteDatabase db = Cache.openDatabase();
Cursor cursor = db.rawQuery(query, params);
@@ -148,22 +237,45 @@ public class ScoreList
do
{
scores[k++] = (int) cursor.getLong(1);
scores[k++] = (int) cursor.getFloat(1);
}
while (cursor.moveToNext());
cursor.close();
return scores;
}
public int[] getAllValues(long divisor)
/**
* Returns the score for today.
*
* @return score for today
*/
@Nullable
protected Score getToday()
{
Repetition oldestRep = habit.repetitions.getOldest();
if(oldestRep == null) return new int[0];
return get(DateHelper.getStartOfToday());
}
long fromTimestamp = oldestRep.timestamp;
long toTimestamp = DateHelper.getStartOfToday();
return getAllValues(fromTimestamp, toTimestamp, divisor);
/**
* Returns the value of the score for today.
*
* @return value of today's score
*/
public int getTodayValue()
{
return getValue(DateHelper.getStartOfToday());
}
/**
* Returns the star status for today. The returned value is either Score.EMPTY_STAR,
* Score.HALF_STAR or Score.FULL_STAR.
*
* @return star status for today
*/
public int getTodayStarStatus()
{
Score score = getToday();
if(score != null) return score.getStarStatus();
else return Score.EMPTY_STAR;
}
}

2
app/src/main/java/org/isoron/uhabits/views/CheckmarkView.java
View File

@@ -115,7 +115,7 @@ public class CheckmarkView extends View
public void setHabit(Habit habit)
{
this.check_status = habit.checkmarks.getTodayValue();
this.star_status = habit.scores.getCurrentStarStatus();
this.star_status = habit.scores.getTodayStarStatus();
this.primaryColor = Color.argb(230, Color.red(habit.color), Color.green(habit.color), Color.blue(habit.color));
this.label = habit.name;
updateLabel();

10
app/src/main/java/org/isoron/uhabits/views/HabitScoreView.java
View File

@@ -171,7 +171,7 @@ public class HabitScoreView extends ScrollableDataView implements HabitDataView
else
{
if (habit == null) return;
scores = habit.scores.getAllValues(BUCKET_SIZE * DateHelper.millisecondsInOneDay);
scores = habit.scores.getAllValues(BUCKET_SIZE);
}
invalidate();
@@ -181,13 +181,13 @@ public class HabitScoreView extends ScrollableDataView implements HabitDataView
{
Random random = new Random();
scores = new int[100];
scores[0] = Score.MAX_SCORE / 2;
scores[0] = Score.MAX_VALUE / 2;
for(int i = 1; i < 100; i++)
{
int step = Score.MAX_SCORE / 10;
int step = Score.MAX_VALUE / 10;
scores[i] = scores[i - 1] + random.nextInt(step * 2) - step;
scores[i] = Math.max(0, Math.min(Score.MAX_SCORE, scores[i]));
scores[i] = Math.max(0, Math.min(Score.MAX_VALUE, scores[i]));
}
}
@@ -224,7 +224,7 @@ public class HabitScoreView extends ScrollableDataView implements HabitDataView
int offset = nColumns - k - 1 + getDataOffset();
if(offset < scores.length) score = scores[offset];
double sRelative = ((double) score) / Score.MAX_SCORE;
double sRelative = ((double) score) / Score.MAX_VALUE;
int height = (int) (columnHeight * sRelative);
rect.set(0, 0, baseSize, baseSize);