node-schedule 1.2.1 → 1.2.5

package/.eslintrc

@@ -1,16 +1,17 @@
 {
   "env": {
-    "node": true
+    "node": true,
+    "es6": true
   },
   "rules": {
-    "eqeqeq": [2, "smart"],
-    "indent": [2, 2],
-    "no-constant-condition": false,
-    "no-redeclare": 1,
-    "no-underscore-dangle": false,
-    "no-use-before-define": [true,"nofunc"],
-    "quotes": [2, "single"],
-    "space-before-blocks": 2,
-    "strict": 2
+    "eqeqeq": ["error", "smart"],
+    "indent": ["error", 2, { "SwitchCase": 1 }],
+    "no-constant-condition": "off",
+    "no-redeclare": "warn",
+    "no-underscore-dangle": "off",
+    "no-use-before-define": ["warn","nofunc"],
+    "quotes": ["error", "single"],
+    "space-before-blocks": "error",
+    "strict": "error"
   }
 }

package/.travis.yml

@@ -3,6 +3,13 @@ node_js:
   - "0.12"
   - "0.10"
   - "4"
-  - "5"
-before_script: npm run lint
+  - "6"
+  - "7"
+before_script: >
+  if nvm ls-remote --lts | grep "$(nvm current)"; then
+    echo "running on a LTS node version, linting"
+    npm test
+  else
+    echo "running on a non-LTS node version, skipping linting"
+  fi
 script: ./node_modules/.bin/istanbul cover ./node_modules/.bin/nodeunit test && cat ./coverage/lcov.info | ./node_modules/.bin/coveralls && rm -rf ./coverage

package/README.md

@@ -48,8 +48,9 @@ They also emit a `scheduled` event each time they're scheduled to run, and a
 `canceled` event when an invocation is canceled before it's executed (both events
 receive a JavaScript date object as a parameter). Note that jobs are scheduled the
 first time immediately, so if you create a job using the `scheduleJob()`
-convenience method, you'll miss the first `scheduled` event. Also note that
-`canceled` is the single-L American spelling.
+convenience method, you'll miss the first `scheduled` event, but you can query the
+invocation manually (see below). Also note that `canceled` is the single-L American
+spelling.
 
 ### Cron-style Scheduling
 
@@ -110,12 +111,6 @@ var j = schedule.scheduleJob(date, function(){
 });
 ```
 
-You can invalidate the job with the `cancel()` method:
-
-```js
-j.cancel();
-```
-
 To use current data in the future you can use binding:
 
 ```js
