ladderlife / autochrome

Structural diffs for clojure source code

autochrome

Autochrome is a program for structurally diffing and highlighting clojure source code. It generates diffs as static HTML from github pull requests or local git repos. For more information, some examples, and a description of how it works, please see the HTML readme (generated from readme.clj).

Usage

From local git repo:

$ lein run --open --git-dir /path/to/repo <old-ref> [<new-ref>]

• old-ref and new-ref are just like the arguments to git diff
• --open tries to open the diff in a browser. With no arguments you get HTML on stdout.
• -o <file> also works.

From github:

$ lein run <owner> <repo> <pr-number> -o diff.html        # write a diff for a GitHub pull request
$ lein run --token user:123abc <owner> <repo> <pr-number> # use supplied auth token for github api

License

Copyright © 2018 Ladder Financial, Inc.

Distributed under the Eclipse Public License either version 1.0 or (at your option) any later version.

autochrome's Issues

Autochrome fails with java 9/10

After JDK modularization, javax.xml.bind classes are no longer included by default.
If you try to invoke autochrome with java 9 or 10, you'll get following error:

Exception in thread "main" java.lang.ExceptionInInitializerError
        at java.base/java.lang.Class.forName0(Native Method)
        at java.base/java.lang.Class.forName(Class.java:374)
        at clojure.lang.RT.classForName(RT.java:2168)
...
        at clojure.lang.Util.loadWithClass(Util.java:250)
        at autochrome.core.<clinit>(Unknown Source)
Caused by: java.lang.ClassNotFoundException: javax.xml.bind.DatatypeConverter
        at java.base/jdk.internal.loader.BuiltinClassLoader.loadClass(BuiltinClassLoader.java:582)
        at java.base/jdk.internal.loader.ClassLoaders$AppClassLoader.loadClass(ClassLoaders.java:190)
        at java.base/java.lang.ClassLoader.loadClass(ClassLoader.java:499)
        at java.base/java.lang.Class.forName0(Native Method)
        at java.base/java.lang.Class.forName(Class.java:374)
        at clojure.lang.RT.classForName(RT.java:2168)
        at clojure.lang.RT.classForNameNonLoading(RT.java:2181)
        at autochrome.page$loading__5569__auto____1551.invoke(page.clj:1)
        at autochrome.page__init.load(Unknown Source)
        at autochrome.page__init.<clinit>(Unknown Source)
        ... 42 more

The solution should be simple - just add xml-bind as an explicit dependency - see #10

autochrome as library

hi is there way to separate html related functionality and the core alogrithm in order to integrate this to diff tool? e.g. emacs ediff

Autochrome fails on namespaced maps

I have code which uses namespaced maps and autochrome fails to produce such diffs.
I guess this is because autochrome tries to parse this as a reader literal.

One part of the code looks like this:

(let [slack-config #:notification-provider{:type "slack"
                                                                     :active? (= "on" slack-active) }]
                        
    slack-config)

Exception:

