Support Clojure version >= 1.8.0

lread · lread · commit 979edf61754b · 2021-10-09T15:59:42.000-04:00
Was previously requiring a minimum Clojure version of 1.9.0. In order to be able to parse modern Clojure constructs, rewrite-clj will continue to depend on the current version of org.clojure/tools.reader. Notes - Kaocha requires Clojure >= v1.9.0 We still use kaocha (because we like it) for Clojure >= 1.9.0 but use cognitect test-runner to run unit tests under Clojure 1.8.0. - We were using qualified-symbol? which was added in Clojure v1.9.0. Easy enough to effectively inline its source. - Namespaced maps were added in v1.9.0. Had a test to verify namespaced map forms were being coerced to rewrite-clj map nodes. This test can't work in v1.8. That's ok, it was non-sensical, namespaced map forms are converted to maps by the reader, so test wasn't testing what it thought it might be testing. Test deleted. - ##Inf and ##-Inf were added in v1.9.0. Had a test which relied on this reader syntax. This does not work in v1.8. Converted test to instead use resulting ##Inf and ##-Inf values for clj and cljs. - Canary lib testing had been patching some libs to bump Clojure version. Reverted Clojure version bumps for kibit and mutant. - Adjusted Clojure version to current for tooling that needed > v1.8.0 - antq - cli-matic (used in Clojure-run scripts) - clj-kondo - figwheel main (for cljs watch task) - kaocha (for clj watch task) Closes #164
diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc
@@ -16,6 +16,7 @@ For a list of breaking changes see link:#v1-breaking[breaking changes].
 
 === Unreleased
 
+* rewrite-clj v1 minimimum Clojure version is now v1.8.0 (was formerly v1.9.0) https://github.com/clj-commons/rewrite-clj/issues/164[#164]
 * internal rewrite-clj developer facing:
 ** Migrate from `depstar` to `tools.build`
 
@@ -575,4 +576,3 @@ _Development has branched off, using the `0.4.x` branch_
 === 0.1.0
 
 * Initial Release
