Merge branch 'ticalc-travis-sched-refactor'

Author: gfwilliams

apps/keytimer/ChangeLog

@@ -2,3 +2,4 @@
 0.02: Submitted to the app loader
 0.03: Rewrote to use scheduler library
 0.04: Use theme colors
+0.05: Avoid need for custom alarm handler--now uses latest handler provided by sched lib

apps/keytimer/boot.js

@@ -0,0 +1,8 @@
+Bangle.on('alarmDismiss', alarm => {
+  if (alarm.appid === 'keytimer') {
+    console.debug('keytimer: alarmDismiss for keytimer alarm');
+    let state = require('Storage').readJSON('keytimer.json');
+    state.timeLeft = 0;
+    require('Storage').writeJSON('keytimer.json', state);
+  }
+});

apps/keytimer/common.js

@@ -27,10 +27,9 @@ exports.startTimer = function (time) {
     let timer = sched.newDefaultTimer();
 
     timer.timer = time;
-    common.state.timeLeft = time;
+    exports.state.timeLeft = time;
     timer.del = true;
     timer.appid = 'keytimer';
-    timer.js = "load('keytimer-ring.js')";
 
     sched.setAlarm('keytimer', timer);
     sched.reload();

apps/keytimer/metadata.json

@@ -1,7 +1,7 @@
 {
   "id": "keytimer",
   "name": "Keypad Timer",
-  "version": "0.04",
+  "version": "0.05",
   "author": "bruceblore",
   "description": "A timer with a keypad that runs in the background",
   "icon": "icon.png",
@@ -17,6 +17,10 @@
       "name": "keytimer.app.js",
       "url": "app.js"
     },
+    {
+      "name": "keytimer.boot.js",
+      "url": "boot.js"
+    },
     {
       "name": "keytimer.img",
       "url": "icon.js",
@@ -26,10 +30,6 @@
       "name": "keytimer-com.js",
       "url": "common.js"
     },
-    {
-      "name": "keytimer-ring.js",
-      "url": "ring.js"
-    },
     {
       "name": "keytimer-keys.js",
       "url": "keypad.js"

apps/keytimer/ring.js

@@ -43,3 +43,5 @@
 0.40: Prevent time-of-day alarms set via setAlarm() that have a time earlier than the current time triggering immediately after #4220 fix; schedule them for tomorrow by default to match original behavior
 0.41: Fix issue with snoozing alarms and timers beyond midnight causing the alarm/timer to go off immediately instead of snoozing
 0.42: Fix timer snooze 5m button adding 6 minutes instead of 5
+0.43: Introduce `snoozeAlarm` and `dismissAlarm` functions for easier alarm handling by custom JS
+

apps/sched/ChangeLog

@@ -2,6 +2,35 @@ function timeToMillis(time) {
   return (time.getHours() * 3600000) + (time.getMinutes() * 60000) + (time.getSeconds() * 1000);
 }
 
+function setNextRepeatDate(alarm) {
+  let date = new Date(alarm.date);
+  let rp = alarm.rp;
+  if (rp===true) { // fallback in case rp is set wrong
+    date.setDate(date.getDate() + 1);
+  } else switch(rp.interval) { // rp is an object
+    case "day":
+      date.setDate(date.getDate() + rp.num);
+      break;
+    case "week":
+      date.setDate(date.getDate() + (rp.num * 7));
+      break;
+    case "month":
+      if (!alarm.od) alarm.od = date.getDate();
+      date = new Date(date.getFullYear(), date.getMonth() + rp.num, alarm.od);
+      if (date.getDate() != alarm.od) date.setDate(0);
+      break;
+    case "year":
+      if (!alarm.od) alarm.od = date.getDate();
+      date = new Date(date.getFullYear() + rp.num, date.getMonth(), alarm.od);
+      if (date.getDate() != alarm.od) date.setDate(0);
+      break;
+    default:
+      console.log(`sched: unknown repeat '${JSON.stringify(rp)}'`);
+      break;
+  }
+  alarm.date = date.toLocalISOString().slice(0,10);
+}
+
 // Return an array of all alarms
 exports.getAlarms = function() {
   // we do this direct in clkinfo.js to avoid loading the library
@@ -77,6 +106,81 @@ exports.setAlarm = function(id, alarm) {
   return alarm;
 };
 
+// Put an alarm on snooze for `snoozeTime` milliseconds (if already
+// snoozed, this will add to the existing snooze time).
+//
+// `alarms` is the list of alarms from getAlarms, and `alarm` is the
+// alarm object from that list to snooze.
+exports.snoozeAlarm = function(alarms, alarm, snoozeTime) {
+  if (alarms.indexOf(alarm) < 0) {
+    console.error('[sched] snoozeAlarm: Given alarm not in list of alarms');
+    return 'error';
+  }
+
+  if (alarm.ot === undefined) {
+    alarm.ot = alarm.t;
+  }
+  let time = new Date();
+  let currentTime = timeToMillis(time);
+  alarm.t = currentTime + snoozeTime;
+  alarm.t %= 86400000;
+
+  // This makes updateAlarm() recompute the last alarm date so
+  // that it works correctly if we're snoozing beyond midnight
+  delete alarm.last;
+
+  exports.updateAlarm(alarm);
+
+  // Save snoozed alarm (still a member of `alarms`) back to storage
+  exports.setAlarms(alarms);
+  Bangle.emit("alarmSnooze", alarm);
+  return 'snoozed';
+};
+
+// Stop and dismiss an expired alarm. This will cancel any snooze status
+// on the alarm, turn the alarm off (or delete the alarm if configured
+// to do so), or reschedule the alarm if it's set to repeat.
+//
+// Returns the string 'stopped', 'deleted', or 'rescheduled' to indicate
+// what action was taken.
+//
+// `alarms` is the list of alarms from getAlarms, and `alarm` is the
+// alarm object from that list to dismiss.
+exports.dismissAlarm = function(alarms, alarm) {
+  const alarmIndex = alarms.indexOf(alarm);
+  if (alarmIndex < 0) {
+    console.error('[sched] dismissAlarm: Given alarm not in list of alarms');
+    return 'error';
+  }
+
+  const settings = exports.getSettings();
+  let actionTaken = 'stopped';
+  let del = alarm.del === undefined ? settings.defaultDeleteExpiredTimers : alarm.del;
+  if (del) {
+    alarms.splice(alarmIndex, 1);
+    actionTaken = 'deleted';
+  } else {
+    if (alarm.date && alarm.rp) {
+      setNextRepeatDate(alarm);
+      actionTaken = 'rescheduled';
+    } else if (!alarm.timer) {
+      alarm.last = new Date().getDate();
+    }
+    if (alarm.ot !== undefined) {
+      alarm.t = alarm.ot;
+      delete alarm.ot;
+    }
+    if (!alarm.rp) {
+      alarm.on = false;
+    }
+  }
+
+  // Save dismissed alarm (still a member of `alarms`) back to storage
+  require("sched").setAlarms(alarms);
+  Bangle.emit("alarmDismiss", alarm);
+  return actionTaken;
+};
+
 /// Get time until the given alarm (object). Return undefined if alarm not enabled, or if 86400000 or more, alarm could be *more* than a day in the future
 exports.getTimeToAlarm = function(alarm, time) {
   if (!alarm) return undefined;

apps/sched/lib.js

@@ -1,7 +1,7 @@
 {
   "id": "sched",
   "name": "Scheduler",
-  "version": "0.42",
+  "version": "0.43",
   "author": "gfwilliams",
   "description": "Scheduling library for alarms and timers",
   "icon": "app.png",

apps/sched/metadata.json

@@ -16,33 +16,12 @@ function formatMS(ms) {
   }
 }
 
-function snoozeAlarm(alarm, snoozeTime) {
-    if (alarm.ot === undefined) {
-      alarm.ot = alarm.t;
-    }
-    let time = new Date();
-    let currentTime = (time.getHours()*3600000)+(time.getMinutes()*60000)+(time.getSeconds()*1000);
-    alarm.t = currentTime + snoozeTime;
-    alarm.t %= 86400000;
-
-    // This makes updateAlarm() recompute the last alarm date so
-    // that it works correctly if we're snoozing beyond midnight
-    delete alarm.last;
-
-    require("sched").updateAlarm(alarm);
-    Bangle.emit("alarmSnooze", alarm);
-
-    // The updated alarm is still a member of 'alarms'
-    // so writing to array writes changes back directly
-    require("sched").setAlarms(alarms);
-}
-
 function showSnoozeMenu(alarm){
 
   Bangle.buzz(40);
 
   function onSnooze(snoozeTime) {
-    snoozeAlarm(alarm, snoozeTime);
+    require("sched").snoozeAlarm(alarms, alarm, snoozeTime);
     load();
   }
 
@@ -66,7 +45,6 @@ function showSnoozeMenu(alarm){
 }
 
 function showAlarm(alarm) {
-  const alarmIndex = alarms.indexOf(alarm);
   const settings = require("sched").getSettings();
 
   let message = "";
@@ -93,30 +71,9 @@ function showAlarm(alarm) {
       return;
     }
     if (sleep==1) {
-      snoozeAlarm(alarm, settings.defaultSnoozeMillis);
+      require("sched").snoozeAlarm(alarms, alarm, settings.defaultSnoozeMillis);
     } else { // sleep=2, stop the alarm
-      let del = alarm.del === undefined ? settings.defaultDeleteExpiredTimers : alarm.del;
-      if (del) {
-        alarms.splice(alarmIndex, 1);
-      } else {
-        if (alarm.date && alarm.rp) {
-          setNextRepeatDate(alarm);
-        } else if (!alarm.timer) {
-          alarm.last = new Date().getDate();
-        }
-        if (alarm.ot !== undefined) {
-          alarm.t = alarm.ot;
-          delete alarm.ot;
-        }
-        if (!alarm.rp) {
-          alarm.on = false;
-        }
-      }
-      Bangle.emit("alarmDismiss", alarm);
-
-      // The updated alarm is still a member of 'alarms'
-      // so writing to array writes changes back directly
-      require("sched").setAlarms(alarms);
+      require("sched").dismissAlarm(alarms, alarm);
     }
 
     load();
@@ -145,35 +102,6 @@ function showAlarm(alarm) {
     });
   }
 
-  function setNextRepeatDate(alarm) {
-    let date = new Date(alarm.date);
-    let rp = alarm.rp;
-    if (rp===true) { // fallback in case rp is set wrong
-      date.setDate(date.getDate() + 1);
-    } else switch(rp.interval) { // rp is an object
-      case "day":
-        date.setDate(date.getDate() + rp.num);
-        break;
-      case "week":
-        date.setDate(date.getDate() + (rp.num * 7));
-        break;
-      case "month":
-        if (!alarm.od) alarm.od = date.getDate();
-        date = new Date(date.getFullYear(), date.getMonth() + rp.num, alarm.od);
-        if (date.getDate() != alarm.od) date.setDate(0);
-        break;
-      case "year":
-        if (!alarm.od) alarm.od = date.getDate();
-        date = new Date(date.getFullYear() + rp.num, date.getMonth(), alarm.od);
-        if (date.getDate() != alarm.od) date.setDate(0);
-        break;
-      default:
-        console.log(`sched: unknown repeat '${JSON.stringify(rp)}'`);
-        break;
-    }
-    alarm.date = date.toLocalISOString().slice(0,10);
-  }
-
   if ((require("Storage").readJSON("setting.json", 1) || {}).quiet > 1)
     return;