The clavier Reference Manual

Table of Contents

The clavier Reference Manual

This is the clavier Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:29:21 2018 GMT+0.

1 Introduction

Clavier

Clavier is a general purpose validation library for Common Lisp.

Install

Through Quicklisp:

(ql:quickload :clavier)

Getting started

Validators are class instances that validate the arguments passed to the validate function:

(let ((validator (make-instance 'equal-to-validator :object 22)))
    (validate validator 22 :error-p t))
    
;=> T

If the validator succeeds, the validate function returns T. If it fails, the validate function either signals a validation error, or returns NIL and a validation message depending on the value of the :error-p argument.

(let ((validator (make-instance 'equal-to-validator :object 22)))
    (validate validator 33 :error-p nil))
    
;=>
;NIL    
;"33 is not equal to 22"

Validators are implemented as funcallable classes. So, alternatively to using the validate function, it is possible to just funcall the validator, like this:

(let ((validator (make-instance 'equal-to-validator :object 22)))
    (funcall validator 22 :error-p t))
    
;=> T

Validation expressions

It is possible to create validators with a more convenient syntax. Each validator provides a builder function. For instance, and equal-to-validator can be built like this:

(funcall (== 100) 100) ;=> T
(funcall (== 100) 99) ;=> NIL

Validators composition

This allows to compose validators, using ==, ~=, &&, || as the composition operands:

(let ((validator (|| (&& (greater-than 20)
			   (less-than 30))
		       (|| (&& (greater-than 1)
			       (less-than 10))
			   (== 100)))))
    (funcall validator 5))

Validators messages

Validators messages to be used when validation fails can be customized passing an :message argument when building the validator

Catching and collecting validation errors

Validation errors can controlled globally by setting the dynamic variable *signal-validation-errors*, which is NIL by default (no validation errors are signaled by default).

There's also the with-signal-validation-errors macro to specify whether validation errors should be signaled or not in a dynamic extent. For instance, this code signals a validation error:

(let ((validator (make-instance 'equal-to-validator :object 22)))
	   (with-signal-validation-errors (t)
	     (validate validator 33)))

Use the collecting-validation-errors macro to collect validation errors happening in a dynamic extent:

(let ((validator (make-instance 'equal-to-validator :object 22)))
	   (collecting-validation-errors (errors found-p)
	       (progn
		 (funcall validator 33 :error-p t)
		 (funcall validator 44 :error-p t))
	     (print errors)
	     (print found-p)))
;=>
;(#<VALIDATION-ERROR 44: 44 is not equal to 22 {1008A48673}>
; #<VALIDATION-ERROR 33: 33 is not equal to 22 {1008A47EA3}>) 
;T 

Validators list:

• equal-to-validator
• not-equal-to-validator
• blank-validator
• not-blank-validator
• true-validator
• false-validator
• type-validator
• string-validator
• boolean-validator
• integer-validator
• symbol-validator
• keyword-validator
• function-validator
• email-validator
• regex-validator
• url-validator
• not-validator
• and-validator
• or-validator
• one-of-validator
• less-than-validator
• greater-than-validator
• length-validator

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 clavier

Author

Mariano Montone

License

MIT

Description

Clavier: A Common Lisp validation library

Dependencies

• alexandria
• cl-ppcre
• closer-mop
• chronicity
• cl-fad

Source

clavier.asd (file)

Components

• package.lisp (file)
• clavier.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 clavier.asd

Location

clavier.asd

Systems

clavier (system)

3.1.2 clavier/package.lisp

Parent

clavier (system)

Location

package.lisp

Packages

clavier

3.1.3 clavier/clavier.lisp

Dependency

package.lisp (file)

Parent

clavier (system)

Location

clavier.lisp

Exported Definitions

• (function)
• && (function)
• *signal-validation-errors* (special variable)
• == (function)
• and-validator (class)
• blank (function)
• blank-validator (class)
• boolean-validator (class)
• call-with-signal-validation-errors (function)
• collecting-validation-errors (macro)
• datetime-validator (class)
• email-validator (class)
• equal-to-validator (class)
• false-validator (class)
• fn (function)
• function-validator (class)
• greater-than (function)
• greater-than-validator (class)
• integer-validator (class)
• is-a (function)
• is-a-boolean (function)
• is-a-keyword (function)
• is-a-list (function)
• is-a-string (function)
• is-a-symbol (function)
• is-an-integer (function)
• is-false (function)
• is-true (function)
• keyword-validator (class)
• len (function)
• length-validator (class)
• less-than (function)
• less-than-validator (class)
• list-validator (class)
• matches-regex (function)
• message (method)
• (setf message) (method)
• not-blank (function)
• not-blank-validator (class)
• not-equal-to-validator (class)
• not-validator (class)
• one-of (function)
• one-of-validator (class)
• or-validator (class)
• pathname-validator (class)
• regex-validator (class)
• string-validator (class)
• symbol-validator (class)
• true-validator (class)
• type-validator (class)
• url-validator (class)
• valid-datetime (function)
• valid-email (function)
• valid-pathname (function)
• valid-url (function)
• validate (function)
• validation-error (function)
• validation-error (condition)
• validation-error-message (method)
• validation-error-target (method)
• validator (method)
• (setf validator) (method)
• validator (class)
• validator-collection (class)
• validator-message (function)
• with-signal-validation-errors (macro)
• ~ (function)
• ~= (function)

Internal Definitions

• %collecting-validation-errors (function)
• %validate (generic function)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• absolute-p (method)
• (setf absolute-p) (method)
• object (method)
• (setf object) (method)
• object (method)
• (setf object) (method)
• options (method)
• (setf options) (method)
• pathname-type* (method)
• (setf pathname-type*) (method)
• probe-p (method)
• (setf probe-p) (method)
• valid-email-address-p (function)
• valid-url-p (function)
• validator-function (method)
• (setf validator-function) (method)
• validator-max (method)
• (setf validator-max) (method)
• validator-max-message (method)
• (setf validator-max-message) (method)
• validator-min (method)
• (setf validator-min) (method)
• validator-min-message (method)
• (setf validator-min-message) (method)
• validator-number (method)
• (setf validator-number) (method)
• validator-number (method)
• (setf validator-number) (method)
• validator-regex (method)
• (setf validator-regex) (method)
• validator-type (method)
• (setf validator-type) (method)
• validators (method)
• (setf validators) (method)
• x (method)
• (setf x) (method)
• x (method)
• (setf x) (method)
• y (method)
• (setf y) (method)
• y (method)
• (setf y) (method)

4 Packages

Packages are listed by definition order.

4.1 clavier

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• (function)
• && (function)
• *signal-validation-errors* (special variable)
• == (function)
• and-validator (class)
• blank (function)
• blank-validator (class)
• boolean-validator (class)
• call-with-signal-validation-errors (function)
• collecting-validation-errors (macro)
• datetime-validator (class)
• email-validator (class)
• equal-to-validator (class)
• false-validator (class)
• fn (function)
• function-validator (class)
• greater-than (function)
• greater-than-validator (class)
• integer-validator (class)
• is-a (function)
• is-a-boolean (function)
• is-a-keyword (function)
• is-a-list (function)
• is-a-string (function)
• is-a-symbol (function)
• is-an-integer (function)
• is-false (function)
• is-true (function)
• keyword-validator (class)
• len (function)
• length-validator (class)
• less-than (function)
• less-than-validator (class)
• list-validator (class)
• matches-regex (function)
• message (generic function)
• message (method)
• (setf message) (method)
• (setf message) (generic function)
• not-blank (function)
• not-blank-validator (class)
• not-equal-to-validator (class)
• not-validator (class)
• one-of (function)
• one-of-validator (class)
• or-validator (class)
• pathname-validator (class)
• regex-validator (class)
• string-validator (class)
• symbol-validator (class)
• true-validator (class)
• type-validator (class)
• url-validator (class)
• valid-datetime (function)
• valid-email (function)
• valid-pathname (function)
• valid-url (function)
• validate (function)
• validation-error (function)
• validation-error (condition)
• validation-error-message (generic function)
• validation-error-message (method)
• validation-error-target (generic function)
• validation-error-target (method)
• validator (generic function)
• validator (method)
• (setf validator) (method)
• (setf validator) (generic function)
• validator (class)
• validator-collection (class)
• validator-message (function)
• with-signal-validation-errors (macro)
• ~ (function)
• ~= (function)

Internal Definitions

• %collecting-validation-errors (function)
• %validate (generic function)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• %validate (method)
• absolute-p (generic function)
• absolute-p (method)
• (setf absolute-p) (method)
• (setf absolute-p) (generic function)
• object (generic function)
• object (method)
• (setf object) (method)
• object (method)
• (setf object) (method)
• (setf object) (generic function)
• options (generic function)
• options (method)
• (setf options) (method)
• (setf options) (generic function)
• pathname-type* (generic function)
• pathname-type* (method)
• (setf pathname-type*) (method)
• (setf pathname-type*) (generic function)
• probe-p (generic function)
• probe-p (method)
• (setf probe-p) (method)
• (setf probe-p) (generic function)
• valid-email-address-p (function)
• valid-url-p (function)
• validator-function (generic function)
• validator-function (method)
• (setf validator-function) (method)
• (setf validator-function) (generic function)
• validator-max (generic function)
• validator-max (method)
• (setf validator-max) (method)
• (setf validator-max) (generic function)
• validator-max-message (generic function)
• validator-max-message (method)
• (setf validator-max-message) (method)
• (setf validator-max-message) (generic function)
• validator-min (generic function)
• validator-min (method)
• (setf validator-min) (method)
• (setf validator-min) (generic function)
• validator-min-message (generic function)
• validator-min-message (method)
• (setf validator-min-message) (method)
• (setf validator-min-message) (generic function)
• validator-number (generic function)
• validator-number (method)
• (setf validator-number) (method)
• validator-number (method)
• (setf validator-number) (method)
• (setf validator-number) (generic function)
• validator-regex (generic function)
• validator-regex (method)
• (setf validator-regex) (method)
• (setf validator-regex) (generic function)
• validator-type (generic function)
• validator-type (method)
• (setf validator-type) (method)
• (setf validator-type) (generic function)
• validators (generic function)
• validators (method)
• (setf validators) (method)
• (setf validators) (generic function)
• x (generic function)
• x (method)
• (setf x) (method)
• x (method)
• (setf x) (method)
• (setf x) (generic function)
• y (generic function)
• y (method)
• (setf y) (method)
• y (method)
• (setf y) (method)
• (setf y) (generic function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *signal-validation-errors*

Package

clavier

Source

clavier.lisp (file)

5.1.2 Macros

Macro: collecting-validation-errors (ERRORS FOUND-P) EXPR &body BODY

Package

clavier

Source

clavier.lisp (file)

Macro: with-signal-validation-errors (&optional SIGNAL) &body BODY

Enables/disables validation errors in body

Args: - signal(boolean) : If **T**, errors are signaled. If **NIL**, they are not.

Package

clavier

Source

clavier.lisp (file)

5.1.3 Functions

Function: X Y &optional MESSAGE &rest ARGS

Package

clavier

Source

clavier.lisp (file)

Function: && X Y &optional MESSAGE &rest ARGS

Package

clavier

Source

clavier.lisp (file)

Function: == OBJECT &optional MESSAGE &rest ARGS

Package

clavier

Source

clavier.lisp (file)

Function: blank &optional MESSAGE &rest ARGS

Package

clavier

Source

clavier.lisp (file)

Function: call-with-signal-validation-errors FUNC &optional SIGNAL

Package

clavier

Source

clavier.lisp (file)

Function: fn FUNCTION MESSAGE &rest ARGS

Package

clavier

Source

clavier.lisp (file)

Function: greater-than NUMBER &optional MESSAGE &rest ARGS

Package

clavier

Source

clavier.lisp (file)

Function: is-a TYPE &optional MESSAGE &rest ARGS

Package

clavier

Source

clavier.lisp (file)

Function: is-a-boolean &optional MESSAGE &rest ARGS

Package

clavier

Source

clavier.lisp (file)

Function: is-a-keyword &optional MESSAGE &rest ARGS

Package

clavier

Source

clavier.lisp (file)

Function: is-a-list &optional MESSAGE &rest ARGS

Package

clavier

Source

clavier.lisp (file)

Function: is-a-string &optional MESSAGE &rest ARGS

Package

clavier

Source

clavier.lisp (file)

Function: is-a-symbol &optional MESSAGE &rest ARGS

Package

clavier

Source

clavier.lisp (file)

Function: is-an-integer &optional MESSAGE &rest ARGS

Package

clavier

Source

clavier.lisp (file)

Function: is-false &optional MESSAGE &rest ARGS

Package

clavier

Source

clavier.lisp (file)

Function: is-true &optional MESSAGE &rest ARGS

Package

clavier

Source

clavier.lisp (file)

Function: len &key MIN MAX MIN-MESSAGE MAX-MESSAGE

Package

clavier

Source

clavier.lisp (file)

Function: less-than NUMBER &optional MESSAGE &rest ARGS

Package

clavier

Source

clavier.lisp (file)

Function: matches-regex REGEX &optional MESSAGE &rest ARGS

Package

clavier

Source

clavier.lisp (file)

Function: not-blank &optional MESSAGE &rest ARGS

Package

clavier

Source

clavier.lisp (file)

Function: one-of OPTIONS &optional MESSAGE &rest ARGS

Package

clavier

Source

clavier.lisp (file)

Function: valid-datetime &optional MESSAGE &rest ARGS

Package

clavier

Source

clavier.lisp (file)

Function: valid-email &optional MESSAGE &rest ARGS

Package

clavier

Source

clavier.lisp (file)

Function: valid-pathname &optional MESSAGE &rest ARGS

Package

clavier

Source

clavier.lisp (file)

Function: valid-url &optional MESSAGE &rest ARGS

Package

clavier

Source

clavier.lisp (file)

Function: validate VALIDATOR OBJECT &rest ARGS &key ERROR-P MESSAGE &allow-other-keys

Package

clavier

Source

clavier.lisp (file)

Function: validation-error TARGET ERROR-MSG &rest ARGS

Package

clavier

Source

clavier.lisp (file)

Function: validator-message VALIDATOR OBJECT

Returns the validator message for the given object

Package

clavier

Source

clavier.lisp (file)

Function: ~ VALIDATOR &optional MESSAGE &rest ARGS

Package

clavier

Source

clavier.lisp (file)

Function: ~= OBJECT &optional MESSAGE &rest ARGS

Package

clavier

Source

clavier.lisp (file)

5.1.4 Generic functions

Generic Function: message OBJECT

Generic Function: (setf message) NEW-VALUE OBJECT

Package

clavier

Methods

Method: message (VALIDATOR validator)

automatically generated reader method

Source

clavier.lisp (file)

Method: (setf message) NEW-VALUE (VALIDATOR validator)

automatically generated writer method

Source

clavier.lisp (file)

Generic Function: validation-error-message CONDITION

Package

clavier

Methods

Method: validation-error-message (CONDITION validation-error)

Source

clavier.lisp (file)

Generic Function: validation-error-target CONDITION

Package

clavier

Methods

Method: validation-error-target (CONDITION validation-error)

Source

clavier.lisp (file)

Generic Function: validator OBJECT

Generic Function: (setf validator) NEW-VALUE OBJECT

Package

clavier

Methods

Method: validator (NOT-VALIDATOR not-validator)

automatically generated reader method

Source

clavier.lisp (file)

Method: (setf validator) NEW-VALUE (NOT-VALIDATOR not-validator)

automatically generated writer method

Source

clavier.lisp (file)

5.1.5 Conditions

Condition: validation-error ()

Package

clavier

Source

clavier.lisp (file)

Direct superclasses

error (condition)

Direct methods

• print-object (method)
• validation-error-message (method)
• validation-error-target (method)

Direct slots

Slot: target

Initargs

:target

Initform

(quote (error "set up the target"))

Readers

validation-error-target (generic function)

Slot: error-msg

Initargs

:error-msg

Initform

(quote (error "provide the error message"))

Readers

validation-error-message (generic function)

5.1.6 Classes

Class: and-validator ()

Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods

• %validate (method)
• y (method)
• y (method)
• x (method)
• x (method)

Direct slots

Slot: x

Initargs

:x

Initform

(error "provide the first validator")

Readers

x (generic function)

Writers

(setf x) (generic function)

Slot: y

Initargs

:y

Initform

(error "provide the second validator")

Readers

y (generic function)

Writers

(setf y) (generic function)

Direct Default Initargs

Initarg	Value
:message	(lambda (clavier:validator clavier::object) (format nil "~a or ~a" (let ((clavier::x-validator (clavier::x clavier:validator))) (clavier:validator-message clavier::x-validator clavier::object)) (let ((clavier::y-validator (clavier::y clavier:validator))) (clavier:validator-message clavier::y-validator clavier::object))))

Class: blank-validator ()

Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods

%validate (method)

Direct Default Initargs

Initarg	Value
:message	(lambda (clavier:validator clavier::object) (declare (ignorable clavier:validator clavier::object)) (format nil "should be blank"))

Class: boolean-validator ()

Package

clavier

Source

clavier.lisp (file)

Direct superclasses

type-validator (class)

Direct Default Initargs

Initarg	Value
:type	(quote boolean)
:message	(lambda (clavier:validator clavier::object) (format nil "~a is not a boolean" clavier::object))

Class: datetime-validator ()

Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods

%validate (method)

Direct Default Initargs

Initarg	Value
:message	(lambda (clavier:validator clavier::object) (declare (ignorable clavier:validator clavier::object)) (format nil "~a is not a valid timestamp" clavier::object))

Class: email-validator ()

Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods

%validate (method)

Direct Default Initargs

Initarg	Value
:message	(lambda (clavier:validator clavier::object) (declare (ignorable clavier:validator clavier::object)) (format nil "the email is invalid: ~a" clavier::object))

Class: equal-to-validator ()

Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods

• %validate (method)
• object (method)
• object (method)

Direct slots

Slot: object

Initargs

:object

Initform

(error "provide the object")

Readers

object (generic function)

Writers

(setf object) (generic function)

Direct Default Initargs

Initarg	Value
:message	(lambda (clavier:validator clavier::object) (format nil "~a is not equal to ~a" clavier::object (clavier::object clavier:validator)))

Class: false-validator ()

Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods

%validate (method)

Direct Default Initargs

Initarg	Value
:message	(lambda (clavier:validator clavier::object) (declare (ignorable clavier:validator clavier::object)) (format nil "is not false"))

Class: function-validator ()

Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods

• %validate (method)
• validator-function (method)
• validator-function (method)

Direct slots

Slot: function

Initargs

:function

Initform

(error "provide the function")

Readers

validator-function (generic function)

Writers

(setf validator-function) (generic function)

Class: greater-than-validator ()

Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods

• %validate (method)
• validator-number (method)
• validator-number (method)

Direct slots

Slot: number

Initargs

:number

Initform

(error "provide the number")

Readers

validator-number (generic function)

Writers

(setf validator-number) (generic function)

Direct Default Initargs

Initarg	Value
:message	(lambda (clavier:validator clavier::object) (declare (ignorable clavier:validator clavier::object)) (format nil "~a is not greater than ~a" clavier::object (clavier::validator-number clavier:validator)))

Class: integer-validator ()

Package

clavier

Source

clavier.lisp (file)

Direct superclasses

type-validator (class)

Direct Default Initargs

Initarg	Value
:type	(quote integer)
:message	(lambda (clavier:validator clavier::object) (format nil "~a is not an integer" clavier::object))

Class: keyword-validator ()

Package

clavier

Source

clavier.lisp (file)

Direct superclasses

type-validator (class)

Direct Default Initargs

Initarg	Value
:type	(quote keyword)
:message	(lambda (clavier:validator clavier::object) (format nil "~a is not a keyword" clavier::object))

Class: length-validator ()

Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods

• %validate (method)
• validator-max-message (method)
• validator-max-message (method)
• validator-min-message (method)
• validator-min-message (method)
• validator-max (method)
• validator-max (method)
• validator-min (method)
• validator-min (method)

Direct slots

Slot: min

Minimum length

Initargs

:min

Readers

validator-min (generic function)

Writers

(setf validator-min) (generic function)

Slot: max

Maximum length

Initargs

:max

Readers

validator-max (generic function)

Writers

(setf validator-max) (generic function)

Slot: min-message

Message for when length is below minimum

Initargs

:min-message

Readers

validator-min-message (generic function)

Writers

(setf validator-min-message) (generic function)

Slot: max-message

Message for when length is above maximum

Initargs

:max-message

Readers

validator-max-message (generic function)

Writers

(setf validator-max-message) (generic function)

Direct Default Initargs

Initarg	Value
:message	"size is not correct"

Class: less-than-validator ()

Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods

• %validate (method)
• validator-number (method)
• validator-number (method)

Direct slots

Slot: number

Initargs

:number

Initform

(error "provide the number")

Readers

validator-number (generic function)

Writers

(setf validator-number) (generic function)

Direct Default Initargs

Initarg	Value
:message	(lambda (clavier:validator clavier::object) (declare (ignorable clavier:validator clavier::object)) (format nil "~a is not lower than ~a" clavier::object (clavier::validator-number clavier:validator)))

Class: list-validator ()

Package

clavier

Source

clavier.lisp (file)

Direct superclasses

type-validator (class)

Direct Default Initargs

Initarg	Value
:type	(quote list)
:message	(lambda (clavier:validator clavier::object) (format nil "~a is not a list" clavier::object))

Class: not-blank-validator ()

Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods

%validate (method)

Direct Default Initargs

Initarg	Value
:message	(lambda (clavier:validator clavier::object) (declare (ignorable clavier:validator clavier::object)) (format nil "should not be blank"))

Class: not-equal-to-validator ()

Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods

• %validate (method)
• object (method)
• object (method)

Direct slots

Slot: object

Initargs

:object

Initform

(error "provide the object")

Readers

object (generic function)

Writers

(setf object) (generic function)

Direct Default Initargs

Initarg	Value
:message	(lambda (clavier:validator clavier::object) (format nil "~a is equal to ~a" clavier::object (clavier::object clavier:validator)))

Class: not-validator ()

Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods

• %validate (method)
• validator (method)
• validator (method)

Direct slots

Slot: validator

Initargs

:validator

Initform

(error "provide the validator")

Readers

validator (generic function)

Writers

(setf validator) (generic function)

Direct Default Initargs

Initarg	Value
:message	(lambda (clavier:validator clavier::object) (format nil "not ~a" (clavier:validator-message (clavier:validator clavier:validator) clavier::object)))

Class: one-of-validator ()

Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods

• %validate (method)
• options (method)
• options (method)

Direct slots

Slot: options

Initargs

:options

Initform

(error "provide the options")

Readers

options (generic function)

Writers

(setf options) (generic function)

Direct Default Initargs

Initarg	Value
:message	(lambda (clavier:validator clavier::object) (declare (ignorable clavier:validator clavier::object)) (format nil "should be one of ~{~a~}" (clavier::options clavier:validator)))

Class: or-validator ()

Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods

• %validate (method)
• y (method)
• y (method)
• x (method)
• x (method)

Direct slots

Slot: x

Initargs

:x

Initform

(error "provide the first validator")

Readers

x (generic function)

Writers

(setf x) (generic function)

Slot: y

Initargs

:y

Initform

(error "provide the second validator")

Readers

y (generic function)

Writers

(setf y) (generic function)

Direct Default Initargs

Initarg	Value
:message	(lambda (clavier:validator clavier::object) (format nil "~a and ~a" (let ((clavier::x-validator (clavier::x clavier:validator))) (clavier:validator-message clavier::x-validator clavier::object)) (let ((clavier::y-validator (clavier::y clavier:validator))) (clavier:validator-message clavier::y-validator clavier::object))))

Class: pathname-validator ()

Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods

• %validate (method)
• pathname-type* (method)
• pathname-type* (method)
• probe-p (method)
• probe-p (method)
• absolute-p (method)
• absolute-p (method)

Direct slots

Slot: absolute-p

If the pathname should be absolute

Initargs

:absolute-p

Readers

absolute-p (generic function)

Writers

(setf absolute-p) (generic function)

Slot: probe-p

Probe existance of pathname

Initargs

:probe-p

Readers

probe-p (generic function)

Writers

(setf probe-p) (generic function)

Slot: pathname-type

The pathname type

Initargs

:pathname-type

Readers

pathname-type* (generic function)

Writers

(setf pathname-type*) (generic function)

Direct Default Initargs

Initarg	Value
:message	(lambda (clavier:validator clavier::object) (declare (ignorable clavier:validator clavier::object)) (format nil "~a is not a valid pathname" clavier::object))

Class: regex-validator ()

Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods

• %validate (method)
• validator-regex (method)
• validator-regex (method)

Direct slots

Slot: regex

Initargs

:regex

Initform

(error "provide the regex")

Readers

validator-regex (generic function)

Writers

(setf validator-regex) (generic function)

Direct Default Initargs

Initarg	Value
:message	(lambda (clavier:validator clavier::object) (declare (ignorable clavier:validator clavier::object)) (format nil "~a does not match the regex ~s" clavier::object (clavier::validator-regex clavier:validator)))

Class: string-validator ()

Package

clavier

Source

clavier.lisp (file)

Direct superclasses

type-validator (class)

Direct Default Initargs

Initarg	Value
:type	(quote string)
:message	(lambda (clavier:validator clavier::object) (declare (ignore clavier:validator)) (format nil "~s is not a string" clavier::object))

Class: symbol-validator ()

Package

clavier

Source

clavier.lisp (file)

Direct superclasses

type-validator (class)

Direct Default Initargs

Initarg	Value
:type	(quote symbol)
:message	(lambda (clavier:validator clavier::object) (format nil "~a is not a symbol" clavier::object))

Class: true-validator ()

Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods

%validate (method)

Direct Default Initargs

Initarg	Value
:message	(lambda (clavier:validator clavier::object) (declare (ignorable clavier:validator clavier::object)) (format nil "is not true"))

Class: type-validator ()

Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct subclasses

• string-validator (class)
• boolean-validator (class)
• integer-validator (class)
• symbol-validator (class)
• keyword-validator (class)
• list-validator (class)

Direct methods

• %validate (method)
• validator-type (method)
• validator-type (method)

Direct slots

Slot: type

Initargs

:type

Initform

(error "provide the type")

Readers

validator-type (generic function)

Writers

(setf validator-type) (generic function)

Direct Default Initargs

Initarg	Value
:message	(lambda (clavier:validator clavier::object) (format nil "~a is not of type ~a" clavier::object (clavier::validator-type clavier:validator)))

Class: url-validator ()

Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods

%validate (method)

Direct Default Initargs

Initarg	Value
:message	(lambda (clavier:validator clavier::object) (declare (ignorable clavier:validator clavier::object)) (format nil "~a is not a valid url" clavier::object))

Class: validator ()

Package

clavier

Source

clavier.lisp (file)

Direct superclasses

funcallable-standard-object (class)

Direct subclasses

• validator-collection (class)
• equal-to-validator (class)
• not-equal-to-validator (class)
• blank-validator (class)
• not-blank-validator (class)
• true-validator (class)
• false-validator (class)
• type-validator (class)
• function-validator (class)
• email-validator (class)
• regex-validator (class)
• url-validator (class)
• datetime-validator (class)
• pathname-validator (class)
• not-validator (class)
• and-validator (class)
• or-validator (class)
• one-of-validator (class)
• less-than-validator (class)
• greater-than-validator (class)
• length-validator (class)

Direct methods

• initialize-instance (method)
• message (method)
• message (method)

Direct slots

Slot: message

Initargs

:message

Initform

(error "provide the validation error message")

Readers

message (generic function)

Writers

(setf message) (generic function)

Class: validator-collection ()

Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods

• %validate (method)
• validators (method)
• validators (method)

Direct slots

Slot: validators

Initargs

:validators

Readers

validators (generic function)

Writers

(setf validators) (generic function)

Direct Default Initargs

Initarg	Value
:message	(lambda (&rest clavier::args) "")

5.2 Internal definitions

5.2.1 Functions

Function: %collecting-validation-errors FUNC

Package

clavier

Source

clavier.lisp (file)

Function: valid-email-address-p STRING

Package

clavier

Source

clavier.lisp (file)

Function: valid-url-p STRING

Package

clavier

Source

clavier.lisp (file)

5.2.2 Generic functions

Generic Function: %validate VALIDATOR OBJECT &rest ARGS

Package

clavier

Source

clavier.lisp (file)

Methods

Method: %validate (VALIDATOR greater-than-validator) OBJECT &rest ARGS

Method: %validate (VALIDATOR less-than-validator) OBJECT &rest ARGS

Method: %validate (VALIDATOR one-of-validator) OBJECT &rest ARGS

Method: %validate (VALIDATOR or-validator) OBJECT &rest ARGS

Method: %validate (VALIDATOR and-validator) OBJECT &rest ARGS

Method: %validate (VALIDATOR not-validator) OBJECT &rest ARGS

Method: %validate (VALIDATOR pathname-validator) OBJECT &rest ARGS

Method: %validate (VALIDATOR datetime-validator) OBJECT &rest ARGS

Method: %validate (VALIDATOR regex-validator) OBJECT &rest ARGS

Method: %validate (VALIDATOR url-validator) OBJECT &rest ARGS

Method: %validate (VALIDATOR email-validator) OBJECT &rest ARGS

Method: %validate (VALIDATOR length-validator) OBJECT &rest ARGS

Method: %validate (VALIDATOR false-validator) OBJECT &rest ARGS

Method: %validate (VALIDATOR true-validator) OBJECT &rest ARGS

Method: %validate (VALIDATOR not-blank-validator) OBJECT &rest ARGS

Method: %validate (VALIDATOR blank-validator) OBJECT &rest ARGS

Method: %validate (VALIDATOR function-validator) OBJECT &rest ARGS

Method: %validate (VALIDATOR type-validator) OBJECT &rest ARGS

Method: %validate (VALIDATOR not-equal-to-validator) OBJECT &rest ARGS

Method: %validate (VALIDATOR equal-to-validator) OBJECT &rest ARGS

Method: %validate (VALIDATOR validator-collection) OBJECT &rest ARGS

Method: %validate VALIDATOR OBJECT &rest ARGS

Generic Function: absolute-p OBJECT

Generic Function: (setf absolute-p) NEW-VALUE OBJECT

Package

clavier

Methods

Method: absolute-p (PATHNAME-VALIDATOR pathname-validator)

Method: (setf absolute-p) NEW-VALUE (PATHNAME-VALIDATOR pathname-validator)

If the pathname should be absolute

Source

clavier.lisp (file)

Generic Function: object OBJECT

Generic Function: (setf object) NEW-VALUE OBJECT

Package

clavier

Methods

Method: object (NOT-EQUAL-TO-VALIDATOR not-equal-to-validator)

automatically generated reader method

Source

clavier.lisp (file)

Method: (setf object) NEW-VALUE (NOT-EQUAL-TO-VALIDATOR not-equal-to-validator)

automatically generated writer method

Source

clavier.lisp (file)

Method: object (EQUAL-TO-VALIDATOR equal-to-validator)

automatically generated reader method

Source

clavier.lisp (file)

Method: (setf object) NEW-VALUE (EQUAL-TO-VALIDATOR equal-to-validator)

automatically generated writer method

Source

clavier.lisp (file)

Generic Function: options OBJECT

Generic Function: (setf options) NEW-VALUE OBJECT

Package

clavier

Methods

Method: options (ONE-OF-VALIDATOR one-of-validator)

automatically generated reader method

Source

clavier.lisp (file)

Method: (setf options) NEW-VALUE (ONE-OF-VALIDATOR one-of-validator)

automatically generated writer method

Source

clavier.lisp (file)

Generic Function: pathname-type* OBJECT

Generic Function: (setf pathname-type*) NEW-VALUE OBJECT

Package

clavier

Methods

Method: pathname-type* (PATHNAME-VALIDATOR pathname-validator)

Method: (setf pathname-type*) NEW-VALUE (PATHNAME-VALIDATOR pathname-validator)

The pathname type

Source

clavier.lisp (file)

Generic Function: probe-p OBJECT

Generic Function: (setf probe-p) NEW-VALUE OBJECT

Package

clavier

Methods

Method: probe-p (PATHNAME-VALIDATOR pathname-validator)

Method: (setf probe-p) NEW-VALUE (PATHNAME-VALIDATOR pathname-validator)

Probe existance of pathname

Source

clavier.lisp (file)

Generic Function: validator-function OBJECT

Generic Function: (setf validator-function) NEW-VALUE OBJECT

Package

clavier

Methods

Method: validator-function (FUNCTION-VALIDATOR function-validator)

automatically generated reader method

Source

clavier.lisp (file)

Method: (setf validator-function) NEW-VALUE (FUNCTION-VALIDATOR function-validator)

automatically generated writer method

Source

clavier.lisp (file)

Generic Function: validator-max OBJECT

Generic Function: (setf validator-max) NEW-VALUE OBJECT

Package

clavier

Methods

Method: validator-max (LENGTH-VALIDATOR length-validator)

Method: (setf validator-max) NEW-VALUE (LENGTH-VALIDATOR length-validator)

Maximum length

Source

clavier.lisp (file)

Generic Function: validator-max-message OBJECT

Generic Function: (setf validator-max-message) NEW-VALUE OBJECT

Package

clavier

Methods

Method: validator-max-message (LENGTH-VALIDATOR length-validator)

Method: (setf validator-max-message) NEW-VALUE (LENGTH-VALIDATOR length-validator)

Message for when length is above maximum

Source

clavier.lisp (file)

Generic Function: validator-min OBJECT

Generic Function: (setf validator-min) NEW-VALUE OBJECT

Package

clavier

Methods

Method: validator-min (LENGTH-VALIDATOR length-validator)

Method: (setf validator-min) NEW-VALUE (LENGTH-VALIDATOR length-validator)

Minimum length

Source

clavier.lisp (file)

Generic Function: validator-min-message OBJECT

Generic Function: (setf validator-min-message) NEW-VALUE OBJECT

Package

clavier

Methods

Method: validator-min-message (LENGTH-VALIDATOR length-validator)

Method: (setf validator-min-message) NEW-VALUE (LENGTH-VALIDATOR length-validator)

Message for when length is below minimum

Source

clavier.lisp (file)

Generic Function: validator-number OBJECT

Generic Function: (setf validator-number) NEW-VALUE OBJECT

Package

clavier

Methods

Method: validator-number (GREATER-THAN-VALIDATOR greater-than-validator)

automatically generated reader method

Source

clavier.lisp (file)

Method: (setf validator-number) NEW-VALUE (GREATER-THAN-VALIDATOR greater-than-validator)

automatically generated writer method

Source

clavier.lisp (file)

Method: validator-number (LESS-THAN-VALIDATOR less-than-validator)

automatically generated reader method

Source

clavier.lisp (file)

Method: (setf validator-number) NEW-VALUE (LESS-THAN-VALIDATOR less-than-validator)

automatically generated writer method

Source

clavier.lisp (file)

Generic Function: validator-regex OBJECT

Generic Function: (setf validator-regex) NEW-VALUE OBJECT

Package

clavier

Methods

Method: validator-regex (REGEX-VALIDATOR regex-validator)

automatically generated reader method

Source

clavier.lisp (file)

Method: (setf validator-regex) NEW-VALUE (REGEX-VALIDATOR regex-validator)

automatically generated writer method

Source

clavier.lisp (file)

Generic Function: validator-type OBJECT

Generic Function: (setf validator-type) NEW-VALUE OBJECT

Package

clavier

Methods

Method: validator-type (TYPE-VALIDATOR type-validator)

automatically generated reader method

Source

clavier.lisp (file)

Method: (setf validator-type) NEW-VALUE (TYPE-VALIDATOR type-validator)

automatically generated writer method

Source

clavier.lisp (file)

Generic Function: validators OBJECT

Generic Function: (setf validators) NEW-VALUE OBJECT

Package

clavier

Methods

Method: validators (VALIDATOR-COLLECTION validator-collection)

automatically generated reader method

Source

clavier.lisp (file)

Method: (setf validators) NEW-VALUE (VALIDATOR-COLLECTION validator-collection)

automatically generated writer method

Source

clavier.lisp (file)

Generic Function: x OBJECT

Generic Function: (setf x) NEW-VALUE OBJECT

Package

clavier

Methods

Method: x (OR-VALIDATOR or-validator)

automatically generated reader method

Source

clavier.lisp (file)

Method: (setf x) NEW-VALUE (OR-VALIDATOR or-validator)

automatically generated writer method

Source

clavier.lisp (file)

Method: x (AND-VALIDATOR and-validator)

automatically generated reader method

Source

clavier.lisp (file)

Method: (setf x) NEW-VALUE (AND-VALIDATOR and-validator)

automatically generated writer method

Source

clavier.lisp (file)

Generic Function: y OBJECT

Generic Function: (setf y) NEW-VALUE OBJECT

Package

clavier

Methods

Method: y (OR-VALIDATOR or-validator)

automatically generated reader method

Source

clavier.lisp (file)

Method: (setf y) NEW-VALUE (OR-VALIDATOR or-validator)

automatically generated writer method

Source

clavier.lisp (file)

Method: y (AND-VALIDATOR and-validator)

automatically generated reader method

Source

clavier.lisp (file)

Method: (setf y) NEW-VALUE (AND-VALIDATOR and-validator)

automatically generated writer method

Source

clavier.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions