deprecate/rename whitespace append/prepend functions (closes #36).

Author: Yannick Scherer

src/rewrite_clj/zip/whitespace.clj

@@ -40,32 +40,68 @@
 
 ;; ## Insertion
 
-(defn prepend-space
-  "Prepend a whitespace node representing the given number of spaces (default: 1)."
-  ([zloc] (prepend-space zloc 1))
+(defn ^{:added "0.5.0"} insert-space-left
+  "Insert a whitespace node before the given one, representing the given
+   number of spaces (default: 1)."
+  ([zloc] (insert-space-left zloc 1))
   ([zloc n]
    {:pre [(>= n 0)]}
    (if (pos? n)
      (z/insert-left zloc (node/spaces n))
      zloc)))
 
-(defn append-space
-  "Append a whitespace node representing the given number of spaces (default: 1)."
-  ([zloc] (append-space zloc 1))
+(defn ^{:added "0.5.0"} insert-space-right
+  "Insert a whitespace node after the given one, representing the given number
+   of spaces (default: 1)."
+  ([zloc] (insert-space-right zloc 1))
   ([zloc n]
    {:pre [(>= n 0)]}
    (if (pos? n)
      (z/insert-right zloc (node/spaces n))
      zloc)))
 
-(defn prepend-newline
-  "Prepend a whitespace node representing the given number of spaces (default: 1)."
-  ([zloc] (prepend-newline zloc 1))
+(defn ^{:added "0.5.0"} insert-newline-left
+  "Insert a newline node before the given one, representing the given number of
+   spaces (default: 1)."
+  ([zloc] (insert-newline-left zloc 1))
   ([zloc n]
    (z/insert-left zloc (node/newlines n))))
 
-(defn append-newline
-  "Append a whitespace node representing the given number of spaces (default: 1)."
-  ([zloc] (append-newline zloc 1))
+(defn ^{:added "0.5.0"} insert-newline-right
+  "Insert a newline node after the given one, representing the given number of
+   linebreaks (default: 1)."
+  ([zloc] (insert-newline-right zloc 1))
   ([zloc n]
    (z/insert-right zloc (node/newlines n))))
+
+;; ## Deprecated Functions
+
+(defn ^{:deprecated "0.5.0"} prepend-space
+  "Prepend a whitespace node representing the given number of spaces (default: 1).
+
+   DEPRECATED: use 'insert-space-left' instead."
+  [zloc & [n]]
+  (insert-space-left zloc (or n 1)))
+
+(defn ^{:deprecated "0.5.0"} append-space
+  "Append a whitespace node representing the given number of spaces (default: 1).
+
+   DEPRECATED: use 'insert-space-right' instead."
+  [zloc & [n]]
+  (insert-space-right zloc (or n 1)))
+
+(defn ^{:deprecated "0.5.0"} prepend-newline
+  "Prepend a newline node representing the given number of linebreaks (default:
+   1).
+
+   DEPRECATED: use 'insert-newline-left' instead."
+  [zloc & [n]]
+  (insert-newline-left zloc (or n 1)))
+
+(defn ^{:deprecated "0.5.0"} append-newline
+  "Append a newline node representing the given number of linebreaks (default:
+   1).
+
+   DEPRECATED: use 'insert-newline-right' instead."
+  [zloc & [n]]
+  (insert-newline-right zloc (or n 1)))

test/rewrite_clj/zip/whitespace_test.clj

@@ -27,13 +27,21 @@
         (let [n (->> loc z/down (skip-whitespace z/next) z/node)]
           (node/tag n) => :token
           (node/sexpr n) => 0))
-  (fact "about prepending/appending spaces."
-        (let [n (-> loc z/down z/rightmost (prepend-space 3))]
-          (base/root-string n) => " \n0 1   ;comment")
-        (let [n (-> loc z/down z/rightmost (append-space 3))]
-          (base/root-string n) => " \n0 1;comment   "))
-  (fact "about prepending/appending linebreaks."
-        (let [n (-> loc z/down z/rightmost (prepend-newline 3))]
-          (base/root-string n) => " \n0 1\n\n\n;comment")
-        (let [n (-> loc z/down z/rightmost (append-newline 3))]
-          (base/root-string n) => " \n0 1;comment\n\n\n")))
+  (tabular
+    (fact "about prepending/appending spaces."
+          (let [n (-> loc z/down z/rightmost (?left-fn 3))]
+            (base/root-string n) => " \n0 1   ;comment")
+          (let [n (-> loc z/down z/rightmost (?right-fn 3))]
+            (base/root-string n) => " \n0 1;comment   "))
+    ?left-fn          ?right-fn
+    prepend-space     append-space
+    insert-space-left insert-space-right)
+  (tabular
+    (fact "about prepending/appending linebreaks."
+          (let [n (-> loc z/down z/rightmost (prepend-newline 3))]
+            (base/root-string n) => " \n0 1\n\n\n;comment")
+          (let [n (-> loc z/down z/rightmost (append-newline 3))]
+            (base/root-string n) => " \n0 1;comment\n\n\n"))
+    ?left-fn            ?right-fn
+    prepend-newline     append-newline
+    insert-newline-left insert-newline-right))