CSV File Validator

Author: shystruk

.gitignore

@@ -0,0 +1,4 @@
+.idea
+.nyc_output
+node_modules
+coverage

.travis.yml

@@ -0,0 +1,17 @@
+language: node_js
+
+node_js:
+  - stable
+
+branches:
+  only:
+    - master
+
+install:
+  - npm install
+
+script:
+  - npm run test
+
+after_success:
+  - npm run report-coverage

package.json

@@ -0,0 +1,39 @@
+{
+  "name": "csv-file-validator",
+  "version": "1.0.0",
+  "description": "Validation of CSV file against user defined schema (returns back object with data and invalid messages)",
+  "main": "./src/csv-file-validator.js",
+  "repository": "https://github.com/shystruk/csv-file-validator.git",
+  "directories": {
+    "src": "src"
+  },
+  "scripts": {
+    "report-coverage": "cat ./coverage/lcov.info | codecov",
+    "coverage": "nyc report --reporter=lcov",
+    "test": "nyc ava --browser && npm run coverage"
+  },
+  "keywords": [
+    "csv parser",
+    "parser",
+    "validator",
+    "csv validator",
+    "csv file validator",
+    "reviewer",
+    "csv reviewer"
+  ],
+  "author": {
+    "name": "Vasyl Stokolosa",
+    "email": "[email protected]",
+    "url": "https://github.com/shystruk"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "lodash": "^4.17.5",
+    "papaparse": "^4.3.7"
+  },
+  "devDependencies": {
+    "ava": "^0.25.0",
+    "codecov.io": "^0.1.6",
+    "nyc": "^11.4.1"
+  }
+}

src/csv-file-validator.js

@@ -0,0 +1,102 @@
+(function (global, factory) {
+    typeof exports === 'object' && typeof module !== 'undefined'
+        ? module.exports = factory(require('papaparse'), require('lodash/uniqBy'), require('lodash/isFunction'))
+        : typeof define === 'function' && define.amd 
+            ? define(['papaparse', 'lodash/uniqBy', 'lodash/isFunction'], factory)
+            : (global.myBundle = factory(global.Papa,global._uniqBy,global._isFunction));
+}(this, (function (Papa,_uniqBy,_isFunction) {
+    'use strict';
+
+    Papa = Papa && Papa.hasOwnProperty('default') ? Papa['default'] : Papa;
+    _uniqBy = _uniqBy && _uniqBy.hasOwnProperty('default') ? _uniqBy['default'] : _uniqBy;
+    _isFunction = _isFunction && _isFunction.hasOwnProperty('default') ? _isFunction['default'] : _isFunction;
+
+    /**
+     * @param {File} csvFile 
+     * @param {Object} config 
+     */
+    function CSVFileValidate (csvFile, config) {
+        return new Promise((resolve, reject) => {
+            Papa.parse(csvFile, {
+                complete: function(results) {
+                    resolve(_prepareDataAndValidateFile(results.data, config));
+                },
+                error: function(error, file) {
+                    reject({error, file});
+                }
+            });
+        })
+    }
+
+    /**
+     * @param {Array} csvData 
+     * @param {Object} config 
+     * @private
+     */
+    function _prepareDataAndValidateFile(csvData, config) {
+        const file = {
+            inValidMessages: [],
+            data: []
+        };
+
+        csvData.splice(0,1); // skip first row as a header
+        csvData.forEach((row, rowIndex) => {
+            const columnData = {};
+
+            row.forEach((columnValue, columnIndex) => {
+                const valueConfig = config.headers[columnIndex];
+
+                if (!valueConfig) {
+                    return;
+                }
+
+                if (valueConfig.required && !columnValue.length) {
+                    file.inValidMessages.push(
+                        _isFunction(valueConfig.requiredError)
+                            ? valueConfig.requiredError(rowIndex + 2, columnIndex + 1)
+                            : valueConfig.requiredError
+                    );
+                } else if (valueConfig.validate && !valueConfig.validate(columnValue)) {
+                    file.inValidMessages.push(
+                        _isFunction(valueConfig.validateError)
+                            ? valueConfig.validateError(rowIndex + 2, columnIndex + 1)
+                            : valueConfig.validateError
+                    );
+                }
+
+                if (valueConfig.isArray) {
+                    columnData[valueConfig.inputName] = columnValue.split(',').map(value => value.trim());
+                } else {
+                    columnData[valueConfig.inputName] = columnValue;
+                }
+            });
+
+            file.data.push(columnData);
+        });
+
+        _checkUniqueFields(file, config);
+
+        return file;
+    }
+
+    /**
+     * @param {Object} file 
+     * @param {Object} config
+     * @private 
+     */
+    function _checkUniqueFields(file, config) {
+        if (!file.data.length) {
+            return;
+        }
+
+        config.headers
+            .filter(header => header.unique)
+            .forEach(header => {
+                if (_uniqBy(file.data, header.inputName).length !== file.data.length) {
+                    file.inValidMessages.push(header.uniqueErrorMessage);
+                }
+            });
+    };
+
+    return CSVFileValidate;
+})));

test.js

@@ -0,0 +1,6 @@
+import test from 'ava';
+import CSVFileValidate from './src/csv-file-validator';
+
+test('module should be a function', t => {
+    t.is(typeof CSVFileValidate, 'function');
+});