Merge pull request #19 from sealsystems/master

Added separator parameter to array function

Author: ctavan

README.md

@@ -86,9 +86,9 @@ Return as boolean. Only allows true/false as valid values.
 
 Return as boolean. Allows true/false/1/0 as valid values.
 
-### env.array(name, [type], [fallback])
+### env.array(name, [type], [fallback], [separator])
 
-Split value of the environment variable at each comma and return the resulting array where each value has been typecast according to the `type` parameter. An array can be provided as `fallback`.
+Split value of the environment variable at each comma (default) and return the resulting array where each value has been typecast according to the `type` parameter. An array can be provided as `fallback` and a regular expression can be provided as `separator` in case commas don't fit.
 
 ### env.multi({spec})
 

index.js

@@ -1,4 +1,3 @@
-const util = require('util');
 const url = require('url');
 
 let fallbacksDisabled = false;
@@ -95,20 +94,21 @@ Object.keys(convert).forEach(function(type) {
   getenv[type] = converter(type);
 });
 
-getenv.array = function array(varName, type, fallback) {
+getenv.array = function array(varName, type, fallback, separator) {
   type = type || 'string';
+  separator = separator || /\s*,\s*/;
   if (Object.keys(convert).indexOf(type) === -1) {
     throw new Error('GetEnv.ArrayUndefinedType: Unknown array type ' + type);
   }
   const value = _value(varName, fallback);
-  return value.split(/\s*,\s*/).map(convert[type]);
+  return value.split(separator).map(convert[type]);
 };
 
 getenv.multi = function multi(spec) {
   const result = {};
   for (let key in spec) {
     const value = spec[key];
-    if (util.isArray(value)) {
+    if (Array.isArray(value)) {
       // default value & typecast
       switch (value.length) {
         case 1: // no default value

test/getenv.js

@@ -22,15 +22,19 @@ process.env.TEST_GETENV_STRING_ARRAY2 = 'one, two ,three , four';
 process.env.TEST_GETENV_STRING_ARRAY3 = 'one, two,';
 process.env.TEST_GETENV_STRING_ARRAY4 = ' ';
 process.env.TEST_GETENV_STRING_ARRAY5 = 'one;two:three,four';
+process.env.TEST_GETENV_STRING_ARRAY6 = 'one two ';
 process.env.TEST_GETENV_INT_ARRAY = '1,2, 3';
+process.env.TEST_GETENV_INT_ARRAY2 = '1  2 3';
 process.env.TEST_GETENV_INT_ARRAY_INVALID1 = '1, 2.2, 3';
 process.env.TEST_GETENV_INT_ARRAY_INVALID2 = '1, true, 3';
 process.env.TEST_GETENV_INT_ARRAY_INVALID3 = '1, abc, 3';
 process.env.TEST_GETENV_FLOAT_ARRAY = '1.9,2, 3e5';
+process.env.TEST_GETENV_FLOAT_ARRAY2 = '1.9 2  3e5';
 process.env.TEST_GETENV_FLOAT_ARRAY_INVALID1 = '1.9,true, 3e5';
 process.env.TEST_GETENV_FLOAT_ARRAY_INVALID2 = '1.9, abc, 3e5';
 process.env.TEST_GETENV_FLOAT_ARRAY_INVALID3 = '1.9, Infinity, 3e5';
 process.env.TEST_GETENV_BOOL_ARRAY = 'true, false, true';
+process.env.TEST_GETENV_BOOL_ARRAY2 = 'true false true';
 process.env.TEST_GETENV_BOOL_ARRAY_INVALID1 = 'true, 1, true';
 process.env.TEST_GETENV_BOOL_ARRAY_INVALID2 = 'true, 1.2, true';
 process.env.TEST_GETENV_BOOL_ARRAY_INVALID3 = 'true, abc, true';
@@ -303,7 +307,37 @@ tests['getenv.array() valid string (default) input'] = function() {
 
   data.forEach(function(item) {
     const arrayVar = getenv.array(item.varName);
-    assert.deepEqual(arrayVar, item.expected);
+    assert.deepStrictEqual(arrayVar, item.expected);
+  });
+};
+
+tests['getenv.array() valid inputs split by separator'] = function() {
+  const data = [
+    {
+      varName: 'TEST_GETENV_STRING_ARRAY6',
+      type: 'string',
+      expected: ['one', 'two', ''],
+    },
+    {
+      varName: 'TEST_GETENV_INT_ARRAY2',
+      type: 'int',
+      expected: [1, 2, 3],
+    },
+    {
+      varName: 'TEST_GETENV_FLOAT_ARRAY2',
+      type: 'float',
+      expected: [1.9, 2, 3e5],
+    },
+    {
+      varName: 'TEST_GETENV_BOOL_ARRAY2',
+      type: 'boolish',
+      expected: [true, false, true],
+    },
+  ];
+
+  data.forEach(function(item) {
+    const arrayVar = getenv.array(item.varName, item.type, [], /\s+/);
+    assert.deepStrictEqual(arrayVar, item.expected);
   });
 };
 
@@ -411,7 +445,7 @@ tests['getenv.array() nonexistent variable'] = function() {
 tests['getenv.array() nonexistent variable with fallback'] = function() {
   const expect = ['A', 'B', 'C'];
   const arrayVar = getenv.array('TEST_GETENV_NONEXISTENT', 'string', expect);
-  assert.deepEqual(arrayVar, expect);
+  assert.deepStrictEqual(arrayVar, expect);
 };
 
 tests['getenv.array() nonexistent type'] = function() {
@@ -428,7 +462,7 @@ tests['getenv.multi([string]) multiple env vars'] = function() {
   const expect = {
     foo: process.env.TEST_GETENV_STRING,
   };
-  assert.deepEqual(expect, config);
+  assert.deepStrictEqual(expect, config);
 };
 
 tests['getenv([string]) multiple env vars shortcut'] = function() {
@@ -439,7 +473,7 @@ tests['getenv([string]) multiple env vars shortcut'] = function() {
   const expect = {
     foo: process.env.TEST_GETENV_STRING,
   };
-  assert.deepEqual(expect, config);
+  assert.deepStrictEqual(expect, config);
 };
 
 tests['getenv.multi([string/throw]) multiple env vars'] = function() {
@@ -459,7 +493,7 @@ tests['getenv.multi([string/typecast]) multiple env vars'] = function() {
   const expect = {
     foo: process.env.TEST_GETENV_STRING,
   };
-  assert.deepEqual(expect, config);
+  assert.deepStrictEqual(expect, config);
 };
 
 tests['getenv.multi([string/typecast/defaultval]) multiple env vars'] = function() {
@@ -470,7 +504,7 @@ tests['getenv.multi([string/typecast/defaultval]) multiple env vars'] = function
   const expect = {
     foo: 'default',
   };
-  assert.deepEqual(expect, config);
+  assert.deepStrictEqual(expect, config);
 };
 
 tests['getenv.multi([string/typecast/throw]) multiple env vars'] = function() {
@@ -490,7 +524,7 @@ tests['getenv.multi([string/defaultval]) multiple env vars'] = function() {
   const expect = {
     foo: process.env.TEST_GETENV_STRING,
   };
-  assert.deepEqual(expect, config);
+  assert.deepStrictEqual(expect, config);
 };
 
 tests['getenv.multi([string/defaultval/throw]) multiple env vars'] = function() {
@@ -501,7 +535,7 @@ tests['getenv.multi([string/defaultval/throw]) multiple env vars'] = function()
   const expect = {
     foo: 'default',
   };
-  assert.deepEqual(expect, config);
+  assert.deepStrictEqual(expect, config);
 };
 
 tests['getenv.multi([string/single]) multiple env vars'] = function() {
@@ -512,7 +546,7 @@ tests['getenv.multi([string/single]) multiple env vars'] = function() {
   const expect = {
     foo: process.env.TEST_GETENV_STRING,
   };
-  assert.deepEqual(expect, config);
+  assert.deepStrictEqual(expect, config);
 };
 
 tests['getenv.multi([string/single/throw]) multiple env vars'] = function() {
@@ -539,7 +573,7 @@ tests['getenv.url() valid input'] = function() {
       h[key] = parsed[key];
       return h;
     }, {});
-    assert.deepEqual(actual, expectation);
+    assert.deepStrictEqual(actual, expectation);
   });
 };