Testing multi-line Strings. Added prefix/suffix utility functions.

Author: Yannick Scherer

src/rewrite_clj/zip/utils.clj

@@ -0,0 +1,58 @@
+(ns ^{ :doc "Utility operations for nodes."
+       :author "Yannick Scherer" }
+  rewrite-clj.zip.utils
+  (:require [fast-zip.core :as z]))
+
+;; ## Prefix
+
+(defmulti prefix
+  "Prefix the value of a zipper node with the given string. This supports multi-lined strings."
+  (fn [zloc p]
+    (when zloc
+      (first (z/node zloc))))
+  :default nil)
+
+(defmethod prefix nil
+  [zloc prefix]
+  (throw (Exception. (str "Cannot prefix value of type: " (first (z/node zloc))))))
+
+(defmethod prefix :token
+  [zloc prefix]
+  (let [v (second (z/node zloc))
+        v1 (cond (string? v) (str prefix v)
+                 (symbol? v) (symbol (namespace v) (str prefix (name v)))
+                 (keyword? v) (keyword (namespace v) (str prefix (name v)))
+                 :else (throw (Exception. (str "Cannot prefix token: " v))))]
+    (z/replace zloc [:token v1])))
+
+(defmethod prefix :multi-line
+  [zloc prefix]
+  (let [[v & rst] (rest (z/node zloc))]
+    (z/replace zloc (vec (list* :multi-line (str prefix v) rst)))))
+
+;; ## Suffix
+
+(defmulti suffix
+  "Suffix the value of a zipper node with the given string. This supports multi-lined strings."
+  (fn [zloc p]
+    (when zloc
+      (first (z/node zloc))))
+  :default nil)
+
+(defmethod suffix nil
+  [zloc suffix]
+  (throw (Exception. (str "Cannot suffix value of type: " (first (z/node zloc))))))
+
+(defmethod suffix :token
+  [zloc suffix]
+  (let [v (second (z/node zloc))
+        v1 (cond (string? v) (str v suffix)
+                 (symbol? v) (symbol (namespace v) (str (name v) suffix))
+                 (keyword? v) (keyword (namespace v) (str (name v) suffix))
+                 :else (throw (Exception. (str "Cannot suffix token: " v))))]
+    (z/replace zloc [:token v1])))
+
+(defmethod suffix :multi-line
+  [zloc suffix]
+  (let [[v & rst] (rest (z/node zloc))]
+    (z/replace zloc (vec (list* :multi-line (str v suffix) rst)))))

test/rewrite_clj/convert_test.clj

@@ -11,6 +11,9 @@
   [:token 0]                                0
   [:token 'id]                              'id
   [:token :k]                               :k
+  [:token "s"]                              "s"
+  [:token "abc\ndef"]                       "abc\ndef"
+  [:multi-line "abc" "def"]                 "abc\ndef"
   [:list [:token :k] [:token 5]]            '(:k 5)
   [:vector [:token :k] [:token 5]]          [:k 5]
   [:set [:token :k] [:token 5]]             #{:k 5}
@@ -54,6 +57,7 @@
   0                                        [:token 0]
   :k                                       [:token :k]
   'x                                       [:token 'x]
+  "s"                                      [:token "s"]
   '(1 2)                                   [:list [:token 1] [:whitespace " "] [:token 2]]
   [1 2]                                    [:vector [:token 1] [:whitespace " "] [:token 2]]
   #{1 2}                                   [:set [:token 1] [:whitespace " "] [:token 2]]

test/rewrite_clj/parser_test.clj

@@ -39,6 +39,11 @@
   "#\"regex\\.\""    "regex\\."
   "#\"[reg|k].x\""   "[reg|k].x")
 
+(fact "about parsing strings"
+  (p/parse-string "\"123\"") => [:token "123"]
+  (p/parse-string "\"123\\n456\"") => [:token "123\n456"]
+  (p/parse-string "\"123\n456\"") => [:multi-line "123" "456"])
+
 (tabular
   (fact "about parsing seqs"
     (let [[k & rst] (p/parse-string ?s)]

test/rewrite_clj/transform_test.clj

@@ -2,12 +2,14 @@
        :author "Yannick Scherer" }
   rewrite-clj.transform-test
   (:require [midje.sweet :refer :all]
-            [rewrite-clj.zip :as z]))
+            [rewrite-clj.zip :as z]
+            [rewrite-clj.zip.utils :as zu]))
 
 (def data-string
 ";; This is a Project File.
 (defproject my-project \"0.1.0-SNAPSHOT\"
-  :description \"A project.\"
+  :description \"A project.
+                 Multiline!\"
   :dependencies [[a \"0.1.0\"]
                  [b \"1.2.3\"]]
   :repositories { \"private\" \"http://private.com/repo\" })")
@@ -17,33 +19,55 @@
 (fact "about a simple transformation"
   (-> data 
     (z/find-value z/next 'defproject) 
-    (z/find-value :description)
-    z/right (z/edit #(str "DESCR: " %))
+    z/right z/right
+    (z/edit #(str % "-1"))
     z/->root-string)
       => 
 ";; This is a Project File.
-(defproject my-project \"0.1.0-SNAPSHOT\"
-  :description \"DESCR: A project.\"
+(defproject my-project \"0.1.0-SNAPSHOT-1\"
+  :description \"A project.
+                 Multiline!\"
   :dependencies [[a \"0.1.0\"]
                  [b \"1.2.3\"]]
   :repositories { \"private\" \"http://private.com/repo\" })")
 
-(fact "about a seq transformation"
+(fact "about a seq transformation (prefix)"
   (-> data
     (z/find-value z/next 'defproject)
     (z/find-value :dependencies) z/right
     (->>
       (z/map
         (fn [loc]
           (-> loc z/down 
-            (z/edit (comp symbol #(str "prefix-" %)) )
+            (zu/prefix "prefix-")
             z/up))))
     z/->root-string)
       =>
 ";; This is a Project File.
 (defproject my-project \"0.1.0-SNAPSHOT\"
-  :description \"A project.\"
+  :description \"A project.
+                 Multiline!\"
   :dependencies [[prefix-a \"0.1.0\"]
                  [prefix-b \"1.2.3\"]]
+  :repositories { \"private\" \"http://private.com/repo\" })")
+
+(fact "about a seq transformation (suffix)"
+  (-> data
+    (z/find-value z/next 'defproject)
+    (z/find-value :dependencies) z/right
+    (->>
+      (z/map
+        (fn [loc]
+          (-> loc z/down 
+            (zu/suffix "-suffix")
+            z/up))))
+    z/->root-string)
+      =>
+";; This is a Project File.
+(defproject my-project \"0.1.0-SNAPSHOT\"
+  :description \"A project.
+                 Multiline!\"
+  :dependencies [[a-suffix \"0.1.0\"]
+                 [b-suffix \"1.2.3\"]]
   :repositories { \"private\" \"http://private.com/repo\" })" 
       )