grimoire.things — org.clojure-grimoire/lib-grimoire 0.10.10

This namespace implements a "thing" structure, approximating a URI, for uniquely naming and referencing entities in a Grimoire documentation store.

Thing ::= Sum[Group, Artifact, Version, Platform, Namespace, Def, Note, Example]; Group ::= Record[ Name: String]; Artifact ::= Record[Parent: Group, Name: String]; Version ::= Record[Parent: Artifact, Name: String]; Platform ::= Record[Parent: Version, Name: String]; Namespace ::= Record[Parent: Platform, Name: String]; Def ::= Record[Parent: Namespace, Name: String];

Note ::= Record[Parent: Thing, Handle: String]; Example ::= Record[Parent: Thing, Handle: String];

->artifact clj

(->artifact parent name)

Generated constructor for the artifact type.

->def clj

(->def parent name)

Generated constructor for the def type.

->example clj

(->example parent name handle)

Generated constructor for the example type.

->group clj

(->group name)

Generated constructor for the group type.

->namespace clj

(->namespace parent name)

Generated constructor for the namespace type.

->note clj

(->note parent name handle)

Generated constructor for the note type.

->platform clj

(->platform parent name)

Generated constructor for the platform type.

->version clj

(->version parent name)

Generated constructor for the version type.

artifact? clj

(artifact? x__5843__auto__)

Generated predicate for the artifact type.

artifacted? clj

(artifacted? t)

Predicate testing whether the input either is an artifact or has an artifact as a parent.

def? clj

(def? x__5843__auto__)

Generated predicate for the def type.

ensure-thing clj

(ensure-thing maybe-thing)

Transformer which, if given a string, will construct a Thing (with a warning) and if given a Thing will return the Thing without modification. Intended as a guard for potentially mixed input situations.

example? clj

(example? x__5843__auto__)

Generated predicate for the example type.

full-uri->thing clj

(full-uri->thing uri-string)

Complement of thing->full-uri.

full-uri-pattern clj

group? clj

(group? x__5843__auto__)

Generated predicate for the group type.

grouped? clj

(grouped? t)

Predicate testing whether the input either is a group or has a group as a parent.

leaf? clj

(leaf? t)

Predicate testing whether the input Thing is either an example or a note.

namespace? clj

(namespace? x__5843__auto__)

Generated predicate for the namespace type.

namespaced? clj

(namespaced? t)

Predicate testing whether the input either is a namespace or has a namespace as a parent.

note? clj

(note? x__5843__auto__)

Generated predicate for the note type.

parse-short-string clj

(parse-short-string s)

Function from a String as generated by thing->short-string to one of either [:def nil nil nil <ns-name> <def-name>] or [:ns nil nil nil <ns-name>]. The intention is that this function can be used to parse short-strings into structures for which Things can be looked up out of a datastore. Returns nil on failure to parse.

path->thing clj

(path->thing path)

String to Thing transformer which builds a Thing tree by splitting on /. The resulting things are rooted on a Group as required by the definition of a Thing.

platform? clj

(platform? x__5843__auto__)

Generated predicate for the platform type.

platformed? clj

(platformed? t)

Predicate testing whether the input either is a platform or has a platform as a parent.

short-string-pattern clj

thing->artifact clj

(thing->artifact t)

Function from a Thing to an Artifact. If the Thing is rooted on an Artifact, or is an Artifact, traverses thing->parent until the rooting Artifact is reached and then returns that value. Otherwise returns nil.

thing->def clj

(thing->def t)

Function from a Thing to a Def. If the Thing either is a Def or is rooted on a Def, traverses thing->parent until the rooting Def is reached and then returns that value. Otherwise returns nil.

thing->full-uri clj

(thing->full-uri t)

Function from a Thing to a String representing a unique Thing naming URI.

URIs have the same structure as thing->url-path but are prefixed by <t>: where <t> is the lower cased name of the type of the input Thing.

For example, a Thing represeting org.clojure/clojure would give the full URI grim+artifact:org.clojure/clojure. A Thing representing org.clojure/clojure/1.6.0 would likewise be grim+version:org.clojure/clojure/1.6.0 and soforth.

thing->group clj

(thing->group t)

Function from a Thing to a Group. If the Thing is rooted on a Group, or is a Group, traverses thing->parent until a Group is produced. Otherwise returns nil.

thing->name clj

(thing->name t)

Function from an object to Maybe[String]. If the input is a thing, returns the name of the Thing. Otherwise returns nil.

thing->namespace clj

(thing->namespace t)

Function from a Thing to a Namespace. If the Thing is rooted on a Platform or is a Platform traverses thing->parent until the rooting Platform is reached and then returns that value. Otherwise returns nil.

thing->parent clj

(thing->parent t)

Function from any object to Maybe[Thing]. If the input is a thing, returns the parent (maybe nil) of that Thing. Otherwise returns nil.

thing->path clj

(thing->path t)

Provides a mechanism for converting one of the Handle objects into a cannonical "path" which can be serialized, deserialized and walked back into a Handle.

thing->platform clj

(thing->platform t)

Function from a Thing to a Platform. If the Thing is rooted on a Platform or is a Platform traverses thing->parent until the rooting Platform is reached and then returns that value. Otherwise returns nil.

thing->short-string clj

(thing->short-string t)

Function from a Thing to a String representing a mostly unique naming string.

Unlike thing->full-uri, thing->short-string will discard exact artifact, group and verison information instead giving only a URI with respect to the platform, namespace and name of a Thing.

For example, the Thing representing org.clojure/clojure/1.6.0/clj/clojure.core/+ would give the short string clj::clojure.core/+.

thing->type-name clj

(thing->type-name t)

thing->url-path clj

(thing->url-path t)

(thing->url-path t munge-fn)

Function from a Thing to a munged and URL safe Thing path

thing->version clj

(thing->version t)

Function from a Thing to a Verison. If the Thing is rooted on a Version or is a Version, traverses thing->parent until the rooting Version is reached and then returns that value. Otherwise returns nil.

thing? clj

(thing? t)

Predicate testing whether the input exists within the "thing" variant of Σ[Group, Artifact,Version, Platform, Namespace, Def]

url-path->thing clj

(url-path->thing url)

Function from a URL to a Thing. Complement of thing->url-path.

version? clj

(version? x__5843__auto__)

Generated predicate for the version type.

versioned? clj

(versioned? t)

Predicate testing whether the input exists within the subset of the "thing" variant which can be said to be "versioned" in that it is rooted on a Version instance and thus a version instance can be reached by upwards traversal.