Merge pull request #5 from juxt/master

update

Author: source-c

README.md

@@ -97,7 +97,7 @@ Aero provides a small library of tag literals.
 Use `#env` to reference an environment variable.
 
 ```clojure
-{:password #env DATABASE_URI}
+{:database-uri #env DATABASE_URI}
 ```
 
 It is considered bad practice to use environment variables for passwords and other confidential information. This is because it is very easy for anyone to read a process's environment (e.g. via `ps -ef`). Environment variables are also commonly dumped out in a debugging sessions. Instead you should use `#include` - see [here](#hide-passwords-in-local-private-files).
@@ -115,7 +115,7 @@ Use `#envf` to insert environment variables into a formatted string.
 Use `#or` when you want to provide a list of possibilities, perhaps with a default and the end.
 
 ```clojure
-{:password #or [#env PORT 8080]}
+{:port #or [#env PORT 8080]}
 ```
 
 ### join
@@ -133,7 +133,7 @@ Use `#or` when you want to provide a list of possibilities, perhaps with a defau
 
 Use profile as a kind of reader conditional.
 
-`#profile` expects a map, from which is extracts the entry corresponding to the of __profile__.
+`#profile` expects a map, from which it extracts the entry corresponding to the __profile__.
 
 ```clojure
 {:webserver
@@ -220,37 +220,37 @@ Merge multiple maps together
 #merge [{:foo :bar} {:foo :zip}]
 ```
 
-### Define your own
-
-Aero supports user-defined tag literals. Just extend the `reader` multimethod.
-
-```clojure
-(defmethod reader `mytag
- [{:keys [profile] :as opts} tag value]
-  (if (= value :favorite)
-     :chocolate
-     :vanilla))
-```
-
-## Using `^:ref` metadata for references
+### ref
 
-To avoid duplication you can refer to other parts of you configuration file using `^:ref` metadata.
+To avoid duplication you can refer to other parts of your configuration file using the `#ref` tag.
 
-The `^:ref` value should be a vector resolveable by `get-in`. Take the following config map for example:
+The `#ref` value should be a vector resolveable by `get-in`. Take the following config map for example:
 
 ```clojure
 {:db-connection "datomic:dynamo://dynamodb"
  :webserver
-  {:db ^:ref [:db-connection]}
+  {:db #ref [:db-connection]}
  :analytics
-  {:db ^:ref [:db-connection]}}
+  {:db #ref [:db-connection]}}
 ```
 
 Both `:analytics` and `:webserver` will have their `:db` keys resolved
 to `"datomic:dynamo://dynamodb"`
 
 References are recursive. They can be used in `#include` files.
 
+### Define your own
+
+Aero supports user-defined tag literals. Just extend the `reader` multimethod.
+
+```clojure
+(defmethod reader 'mytag
+ [{:keys [profile] :as opts} tag value]
+  (if (= value :favorite)
+     :chocolate
+     :vanilla))
+```
+
 ## Deferreds
 
 Sometimes you may not want your tag literal to be run during the EDN load, but only after the tree has fully loaded.
@@ -277,8 +277,8 @@ Here is how this can be achieved:
 {:secrets #include #join [#env HOME "/.secrets.edn"]
 
  :aws-secret-access-key
-  #profile {:test ^:ref [:secrets :aws-test-key]
-            :prod ^:ref [:secrets :aws-prod-key]}}
+  #profile {:test #ref [:secrets :aws-test-key]
+            :prod #ref [:secrets :aws-prod-key]}}
 ```
 
 ### Use functions to wrap access to your configuration.

project.clj

@@ -1,6 +1,6 @@
 ;; Copyright © 2015, JUXT LTD.
 
-(defproject aero "1.1.2"
+(defproject aero "1.1.3"
   :description "A small library for explicit, intentful configuration."
   :url "https://github.com/juxt/aero"
   :license {:name "The MIT License"

src/aero/core.cljc

@@ -10,17 +10,16 @@
            [aero.vendor.dependency.v0v2v0.com.stuartsierra.dependency :as dep]))
   #?(:clj (:import (java.io StringReader)))
   #?(:cljs (:require [cljs.tools.reader :as edn]
-                     [cljs.nodejs :as nodejs]
                      [goog.string :as gstring]
                      goog.string.format
                      [clojure.walk :refer [walk postwalk]]
-                     [aero.vendor.dependency.v0v2v0.com.stuartsierra.dependency :as dep])))
+                     [aero.vendor.dependency.v0v2v0.com.stuartsierra.dependency :as dep]
+                     ["os" :as os]
+                     ["fs" :as fs]
+                     ["path" :as path])))
 
 (declare read-config)
 
-#?(:cljs (def os (nodejs/require "os")))
-#?(:cljs (def fs (nodejs/require "fs")))
-
 (defmulti reader (fn [opts tag value] tag))
 
 (defmethod reader :default
@@ -89,7 +88,7 @@
 (defmethod reader 'hostname
   [{:keys [hostname]} tag value]
   (let [hostn (or hostname #?(:clj (env "HOSTNAME")
-                              :cljs (os.hostname)))]
+                              :cljs (os/hostname)))]
     (or
      (some (fn [[k v]]
              (when (or (= k hostn)
@@ -125,7 +124,7 @@
   [opts tag value]
   (some-> value str edn/read-string))
 
-(defmethod aero.core/reader 'merge
+(defmethod reader 'merge
   [opts tag values]
   (apply merge values))
 
@@ -174,9 +173,9 @@
   {:profile :default
    :resolver #?(:clj adaptive-resolver
                 :cljs (fn [source include]
-                        (if (path.isAbsolute include)
+                        (if (path/isAbsolute include)
                           include
-                          (path.join source ".." include))))})
+                          (path/join source ".." include))))})
 
 ;; The rationale for deferreds is to realise some values after the
 ;; config has been read. This allows certain expensive operations to
@@ -357,7 +356,7 @@
           ;; post-processed tags with declared data readers
           :readers {}
           :default tag-wrapper}
-         (fs.readFileSync source "utf-8"))))))
+         (fs/readFileSync source "utf-8"))))))
 
 (defn read-config
   "First argument is a string URL to the file. To read from the