schema-plus.core — travelboss/schema-plus 1.0.0

Core functions, including defschema+

defschema+ clj/s≠ macro

clj

(defschema+ schema-name schema-form & kvs)

cljs

(defschema+ &form &env schema-name schema-form & kvs)

Use this instead of defschema to get mock generation capabilities, default example values for Swagger, and optional builder functions.

A docstring (and documentation for usage in Swagger) can be supplied by passing an optional :docs argument followed by the string.

Based on the types used in the schema definition, a clojure.test.check.generators.Generator instance will be created that can generate mock data satisfying the schema definition. This automatically handles any referenced schemas that were also created with defschema+.

The default generator behavior can be replaced or augmented by supplying a :generator option. The following argument should either be a clojure.test.check.generators.Generator instance (to totally replace the default generator) or a function accepting one argument. If a function is passed, it will be passed as the first argument to clojure.test.check.generators/fmap, with the default generator as the second argument. In other words, when generating, the output of the default generator will be passed to your custom function as the only argument.

Example of supplying a custom generator:

(defschema+ Person {:name schema/Str :age schema/Int} :generator (gen/return {:name "Bob", :age 42}))

Example of supplying an fmap function:

(defschema+ Person {:name schema/Str :age schema/Int} :generator (fn [default-generated] (assoc default-generated :age 42)))

If :make-builders? is not supplied, or is followed by true, then default builder functions will be defined. This will automatically define the following functions in the current namespace (assuming the schema-name is Foo and there is a field named :bar):

(+Foo) - Create an initial, empty instance (+Foo m) - Create an initial instance populated with fields populated from a map

(+Foo-with-bar this v) - set the :bar field on a Foo instance

(+Foo-build this) - Finalize creation of a Foo instance

(+Foo-> m forms) - (macro) Thread m through forms and validate the final result against the schema

Typical usage for creating a new instance would look like (using the convenience macro):

(+Foo-> (+Foo) (+Foo-with-bar 123))

Full example with all options:

(require '[schema-plus.core :refer [defschema+]]) (require '[schema.core :as schema]) (require '[clojure.test.check.generators :as gen])

(defschema+ Person {:name schema/Str :age schema/Int} :doc "A person with a name and age" :generator (gen/hash-map :name gen/char-alphanumeric :age gen/nat) :example {:name "Bob", :age 42} :make-builders? false)

generate clj/s

(generate schema-obj)

Generate a value from a schema.

generator-registry clj/s

Holds a map of Schema -> Generator for default generation behavior.

get-generator clj/s

(get-generator schema-obj)

Get the current clojure.test.check.generators.Generator for a schema.

process-opts clj/s

(process-opts kvs schema-name)

Only for internal usage

set-generator clj/s

(set-generator schema-obj generator)

Manually set the Generators for some schema object. Normally this should only be used for raw Java Classes and other objects where defschema+ can't be used directly.

throw-arg-err! clj/s

(throw-arg-err! msg)