Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use aero to namespace tagged literals and deprecate unqualified tags #53

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Use aero to namespace tagged literals and deprecate unqualified tags #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
201 changes: 127 additions & 74 deletions src/aero/core.cljc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,23 @@

(defmulti reader (fn [opts tag value] tag))

(defn- println-stderr [s]
(binding [*out* *err*]
(println s)))

(defn- make-warning-msg [old-tag new-tag]
(format "WARNING: #%s is decrecated; use #%s instead." old-tag new-tag))

(defn- namespace-tag [tag]
(symbol "aero" (str tag)))

(defmacro deprecate-reader
[dispatch-val]
`(defmethod reader ~dispatch-val [opts# tag# value#]
(let [new-tag# (namespace-tag tag#)]
(-> tag# (make-warning-msg new-tag#) println-stderr)
(reader opts# new-tag# value#))))

(defmethod reader :default
[_ tag value]
(cond
Expand All @@ -35,58 +52,75 @@
:else
(throw (ex-info (#?(:clj format :cljs gstring/format) "No reader for tag %s" tag) {:tag tag :value value}))))


(defn- env [s]
#?(:clj (System/getenv (str s)))
#?(:cljs (aget js/process.env s)))

(defmethod reader 'env
(defmethod reader 'aero/env
[opts tag value]
(env value))

(defmethod reader 'envf
(deprecate-reader 'env)

(defmethod reader 'aero/envf
[opts tag value]
(let [[fmt & args] value]
(apply #?(:clj format :cljs gstring/format) fmt
(map #(env (str %)) args))))

(defmethod reader 'prop
[opts tag value]
#?(:clj (System/getProperty (str value))
:cljs nil))
(deprecate-reader 'envf)

(defmethod reader 'aero/prop
[opts tag value]
#?(:clj (System/getProperty (str value))
:cljs nil))

(deprecate-reader 'prop)

(defmethod reader 'or
(defmethod reader 'aero/or
[opts tag value]
(first (filter some? value)))

(defmethod reader 'long
(deprecate-reader 'or)

(defmethod reader 'aero/long
[opts tag value]
#?(:clj (Long/parseLong (str value)))
#?(:cljs (js/parseInt (str value))))

(defmethod reader 'double
(deprecate-reader 'long)

(defmethod reader 'aero/double
[opts tag value]
#?(:clj (Double/parseDouble (str value)))
#?(:cljs (js/parseFloat (str value))))

(defmethod reader 'keyword
(deprecate-reader 'double)

(defmethod reader 'aero/keyword
[opts tag value]
(if (keyword? value)
value
(keyword (str value))))

(defmethod reader 'boolean
(deprecate-reader 'keyword)

(defmethod reader 'aero/boolean
[opts tag value]
#?(:clj (Boolean/parseBoolean (str value)))
#?(:cljs (= "true" (.toLowerCase (str value)))))

(defmethod reader 'profile
(deprecate-reader 'boolean)

(defmethod reader 'aero/profile
[{:keys [profile]} tag value]
(cond (contains? value profile) (get value profile)
(contains? value :default) (get value :default)
:otherwise nil))

(defmethod reader 'hostname
(deprecate-reader 'profile)

(defmethod reader 'aero/hostname
[{:keys [hostname]} tag value]
(let [hostn (or hostname #?(:clj (env "HOSTNAME")
:cljs (os.hostname)))]
Expand All @@ -98,7 +132,9 @@
value)
(get value :default))))

(defmethod reader 'user
(deprecate-reader 'hostname)

(defmethod reader 'aero/user
[{:keys [user]} tag value]
(let [user (or user (env "USER"))]
(or
Expand All @@ -109,26 +145,36 @@
value)
(get value :default))))

(defmethod reader 'include
(deprecate-reader 'user)

(defmethod reader 'aero/include
[{:keys [resolver source] :as opts} tag value]
(read-config
(if (map? resolver)
(get resolver value)
(resolver source value))
opts))
(if (map? resolver)
(get resolver value)
(resolver source value))
opts))

(deprecate-reader 'include)

(defmethod reader 'join
(defmethod reader 'aero/join
[opts tag value]
(apply str value))

(defmethod reader 'read-edn
(deprecate-reader 'join)

(defmethod reader 'aero/read-edn
[opts tag value]
(some-> value str edn/read-string))

(defmethod aero.core/reader 'merge
(deprecate-reader 'read-edn)

(defmethod reader 'aero/merge
[opts tag values]
(apply merge values))

(deprecate-reader 'merge)

(defn- get-in-ref
[config]
(letfn [(get-in-conf [m]
Expand Down Expand Up @@ -215,25 +261,30 @@

(defn- tag-wrapper-of-ref?
[x]
(tag-wrapper-of? x 'ref))
(if (tag-wrapper-of? x 'ref)
(do
(println-stderr (make-warning-msg 'ref 'aero/ref))
true)
(tag-wrapper-of? x 'aero/ref)))

(defn- resolve-tag-wrappers
[tagged-config tag-fn]
(postwalk
(fn [x]
(if (tag-wrapper? x)
(tag-fn (:tag x) (:value x))
x))
tagged-config))
(fn [x]
(if (tag-wrapper? x)
(tag-fn (:tag x) (:value x))
x))
tagged-config))

(defn- ref-meta-to-tag-wrapper
[config]
(letfn [(get-in-conf [m]
(postwalk
(fn [v]
(if-not (contains? (meta v) :ref)
v
(tag-wrapper 'ref v)))
m))]
(fn [v]
(if-not (contains? (meta v) :ref)
v
(tag-wrapper 'aero/ref v)))
m))]
(get-in-conf config)))

(defn pathify
Expand Down Expand Up @@ -275,56 +326,58 @@
"Recursively checks a ref for nested dependencies"
[ref*]
(let [nested-deps (sequence
(comp (filter tag-wrapper-of-ref?)
(map :value))
(:value ref*))]
(comp (filter tag-wrapper-of-ref?)
(map :value))
(:value ref*))]
(concat
(when-some [r (ref-dependency ref*)] [r])
(when (seq nested-deps)
(concat nested-deps
(->> nested-deps
(mapcat ref-dependencies)))))))
(when-some [r (ref-dependency ref*)] [r])
(when (seq nested-deps)
(concat nested-deps
(->> nested-deps
(mapcat ref-dependencies)))))))

(defn config->ref-graph
[config]
(reduce
(fn [graph [k v]]
(as-> graph %
(reduce (fn [acc sk] (dep/depend acc sk k)) % (shorter-variations k))
(reduce (fn [acc sk] (dep/depend acc k sk)) % (shorter-variations (:value v)))
(reduce (fn [acc d] (dep/depend acc k d)) % (ref-dependencies v))))
(dep/graph)
(filter
(comp tag-wrapper-of-ref? second)
(pathify conj [] config))))
(fn [graph [k v]]
(as-> graph %
(reduce (fn [acc sk] (dep/depend acc sk k)) % (shorter-variations k))
(reduce (fn [acc sk] (dep/depend acc k sk)) % (shorter-variations (:value v)))
(reduce (fn [acc d] (dep/depend acc k d)) % (ref-dependencies v))))
(dep/graph)
(filter
(comp tag-wrapper-of-ref? second)
(pathify conj [] config))))



(defn resolve-refs
"Resolves refs & any necessary tags in order to do it's job"
[config resolve-fn]
(reduce
(fn [acc ks]
(let [resolved-ks (map
(fn [x]
;; if there's a sub-ref here, it should already be
;; a value due to recursive deps being resolved for
;; us
(if (tag-wrapper-of-ref? x)
(get-in acc (ref-dependency x))
x))
ks)
b (get-in acc resolved-ks)]
(cond
(tag-wrapper-of-ref? b)
(assoc-in acc resolved-ks (get-in acc (ref-dependency b)))
(tag-wrapper? b)
(assoc-in acc
resolved-ks
(resolve-fn (:tag b)
(resolve-tag-wrappers (:value b) resolve-fn)))
:else
acc)))
config
(dep/topo-sort (config->ref-graph config))))
(fn [acc ks]
(let [resolved-ks (map
(fn [x]
;; if there's a sub-ref here, it should already be
;; a value due to recursive deps being resolved for
;; us
(if (tag-wrapper-of-ref? x)
(get-in acc (ref-dependency x))
x))
ks)
b (get-in acc resolved-ks)]
(cond
(tag-wrapper-of-ref? b)
(assoc-in acc resolved-ks (get-in acc (ref-dependency b)))
(tag-wrapper? b)
(assoc-in acc
resolved-ks
(resolve-fn (:tag b)
(resolve-tag-wrappers (:value b) resolve-fn)))
:else
acc)))
config
(dep/topo-sort (config->ref-graph config))))

(defn read-config-into-tag-wrapper
[source]
Expand Down
50 changes: 25 additions & 25 deletions test/aero/config.edn
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,33 +1,33 @@
{:greeting "Hello World!"
:flavor #myflavor :favorite
:dumb-term #join ["Terminal is " #env TERM]
:smart-term #join ["Terminal is " #or [#env NONE "smart"]]
:dumb-term-envf #envf ["Terminal is %s" TERM]
:flavor-string #join ["My favorite flavor is " #or [#env TERM "flaa"] " " #myflavor :favorite]
:flavor #my/flavor :favorite
:dumb-term #aero/join ["Terminal is " #aero/env TERM]
:smart-term #aero/join ["Terminal is " #aero/or [#aero/env NONE "smart"]]
:dumb-term-envf #aero/envf ["Terminal is %s" TERM]
:flavor-string #aero/join ["My favorite flavor is " #aero/or [#aero/env TERM "flaa"] " " #my/flavor :favorite]
:test ^:ref [:greeting]
:remote #include "included.edn"
:remote #aero/include "included.edn"
:test-nested ^:ref [:test]
:port #profile {:dev 8000
:prod 80}
:True-boolean #boolean "True"
:true-boolean #boolean "true"
:false-boolean #boolean "false"
:trivial-false-boolean #boolean "OTHER"
:nil-false-boolean #boolean ""
:long #long "1234"
:double #double "4567.8"
:keyword #keyword "foo/bar"
:already-a-keyword #keyword :foo/bar
:env-keyword #keyword #or [#env KEYWORD "abc"]
:dummy #or [#env "DUMMY" "dummy"]
:triple-or #or [#env "DUMMY" #prop "DUMMY" "dummy"]
:prop #prop "DUMMY"
:network-call #expensive-network-call 7
:test-read-str #read-edn "[:foo :bar :baz]"
:test-read-env #read-edn #prop DUMMY_READ
:port #aero/profile {:dev 8000
:prod 80}
:True-boolean #aero/boolean "True"
:true-boolean #aero/boolean "true"
:false-boolean #aero/boolean "false"
:trivial-false-boolean #aero/boolean "OTHER"
:nil-false-boolean #aero/boolean ""
:long #aero/long "1234"
:double #aero/double "4567.8"
:keyword #aero/keyword "foo/bar"
:already-a-keyword #aero/keyword :foo/bar
:env-keyword #aero/keyword #aero/or [#aero/env KEYWORD "abc"]
:dummy #aero/or [#aero/env "DUMMY" "dummy"]
:triple-or #aero/or [#aero/env "DUMMY" #aero/prop "DUMMY" "dummy"]
:prop #aero/prop "DUMMY"
:network-call #my/expensive-network-call 7
:test-read-str #aero/read-edn "[:foo :bar :baz]"
:test-read-env #aero/read-edn #aero/prop DUMMY_READ

:referencing-network-call ^:ref [:network-call]

:key-part :b
:refer-me {:a {:b {1234 :sentinel}}}
:complex-ref #ref [:refer-me :a #ref [:key-part] #ref [:long]]}
:complex-ref #aero/ref [:refer-me :a #aero/ref [:key-part] #aero/ref [:long]]}
Loading