com.mjdowney.rich-comment-tests — io.github.matthewdowney/rich-comment-tests v1.0.3

RCT turns rich comment forms into tests.

?comment-expectation-string clj

(?comment-expectation-string z)

?result-comment-zloc clj

(?result-comment-zloc z)

advance clj

(advance zloc & {:keys [to through] :as ops})

capture-clojure-test-out clj macro

(capture-clojure-test-out & body)

Capture any string output fom clojure.test while invoking body, and isolate test state.

clojure-test-reporting-active? clj

(clojure-test-reporting-active?)

context-strings clj

(context-strings test-sexpr-zloc)

A series of string comments preceding the test sexpr.

expectation-data clj

(expectation-data test-sexpr-zloc)

Parse a string representing the expectation for a test expression and an expression type, returning a vector of [type str] (or nil if none).

The expected result is designated by a =>-prefixed comment, either directly after or on a line following the test expression.

For example:

(+ 1 1) ;=> 2

(+ 1 1) ;;=> 2

(+ 1 1) ;; => 2

iterate1 clj

(iterate1 f x)

Like clojure.core/iterate, but stops at the first nil element.

pairs clj

(pairs)

Transducer from [a b c ... z] => [[a b] [b c] ... [z nil]].

rct-data-seq clj

(rct-data-seq rct-zloc)

Take an rct zloc and return a series of maps with information about tests to run.

rct-zlocs clj

(rct-zlocs source-file-root-zloc)

Given the root zloc for a source file, return a series of rct zlocs.

rct? clj

(rct? zloc)

Is the node at the zloc a ^:rct/test (comment ...) block?

require-file-for-ns clj

(require-file-for-ns ns)

Given a Namespace, attempt to find a corresponding source file, or throw an exception if this isn't possible.

result-comment-type clj

(result-comment-type z)

result-comment? clj

(result-comment? s)

A string like ";=> _" or ";=>> _" or ";; => _"

rsequence clj

(rsequence xform coll)

Like (reverse (sequence xform coll)).

run-file-tests! clj

(run-file-tests! file ns)

Take a file path and the namespace it corresponds to, and run tests.

run-ns-tests! clj

(run-ns-tests! ns)

Take a namespace or namespace symbol, attempt to find the corresponding source file, and run tests in the namespace.

run-tests* clj

(run-tests* zloc)

Take a rewrite-clj zipper pointed at the root of a file and run all rich comment tests.

The zipper must have be configured with {:track-position? true}.

ns and file should be bound before calling this.

tag? clj

(tag? x)

test-sexpr-zlocs clj

(test-sexpr-zlocs rct-zloc)

All sexpr-able nodes inside a rct form.

with-clojure-test-reporting clj macro

(with-clojure-test-reporting & body)

Run body with clojure.test reporting, unless it is already active.

with-printlns clj macro

(with-printlns & body)

Rebind println during the execution of body to print as normal, PLUS save each line of output, and return a vector of printed lines.