Feat/onParseValue (evanplaice#131)

evanplaice · web-flow · commit 5dc5cde2ad4a · 2019-05-02T17:12:45.000-06:00
* Fix Implementation - previously onParseValue was being applied to the object headers.
* Add tests/fixtures
* Test using state to locate the correct value
diff --git a/src/jquery.csv.js b/src/jquery.csv.js
@@ -138,6 +138,9 @@ RegExp.escape = function (s) {
           if (options.onParseValue === undefined) {
             // onParseValue hook not set
             entry.push(value);
+          } else if (options.headers && options.state.rowNum === 1) {
+            // don't onParseValue object headers
+            entry.push(value);
           } else {
             var hook = options.onParseValue(value, options.state); // onParseValue Hook
             // false skips the row, configurable through a hook
@@ -801,7 +804,8 @@ RegExp.escape = function (s) {
         state: {
           rowNum: 1,
           colNum: 1
-        }
+        },
+        headers: true
       };
 
       // onPreParse hook
@@ -811,7 +815,7 @@ RegExp.escape = function (s) {
 
       // parse the csv
       var headerLine = $.csv.parsers.splitLines(csv, headerOptions);
-      var headers = $.csv.toArray(headerLine[0], options);
+      var headers = $.csv.toArray(headerLine[0], headerOptions);
 
       // fetch the data
       lines = $.csv.parsers.splitLines(csv, options);
diff --git a/test/csv.on_parse_value_hook.js b/test/csv.on_parse_value_hook.js
@@ -0,0 +1,58 @@
+const test = require('tape');
+const csv = require('../src/jquery.csv.js');
+const fixtures = require('./fixtures/fixtures.js');
+
+test('$.csv.toObjects onParseValue hook callback - should be passed the data and state', (t) => {
+  let passedData, passedState;
+
+  csv.toObjects(fixtures.objects_csv, { onParseValue: (data, state) => {
+    passedData = data;
+    passedState = state;
+    return data;
+  } });
+
+  t.isNot(passedData, null, 'data argument should not be null');
+  t.isNot(passedState, null, 'state argument should not be null');
+  t.end();
+});
+
+test('$.csv.toArrays onParseValue hook callback - should be passed the data and state', (t) => {
+  let passedData, passedState;
+
+  csv.toArrays(fixtures.arrays1_csv, { onParseValue: (data, state) => {
+    passedData = data;
+    passedState = state;
+    return data;
+  } });
+
+  t.isNot(passedData, null, 'data argument should not be null');
+  t.isNot(passedState, null, 'state argument should not be null');
+  t.end();
+});
+
+test('$.csv.toObjects onParseValue hook callback - should affect return value', (t) => {
+  const returnMutatedValues = (value) => value + 'a';
+  const result = csv.toObjects(fixtures.value_objects_csv, { onParseValue: returnMutatedValues });
+  t.deepEqual(result, fixtures.value_objects_obj, 'return value should reflect what was returned from callback');
+  t.end();
+});
+
+test('$.csv.toObjects onParseValue hook callback - should have correct state', (t) => {
+  const checkValueState = (value, state) => {
+    if (state.rowNum === 2, state.colNum === 3) {
+      t.equal(value, 'some');
+    }
+  };
+  csv.toObjects(fixtures.value_objects_csv, { onParseValue: checkValueState });
+  t.end();
+});
+
+test('$.csv.toArrays onParseValue hook callback - should have correct state', (t) => {
+  const checkValueState = (value, state) => {
+    if (state.rowNum === 1, state.colNum === 3) {
+      t.equal(value, 'some');
+    }
+  };
+  csv.toArrays(fixtures.value_arrays_csv, { onParseValue: checkValueState });
+  t.end();
+});
diff --git a/test/fixtures/fixtures.js b/test/fixtures/fixtures.js
@@ -64,8 +64,11 @@ var fs = require('fs');
     backslash_obj: jsonFixture('backslash'),
     objects_csv: csvFixture('objects'),
     objects_obj: jsonFixture('objects'),
-    objects2_csv: csvFixture('objects2')
-
+    objects2_csv: csvFixture('objects2'),
+    value_arrays_csv: csvFixture('value_arrays'),
+    value_arrays_obj: jsonFixture('value_arrays'),
+    value_objects_csv: csvFixture('value_objects'),
+    value_objects_obj: jsonFixture('value_objects')
   };
 
   // CommonJS module is defined
diff --git a/test/fixtures/value_arrays.csv b/test/fixtures/value_arrays.csv
@@ -0,0 +1 @@
+this,is,some,data
diff --git a/test/fixtures/value_arrays.json b/test/fixtures/value_arrays.json
@@ -0,0 +1,3 @@
+[
+  [ "thisa", "isa", "somea", "dataa" ]
+]
diff --git a/test/fixtures/value_objects.csv b/test/fixtures/value_objects.csv
@@ -0,0 +1,2 @@
+h1,h2,h3,h4
+this,is,some,data
diff --git a/test/fixtures/value_objects.json b/test/fixtures/value_objects.json
@@ -0,0 +1,3 @@
+[
+  { "h1": "thisa", "h2": "isa", "h3": "somea", "h4": "dataa" }
+]

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+[`
	`2`	`+ [ "thisa", "isa", "somea", "dataa" ]`
	`3`	`+]`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+[`
	`2`	`+ { "h1": "thisa", "h2": "isa", "h3": "somea", "h4": "dataa" }`
	`3`	`+]`