Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

D3, now with more Lisp.

  • Loading branch information...
commit 191fc82d4b0aa5eab2c097fe059a51e00d6677b0 0 parents
Kevin Lynagh authored
11 .gitignore
@@ -0,0 +1,11 @@
+.cake
+pom.xml
+*.jar
+*.war
+lib
+classes
+build
+/cljs-d3
+resources/public/main.js
+resources/public/out
+
6 .gitmodules
@@ -0,0 +1,6 @@
+[submodule "vendor/clojurescript"]
+ path = vendor/clojurescript
+ url = https://github.com/clojure/clojurescript.git
+[submodule "vendor/d3"]
+ path = vendor/d3
+ url = https://github.com/mbostock/d3.git
227 LICENSE
@@ -0,0 +1,227 @@
+Eclipse Public License - v 1.0
+
+THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE
+PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF
+THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
+
+1. DEFINITIONS
+
+"Contribution" means:
+
+a) in the case of the initial Contributor, the initial code and
+documentation distributed under this Agreement, and
+
+b) in the case of each subsequent Contributor:
+
+i) changes to the Program, and
+
+ii) additions to the Program;
+
+where such changes and/or additions to the Program originate from and
+are distributed by that particular Contributor. A Contribution
+'originates' from a Contributor if it was added to the Program by such
+Contributor itself or anyone acting on such Contributor's
+behalf. Contributions do not include additions to the Program which:
+(i) are separate modules of software distributed in conjunction with
+the Program under their own license agreement, and (ii) are not
+derivative works of the Program.
+
+"Contributor" means any person or entity that distributes the Program.
+
+"Licensed Patents" mean patent claims licensable by a Contributor
+which are necessarily infringed by the use or sale of its Contribution
+alone or when combined with the Program.
+
+"Program" means the Contributions distributed in accordance with this
+Agreement.
+
+"Recipient" means anyone who receives the Program under this
+Agreement, including all Contributors.
+
+2. GRANT OF RIGHTS
+
+a) Subject to the terms of this Agreement, each Contributor hereby
+grants Recipient a non-exclusive, worldwide, royalty-free copyright
+license to reproduce, prepare derivative works of, publicly display,
+publicly perform, distribute and sublicense the Contribution of such
+Contributor, if any, and such derivative works, in source code and
+object code form.
+
+b) Subject to the terms of this Agreement, each Contributor hereby
+grants Recipient a non-exclusive, worldwide, royalty-free patent
+license under Licensed Patents to make, use, sell, offer to sell,
+import and otherwise transfer the Contribution of such Contributor, if
+any, in source code and object code form. This patent license shall
+apply to the combination of the Contribution and the Program if, at
+the time the Contribution is added by the Contributor, such addition
+of the Contribution causes such combination to be covered by the
+Licensed Patents. The patent license shall not apply to any other
+combinations which include the Contribution. No hardware per se is
+licensed hereunder.
+
+c) Recipient understands that although each Contributor grants the
+licenses to its Contributions set forth herein, no assurances are
+provided by any Contributor that the Program does not infringe the
+patent or other intellectual property rights of any other entity. Each
+Contributor disclaims any liability to Recipient for claims brought by
+any other entity based on infringement of intellectual property rights
+or otherwise. As a condition to exercising the rights and licenses
+granted hereunder, each Recipient hereby assumes sole responsibility
+to secure any other intellectual property rights needed, if any. For
+example, if a third party patent license is required to allow
+Recipient to distribute the Program, it is Recipient's responsibility
+to acquire that license before distributing the Program.
+
+d) Each Contributor represents that to its knowledge it has sufficient
+copyright rights in its Contribution, if any, to grant the copyright
+license set forth in this Agreement.
+
+3. REQUIREMENTS
+
+A Contributor may choose to distribute the Program in object code form
+under its own license agreement, provided that:
+
+a) it complies with the terms and conditions of this Agreement; and
+
+b) its license agreement:
+
+i) effectively disclaims on behalf of all Contributors all warranties
+and conditions, express and implied, including warranties or
+conditions of title and non-infringement, and implied warranties or
+conditions of merchantability and fitness for a particular purpose;
+
+ii) effectively excludes on behalf of all Contributors all liability
+for damages, including direct, indirect, special, incidental and
+consequential damages, such as lost profits;
+
+iii) states that any provisions which differ from this Agreement are
+offered by that Contributor alone and not by any other party; and
+
+iv) states that source code for the Program is available from such
+Contributor, and informs licensees how to obtain it in a reasonable
+manner on or through a medium customarily used for software exchange.
+
+When the Program is made available in source code form:
+
+a) it must be made available under this Agreement; and
+
+b) a copy of this Agreement must be included with each copy of the Program.
+
+Contributors may not remove or alter any copyright notices contained
+within the Program.
+
+Each Contributor must identify itself as the originator of its
+Contribution, if any, in a manner that reasonably allows subsequent
+Recipients to identify the originator of the Contribution.
+
+4. COMMERCIAL DISTRIBUTION
+
+Commercial distributors of software may accept certain
+responsibilities with respect to end users, business partners and the
+like. While this license is intended to facilitate the commercial use
+of the Program, the Contributor who includes the Program in a
+commercial product offering should do so in a manner which does not
+create potential liability for other Contributors. Therefore, if a
+Contributor includes the Program in a commercial product offering,
+such Contributor ("Commercial Contributor") hereby agrees to defend
+and indemnify every other Contributor ("Indemnified Contributor")
+against any losses, damages and costs (collectively "Losses") arising
+from claims, lawsuits and other legal actions brought by a third party
+against the Indemnified Contributor to the extent caused by the acts
+or omissions of such Commercial Contributor in connection with its
+distribution of the Program in a commercial product offering. The
+obligations in this section do not apply to any claims or Losses
+relating to any actual or alleged intellectual property
+infringement. In order to qualify, an Indemnified Contributor must: a)
+promptly notify the Commercial Contributor in writing of such claim,
+and b) allow the Commercial Contributor tocontrol, and cooperate with
+the Commercial Contributor in, the defense and any related settlement
+negotiations. The Indemnified Contributor may participate in any such
+claim at its own expense.
+
+For example, a Contributor might include the Program in a commercial
+product offering, Product X. That Contributor is then a Commercial
+Contributor. If that Commercial Contributor then makes performance
+claims, or offers warranties related to Product X, those performance
+claims and warranties are such Commercial Contributor's responsibility
+alone. Under this section, the Commercial Contributor would have to
+defend claims against the other Contributors related to those
+performance claims and warranties, and if a court requires any other
+Contributor to pay any damages as a result, the Commercial Contributor
+must pay those damages.
+
+5. NO WARRANTY
+
+EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS
+PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY
+WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY
+OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely
+responsible for determining the appropriateness of using and
+distributing the Program and assumes all risks associated with its
+exercise of rights under this Agreement , including but not limited to
+the risks and costs of program errors, compliance with applicable
+laws, damage to or loss of data, programs or equipment, and
+unavailability or interruption of operations.
+
+6. DISCLAIMER OF LIABILITY
+
+EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR
+ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING
+WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR
+DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED
+HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+7. GENERAL
+
+If any provision of this Agreement is invalid or unenforceable under
+applicable law, it shall not affect the validity or enforceability of
+the remainder of the terms of this Agreement, and without further
+action by the parties hereto, such provision shall be reformed to the
+minimum extent necessary to make such provision valid and enforceable.
+
+If Recipient institutes patent litigation against any entity
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+the Program itself (excluding combinations of the Program with other
+software or hardware) infringes such Recipient's patent(s), then such
+Recipient's rights granted under Section 2(b) shall terminate as of
+the date such litigation is filed.
+
+All Recipient's rights under this Agreement shall terminate if it
+fails to comply with any of the material terms or conditions of this
+Agreement and does not cure such failure in a reasonable period of
+time after becoming aware of such noncompliance. If all Recipient's
+rights under this Agreement terminate, Recipient agrees to cease use
+and distribution of the Program as soon as reasonably
+practicable. However, Recipient's obligations under this Agreement and
+any licenses granted by Recipient relating to the Program shall
+continue and survive.
+
+Everyone is permitted to copy and distribute copies of this Agreement,
+but in order to avoid inconsistency the Agreement is copyrighted and
+may only be modified in the following manner. The Agreement Steward
+reserves the right to publish new versions (including revisions) of
+this Agreement from time to time. No one other than the Agreement
+Steward has the right to modify this Agreement. The Eclipse Foundation
+is the initial Agreement Steward. The Eclipse Foundation may assign
+the responsibility to serve as the Agreement Steward to a suitable
+separate entity. Each new version of the Agreement will be given a
+distinguishing version number. The Program (including Contributions)
+may always be distributed subject to the version of the Agreement
+under which it was received. In addition, after a new version of the
+Agreement is published, Contributor may elect to distribute the
+Program (including its Contributions) under the new version. Except as
+expressly stated in Sections 2(a) and 2(b) above, Recipient receives
+no rights or licenses to the intellectual property of any Contributor
+under this Agreement, whether expressly, by implication, estoppel or
+otherwise. All rights in the Program not expressly granted under this
+Agreement are reserved.
+
+This Agreement is governed by the laws of the State of Washington and
+the intellectual property laws of the United States of America. No
+party to this Agreement will bring a legal action under this Agreement
+more than one year after the cause of action arose. Each party waives
+its rights to a jury trial in any resulting litigation.
135 README.markdown
@@ -0,0 +1,135 @@
+ _ _ _ _____
+ ___ | | (_) ___ __| ||___ /
+ / __|| | | |/ __| _____ / _` | |_ \
+ | (__ | | | |\__ \|_____|| (_| | ___) |
+ \___||_|_/ ||___/ \__,_||____/
+ |__/
+
+ Data driven documents, now with more Lisp!
+ http://keminglabs.com/cljs-d3/
+
+
+Cljs-d3 is a ClojureScript façade for the [D3](http://mbostock.github.com/d3/) JavaScript DOM-manipulation library.
+It transparently coerces ClojureScript data types into the appropriate JavaScript objects and provides a more Clojure-like API to some of the D3 functions:
+
+
+```clojure
+(ns sample
+ (:require [cljs-d3.core :as d3]
+ [cljs-d3.scales :as scales]))
+
+(defn rand [] ((.random js/Math)))
+
+(let [Width 400 ;;Width in pixels
+ n 100 ;;Number of data
+ scale (scales/linear :domain [0 1] :range [0 Width])
+
+ sample-data (for [_ (range n)]
+ {:x (rand)
+ :y (rand)
+ :class (if (> (rand) 0.5)
+ "A" "B")})
+
+ scatterplot (-> d3/d3 (d3/select "#example")
+ (d3/append "svg:svg")
+ (d3/style {:border "2px solid darkGray"
+ :border-radius 8})
+ (d3/attr {:width Width
+ :height Width}))
+
+ points (-> scatterplot
+ (d3/selectAll "circle.num")
+ (d3/data sample-data)
+ (d3/enter)(d3/append "svg:circle")
+ (d3/attr {:class "num"
+ :r 5
+ :fill #(condp = (:class %)
+ "A" "darkRed"
+ "B" "darkBlue")
+ :cx #(scale (:x %))
+ :cy #(scale (:y %))}))
+
+ ])
+```
+
+For more details and examples, see [http://keminglabs.com/cljs-d3/](http://keminglabs.com/cljs-d3/).
+
+Install
+=======
+
+Checkout the repository,
+
+```bash
+mkdir vendor
+git submodule add https://github.com/lynaghk/cljs-d3 vendor/cljs-d3
+```
+
+And then add the sources to your classpath.
+If you are using `cake`, for instance, open up `<your project>/.cake/config` and add the line
+
+ project.classpath = vendor/cljs-d3/src/clj:vendor/cljs-d3/src/cljs
+
+And then in your ClojureScript files just
+
+```clojure
+(:require [cljs-d3.core :as d3])
+```
+
+Experimentation / Development
+=============================
+
+If you want to work on cljs-d3 itself or just want a sandbox to play in, this repository has everything you need.
+First run
+
+ git submodule update --init
+
+to get D3 and the ClojureScript compiler as git submodules, then bootstrap-install Clojurescript:
+
+ cd vendor/clojurescript
+ ./script/bootstrap
+
+Then you can use the `compile.clj` script to compile ClojureScript examples, which you can view locally:
+
+```bash
+cake run compile.clj samples/scatterplot.cljs
+google-chrome resources/public/index.html
+```
+
+Pull Requests
+=============
+
+Pull requests are welcome; if you want to discuss something before you code it up, feel free to open an issue or send me a [github msg](https://github.com/inbox/new/lynaghk).
+
+
+Todo
+====
+
+We are writing façades as we need them, so some D3 functions may be missing.
+If you want something, please send us a note or pull request.
+
+If ClojureScript doesn't get `(:use)` soon, then we might write a macro for chaining D3 calls without namespace prefix; i.e.,
+
+```clojure
+scatterplot (d3-> d3 (select "#example")
+ (append "svg:svg")
+ (style {:border "2px solid darkGray"
+ :border-radius 8})
+```
+
+instead of
+
+```clojure
+scatterplot (-> d3/d3 (d3/select "#example")
+ (d3/append "svg:svg")
+ (d3/style {:border "2px solid darkGray"
+ :border-radius 8})
+```
+
+(because we hate typing).
+
+
+Thanks
+======
+Mike Bostock for D3 and the Clojure core team for their rad work on Clojure(Script).
+
+This project is sponsored by [Keming Labs](http://keminglabs.com), a technical design studio specializing in data visualization.
7 compile.clj
@@ -0,0 +1,7 @@
+(require '[cljs.closure :as closure])
+
+(if (= 1 (count *command-line-args*))
+ (closure/build (first *command-line-args*) {:optimizations :simple ;;TODO: Advanced compilation chokes on SVG handling in D3
+ :output-dir "resources/public/out"
+ :output-to "resources/public/main.js"})
+ (println "compile.clj requires one argument: path to cljs file to compile"))
3  project.clj
@@ -0,0 +1,3 @@
+(defproject cljs-d3 "0.0.1-SNAPSHOT"
+ :description "A ClojureScript façade for the D3 JavaScript library"
+ :dependencies [[org.clojure/clojure "1.3.0-beta1"]])
1  resources/public/d3
13 resources/public/index.html
@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html lang='en'>
+<head>
+<meta charset='utf-8'>
+<meta content='IE=edge,chrome=1' http-equiv='X-UA-Compatible'>
+<title>cljs-d3 example</title>
+</head>
+<body>
+<div id="example"></div>
+<script src='d3/d3.js'></script>
+<script src='main.js'></script>
+</body>
+</html>
36 samples/scatterplot.cljs
@@ -0,0 +1,36 @@
+(ns sample
+ (:require [cljs-d3.core :as d3]
+ [cljs-d3.scales :as scales]))
+
+(defn rand [] ((.random js/Math)))
+
+(let [Width 400 ;;Width in pixels
+ n 100 ;;Number of data
+ scale (scales/linear :domain [0 1] :range [0 Width])
+
+ sample-data (for [_ (range n)]
+ {:x (rand)
+ :y (rand)
+ :class (if (> (rand) 0.5)
+ "A" "B")})
+
+ scatterplot (-> d3/d3 (d3/select "#example")
+ (d3/append "svg:svg")
+ (d3/style {:border "2px solid darkGray"
+ :border-radius 8})
+ (d3/attr {:width Width
+ :height Width}))
+
+ points (-> scatterplot
+ (d3/selectAll "circle.num")
+ (d3/data sample-data)
+ (d3/enter)(d3/append "svg:circle")
+ (d3/attr {:class "num"
+ :r 5
+ :fill #(condp = (:class %)
+ "A" "darkRed"
+ "B" "darkBlue")
+ :cx #(scale (:x %))
+ :cy #(scale (:y %))}))
+
+ ])
35 src/clj/cljs_d3/macros.clj
@@ -0,0 +1,35 @@
+(ns cljs-d3.macros)
+
+(defmacro attr
+ "Call JavaScript function, replacing Clojure map with JavaScript object"
+ [d3 attr-map]
+ (let [d3# d3]
+ `(do
+ ~@(for [[k# v#] attr-map]
+ `(.attr ~d3# ~k# ~v#))
+ ~d3#)))
+
+(defmacro $ready
+ "Call forms on document ready"
+ [& forms]
+ `(.ready (js/jQuery "document")
+ #(do ~@forms)))
+
+(defmacro debug
+ "Call a function to print D3 data and indexes at this point"
+ [d3]
+ `(.call ~d3 (fn [d i]
+ (js/p d)
+ (js/p i))))
+
+(defmacro shim [name]
+ "Define a proxy to native D3 method"
+ `(defn ~name [sel# & args#]
+ (apply (. sel# ~name) args#)))
+
+(defmacro shim-if [name & args]
+ "Inline proxy for a D3 method, if true.
+ Works for argument-less mutators like `.nice()` as well as things like `.domain([0 1])`"
+ (if (seq args)
+ `(fn [x# test#] (if test# (. x# ~name ~@args) x#))
+ `(fn [x# test#] (if test# (. x# (~name)) x#))))
89 src/cljs/cljs_d3/core.cljs
@@ -0,0 +1,89 @@
+(ns cljs-d3.core
+ (:require-macros [cljs-d3.macros :as d3m]))
+
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;;Some nice JavaScript helpers
+
+(defn kstr
+ "Stringify keywords"
+ [k] (if (keyword? k) (name k) k))
+
+(defn pxstr
+ "Converts a number to a string with suffix 'px'"
+ [v] (if (number? v) (str v "px") v))
+
+(defn jsArr
+ "Recursively converts a sequential object into a JavaScript array"
+ [seq]
+ (.array (vec (map #(if (sequential? %) (jsArr %) %)
+ seq))))
+
+(defn jsObj
+ "Convert a clojure map into a JavaScript object"
+ [obj]
+ (into {} (map (fn [[k v]]
+ (let [k (if (keyword? k) (name k) k)
+ v (if (keyword? v) (name v) v)]
+ (if (map? v)
+ [k (jsObj v)]
+ [k v])))
+ obj)))
+
+(defn p [x]
+ (.log js/console (cond
+ (sequential? x) (jsArr x)
+ (map? x) (jsObj x)
+ :else x)))
+
+
+
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;;D3 shims
+(def d3 js/d3)
+(d3m/shim select)
+(d3m/shim selectAll)
+(d3m/shim classed)
+(d3m/shim property)
+(d3m/shim text)
+(d3m/shim html)
+
+(d3m/shim append)
+(d3m/shim insert)
+(d3m/shim remove)
+
+(d3m/shim on)
+
+(d3m/shim enter)
+(d3m/shim exit)
+
+
+
+;;TODO: Replace attr & style with macros so map arguments expand at compile time
+(defn attr
+ ([sel x]
+ (if (map? x)
+ (doseq [[k v] x] (.attr sel (kstr k) v))
+ (.attr sel x))
+ sel)
+ ([sel k v] (.attr sel (kstr k) v)))
+
+(defn style
+ ([sel x]
+ (if (map? x)
+ (doseq [[k v] x] (.style sel (kstr k) (pxstr v)))
+ (.style sel (pxstr x)))
+ sel)
+ ([sel k v] (.style sel (kstr k) (pxstr v))))
+
+(defn data [sel x]
+ (.data sel (if (sequential? x)
+ (jsArr x)
+ #(jsArr (apply x %&)))))
+
+
+(defn transition [sel & {:keys [duration delay]
+ :or {duration 250
+ delay 0}}]
+ (-> (. sel (transition))
+ (.duration duration)
+ (.delay delay)))
18 src/cljs/cljs_d3/scales.cljs
@@ -0,0 +1,18 @@
+(ns cljs-d3.scales
+ (:require [cljs-d3.core :as d3])
+ (:require-macros [cljs-d3.macros :as d3m]))
+
+(defn linear
+ [& {:keys [domain range nice]
+ :or {domain [0 1]
+ range [0 1]
+ rangeRound nil
+ nice false
+ clamp false}}]
+
+ (-> (.. js/d3 scale (linear))
+ (.domain (d3/jsArr domain))
+ (.range (d3/jsArr range))
+ ((d3m/shim-if rangeRound (d3/jsArr rangeRound)))
+ ((d3m/shim-if nice))
+ ((d3m/shim-if clamp))))
1  vendor/clojurescript
@@ -0,0 +1 @@
+Subproject commit 91be59bb891b3635899ee5e23bc4e8e06e4b5a62
1  vendor/d3
@@ -0,0 +1 @@
+Subproject commit bf180dc9afa60c945d8410002eab60dac2c4493a
Please sign in to comment.
Something went wrong with that request. Please try again.