Addendum for #214: coerce strings as string nodes (#231)

Author: borkdude

src/rewrite_clj/node/coercer.cljc

@@ -21,10 +21,11 @@
         [rewrite-clj.node.reader-macro :refer [reader-macro-node var-node]]
         [rewrite-clj.node.regex :refer [regex-node pattern-string-for-regex]]
         [rewrite-clj.node.seq :refer [vector-node list-node set-node map-node]]
-        [rewrite-clj.node.stringz]
+        [rewrite-clj.node.stringz :as stringz]
         [rewrite-clj.node.token :refer [token-node]]
         [rewrite-clj.node.uneval]
-        [rewrite-clj.node.whitespace :as ws]]
+        [rewrite-clj.node.whitespace :as ws]
+        [rewrite-clj.parser.impl :as pimpl]]
        :cljs
        [[clojure.string :as string]
         [rewrite-clj.node.comment :refer [CommentNode]]
@@ -39,10 +40,12 @@
         [rewrite-clj.node.reader-macro :refer [ReaderNode ReaderMacroNode DerefNode reader-macro-node var-node]]
         [rewrite-clj.node.regex :refer [RegexNode regex-node pattern-string-for-regex]]
         [rewrite-clj.node.seq :refer [SeqNode vector-node list-node set-node map-node]]
-        [rewrite-clj.node.stringz :refer [StringNode]]
+        [rewrite-clj.node.stringz :as stringz :refer [StringNode]]
         [rewrite-clj.node.token :refer [TokenNode SymbolNode token-node]]
         [rewrite-clj.node.uneval :refer [UnevalNode]]
-        [rewrite-clj.node.whitespace :refer [WhitespaceNode CommaNode NewlineNode] :as ws]]))
+        [rewrite-clj.node.whitespace :refer [WhitespaceNode CommaNode NewlineNode] :as ws]
+        [rewrite-clj.parser.impl :as pimpl]])
+   [rewrite-clj.reader :as reader])
   #?(:clj
      (:import [rewrite_clj.node.comment CommentNode]
               [rewrite_clj.node.fn FnNode]
@@ -135,13 +138,8 @@
 
 (extend-protocol NodeCoerceable
   #?(:clj java.lang.String :cljs string)
-  ;; You might we should be coercing to a string-node here.
-  ;; We did this initially for rewrite-clj v1 but found it made more sense to revert to v0 behaviour.
-  ;; The string-node was created to serve the parser and expects the strings to be escaped in a particular way.
-  ;; The token-node has no such expectations and is therefore, currently, what we use for coercing strings.
-  ;; If this makes future internal changes awkward we'll revisit.
   (coerce [v]
-    (token-node v)))
+    (stringz/string-node (pimpl/read-string-data (reader/string-reader (pr-str v))))))
 
 #?(:clj
    (extend-protocol NodeCoerceable

src/rewrite_clj/parser/impl.cljc

@@ -0,0 +1,33 @@
+(ns rewrite-clj.parser.impl
+  {:no-doc true}
+  (:require [rewrite-clj.reader :as reader])
+  #?(:cljs (:import [goog.string StringBuffer])))
+
+#?(:clj (set! *warn-on-reflection* true))
+
+(defn flush-into
+  "INTERNAL. Flush buffer and add string to the given vector."
+  [lines ^StringBuffer buf]
+  (let [s (.toString buf)]
+    #?(:clj (.setLength buf 0) :cljs (.clear buf))
+    (conj lines s)))
+
+(defn read-string-data
+  "INTERNAL."
+  [#?(:cljs ^not-native reader :default reader)]
+  (reader/ignore reader)
+  (let [buf (StringBuffer.)]
+    (loop [escape? false
+           lines []]
+      (if-let [c (reader/next reader)]
+        (cond (and (not escape?) (identical? c \"))
+              (flush-into lines buf)
+
+              (identical? c \newline)
+              (recur escape? (flush-into lines buf))
+
+              :else
+              (do
+                (.append buf c)
+                (recur (and (not escape?) (identical? c \\)) lines)))
+        (reader/throw-reader reader "Unexpected EOF while reading string.")))))

src/rewrite_clj/parser/string.cljc

@@ -1,42 +1,15 @@
 (ns ^:no-doc rewrite-clj.parser.string
   (:require [clojure.string :as string]
             [rewrite-clj.node.stringz :as nstring]
-            [rewrite-clj.reader :as reader])
-  #?(:cljs (:import [goog.string StringBuffer])))
+            [rewrite-clj.parser.impl :as pimpl]))
 
 #?(:clj (set! *warn-on-reflection* true))
 
-(defn- flush-into
-  "Flush buffer and add string to the given vector."
-  [lines ^StringBuffer buf]
-  (let [s (.toString buf)]
-    #?(:clj (.setLength buf 0) :cljs (.clear buf))
-    (conj lines s)))
-
-(defn- read-string-data
-  [#?(:cljs ^not-native reader :default reader)]
-  (reader/ignore reader)
-  (let [buf (StringBuffer.)]
-    (loop [escape? false
-           lines []]
-      (if-let [c (reader/next reader)]
-        (cond (and (not escape?) (identical? c \"))
-              (flush-into lines buf)
-
-              (identical? c \newline)
-              (recur escape? (flush-into lines buf))
-
-              :else
-              (do
-                (.append buf c)
-                (recur (and (not escape?) (identical? c \\)) lines)))
-        (reader/throw-reader reader "Unexpected EOF while reading string.")))))
-
 (defn parse-string
   [#?(:cljs ^not-native reader :default reader)]
-  (nstring/string-node (read-string-data reader)))
+  (nstring/string-node (pimpl/read-string-data reader)))
 
 (defn parse-regex
   [#?(:cljs ^not-native reader :default reader)]
-  (let [h (read-string-data reader)]
+  (let [h (pimpl/read-string-data reader)]
     (string/join "\n" h)))

test/rewrite_clj/node/coercer_test.cljc

@@ -41,15 +41,15 @@
       ::1.5.1                :token      :keyword
       :namespace/keyword     :token      :keyword
 
-      ""                     :token      :token
-      "hello, over there!"   :token      :token
-      "multi\nline"          :token      :token
-      " "                    :token      :token
-      "\n"                   :token      :token
-      "\n\n"                 :token      :token
-      ","                    :token      :token
-      "inner\"quote"         :token      :token
-      "\\s+"                 :token      :token
+      ""                     :token      :string
+      "hello, over there!"   :token      :string
+      "multi\nline"          :token      :string
+      " "                    :token      :string
+      "\n"                   :token      :string
+      "\n\n"                 :token      :string
+      ","                    :token      :string
+      "inner\"quote"         :token      :string
+      "\\s+"                 :token      :string
 
       ;; seqs
       []                     :vector     :seq
@@ -69,7 +69,9 @@
           n (node/coerce s)]
       (is (= s (node/sexpr n)))))
   (testing "coerce string roundtrip"
-    (is (= "\"hey \\\" man\"" (-> "hey \" man" node/coerce node/string)))))
+    (is (= "\"hey \\\" man\"" (-> "hey \" man" node/coerce node/string))))
+  (testing "coerce string equals parsed string"
+    (is (= (p/parse-string "\"hello\"") (node/coerce "hello")))))
 
 (deftest
   t-quoted-list-reader-location-metadata-elided