date-format 0.0.1 → 1.2.0

package/.eslintrc

@@ -0,0 +1,24 @@
+{
+  "env": {
+    "node": true,
+    "mocha": true
+  },
+  "plugins": [
+      "mocha",
+      "import"
+  ],
+  "rules": {
+    "comma-dangle": 0,
+    "indent": 2,
+    "func-names": 0,
+    "max-len": [1, 120, 2],
+    "no-use-before-define": 1,
+    "no-param-reassign": 0,
+    "strict": 0,
+    "import/no-extraneous-dependencies": ["error", {"devDependencies": ["test/*.js"]}],
+    "mocha/no-exclusive-tests": "error"
+  },
+  "parserOptions": {
+    "ecmaVersion": 5
+  }
+}

package/.travis.yml

@@ -0,0 +1,7 @@
+language: node_js
+sudo: false
+node_js:
+  - "7"
+  - "6"
+  - "5"
+  - "4"

package/README.md

@@ -3,31 +3,38 @@ date-format
 
 node.js formatting of Date objects as strings. Probably exactly the same as some other library out there.
 
-        npm install date-format
+```sh
+npm install date-format
+```
 
 usage
 =====
 
-        var format = require('date-format');
-        format.asString(new Date()); //defaults to ISO8601 format
-        format.asString('hh:mm:ss.SSS', new Date()); //just the time
+```js
+var format = require('date-format');
+format.asString(); //defaults to ISO8601 format and current date.
+format.asString(new Date()); //defaults to ISO8601 format
+format.asString('hh:mm:ss.SSS', new Date()); //just the time
+```
 
 or
 
-        var format = require('date-format');
-        format(new Date());
-        format('hh:mm:ss.SSS', new Date());
-
+```js
+var format = require('date-format');
+format(); //defaults to ISO8601 format and current date.
+format(new Date());
+format('hh:mm:ss.SSS', new Date());
+```
 
 Format string can be anything, but the following letters will be replaced (and leading zeroes added if necessary):
-* dd - date.getDate()
-* MM - date.getMonth() + 1
-* yy - date.getFullYear().toString().substring(2, 4)
-* yyyy - date.getFullYear()
-* hh - date.getHours()
-* mm - date.getMinutes()
-* ss - date.getSeconds()
-* SSS - date.getMilliseconds()
+* dd - `date.getDate()`
+* MM - `date.getMonth() + 1`
+* yy - `date.getFullYear().toString().substring(2, 4)`
+* yyyy - `date.getFullYear()`
+* hh - `date.getHours()`
+* mm - `date.getMinutes()`
+* ss - `date.getSeconds()`
+* SSS - `date.getMilliseconds()`
 * O - timezone offset in +hm format
 
 That's it.

package/lib/index.js

@@ -1,62 +1,63 @@
-"use strict";
-
-module.exports = asString
-asString.asString = asString
-
-asString.ISO8601_FORMAT = "yyyy-MM-dd hh:mm:ss.SSS";
-asString.ISO8601_WITH_TZ_OFFSET_FORMAT = "yyyy-MM-ddThh:mm:ssO";
-asString.DATETIME_FORMAT = "dd MM yyyy hh:mm:ss.SSS";
-asString.ABSOLUTETIME_FORMAT = "hh:mm:ss.SSS";
+'use strict';
 
 function padWithZeros(vNumber, width) {
-  var numAsString = vNumber + "";
-  while (numAsString.length < width) {
-    numAsString = "0" + numAsString;
-  }
-  return numAsString;
+    var numAsString = vNumber.toString();
+    while (numAsString.length < width) {
+        numAsString = '0' + numAsString;
+    }
+    return numAsString;
 }
-  
+
 function addZero(vNumber) {
-  return padWithZeros(vNumber, 2);
+    return padWithZeros(vNumber, 2);
 }
 
 /**
- * Formats the TimeOffest
+ * Formats the TimeOffset
  * Thanks to http://www.svendtofte.com/code/date_format/
  * @private
  */
