eastwood.util — jonase/eastwood 0.4.1

all-children-vectors clj

(all-children-vectors asts)

allow-warning clj

(allow-warning w opt)

allow-warning-based-on-enclosing-macros clj

(allow-warning-based-on-enclosing-macros w
                                         linter
                                         suppress-desc
                                         suppress-conditions
                                         opt)

ast-expands-macro clj

(ast-expands-macro ast macro-fqsym-set)

ast-to-ordered clj

(ast-to-ordered ast)

Take an ast and return an identical one, except every map is replaced with an ordering-map. The sorting of keys in a specified order can make it significantly easier when printing them out, to see more interesting keys earlier.

builtin-config-to-resource clj

(builtin-config-to-resource name)

butlast+last clj

(butlast+last s)

Returns same value as (juxt butlast last), but slightly more efficient since it only traverses the input sequence s once, not twice.

canonical-filename clj

(canonical-filename fname)

Returns the canonical file name for the given file name. A canonical file name is platform dependent, but is both absolute and unique. See the Java docs for getCanonicalPath for some more details, and the examples below.

http://docs.oracle.com/javase/7/docs/api/java/io/File.html#getCanonicalPath%28%29

Examples:

Context: A Linux or Mac OS X system, where the current working directory is /Users/jafinger/clj/dolly

user=> (canonical-filename "README.md") "/Users/jafinger/clj/dolly/README.md"

user=> (canonical-filename "../../Documents/") "/Users/jafinger/Documents"

user=> (canonical-filename "../.././clj/../Documents/././") "/Users/jafinger/Documents"

Context: A Windows 7 system, where the current working directory is C:\Users\jafinger\clj\dolly

user=> (canonical-filename "README.md") "C:\Users\jafinger\clj\dolly\README.md"

user=> (canonical-filename "....\Documents") "C:\Users\jafinger\Documents"

user=> (canonical-filename ".....\clj..\Documents..") "C:\Users\jafinger\Documents"

clean-ast clj

(clean-ast ast & kws)

clojure-1-10-or-later clj

(clojure-1-10-or-later)

clojure-1-6-or-later clj

(clojure-1-6-or-later)

clojure-1-7-or-later clj

(clojure-1-7-or-later)

clojure-1-8-or-later clj

(clojure-1-8-or-later)

clojure-1-9-or-later clj

(clojure-1-9-or-later)

contains-loc-info? clj

(contains-loc-info? x)

debug-warning clj

(debug-warning w ast opt extra-flags)

(debug-warning w ast opt extra-flags f)

debug? clj

(debug? debug-options opt)

deftype-for-fieldless-defrecord clj

(deftype-for-fieldless-defrecord ast)

disable-warning clj

(disable-warning m)

elide-defprotocol-vars clj

(elide-defprotocol-vars ast)

Motivation: pprint'ing a value containing a defprotocol Var, with all metadata included leads to an infinite loop. Why? The value of a defprotocol's Var is a map.

(1) The value of the key :var in this map is the defprotocol Var itself, and pprint'ing this recurses infinitely.

(2) The value of the key :method-builders in this map has metadata containing the defprotocol Var, so if metadata is being printed, this also leads to an infinite loop.

These problems are most simply avoided by removing these two keys from defprotocol maps.

Note: This can replace Vars in the AST with their values, so the resulting AST is not as it was originally, and will likely fail if you try to generate code from it. It is fine for pprint'ing.

There are cases where this function misses things. It seems like it may be simpler to detect protocol occurrences while doing pprint-meta instead.

elide-meta clj

(elide-meta form elide-key-set)

empty-enclosing-macro-map clj

enclosing-macros clj

(enclosing-macros ast)

enhance-extend-args clj

(enhance-extend-args extend-args)

enhance-extend-invocations clj

(enhance-extend-invocations ast)

enhance-extend-invocations-prewalk clj

(enhance-extend-invocations-prewalk ast)

expr-in-try-body? clj

(expr-in-try-body? ast)

extend-invocation-ast? clj

(extend-invocation-ast? ast)

file-warn-info clj

(file-warn-info f cwd-file)

filter-keys clj

(filter-keys f m)

filter-vals clj

(filter-vals f m)

fqsym-of-raw-form clj

(fqsym-of-raw-form raw-form)

get-fn-in-def clj

(get-fn-in-def expr)

get-in-ast clj

(get-in-ast ast kvec-op-pairs)

get-val-in-map-ast clj

(get-val-in-map-ast map-ast k)

(get-val-in-map-ast map-ast k not-found)

has-keys? clj

(has-keys? m key-seq)

in-thrown? clj

(in-thrown? statement-form ancestor-form)

Is statement-form part of a thrown? (per clojure.test semantics) invoked in ancestor-form?

in-thrown?-call? clj

(in-thrown?-call? ast)

Is ast within a clojure.test (thrown?) call?

init-warning-enable-config clj

(init-warning-enable-config builtin-config-files config-files opt)

inside-fieldless-defrecord clj

(inside-fieldless-defrecord ast)

interface? clj

(interface? obj)

invoke-expr? clj

(invoke-expr? ast-node)

keys-in-map clj

(keys-in-map key-set m)

Return the subset of key-set that are keys of map m, or nil if no element of key-set is a key of m.

linter-executor-atom clj

A #'map-like function that will run each of the linters.

Can be customized in order to achieve linter parallelism, or extra logging, etc.

longest-common-prefix clj

(longest-common-prefix s1 s2)

make-msg-cb clj

(make-msg-cb kind opt)

Tiny helper function to create a simple way to call the Eastwood callback function with only a message string.

Given an option map opt that should have a key :callback whose value is a callback function (which takes a certain kind of map as its only argument), return a function that takes only a string, and then calls the callback function with a proper kind of map, including that message string.

