Liking cljdoc? Tell your friends :D
Clojure only.
effective.core
effectcljmacro
(effect form config)Asserts modifications specified by config using the clojure.test API.
form is a Clojure form representing the effect to test.
config is expected to be a collection of monitor configurations. Each of
those to be a hashmap with the following keys:
| key | required? | description |
|---|---|---|
:changes | yes | expression to evaluate |
:from | no | expected value of :changes before the effect |
:to | no | expected value of :changes after the effect |
:by | no | expected numerical difference of :changes |
| before and after the effect |
Examples:
(let [x (atom 10)]
(effect (swap! x inc)
[{:changes @x
:from 0
:to 1}]))
expands to the following:
(let [x (atom 10)]
(let [before-0 @x
_ (swap! x inc)
after-0 @x]
(is (= 0 before-0) ":from check failed")
(is (= 1 after-0) ":to check failed")))
Multiple expressions can be monitored for changes:
(let [x (atom {:a 100 :b -2})]
(effect (swap! assoc :a 0 :b 10)
[{:changes (:a @x) :by -100}
{:changes (:b @x) :to 2}]))
expands to the following:
(let [x (atom {:a 100 :b -2})]
(let [before-0 (:a @x)
before-1 (:b @x)
_ (swap! x assoc :a 0 :b 10)
after-0 (:a @x)
after-1 (:b @x)]
(is (= -100 (- after-0 before-0)) ":by check failed")
(is (= 2 after-1) ":to check failed")))
Asserts modifications specified by `config` using the `clojure.test` API.
`form` is a Clojure form representing the effect to test.
`config` is expected to be a collection of monitor configurations. Each of
those to be a hashmap with the following keys:
| key | required? | description |
| ---------- | --------- | ------------------------------------------------ |
| `:changes` | **yes** | expression to evaluate |
| `:from` | **no** | expected value of `:changes` before the effect |
| `:to` | **no** | expected value of `:changes` after the effect |
| `:by` | **no** | expected numerical difference of `:changes` |
| | | before and after the effect |
**Examples**:
``` clojure
(let [x (atom 10)]
(effect (swap! x inc)
[{:changes @x
:from 0
:to 1}]))
```
expands to the following:
``` clojure
(let [x (atom 10)]
(let [before-0 @x
_ (swap! x inc)
after-0 @x]
(is (= 0 before-0) ":from check failed")
(is (= 1 after-0) ":to check failed")))
```
Multiple expressions can be monitored for changes:
``` clojure
(let [x (atom {:a 100 :b -2})]
(effect (swap! assoc :a 0 :b 10)
[{:changes (:a @x) :by -100}
{:changes (:b @x) :to 2}]))
```
expands to the following:
``` clojure
(let [x (atom {:a 100 :b -2})]
(let [before-0 (:a @x)
before-1 (:b @x)
_ (swap! x assoc :a 0 :b 10)
after-0 (:a @x)
after-1 (:b @x)]
(is (= -100 (- after-0 before-0)) ":by check failed")
(is (= 2 after-1) ":to check failed")))
```cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close