BREAKING: Rename all the remaining dev-local occurrences

Author: marksto

README.md

@@ -1,29 +1,30 @@
-# dev-local-tu
+# datomic-local-tu
 
-Test utility for Datomic dev-local. 
+Test utility for Datomic Local.
 
 ```clojure
 dev-local-tu {:mvn/version "0.3.0"}
 ```
 
-## Rationale 
+## Rationale
 
-Datomic dev-local provides a way to create clean environments useful for testing.
-It does not provide a methodology for how to use it. 
-This library provides an opinionated way to use dev-local in your tests.
+Datomic Local provides a way to create clean environments useful for testing.
+It does not provide a methodology for how to use it.
+This library provides an opinionated way to use `:datomic-local` in your tests.
 
 ## Usage
 
-The primary function exposed by the api is `test-env`. 
+The primary function exposed by the api is `test-env`.
 This function returns a test environment.
-A test environment will contain a Datomic client, created by dev local, that can be cleaned up by simply calling `.close`.
+A test environment will contain a Datomic client, created by Datomic Local,
+that can be cleaned up by simply calling `.close`.
 A test environment is typically used within a `with-open`.
 
 ```clojure
-(require '[dev-local-tu.core :as dev-local-tu]
+(require '[datomic-local-tu.core :as datomic-local-tu]
          '[datomic.client.api :as d])
 
-(with-open [db-env (dev-local-tu/test-env)]
+(with-open [db-env (datomic-local-tu/test-env)]
   (let [_ (d/create-database (:client db-env) {:db-name "test"})
         conn (d/connect (:client db-env) {:db-name "test"})
         _ (d/transact conn {:tx-data [{:db/ident       ::name
@@ -37,19 +38,24 @@ A test environment is typically used within a `with-open`.
 => #:example1{:name "hi"}
 ```
 
-If you would prefer to manage the lifecycle, use `new-env` to generate a new, random system and `cleanup-env!` to remove the associated resources.
+If you would prefer to manage the lifecycle, use `new-env` to generate a new,
+random system and `cleanup-env!` to remove the associated resources.
 
-Alternatively, you can use test-env with fixtures. 
+Alternatively, you can use test-env with fixtures.
 See `examples/example_fixture.clj` for the complete example.
 
 ```clojure
 (def ^:dynamic *client* nil)
 
 (defn client-fixture
   [f]
-  (with-open [db-env (dev-local-tu/test-env)]
+  (with-open [db-env (datomic-local-tu/test-env)]
     (binding [*client* (:client db-env)]
       (f))))
 
 (use-fixtures :each client-fixture)
 ```
+
+## Author
+
+Kenny Williams @kennyjwilli

examples/example1.clj

@@ -2,10 +2,10 @@
   (:require
     [clojure.test :refer :all]
     [datomic.client.api :as d]
-    [dev-local-tu.core :as dev-local-tu]))
+    [datomic-local-tu.core :as datomic-local-tu]))
 
 (deftest test1
-  (with-open [db-env (dev-local-tu/test-env)]
+  (with-open [db-env (datomic-local-tu/test-env)]
     (let [_ (d/create-database (:client db-env) {:db-name "test"})
           conn (d/connect (:client db-env) {:db-name "test"})
           _ (d/transact conn {:tx-data [{:db/ident       ::name
@@ -16,4 +16,4 @@
       (is (= {::name "hi"}
              (d/pull (d/db conn)
                      [::name]
-                     (get tempids "a")))))))
+                     (get tempids "a")))))))

examples/example_fixture.clj

@@ -2,13 +2,13 @@
   (:require
     [clojure.test :refer :all]
     [datomic.client.api :as d]
-    [dev-local-tu.core :as dev-local-tu]))
+    [datomic-local-tu.core :as datomic-local-tu]))
 
 (def ^:dynamic *client* nil)
 
 (defn client-fixture
   [f]
-  (with-open [db-env (dev-local-tu/test-env)]
+  (with-open [db-env (datomic-local-tu/test-env)]
     (binding [*client* (:client db-env)]
       (f))))
 
@@ -25,4 +25,4 @@
     (is (= {::name "hi"}
            (d/pull (d/db conn)
                    [::name]
-                   (get tempids "a"))))))
+                   (get tempids "a"))))))

