systems.thoughtfull.assay.metrics.interface — systems.thoughtfull/assay 0.2.0

Measure Clojure source files and Polylith bricks.

averages clj

(averages measurements)

Each brick metric's mean across the measurements that have a value, or nil when none do. Metrics that only describe components, such as abstractness and afferent coupling, average components only.

column-text clj

(column-text column metrics)

A column's values from a map of metrics, joined with " / ".

columns clj

Ordered display columns for brick metrics, each a map of :label, :description (a short tooltip), :explanation (a longer legend entry), and :keys, the metrics it shows.

format-value clj

(format-value k v)

Brick metric k's value v for display: decimals to their precision, other whole numbers as they are and fractions (such as averages) to one place, and nil as a dash.

function-id clj

(function-id function)

A function's identity across a workspace: its name qualified by its namespace, since bricks often have same-named functions in different namespaces.

label clj

(label m)

The display label of a violation, or of any map of :metric and optionally :scope (:brick, the default, or :function). A :label in the map wins, then the registry's label, then the metric's name.

measure-brick clj

(measure-brick root brick)

Measure every source file of brick (as returned by the workspace component), reading files relative to root. Returns a map of :brick, :metrics (metric key to number, or nil when undefined), :functions, and :sources (each source file's :file, :ns, :requires, :forms, :definitions, :keywords, :fragments, :mutable-state, :throws, and :catches), and :tests, each test file as from measure-test-source.

measure-source clj

(measure-source file source)

Measure a string of Clojure source from file (a path used for locations). Returns a map of :file, :ns and :requires (from its ns form, if any), :forms, :top-level-forms, :functions (each also has :ns), :definitions, :keywords, :fragments, :mutable-state, :throws, :catches, and :interop (a count of Java interop forms).

Each definition (def, defn, defmulti, and so on) is a map of :name (a symbol), :line, :references, the set of symbols in its body, and :throws?, true if its body throws. Each function is a map of :name, :file, :line, :complexity, :depth (with :depth-line, the line of its deepest form), :forms, and :params. Each :mutable-state entry is a top-level atom, ref, agent, volatile, or dynamic var, or an alter-var-root call, as a map of :name, :line, and :kind. Each throw is a map of :line and :kind (:typed, :untyped, or :unknown ex-info, a :java exception, or a :rethrow), and each catch clause a map of :line, :class, and :broad?.

measure-test-source clj

(measure-test-source file source)

Measure a string of Clojure test source from file. Returns a map of :file, :ns and :requires (from its ns form), :forms, :tests (each deftest as {:name :line :forms :assertions}, counting is and are), :hazards (with-redefs, Thread/sleep, alter-var-root, and top-level mutable state, each {:line :kind}), and :references, every symbol in the file.

outlier-std-devs clj

How many standard deviations from the mean reports treat as an outlier.

outliers clj

(outliers measurements k)

Brick metrics at least k standard deviations from the mean of every brick that has a value, as a map of [brick-name metric-key] to :z (signed standard deviations from the mean), :mean, :std-dev (of the population), and :peers, :bricks or :components (for metrics that only describe components, which leave bases out). A metric needs at least 3 values and some variation.

sections clj

Report sections in order, each a map of :key, :label, and :columns, the columns (as in columns) it shows: dependencies, complexity, modularity, I/O and mutability, error handling, and tests.