-
diff --git a/deps.edn b/deps.edn
@@ -1,11 +1,12 @@
 {:paths ["src" "resources"]
 
- :deps {org.clojure/clojure {:mvn/version "1.9.0"}
+ :deps {org.clojure/clojure {:mvn/version "1.8.0"}
         org.clojure/tools.reader {:mvn/version "1.3.6"}}
 
  :aliases {;;
            ;; Clojure versions we support
            ;;
+           :1.8 {:override-deps {org.clojure/clojure {:mvn/version "1.8.0"}}}
            :1.9 {:override-deps {org.clojure/clojure {:mvn/version "1.9.0"}}}
            :1.10 {:override-deps {org.clojure/clojure {:mvn/version "1.10.3"}}}
 
@@ -22,6 +23,7 @@
            :lint-cache {:replace-paths ["src"]} ;; when building classpath we want to exclude resources
                                                 ;; so we do not pick up our own clj-kondo config exports
            :clj-kondo {:extra-deps {clj-kondo/clj-kondo {:mvn/version "2021.09.25"}}
+                       :override-deps {org.clojure/clojure {:mvn/version "1.10.3"}}
                        :main-opts ["-m" "clj-kondo.main"]}
 
            :eastwood {:extra-deps {jonase/eastwood {:mvn/version "0.9.9"}}
@@ -34,6 +36,8 @@
            :test-common {:extra-deps {org.clojure/test.check {:mvn/version "1.1.0"}}
                          :extra-paths ["test"]}
 
+           :test-isolated {:extra-paths ["test-isolated"]}
+
            ;; document block testing
            :test-doc-blocks {:replace-deps {org.clojure/clojure {:mvn/version "1.10.3"}
                                             com.github.lread/test-doc-blocks {:mvn/version "1.0.146-alpha"}}
@@ -47,14 +51,21 @@
            :test-docs {:override-deps {org.clojure/clojure {:mvn/version "1.10.3"}}
                        :extra-paths ["target/test-doc-blocks/test"]}
 
-           ;; kaocha for clojure testing
+           ;; kaocha for testing clojure versions>= v1.9
            :kaocha {:extra-deps {lambdaisland/kaocha {:mvn/version "1.0.902"}
                                  lambdaisland/kaocha-junit-xml {:mvn/version "0.0.76"}
                                  lambdaisland/kaocha-cloverage {:mvn/version "1.0.75"}}
                     :main-opts ["-m" "kaocha.runner"]}
 
+;; cognitect test-runner for testing clojure < v1.9
+           ;; (we prefer kaocha but it requires a min Clojure version of 1.9)
+           :clj-test-runner {:extra-deps {io.github.cognitect-labs/test-runner
+                                          {:git/tag "v0.5.0" :git/sha "b3fd0d2"}}
+                             :main-opts ["-m" "cognitect.test-runner"]}
+
            ;; figwheel for clojurescript testing during dev
            :fig-test {:extra-deps {com.bhauman/figwheel-main {:mvn/version "0.2.14"}}
+                      :override-deps {org.clojure/clojure {:mvn/version "1.10.3"}}
                       :extra-paths ["target" "test"]
                       :main-opts ["-m" "figwheel.main" "-b" "fig" "-r"]}
 
@@ -69,6 +80,7 @@
            ;; General script deps
            ;;
            :script {:extra-paths ["script"]
+                    :override-deps {org.clojure/clojure {:mvn/version "1.10.3"}}
                     :extra-deps {org.clojure/tools.namespace {:mvn/version "1.1.0"}
                                  cli-matic/cli-matic {:mvn/version "0.4.3"}}}
 
@@ -116,6 +128,7 @@
            :outdated {:extra-deps {com.github.liquidz/antq {:mvn/version "1.1.0"}
                                    org.slf4j/slf4j-simple {:mvn/version "1.7.32"} ;; to rid ourselves of logger warnings
                                    }
+                      :override-deps {org.clojure/clojure {:mvn/version "1.10.3"}}
                       :main-opts ["-m" "antq.core"
                                   "--exclude=lambdaisland/kaocha@1.0.829" ;; https://github.com/lambdaisland/kaocha/issues/208
                                   ]}}}
diff --git a/doc/01-user-guide.adoc b/doc/01-user-guide.adoc
@@ -61,6 +61,9 @@ Thanks to @xsc's transfer of rewrite-clj to clj-commons we'll continue on with t
 To upgrade to rewrite-clj v1, update your project dependencies.
 If you were using both rewrite-cljs and rewrite-clj v0 in your project you can now drop the rewrite-cljs dependency.
 
+Rewrite-clj unit tests are run against the current version of ClojureScript and Clojure versions >= v1.8.0.
+We recommend that while bumping your rewrite-clj dependency to v1, that you also bump your Clojure and ClojureScript dependencies to current official releases.
+
 The most notable breaking changes from rewrite-clj v0 relate to handling of namespaced elements:
 
 * Namespaced map handling was incomplete in rewrite-clj, has been reworked a bit and now supports namespaced symbols
diff --git a/doc/02-developer-guide.adoc b/doc/02-developer-guide.adoc
@@ -19,7 +19,7 @@ Automated testing is setup using GraalVM v21 JDK11.
 * Java JDK 1.8 or above
 * NodeJs v12 or above
 * Clojure v1.10.1.697 or above for `clojure` command
-** Note that rewrite-clj v1 itself supports Clojure v1.9 and above
+** Note that rewrite-clj v1 itself supports Clojure v1.8 and above
 * Babashka v0.3.7 or above
 * GraalVM v21.2.0 JDK 11 (if you want to run GraalVM native image tests)
 
diff --git a/doc/design/01-merging-rewrite-clj-and-rewrite-cljs.adoc b/doc/design/01-merging-rewrite-clj-and-rewrite-cljs.adoc
@@ -191,7 +191,7 @@ After some experimentation, my general strategy is to:
 .. Grab the a specified release of a project from GitHub via zip download
 .. Patch deps to
 ... Point to rewrite-clj canary release
-... Adjust Clojure version if necessary (we are 1.9 and above)
+... Adjust Clojure version if necessary (we are 1.8 and above)
 .. Adjust sources as necessary
 ... Ex. rewrite-cljc -> rewrite-clj namespace
 ... At the time of the writing only zprint v1.1.1. needed a src code hack to get its tests passing.
diff --git a/script/ci_unit_tests.clj b/script/ci_unit_tests.clj
@@ -21,7 +21,7 @@
   (shell/command "bb test-doc"))
 
 (defn clojure-tests []
-  (doseq [version ["1.9" "1.10"]]
+  (doseq [version ["1.8" "1.9" "1.10"]]
     (shell/command "bb test-clj --clojure-version" version)) )
 
 (defn cljs-tests []
diff --git a/script/test_clj.clj b/script/test_clj.clj
@@ -1,30 +1,34 @@
-
-
 #!/usr/bin/env bb
 
 (ns test-clj
   (:require [helper.main :as main]
             [helper.shell :as shell]
             [lread.status-line :as status]))
 
-(def allowed-clojure-versions '("1.9" "1.10"))
+(def allowed-clojure-versions '("1.8" "1.9" "1.10"))
 
 (defn run-unit-tests [clojure-version]
   (status/line :head (str "testing clojure source against clojure v" clojure-version))
-  (shell/command "clojure"
-                  (str "-M:test-common:kaocha:" clojure-version)
-                  "--reporter" "documentation"))
+  (if (= "1.8" clojure-version)
+    (shell/command "clojure"
+                   (str "-M:test-common:clj-test-runner:" clojure-version))
+    (shell/command "clojure"
+                   (str "-M:test-common:kaocha:" clojure-version)
+                   "--reporter" "documentation")))
 
 (defn run-isolated-tests[clojure-version]
   (status/line :head (str "running isolated tests against clojure v" clojure-version))
-  (shell/command "clojure" (str "-M:kaocha:" clojure-version)
-                 "--profile" "test-isolated"
-                 "--reporter" "documentation"))
+  (if (= "1.8" clojure-version)
+    (shell/command "clojure" (str "-M:clj-test-runner:test-isolated:" clojure-version)
+                   "--dir" "test-isolated")
+    (shell/command "clojure" (str "-M:kaocha:" clojure-version)
+                   "--profile" "test-isolated"
+                   "--reporter" "documentation")))
 
 (def args-usage "Valid args: [options]
 
 Options:
-  -v, --clojure-version VERSION  Test with Clojure [1.9, 1.10] [default: 1.10]
+  -v, --clojure-version VERSION  Test with Clojure [1.8, 1.9, 1.10] [default: 1.10]
   --help                         Show this help")
 
 (defn -main [& args]
diff --git a/script/test_clj_watch.clj b/script/test_clj_watch.clj
@@ -10,7 +10,7 @@
   ;; we simply pass along any args to kaocha, it will validate them
   (env/assert-min-versions)
   (status/line :head "launching kaocha watch on clojure sources")
-  (apply shell/command "clojure -M:test-common:kaocha --watch" args))
+  (apply shell/command "clojure -M:test-common:kaocha:1.9 --watch" args))
 
 (main/when-invoked-as-script
  (apply -main *command-line-args*))
diff --git a/script/test_libs.clj b/script/test_libs.clj
@@ -200,15 +200,6 @@
                    "[rewrite-clj.zip :as rzip]"
                    "[rewrite-clj.zip :as rzip] [rewrite-clj.node]"))
 
-;;
-;; kibit patch
-;;
-(defn- kibit-patch [{:keys [home-dir rewrite-clj-version]}]
-  (patch-deps {:filename (str (fs/file home-dir "project.clj"))
-               :removals #{'rewrite-clj 'org.clojure/clojure}
-               :additions [['rewrite-clj rewrite-clj-version]
-                           ['org.clojure/clojure "1.9.0"]]}))
-
 ;;
 ;; lein ancient
 ;;
@@ -239,15 +230,6 @@
                         "[$1 :exclusions [org.clojure/tools.reader]]")
         (->> (spit p)))))
 
-;;
-;; mutant
-;;
-(defn- mutant-patch [{:keys [home-dir rewrite-clj-version]}]
-  (patch-deps {:filename (str (fs/file home-dir "project.clj"))
-               :removals #{'rewrite-clj 'org.clojure/clojure}
-               :additions [['rewrite-clj rewrite-clj-version]
-                           ['org.clojure/clojure "1.9.0"]]}))
-
 ;;
 ;; refactor-nrepl
 ;;
@@ -377,7 +359,7 @@
             :root "kibit"
             :version "0.1.8"
             :github-release {:repo "jonase/kibit"}
-            :patch-fn kibit-patch
+            :patch-fn project-clj-v1-patch
             :show-deps-fn lein-deps-tree
             :test-cmds ["lein test-all"]}
            {:name "lein-ancient"
@@ -404,7 +386,7 @@
             :note "Dormant project"
             :github-release {:repo "jstepien/mutant"
                              :via :tag}
-            :patch-fn mutant-patch
+            :patch-fn project-clj-v1-patch
             :show-deps-fn lein-deps-tree
             :test-cmds ["lein test"]}
            {:name "rewrite-edn"
diff --git a/src/rewrite_clj/node.cljc b/src/rewrite_clj/node.cljc
@@ -758,7 +758,7 @@
 ;; DO NOT EDIT FILE, automatically imported from: rewrite-clj.node.token
 (defn token-node
   "Create node for an unspecified token of `value`.
-   
+
    ```Clojure
    (require '[rewrite-clj.node :as n])
 
diff --git a/src/rewrite_clj/node/token.cljc b/src/rewrite_clj/node/token.cljc
@@ -10,7 +10,7 @@
     (or sym-qualifier map-qualifier)))
 
 (defn- symbol-qualifier [value]
-  (when (qualified-symbol? value)
+  (when (and (symbol? value) (namespace value))
     {:prefix (namespace value)}))
 
 ;; A symbol is different than a keyword in that it can only be auto-resolve qualified by a namespaced map
@@ -30,7 +30,7 @@
   (node-type [_node] :token)
   (printable-only? [_node] false)
   (sexpr* [_node _opts] value)
-  (length [_node] 
+  (length [_node]
     (count string-value))
   (string [_node] string-value)
 
@@ -61,7 +61,7 @@
 (node/make-printable! TokenNode)
 (node/make-printable! SymbolNode)
 
-(defn symbol-node? 
+(defn symbol-node?
   "Returns true if `n` is a node representing a symbol."
   [n]
   (= :symbol (node/node-type n)))
@@ -70,7 +70,7 @@
 
 (defn token-node
   "Create node for an unspecified token of `value`.
-   
+
    ```Clojure
    (require '[rewrite-clj.node :as n])
 
diff --git a/test/rewrite_clj/custom_zipper/utils_test.cljc b/test/rewrite_clj/custom_zipper/utils_test.cljc
@@ -40,15 +40,15 @@
       6 '[b d] "[a [b  d]]")))
 
 (deftest t-remove-and-move-up-throws
-  ;; I can't tell you why, but shadow-cljs will sometimes, under certain vesions of node and 
+  ;; I can't tell you why, but shadow-cljs will sometimes, under certain vesions of node and
   ;; other variables I do not understand culminate in a:
   ;;    #object[RangeError RangeError: Maximum call stack size exceeded]
   ;; when I change this test to use (thrown-with-msg? ...)
   (let [zloc (base/of-string "[a [b c d]]")]
     (is (= "cannot remove at top" (try
-                     (u/remove-and-move-up zloc) 
+                     (u/remove-and-move-up zloc)
                      (catch ExceptionInfo e
-                       ;; ex-message is only avail in 1.10 and we support clj 1.9
+                       ;; ex-message is only avail in 1.10 and we support clj >= 1.8
                        #?(:clj (.getMessage e) :cljs (.-message e))))))))
 
 (deftest t-remove-and-move-left-tracks-current-position-correctly
diff --git a/test/rewrite_clj/node/coercer_test.cljc b/test/rewrite_clj/node/coercer_test.cljc
@@ -97,18 +97,7 @@
     (array-map)
     (array-map :d 4 :e 5)))
 
-(deftest t-namespaced-maps-coerce-to-maps
-  (are [?sexpr]
-       (let [n (node/coerce ?sexpr)]
-         (is (node/node? n))
-         (is (= :map (node/tag n)))
-         (is (= :seq (protocols/node-type n)))
-         (is (string? (node/string n)))
-         (is (= ?sexpr (node/sexpr n)))
-         (is (map? (node/sexpr n))))
-    #:prefix {:a 1 :b 2}
-    #::{:c 3 :d 4}
-    #::p{:e 5 :f 6}))
+
 
 (deftest t-sexpr->node->sexpr-roundtrip-for-regex
   (are [?in]
diff --git a/test/rewrite_clj/parser_test.cljc b/test/rewrite_clj/parser_test.cljc
@@ -100,12 +100,14 @@
 
 (deftest t-parsing-symbolic-inf-values
   (are [?s ?r]
-      (let [n (p/parse-string ?s)]
-        (is (= :token (node/tag n)))
-        (is (= ?s (node/string n)))
-        (is (= ?r (node/sexpr n))))
-    "##Inf" '##Inf
-    "##-Inf" '##-Inf))
+       (let [n (p/parse-string ?s)]
+         (is (= :token (node/tag n)))
+         (is (= ?s (node/string n)))
+         (is (= ?r (node/sexpr n))))
+    "##Inf" #?(:cljs js/Number.POSITIVE_INFINITY
+               :default Double/POSITIVE_INFINITY)
+    "##-Inf" #?(:cljs js/Number.NEGATIVE_INFINITY
+                :default Double/NEGATIVE_INFINITY)))
 
 (deftest t-parsing-symbolic-NaN-value
   (let [n (p/parse-string "##NaN")
@@ -572,5 +574,3 @@
     ;1   2 3   4   5 6   7
     "\r\n\r\r\f\r\n\r\r\n\r"
     "\n\n\n\n\n\n\n"))
-
-