map-keys clj

(map-keys f m)

map-vals clj

(map-vals f m)

mark-exprs-in-try-body clj

(mark-exprs-in-try-body ast)

Return an ast that is identical to the argument, except that expressions 'directly' within try blocks will have one of two new keywords with value true.

Statements, i.e. expressions that are not the last one in the body, and thus their return value is discarded, will have the new keyword :eastwood/unused-ret-val-expr-in-try-body with value true. Use the fn statement-in-try-body? to check whether a node was so marked.

Return values, i.e. expressions that are the last one in the body, will have the new keyword :eastwood/used-ret-val-expr-in-try-body with value true. Use the fn ret-expr-in-try-body? to check whether a node was so marked.

Use fn expr-in-try-body? to check whether an expression was either one of these kind.

meets-suppress-condition clj

(meets-suppress-condition ast enclosing-macros qualifier condition)

min-clojure-version clj

(min-clojure-version min-version-vector)

nil-safe-rseq clj

(nil-safe-rseq s)

ns-form-asts clj

(ns-form-asts asts)

nth-last clj

(nth-last v n)

Return the nth-last element of a vector v, where n=1 means the last element, n=2 is the second-to-last, etc. Returns nil if there are fewer than n elements in the vector.

op= clj

(op= op)

ordering-map clj

(ordering-map key-order)

(ordering-map key-order default-comparator)

Create an empty map with a custom comparator that puts the given keys first, in the order specified. Other keys will be placed after the special keys, sorted by the default-comparator.

postwalk clj

(postwalk f form)

Performs a depth-first, post-order traversal of form. Calls f on each sub-form, uses f's return value in place of the original. Recognizes all Clojure data structures. Consumes seqs as with doall.

pprint-ast-node clj

(pprint-ast-node ast & kws)

pprint-form clj

(pprint-form form)

pprint-meta clj

(pprint-meta obj)

A version of pprint that prints all metadata on the object, wherever it appears. (binding [print-meta true] (pprint obj)) prints metadata on symbols, but not on collection, at least with Clojure 1.6.0 and probably earlier versions. Clojure ticket CLJ-1445 may improve upon this in the future.

http://dev.clojure.org/jira/browse/CLJ-1445

pprint-meta-elided clj

(pprint-meta-elided form)

prewalk clj

(prewalk f form)

Like postwalk, but does pre-order traversal.

print-enclosing-macros clj

(print-enclosing-macros ast)

print-var-info-summary clj

(print-var-info-summary var-info-map opts)

process-configs clj

(process-configs warning-enable-config)

protocol? clj

(protocol? p)

Make a good guess as to whether p is an object created via defprotocol.

pst clj

(pst e depth)

'Prints' a stack trace of the exception, to the depth requested (the entire stack trace if depth is nil). Does not print ex-data.

regex? clj

(regex? x)

remove-prefix clj

(remove-prefix s prefix)

If string s starts with the string prefix, return s with that prefix removed. Otherwise, return s.

remove-unrelated-is-clauses clj

(remove-unrelated-is-clauses do-form candidate-is-clause)

replace-comments-and-quotes-with-nil clj

(replace-comments-and-quotes-with-nil form)

replace-subforms-with-first-in-set clj

(replace-subforms-with-first-in-set form sym-set replace-fn)

ret-expr-in-try-body? clj

(ret-expr-in-try-body? ast)

separate-suffix clj

(separate-suffix s suffixes)

Given a string s and a sequence of strings, suffixes, return a vector of 2 strings [x y] where y is the first element of suffixes that is a suffix of s, and (str x y)=s. If no string in suffixes is a suffix of s, return nil.

set-linter-executor! clj

(set-linter-executor! executor)

sorted-map-with-non-keyword-keys? clj

(sorted-map-with-non-keyword-keys? x)

statement-in-try-body? clj

(statement-in-try-body? ast)

static-call? clj

(static-call? ast-node)

string->forms clj

(string->forms s ns include-line-col-metadata?)

Treat a string as a sequence of 0 or more Clojure forms, and read all of them. No line or column number metadata will be attached to the returned forms, but sometimes this is what you want.

Hack alert: In order to be able to correctly interpret keywords of the form ::name or ::ns-or-ns-alias/name, you should pass in a namespace to bind to the ns var during this function's reading of s. The assumption is that this namespace and those it requires are already loaded before this function is called, and any aliases used by keywords are already set up. It also assumes that the entire string is in that same namespace. Fortunately, this is pretty common for most Clojure code as written today.

subforms-with-first-in-set clj

(subforms-with-first-in-set form sym-set)

timeit clj macro

(timeit expr)

Evaluates expr and returns a vector containing the expression's return value followed by the time it took to evaluate in millisec.

to-uri clj

(to-uri x)

trim-ast clj

(trim-ast ast action key-set)

trim-thrown-form clj

(trim-thrown-form x)

Given a (thrown? Exception ...), removes the Exception symbol, for making = comparisons simpler.

var-to-fqsym clj

(var-to-fqsym v)

walk clj

(walk inner outer form)

Traverses form, an arbitrary data structure. inner and outer are functions. Applies inner to each element of form, building up a data structure of the same type, then applies outer to the result. Recognizes all Clojure data structures. Consumes seqs as with doall.

walk was copied from Clojure 1.6.0, and then modified to preserve metadata on all sub-values of the input form that have them. Note that this metadata is 'put back on' after the function inner has already been called, but before outer, so only outer has a chance to change it.

warning-enable-config-atom clj

with-out-str2 clj macro

(with-out-str2 & body)

Like with-out-str, but returns a map m. (:val m) is the return value of the last expression in the body. (:out m) is the string normally returned by with-out-str. (:err m) is the string that would be returned by with-out-str if it bound err instead of out to a StringWriter.