Merge pull request #10 from metasoarous/master

Latest changes

Author: MawiraIke

.github/FUNDING.yml

@@ -0,0 +1,13 @@
+# These are supported funding model platforms
+
+github: metasoarous
+
+#patreon: # Replace with a single Patreon username
+#open_collective: # Replace with a single Open Collective username
+#ko_fi: # Replace with a single Ko-fi username
+#tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+#community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+#liberapay: # Replace with a single Liberapay username
+#issuehunt: # Replace with a single IssueHunt username
+#otechie: # Replace with a single Otechie username
+#custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

Makefile

@@ -44,8 +44,9 @@ check-clean-tree:
 .PHONY: build
 build:
 	rm -rf resources/oz/public/js && \
+	rm -rf .shadow-cljs && \
 	npm install && \
-	shadow-cljs release app lib && \
+	clojure -M:shadow-cljs release app lib && \
 	clojure -A:pack mach.pack.alpha.skinny --no-libs --project-path target/oz.jar
 
 .PHONY: release
@@ -55,6 +56,7 @@ release: check-clean-tree build
 	git commit -m "add build targets" && \
 	git push origin && \
 	clojure -Spom && \
+	./bin/munge-provided-deps.clj && \
 	mvn -e deploy:deploy-file -Dfile=target/oz.jar -DrepositoryId=clojars -Durl=https://clojars.org/repo -DpomFile=pom.xml
 
 .PHONY: clean

README.md

