From 6ad431f095cf8507f4985640f17f974dd4fd5e9d Mon Sep 17 00:00:00 2001
From: Antonin Hildebrand <antonin@hildebrand.cz>
Date: Wed, 19 Aug 2015 16:40:40 +0200
Subject: [PATCH] mark side-effecting functions as such

---
 src/re_frame/frame.cljs       | 6 +++---
 src/re_frame/scaffold.cljs    | 4 ++--
 test/re_frame/test/frame.cljs | 6 +++---
 3 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/src/re_frame/frame.cljs b/src/re_frame/frame.cljs
index d90672807..6f98c2817 100644
--- a/src/re_frame/frame.cljs
+++ b/src/re_frame/frame.cljs
@@ -137,11 +137,11 @@ by the process doing actual transduction. See event processing helpers below for
         xform (get-frame-transducer frame last)]
     (transduce xform reducing-fn [init-db] events)))
 
-(defn process-event-on-atom [frame db-atom event]
+(defn process-event-on-atom! [frame db-atom event]
   (let [new-db (process-event frame @db-atom event)]
     (reset-if-changed! db-atom new-db)))
 
-(defn process-events-on-atom [frame db-atom events]
+(defn process-events-on-atom! [frame db-atom events]
   (let [reducing-fn (fn
                       ([db-atom] db-atom)                   ; completion
                       ([db-atom new-db]                     ; in each step
@@ -150,7 +150,7 @@ by the process doing actual transduction. See event processing helpers below for
         xform (get-frame-transducer frame deref)]
     (transduce xform reducing-fn db-atom events)))
 
-(defn process-events-on-atom-with-coallesced-write [frame db-atom events]
+(defn process-events-on-atom-with-coallesced-write! [frame db-atom events]
   (let [reducing-fn (fn
                       ([final-db]                           ; completion
                        (reset-if-changed! db-atom final-db))  ; commit final-db to atom
diff --git a/src/re_frame/scaffold.cljs b/src/re_frame/scaffold.cljs
index 06469c2b0..96141456e 100644
--- a/src/re_frame/scaffold.cljs
+++ b/src/re_frame/scaffold.cljs
@@ -114,7 +114,7 @@
               (do (reagent/flush) (<! (timeout 20)))        ;; wait just over one annimation frame (16ms), to rensure all pending GUI work is flushed to the DOM.
               (<! (timeout 0)))]                            ;; just in case we are handling one dispatch after an other, give the browser back control to do its stuff
       (try
-        (frame/process-event-on-atom @frame-atom db-atom event)
+        (frame/process-event-on-atom! @frame-atom db-atom event)
 
         ;; If the handler throws:
         ;;   - allow the exception to bubble up because the app, in production,
@@ -158,7 +158,7 @@
   Usage example:
      (dispatch-sync [:delete-item 42])"
   [db-atom frame-atom event]
-  (frame/process-event-on-atom @frame-atom db-atom event)
+  (frame/process-event-on-atom! @frame-atom db-atom event)
   nil)                                                      ;; Ensure nil return. See https://github.com/Day8/re-frame/wiki/Beware-Returning-False
 
 (def dispatch-sync (partial dispatch-sync* app-db app-frame))
diff --git a/test/re_frame/test/frame.cljs b/test/re_frame/test/frame.cljs
index 17599de0b..6f08ed3bb 100644
--- a/test/re_frame/test/frame.cljs
+++ b/test/re_frame/test/frame.cljs
@@ -102,7 +102,7 @@
           add-handler (fn [state [_event-id num]] (+ state num))
           frame (-> (make-test-frame-with-log-recording)
                   (frame/register-event-handler :add add-handler))]
-      (frame/process-event-on-atom frame db [:add 100])
+      (frame/process-event-on-atom! frame db [:add 100])
       (is (= @db 100))
       (is (= @reset-counter 1))))
   (testing "process multiple events on atom"
@@ -112,7 +112,7 @@
           add-handler (fn [state [_event-id num]] (+ state num))
           frame (-> (make-test-frame-with-log-recording)
                   (frame/register-event-handler :add add-handler))]
-      (frame/process-events-on-atom frame db [[:add 1] [:add 2]])
+      (frame/process-events-on-atom! frame db [[:add 1] [:add 2]])
       (is (= @db 3))
       (is (= @reset-counter 2))))
   (testing "process multiple events on atom with coallesced write"
@@ -122,7 +122,7 @@
           add-handler (fn [state [_event-id num]] (+ state num))
           frame (-> (make-test-frame-with-log-recording)
                   (frame/register-event-handler :add add-handler))]
-      (frame/process-events-on-atom-with-coallesced-write frame db [[:add 1] [:add 2]])
+      (frame/process-events-on-atom-with-coallesced-write! frame db [[:add 1] [:add 2]])
       (is (= @db 3))
       (is (= @reset-counter 1)))))