Add annotate and describe functions

Author: weavejester

src/integrant/core.cljc

@@ -7,6 +7,21 @@
             [clojure.string :as str]
             [weavejester.dependency :as dep]))
 
+(def ^:private registry (atom {}))
+
+(defn annotate
+  "Annotate a namespaced keyword with a map of metadata that will be stored in a
+  global registry. Use [[describe]] to retrieve the keyword annotation map."
+  [kw metadata]
+  {:pre [(qualified-keyword? kw) (map? metadata)]}
+  (swap! registry assoc kw metadata))
+
+(defn describe
+  "Return the annotation map for a namespaced keyword."
+  [kw]
+  {:pre [(qualified-keyword? kw)]}
+  (@registry kw))
+
 (defprotocol RefLike
   (ref-key [r] "Return the key of the reference.")
   (ref-resolve [r config resolvef] "Return the resolved value."))

test/integrant/core_test.cljc

@@ -73,6 +73,12 @@
 (defn- init-example [v]
   (str "init" v))
 
+(deftest annotate-describe-test
+  (ig/annotate ::foo {:doc "A test keyword"})
+  (ig/annotate ::bar {:doc "Another test keyword"})
+  (is (= {:doc "A test keyword"} (ig/describe ::foo)))
+  (is (= {:doc "Another test keyword"} (ig/describe ::bar))))
+
 (deftest ref-test
   (is (ig/ref? (ig/ref ::foo)))
   (is (ig/ref? (ig/ref [::foo ::bar])))