rename freeze to freeze!

Author: radarroark

README.md

@@ -152,12 +152,12 @@ One important distinction from the Clojure atom is that inside a transaction (eg
 ;; the fruits vector was mutated!
 ```
 
-If you want to prevent data from being mutated within a transaction, you must `freeze` it:
+If you want to prevent data from being mutated within a transaction, you must `freeze!` it:
 
 ```clojure
 (swap! db (fn [moment]
             (let [moment (assoc moment :fruits ["apple" "pear" "grape"])
-                  moment (assoc moment :food (xdb/freeze (:fruits moment)))
+                  moment (assoc moment :food (xdb/freeze! (:fruits moment)))
                   moment (update moment :food conj "eggs" "rice" "fish")]
               moment)))
 

src/xitdb/db.clj

@@ -231,7 +231,7 @@
     :else
     (throw (IllegalArgumentException. (str "xdb must be an instance of XITDBCursor or XITDBDatabase, got: " (type xdb))))))
 
-(defn freeze
+(defn freeze!
   "Prevents all data written in the current transaction from
   being mutated by any remaining changes. Throws if called
   outside of a transaction. Returns a read-only version of the

test/xitdb/freeze_test.clj

@@ -1,5 +1,5 @@
 (ns xitdb.freeze-test
-  "Tests for the `freeze` function"
+  "Tests for the `freeze!` function"
   (:require
     [clojure.test :refer :all]
     [xitdb.db :as xdb]
@@ -26,7 +26,7 @@
 
       (swap! db (fn [moment]
                   (let [moment (assoc moment :fruits ["apple" "pear" "grape"])
-                        moment (assoc moment :food (xdb/freeze (:fruits moment)))
+                        moment (assoc moment :food (xdb/freeze! (:fruits moment)))
                         moment (update moment :food conj "eggs" "rice" "fish")]
                     moment)))
 
@@ -55,7 +55,7 @@
 
       (swap! db (fn [moment]
                   (let [moment (assoc moment :fruits '("apple" "pear" "grape"))
-                        moment (assoc moment :food (xdb/freeze (:fruits moment)))
+                        moment (assoc moment :food (xdb/freeze! (:fruits moment)))
                         moment (update moment :food conj "eggs" "rice" "fish")]
                     moment)))
 
@@ -84,7 +84,7 @@
 
       (swap! db (fn [moment]
                   (let [moment (assoc moment :fruits {:names ["apple" "pear" "grape"]})
-                        moment (assoc moment :food (xdb/freeze (:fruits moment)))
+                        moment (assoc moment :food (xdb/freeze! (:fruits moment)))
                         moment (update-in moment [:food :names] conj "eggs" "rice" "fish")]
                     moment)))
 
@@ -113,7 +113,7 @@
 
       (swap! db (fn [moment]
                   (let [moment (assoc moment :fruits #{"apple" "pear" "grape"})
-                        moment (assoc moment :food (xdb/freeze (:fruits moment)))
+                        moment (assoc moment :food (xdb/freeze! (:fruits moment)))
                         moment (update moment :food conj "eggs" "rice" "fish")]
                     moment)))