specter

Specter Specter rejects Clojure's restrictive approach to immutable data structure manipulation, instead exposing an elegant API to allow any sort of manipulation imaginable. Specter especially excels at querying and transforming nested and recursive data, important use cases that are very complex to handle with vanilla Clojure. Specter has an extremely simple core, just a single abstraction called "navigator". Queries and transforms are done by composing navigators into a "path" precisely targeting what you want to retrieve or change. Navigators can be composed with any other navigators, allowing sophisticated manipulations to be expressed very concisely. In addition, Specter has performance rivaling hand-optimized code (see this benchmark). Clojure's only comparable built-in operations are get-in and update-in, and the Specter equivalents are 30% and 85% faster respectively (while being just as concise). Under the hood, Specter uses advanced dynamic techniques to strip away the overhead of composition. There are some key differences between the Clojure approach to data manipulation and the Specter approach. Unlike Clojure, Specter always uses the most efficient method possible to implement an operation for a datatype (e.g. last vs. LAST). Clojure intentionally leaves out many operations, such as prepending to a vector or inserting into the middle of a sequence. Specter has navigators that cover these use cases (BEFORE-ELEM and before-index) and many more. Finally, Specter transforms always target precise parts of a data structure, leaving everything else the same. For instance, ALL targets every value within a sequence, and the resulting transform is always the same type as the input (e.g. a vector stays a vector, a sorted map stays a sorted map). Consider these examples: Example 1: Increment every even number nested within map of vector of maps (def data {:a [{:aa 1 :bb 2} {:cc 3}] :b [{:dd 4}]}) ;; Manual Clojure (defn map-vals [m afn] (->> m (map (fn [[k v]] [k (afn v)])) (into (empty m)))) (map-vals data (fn [v] (mapv (fn [m] (map-vals m (fn [v] (if (even? v) (inc v) v)))) v))) ;; Specter (transform [MAP-VALS ALL MAP-VALS even?] inc data) Example 2: Append a sequence of elements to a nested vector (def data {:a [1 2 3]}) ;; Manual Clojure (update data :a (fn [v] (into (if v v []) [4 5]))) ;; Specter (setval [:a END] [4 5] data) Example 3: Increment the last odd number in a sequence (def data [1 2 3 4 5 6 7 8]) ;; Manual Clojure (let [idx (reduce-kv (fn [res i v] (if (odd? v) i res)) nil data)] (if idx (update data idx inc) data)) ;; Specter (transform [(filterer odd?) LAST] inc data) Example 4: Map a function over a sequence without changing the type or order of the sequence ;; Manual Clojure (map inc data) ;; doesn't work, becomes a lazy sequence (into (empty data) (map inc data)) ;; doesn't work, reverses the order of lists ;; Specter (transform ALL inc data) ;; works for all Clojure datatypes with near-optimal efficiency Latest Version The latest release version of Specter is hosted on Clojars: Learn Specter Introductory blog post: Clojure's missing piece Presentation about Specter: Specter: Powerful and Simple Data Structure Manipulation Note that this presentation was given before Specter's inline compilation/caching system was developed. You no longer need to do anything special to get near-optimal performance. Screencast on Specter: Understanding Specter List of navigators with examples: This wiki page provides a more comprehensive overview than the API docs about the behavior of specific navigators and includes many examples. Core operations and defining new navigators: This wiki page provides a more comprehensive overview than the API docs of the core select/transform/etc. operations and the operations for defining new navigators. This wiki page explains how to do precise and efficient recursive navigation with Specter. This wiki page provides a comprehensive overview of how to use Specter's zipper navigators. Zippers are a much slower navigation method but can perform certain tasks that are not possible with Specter's regular navigators. Note that zippers are rarely needed. Cheat Sheet API docs Performance guide: This post provides an overview of how Specter achieves its performance. Specter's API is contained in these files: specter.cljc: This contains the built-in navigators and the definition of the core operations. transients.cljc: This contains navigators for transient collections. zipper.cljc: This integrates zipper-based navigation into Specter. Questions? You can ask questions about Specter by opening an issue on Github. You can also find help in the #specter channel on Clojurians. Examples Increment all the values in maps of maps: user> (use 'com.rpl.specter) user> (transform [MAP-VALS MAP-VALS] inc {:a {:aa 1} :b {:ba -1 :bb 2}}) {:a {:aa 2}, :b {:ba 0, :bb 3}} Increment all the even values for :a keys in a sequence of maps: user> (transform [ALL :a even?] inc [{:a 1} {:a 2} {:a 4} {:a 3}]) [{:a 1} {:a 3} {:a 5} {:a 3}] Retrieve every number divisible by 3 out of a sequence of sequences: user> (select [ALL ALL #(= 0 (mod % 3))] [[1 2 3 4] [] [5 3 2 18] [2 4 6] [12]]) [3 3 18 6 12] Increment the last odd number in a sequence: user> (transform [(filterer odd?) LAST] inc [2 1 3 6 9 4 8]) [2 1 3 6 10 4 8] Remove nils from a nested sequence: user> (setval [:a ALL nil?] NONE {:a [1 2 nil 3 nil]}) {:a [1 2 3]} Remove key/value pair from nested map: user> (setval [:a :b :c] NONE {:a {:b {:c 1}}}) {:a {:b {}}} Remove key/value pair from nested map, removing maps that become empty along the way: user> (setval [:a (compact :b :c)] NONE {:a {:b {:c 1}}}) {} Increment all the odd numbers between indices 1 (inclusive) and 4 (exclusive): user> (transform [(srange 1 4) ALL odd?] inc [0 1 2