@@ -45,7 +45,7 @@ Here's another which focuses on the philosophical ideas behind Vega & Vega-Lite,
 [![Seajure Clojure + Vega/Vega-Lite talk](https://i.imgur.com/SmIPUQtm.png)](https://www.youtube.com/watch?v=hXq5Bb40zZY)
 
 This Readme is the canonical entry point for learning about Oz.
-You may also want to check out the [clojdoc page](https://cljdoc.org/d/metasoarous/oz) (if you're not there already) for API & other docs, and look at the [examples directory](https://github.com/metasoarous/oz/tree/master/examples) of this project (references occassionally below).
+You may also want to check out the [clojdoc page](https://cljdoc.org/d/metasoarous/oz) (if you're not there already) for API & other docs, and look at the [examples directory](https://github.com/metasoarous/oz/tree/master/resources/oz/examples) of this project (references occassionally below).
 
 
 ### Ecosystem
@@ -483,12 +483,24 @@ The great thing about static sites is that they are easy and cheap to deploy and
 
 ## Local CLJS development
 
-Oz is now compiled (on the cljs side) with [Shadow-CLJS](http://shadow-cljs.org/).
-A typical workflow involves running `shadow-cljs watch app devcards`.
-This will compile both the `app.js` and `devcards.js` compile targets (to `resources/oz/public/js/`), meaning you can run the REPL/JVM tooling locally, and it will serve up the latest edition of the `app.js` for calling `view!`, etc.
-But also, visiting <https://localhost:7125/devcards.html> will pull up a live view of a set of example components defined at `src/cljs/oz/core_devcards.cljs`.
+Oz is now compiled (on the cljs side) with [Shadow-CLJS](http://shadow-cljs.org/), together with the Clojure CLI tooling.
+A typical workflow involves running `clj -M:shadow-cljs watch devcards app` (note, older versions of `clj` use `-A` instead of `-M`; consider updating).
+This will watch your cljs files for changes, and immediately compile both the `app.js` and `devcards.js` targets (to `resources/oz/public/js/`).
+
+In general, the best way to develop is to visit <https://localhost:7125/devcards.html>, which will pull up a live view of a set of example Reagent components defined at `src/cljs/oz/core_devcards.cljs`.
 This is the easiest way to tweak functionality and test new features, as editing `src/cljs/oz/core.cljs` will trigger updates to the devcards views.
 
+If it's necessary or desirable to test the app (live-view, etc) functionality  "in-situ", you can also use the normal Clj REPL utilities to feed plots to the `app.js` target using `oz/view!`, etc.
+Note that if you do this, you will need to use whatever port is passed to `oz/view!` (by default, 10666) and not the one printed out when you start `clj -M:shadow-cljs`.
+
+See documentation for your specific editing environment if you'd like your editor to be able to connect to the Shadow-CLJS repl.
+For `vim-fireplace`, the initial Clj connection should establish itself automatically when you attempt to evaluate your first form.
+From there simply execute the vim command `:CljEval (shadow/repl :app)`, and you should be able to evaluate code in the `*.cljs` files from vim.
+Code in `*.clj` files should also continue to evaluate as before as well.
+
+IMPORTANT NOTE: If you end up deploying a version of Oz to Clojars or elsewhere, make sure you stop your `clj -M:shadow-cljs watch` process before running `make release`.
+If you don't, shadow will continue watching files and rebuild js compilation targets with dev time configuration (shadow, less minification, etc), that shouldn't be in the final release build.
+If however you are simply making changes and pushing up for me to release, please just leave any compiled changes to the js targets out of your commits.
 
 
 ## Debugging & updating Vega/Vega-Lite versions

bin/munge-provided-deps.clj

@@ -0,0 +1,78 @@
+#!/usr/bin/env bb
+
+(require '[clojure.data.xml :as xml]
+         '[clojure.string :as string]
+         '[clojure.walk :as walk]
+         '[clojure.pprint :as pp])
+
+(def pom-xml
+  (xml/parse (io/reader "pom.xml")))
+
+(def pom-ns (namespace (:tag (second (:content pom-xml)))))
+
+(defn nsify
+  [key]
+  (keyword pom-ns (name key)))
+
+(def clojupyter-version
+  (-> (slurp "deps.edn")
+      (read-string)
+      :aliases
+      :clojupyter
+      :extra-deps
+      (get 'clojupyter/clojupyter)
+      :mvn/version))
+
+(println "clojupyter version is:" clojupyter-version)
+
+(def clojupyter-dep
+  (xml/sexp-as-element
+    [(nsify :dependency)
+     [(nsify :groupId) "clojupyter"]
+     [(nsify :artifactId) "clojupyter"]
+     [(nsify ::version) clojupyter-version]
+     [(nsify ::scope) "provided"]]))
+
+(def strip-emtpy-lines
+  (partial remove
+           (comp empty? string/trim)))
+
+
+(defn stringify-xml [xml]
+  (->> xml
+    (xml/indent-str)
+    (string/split-lines)
+    (strip-emtpy-lines)
+    (interpose "\n")
+    (apply str)))
+
+(defn decorate-xml
+  [xml attrs]
+  (walk/postwalk
+    (fn [{:as elmt :keys [tag]}]
+      (if tag
+        (update elmt :attrs merge attrs)
+        elmt))
+    xml))
+
+(defn add-clojupyter-dep
+  [{:as xml :keys [content attrs]}]
+  (let [clojupyter-dep clojupyter-dep]
+  ;(let [clojupyter-dep (decorate-xml clojupyter-dep attrs)]
+    (assoc xml
+           :content
+           (map
+             (fn [{:as elmt :keys [tag content]}]
+               (if (and tag (= "dependencies" (name tag)))
+                 (update elmt :content concat [clojupyter-dep])
+                 elmt))
+             content))))
+
+(->> pom-xml
+     (add-clojupyter-dep)
+     (xml/emit-str)
+     ;(println))
+     (spit "pom.xml"))
+
+
+

deps.edn

@@ -1,52 +1,54 @@
 {:paths ["src/clj" "src/cljs" "resources"]
- :deps {org.clojure/clojure {:mvn/version "1.10.0"}
-        org.clojure/clojurescript {:mvn/version "1.10.439"} ;; equivalent of :scope "provided"?
+ :deps {org.clojure/clojure {:mvn/version "1.10.1"}
+        org.clojure/clojurescript {:mvn/version "1.10.764"} ;; equivalent of :scope "provided"?
         ;; this appears to be necessary for fiwheel to work for some applications
         org.clojure/tools.reader {:mvn/version "1.3.2"}
         org.clojure/core.async {:mvn/version "0.4.490"}
-        cheshire {:mvn/version "5.8.1"}
-        clj-http {:mvn/version "3.9.1"}
+        cheshire/cheshire {:mvn/version "5.8.1"}
+        clj-http/clj-http {:mvn/version "3.9.1"}
         com.taoensso/sente {:mvn/version "1.13.1"}
         com.taoensso/timbre {:mvn/version "4.10.0"}
+        com.taoensso/encore {:mvn/version "2.120.0"}
+        devcards/devcards {:mvn/version "0.2.6"}
+        reagent/reagent {:mvn/version "0.10.0"}
+        ;; consider using this for lazy loading clojupyter stuff
         ;com.clojure-goes-fast/lazy-require {:mvn/version "0.1.1"}
-        aleph {:mvn/version "0.4.6"}
-        ring {:mvn/version "1.7.1"}
+        aleph/aleph {:mvn/version "0.4.6"}
+        ring/ring {:mvn/version "1.8.1"}
         ring/ring-defaults {:mvn/version "0.3.2"}
         bk/ring-gzip {:mvn/version "0.3.0"}
-        ring-cljsjs {:mvn/version "0.1.0"}
-        compojure {:mvn/version "1.6.1"}
-        ;hiccup {:mvn/version "1.0.5"}
-        hiccup {:mvn/version "2.0.0-alpha2"}
+        compojure/compojure {:mvn/version "1.6.1"}
+        hiccup/hiccup {:mvn/version "2.0.0-alpha2"}
         com.cognitect/transit-clj  {:mvn/version "0.8.313"}
         com.cognitect/transit-cljs {:mvn/version "0.8.256"}
-        reagent {:mvn/version "0.10.0"}
-        ;cljsjs/vega {:mvn/version "5.9.0-0"}
-        ;cljsjs/vega-lite {:mvn/version "4.0.2-0"}
-        ;cljsjs/vega-embed {:mvn/version "6.0.0-0"}
-        ;cljsjs/vega-tooltip {:mvn/version "0.20.0-0"}
-        markdown-clj {:mvn/version "1.10.0"}
-        hickory {:mvn/version "0.7.1"}
-        markdown-to-hiccup {:mvn/version "0.6.2"}
-        ;; leave this out; causes dependency issues
-        ;org.clojars.didiercrunch/clojupyter {:mvn/version "0.1.5"}
-        ;; must be above yaml for jvm compilation fix
+        markdown-clj/markdown-clj {:mvn/version "1.10.0"}
+        hickory/hickory {:mvn/version "0.7.1"}
+        markdown-to-hiccup/markdown-to-hiccup {:mvn/version "0.6.2"}
         org.flatland/ordered {:mvn/version "1.5.7"}
         io.forward/yaml {:mvn/version "1.0.9"}
-        commonmark-hiccup {:mvn/version "0.1.0"}
+        commonmark-hiccup/commonmark-hiccup {:mvn/version "0.1.0"}
         org.clojure/spec.alpha {:mvn/version "0.2.176"}
         irresponsible/tentacles {:mvn/version "0.6.3"}
-        respeced {:mvn/version "0.0.1"}
+        respeced/respeced {:mvn/version "0.0.1"}
         org.clojure/test.check {:mvn/version "0.10.0"}
-        hawk {:mvn/version "0.2.11"}
+        hawk/hawk {:mvn/version "0.2.11"}
         metasoarous/darkstar {:mvn/version "0.1.0"}}
         ;applied-science/darkstar {:git/url "https://github.com/applied-science/darkstar/"
                                   ;:sha "ef93147377d09a3894959c2c43faabf1a527a7d5"}}
         ;timofreiberg/bultitude {:mvn/version "0.3.0"}
         ;org.clojure/tools.namespace {:mvn/version "0.2.11"}
  :aliases {:dev {:extra-paths ["dev"]
-                 :extra-deps {alembic {:mvn/version "0.3.2"}}}
+                 :extra-deps {alembic/alembic {:mvn/version "0.3.2"}}}
                               ;binaryage/devtools {:mvn/version "0.9.10"}}}
-           :clojupyter {:extra-deps {clojupyter {:mvn/version "0.3.2"}}}
+           :clojupyter {:extra-deps {clojupyter/clojupyter {:mvn/version "0.3.2"
+                                                            :exclusions [hiccup/hiccup]}}}
+           :shadow-cljs {:extra-deps {thheller/shadow-cljs {:mvn/version "2.11.5"}
+                                      cider/cider-nrepl {:mvn/version "0.21.1"}}
+                         :main-opts ["-m" "shadow.cljs.devtools.cli"]}
+           :codox {:extra-deps {codox/codox {:mvn/version "0.10.7"}}
+                   :exec-fn codox.main/generate-docs
+                   :exec-args {:language :clojure
+                               :output-path "docs"}}
            :pack {:extra-deps {pack/pack.alpha {:git/url "https://github.com/juxt/pack.alpha.git"
                                                 :sha "c70740ffc10805f34836da2160fa1899601fac02"}}
                   :main-opts ["-m"]}}}

dev/user.clj

@@ -61,7 +61,7 @@
 
 
   ;; vega example
-  (def contour-plot (json/parse-string (slurp "resources/oz/examples/contour-lines.vega.json"))) 
+  (def contour-plot (json/parse-string (slurp "resources/oz/examples/vega/contour-lines.vega.json")))
   (oz/view! contour-plot :mode :vega)
 
   ;; Note that to publish vega, you must set :mode