Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add escape-char option to write-csv #28

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add escape-char option to write-csv #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions src/clojure_csv/core.clj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,27 +234,28 @@ and quotes. The main functions are parse-csv and write-csv."}
"Given a character, returns the escaped version, whether that is the same
as the original character or a replacement. The return is a string or a
character, but it all gets passed into str anyways."
[chr delimiter quote-char]
(if (= quote-char chr) (str quote-char quote-char) chr))
[chr delimiter quote-char escape-char]
(if (= quote-char chr) (str escape-char quote-char) chr))

(defn- quote-and-escape
"Given a string (cell), returns a new string that has any necessary quoting
and escaping."
[cell delimiter quote-char force-quote]
[cell delimiter quote-char escape-char force-quote]
(if (or force-quote (needs-quote? cell delimiter quote-char))
(str quote-char
(apply str (map #(escape % delimiter quote-char)
(apply str (map #(escape % delimiter quote-char escape-char)
cell))
quote-char)
cell))

(defn- quote-and-escape-row
"Given a row (vector of strings), quotes and escapes any cells where that
is necessary and then joins all the text into a string for that entire row."
[row delimiter quote-char force-quote]
[row delimiter quote-char escape-char force-quote]
(string/join delimiter (map #(quote-and-escape %
delimiter
quote-char
escape-char
force-quote)
row)))

Expand All @@ -269,15 +270,18 @@ and quotes. The main functions are parse-csv and write-csv."}
for writing CSV files. Default value: \\n
:quote-char - A character that is used to begin and end a quoted cell.
Default value: \\\"
:escape-char - A character that is used to escape quoting.
Default value: :quote-char
:force-quote - Forces every cell to be quoted (useful for Excel interop)
Default value: false"
[table & {:keys [delimiter quote-char end-of-line force-quote]
[table & {:keys [delimiter quote-char escape-char end-of-line force-quote]
:or {delimiter \, quote-char \" end-of-line "\n"
force-quote false}}]
(loop [csv-string (StringBuilder.)
quoted-table (map #(quote-and-escape-row %
(str delimiter)
quote-char
(if (nil? escape-char) quote-char escape-char)
force-quote)
table)]
(if (empty? quoted-table)
Expand Down
8 changes: 8 additions & 0 deletions test/clojure_csv/test/core.clj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,14 @@
(is (= "a,b\"c,d\n"
(write-csv [["a", "b\"c", "d"]] :quote-char \|))))

(deftest alternate-escape-char
(is (= "quoted:,\"escaped\"quotes\"\"\n"
(write-csv [["quoted:" "escaped\"quotes\""]] :escape-char "")))
(is (= "quoted:,\"escaped\"\"quotes\"\"\"\n"
(write-csv [["quoted:" "escaped\"quotes\""]] :escape-char \")))
(is (= "quoted:,\"escaped\\\"quotes\\\"\"\n"
(write-csv [["quoted:" "escaped\"quotes\""]] :escape-char \\))))

(deftest strictness
(is (thrown? Exception (dorun (parse-csv "a,b,c,\"d" :strict true))))
(is (thrown? Exception (dorun (parse-csv "a,b,c,d\"e" :strict true))))
Expand Down