Merge pull request #15 from shopsmart/pre-1.0

Misc cleanup; one bug fix

Author: coconutpalm

README.md

@@ -1,58 +1,23 @@
-# clj-foundation pre-1.0
+# clj-foundation
 
-## Definition of Done for 1.0 release
-
-* On APIs - While 1.0 will be a major release with some inevitable API breakage, we will strive:
-    * To maintain API compatiblity with prior releases to the greatest extent possible
-    * To remove duplicated functionality (which may contradict the API compatibility principle)
-    * To maintain API compatibility with code copied from internal Brad's Deals projects to the greatest extent possible.
-    * Clear naming convention for namespaces that are provisional (non-frozen, WIP) API.
-
-* Known tech debt that may influence APIs
-    * Consider migrating db.clj's local configuration mechanism to config.clj (and then make an instance of the generic implementation inside db.clj)
-
-* Target Clojure 1.9
-    * All functions will have type information supplied via Clojure 1.9 specs.
-    * Functions currently using plumatic/schema to specify type constraints will be migrated to Specs
-
-* On testing
-    * All functions will be unit tested using a style designed to illustrate behavior under failure modes as well as happy path scenarios.
-    * We will collectively agree on a style of testing that seems to hit the sweet spot between overspecification and underspecification.
-        * (Details are not set in stone but definitely up for negotiation)
-    * When defects are detected, we will first reproduce the defect's root cause using a failing test case that will prevent the defect from reoccurring without the test notifying us.
-    * Generative testing with Specs
-    * Integrate kbitz (suggest Clojure idioms), some Clojure linting library; if it's easy to make these available to clients of clj-foundation, do so.
-
-* Debug library
-    * dbg, ppdbg macros
-    * trace?
-
-* Documentation
-    * Machine generate as much as possible?
-
-* Make clj_infrastructure as a separate library
-    * Move db.clj there?
-    * Abstract db.clj API using monads at the foundation layer and implement for relational, nosql, etc. in infrastructure?
-        * http://rea.tech/the-worst-thing-in-our-scala-code-futures/  ?
-        * Abstractions for creating/consuming lazy sequences?
-        * Abstractions for aggregating a sequence of database results into a map[concatinated-key value(s)]
-
-## Provisional ideas for 1.0
-
-* Figure out how to isolate namespaces and their dependencies at the classpath level, including runtime reloading and evolution semantics after the fashion of OSGi at the REPL or in a running application.
-* Update and include clojure.osgi for clean deployment into OSGi frameworks?
-* Deploy to Clojars?
-
-
-# Why clj-foundation?
+## Why clj-foundation?
 
 clj-foundation supplies namespaces making additional simple things easy and hard things possible in Clojure that are intended for use across all Clojure projects at Brad's Deals.
 
 * Enhances the core language in resonable, useful, and conservative ways.
 * Enables programming using a monadic style without requiring explicit monad types.
 * Describes, specifies, and illustrates best practices at Brad's Deals for working in Clojure.
 * The only dependencies are Clojure, Potemkin, and Schema in order to minimize adoption friction.
-    * *(This is up for renegotiation for 1.0)*
+
+## Other Clojure foundational libraries that compliment this one
+
+* Hara: http://docs.caudate.me/hara/index.html
+
+## High-quality domain-specific libraries complimenting this
+
+* Cassandra as a mutable, versioned map: https://github.com/MyPost/cassius
+* Git from the Clojure REPL: https://github.com/zcaudate/gita
+
 
 # Features
 
@@ -167,8 +132,8 @@ where "version" currently is "[![Release](http://jitpack.io/v/com.github.shopsma
 <repositories>
   <repository>
     <id>jitpack.io</id>
-	<name>Jitpack repo</name>
-	<url>https://jitpack.io</url>
+    <name>Jitpack repo</name>
+    <url>https://jitpack.io</url>
   </repository>
 </repositories>
 ```
@@ -187,6 +152,53 @@ $ lein jar
 $ lein with-profile test test
 ```
 
+
+# Definition of Done for 1.0 release
+
+* On APIs - While 1.0 will be a major release with some inevitable API breakage, we will strive:
+    * To maintain API compatiblity with prior releases to the greatest extent possible
+    * To remove duplicated functionality (which may contradict the API compatibility principle)
+    * To maintain API compatibility with code copied from internal Brad's Deals projects to the greatest extent possible.
+    * Clear naming convention for namespaces that are provisional (non-frozen, WIP) API.
+
+* Known tech debt that may influence APIs
+    * Consider migrating db.clj's local configuration mechanism to config.clj (and then make an instance of the generic implementation inside db.clj)
+
+* Target Clojure 1.9
+    * All functions will have type information supplied via Clojure 1.9 specs.
+    * Functions currently using plumatic/schema to specify type constraints will be migrated to Specs
+
+* On testing
+    * All functions will be unit tested using a style designed to illustrate behavior under failure modes as well as happy path scenarios.
+    * We will collectively agree on a style of testing that seems to hit the sweet spot between overspecification and underspecification.
+        * (Details are not set in stone but definitely up for negotiation)
+    * When defects are detected, we will first reproduce the defect's root cause using a failing test case that will prevent the defect from reoccurring without the test notifying us.
+    * Generative testing with Specs
+    * Integrate kbitz (suggest Clojure idioms), some Clojure linting library; if it's easy to make these available to clients of clj-foundation, do so.
+
+* Debug library
+    * dbg, ppdbg macros
+    * trace?
+
+* Documentation
+    * Machine generate as much as possible?
+
+* Make clj_infrastructure as a separate library
+    * Move db.clj there?
+    * Abstract db.clj API using monads at the foundation layer and implement for relational, nosql, etc. in infrastructure?
+        * http://rea.tech/the-worst-thing-in-our-scala-code-futures/  ?
+        * Abstractions for creating/consuming lazy sequences?
+        * Abstractions for aggregating a sequence of database results into a map[concatinated-key value(s)]
+
+## Provisional ideas for 1.0
+
+* Figure out how to isolate namespaces and their dependencies at the classpath level, including runtime reloading and evolution semantics after the fashion of OSGi at the REPL or in a running application.
+* Update and include clojure.osgi for clean deployment into OSGi frameworks?
+* Deploy to Clojars?
+
+
+
+
 ## License
 
 Copyright © 2015, 2016 by ShopSmart, LLC.  Licensed under the Eclipse Public License v1.0.