23 changed files
Exception in thread "main" clojure.lang.ExceptionInfo: bad dispatch form {:bad-token {:type :keyword, :text ":notification-provider"}}
        at clojure.core$ex_info.invokeStatic(core.clj:4617)
        at clojure.core$ex_info.invoke(core.clj:4617)
        at autochrome.parse$_parse_one.invokeStatic(parse.clj:233)
        at autochrome.parse$_parse_one.invoke(parse.clj:196)
        at autochrome.parse$parse_list.invokeStatic(parse.clj:278)
        at autochrome.parse$parse_list.invoke(parse.clj:264)
        at autochrome.parse$parse_list.invokeStatic(parse.clj:270)
        at autochrome.parse$parse_list.invoke(parse.clj:264)
        at autochrome.parse$parse_list.invokeStatic(parse.clj:270)
        at autochrome.parse$parse_list.invoke(parse.clj:264)
        at autochrome.parse$_parse_one.invokeStatic(parse.clj:200)
        at autochrome.parse$_parse_one.invoke(parse.clj:196)
        at autochrome.parse$parse_many.invokeStatic(parse.clj:295)
        at autochrome.parse$parse_many.invoke(parse.clj:288)
        at autochrome.parse$parse.invokeStatic(parse.clj:313)
        at autochrome.parse$parse.invoke(parse.clj:310)
        at autochrome.page$clojure_diff.invokeStatic(page.clj:117)
        at autochrome.page$clojure_diff.invoke(page.clj:113)
        at autochrome.page$diff_page$fn__5631.invoke(page.clj:155)
        at clojure.lang.AFn.applyToHelper(AFn.java:154)
        at clojure.lang.AFn.applyTo(AFn.java:144)
        at clojure.core$apply.invokeStatic(core.clj:646)
        at clojure.core$apply.invoke(core.clj:641)
        at com.climate.claypoole$pmap_core$start_task__5141$fn__5142.invoke(claypoole.clj:323)
        at clojure.lang.AFn.applyToHelper(AFn.java:152)
        at clojure.lang.AFn.applyTo(AFn.java:144)
        at clojure.lang.AFunction$1.doInvoke(AFunction.java:29)
        at clojure.lang.RestFn.invoke(RestFn.java:397)
        at com.climate.claypoole.impl$binding_conveyor_fn$fn__5019.invoke(impl.clj:46)
        at clojure.lang.AFn.applyToHelper(AFn.java:152)
        at clojure.lang.AFn.applyTo(AFn.java:144)
        at clojure.lang.AFunction$1.doInvoke(AFunction.java:29)
        at clojure.lang.RestFn.invoke(RestFn.java:397)
        at clojure.lang.AFn.call(AFn.java:18)
        at java.util.concurrent.FutureTask.run(FutureTask.java:266)
        at java.util.concurrent.ScheduledThreadPoolExecutor$ScheduledFutureTask.access$201(ScheduledThreadPoolExecutor.java:180)
        at java.util.concurrent.ScheduledThreadPoolExecutor$ScheduledFutureTask.run(ScheduledThreadPoolExecutor.java:293)
        at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1142)
        at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:617)
        at java.lang.Thread.run(Thread.java:748)
        at java.util.concurrent.FutureTask.report(FutureTask.java:122)
        at java.util.concurrent.FutureTask.get(FutureTask.java:192)
        at com.climate.claypoole.impl$deref_future.invokeStatic(impl.clj:52)
        at com.climate.claypoole.impl$deref_future.invoke(impl.clj:49)
        at com.climate.claypoole$future_call$reify__5132.deref(claypoole.clj:264)
        at clojure.core$deref.invokeStatic(core.clj:2228)
        at clojure.core$deref.invoke(core.clj:2214)
        at com.climate.claypoole.impl$deref_fixing_exceptions.invokeStatic(impl.clj:65)
        at com.climate.claypoole.impl$deref_fixing_exceptions.invoke(impl.clj:58)
        at clojure.core$map$fn__4785.invoke(core.clj:2646)
        at clojure.lang.LazySeq.sval(LazySeq.java:40)
        at clojure.lang.LazySeq.seq(LazySeq.java:49)
        at clojure.lang.RT.seq(RT.java:521)
        at clojure.core$seq__4357.invokeStatic(core.clj:137)
        at clojure.core$concat$fn__4446.invoke(core.clj:706)
        at clojure.lang.LazySeq.sval(LazySeq.java:40)
        at clojure.lang.LazySeq.seq(LazySeq.java:49)
        at clojure.lang.Cons.next(Cons.java:39)
        at clojure.lang.RT.boundedLength(RT.java:1749)
        at clojure.lang.RestFn.applyTo(RestFn.java:130)
        at clojure.core$apply.invokeStatic(core.clj:646)
        at clojure.core$apply.invoke(core.clj:641)
        at autochrome.page$diff_page.invokeStatic(page.clj:160)
        at autochrome.page$diff_page.invoke(page.clj:144)
        at autochrome.page$pull_request_diff.invokeStatic(page.clj:171)
        at autochrome.page$pull_request_diff.invoke(page.clj:169)
        at autochrome.core$do_main$fn__5901.invoke(core.clj:26)
        at autochrome.core$do_main.invokeStatic(core.clj:22)
        at autochrome.core$do_main.doInvoke(core.clj:18)
        at clojure.lang.RestFn.applyTo(RestFn.java:137)
        at clojure.core$apply.invokeStatic(core.clj:646)
        at clojure.core$apply.invoke(core.clj:641)
        at autochrome.core$_main.invokeStatic(core.clj:44)
        at autochrome.core$_main.doInvoke(core.clj:42)
        at clojure.lang.RestFn.applyTo(RestFn.java:137)
        at autochrome.core.main(Unknown Source)

detect moved forms

would be pretty cool. just hash all the top-level forms that were deleted and all the top-level forms that were added, and see if there are any that match.

Integrating as a git difftool

I'm not sure how hard it would be, but autochrome would be awesome as a git difftool provider for diffing changes. Is this in scope for this project?

ClojureScript support

I'd be interested in using this library for https://github.com/Day8/re-frame-10x to diff data structures. The README notes that ClojureScript support would be difficult, what kinds of things would be needed to accomplish this?