status-im
/
re-frame
mirror of https://github.com/status-im/re-frame.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Light edits on the inline Interceptor docs

This commit is contained in:
Mike Thompson 2017-07-20 09:46:35 +10:00
parent b98306f1a3
commit 522c3e4c1b
1 changed files with 32 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
src/re_frame/std_interceptors.cljc
View File

@ -21,8 +21,17 @@
Warning: calling clojure.data/diff on large, complex data structures Warning: calling clojure.data/diff on large, complex data structures
can be slow. So, you won't want this interceptor present in production can be slow. So, you won't want this interceptor present in production
code. See the todomvc example to see how to exclude interceptors from code. So condition it out like this:
production code."
(re-frame.core/reg-event
:evt-id
[(when ^boolean goog.DEBUG re-frame.core/debug)] ;; <-- conditional
(fn [db v]
...))
You'll also have to set goog.DEBUG to false in your production builds - look
in project.clj of the todomvc example in /examples.
"
(->interceptor (->interceptor
:id :debug :id :debug
:before (fn debug-before :before (fn debug-before
@ -72,7 +81,7 @@
;; -- Interceptor Factories - PART 1 --------------------------------------------------------------- ;; -- Interceptor Factories - PART 1 ---------------------------------------------------------------
;; ;;
;; These 3 factories wrap the 3 kinds of handlers. ;; These 3 factories wrap the 3 kinds of event handlers.
;; ;;
(defn db-handler->interceptor (defn db-handler->interceptor
@ -137,7 +146,7 @@
(defn path (defn path
"An interceptor factory which supplies a sub-path of `:db` to the handler. "An interceptor factory which supplies a sub-path of `:db` to the handler.
It's action is somewhat analogous to `update-in`. It grafts the return It's action is somewhat analogous to clojure's `update-in`. It grafts the return
value from the handler back into db. value from the handler back into db.
Usage: Usage:
@ -147,9 +156,8 @@
(path [:some :path] [:to] :here) (path [:some :path] [:to] :here)
Notes: Notes:
1. cater for `path` appearing more than once in an interceptor chain. 1. `path` may appear more than once in an interceptor chain
2. `:effects` may not contain `:db` effect. Which means no change to 2. if `:effects` contains no `:db` effect, can't graft a value back in.
`:db` should be made.
" "
[& args] [& args]
(let [path (flatten args) (let [path (flatten args)
@ -184,7 +192,7 @@
position. `f` is called with two arguments: `db` and `v`, and is expected to position. `f` is called with two arguments: `db` and `v`, and is expected to
return a modified `db`. return a modified `db`.
Unlike the `after` inteceptor which is only about side effects, `enrich` Unlike the `after` interceptor which is only about side effects, `enrich`
expects `f` to process and alter the given `db` coeffect in some useful way, expects `f` to process and alter the given `db` coeffect in some useful way,
contributing to the derived data, flowing vibe. contributing to the derived data, flowing vibe.
@ -192,11 +200,11 @@
------------ ------------
Imagine that todomvc needed to do duplicate detection - if any two todos had Imagine that todomvc needed to do duplicate detection - if any two todos had
the same text, then highlight their background, and report them in a warning the same text, then highlight their background, and report them via a warning
down the bottom of the panel. at the bottom of the panel.
Almost any user action (edit text, add new todo, remove a todo) requires a Almost any user action (edit text, add new todo, remove a todo) requires a
complete reassesment of duplication errors and warnings. Eg: that edit complete reassessment of duplication errors and warnings. Eg: that edit
just made might have introduced a new duplicate, or removed one. Same with just made might have introduced a new duplicate, or removed one. Same with
any todo removal. So we need to re-calculate warnings after any CRUD events any todo removal. So we need to re-calculate warnings after any CRUD events
associated with the todos list. associated with the todos list.
@ -204,23 +212,25 @@
Unless we are careful, we might end up coding subtly different checks Unless we are careful, we might end up coding subtly different checks
for each kind of CRUD operation. The duplicates check made after for each kind of CRUD operation. The duplicates check made after
'delete todo' event might be subtly different to that done after an 'delete todo' event might be subtly different to that done after an
eddting operation. Nice and efficient, but fiddly. A bug generator editing operation. Nice and efficient, but fiddly. A bug generator
approach. approach.
So, instead, we create an `f` which recalculates warnings from scratch So, instead, we create an `f` which recalculates ALL warnings from scratch
every time there is ANY change. It will inspect all the todos, and every time there is ANY change. It will inspect all the todos, and
reset ALL FLAGS every time (overwriting what was there previously) reset ALL FLAGS every time (overwriting what was there previously)
and fully recalculate the list of duplicates (displayed at the bottom?). and fully recalculate the list of duplicates (displayed at the bottom?).
https://twitter.com/nathanmarz/status/879722740776939520
By applying `f` in an `:enrich` interceptor, after every CRUD event, By applying `f` in an `:enrich` interceptor, after every CRUD event,
we keep the handlers simple and yet we ensure this important step we keep the handlers simple and yet we ensure this important step
(of getting warnings right) is not missed on any change. (of getting warnings right) is not missed on any change.
We can test `f` easily - it is a pure fucntions - independently of We can test `f` easily - it is a pure function - independently of
any CRUD operation. any CRUD operation.
This brings huge simplicity at the expense of some re-computation This brings huge simplicity at the expense of some re-computation
each time. This may be a very satisfactory tradeoff in many cases." each time. This may be a very satisfactory trade-off in many cases."
[f] [f]
(->interceptor (->interceptor
:id :enrich :id :enrich
@ -243,8 +253,8 @@
(or the `coeffect` value of db if no db effect is returned) and the event. (or the `coeffect` value of db if no db effect is returned) and the event.
Its return value is ignored so `f` can only side-effect. Its return value is ignored so `f` can only side-effect.
Example use: Examples use can be seen in the /examples/todomvc:
- `f` runs schema validation (reporting any errors found) - `f` runs schema validation (reporting any errors found).
- `f` writes some aspect of db to localstorage." - `f` writes some aspect of db to localstorage."
[f] [f]
(->interceptor (->interceptor
@ -260,10 +270,11 @@
(defn on-changes (defn on-changes
"Interceptor factory which acts a bit like `reaction` (but it flows into `db`, rather than out) "Interceptor factory which acts a bit like `reaction` (but it flows into
It observes N paths in `db` and if any of them test not indentical? to their previous value `db`, rather than out). It observes N paths within `db` and if any of them
(as a result of a handler being run) then it runs `f` to compute a new value, which is test not identical? to their previous value (as a result of a event handler
then assoced into the given `out-path` within `db`. being run) then it runs `f` to compute a new value, which is then assoc-ed
into the given `out-path` within `db`.
Usage: Usage: