Wip: migtrate to ES6 and flow

.flowconfig

@@ -0,0 +1,13 @@
+[ignore]
+<PROJECT_ROOT>/node_modules/es-abstract/.*
+<PROJECT_ROOT>/node_modules/has/.*
+
+[include]
+
+[libs]
+
+[lints]
+
+[options]
+
+[strict]

package.json

@@ -11,7 +11,9 @@
     "lint": "eslint src test",
     "test": "tape test"
   },
-  "dependencies": {},
+  "dependencies": {
+    "flow-bin": "^0.62.0"
+  },
   "devDependencies": {
     "eslint": "^4.4.1",
     "eslint-config-uber-es5": "^2.0.3",

src/analyzer.js

@@ -1,3 +1,4 @@
+// @flow
 // Copyright (c) 2017 Uber Technologies, Inc.
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -20,19 +21,22 @@
 
 'use strict';
 
-var CONSTANT = require('./constant');
-var VALIDATOR_MAP = require('./validator-map');
-var Utils = require('./utils');
+import CONSTANT from './constant';
+import VALIDATOR_MAP from './validator-map';
+import {
+  findFirstNonNullValue,
+  detectTimeFormat
+} from './utils';
 
-var NUMBER_OF_ALLOWED_HITS = 3;
+const NUMBER_OF_ALLOWED_HITS = 3;
 
-var Analyzer = {};
+const Analyzer = {};
 
-Analyzer._category = function _category(colType) {
+function _category(colType) {
   return CONSTANT.TYPES_TO_CATEGORIES[colType] || CONSTANT.CATEGORIES.DIMENSION;
-};
+}
 
-var VALIDATOR_CONSIDERS_EMPTY_STRING_NULL = {
+const VALIDATOR_CONSIDERS_EMPTY_STRING_NULL = {
   PAIR_GEOMETRY_FROM_STRING: true,
   GEOMETRY_FROM_STRING: true,
   NUMBER: true
@@ -59,14 +63,14 @@ function valueIsNullForValidator(value, validatorName) {
 function buildValidatorFinder(data, columnName) {
   return function findTypeFromValidators(validatorName) {
     // you get three strikes until we dont think you are this type
-    var nonNullData = data.filter(function iterator(row) {
-      var value = row[columnName];
+    const nonNullData = data.filter(function iterator(row) {
+      const value = row[columnName];
       return !valueIsNullForValidator(value, validatorName);
     });
-    var strikes = Math.min(NUMBER_OF_ALLOWED_HITS, nonNullData.length);
-    var hits = 0;
+    const strikes = Math.min(NUMBER_OF_ALLOWED_HITS, nonNullData.length);
+    const hits = 0;
     nonNullData.some(function iterateAcrossData(row) {
-      var value = row[columnName];
+      const value = row[columnName];
       if (Boolean(VALIDATOR_MAP[validatorName](value)) === false) {
         strikes -= 1;
       } else {
@@ -102,36 +106,36 @@ function getTypeFromRules(analyzerRules, columnName) {
 * @param {Object} analyzerRules - regexs describing column overrides
 * @return {Object} column metadata
 **/
-Analyzer.computeColMeta = function computeColMeta(data, analyzerRules) {
+function computeColMeta(data: Object[], analyzerRules) {
   if (!data || Object.keys(data).length === 0) {
     return [];
   }
-  var _columns = Object.keys(data[0]);
+  const _columns = Object.keys(data[0]);
   /* eslint-disable max-statements */
   return _columns.reduce(function iterator(res, columnName) {
-    var format = '';
+    let format = '';
     // First try to get the column from the rules
-    var type = getTypeFromRules(analyzerRules, columnName);
+    let type = getTypeFromRules(analyzerRules, columnName);
     // If it's not there then try to infer the type
     if (!type) {
       type = CONSTANT.VALIDATORS.find(buildValidatorFinder(data, columnName));
     }
     // if theres still no type, dump this column
-    var category = Analyzer._category(type);
+    const category = _category(type);
     if (!type) {
       return res;
     }
     // if its a time, detect and record the time
     if (type && CONSTANT.TIME_VALIDATORS.indexOf(type) !== -1) {
       // Find the first non-null value.
-      var sample = Utils.findFirstNonNullValue(data, columnName);
+      const sample = findFirstNonNullValue(data, columnName);
       if (sample === null) {
         return res;
       }
-      format = Utils.detectTimeFormat(sample, type);
+      format = detectTimeFormat(sample, type);
     }
 
-    var colMeta = {
+    const colMeta = {
       key: columnName,
       label: columnName,
       type: type,
@@ -140,14 +144,14 @@ Analyzer.computeColMeta = function computeColMeta(data, analyzerRules) {
     };
 
     if (type === CONSTANT.DATA_TYPES.GEOMETRY) {
-      var geoSample = Utils.findFirstNonNullValue(data, columnName);
+      const geoSample = findFirstNonNullValue(data, columnName);
       if (geoSample === null) {
         return res;
       }
       colMeta.geoType = geoSample.type.toUpperCase();
     }
     if (type === CONSTANT.DATA_TYPES.GEOMETRY_FROM_STRING) {
-      var geoStringSample = Utils.findFirstNonNullValue(data, columnName);
+      const geoStringSample = findFirstNonNullValue(data, columnName);
       if (geoStringSample === null) {
         return res;
       }
@@ -161,5 +165,3 @@ Analyzer.computeColMeta = function computeColMeta(data, analyzerRules) {
   }, []);
 };
 /* eslint-enable max-statements */
-
-module.exports = Analyzer;

src/constant.js

@@ -1,3 +1,4 @@
+// @flow
 // Copyright (c) 2017 Uber Technologies, Inc.
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -18,83 +19,79 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 // THE SOFTWARE.
 
-'use strict';
-
-var CONSTANT = {
-  DATA_TYPES: {
-    // date time formats
-    DATE: 'DATE',
-    TIME: 'TIME',
-    DATETIME: 'DATETIME',
-
-    // number formats
-    NUMBER: 'NUMBER',
-    INT: 'INT',
-    FLOAT: 'FLOAT',
-    CURRENCY: 'CURRENCY',
-    PERCENT: 'PERCENT',
-
-    // string types:
-    STRING: 'STRING',
-    CITY: 'CITY',
-    ZIPCODE: 'ZIPCODE',
-
-    // boolean type
-    BOOLEAN: 'BOOLEAN',
-
-    // geometry
-    GEOMETRY: 'GEOMETRY',
-    GEOMETRY_FROM_STRING: 'GEOMETRY_FROM_STRING',
-    PAIR_GEOMETRY_FROM_STRING: 'PAIR_GEOMETRY_FROM_STRING',
-
-    NONE: 'NONE'
-  },
-
-  CATEGORIES: {
-    GEOMETRY: 'GEOMETRY',
-    TIME: 'TIME',
-    DIMENSION: 'DIMENSION',
-    MEASURE: 'MEASURE'
-  },
-
-  BOOLEAN_TRUE_VALUES: ['true', 'yes', '1'],
-  BOOLEAN_FALSE_VALUES: ['false', 'no', '0'],
-
-  NULL: 'NULL'
-};
+export const DATA_TYPES = {
+  // date time formats
+  DATE: 'DATE',
+  TIME: 'TIME',
+  DATETIME: 'DATETIME',
 
-CONSTANT.POSSIBLE_TYPES = {};
+  // number formats
+  NUMBER: 'NUMBER',
+  INT: 'INT',
+  FLOAT: 'FLOAT',
+  CURRENCY: 'CURRENCY',
+  PERCENT: 'PERCENT',
 
-CONSTANT.POSSIBLE_TYPES[CONSTANT.CATEGORIES.GEOMETRY] = [
-  CONSTANT.DATA_TYPES.GEOMETRY_FROM_STRING,
-  CONSTANT.DATA_TYPES.PAIR_GEOMETRY_FROM_STRING,
-  CONSTANT.DATA_TYPES.GEOMETRY
-];
+  // string types:
+  STRING: 'STRING',
+  CITY: 'CITY',
+  ZIPCODE: 'ZIPCODE',
 
-CONSTANT.POSSIBLE_TYPES[CONSTANT.CATEGORIES.TIME] = [
-  CONSTANT.DATA_TYPES.DATETIME,
-  CONSTANT.DATA_TYPES.DATE,
-  CONSTANT.DATA_TYPES.TIME
-];
+  // boolean type
+  BOOLEAN: 'BOOLEAN',
 
-CONSTANT.POSSIBLE_TYPES[CONSTANT.CATEGORIES.DIMENSION] = [
-  CONSTANT.DATA_TYPES.STRING,
-  CONSTANT.DATA_TYPES.BOOLEAN,
-  CONSTANT.DATA_TYPES.CITY,
-  CONSTANT.DATA_TYPES.ZIPCODE
-];
+  // geometry
+  GEOMETRY: 'GEOMETRY',
+  GEOMETRY_FROM_STRING: 'GEOMETRY_FROM_STRING',
+  PAIR_GEOMETRY_FROM_STRING: 'PAIR_GEOMETRY_FROM_STRING',
 
-CONSTANT.POSSIBLE_TYPES[CONSTANT.CATEGORIES.MEASURE] = [
-  CONSTANT.DATA_TYPES.NUMBER,
-  CONSTANT.DATA_TYPES.INT,
-  CONSTANT.DATA_TYPES.FLOAT,
-  CONSTANT.DATA_TYPES.CURRENCY,
-  CONSTANT.DATA_TYPES.PERCENT
-];
+  NONE: 'NONE'
+};
+
+export const CATEGORIES: $ReadOnly<typeof CATEGORIES> = {
+  GEOMETRY: 'GEOMETRY',
+  TIME: 'TIME',
+  DIMENSION: 'DIMENSION',
+  MEASURE: 'MEASURE'
+};
 
-CONSTANT.TYPES_TO_CATEGORIES = Object.keys(CONSTANT.POSSIBLE_TYPES)
+export const BOOLEAN_TRUE_VALUES = ['true', 'yes', '1'];
+export const BOOLEAN_FALSE_VALUES = ['false', 'no', '0'];
+
+export const NULL = 'NULL';
+
+export const POSSIBLE_TYPES = {
+  [CATEGORIES.GEOMETRY]: [
+    DATA_TYPES.GEOMETRY_FROM_STRING,
+    DATA_TYPES.PAIR_GEOMETRY_FROM_STRING,
+    DATA_TYPES.GEOMETRY
+  ],
+
+  [CATEGORIES.TIME]: [
+    DATA_TYPES.DATETIME,
+    DATA_TYPES.DATE,
+    DATA_TYPES.TIME
+  ],
+
+  [CATEGORIES.DIMENSION]: [
+    DATA_TYPES.STRING,
+    DATA_TYPES.BOOLEAN,
+    DATA_TYPES.CITY,
+    DATA_TYPES.ZIPCODE
+  ],
+
+  [CATEGORIES.MEASURE]: [
+    DATA_TYPES.NUMBER,
+    DATA_TYPES.INT,
+    DATA_TYPES.FLOAT,
+    DATA_TYPES.CURRENCY,
+    DATA_TYPES.PERCENT
+  ]
+};
+
+export const TYPES_TO_CATEGORIES = Object.keys(POSSIBLE_TYPES)
   .reduce(function generateTypeToCategoryMap(res, category) {
-    CONSTANT.POSSIBLE_TYPES[category].forEach(function loopAcrossTypes(type) {
+    POSSIBLE_TYPES[category].forEach(function loopAcrossTypes(type) {
       res[type] = category;
     });
     return res;
@@ -105,39 +102,37 @@ CONSTANT.TYPES_TO_CATEGORIES = Object.keys(CONSTANT.POSSIBLE_TYPES)
 // here's trying to determine a more accuraet data type of the column.
 // later on, users still can override the data type.
 // this will affect how we trasnform(aggregation), formating the data.
-CONSTANT.VALIDATORS = [
+export const VALIDATORS = [
   // geometry
-  CONSTANT.DATA_TYPES.GEOMETRY,
-  CONSTANT.DATA_TYPES.GEOMETRY_FROM_STRING,
-  CONSTANT.DATA_TYPES.PAIR_GEOMETRY_FROM_STRING,
+  DATA_TYPES.GEOMETRY,
+  DATA_TYPES.GEOMETRY_FROM_STRING,
+  DATA_TYPES.PAIR_GEOMETRY_FROM_STRING,
 
   // true/false, 0/1
-  CONSTANT.DATA_TYPES.BOOLEAN,
+  DATA_TYPES.BOOLEAN,
 
   // prefix/postfix rules
-  CONSTANT.DATA_TYPES.CURRENCY,
-  CONSTANT.DATA_TYPES.PERCENT,
+  DATA_TYPES.CURRENCY,
+  DATA_TYPES.PERCENT,
 
   // times
-  CONSTANT.DATA_TYPES.DATETIME,
-  CONSTANT.DATA_TYPES.DATE,
-  CONSTANT.DATA_TYPES.TIME,
+  DATA_TYPES.DATETIME,
+  DATA_TYPES.DATE,
+  DATA_TYPES.TIME,
 
   // numbers
-  CONSTANT.DATA_TYPES.INT,
-  CONSTANT.DATA_TYPES.FLOAT,
-  CONSTANT.DATA_TYPES.NUMBER,
+  DATA_TYPES.INT,
+  DATA_TYPES.FLOAT,
+  DATA_TYPES.NUMBER,
 
   // strings
-  CONSTANT.DATA_TYPES.ZIPCODE,
-  CONSTANT.DATA_TYPES.CITY,
-  CONSTANT.DATA_TYPES.STRING
+  DATA_TYPES.ZIPCODE,
+  DATA_TYPES.CITY,
+  DATA_TYPES.STRING
 ];
 
-CONSTANT.TIME_VALIDATORS = [
-  CONSTANT.DATA_TYPES.DATETIME,
-  CONSTANT.DATA_TYPES.DATE,
-  CONSTANT.DATA_TYPES.TIME
+export const TIME_VALIDATORS = [
+  DATA_TYPES.DATETIME,
+  DATA_TYPES.DATE,
+  DATA_TYPES.TIME
 ];
-
-module.exports = CONSTANT;

src/regex-list.js

@@ -1,3 +1,4 @@
+// @flow
 // Copyright (c) 2017 Uber Technologies, Inc.
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -20,7 +21,7 @@
 
 'use strict';
 
-var RegexList = {
+export const RegexList = {
   // accepts: 10, 2.3, +4,000, -5,023.234, 2.3e+2, 4,234.56e-2, $23,203, 23.45%
   isNumber: /^(\+|\-)?\$?[\d,]*\.?\d+((e|E)(\+|\-)\d+)?%?$/,
 
@@ -54,5 +55,3 @@ var RegexList = {
   isPairwisePointGeometry:
     /(\+|\-)?\d*\.\d*,(\+|\-)?\d*\.\d*/
 };
-
-module.exports = RegexList;