project.clj

@@ -1,4 +1,4 @@
-(defproject com.github.shopsmart/clj-foundation "0.9.15"
+(defproject com.github.shopsmart/clj-foundation "0.9.16"
   :description "Common patterns enabling simpler to be easier and harder to be possibler."
   :url "https://github.com/shopsmart/clj-foundation"
 

src/clj_foundation/data.clj

@@ -167,20 +167,20 @@
    Ex. some_name -> :some-name"
   ([name :- s/Str
     naming-exceptions :- #{s/Str}]
-    (if-let [name-exception (naming-exceptions name)]
-      name-exception
-      (keywordize name)))
+   (if-let [name-exception (naming-exceptions name)]
+     name-exception
+     (keywordize name)))
   ([name :- s/Str]
-    (keywordize name)))
+   (keywordize name)))
 
 
 (defn string-list->keywords
   "Convert a list of strings to a list of keywords"
   ([list]
-    (map (fn [string]
+   (map (fn [string]
          (string->keyword (name string))) list))
   ([list naming-exceptions]
-    (map (fn [string]
+   (map (fn [string]
          (string->keyword (name string) naming-exceptions)) list)))
 
 

src/clj_foundation/errors.clj

@@ -115,7 +115,7 @@
           (throw (IllegalStateException. error-message))
           (if-not completed
             (do
-              (Thread/sleep 500)
+              (Thread/sleep 100)
               (recur (predicate)))
             completed))))))
 

src/clj_foundation/io.clj

@@ -3,6 +3,7 @@
             [clj-foundation.errors :as err]
             [clj-foundation.templates :as template]
             [clj-foundation.patterns :as p]
+            [clj-foundation.data :as data]
             [clojure.java.io :as io]
             [clojure.edn :as edn])
 
@@ -142,7 +143,9 @@
 
     (try
       (s/validate ClojureFileInputs result)
-      result
+      (if (string? result)
+        (data/replace-nil (io/resource result) result)
+        result)
       (catch Throwable e
         (throw (IllegalArgumentException.
                 (str "Expected result to be one of " (s/explain ClojureFileInputs)
@@ -177,7 +180,7 @@
       (= argc 1) (read-file {:resource (first resource-spec)})
       (= argc 2) (read-file [(first resource-spec) (second resource-spec)])
       :else (throw (IllegalArgumentException.
-                    (str "resource-as-string: Illegal arg list: " resource-spec) )))))
+                    (str "resource-as-string: Illegal arg list: " resource-spec))))))
 
 
 (defn- parse-extended-file-location [input subs]

test/clj_foundation/errors_test.clj

@@ -6,7 +6,8 @@
             [clj-foundation.errors :refer :all]
             [clj-foundation.data :refer [any?]]
             [clj-foundation.patterns :as p]
-            [clj-foundation.millis :as millis]))
+            [clj-foundation.millis :as millis])
+  (:import [java.util Date]))
 
 
 (common/register-fixtures)
@@ -71,6 +72,43 @@
       (is (= 5 (count (seq<- e5)))))))
 
 
+(deftest expect-within-test
+  (testing "Immediate success returns immediately"
+    (let [before  (.getTime (Date.))
+          success (expect-within (millis/<-seconds 2)
+                                 (constantly true)
+                                 "Always succeeds immediately")
+          after   (.getTime (Date.))
+          time    (- after before)]
+
+      (is success)
+      (is (< time (millis/<-seconds 1/4)))))
+
+  (testing "Eventual success succeeds"
+    (let [tries   (atom 0)
+          before  (.getTime (Date.))
+          success (expect-within (millis/<-seconds 5)
+                                 (fn [] (swap! tries inc) (< 3 @tries))
+                                 "Always succeeds eventually")
+          after   (.getTime (Date.))
+          time    (- after before)]
+
+      (is success)
+      (is (< time (millis/<-seconds 4)))))
+
+  (testing "Taking too much time throws IllegalStateException"
+    (let [timeout (millis/<-seconds 1)
+          before  (.getTime (Date.))
+          result  (try* (expect-within timeout
+                                       (constantly false)
+                                       "Never succeeds"))
+          after   (.getTime (Date.))
+          time    (- after before)]
+
+    (is (instance? IllegalStateException result))
+    (is (< timeout time)))))
+
+
 (deftest retry?-test
   (testing "Retry up to :max-retries times"
     (let [r0 (new-default-job "timeout-test"

test/clj_foundation/io_test.clj

@@ -15,6 +15,10 @@
 
 
 (deftest normalize-file-input-test
+  (testing "If a string input references a resource, a resource URL is returned."
+    (is (instance? URL (normalize-file-input "_test-config.edn")))
+    (is (= "/some/file/path" (normalize-file-input "/some/file/path"))))
+
   (testing "Return the default value as a resource when the envar is not defined"
     (is (instance? URL (normalize-file-input ["CONFIG-PRODDD" "_test-config.edn"]))))