Lilac: some validation functions in ClojureScript

Usage

[mvc-works/lilac "0.0.3"]

(require '[lilac.core :refer [validate-lilac number+ string+ or+]])

(validate-lilac 1 (number+))

(validate-lilac 1
  (or+ (number+) (string+)))

If validation is passed, it returns:

{:ok? true}

or the return value would contain informations why it's not correct:

{:ok? false
 :data x
 :rule x
 :coord []
 :message "failure reason..."
 :formatted-message "formatted failure reason..."}

APIs

Supported APIs:

(:require [lilac.core :refer [validate-lilac deflilac register-custom-rule!
           optional+ keyword+ boolean+ number+ string+ custom+ vector+
           list+ map+ not+ and+ set+ nil+ or+ is+]])

For more details browse source code:

• https://github.com/mvc-works/lilac/blob/master/src/lilac/test.cljs
• https://github.com/mvc-works/lilac/blob/master/src/lilac/router.cljs

Recursive data

Lilac is designed to validate recursive data, based on a "component" concept begined deflilac:

(require '[lilac.core :refer [deflilac map+ string+]])

(deflilac lilac-tree+ []
  (map+ {:name (string+)
         :children (vector+ (lilac-tree+))}))

Custom rules

To provide lilac.core/custom+:

(defn method-1 [x]
  (if (and (> x 10) (< x 20))
    {:ok? true}
    {:ok? false, :message (str "expects number between 10 amd 20, got " x)}))

(testing "validating number with custom function"
  (is (=ok true (validate-lilac 11 (custom+ method-1)))))

To added custom validation type called method-2+ (something like number+), use an API:

(defn validate-method-2 [data rule coord]
  (if (and (> data 10) (< data 20))
    {:ok? true}
    {:ok? false,
     :data data,
     :rule rule,
     :coord coord,
     :message (str "expects number between 10 amd 20, got " data)}))

(defn method-2+ [] {:lilac-type :method-2})

(lilac.core/register-custom-rule! :method-2 validate-method-2)

(testing "validating number with custom function"
  (is (=ok true (validate-lilac 11 (method-2+)))))

Contribute to project

If you like the idea in Lilac, fork the project and develop on your own intention. This project does not accept large changes.

The project is developed with Cirru toolchains. Clojure code are compiled from calcit.cirru. Make sure you are using Calcit Editor if you need the fix to be merged.

Naming

Since Lilac has APIs similar to number or and vector, which are core functions/variables in Clojure. I have to add prefix/suffix in names. Lilac uses suffix of + in APIs, inspired by lilac

License

MIT