ftcsv/spec/feature_spec.lua

local ftcsv = require('ftcsv')

describe("csv features", function()
	it("should handle loading from string", function()
		local expected = {}
		expected[1] = {}
		expected[1].a = "apple"
		expected[1].b = "banana"
		expected[1].c = "carrot"
		local actual = ftcsv.parse("a,b,c\napple,banana,carrot", ",", {loadFromString=true})
		assert.are.same(expected, actual)
	end)

	it("should handle crlf loading from string", function()
		local expected = {}
		expected[1] = {}
		expected[1].a = "apple"
		expected[1].b = "banana"
		expected[1].c = "carrot"
		local actual = ftcsv.parse("a,b,c\r\napple,banana,carrot", ",", {loadFromString=true})
		assert.are.same(expected, actual)
	end)

	it("should handle cr loading from string", function()
		local expected = {}
		expected[1] = {}
		expected[1].a = "apple"
		expected[1].b = "banana"
		expected[1].c = "carrot"
		local actual = ftcsv.parse("a,b,c\rapple,banana,carrot", ",", {loadFromString=true})
		assert.are.same(expected, actual)
	end)

	it("should handle quotes loading from string", function()
		local expected = {}
		expected[1] = {}
		expected[1].a = "apple"
		expected[1].b = "banana"
		expected[1].c = "carrot"
		local actual = ftcsv.parse('"a","b","c"\n"apple","banana","carrot"', ",", {loadFromString=true})
		assert.are.same(expected, actual)
	end)

	it("should handle doublequotes loading from string", function()
		local expected = {}
		expected[1] = {}
		expected[1].a = '"apple"'
		expected[1].b = '"banana"'
		expected[1].c = '"carrot"'
		local actual = ftcsv.parse('"a","b","c"\n"""apple""","""banana""","""carrot"""', ",", {loadFromString=true})
		assert.are.same(expected, actual)
	end)

	it("should handle doublequotes loading from string", function()
		local expected = {}
		expected[1] = {}
		expected[1].a = '"apple"'
		expected[1].b = 'banana'
		expected[1].c = '"carrot"'
		local actual = ftcsv.parse('"a","b","c"\n"""apple""","banana","""carrot"""', ",", {loadFromString=true})
		assert.are.same(expected, actual)
	end)

	it("should handle escaped doublequotes", function()
		local expected = {}
		expected[1] = {}
		expected[1].a = 'A"B""C'
		expected[1].b = 'A""B"C'
		expected[1].c = 'A"""B""C'
		local actual = ftcsv.parse('a;b;c\n"A""B""""C";"A""""B""C";"A""""""B""""C"', ";", {loadFromString=true})
		assert.are.same(expected, actual)
	end)

	it("should handle renaming a field", function()
		local expected = {}
		expected[1] = {}
		expected[1].d = "apple"
		expected[1].b = "banana"
		expected[1].c = "carrot"
		local actual = ftcsv.parse("a,b,c\r\napple,banana,carrot", ",", {loadFromString=true, rename={["a"] = "d"}})
		assert.are.same(expected, actual)
	end)

	it("should handle renaming multiple fields", function()
		local expected = {}
		expected[1] = {}
		expected[1].d = "apple"
		expected[1].e = "banana"
		expected[1].f = "carrot"
		local options = {loadFromString=true, rename={["a"] = "d", ["b"] = "e", ["c"] = "f"}}
		local actual = ftcsv.parse("a,b,c\r\napple,banana,carrot", ",", options)
		assert.are.same(expected, actual)
	end)

	it("should return a table with column headers", function()
		local expected = { 'd', 'e', 'f' }
		local options = {loadFromString=true, rename={["a"] = "d", ["b"] = "e", ["c"] = "f"}}
		local _, actual = ftcsv.parse("a,b,c\r\napple,banana,carrot", ",", options)
		assert.are.same(expected, actual)
	end)

	it("should handle renaming multiple fields to the same out value", function()
		local expected = {}
		expected[1] = {}
		expected[1].d = "apple"
		expected[1].e = "carrot"
		local options = {loadFromString=true, rename={["a"] = "d", ["b"] = "e", ["c"] = "e"}}
		local actual = ftcsv.parse("a,b,c\r\napple,banana,carrot", ",", options)
		assert.are.same(expected, actual)
	end)

	it("should handle renaming multiple fields to the same out value with newline at end", function()
		local expected = {}
		expected[1] = {}
		expected[1].d = "apple"
		expected[1].e = "carrot"
		local options = {loadFromString=true, rename={["a"] = "d", ["b"] = "e", ["c"] = "e"}}
		local actual = ftcsv.parse("a,b,c\r\napple,banana,carrot\r\n", ",", options)
		assert.are.same(expected, actual)
	end)

	it("should handle only keeping a few fields", function()
		local expected = {}
		expected[1] = {}
		expected[1].a = "apple"
		expected[1].b = "banana"
		local options = {loadFromString=true, fieldsToKeep={"a","b"}}
		local actual = ftcsv.parse("a,b,c\r\napple,banana,carrot\r\n", ",", options)
		assert.are.same(expected, actual)
	end)

	it("should handle only keeping a few fields with a rename to an existing field", function()
		local expected = {}
		expected[1] = {}
		expected[1].a = "apple"
		expected[1].b = "carrot"
		local options = {loadFromString=true, fieldsToKeep={"a","b"}, rename={["c"] = "b"}}
		local actual = ftcsv.parse("a,b,c\r\napple,banana,carrot\r\n", ",", options)
		assert.are.same(expected, actual)
	end)

	it("should handle only keeping a few fields with a rename to a new field", function()
		local expected = {}
		expected[1] = {}
		expected[1].a = "apple"
		expected[1].f = "carrot"
		local options = {loadFromString=true, fieldsToKeep={"a","f"}, rename={["c"] = "f"}}
		local actual = ftcsv.parse("a,b,c\r\napple,banana,carrot\r\n", ",", options)
		assert.are.same(expected, actual)
	end)

	it("should handle files without headers", function()
		local expected = {}
		expected[1] = {}
		expected[1][1] = "apple"
		expected[1][2] = "banana"
		expected[1][3] = "carrot"
		expected[2] = {}
		expected[2][1] = "diamond"
		expected[2][2] = "emerald"
		expected[2][3] = "pearl"
		local options = {loadFromString=true, headers=false}
		local actual = ftcsv.parse("apple>banana>carrot\ndiamond>emerald>pearl", ">", options)
		assert.are.same(expected, actual)
	end)

	it("should handle files without headers with an empty header field", function()
		local expected = {}
		expected[1] = {}
		expected[1][1] = "apple"
		expected[1][2] = "banana"
		expected[1][3] = ""
		expected[2] = {}
		expected[2][1] = "diamond"
		expected[2][2] = "emerald"
		expected[2][3] = "pearl"
		local options = {loadFromString=true, headers=false}
		local actual = ftcsv.parse("apple>banana>\ndiamond>emerald>pearl", ">", options)
		assert.are.same(expected, actual)
	end)

	it("should handle files without (headers and newlines)", function()
		local expected = {}
		expected[1] = {}
		expected[1][1] = "apple"
		expected[1][2] = "banana"
		expected[1][3] = "carrot"
		local options = {loadFromString=true, headers=false}
		local actual = ftcsv.parse("apple>banana>carrot", ">", options)
		assert.are.same(expected, actual)
	end)

	it("should handle files without (headers and newlines) with an empty header field", function()
		local expected = {}
		expected[1] = {}
		expected[1][1] = "apple"
		expected[1][2] = "banana"
		expected[1][3] = ""
		local options = {loadFromString=true, headers=false}
		local actual = ftcsv.parse("apple>banana>", ">", options)
		assert.are.same(expected, actual)
	end)

	it("should handle files with quotes and without (headers and newlines)", function()
		local expected = {}
		expected[1] = {}
		expected[1][1] = "apple"
		expected[1][2] = "banana"
		expected[1][3] = "carrot"
		local options = {loadFromString=true, headers=false}
		local actual = ftcsv.parse('"apple">"banana">"carrot"', ">", options)
		assert.are.same(expected, actual)
	end)

	it("should handle files with quotes and without (headers and newlines) with an empty header field", function()
		local expected = {}
		expected[1] = {}
		expected[1][1] = "apple"
		expected[1][2] = "banana"
		expected[1][3] = ""
		local options = {loadFromString=true, headers=false}
		local actual = ftcsv.parse('"apple">"banana">', ">", options)
		assert.are.same(expected, actual)
	end)

	it("should handle files with quotes and without (headers and newlines)", function()
		local expected = {}
		expected[1] = {}
		expected[1][1] = "apple"
		expected[1][2] = "banana"
		expected[1][3] = "carrot"
		expected[2] = {}
		expected[2][1] = "diamond"
		expected[2][2] = "emerald"
		expected[2][3] = "pearl"
		local options = {loadFromString=true, headers=false}
		local actual = ftcsv.parse('"apple">"banana">"carrot"\n"diamond">"emerald">"pearl"', ">", options)
		assert.are.same(expected, actual)
	end)

	it("should handle files with quotes and without (headers and newlines) with an empty header field", function()
		local expected = {}
		expected[1] = {}
		expected[1][1] = "apple"
		expected[1][2] = "banana"
		expected[1][3] = ""
		expected[2] = {}
		expected[2][1] = "diamond"
		expected[2][2] = "emerald"
		expected[2][3] = "pearl"
		local options = {loadFromString=true, headers=false}
		local actual = ftcsv.parse('"apple">"banana">\n"diamond">"emerald">"pearl"', ">", options)
		assert.are.same(expected, actual)
	end)

	it("should handle files without (headers and newlines) w/newline at end", function()
		local expected = {}
		expected[1] = {}
		expected[1][1] = "apple"
		expected[1][2] = "banana"
		expected[1][3] = "carrot"
		local options = {loadFromString=true, headers=false}
		local actual = ftcsv.parse("apple>banana>carrot\n", ">", options)
		assert.are.same(expected, actual)
	end)

	it("should handle files without (headers and newlines) w/newline at end with an empty header field", function()
		local expected = {}
		expected[1] = {}
		expected[1][1] = "apple"
		expected[1][2] = "banana"
		expected[1][3] = ""
		local options = {loadFromString=true, headers=false}
		local actual = ftcsv.parse("apple>banana>\n", ">", options)
		assert.are.same(expected, actual)
	end)

	it("should handle files without (headers and newlines) w/crlf", function()
		local expected = {}
		expected[1] = {}
		expected[1][1] = "apple"
		expected[1][2] = "banana"
		expected[1][3] = "carrot"
		local options = {loadFromString=true, headers=false}
		local actual = ftcsv.parse("apple>banana>carrot\r\n", ">", options)
		assert.are.same(expected, actual)
	end)

	it("should handle files without (headers and newlines) w/crlf with an empty header field", function()
		local expected = {}
		expected[1] = {}
		expected[1][1] = "apple"
		expected[1][2] = "banana"
		expected[1][3] = ""
		local options = {loadFromString=true, headers=false}
		local actual = ftcsv.parse("apple>banana>\r\n", ">", options)
		assert.are.same(expected, actual)
	end)

	it("should handle files without (headers and newlines) w/cr", function()
		local expected = {}
		expected[1] = {}
		expected[1][1] = "apple"
		expected[1][2] = "banana"
		expected[1][3] = "carrot"
		local options = {loadFromString=true, headers=false}
		local actual = ftcsv.parse("apple>banana>carrot\r", ">", options)
		assert.are.same(expected, actual)
	end)

	it("should handle files without (headers and newlines) w/cr with an empty header field", function()
		local expected = {}
		expected[1] = {}
		expected[1][1] = "apple"
		expected[1][2] = "banana"
		expected[1][3] = ""
		local options = {loadFromString=true, headers=false}
		local actual = ftcsv.parse("apple>banana>\r", ">", options)
		assert.are.same(expected, actual)
	end)


	it("should handle only renaming fields from files without headers", function()
		local expected = {}
		expected[1] = {}
		expected[1].a = "apple"
		expected[1].b = "banana"
		expected[1].c = "carrot"
		expected[2] = {}
		expected[2].a = "diamond"
		expected[2].b = "emerald"
		expected[2].c = "pearl"
		local options = {loadFromString=true, headers=false, rename={"a","b","c"}}
		local actual = ftcsv.parse("apple>banana>carrot\ndiamond>emerald>pearl", ">", options)
		assert.are.same(expected, actual)
	end)

	it("should handle only renaming fields from files without headers with an empty header field", function()
		local expected = {}
		expected[1] = {}
		expected[1].a = "apple"
		expected[1].b = "banana"
		expected[1].c = ""
		expected[2] = {}
		expected[2].a = "diamond"
		expected[2].b = "emerald"
		expected[2].c = "pearl"
		local options = {loadFromString=true, headers=false, rename={"a","b","c"}}
		local actual = ftcsv.parse("apple>banana>\ndiamond>emerald>pearl", ">", options)
		assert.are.same(expected, actual)
	end)

	it("should handle only renaming fields from files without headers and only keeping a few fields", function()
		local expected = {}
		expected[1] = {}
		expected[1].a = "apple"
		expected[1].b = "banana"
		expected[2] = {}
		expected[2].a = "diamond"
		expected[2].b = "emerald"
		local options = {loadFromString=true, headers=false, rename={"a","b","c"}, fieldsToKeep={"a","b"}}
		local actual = ftcsv.parse("apple>banana>carrot\ndiamond>emerald>pearl", ">", options)
		assert.are.same(expected, actual)
	end)

	it("should handle only renaming fields from files without headers and only keeping a few fields with an empty header field", function()
		local expected = {}
		expected[1] = {}
		expected[1].a = "apple"
		expected[1].b = ""
		expected[2] = {}
		expected[2].a = "diamond"
		expected[2].b = "emerald"
		local options = {loadFromString=true, headers=false, rename={"a","b","c"}, fieldsToKeep={"a","b"}}
		local actual = ftcsv.parse("apple>>carrot\ndiamond>emerald>pearl", ">", options)
		assert.are.same(expected, actual)
	end)

	it("should handle if the number of renames doesn't equal the number of fields", function()
		local expected = {}
		expected[1] = {}
		expected[1].a = "apple"
		expected[1].b = "banana"
		expected[2] = {}
		expected[2].a = "diamond"
		expected[2].b = "emerald"
		local options = {loadFromString=true, headers=false, rename={"a","b"}, fieldsToKeep={"a","b"}}
		local actual = ftcsv.parse("apple>banana>carrot\ndiamond>emerald>pearl", ">", options)
		assert.are.same(expected, actual)
	end)

	it("should make things uppercase via headerFunc", function()
		local expected = {}
		expected[1] = {}
		expected[1].A = "apple"
		expected[1].B = "banana"
		expected[1].C = "carrot"
		local actual = ftcsv.parse("a,b,c\napple,banana,carrot", ",", {loadFromString=true, headerFunc=string.upper})
		assert.are.same(expected, actual)
	end)

	it("should handle encoding files", function()
		local expected = {}
		expected[1] = {}
		expected[1].A = "apple"
		expected[1].B = "banana"
		expected[1].C = "carrot"
		local actual = ftcsv.parse(ftcsv.encode(expected, ","), ",", {loadFromString=true})
		local expected = ftcsv.parse("A,B,C\napple,banana,carrot", ",", {loadFromString=true})
		assert.are.same(expected, actual)
	end)

	it("should handle encoding files with odd delimiters", function()
		local expected = {}
		expected[1] = {}
		expected[1].A = "apple"
		expected[1].B = "banana"
		expected[1].C = "carrot"
		local actual = ftcsv.parse(ftcsv.encode(expected, ">"), ">", {loadFromString=true})
		local expected = ftcsv.parse("A,B,C\napple,banana,carrot", ",", {loadFromString=true})
		assert.are.same(expected, actual)
	end)

	it("should handle encoding files with only certain fields to keep", function()
		local expected = {}
		expected[1] = {}
		expected[1].A = "apple"
		expected[1].B = "banana"
		expected[1].C = "carrot"
		local actual = ftcsv.parse(ftcsv.encode(expected, ",", {fieldsToKeep={"A", "B"}}), ",", {loadFromString=true})
		local expected = ftcsv.parse("A,B\napple,banana", ",", {loadFromString=true})
		assert.are.same(expected, actual)
	end)

	it("should handle encoding files (str test)", function()
		local expected = '"a","b","c","d"\r\n"1","","foo","""quoted"""\r\n'
		output = ftcsv.encode({
			{ a = 1, b = '', c = 'foo', d = '"quoted"' };
		}, ',')
		assert.are.same(expected, output)
	end)

	it("should handle encoding files (str test) with other delimiter", function()
		local expected = '"a">"b">"c">"d"\r\n"1">"">"foo">"""quoted"""\r\n'
		output = ftcsv.encode({
			{ a = 1, b = '', c = 'foo', d = '"quoted"' };
		}, '>')
		assert.are.same(expected, output)
	end)

	it("should handle encoding files without quotes (str test)", function()
		local expected = 'a,b,c,d\r\n1,,"fo,o","""quoted"""\r\n'
		output = ftcsv.encode({
			{ a = 1, b = '', c = 'fo,o', d = '"quoted"' };
		}, ',', {onlyRequiredQuotes=true})
		assert.are.same(expected, output)
	end)

	it("should handle encoding files without quotes with other delimiter (str test)", function()
		local expected = 'a>b>c>d\r\n1>>fo,o>"""quoted"""\r\n'
		output = ftcsv.encode({
			{ a = 1, b = '', c = 'fo,o', d = '"quoted"' };
		}, '>', {onlyRequiredQuotes=true})
		assert.are.same(expected, output)
	end)

	it("should handle encoding files without quotes with certain fields to keep (str test)", function()
		local expected = "b,c\r\n,foo\r\n"
		output = ftcsv.encode({
			{ a = 1, b = '', c = 'foo', d = '"quoted"' };
		}, ',', {onlyRequiredQuotes=true, fieldsToKeep={"b", "c"}})
		assert.are.same(expected, output)
	end)

	it("should handle headers attempting to escape", function()
		local expected = {}
		expected[1] = {}
		expected[1]["]] print('hello')"] = "apple"
		expected[1].b = "banana"
		expected[1].c = "carrot"
		local actual = ftcsv.parse("]] print('hello'),b,c\napple,banana,carrot", ",", {loadFromString=true})
		assert.are.same(expected, actual)
	end)

	it("should handle ignoring the single quote", function()
		local expected = {}
		expected[1] = {}
		expected[1].a = '"apple'
		expected[1].b = "banana"
		expected[1].c = "carrot"
		local actual = ftcsv.parse('a,b,c\n"apple,banana,carrot', ",", {loadFromString=true, ignoreQuotes=true})
		assert.are.same(expected, actual)
	end)

end)