@@ -200,6 +195,32 @@ var j = schedule.scheduleJob({ start: startTime, end: endTime, rule: '*/1 * * *
 });
 ```
 
+### Handle Jobs and Job Invocations
+
+There are some function to get informations for a Job and to handle the Job and
+Invocations.
+
+
+#### job.cancel(reshedule)
+You can invalidate any job with the `cancel()` method:
+
+```js
+j.cancel();
+```
+All planned invocations will be canceled. When you set the parameter ***reschedule***
+to true then the Job is newly scheduled afterwards.
+
+#### job.cancelNext(reshedule)
+This method invalidates the next planned invocation or the job.
+When you set the parameter ***reschedule*** to true then the Job is newly scheduled
+afterwards.
+
+#### job.reschedule(spec)
+This method cancels all pending invocation and registers the Job completely new again using the given specification.
+Return true/false on success/failure.
+
+#### job.nextInvocation()
+This method returns a Date object for the planned next Invocation for this Job. If no invocation is planned the method returns null.
 
 ## Contributing
 

package/lib/schedule.js

@@ -15,6 +15,7 @@ var events = require('events'),
 
 /* Job object */
 var anonJobCounter = 0;
+var scheduledJobs = {};
 
 function isValidDate(date) {
   // Taken from http://stackoverflow.com/a/12372720/1562178
@@ -185,33 +186,40 @@ Job.prototype.schedule = function(spec) {
   var inv;
   var start;
   var end;
+  var tz;
 
   if (typeof spec === 'object' && spec.rule) {
-    start = spec.start || null;
-    end = spec.end || null;
+    start = spec.start || undefined;
+    end = spec.end || undefined;
+    tz = spec.tz;
     spec = spec.rule;
 
-    if (start != null) {
+    if (start) {
       if (!(start instanceof Date)) {
         start = new Date(start);
       }
+
+      start = new CronDate(start, tz);
       if (!isValidDate(start) || start.getTime() < Date.now()) {
-        start = null;
+        start = undefined;
       }
     }
 
-    if (end != null && !(end instanceof Date) && !isValidDate(end = new Date(end))) {
-      end = null;
+    if (end && !(end instanceof Date) && !isValidDate(end = new Date(end))) {
+      end = undefined;
+    }
+
+    if (end) {
+      end = new CronDate(end, tz);
     }
   }
 
   try {
-    var res = cronParser.parseExpression(spec, { currentDate: start });
+    var res = cronParser.parseExpression(spec, { currentDate: start, tz: tz });
     inv = scheduleNextRecurrence(res, self, start, end);
     if (inv !== null) {
       success = self.trackInvocation(inv);
     }
-
   } catch (err) {
     var type = typeof spec;
     if ((type === 'string') || (type === 'number')) {
@@ -219,6 +227,7 @@ Job.prototype.schedule = function(spec) {
     }
 
     if ((spec instanceof Date) && (isValidDate(spec))) {
+      spec = new CronDate(spec);
       if (spec.getTime() >= Date.now()) {
         inv = new Invocation(self, spec);
         scheduleInvocation(inv);
@@ -252,6 +261,7 @@ Job.prototype.schedule = function(spec) {
         spec = r;
       }
 
+      spec.tz = tz;
       inv = scheduleNextRecurrence(spec, self, start, end);
       if (inv !== null) {
         success = self.trackInvocation(inv);
@@ -336,13 +346,68 @@ function RecurrenceRule(year, month, date, dayOfWeek, hour, minute, second) {
   this.second = (second == null) ? 0 : second;
 }
 
+RecurrenceRule.prototype.isValid = function() {
+  function isValidType(num) {
+    if (Array.isArray(num) || (num instanceof Array)) {
+      return num.every(function(e) {
+        return isValidType(e);
+      });
+    }
+    return !(Number.isNaN(Number(num)) && !(num instanceof Range));
+  }
+  if (this.month !== null && (this.month < 0 || this.month > 11 || !isValidType(this.month))) {
+    return false;
+  }
+  if (this.dayOfWeek !== null && (this.dayOfWeek < 0 || this.dayOfWeek > 6 || !isValidType(this.dayOfWeek))) {
+    return false;
+  }
+  if (this.hour !== null && (this.hour < 0 || this.hour > 23 || !isValidType(this.hour))) {
+    return false;
+  }
+  if (this.minute !== null && (this.minute < 0 || this.minute > 59 || !isValidType(this.minute))) {
+    return false;
+  }
+  if (this.second !== null && (this.second < 0 || this.second > 59 || !isValidType(this.second))) {
+    return false;
+  }
+  if (this.date !== null) {
+    if(!isValidType(this.date)) {
+      return false;
+    }
+    switch (this.month) {
+      case 3:
+      case 5:
+      case 8:
+      case 10:
+        if (this.date < 1 || this. date > 30) {
+          return false;
+        }
+        break;
+      case 1:
+        if (this.date < 1 || this. date > 29) {
+          return false;
+        }
+        break;
+      default:
+        if (this.date < 1 || this. date > 31) {
+          return false;
+        }
+    }
+  }
+  return true;
+};
+
 RecurrenceRule.prototype.nextInvocationDate = function(base) {
-  base = (base instanceof Date) ? base : (new Date());
+  base = ((base instanceof CronDate) || (base instanceof Date)) ? base : (new Date());
   if (!this.recurs) {
     return null;
   }
 
-  var now = new Date();
+  if(!this.isValid()) {
+    return null;
+  }
+
+  var now = new CronDate(Date.now(), this.tz);
   var fullYear = now.getFullYear();
   if ((this.year !== null) &&
       (typeof this.year == 'number') &&
@@ -350,7 +415,7 @@ RecurrenceRule.prototype.nextInvocationDate = function(base) {
     return null;
   }
 
-  var next = new CronDate(base.getTime());
+  var next = new CronDate(base.getTime(), this.tz);
   next.addSecond();
 
   while (true) {
@@ -399,7 +464,7 @@ RecurrenceRule.prototype.nextInvocationDate = function(base) {
     break;
   }
 
-  return next;
+  return next ? next.toDate() : null;
 };
 
 function recurMatch(val, matcher) {
@@ -407,8 +472,10 @@ function recurMatch(val, matcher) {
     return true;
   }
 
-  if (typeof matcher === 'number' || typeof matcher === 'string') {
+  if (typeof matcher === 'number') {
     return (val === matcher);
+  } else if(typeof matcher === 'string') {
+    return (val === Number(matcher));
   } else if (matcher instanceof Range) {
     return matcher.contains(val);
   } else if (Array.isArray(matcher) || (matcher instanceof Array)) {
@@ -426,13 +493,8 @@ function recurMatch(val, matcher) {
 function runOnDate(date, job) {
   var now = (new Date()).getTime();
   var then = date.getTime();
-
-  if (then < now) {
-    setImmediate(job);
-    return null;
-  }
-
-  return lt.setTimeout(job, (then - now));
+  
+  return lt.setTimeout(job, (then < now ? 0 : then - now));
 }
 
 var invocations = [];
@@ -441,7 +503,8 @@ var currentInvocation = null;
 function scheduleInvocation(invocation) {
   sorted.add(invocations, invocation, sorter);
   prepareNextInvocation();
-  invocation.job.emit('scheduled', invocation.fireDate);
+  var date = invocation.fireDate instanceof CronDate ? invocation.fireDate.toDate() : invocation.fireDate;
+  invocation.job.emit('scheduled', date);
 }
 
 function prepareNextInvocation() {
@@ -504,14 +567,14 @@ function cancelInvocation(invocation) {
 /* Recurrence scheduler */
 function scheduleNextRecurrence(rule, job, prevDate, endDate) {
 
-  prevDate = (prevDate instanceof Date) ? prevDate : (new Date());
+  prevDate = (prevDate instanceof CronDate) ? prevDate : new CronDate();
 
   var date = (rule instanceof RecurrenceRule) ? rule.nextInvocationDate(prevDate) : rule.next();
   if (date === null) {
     return null;
   }
 
-  if ((endDate instanceof Date) && date.getTime() > endDate.getTime()) {
+  if ((endDate instanceof CronDate) && date.getTime() > endDate.getTime()) {
     return null;
   }
 
@@ -522,8 +585,6 @@ function scheduleNextRecurrence(rule, job, prevDate, endDate) {
 }
 
 /* Convenience methods */
-var scheduledJobs = {};
-
 function scheduleJob() {
   if (arguments.length < 2) {
     return null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-schedule",
-  "version": "1.2.1",
+  "version": "1.2.5",
   "description": "A cron-like and not-cron-like job scheduler for Node.",
   "keywords": [
     "schedule",
@@ -12,7 +12,7 @@
   "main": "./lib/schedule.js",
   "scripts": {
     "test": "nodeunit",
-    "lint": "eslint lib"
+    "lint": "eslint lib test"
   },
   "author": {
     "name": "Matt Patenaude",
@@ -24,13 +24,13 @@
     "url": "https://github.com/node-schedule/node-schedule.git"
   },
   "dependencies": {
-    "cron-parser": "1.1.0",
+    "cron-parser": "^2.4.0",
     "long-timeout": "0.1.1",
     "sorted-array-functions": "^1.0.0"
   },
   "devDependencies": {
     "coveralls": "^2.11.2",
-    "eslint": "^0.15.1",
+    "eslint": "^3.19.0",
     "istanbul": "^0.4.5",
     "nodeunit": "^0.10.2",
     "sinon": "^1.14.1"