-function offset(date) {
+function offset(timezoneOffset) {
   // Difference to Greenwich time (GMT) in hours
-  var os = Math.abs(date.getTimezoneOffset());
-  var h = String(Math.floor(os/60));
-  var m = String(os%60);
-  if (h.length == 1) {
-    h = "0" + h;
-  }
-  if (m.length == 1) {
-    m = "0" + m;
-  }
-  return date.getTimezoneOffset() < 0 ? "+"+h+m : "-"+h+m;
+    var os = Math.abs(timezoneOffset);
+    var h = String(Math.floor(os / 60));
+    var m = String(os % 60);
+    if (h.length === 1) {
+        h = '0' + h;
+    }
+    if (m.length === 1) {
+        m = '0' + m;
+    }
+    return timezoneOffset < 0 ? '+' + h + m : '-' + h + m;
 }
 
-function asString(/*format,*/ date) {
-  var format = asString.ISO8601_FORMAT;
-  if (typeof(date) === "string") {
-    format = arguments[0];
-    date = arguments[1];
-  }
+function asString(format, date, timezoneOffset) {
+    if (typeof format !== 'string') {
+        timezoneOffset = date;
+        date = format;
+        format = module.exports.ISO8601_FORMAT;
+    }
+    if (!date) {
+        date = new Date();
+    }
+  // make the date independent of the system timezone by working with UTC
+    if (timezoneOffset === undefined) {
+        timezoneOffset = date.getTimezoneOffset();
+    }
 
-  var vDay = addZero(date.getDate());
-  var vMonth = addZero(date.getMonth()+1);
-  var vYearLong = addZero(date.getFullYear());
-  var vYearShort = addZero(date.getFullYear().toString().substring(2,4));
-  var vYear = (format.indexOf("yyyy") > -1 ? vYearLong : vYearShort);
-  var vHour  = addZero(date.getHours());
-  var vMinute = addZero(date.getMinutes());
-  var vSecond = addZero(date.getSeconds());
-  var vMillisecond = padWithZeros(date.getMilliseconds(), 3);
-  var vTimeZone = offset(date);
-  var formatted = format
+    date.setUTCMinutes(date.getUTCMinutes() - timezoneOffset);
+    var vDay = addZero(date.getUTCDate());
+    var vMonth = addZero(date.getUTCMonth() + 1);
+    var vYearLong = addZero(date.getUTCFullYear());
+    var vYearShort = addZero(date.getUTCFullYear().toString().substring(2, 4));
+    var vYear = (format.indexOf('yyyy') > -1 ? vYearLong : vYearShort);
+    var vHour = addZero(date.getUTCHours());
+    var vMinute = addZero(date.getUTCMinutes());
+    var vSecond = addZero(date.getUTCSeconds());
+    var vMillisecond = padWithZeros(date.getUTCMilliseconds(), 3);
+    var vTimeZone = offset(timezoneOffset);
+    date.setUTCMinutes(date.getUTCMinutes() + timezoneOffset);
+    var formatted = format
     .replace(/dd/g, vDay)
     .replace(/MM/g, vMonth)
     .replace(/y{1,4}/g, vYear)
@@ -65,6 +66,12 @@ function asString(/*format,*/ date) {
     .replace(/ss/g, vSecond)
     .replace(/SSS/g, vMillisecond)
     .replace(/O/g, vTimeZone);
-  return formatted;
+    return formatted;
+}
 
-};
+module.exports = asString;
+module.exports.asString = asString;
+module.exports.ISO8601_FORMAT = 'yyyy-MM-ddThh:mm:ss.SSS';
+module.exports.ISO8601_WITH_TZ_OFFSET_FORMAT = 'yyyy-MM-ddThh:mm:ss.SSSO';
+module.exports.DATETIME_FORMAT = 'dd MM yyyy hh:mm:ss.SSS';
+module.exports.ABSOLUTETIME_FORMAT = 'hh:mm:ss.SSS';

package/package.json

@@ -1,26 +1,34 @@
 {
   "name": "date-format",
-  "version": "0.0.1",
-  "description": "formatting Date objects as strings since 2013",
+  "version": "1.2.0",
+  "description": "Formatting Date objects as strings since 2013",
   "main": "lib/index.js",
-  "scripts": {
-    "test": "mocha"
-  },
   "repository": {
     "type": "git",
     "url": "https://github.com/nomiddlename/date-format.git"
   },
+  "engines": {
+    "node": ">=4.0"
+  },
+  "scripts": {
+    "lint": "eslint lib/* test/*",
+    "pretest": "eslint lib/* test/*",
+    "test": "mocha"
+  },
   "keywords": [
     "date",
     "format",
     "string"
   ],
-  "author": "Gareth Jones <gareth.jones@sensis.com.au>",
+  "author": "Gareth Jones <gareth.nomiddlename@gmail.com>",
   "license": "MIT",
   "readmeFilename": "README.md",
   "gitHead": "bf59015ab6c9e86454b179374f29debbdb403522",
   "devDependencies": {
-    "should": "~1.2.2",
-    "mocha": "~1.12.0"
+    "eslint": "^3.12.0",
+    "eslint-plugin-import": "^2.2.0",
+    "eslint-plugin-mocha": "^4.8.0",
+    "mocha": "^3.2.0",
+    "should": "^11.1.2"
   }
 }

package/test/date_format-test.js

@@ -1,42 +1,63 @@
-"use strict";
-var should = require('should')
-, dateFormat = require('../lib');
+'use strict';
+
+require('should');
+
+var dateFormat = require('../lib');
+
+function createFixedDate() {
+    return new Date(2010, 0, 11, 14, 31, 30, 5);
+}
 
 describe('date_format', function() {
-  var date = new Date(2010, 0, 11, 14, 31, 30, 5);
-
-  it('should format a date as string using a pattern', function() {
-    dateFormat.asString(dateFormat.DATETIME_FORMAT, date).should.eql("11 01 2010 14:31:30.005");
-  });
-
-  it('should default to the ISO8601 format', function() {
-    dateFormat.asString(date).should.eql('2010-01-11 14:31:30.005');
-  });
-
-  it('should provide a ISO8601 with timezone offset format', function() {
-    date.getTimezoneOffset = function() { return -660; };
-    dateFormat.asString(
-      dateFormat.ISO8601_WITH_TZ_OFFSET_FORMAT, 
-      date
-    ).should.eql(
-      "2010-01-11T14:31:30+1100"
-    );
-
-    date.getTimezoneOffset = function() { return 120; };
-    dateFormat.asString(
-      dateFormat.ISO8601_WITH_TZ_OFFSET_FORMAT, 
-      date
-    ).should.eql(
-      "2010-01-11T14:31:30-0200"
-    );
-  });
-
-  it('should provide a just-the-time format', function() {
-    dateFormat.asString(dateFormat.ABSOLUTETIME_FORMAT, date).should.eql('14:31:30.005');
-  });
-
-  it('should provide a custom format', function() {
-    date.getTimezoneOffset = function() { return 120; };
-    dateFormat.asString("O.SSS.ss.mm.hh.dd.MM.yy", date).should.eql('-0200.005.30.31.14.11.01.10');
-  });
+    var date = createFixedDate();
+
+    it('should default to now when a date is not provided', function() {
+        dateFormat.asString(dateFormat.DATETIME_FORMAT).should.not.be.empty();
+    });
+
+    it('should be usable directly without calling asString', function() {
+        dateFormat(dateFormat.DATETIME_FORMAT, date).should.eql('11 01 2010 14:31:30.005');
+    });
+
+    it('should format a date as string using a pattern', function() {
+        dateFormat.asString(dateFormat.DATETIME_FORMAT, date).should.eql('11 01 2010 14:31:30.005');
+    });
+
+    it('should default to the ISO8601 format', function() {
+        dateFormat.asString(date).should.eql('2010-01-11T14:31:30.005');
+    });
+
+    it('should provide a ISO8601 with timezone offset format', function() {
+        var tzDate = createFixedDate();
+        tzDate.setMinutes(tzDate.getMinutes() - tzDate.getTimezoneOffset() - 660);
+        tzDate.getTimezoneOffset = function () {
+            return -660;
+        };
+
+        dateFormat.asString(dateFormat.ISO8601_WITH_TZ_OFFSET_FORMAT, tzDate)
+          .should.eql('2010-01-11T14:31:30.005+1100');
+
+        tzDate = createFixedDate();
+        tzDate.setMinutes((tzDate.getMinutes() - tzDate.getTimezoneOffset()) + 120);
+        tzDate.getTimezoneOffset = function () {
+            return 120;
+        };
+
+        dateFormat.asString(dateFormat.ISO8601_WITH_TZ_OFFSET_FORMAT, tzDate)
+          .should.eql('2010-01-11T14:31:30.005-0200');
+    });
+
+    it('should provide a just-the-time format', function() {
+        dateFormat.asString(dateFormat.ABSOLUTETIME_FORMAT, date).should.eql('14:31:30.005');
+    });
+
+    it('should provide a custom format', function() {
+        var customDate = createFixedDate();
+        customDate.setMinutes((customDate.getMinutes() - customDate.getTimezoneOffset()) + 120);
+        customDate.getTimezoneOffset = function () {
+            return 120;
+        };
+
+        dateFormat.asString('O.SSS.ss.mm.hh.dd.MM.yy', customDate).should.eql('-0200.005.30.31.14.11.01.10');
+    });
 });