Fix: double quotes inside elements (closes #9) (#12)

* Fix: double quotes inside elements

* Test: update tests for new fix

Author: aichbauer

src/helpers/append-element.js

@@ -5,13 +5,25 @@ const separatorOrLineBreak = (length, elementIdx, separator) => (
   length - 1 === elementIdx ? '\n' : separator
 );
 
+const escapeDoubleQuotesInsideElement = (element) => {
+  const thisElement = element.replace('"', '""');
+
+  return thisElement;
+};
+
 const appendElement = (element, lineLength, elementIdx, separator) => {
   const includesSpecials = checkSpecialCharsAndEmpty(element);
 
+  let thisElement = element;
+
+  if (includesSpecials) {
+    thisElement = escapeDoubleQuotesInsideElement(thisElement);
+  }
+
   return (
     includesSpecials
-      ? `"${element}"${separatorOrLineBreak(lineLength, elementIdx, separator)}`
-      : `${element}${separatorOrLineBreak(lineLength, elementIdx, separator)}`
+      ? `"${thisElement}"${separatorOrLineBreak(lineLength, elementIdx, separator)}`
+      : `${thisElement}${separatorOrLineBreak(lineLength, elementIdx, separator)}`
   );
 };
 

test/fixtures/data.js

@@ -8,6 +8,12 @@ const dataArray = [
   [3, 'Larry', 'the Bird', '@twitter'],
 ];
 
+const dataArrayWithDoubleQuotes = [
+  [1, 'Mark', 'Ot"to', '@mdo'],
+  [2, 'Jacob', 'Thornton', '@fat'],
+  [3, 'Larry', 'the Bird', '@twitter'],
+];
+
 const dataArrayWithNullAndUndefined = [
   [1, 'Mark', null, '@mdo'],
   [2, 'Jacob', 'Thornton', undefined],
@@ -41,6 +47,27 @@ const data = [
   },
 ];
 
+const dataObjectWithDoubleQuotes = [
+  {
+    number: 1,
+    first: 'Mark',
+    last: 'Ot"to',
+    handle: '@mdo',
+  },
+  {
+    number: 2,
+    first: 'Jacob',
+    last: 'Thornton',
+    handle: '@fat',
+  },
+  {
+    number: 3,
+    first: 'Larry',
+    last: 'the Bird',
+    handle: '@twitter',
+  },
+];
+
 const dataWithNullAndUndefined = [
   {
     number: 1,
@@ -67,6 +94,10 @@ export const dataArrayWithHeader = [
   ...dataArray,
 ];
 
+export const dataArrayWithDoubleQuotesInsideElement = [
+  ...dataArrayWithDoubleQuotes,
+];
+
 export const dataArrayWithoutHeader = [
   ...dataArray,
 ];
@@ -75,6 +106,10 @@ export const dataObject = [
   ...data,
 ];
 
+export const dataObjectWithDoubleQuotesInsideElement = [
+  ...dataObjectWithDoubleQuotes,
+];
+
 export const dataObjectWithNullAndUndefined = [
   ...dataWithNullAndUndefined,
 ];

test/fixtures/expected-results.js

@@ -16,10 +16,14 @@ export const expectedResultObjecOnlySeparatorTab = 'number\tfirst\tlast\thandle\
 
 export const expectedResultArrayHeaderWithSpaces = '"number number",first,last,handle\n1,Mark,Otto,@mdo\n2,Jacob,Thornton,@fat\n3,Larry,"the Bird",@twitter\n';
 
+export const expectedResultArrayWithDoubleQoutesInsideElement = '1,Mark,"Ot""to",@mdo\n2,Jacob,Thornton,@fat\n3,Larry,"the Bird",@twitter\n';
+
 export const expectedResultArrayWithHeaderNoOptions = expectedResultObjectNoOptions;
 
 export const expectedResultArrayOnlyHeader = expectedResultObjectOnlyHeader;
 
 export const expectedResultArrayHeaderSeparatorSemicolon = expectedResultObjectHeaderSeparatorSemicolon; // eslint-disable-line
 
 export const expectedResultArrayOnlySeparatorTab = expectedResultObjecOnlySeparatorTab;
+
+export const expectedResultObjectWithDoubleQoutesInsideElement = `number,first,last,handle\n${expectedResultArrayWithDoubleQoutesInsideElement}`; // eslint-disable-line

test/modules/convert-array-of-arrays-to-csv.spec.js

@@ -5,6 +5,7 @@ import {
   dataArrayWithoutHeader,
   dataArrayWithHeaderAndNullAndUndefined,
   dataArrayWithHeaderAndZero,
+  dataArrayWithDoubleQuotesInsideElement,
 } from '../fixtures/data';
 import {
   optionsHeaderSeperatorSemicolon,
@@ -21,6 +22,7 @@ import {
   expectedResultArrayOnlySeparatorTab,
   expectedResultArrayNullAndUndefined,
   expectedResultArrayZero,
+  expectedResultArrayWithDoubleQoutesInsideElement,
 } from '../fixtures/expected-results';
 
 test('convertArrayOfArraysToCSV | array of arrays | with default options', () => {
@@ -29,6 +31,12 @@ test('convertArrayOfArraysToCSV | array of arrays | with default options', () =>
   expect(result).toBe(expectedResultArrayWithHeaderNoOptions);
 });
 
+test('convertArrayOfArraysToCSV | array of arrays | with default options and double quotes in element', () => {
+  const result = convertArrayOfArraysToCSV(dataArrayWithDoubleQuotesInsideElement, optionsDefault);
+
+  expect(result).toBe(expectedResultArrayWithDoubleQoutesInsideElement);
+});
+
 test('convertArrayOfArraysToCSV | array of arrays | with default options and no header', () => {
   const result = convertArrayOfArraysToCSV(dataArrayWithoutHeader, optionsDefault);
 

test/modules/convert-array-of-objects-to-csv.spec.js

@@ -3,6 +3,7 @@ import { convertArrayOfObjectsToCSV } from '../../src/modules/convert-array-of-o
 import {
   dataObject,
   dataObjectWithNullAndUndefined,
+  dataObjectWithDoubleQuotesInsideElement,
 } from '../fixtures/data';
 import {
   optionsHeaderSeperatorSemicolon,
@@ -17,9 +18,16 @@ import {
   expectedResultObjectOnlyHeader,
   expectedResultObjecOnlySeparatorTab,
   expectedResultObjectNullAndUndefined,
+  expectedResultObjectWithDoubleQoutesInsideElement,
 } from '../fixtures/expected-results';
 
 test('convertArrayOfObjectsToCSV | array of objects | with default options', () => {
+  const result = convertArrayOfObjectsToCSV(dataObjectWithDoubleQuotesInsideElement, optionsDefault); // eslint-disable-line
+
+  expect(result).toBe(expectedResultObjectWithDoubleQoutesInsideElement);
+});
+
+test('convertArrayOfObjectsToCSV | array of objects | with default options and double quotes in element', () => {
   const result = convertArrayOfObjectsToCSV(dataObject, optionsDefault);
 
   expect(result).toBe(expectedResultObjectNoOptions);