Merge pull request #13 from gongo/add_option_pretty_string

Add flag `json-reformat:pretty-string?`
gongo · Dec 11, 2014 · b8dac16 · b8dac16
2 parents a99387e + 7e61723
commit b8dac16
Show file tree

Hide file tree

Showing 3 changed files with 68 additions and 32 deletions.
diff --git a/README.md b/README.md
@@ -40,40 +40,38 @@ M-x json-reformat-region
 json-reformat:indent-width (integer)
 
     Change indentation level (default 4)
-```
 
-## IMPORTANT
+json-reformat:pretty-string? (boolean)
 
-From emacs 24.4, `json-pretty-print` and `json-pretty-print-buffer` was bundled.
+    Specify whether to decode the string (default nil)
 
-Example:
+    Example:
 
-```json
-{"name":"foobar","nick":"foo \u00e4 bar","description":"<pre>\nbaz\n</pre>"}
-```
+    ;; {"name":"foo\"bar","nick":"foo \u00e4 bar","description":"<pre>\nbaz\n</pre>"}
 
-Result of `json-pretty-print`:
+    If nil:
 
-```json
-{
-  "description": "<pre>\nbaz\n<\/pre>",
-  "nick": "foo \u00e4 bar",
-  "name": "foobar"
-}
-```
+    {
+        "name": "foo\"bar",
+        "nick": "foo \u00e4 bar",
+        "description": "<pre>\nbaz\n<\/pre>"
+    }
 
-Result of `json-reformat-region`:
+    Else t:
 
-```json
-{
-  "description": "<pre>
-baz
-</pre>",
-  "nick": "foo ä bar",
-  "name": "foobar"
-}
+    {
+        "name": "foo\"bar",
+        "nick": "foo ä bar",
+        "description": "<pre>
+    baz
+    </pre>"
+    }
 ```
 
+## SEE ALSO
+
+From emacs 24.4, `json-pretty-print` and `json-pretty-print-buffer` (similar specifications as `json-reformat-region`) was bundled.
+
 ## LICENSE
 
 MIT License. see `json-reformat.el`

diff --git a/json-reformat.el b/json-reformat.el
@@ -45,6 +45,33 @@
   :type 'integer
   :group 'json-reformat)
 
+(defcustom json-reformat:pretty-string? nil
+  "Whether to decode the string.
+
+Example:
+
+{\"name\":\"foobar\",\"nick\":\"foo \\u00e4 bar\",\"description\":\"<pre>\\nbaz\\n</pre>\"}
+
+If nil:
+
+    {
+        \"name\": \"foobar\",
+        \"nick\": \"foo \\u00e4 bar\",
+        \"description\": \"<pre>\\nbaz\\n<\\/pre>\"
+    }
+
+Else t:
+
+    {
+        \"name\": \"foobar\",
+        \"nick\": \"foo ä bar\",
+        \"description\": \"<pre>
+    baz
+    </pre>\"
+    }"
+  :type 'boolean
+  :group 'json-reformat)
+
 (defun json-reformat:indent (level)
   (make-string (* level json-reformat:indent-width) ? ))
 
@@ -56,8 +83,10 @@
         ((equal json-false val) "false")
         (t (symbol-name val))))
 
-(defun json-reformat:decode-string (val)
-  (format "\"%s\"" val))
+(defun json-reformat:string-to-string (val)
+  (if json-reformat:pretty-string?
+      (format "\"%s\"" (replace-regexp-in-string "\"" "\\\\\"" val))
+    (json-encode-string val)))
 
 (defun json-reformat:vector-to-string (val level)
   (if (= (length val) 0) "[]"
@@ -84,12 +113,12 @@
     rval))
 
 (defun json-reformat:print-node (val level)
-  (cond ((consp val) (json-reformat:tree-to-string (json-reformat:reverse-plist val) level))
+  (cond ((consp val)   (json-reformat:tree-to-string (json-reformat:reverse-plist val) level))
         ((numberp val) (json-reformat:number-to-string val))
         ((vectorp val) (json-reformat:vector-to-string val level))
-        ((null val) "null")
+        ((null val)    "null")
         ((symbolp val) (json-reformat:symbol-to-string val))
-        (t (json-reformat:decode-string val))))
+        (t             (json-reformat:string-to-string val))))
 
 (defun json-reformat:tree-to-string (root level)
   (concat "{\n"

diff --git a/test/json-reformat-test.el b/test/json-reformat-test.el
@@ -55,11 +55,20 @@
 \]" (json-reformat:vector-to-string [1 [2 [3 4] 5] 6 []] 0)))
   )
 
-(ert-deftest json-reformat-test:decode-string ()
-  (should (string= "\"foobar\"" (json-reformat:decode-string "foobar")))
-  (should (string= "\"♡\"" (json-reformat:decode-string "\u2661")))
+(ert-deftest json-reformat-test:string-to-string ()
+  (should (string= "\"foobar\"" (json-reformat:string-to-string "foobar")))
+  (should (string= "\"fo\\\"o\\nbar\"" (json-reformat:string-to-string "fo\"o\nbar")))
+  (should (string= "\"\\u2661\"" (json-reformat:string-to-string "\u2661")))
   )
 
+(ert-deftest json-reformat-test:string-to-string-when-pretty ()
+  (let ((json-reformat:pretty-string? t))
+    (should (string= "\"foobar\"" (json-reformat:string-to-string "foobar")))
+    (should (string= "\"fo\\\"o
+bar\"" (json-reformat:string-to-string "fo\"o\nbar")))
+    (should (string= "\"♡\"" (json-reformat:string-to-string "\u2661")))
+    ))
+
 (ert-deftest json-reformat-test:print-node ()
   (should (string= "null" (json-reformat:print-node nil 0)))
   )