fr.jeremyschoffen.prose.alpha.eval.common — io.github.pfeodrippe/dev-tooling 1.0.2

Api providing tools to facilitate the evaluation of documents.

*evaluation-env* clj/s

A intended to be bound to a map containing data about an evaluation. This is intented to be the input / environment of an evaluation.

bind-env clj/s macro

(bind-env bindings & body)

Utility allowing to merge kvs keys to the *evaluation-env* map.

Args:

• bindings: a map that will be merged into *evaluation-env*.
• body: code to execute in this new environment.

eval-forms clj/s

(eval-forms forms)

(eval-forms eval-form forms)

Evaluate a sequence of forms ensuring the the current namespace doesn't change after the evaluation.

eval-forms* clj/s

(eval-forms* eval-form forms)

Evaluate a sequences of forms forms in sequence with eval-form

eval-forms-in-temp-ns clj/s

(eval-forms-in-temp-ns forms)

(eval-forms-in-temp-ns eval-form forms)

Evaluate a sequence of forms in a temporary namespace.

Args:

• forms; a sequence of forms to eval
• eval-form: a function a evaluates one form defaulting to clojure.core/eval.

evaluate clj/s

(evaluate ef middleware forms)

Evaluate a sequence of forms in order. Returns the sequence of evaluations.

To do so an evaluation context is created using make-evaluation-ctxt. This context is passed to evaluate-ctxt that has been wrapped with middleware.

Args:

• ef: an 'evaluate-form' function that take 1 form and returns the result of evaluating it.
• middleware: an 'evaluate-ctxt -> evaluate-ctxt' function
• forms: the sequence to forms to evaluate

evaluate-ctxt clj/s

(evaluate-ctxt {:keys [forms eval-form] :as ctxt})

Function evaluating a context (produced by make-evaluation-ctxt). Returns the context with one of two keys associated:

• :result: in the case of a successful evaluation the sequence of evaluations is returned here
• :error: in the case of an error, the exception is returned here.

get-env clj/s

(get-env)

(get-env key)

Get the evaluation environment or a specific key from it.

make-evaluation-ctxt clj/s

(make-evaluation-ctxt eval-form forms)

Make an evaluation context.

This context is a map of 2 keys:

• :forms: a sequence of forms to evaluate
• :eval-form: a function that evaluates one form

wrap-eval-form-exception clj/s

(wrap-eval-form-exception e)

Wraps an eval function so that exceptions thrown are caught and rethrown in an ex-info containing the form that threw in its ex-data.

wrap-eval-forms clj/s

Middleware used in eval-forms namely:

• wrap-eval-result
• wrap-snapshot-ns

wrap-eval-forms-in-temp-ns clj/s

Middleware used in eval-forms-in-temp-ns namely:

• wrap-eval-result
• wrap-snapshot-ns
• wrap-eval-in-temp-ns

wrap-eval-in-temp-ns clj/s

(wrap-eval-in-temp-ns eval-ctxt)

(wrap-eval-in-temp-ns eval-ctxt temp-ns)

Middleware that makes the evaluation take place in a temporary namespace.

wrap-eval-result clj/s

(wrap-eval-result eval-ctxt)

Middleware that either returns the result of the evaluation or throws any error raised.

wrap-snapshot-ns clj/s

(wrap-snapshot-ns eval-ctxt)

Middleware making sure the current ns stays the same after an evaluation.