├── .gitignore ├── CHANGELOG.md ├── LICENSE ├── README.md ├── basics.png ├── deps.edn ├── dev-resources └── user.clj ├── project.clj ├── save-function.png └── src └── com └── walmartlabs └── datascope.clj /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | /classes 3 | /checkouts 4 | pom.xml 5 | pom.xml.asc 6 | *.jar 7 | *.class 8 | /.lein-* 9 | /.nrepl-port 10 | .hgignore 11 | .hg/ 12 | .idea 13 | *.iml 14 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | ## 0.1.1 - 30 Sep 2016 2 | 3 | Empty collections now render as if they were scalars. 4 | 5 | Functions now render as their demangled names. 6 | 7 | Note: HTML-like labels are not rendering correctly on my machine. 8 | Your mileage my vary. 9 | 10 | ## 0.1.0 - 17 Jun 2016 11 | 12 | Initial release 13 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, and 10 | distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by the copyright 13 | owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all other entities 16 | that control, are controlled by, or are under common control with that entity. 17 | For the purposes of this definition, "control" means (i) the power, direct or 18 | indirect, to cause the direction or management of such entity, whether by 19 | contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the 20 | outstanding shares, or (iii) beneficial ownership of such entity. 21 | 22 | "You" (or "Your") shall mean an individual or Legal Entity exercising 23 | permissions granted by this License. 24 | 25 | "Source" form shall mean the preferred form for making modifications, including 26 | but not limited to software source code, documentation source, and configuration 27 | files. 28 | 29 | "Object" form shall mean any form resulting from mechanical transformation or 30 | translation of a Source form, including but not limited to compiled object code, 31 | generated documentation, and conversions to other media types. 32 | 33 | "Work" shall mean the work of authorship, whether in Source or Object form, made 34 | available under the License, as indicated by a copyright notice that is included 35 | in or attached to the work (an example is provided in the Appendix below). 36 | 37 | "Derivative Works" shall mean any work, whether in Source or Object form, that 38 | is based on (or derived from) the Work and for which the editorial revisions, 39 | annotations, elaborations, or other modifications represent, as a whole, an 40 | original work of authorship. For the purposes of this License, Derivative Works 41 | shall not include works that remain separable from, or merely link (or bind by 42 | name) to the interfaces of, the Work and Derivative Works thereof. 43 | 44 | "Contribution" shall mean any work of authorship, including the original version 45 | of the Work and any modifications or additions to that Work or Derivative Works 46 | thereof, that is intentionally submitted to Licensor for inclusion in the Work 47 | by the copyright owner or by an individual or Legal Entity authorized to submit 48 | on behalf of the copyright owner. For the purposes of this definition, 49 | "submitted" means any form of electronic, verbal, or written communication sent 50 | to the Licensor or its representatives, including but not limited to 51 | communication on electronic mailing lists, source code control systems, and 52 | issue tracking systems that are managed by, or on behalf of, the Licensor for 53 | the purpose of discussing and improving the Work, but excluding communication 54 | that is conspicuously marked or otherwise designated in writing by the copyright 55 | owner as "Not a Contribution." 56 | 57 | "Contributor" shall mean Licensor and any individual or Legal Entity on behalf 58 | of whom a Contribution has been received by Licensor and subsequently 59 | incorporated within the Work. 60 | 61 | 2. Grant of Copyright License. 62 | 63 | Subject to the terms and conditions of this License, each Contributor hereby 64 | grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, 65 | irrevocable copyright license to reproduce, prepare Derivative Works of, 66 | publicly display, publicly perform, sublicense, and distribute the Work and such 67 | Derivative Works in Source or Object form. 68 | 69 | 3. Grant of Patent License. 70 | 71 | Subject to the terms and conditions of this License, each Contributor hereby 72 | grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, 73 | irrevocable (except as stated in this section) patent license to make, have 74 | made, use, offer to sell, sell, import, and otherwise transfer the Work, where 75 | such license applies only to those patent claims licensable by such Contributor 76 | that are necessarily infringed by their Contribution(s) alone or by combination 77 | of their Contribution(s) with the Work to which such Contribution(s) was 78 | submitted. If You institute patent litigation against any entity (including a 79 | cross-claim or counterclaim in a lawsuit) alleging that the Work or a 80 | Contribution incorporated within the Work constitutes direct or contributory 81 | patent infringement, then any patent licenses granted to You under this License 82 | for that Work shall terminate as of the date such litigation is filed. 83 | 84 | 4. Redistribution. 85 | 86 | You may reproduce and distribute copies of the Work or Derivative Works thereof 87 | in any medium, with or without modifications, and in Source or Object form, 88 | provided that You meet the following conditions: 89 | 90 | You must give any other recipients of the Work or Derivative Works a copy of 91 | this License; and 92 | You must cause any modified files to carry prominent notices stating that You 93 | changed the files; and 94 | You must retain, in the Source form of any Derivative Works that You distribute, 95 | all copyright, patent, trademark, and attribution notices from the Source form 96 | of the Work, excluding those notices that do not pertain to any part of the 97 | Derivative Works; and 98 | If the Work includes a "NOTICE" text file as part of its distribution, then any 99 | Derivative Works that You distribute must include a readable copy of the 100 | attribution notices contained within such NOTICE file, excluding those notices 101 | that do not pertain to any part of the Derivative Works, in at least one of the 102 | following places: within a NOTICE text file distributed as part of the 103 | Derivative Works; within the Source form or documentation, if provided along 104 | with the Derivative Works; or, within a display generated by the Derivative 105 | Works, if and wherever such third-party notices normally appear. The contents of 106 | the NOTICE file are for informational purposes only and do not modify the 107 | License. You may add Your own attribution notices within Derivative Works that 108 | You distribute, alongside or as an addendum to the NOTICE text from the Work, 109 | provided that such additional attribution notices cannot be construed as 110 | modifying the License. 111 | You may add Your own copyright statement to Your modifications and may provide 112 | additional or different license terms and conditions for use, reproduction, or 113 | distribution of Your modifications, or for any such Derivative Works as a whole, 114 | provided Your use, reproduction, and distribution of the Work otherwise complies 115 | with the conditions stated in this License. 116 | 117 | 5. Submission of Contributions. 118 | 119 | Unless You explicitly state otherwise, any Contribution intentionally submitted 120 | for inclusion in the Work by You to the Licensor shall be under the terms and 121 | conditions of this License, without any additional terms or conditions. 122 | Notwithstanding the above, nothing herein shall supersede or modify the terms of 123 | any separate license agreement you may have executed with Licensor regarding 124 | such Contributions. 125 | 126 | 6. Trademarks. 127 | 128 | This License does not grant permission to use the trade names, trademarks, 129 | service marks, or product names of the Licensor, except as required for 130 | reasonable and customary use in describing the origin of the Work and 131 | reproducing the content of the NOTICE file. 132 | 133 | 7. Disclaimer of Warranty. 134 | 135 | Unless required by applicable law or agreed to in writing, Licensor provides the 136 | Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, 137 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, 138 | including, without limitation, any warranties or conditions of TITLE, 139 | NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are 140 | solely responsible for determining the appropriateness of using or 141 | redistributing the Work and assume any risks associated with Your exercise of 142 | permissions under this License. 143 | 144 | 8. Limitation of Liability. 145 | 146 | In no event and under no legal theory, whether in tort (including negligence), 147 | contract, or otherwise, unless required by applicable law (such as deliberate 148 | and grossly negligent acts) or agreed to in writing, shall any Contributor be 149 | liable to You for damages, including any direct, indirect, special, incidental, 150 | or consequential damages of any character arising as a result of this License or 151 | out of the use or inability to use the Work (including but not limited to 152 | damages for loss of goodwill, work stoppage, computer failure or malfunction, or 153 | any and all other commercial damages or losses), even if such Contributor has 154 | been advised of the possibility of such damages. 155 | 156 | 9. Accepting Warranty or Additional Liability. 157 | 158 | While redistributing the Work or Derivative Works thereof, You may choose to 159 | offer, and charge a fee for, acceptance of support, warranty, indemnity, or 160 | other liability obligations and/or rights consistent with this License. However, 161 | in accepting such obligations, You may act only on Your own behalf and on Your 162 | sole responsibility, not on behalf of any other Contributor, and only if You 163 | agree to indemnify, defend, and hold each Contributor harmless for any liability 164 | incurred by, or claims asserted against, such Contributor by reason of your 165 | accepting any such warranty or additional liability. 166 | 167 | END OF TERMS AND CONDITIONS 168 | 169 | APPENDIX: How to apply the Apache License to your work 170 | 171 | To apply the Apache License to your work, attach the following boilerplate 172 | notice, with the fields enclosed by brackets "[]" replaced with your own 173 | identifying information. (Don't include the brackets!) The text should be 174 | enclosed in the appropriate comment syntax for the file format. We also 175 | recommend that a file or class name and description of purpose be included on 176 | the same "printed page" as the copyright notice for easier identification within 177 | third-party archives. 178 | 179 | Copyright [yyyy] [name of copyright owner] 180 | 181 | Licensed under the Apache License, Version 2.0 (the "License"); 182 | you may not use this file except in compliance with the License. 183 | You may obtain a copy of the License at 184 | 185 | http://www.apache.org/licenses/LICENSE-2.0 186 | 187 | Unless required by applicable law or agreed to in writing, software 188 | distributed under the License is distributed on an "AS IS" BASIS, 189 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 190 | See the License for the specific language governing permissions and 191 | limitations under the License. 192 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # walmartlabs/datascope 2 | 3 | A library that can be used to render typical Clojure data structures using 4 | Graphviz. 5 | 6 | [![Clojars Project](https://img.shields.io/clojars/v/walmartlabs/datascope.svg)](https://clojars.org/walmartlabs/datascope) 7 | 8 | [API Documentation](http://walmartlabs.github.io/apidocs/datascope/) 9 | 10 | ## Usage 11 | 12 | Pretty printing can only take you so far; eventually 13 | a different visual representation is handy for really seeing how all you 14 | data is connected and related. 15 | 16 | 17 | ``` 18 | (require '[com.walmartlabs.datascope :as ds]) 19 | 20 | (ds/view {:missing nil 21 | :string "A scalar." 22 | :n 10 23 | :enabled? true 24 | :vector [1 2 3 4] 25 | :sequence (iterate inc 1) 26 | :set #{:science-fiction :romance :military} 27 | :atom (atom {:foo :bar :empty {}}) 28 | :empty {}}) 29 | ``` 30 | 31 | This will bring up a frame (care of [Rhizome](https://github.com/ztellman/rhizome)) 32 | that displays the following: 33 | 34 | ![example](basics.png) 35 | 36 | * Maps, Sets, and Sequences have rounded edges, Vectors have square edges. 37 | 38 | * Composite types are labeled with their (abbreviated) type. 39 | 40 | * Refs, such as Atoms and Vars, are supported. 41 | 42 | * Sequences are abbreviated; Maps, Sets, and Vectors are always fully rendered. 43 | 44 | * Functions are rendered as their de-mangled Clojure name. 45 | 46 | Using the rest of the Rhizome API, you can easily save the images to disk 47 | instead of viewing them in a frame. 48 | 49 | And, remember, Clojure code is data: 50 | 51 | 52 | ``` 53 | (require '[com.walmartlabs.datascope :as ds]) 54 | 55 | (ds/view 56 | '(defn save 57 | [root-object file-name] 58 | (-> (dot root-object) 59 | viz/dot->image 60 | (viz/save-image file-name)))) 61 | ``` 62 | 63 | ![save-function](save-function.png) 64 | 65 | ## Upcoming Features 66 | 67 | * Optional rendering of meta data 68 | 69 | * Depth limit on rendering 70 | 71 | * Open up more internal API to support rendering of more types 72 | 73 | * Rendering of JavaBeans 74 | 75 | ## License 76 | 77 | Copyright © 2016 Walmartlabs 78 | 79 | Distributed under the terms of the Apache Software License 2.0. 80 | -------------------------------------------------------------------------------- /basics.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/walmartlabs/datascope/91d8af62a053e793b629a50948333b16da17e9a7/basics.png -------------------------------------------------------------------------------- /deps.edn: -------------------------------------------------------------------------------- 1 | {:paths ["src"] 2 | :deps {org.clojure/clojure {:mvn/version "1.8.0"} 3 | io.aviso/pretty {:mvn/version "0.1.30"} 4 | rhizome {:mvn/version "0.2.5"}}} 5 | -------------------------------------------------------------------------------- /dev-resources/user.clj: -------------------------------------------------------------------------------- 1 | (ns user 2 | (:require [com.walmartlabs.datascope :refer [render-composite dot view]] 3 | [clojure.pprint :refer [pprint]] 4 | [rhizome.viz :as viz])) 5 | 6 | (alter-var-root #'*print-length* (constantly 15)) 7 | 8 | (def example-1 ; basics.png 9 | {:n 10 10 | :string "A scalar." 11 | :vector [1 2 3 4] 12 | :empty {} 13 | :enabled? true 14 | :sequence (iterate inc 1) 15 | :missing nil 16 | :set #{:science-fiction :military :romance} 17 | :atom (atom {:foo :bar :empty {}})}) 18 | 19 | (def common-objects 20 | (let [a {:map :a} 21 | b {:map :b 22 | :a a}] 23 | {:map :root 24 | :string "a simple string" 25 | :a a 26 | :b b 27 | :nil nil 28 | :my-fn #(inc %) 29 | :core-fn inc 30 | :vector [:vector :c a b] 31 | :set #{:set a b} 32 | :atom (atom a)})) 33 | 34 | (def instaparse-document [:document 35 | [:definition 36 | [:operation-definition 37 | [:selection-set 38 | [:selection 39 | [:field 40 | [:name "customer"] 41 | [:arguments 42 | [:argument 43 | [:name "id"] 44 | [:value 45 | [:string-value 46 | [:string-character [:source-character "9"]] 47 | [:string-character [:source-character "0"]] 48 | [:string-character [:source-character "1"]] 49 | [:string-character [:source-character "2"]] 50 | [:string-character [:source-character "5"]]]]]] 51 | [:selection-set 52 | [:selection [:field [:name "name"]]] 53 | [:selection [:field [:name "email"]]] 54 | [:selection 55 | [:field 56 | [:name "transactions"] 57 | [:arguments [:argument [:name "max"] [:value [:int-value [:integer-part [:non-zero-digit "1"] [:digit "0"]]]]]] 58 | [:selection-set [:selection [:field [:name "total"]]] [:selection [:field [:name "item_count"]]]]]]]]] 59 | [:selection [:field [:name "state"]]]]]]]) 60 | 61 | 62 | (defn save 63 | [root-object file-name] 64 | (-> (dot root-object) 65 | viz/dot->image 66 | (viz/save-image file-name))) 67 | 68 | -------------------------------------------------------------------------------- /project.clj: -------------------------------------------------------------------------------- 1 | (defproject walmartlabs/datascope "0.1.1" 2 | :description "Visualization of Clojure data structures using Graphviz" 3 | :url "https://github.com/walmartlabs/datascope" 4 | :license {:name "Apache Sofware License 2.0" 5 | :url "http://www.apache.org/licenses/LICENSE-2.0.html"} 6 | :plugins [[lein-codox "0.9.3"]] 7 | :dependencies [[org.clojure/clojure "1.9.0"] 8 | [io.aviso/pretty "0.1.34"] 9 | [rhizome "0.2.9"]] 10 | :aliases {"release" ["do" 11 | "clean," 12 | "deploy" "clojars"]} 13 | :codox {:source-uri "https://github.com/walmartlabs/datascope/blob/master/{filepath}#L{line}" 14 | :metadata {:doc/format :markdown}}) 15 | -------------------------------------------------------------------------------- /save-function.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/walmartlabs/datascope/91d8af62a053e793b629a50948333b16da17e9a7/save-function.png -------------------------------------------------------------------------------- /src/com/walmartlabs/datascope.clj: -------------------------------------------------------------------------------- 1 | (ns com.walmartlabs.datascope 2 | (:require [rhizome.viz :as viz] 3 | [clojure.string :as str] 4 | [io.aviso.exception :refer [demangle]]) 5 | (:import [clojure.lang ISeq IPersistentVector IPersistentMap IDeref IPersistentSet AFn Symbol])) 6 | 7 | (defn ^:private html-safe 8 | [s] 9 | (-> s 10 | (str/replace "&" "&") 11 | (str/replace "<" "<") 12 | (str/replace ">" ">"))) 13 | 14 | (defn ^:private demangle-fn 15 | [f] 16 | (let [class-name (-> f ^Class type .getName) 17 | [namespace-name & raw-function-ids] (str/split class-name #"\$") 18 | ;; Clojure adds __1234 unique ids to the ends of things, remove those. 19 | function-ids (map #(str/replace % #"__\d+" "") raw-function-ids)] 20 | ;; The assumption is that no real namespace or function name will contain underscores (the underscores 21 | ;; are name-mangled dashes). 22 | (->> 23 | (cons namespace-name function-ids) 24 | (map demangle) 25 | (str/join "/")))) 26 | 27 | (defprotocol Scalar 28 | "Scalars appear as keys and values and this protocol assists with rendering of them as such." 29 | 30 | (as-label [v] 31 | "Return the text representation of a value such that it can be included as a label for a key or value. 32 | 33 | The returned value should be HTML safe.")) 34 | 35 | (extend-protocol Scalar 36 | 37 | Object 38 | (as-label [v] (-> v pr-str html-safe)) 39 | 40 | Symbol 41 | (as-label [v] 42 | (str "" (-> v pr-str html-safe) "")) 43 | 44 | AFn 45 | (as-label [f] 46 | (str "" (demangle-fn f) "")) 47 | 48 | nil 49 | (as-label [_] "nil")) 50 | 51 | (defprotocol Composite 52 | "A non-scalar type, which wraps one or more values (e.g., map, sequence, vector, reference, etc.)" 53 | (render-as-scalar? [v] 54 | "Returns true if should be rendered as a scalar. Typically, this means an empty collection.") 55 | 56 | (composite-type [v] 57 | "Returns :map, :seq, :vec, etc. This key is used when generating Graphviz node ids.") 58 | 59 | (render-composite [v state] 60 | "Renders the value as a new node (this is often quite recursive). 61 | 62 | Returns a tuple of the new state, and the node-id just rendered. 63 | 64 | State has a number of keys: 65 | 66 | :values 67 | : map from a non-scalar value to its unique node id; this is used to create edges, and track 68 | which values have already been rendered. The key is the default hash code for the 69 | value (e.g., keyed on identity, not on value). 70 | 71 | :nodes 72 | : map from node id to the text to render for that node (outer brackets are supplied). 73 | 74 | :edges 75 | : map from node id to node id; the source node is may be extended with a port (e.g., \"map_1:v3\")\"")) 76 | 77 | (def ^:private label-start "label=<") 78 | 79 | (def ^:private label-end "
>") 80 | 81 | (defn ^:private composite-key 82 | [value] 83 | (System/identityHashCode value)) 84 | 85 | (defn ^:private value->node-id 86 | "Computes a unique Graphviz node id for the value (based on the value's composite type and 87 | composite key)." 88 | [value] 89 | (str (name (composite-type value)) "_" (composite-key value))) 90 | 91 | (defn ^:private maybe-render 92 | "Maybe render the value (recursively). 93 | 94 | For composite values, returns a tuple of the state (updated state, 95 | if the value was a recursive render) and the (preiously) rendered node id. 96 | 97 | For scalar values, returns a tuple of state and nil." 98 | [state v] 99 | ;; Anything not a Composite is a Scalar 100 | (cond 101 | (not (satisfies? Composite v)) 102 | [state nil] 103 | 104 | (render-as-scalar? v) 105 | [state nil] 106 | 107 | :else 108 | (let [type (composite-type v) 109 | k (composite-key v)] 110 | (if-let [node-id (get-in state [:values type k])] 111 | [state node-id] 112 | (render-composite v state))))) 113 | 114 | (defn ^:private type-name 115 | [obj] 116 | (str "" 117 | (-> obj 118 | class 119 | .getName 120 | (str/replace #"^clojure\.lang\." "") 121 | html-safe) 122 | "")) 123 | 124 | (defn ^:private type-name-row 125 | [obj] 126 | (str "" 127 | (type-name obj) 128 | "")) 129 | 130 | (defn ^:private cell 131 | [state id prefix v i] 132 | (let [[state' value-id] (maybe-render state v) 133 | scalar? (nil? value-id) 134 | port (when-not scalar? (str (name prefix) i)) 135 | new-state (if port 136 | (assoc-in state' [:edges (str id ":" port)] value-id) 137 | state')] 138 | [new-state (str (if port 139 | (str " ") 140 | "") 141 | (when scalar? 142 | (as-label v)) 143 | "")])) 144 | 145 | (defn ^:private add-composite-mapping 146 | "Store a composite value for later access (this prevents identical or same nodes from being rendered 147 | multiple times). Keyed on the value's composite type, then the composite value itself, the ultimate value is the 148 | node-id. 149 | 150 | Sequences may be infinite and can't be used as keys, so in some cases, 151 | no mapping is added: equivalent sequences will render as distinct nodes." 152 | [state value node-id] 153 | (let [k (composite-key value)] 154 | (assoc-in state [:values (composite-type value) k] node-id))) 155 | 156 | (defn ^:private add-node 157 | [state node-id node] 158 | "Add the rendered text for a node for later inclusion into the DOT output." 159 | (assoc-in state [:nodes node-id] node)) 160 | 161 | (defn ^:private render-map 162 | [state m] 163 | (let [node-id (value->node-id m) 164 | reduction-step (fn [state k v i] 165 | (let [[k-state k-chunk] (cell state node-id :k k i) 166 | [v-state v-chunk] (cell k-state node-id :v v i)] 167 | [v-state (str "" 168 | k-chunk 169 | v-chunk 170 | "")])) 171 | ikvs (map-indexed (fn [i [k v]] 172 | [i k v]) 173 | m) 174 | reducer (fn [[state rows-chunk] [i k v]] 175 | (let [[state' row-chunk] (reduction-step state k v i)] 176 | [state' (str rows-chunk row-chunk)])) 177 | [state' key-value-rows] (reduce reducer 178 | [(add-composite-mapping state m node-id) ""] 179 | ikvs)] 180 | [(add-node state' node-id 181 | (str label-start 182 | "" 183 | (type-name m) 184 | "" 185 | key-value-rows 186 | label-end)) 187 | node-id])) 188 | 189 | (defn ^:private render-ref 190 | [state ref] 191 | (let [node-id (value->node-id ref) 192 | ref-val (deref ref) 193 | [state-1 target-node-id] (maybe-render state ref-val) 194 | label (str "<" 195 | (type-name ref) 196 | "" 197 | (when-not target-node-id 198 | (str "
" (-> ref-val as-label html-safe))) 199 | ">") 200 | state-2 (cond-> (-> state-1 201 | (add-composite-mapping ref node-id) 202 | (add-node node-id 203 | (str "shape=ellipse, label=" label))) 204 | target-node-id (assoc-in [:edges node-id] target-node-id))] 205 | [state-2 node-id])) 206 | 207 | (defn ^:private render-elements 208 | "Renders the elements as a series of TR/TD rows. Returns tuple of updated state and 209 | the rendered elements (as a string)." 210 | [state node-id coll] 211 | (let [reducer (fn [[state label-chunk] i v] 212 | (let [[state' cell-chunk] (cell state node-id :i v i)] 213 | [state' (str label-chunk "" cell-chunk "")]))] 214 | (reduce-kv reducer 215 | [(add-composite-mapping state coll node-id) ""] 216 | coll))) 217 | 218 | (defn ^:private render-vector 219 | [state v] 220 | (let [node-id (value->node-id v) 221 | [state' element-rows] (render-elements state node-id v)] 222 | [(add-node state' node-id 223 | (str "style=filled, " 224 | label-start 225 | (type-name-row v) 226 | element-rows 227 | label-end)) 228 | node-id])) 229 | 230 | (defn ^:private render-seq 231 | [state coll] 232 | (let [node-id (value->node-id coll) 233 | max-seq (:max-seq state 10) 234 | reducer (fn [[state label-chunk] [i v]] 235 | (if (= i max-seq) 236 | (reduced [state (str label-chunk "...")]) 237 | (let [[state' cell-chunk] (cell state node-id :i v i)] 238 | [state' (str label-chunk "" cell-chunk "")]))) 239 | ivs (->> (map vector (iterate inc 0) coll) 240 | (take (inc max-seq))) 241 | [state' element-rows] (reduce reducer 242 | [(add-composite-mapping state coll node-id) ""] 243 | ivs)] 244 | [(add-node state' node-id 245 | (str label-start 246 | (type-name-row coll) 247 | element-rows 248 | label-end)) 249 | node-id])) 250 | 251 | (defn ^:private render-set 252 | [state coll] 253 | (let [node-id (value->node-id coll) 254 | [state' label-chunk] (render-elements state node-id (vec coll))] 255 | [(add-node state' node-id 256 | (str label-start 257 | (type-name-row coll) label-chunk 258 | label-end)) 259 | node-id])) 260 | 261 | (extend-protocol Composite 262 | 263 | IPersistentMap 264 | 265 | (render-as-scalar? [m] (empty? m)) 266 | 267 | (render-composite [m state] 268 | (render-map state m)) 269 | 270 | (composite-type [_] :map) 271 | 272 | IPersistentVector 273 | 274 | (render-as-scalar? [v] (empty? v)) 275 | 276 | (render-composite [v state] 277 | (render-vector state v)) 278 | 279 | (composite-type [_] :vec) 280 | 281 | IPersistentSet 282 | 283 | (render-as-scalar? [s] (empty? s)) 284 | 285 | (render-composite [set state] 286 | (render-set state set)) 287 | 288 | (composite-type [_] :set) 289 | 290 | ISeq 291 | 292 | (render-as-scalar? [s] (empty? s)) 293 | 294 | (render-composite [coll state] 295 | (render-seq state coll)) 296 | 297 | (composite-type [_] :seq) 298 | 299 | IDeref 300 | 301 | (render-as-scalar? [_] false) 302 | 303 | (render-composite [ref state] 304 | (render-ref state ref)) 305 | 306 | (composite-type [_] :ref)) 307 | 308 | (defn dot 309 | "Given a root composite value, returns the DOT (Graphviz 310 | description) of the composite value." 311 | [root-value] 312 | {:pre [(satisfies? Composite root-value)]} 313 | (let [[{:keys [nodes edges]}] (render-composite root-value {})] 314 | (with-out-str 315 | (println "digraph G {\n rankdir=LR;") 316 | (println "\n node [shape=plaintext, style=\"rounded,filled\", fillcolor=\"#FAF0E6\"];") 317 | 318 | (doseq [[id text] nodes] 319 | (println (str " " id " [" text "];"))) 320 | 321 | (println) 322 | 323 | (doseq [[from to] edges] 324 | (println (str " " from " -> " to ";"))) 325 | 326 | (println "}")))) 327 | 328 | (defn view 329 | "Renders the root value as a Graphviz document, then 330 | uses Rhizome to open a frame to view the document." 331 | [root-value] 332 | (-> root-value 333 | dot 334 | viz/dot->image 335 | viz/view-image)) 336 | --------------------------------------------------------------------------------