src/dev_local_tu/core.clj src/datomic_local_tu/core.cljsrc/dev_local_tu/core.clj renamed to src/datomic_local_tu/core.clj

@@ -1,41 +1,42 @@
-(ns dev-local-tu.core
+(ns datomic-local-tu.core
+  "Test utility for Datomic Local"
   (:require
     [clojure.string :as str]
     [datomic.client.api :as d]
     [datomic.local]
     [clojure.java.io :as io]
-    [dev-local-tu.internal.impl :as impl])
+    [datomic-local-tu.internal.impl :as impl])
   (:import (java.io Closeable File)))
 
 (defn gen-name!
   [prefix]
   (str prefix "-" (impl/rand-str! 7)))
 
-(def default-datomic-dev-local-storage-dir
+(def default-datomic-local-storage-dir
   (.getAbsolutePath (io/file (System/getProperty "user.home") ".datomic" "data")))
 
-(defn dev-local-directory
+(defn datomic-local-dir
   ^File [{:keys [system-name db-name storage-dir]
-          :or   {storage-dir default-datomic-dev-local-storage-dir}}]
+          :or   {storage-dir default-datomic-local-storage-dir}}]
   (let [file-args (cond-> [storage-dir]
-                    system-name (conj system-name)
-                    db-name (conj db-name))]
+                          system-name (conj system-name)
+                          db-name (conj db-name))]
     (apply io/file file-args)))
 
 (defn -new-env-map
   [{:keys [prefix system storage-dir]
-    :or   {prefix "dev-local"}}]
+    :or   {prefix "datomic-local"}}]
   (let [system (or system (gen-name! prefix))
         storage-dir (if (or
                           (= storage-dir :mem)
                           (and storage-dir
-                            (str/starts-with? storage-dir "/")))
+                               (str/starts-with? storage-dir "/")))
                       storage-dir
                       (.getAbsolutePath
-                        (dev-local-directory
+                        (datomic-local-dir
                           (cond-> {}
-                            storage-dir
-                            (assoc ::storage-dir storage-dir)))))
+                                  storage-dir
+                                  (assoc ::storage-dir storage-dir)))))
         client-map {:server-type :datomic-local
                     :system      system
                     :storage-dir storage-dir}]
@@ -44,13 +45,13 @@
      :system      system
      :storage-dir storage-dir}))
 
-(defn delete-dev-local-system!
-  "Deletes a :dev-local system's data. Always returns true. Throws on failure."
+(defn delete-datomic-local-system!
+  "Deletes a `:datomic-local` system's data. Always returns true. Throws on failure."
   ([system-name]
-   (delete-dev-local-system! system-name default-datomic-dev-local-storage-dir))
+   (delete-datomic-local-system! system-name default-datomic-local-storage-dir))
   ([system-name storage-dir]
-   (let [f (dev-local-directory {:system-name system-name
-                                 :storage-dir storage-dir})]
+   (let [f (datomic-local-dir {:system-name system-name
+                               :storage-dir storage-dir})]
      (when (.exists ^File f)
        (impl/delete-directory! f))
      true)))
@@ -72,7 +73,7 @@
   [{:keys [client system client-map]}]
   (release-dbs client system)
   (when (string? (:storage-dir client-map))
-    (delete-dev-local-system! system)))
+    (delete-datomic-local-system! system)))
 
 (defrecord TestEnv [system client]
   Closeable

src/dev_local_tu/internal/impl.clj src/datomic_local_tu/internal/impl.cljsrc/dev_local_tu/internal/impl.clj renamed to src/datomic_local_tu/internal/impl.clj

@@ -1,4 +1,4 @@
-(ns dev-local-tu.internal.impl
+(ns datomic-local-tu.internal.impl
   (:require [clojure.java.io :as io])
   (:import (java.nio.file Files SimpleFileVisitor FileVisitResult)
            (java.security SecureRandom)
@@ -22,4 +22,4 @@
     [length]
     (let [buffer (byte-array length)
           _ (.nextBytes random buffer)]
-      (.encodeToString encoder buffer))))
+      (.encodeToString encoder buffer))))