void.cljc's Introduction

Void, about handling nil

Compatible with Clojurescript.

Nil is an information representing the absence of information.

This leads to puzzling shenanigans:

;; This is an empty collection, a perfectly normal phenomenon:

[]

;; It contains nothing.

;; This is a collection containing something that is nothing:

[nil]

;; Sometimes it is not what we want.

;; This is a map containing something that is nothing, nowhere:

{nil nil}

;; This is seldom what we want.

This small library proposes macros and functions for interacting with nil under various circumstances. Most notably, it considers that nothing is nothing as the following few examples demonstrate.

Usage

Meditate and reflect on the full API.

Some Socratic excerpts :

(require '[helins.void :as void])


(= (void/assoc {:a 42}
                :a nil
                :b 42)
    
   {:a 42
    :b 42})


(= (void/update {:a 42
                 :b 42}
                :b
                (fn [x]
                  nil))

   {:a 42})


(= (void/dissoc-in {:a {:b {:c {:d 42}}
                        :e 42}}
                   [:a :b :c :d])

   {:a {:e 42}})


(= (void/update-in {:a {:b {:c {:d 24}}
                        :e 42}}
                   [:a :b :c :d]
                   (fn [x]
                     (when (= x
                              42)
                       x)))

   {:a {:e 42}})


(= (void/merge {:a 42
                :b 42}
               {:b nil
                :c 42})

   {:a 42
    :c 42})


(= (void/dmerge {:a {:b {:c {:d 42}}
                     :e 42}}
                {:a {:b {:c {:d nil}}
                     :f 42}})

   {:a {:e 42
        :f 42}})


(= (void/prune {:a 42
                :b {:c 42
                    :d nil
                    :e {:f {:g nil}}}})

   {:a 42
    :b {:c 42}})

Running tests

On the JVM, using Kaocha:

$ ./bin/test/jvm/run
$ ./bin/test/jvm/watch

On NodeJS, using Kaocha-CLJS:

$ ./bin/test/node/run
$ ./bin/test/node/watch

In the browser, using Chui:

$ ./bin/test/browser/compile
# Then open ./resources/chui/index.html

# For testing an advanced build
$ ./bin/test/browser/advanced

Development

Starting in Clojure JVM mode, mentioning an additional deps alias (here, a local setup of NREPL):

$ ./bin/dev/clojure :nrepl

Starting in CLJS mode using Shadow-CLJS:

$ ./bin/dev/cljs
# Then open ./resources/public/index.html

License

Licensed under the term of the Mozilla Public License 2.0, see LICENSE.

void.cljc's People

Stargazers

Watchers

void.cljc's Issues

cljs warning

compiler- warning: Namespace helins.void contains a reserved JavaScript keyword, the corresponding Google Closure namespace will be munged to helins.void$

I realise the name is pretty core to the library... maybe there's a way to put a marker in to suppress the warning or something

Recommend Projects