active.clojure.config — de.active-group/active-clojure 0.42.2

Application configuration via a big map.

A configuration is a nested key-value map.

It contains top-level settings and sections of qualified settings, like so:

{:top-level-setting-key 'foo
 {:section-key
  {:section-setting 'bar}}}

Additionally, a config contains profiles with additional settings that can be mixed in, like so:

{:top-level-setting-key 'foo
 {:section-key
  {:section-setting 'bar}}
 {:profiles
  {:dev
   {:top-level-setting-key 'bar
    {:section-key
     {:section-setting 'baz}}}}}}

Each profile has the same format as the top-level configuration itself (sans the :profiles key).

access clj/s

(access config setting-or-section & sections)

Access the value of a setting or map of a section.

Note that the setting comes first, followed by the access path.

• setting-or-section is either a setting, section or an index into a sequence schema.
• sections is a list of sections and indices into sequence schemas

access-lens clj/s

(access-lens setting-or-section & sections)

A lens focussing on the value of a setting or map of a section. Both the yanker and the shover use access to check the validity of the structure of the given configuration object and to signal errors otherwise. Additionally, the shover completes the given value according to the range or schema.

Note that the setting comes first, followed by the access path.

• setting-or-section is either a setting, section or an index into a sequence schema.
• sections is a list of sections and indices into sequence schemas

any-range clj/s

(any-range & rs)

Range that satisfies one of the ranges, tried from left to right.

any-value-range clj/s

(any-value-range dflt)

Range for any value at all.

boolean-range clj/s

(boolean-range dflt)

Range for a boolean, with explicit default.

boolean? clj/s

(boolean? x)

Check if a value is a boolean.

check-section clj/s

(check-section section val inherited-map path)

complete-section clj/s

(complete-section inherited-map path section)

complete-settings clj/s

(complete-settings inherited-map settings-map)

configuration-object clj/s≠

clj

(configuration-object rec__3628__auto__)

(configuration-object data__3629__auto__ v__3630__auto__)

cljs

(configuration-object rec__3284__auto__)

(configuration-object data__3285__auto__ v__3286__auto__)

Lens for the object field from a [[Configuration]] record. See active.clojure.config/really-make-configuration.

configuration-schema clj/s≠

clj

(configuration-schema rec__3628__auto__)

(configuration-schema data__3629__auto__ v__3630__auto__)

cljs

(configuration-schema rec__3284__auto__)

(configuration-schema data__3285__auto__ v__3286__auto__)

Lens for the schema field from a [[Configuration]] record. See active.clojure.config/really-make-configuration.

configuration? clj/s

(configuration? thing)

Is object a Configuration record? See active.clojure.config/really-make-configuration.

default-string-range clj/s

(default-string-range dflt)

diff-configuration-objects clj/s

(diff-configuration-objects schema config-object-1 config-object-2)

Returns sequence of triples [path-vector version-1 version-2] of settings that differ.

The config objects must be validated and completed.

diff-configurations clj/s

(diff-configurations schema config-1 config-2)

Returns sequence of triples [path-vectors version-1 version-2] of settings that differ.

diff-setting-values clj/s

(diff-setting-values setting path v1 v2)

Returns sequence of triples [path-vector version-1 version-2] of settings that differ. Handles some ranges more intelligently.

integer-between-range clj/s

(integer-between-range min max dflt)

Range for an integer from a specified range, with explicit default.

keyword-range clj/s

make-configuration clj/s

(make-configuration schema profile-names config-object)

Make a configuration from a map.

make-map-schema clj/s

(make-map-schema description settings settings-map sections sections-map)

Make a [[Schema]] object describing a config format. For internal use; you should use schema.

• description is a human-readable description
• settings is a collection of [[Setting]]s
• settings-map is a map from setting keys to settings
• sections is a collection of [[Section]]s
• sections-map is a map from section keys to sections

make-range clj/s

(make-range description completer reduce)

(make-range description completer reduce diff)

make-range-error clj/s

(make-range-error range path value)

Make a a [[RangeError]] object describing an error from range checking.

• range is the range that caused the error
• path is the path in the configuration that describes where the error is.
• value is the value that was wrong.

range can be nil' ifkey` does not appear in the schema.

make-scalar-range clj/s

(make-scalar-range description completer)

(make-scalar-range description completer diff)

Make a range for unstructured, non-collection ranges.

make-section clj/s

(make-section key schema inherit?)

Construct a Section (Section within a config with settings of its own.) record.

key: access via active.clojure.config/section-key schema: access via active.clojure.config/section-schema inherit?: access via active.clojure.config/section-inherit?

make-sequence-schema clj/s

(make-sequence-schema description element-schema non-empty?)

Construct a SequenceSchema (A sequence schema describes a sequence config format.) record.

description: access via active.clojure.config/sequence-schema-description element-schema: access via active.clojure.config/sequence-schema-element-schema non-empty?: access via active.clojure.config/sequence-schema-non-empty?

make-setting clj/s

(make-setting key description range inherit?)

Make a named schema [[Setting]] object.

• key is a keyword naming the setting
• description is a human-readable description object
• range is a [[Range]] for the admissible values of the setting
• inherit? says whether the setting values may be inherited from a surrounding section

map-of-range clj/s

(map-of-range key-range val-range)

Range for a map with keys and values of underlying ranges, respectively.

map-of-ranges-diff-fn clj/s

(map-of-ranges-diff-fn range)

map-schema-description clj/s≠

clj

(map-schema-description rec__3628__auto__)

(map-schema-description data__3629__auto__ v__3630__auto__)

cljs

(map-schema-description rec__3284__auto__)

(map-schema-description data__3285__auto__ v__3286__auto__)

Lens for the description field from a [[Schema]] record. See active.clojure.config/make-map-schema.

map-schema-sections clj/s≠

clj

(map-schema-sections rec__3628__auto__)

(map-schema-sections data__3629__auto__ v__3630__auto__)

cljs

(map-schema-sections rec__3284__auto__)

(map-schema-sections data__3285__auto__ v__3286__auto__)

Lens for the sections field from a [[Schema]] record. See active.clojure.config/make-map-schema.

map-schema-sections-map clj/s≠

clj

(map-schema-sections-map rec__3628__auto__)

(map-schema-sections-map data__3629__auto__ v__3630__auto__)

cljs

(map-schema-sections-map rec__3284__auto__)

(map-schema-sections-map data__3285__auto__ v__3286__auto__)

Lens for the sections-map field from a [[Schema]] record. See active.clojure.config/make-map-schema.

map-schema-settings clj/s≠

clj

(map-schema-settings rec__3628__auto__)

(map-schema-settings data__3629__auto__ v__3630__auto__)

cljs

(map-schema-settings rec__3284__auto__)

(map-schema-settings data__3285__auto__ v__3286__auto__)

Lens for the settings field from a [[Schema]] record. See active.clojure.config/make-map-schema.

map-schema-settings-map clj/s≠

clj

(map-schema-settings-map rec__3628__auto__)

(map-schema-settings-map data__3629__auto__ v__3630__auto__)

cljs

(map-schema-settings-map rec__3284__auto__)

(map-schema-settings-map data__3285__auto__ v__3286__auto__)

Lens for the settings-map field from a [[Schema]] record. See active.clojure.config/make-map-schema.

map-schema? clj/s

(map-schema? thing)

Is object a Schema record? See active.clojure.config/make-map-schema.

max-string-range clj/s

(max-string-range max-length)

merge-config-objects clj/s

(merge-config-objects schema c)

(merge-config-objects schema c1 c2)

(merge-config-objects schema c1 c2 & cs)

Merge several config maps into one, with the latter taking precedence.

non-nil-range clj/s

Range for any non-nil value.

nonempty-sequence-schema clj/s

(nonempty-sequence-schema desc el-schema)

nonempty-string-range clj/s

(nonempty-string-range & [max-length])

Range for a non-empty string with optional max length.

normalize&check-config-object clj/s

(normalize&check-config-object schema profile-names config)

(normalize&check-config-object schema profile-names config inherited-map path)

Normalize and check the validity of a configuration object.

In the result, every setting has an associated value.

one-of-range clj/s

(one-of-range vals dflt)

Range for one of a set of values, with explicit default.

one-of-range-custom-compare clj/s

(one-of-range-custom-compare vals dflt compare-fn)

Range for one of a set of values, with custom compare function, with explicit default.

optional-default-range clj/s

(optional-default-range range dflt)

Range for something that may be in an underlying range. If it is nil, then dflt is used, which must be in the underlying range too.

optional-range clj/s

(optional-range range)

Range for something that may be in an underlying range or nil.

or-dot-range clj/s

(or-dot-range r)

Given range r is required in the first line, the remainder of the lines the field holds ".".

predicate-range clj/s

(predicate-range desc pred dflt)

Range specified by a simple predicate.

range-completer clj/s≠

clj

(range-completer rec__3628__auto__)

(range-completer data__3629__auto__ v__3630__auto__)

cljs

(range-completer rec__3284__auto__)

(range-completer data__3285__auto__ v__3286__auto__)

Lens for the completer field from a [[ValueRange]] record. See active.clojure.config/really-make-range.

range-description clj/s≠

clj

(range-description rec__3628__auto__)

(range-description data__3629__auto__ v__3630__auto__)

cljs

(range-description rec__3284__auto__)

(range-description data__3285__auto__ v__3286__auto__)

Lens for the description field from a [[ValueRange]] record. See active.clojure.config/really-make-range.

range-diff clj/s≠

clj

(range-diff rec__3628__auto__)

(range-diff data__3629__auto__ v__3630__auto__)

cljs

(range-diff rec__3284__auto__)

(range-diff data__3285__auto__ v__3286__auto__)

Lens for the diff field from a [[ValueRange]] record. See active.clojure.config/really-make-range.

range-error-path clj/s≠

clj

(range-error-path rec__3628__auto__)

(range-error-path data__3629__auto__ v__3630__auto__)

cljs

(range-error-path rec__3284__auto__)

(range-error-path data__3285__auto__ v__3286__auto__)

Lens for the path field from a [[RangeError]] record. See active.clojure.config/make-range-error.

range-error-range clj/s≠

clj

(range-error-range rec__3628__auto__)

(range-error-range data__3629__auto__ v__3630__auto__)

cljs

(range-error-range rec__3284__auto__)

(range-error-range data__3285__auto__ v__3286__auto__)

Lens for the range field from a [[RangeError]] record. See active.clojure.config/make-range-error.

range-error-value clj/s≠

clj

(range-error-value rec__3628__auto__)

(range-error-value data__3629__auto__ v__3630__auto__)

cljs

(range-error-value rec__3284__auto__)

(range-error-value data__3285__auto__ v__3286__auto__)

Lens for the value field from a [[RangeError]] record. See active.clojure.config/make-range-error.

range-error? clj/s

(range-error? thing)

Is object a RangeError record? See active.clojure.config/make-range-error.

range-map clj/s

(range-map descr range f & args)

Range constructed by transforming values matching an existing range.

range-reduce clj/s≠

clj

(range-reduce rec__3628__auto__)

(range-reduce data__3629__auto__ v__3630__auto__)

cljs

(range-reduce rec__3284__auto__)

(range-reduce data__3285__auto__ v__3286__auto__)

Lens for the reduce field from a [[ValueRange]] record. See active.clojure.config/really-make-range.

range? clj/s

(range? thing)

Is object a ValueRange record? See active.clojure.config/really-make-range.

really-make-configuration clj/s

(really-make-configuration object schema)

Construct a Configuration (Validated and expanded configuration object.) record.

object: access via active.clojure.config/configuration-object schema: access via active.clojure.config/configuration-schema

really-make-range clj/s

(really-make-range description completer reduce diff)

Make a [[Range]] range object.

• `description' is a human-readable string
• `completer' is a function that accepts a range, a path, and a value, and either returns a "completed" value that takes defaults etc. into account, or a [[RangeError]] object.
• reduce is a function accepting a range, a path, a function, an initial result, and a value, reducing collection values similar to clojure [[reduce]], calling (f range path res v) on all scalar values.
• diff is a function accepting two values that returns a sequence of [path v1 v2], see diff functions below

scalar-range-reduce clj/s

(scalar-range-reduce completer)

schema clj/s

(schema description & element-list)

Construct a map schema.

• description is a human-readable description
• `element-list' is a list of the [[Setting]]s and [[Section]]s of the schema

schema-range clj/s

(schema-range schema)

Range for a configuration object matching a schema.

section clj/s

(section key schema & {:keys [inherit?]})

Make a section within a config with settings of its own.

section-inherit? clj/s≠

clj

(section-inherit? rec__3628__auto__)

(section-inherit? data__3629__auto__ v__3630__auto__)

cljs

(section-inherit? rec__3284__auto__)

(section-inherit? data__3285__auto__ v__3286__auto__)

Lens for the inherit? field from a [[Section]] record. See active.clojure.config/make-section.

section-key clj/s≠

clj

(section-key rec__3628__auto__)

(section-key data__3629__auto__ v__3630__auto__)

cljs

(section-key rec__3284__auto__)

(section-key data__3285__auto__ v__3286__auto__)

Lens for the key field from a [[Section]] record. See active.clojure.config/make-section.

section-schema clj/s≠

clj

(section-schema rec__3628__auto__)

(section-schema data__3629__auto__ v__3630__auto__)

cljs

(section-schema rec__3284__auto__)

(section-schema data__3285__auto__ v__3286__auto__)

Lens for the schema field from a [[Section]] record. See active.clojure.config/make-section.

section-subconfig clj/s

(section-subconfig config & sections)

Extract a section from a config as a config.

section-subconfig-lens clj/s

(section-subconfig-lens & sections)

section? clj/s

(section? thing)

Is object a Section record? See active.clojure.config/make-section.

sections->lens clj/s

(sections->lens sections)

sequable? clj/s

(sequable? thing)

Test if something can be coerced to a seq.

sequence-of-range clj/s

(sequence-of-range range)

Range for a sequence of values of an underlying range.

sequence-schema clj/s

(sequence-schema desc el-schema)

sequence-schema-description clj/s≠

clj

(sequence-schema-description rec__3628__auto__)

(sequence-schema-description data__3629__auto__ v__3630__auto__)

cljs

(sequence-schema-description rec__3284__auto__)

(sequence-schema-description data__3285__auto__ v__3286__auto__)

Lens for the description field from a [[SequenceSchema]] record. See active.clojure.config/make-sequence-schema.

sequence-schema-element-schema clj/s≠

clj

(sequence-schema-element-schema rec__3628__auto__)

(sequence-schema-element-schema data__3629__auto__ v__3630__auto__)

cljs

(sequence-schema-element-schema rec__3284__auto__)

(sequence-schema-element-schema data__3285__auto__ v__3286__auto__)

Lens for the element-schema field from a [[SequenceSchema]] record. See active.clojure.config/make-sequence-schema.

sequence-schema-non-empty? clj/s≠

clj

(sequence-schema-non-empty? rec__3628__auto__)

(sequence-schema-non-empty? data__3629__auto__ v__3630__auto__)

cljs

(sequence-schema-non-empty? rec__3284__auto__)

(sequence-schema-non-empty? data__3285__auto__ v__3286__auto__)

Lens for the non-empty? field from a [[SequenceSchema]] record. See active.clojure.config/make-sequence-schema.

sequence-schema-subconfig-lens clj/s

(sequence-schema-subconfig-lens & sections)

sequence-schema? clj/s

(sequence-schema? thing)

Is object a SequenceSchema record? See active.clojure.config/make-sequence-schema.

set-of-range clj/s

(set-of-range range)

Range for a set of values of an underlying range.

setting clj/s

(setting key description range & {:keys [inherit?]})

Construct a setting.

• key is a keyword naming the setting
• description is a human-readable description object
• range is a [[Range]] for the admissible values of the setting
• inherit? says whether the setting values may be inherited from a surrounding section

setting-default-value clj/s

(setting-default-value setting)

Compute the default value for a setting.

setting-description clj/s≠

clj

(setting-description rec__3628__auto__)

(setting-description data__3629__auto__ v__3630__auto__)

cljs

(setting-description rec__3284__auto__)

(setting-description data__3285__auto__ v__3286__auto__)

Lens for the description field from a [[Setting]] record. See active.clojure.config/make-setting.

setting-inherit? clj/s≠

clj

(setting-inherit? rec__3628__auto__)

(setting-inherit? data__3629__auto__ v__3630__auto__)

cljs

(setting-inherit? rec__3284__auto__)

(setting-inherit? data__3285__auto__ v__3286__auto__)

Lens for the inherit? field from a [[Setting]] record. See active.clojure.config/make-setting.

setting-key clj/s≠

clj

(setting-key rec__3628__auto__)

(setting-key data__3629__auto__ v__3630__auto__)

cljs

(setting-key rec__3284__auto__)

(setting-key data__3285__auto__ v__3286__auto__)

Lens for the key field from a [[Setting]] record. See active.clojure.config/make-setting.

setting-range clj/s≠

clj

(setting-range rec__3628__auto__)

(setting-range data__3629__auto__ v__3630__auto__)

cljs

(setting-range rec__3284__auto__)

(setting-range data__3285__auto__ v__3286__auto__)

Lens for the range field from a [[Setting]] record. See active.clojure.config/make-setting.

setting? clj/s

(setting? thing)

Is object a Setting record? See active.clojure.config/make-setting.

slurpable-range clj

Range for something that may be passed to [[slurp]].

string-range clj/s

Range for an abitrary string, default is empty string.

tuple-of-range clj/s

(tuple-of-range & rs)

Range for a sequence of mixed underlying ranges.