Merge pull request #6 from keybase/master

Adding boolish support

Author: ctavan

README.md

@@ -78,7 +78,11 @@ Return as float number.
 
 ### env.bool(name, [fallback])
 
-Return as boolean.
+Return as boolean. Only allows true/false as valid values.
+
+### env.boolish(name, [fallback])
+
+Return as boolean. Allows true/false/1/0 as valid values.
 
 ### env.array(name, [type], [fallback])
 
@@ -120,6 +124,9 @@ if (process.env.NODE_ENV === 'production') {
 
 ## Changelog
 
+### v0.5.1
+- Added getenv.boolish() support.
+
 ### v0.5.0
 - Add getenv.url() support.
 

lib/getenv.js

@@ -11,7 +11,7 @@ function _value(varName, fallback) {
                       'and no fallback value provided.');
     }
     if (fallbacksDisabled) {
-      throw new Error('GetEnv.DisabledFallbacks: ' + varName + ' relying on fallback ' + 
+      throw new Error('GetEnv.DisabledFallbacks: ' + varName + ' relying on fallback ' +
                       'when fallbacks have been disabled');
     }
     return '' + fallback;
@@ -50,7 +50,20 @@ var convert = {
       throw new Error('GetEnv.NoBoolean: ' + value + ' is not a boolean.');
     }
 
-    return (value === 'true');
+    return (value === 'true')
+  },
+  boolish: function(value) {
+    try {
+      return convert.bool(value)
+    }
+    catch(err) {
+      var isBool = (value === '1' || value === '0');
+      if (!isBool) {
+        throw new Error('GetEnv.NoBoolean: ' + value + ' is not a boolean.');
+      }
+
+      return (value === '1');
+    }
   },
   url: url.parse
 };

package.json

@@ -8,7 +8,7 @@
     "Jan Lehnardt",
     "Tim Ruffles <[email protected]>"
   ],
-  "version": "0.5.0",
+  "version": "0.5.1",
   "homepage": "https://github.com/ctavan/node-getenv",
   "repository": {
     "type": "git",

test/getenv.js

@@ -221,6 +221,41 @@ tests['getenv.bool() invalid input'] = function() {
   });
 };
 
+tests['getenv.boolish() valid input'] = function() {
+  var data = [{
+    varName: 'TEST_GETENV_FALSE',
+    expected: false
+  }, {
+    varName: 'TEST_GETENV_TRUE',
+    expected: true
+  }, {
+    varName: 'TEST_GETENV_NOT_REALLY_FALSE',
+    expected: false
+  }, {
+    varName: 'TEST_GETENV_NOT_REALLY_TRUE',
+    expected: true
+  }];
+
+  data.forEach(function(item) {
+    var boolVar = getenv.boolish(item.varName);
+    assert.strictEqual(boolVar, item.expected);
+  });
+};
+
+
+tests['getenv.boolish() invalid input'] = function() {
+  var data = [
+    { varName: 'TEST_GETENV_STRING' },
+    { varName: 'TEST_GETENV_EMPTY_STRING' }
+  ];
+
+  data.forEach(function(item) {
+    assert.throws(function() {
+      var boolVar = getenv.boolish(item.varName);
+    });
+  });
+};
+
 
 tests['getenv.bool() nonexistent variable'] = function() {
   assert.throws(function() {