README.md

Confab

– a data-oriented Clojure/Script library for generating mock data, with support for clojure.spec .

Usage

Quick examples

(confab :confab/username)
; => "lazy_maplekoi98"

(confab :confab/sentence {:length 6})
; => "Nulla in orci non sapien hendrerit."

(confab :my.spec/blog-post {:seed 478868574082066804
                            :list? true
                            :count 2})
; => [{:post/title "Ornare taciti semper"
;      :post/body  "Primis iaculis elementum conubia feugiat venenatis dolor..."}
;     {:post/title "Curabitur semper venenatis"
;      :post/body  "Duis lectus porta mattis imperdiet..."}]

The entry point is a multimethod confab that takes in a keyword and an optional opts map. If clojure.spec.alpha is present, the spec corresponding to the keyword will, if it exists, be used to generate the data instead.

Multiple keywords

Confab can also in a sequence of keywords and generate data accordingly. If there are constants in the data, it will leave them intact.

(confab [:confab/first-name :confab/last-name])
; => ["John" "Smith"] 

(confab (list "start" :confab/int "end" true))
; => ("start" 8 "end" true)

Passing opts to individual keywords

The custom tag #confab/tuple (or #cf/t for short) allows you to treat pairs of [<keyword> <options-map>] as tagged literals so that these two calls are equivalent:

(confab :confab/password {:length 8, :seed 10101010})
; => "eF8xYiw0"

(confab #confab/tuple [:confab/password {:length 8, :seed 10101010}])
; => "eF8xYiw0" (same output)

Why introduce this alternative syntax? It's useful if you want to pass in options to individual keywords in a sequence:

(confab [:confab/username, #cf/t [:confab/password {:length 8}]])
; => ["fullmetall_alchemist97" "Xn1Se7Ui]

Nested schema

Confab can also take in a (possibly nested) schema of keys with :confab/* as values:

(confab {:user/name  :confab/user
         :user/email :confab/email
         :user/note  "This string will not be changed."
         :user/data  {:image-url :confab/image
                      :about     [:confab/sentence {:length 5, :question? true}]}})

; => {:user/name  "alt.sam626"
;     :user/email "[email protected]"
;     :user/about "This string will not be changed."
;     :user/data  {:image-url "https://picsum.photos/200"
;                  :about     "Was I a good Bing?"}}

Like in sequences, constant values will be left intact. Thus, Confab is designed to mirror the shape of your data.

See Modules for the available keywords and the options they accept.

Modules

Datatypes

:confab/boolean

:confab/string

:confab/inst

Not to be confused with :confab/date which spits out human-readable dates.

:confab/integer

:confab/float

:confab/hexadecimal

:confab/octal

:confab/binary

:confab/radix

Internet

:confab/username

:confab/email

:confab/url

:confab/ipv4

:confab/ipv6

Text

:confab/word

:confab/phrase

:confab/sentence

:confab/paragraph

Time

:confab/date

:confab/year

:confab/month

:confab/day

:confab/time

:confab/hour

:confab/minute

:confab/second

:confab/millisecond

:confab/week-number

:confab/week-day

Person

:confab/name

:confab/first-name

:confab/last-name

:confab/gender

:confab/sex

:confab/job-title

Image

:confab/image-url

:confab/avatar-url

Roadmap

• 1.0 - implement basic modules (datatype, internet, image, text, time, person)
• 1.1 - allow confab to consume specs; nested map ingestion
• 1.2 - allow specs in maps; allow configs in maps; support vector generation in maps
• 1.3 - configs for basic modules
• 1.4 - more modules (identifier, language, address, phone, finance, color, quotes)
• ?.? - support for non-English languages, generate mock data from unlabeled maps, mocks for popular libraries (e.g. Hiccup), offline image generation, constraint-based generation (e.g., sentences without certain characters) transformer-based generation

Attribution

Confab borrows heavily from the faker.js library.

License

Copyright © 2023 Clark Urzo

Distributed under the Eclipse Public License version 1.0.