The ratify Reference Manual

3.1.1 ratify/ratify.asd

Source

ratify.asd.

Parent Component

ratify (system).

ASDF Systems

ratify.

---

3.1.2 ratify/package.lisp

Source

ratify.asd.

Parent Component

ratify (system).

Packages

• ratify-css.
• ratify-parsing.
• ratify-date.
• ratify-email.
• ratify-html.
• ratify-uri.
• ratify-url.
• ratify.
• ratify-types.
• ratify-testing.
• ratify-toolkit.

---

3.1.3 ratify/toolkit.lisp

Dependency

package.lisp (file).

Source

ratify.asd.

Parent Component

ratify (system).

Public Interface

• make-keyword (function).
• message (reader method).
• (setf message) (writer method).
• ratification-error (function).
• ratification-error (condition).
• test-object (reader method).
• (setf test-object) (writer method).
• true-alpha-p (function).
• true-alphanumeric-p (function).

---

3.1.4 ratify/testing.lisp

Dependency

toolkit.lisp (file).

Source

ratify.asd.

Parent Component

ratify (system).

Public Interface

• cause (reader method).
• (setf cause) (writer method).
• combined-error (condition).
• define-test (macro).
• errors (reader method).
• (setf errors) (writer method).
• perform-combined-tests (macro).
• perform-test (function).
• perform-tests (macro).
• skippable-error (function).
• test (function).
• (setf test) (function).
• test-failed (condition).
• test-name (reader method).
• (setf test-name) (writer method).
• test-object (reader method).
• (setf test-object) (writer method).
• with-errors-combined (macro).
• with-skipping (macro).

Internals

• *tests* (special variable).
• perform-test-no-skip (function).

---

3.1.5 ratify/parsing.lisp

Dependency

testing.lisp (file).

Source

ratify.asd.

Parent Component

ratify (system).

Public Interface

• define-parser (macro).
• parse (function).
• parser (function).
• (setf parser) (function).
• with-parsed-forms (macro).

Internals

*parsers* (special variable).

---

3.1.6 ratify/uri.lisp

Dependency

parsing.lisp (file).

Source

ratify.asd.

Parent Component

ratify (system).

Public Interface

• absolute-path-p (function).
• authority-p (function).
• fragment-p (function).
• hierarchical-part-p (function).
• host-p (function).
• ip-p (function).
• ipv4-p (function).
• ipv6-p (function).
• path-segment-p (function).
• port-p (function).
• query-p (function).
• rootless-path-p (function).
• scheme-p (function).
• test-absolute-path (function).
• test-authority (function).
• test-fragment (function).
• test-hierarchical-part (function).
• test-host (function).
• test-ip (function).
• test-ipv4 (function).
• test-ipv6 (function).
• test-path-segment (function).
• test-port (function).
• test-query (function).
• test-rootless-path (function).
• test-scheme (function).
• test-uri (function).
• test-user (function).
• uri-p (function).
• user-p (function).

Internals

• general-delimiter-p (function).
• parse-port (function).
• pchar-p (function).
• percent-encoded-p (function).
• reserved-character-p (function).
• sub-delimiter-p (function).
• unreserved-character-p (function).

---

3.1.7 ratify/url.lisp

Dependency

uri.lisp (file).

Source

ratify.asd.

Parent Component

ratify (system).

Public Interface

• *permitted-protocols* (special variable).
• domain-p (function).
• hostname-p (function).
• protocol-p (function).
• test-domain (function).
• test-hostname (function).
• test-protocol (function).
• test-url (function).
• url-p (function).

---

3.1.8 ratify/email.lisp

Dependency

url.lisp (file).

Source

ratify.asd.

Parent Component

ratify (system).

Public Interface

• email-p (function).
• test-email (function).

Internals

• email-atpos (function).
• local-part-p (function).
• test-local-part (function).

---

3.1.9 ratify/css.lisp

Dependency

email.lisp (file).

Source

ratify.asd.

Parent Component

ratify (system).

Public Interface

• color-p (function).
• property-p (function).
• test-color (function).
• test-property (function).

Internals

• *css-color-names* (special variable).
• css-argslist (function).
• test-hsl (function).
• test-percentage (function).
• test-rgb (function).

---

3.1.10 ratify/date.lisp

Dependency

css.lisp (file).

Source

ratify.asd.

Parent Component

ratify (system).

Public Interface

• date-p (function).
• datetime-p (function).
• day-p (function).
• hour-p (function).
• minute-p (function).
• month-p (function).
• offset-p (function).
• parse-date (function).
• parse-datetime (function).
• parse-day (function).
• parse-hour (function).
• parse-minute (function).
• parse-month (function).
• parse-offset (function).
• parse-second (function).
• parse-time (function).
• parse-year (function).
• second-p (function).
• test-date (function).
• test-datetime (function).
• test-day (function).
• test-hour (function).
• test-minute (function).
• test-month (function).
• test-offset (function).
• test-second (function).
• test-time (function).
• test-year (function).
• time-p (function).
• year-p (function).

---

3.1.11 ratify/types.lisp

Dependency

date.lisp (file).

Source

ratify.asd.

Parent Component

ratify (system).

Public Interface

• alphabetic-p (function).
• alphanumeric-p (function).
• bit-p (function).
• boolean-p (function).
• character-p (function).
• complex-p (function).
• float-p (function).
• integer-p (function).
• number-p (function).
• numeric-p (function).
• parse-bit (function).
• parse-boolean (function).
• parse-character (function).
• parse-complex (function).
• parse-float (function).
• parse-number (function).
• parse-ratio (function).
• parse-rational (function).
• parse-real (function).
• parse-string (function).
• parse-unsigned-integer (function).
• ratio-p (function).
• rational-p (function).
• real-p (function).
• string-p (function).
• test-alphabetic (function).
• test-alphanumeric (function).
• test-bit (function).
• test-boolean (function).
• test-character (function).
• test-complex (function).
• test-float (function).
• test-integer (function).
• test-number (function).
• test-numeric (function).
• test-ratio (function).
• test-rational (function).
• test-real (function).
• test-string (function).
• test-unsigned-integer (function).
• unsigned-integer-p (function).

---

3.1.12 ratify/html.lisp

Dependency

types.lisp (file).

Source

ratify.asd.

Parent Component

ratify (system).

Public Interface

• checkbox-p (function).
• datetime-local-p (function).
• file-p (function).
• password-p (function).
• radio-p (function).
• range-p (function).
• search-p (function).
• tel-p (function).
• test-checkbox (function).
• test-datetime-local (function).
• test-file (function).
• test-password (function).
• test-radio (function).
• test-range (function).
• test-search (function).
• test-tel (function).
• test-text (function).
• test-textarea (function).
• text-p (function).
• textarea-p (function).

---

5.1.1 Special variables

Special Variable: *permitted-protocols* ¶

List of permitted protocols in a URL.

Package

ratify-url.

Source

url.lisp.

---

5.1.2 Macros

Macro: define-parser (name (param start end) &body body) ¶

Defines a new parse function with NAME.
PARAM will be bound to the object to parse, which is a string unless otherwise specified, START to the starting index (inc) and END to the ending index (exc).

This function creates two other functions automatically:
PARSE-name This is the main test function. If the test fails, an error of type RATIFICATION-ERROR should be returned. If the test succeeds the argument passed to it is always returned.

Package

ratify-parsing.

Source

parsing.lisp.

Macro: define-test (name (param start end) &body body) ¶

Defines a new test function with NAME.
PARAM will be bound to the object to test, which is a string unless otherwise specified, START to the starting index (inc) and END to the ending index (exc).

This function creates two other functions automatically:
TEST-name This is the main test function. If the test fails, an error of type RATIFICATION-ERROR should be returned. If the test succeeds the argument passed to it is always returned.
name-P Equivalent to the TEST- function, except that it simply returns NIL on failure instead of signalling an error.

Package

ratify-testing.

Source

testing.lisp.

Macro: perform-combined-tests (&body test-forms) ¶

Same as PERFORM-TESTS, except with WITH-ERRORS-COMBINED in effect.

Package

ratify-testing.

Source

testing.lisp.

Macro: perform-tests (&body test-forms) ¶

Performs a series of tests.

TEST-FORMS ::= TEST-FORM*
TEST-FORM ::= (test-name test-object*) See TEST.

Package

ratify-testing.

Source

testing.lisp.

Macro: with-errors-combined (&body body) ¶

Executes the body with special error handling.
Errors are gathered in a COMBINED-ERROR, which is finally signalled once the body finishes or an error occurs and no SKIP-ERROR restart can be found.

If no errors occur within the body, the last value of the body is returned as per PROGN.

Package

ratify-testing.

Source

testing.lisp.

Macro: with-parsed-forms (parse-forms &body body) ¶

Performs a series of parsing operations on objects and rebinds their symbols to the results.

PARSE-FORMS ::= PARSE-FORM*
PARSE-FORM ::= (parser-name object*)
See PARSE.

The parse operations are performed within WITH-ERRORS-COMBINED.
As such all parse operations are always performed and only one or no
conditions are signalled as part of the parsing.
See WITH-ERRORS-COMBINED.

Package

ratify-parsing.

Source

parsing.lisp.

Macro: with-skipping (&body body) ¶

Marks the body as being skippable if an error occurs within. This establishes the restart SKIP-ERROR.

Package

ratify-testing.

Source

testing.lisp.

---

5.1.3 Ordinary functions

Function: absolute-path-p (path &optional start end) ¶

Predicate version of TEST-ABSOLUTE-PATH, returns the passed value on success, NIL on error.

Package

ratify-uri.

Source

uri.lisp.

Function: alphabetic-p (alpha &optional start end) ¶

Predicate version of TEST-ALPHABETIC, returns the passed value on success, NIL on error.

Package

ratify-types.

Source

types.lisp.

Function: alphanumeric-p (alpha &optional start end) ¶

Predicate version of TEST-ALPHANUMERIC, returns the passed value on success, NIL on error.

Package

ratify-types.

Source

types.lisp.

Function: authority-p (authority &optional start end) ¶

Predicate version of TEST-AUTHORITY, returns the passed value on success, NIL on error.

Package

ratify-uri.

Source

uri.lisp.

Function: bit-p (bit &optional start end) ¶

Predicate version of TEST-BIT, returns the passed value on success, NIL on error.

Package

ratify-types.

Source

types.lisp.

Function: boolean-p (boolean &optional start end) ¶

Predicate version of TEST-BOOLEAN, returns the passed value on success, NIL on error.

Package

ratify-types.

Source

types.lisp.

Function: character-p (character &optional start end) ¶

Predicate version of TEST-CHARACTER, returns the passed value on success, NIL on error.

Package

ratify-types.

Source

types.lisp.

Function: checkbox-p (input &optional start end) ¶

Predicate version of TEST-CHECKBOX, returns the passed value on success, NIL on error.

Package

ratify-html.

Source

html.lisp.

Function: color-p (color &optional start end) ¶

Predicate version of TEST-COLOR, returns the passed value on success, NIL on error.

Package

ratify-css.

Source

css.lisp.

Function: complex-p (complex &optional start end) ¶

Predicate version of TEST-COMPLEX, returns the passed value on success, NIL on error.

Package

ratify-types.

Source

types.lisp.

Function: date-p (date &optional start end) ¶

Predicate version of TEST-DATE, returns the passed value on success, NIL on error.

Package

ratify-date.

Source

date.lisp.

Function: datetime-local-p (datetime &optional start end) ¶

Predicate version of TEST-DATETIME-LOCAL, returns the passed value on success, NIL on error.

Package

ratify-html.

Source

html.lisp.

Function: datetime-p (datetime &optional start end) ¶

Predicate version of TEST-DATETIME, returns the passed value on success, NIL on error.

Package

ratify-date.

Source

date.lisp.

Function: day-p (day &optional start end) ¶

Predicate version of TEST-DAY, returns the passed value on success, NIL on error.

Package

ratify-date.

Source

date.lisp.

Function: domain-p (domain &optional start end) ¶

Predicate version of TEST-DOMAIN, returns the passed value on success, NIL on error.

Package

ratify-url.

Source

url.lisp.

Function: email-p (email &optional start end) ¶

Predicate version of TEST-EMAIL, returns the passed value on success, NIL on error.

Package

ratify-email.

Source

email.lisp.

Function: file-p (file &optional start end) ¶

Predicate version of TEST-FILE, returns the passed value on success, NIL on error.

Package

ratify-html.

Source

html.lisp.

Function: float-p (float &optional start end) ¶

Predicate version of TEST-FLOAT, returns the passed value on success, NIL on error.

Package

ratify-types.

Source

types.lisp.

Function: fragment-p (fragment &optional start end) ¶

Predicate version of TEST-FRAGMENT, returns the passed value on success, NIL on error.

Package

ratify-uri.

Source

uri.lisp.

Function: hierarchical-part-p (hierarchical &optional start end) ¶

Predicate version of TEST-HIERARCHICAL-PART, returns the passed value on success, NIL on error.

Package

ratify-uri.

Source

uri.lisp.

Function: host-p (host &optional start end) ¶

Predicate version of TEST-HOST, returns the passed value on success, NIL on error.

Package

ratify-uri.

Source

uri.lisp.

Function: hostname-p (hostname &optional start end) ¶

Predicate version of TEST-HOSTNAME, returns the passed value on success, NIL on error.

Package

ratify-url.

Source

url.lisp.

Function: hour-p (hour &optional start end) ¶

Predicate version of TEST-HOUR, returns the passed value on success, NIL on error.

Package

ratify-date.

Source

date.lisp.

Function: integer-p (integer &optional start end) ¶

Predicate version of TEST-INTEGER, returns the passed value on success, NIL on error.

Package

ratify-types.

Source

types.lisp.

Function: ip-p (ip &optional start end) ¶

Predicate version of TEST-IP, returns the passed value on success, NIL on error.

Package

ratify-uri.

Source

uri.lisp.

Function: ipv4-p (ip &optional start end) ¶

Predicate version of TEST-IPV4, returns the passed value on success, NIL on error.

Package

ratify-uri.

Source

uri.lisp.

Function: ipv6-p (ip &optional start end) ¶

Predicate version of TEST-IPV6, returns the passed value on success, NIL on error.

Package

ratify-uri.

Source

uri.lisp.

Function: make-keyword (name) ¶

Returns the keyword equivalent of the passed NAME.

Package

ratify-toolkit.

Source

toolkit.lisp.

Function: minute-p (minute &optional start end) ¶

Predicate version of TEST-MINUTE, returns the passed value on success, NIL on error.

Package

ratify-date.

Source

date.lisp.

Function: month-p (month &optional start end) ¶

Predicate version of TEST-MONTH, returns the passed value on success, NIL on error.

Package

ratify-date.

Source

date.lisp.

Function: number-p (number &optional start end) ¶

Predicate version of TEST-NUMBER, returns the passed value on success, NIL on error.

Package

ratify-types.

Source

types.lisp.

Function: numeric-p (number &optional start end) ¶

Predicate version of TEST-NUMERIC, returns the passed value on success, NIL on error.

Package

ratify-types.

Source

types.lisp.

Function: offset-p (offset &optional start end) ¶

Predicate version of TEST-OFFSET, returns the passed value on success, NIL on error.

Package

ratify-date.

Source

date.lisp.

Function: parse (parser-name object) ¶

Attempts to parse OBJECT using the parser named by PARSER-NAME.

Automatically establishes a SKIP-ERROR restart as per WITH-SKIPPING. Performs exactly two operations:
1) Call the test function of name PARSER-NAME on the object
2) Call the parse function of name PARSER-NAME on the object

Package

ratify-parsing.

Source

parsing.lisp.

Function: parse-bit (bit &optional start end) ¶

Parses into a bit of either 1 or 0.

Package

ratify-types.

Source

types.lisp.

Function: parse-boolean (boolean &optional start end) ¶

Parses into a boolean.

Returns T if one of ("1" "true" "T"), NIL otherwise.

Package

ratify-types.

Source

types.lisp.

Function: parse-character (character &optional start end) ¶

Parses into a character.

Package

ratify-types.

Source

types.lisp.

Function: parse-complex (complex &optional start end) ¶

Parses into a complex number.

Package

ratify-types.

Source

types.lisp.

Function: parse-date (date &optional start end) ¶

Parses the given date into a LOCAL-TIME:TIMESTAMP object.

Package

ratify-date.

Source

date.lisp.

Function: parse-datetime (datetime &optional start end) ¶

Parses the given datetime into a LOCAL-TIME:TIMESTAMP object.
The only part that is allowed to be omitted is the timezone offset specification.

Package

ratify-date.

Source

date.lisp.

Function: parse-day (day &optional start end) ¶

Parses the day into an integer

Package

ratify-date.

Source

date.lisp.

Function: parse-float (float &optional start end) ¶

Parses into a float.

Package

ratify-types.

Source

types.lisp.

Function: parse-hour (hour &optional start end) ¶

Parses the hour into an integer

Package

ratify-date.

Source

date.lisp.

Function: parse-minute (minute &optional start end) ¶

Parses the minute into an integer

Package

ratify-date.

Source

date.lisp.

Function: parse-month (month &optional start end) ¶

Parses the month into an integer.

Package

ratify-date.

Source

date.lisp.

Function: parse-number (number &optional start end) ¶

Parses into a number.

Package

ratify-types.

Source

types.lisp.

Function: parse-offset (offset &optional start end) ¶

Parses the offset into a list of (DIR HOUR MINUTE), wherein DIR is a string of either "+" or "-", denoting the direction of the offset.

Package

ratify-date.

Source

date.lisp.

Function: parse-ratio (ratio &optional start end) ¶

Parses into a ratio.

Package

ratify-types.

Source

types.lisp.

Function: parse-rational (rational &optional start end) ¶

Parses into a rational.

Package

ratify-types.

Source

types.lisp.

Function: parse-real (real &optional start end) ¶

Parses into a real.

Package

ratify-types.

Source

types.lisp.

Function: parse-second (second &optional start end) ¶

Parses the second into an integer

Package

ratify-date.

Source

date.lisp.

Function: parse-string (string &optional start end) ¶

Parses into a string (simply returns its argument).

Package

ratify-types.

Source

types.lisp.

Function: parse-time (time &optional start end) ¶

Parses the given time into a LOCAL-TIME:TIMESTAMP object.

Package

ratify-date.

Source

date.lisp.

Function: parse-unsigned-integer (integer &optional start end) ¶

Parses into an integer.

Package

ratify-types.

Source

types.lisp.

Function: parse-year (year &optional start end) ¶

Parses the year into an integer.

Package

ratify-date.

Source

date.lisp.

Function: parser (name) ¶

Returns the function associated with the NAME.
If no such parser can be found, #’IDENTITY is returned. The name is converted to a keyword.

SETF-able.

Package

ratify-parsing.

Source

parsing.lisp.

Function: (setf parser) (name) ¶

Sets a function to be used for a certain parser. The name is converted to a keyword.

Package

ratify-parsing.

Source

parsing.lisp.

Function: password-p (pw &optional start end) ¶

Predicate version of TEST-PASSWORD, returns the passed value on success, NIL on error.

Package

ratify-html.

Source

html.lisp.

Function: path-segment-p (segment &optional start end) ¶

Predicate version of TEST-PATH-SEGMENT, returns the passed value on success, NIL on error.

Package

ratify-uri.

Source

uri.lisp.

Function: perform-test (test-name test-object) ¶

Performs the test named by TEST-NAME on TEST-OBJECT.

Automatically establishes a SKIP-ERROR restart and resignals any error as a new error of type TEST-FAILED.

Package

ratify-testing.

Source

testing.lisp.

Function: port-p (port &optional start end) ¶

Predicate version of TEST-PORT, returns the passed value on success, NIL on error.

Package

ratify-uri.

Source

uri.lisp.

Function: property-p (property &optional start end) ¶

Predicate version of TEST-PROPERTY, returns the passed value on success, NIL on error.

Package

ratify-css.

Source

css.lisp.

Function: protocol-p (protocol &optional start end) ¶

Predicate version of TEST-PROTOCOL, returns the passed value on success, NIL on error.

Package

ratify-url.

Source

url.lisp.

Function: query-p (query &optional start end) ¶

Predicate version of TEST-QUERY, returns the passed value on success, NIL on error.

Package

ratify-uri.

Source

uri.lisp.

Function: radio-p (radio &optional start end) ¶

Predicate version of TEST-RADIO, returns the passed value on success, NIL on error.

Package

ratify-html.

Source

html.lisp.

Function: range-p (range &optional start end) ¶

Predicate version of TEST-RANGE, returns the passed value on success, NIL on error.

Package

ratify-html.

Source

html.lisp.

Function: ratification-error (test-object &optional message &rest format-args) ¶

Shorthand function to signal a RATIFICATION-ERROR.

Package

ratify-toolkit.

Source

toolkit.lisp.

Function: ratio-p (ratio &optional start end) ¶

Predicate version of TEST-RATIO, returns the passed value on success, NIL on error.

Package

ratify-types.

Source

types.lisp.

Function: rational-p (rational &optional start end) ¶

Predicate version of TEST-RATIONAL, returns the passed value on success, NIL on error.

Package

ratify-types.

Source

types.lisp.

Function: real-p (real &optional start end) ¶

Predicate version of TEST-REAL, returns the passed value on success, NIL on error.

Package

ratify-types.

Source

types.lisp.

Function: rootless-path-p (path &optional start end) ¶

Predicate version of TEST-ROOTLESS-PATH, returns the passed value on success, NIL on error.

Package

ratify-uri.

Source

uri.lisp.

Function: scheme-p (scheme &optional start end) ¶

Predicate version of TEST-SCHEME, returns the passed value on success, NIL on error.

Package

ratify-uri.

Source

uri.lisp.

Function: search-p (search &optional start end) ¶

Predicate version of TEST-SEARCH, returns the passed value on success, NIL on error.

Package

ratify-html.

Source

html.lisp.

Function: second-p (second &optional start end) ¶

Predicate version of TEST-SECOND, returns the passed value on success, NIL on error.

Package

ratify-date.

Source

date.lisp.

Function: skippable-error (datum &rest arguments) ¶

Signals a skippable error as per WITH-SKIPPING.

Package

ratify-testing.

Source

testing.lisp.

Function: string-p (string &optional start end) ¶

Predicate version of TEST-STRING, returns the passed value on success, NIL on error.

Package

ratify-types.

Source

types.lisp.

Function: tel-p (tel &optional start end) ¶

Predicate version of TEST-TEL, returns the passed value on success, NIL on error.

Package

ratify-html.

Source

html.lisp.

Function: test (name) ¶

Returns the function associated with the NAME. If no such test can be found, an error is signalled. The name is converted to a keyword.

SETF-able.

Package

ratify-testing.

Source

testing.lisp.

Function: (setf test) (name) ¶

Sets a function to be used for a certain test. The name is converted to a keyword.

Package

ratify-testing.

Source

testing.lisp.

Function: test-absolute-path (path &optional start end) ¶

Tests for a valid absolute path.

/<rootless-path>

Package

ratify-uri.

Source

uri.lisp.

Function: test-alphabetic (alpha &optional start end) ¶

Tests for an alphabetic string.

[a-zA-Z]*

Package

ratify-types.

Source

types.lisp.

Function: test-alphanumeric (alpha &optional start end) ¶

Tests for an alphanumeric string.

[a-zA-Z0-9]*

Package

ratify-types.

Source

types.lisp.

Function: test-authority (authority &optional start end) ¶

Tests for a valid authority.

(<user>@)?<authority>(:<port>)?

Package

ratify-uri.

Source

uri.lisp.

Function: test-bit (bit &optional start end) ¶

Tests for a valid bit.

[01]

Package

ratify-types.

Source

types.lisp.

Function: test-boolean (boolean &optional start end) ¶

Tests for a valid boolean.

1|0|true|false|T|NIL case-insensitive

Package

ratify-types.

Source

types.lisp.

Function: test-character (character &optional start end) ¶

Tests for a valid character.

.{1}

Package

ratify-types.

Source

types.lisp.

Function: test-checkbox (input &optional start end) ¶

Package

ratify-html.

Source

html.lisp.

Function: test-color (color &optional start end) ¶

Package

ratify-css.

Source

css.lisp.

Function: test-complex (complex &optional start end) ¶

Tests for a valid complex number.

<real>[cC]<real>

Package

ratify-types.

Source

types.lisp.

Function: test-date (date &optional start end) ¶

Tests for a valid date.

<year>-<month>-<day>

Package

ratify-date.

Source

date.lisp.

Function: test-datetime (datetime &optional start end) ¶

Tests for a valid datetime.

<year>-<month>-<day>T<hour>:<minute>:<second>Z<offset>

Package

ratify-date.

Source

date.lisp.

Function: test-datetime-local (datetime &optional start end) ¶

Package

ratify-html.

Source

html.lisp.

Function: test-day (day &optional start end) ¶

Tests for a valid day.

[0-9]{1,2} 1<=val<=31

Package

ratify-date.

Source

date.lisp.

Function: test-domain (domain &optional start end) ¶

Tests for a valid domain.

[<ip>]|<hostname>

Package

ratify-url.

Source

url.lisp.

Function: test-email (email &optional start end) ¶

Test an e-mail address for validity according to http://en.wikipedia.org/wiki/Email_address#Syntax

<local-part>@<domain>

Package

ratify-email.

Source

email.lisp.

Function: test-file (file &optional start end) ¶

Package

ratify-html.

Source

html.lisp.

Function: test-float (float &optional start end) ¶

Tests for a valid float.

[+-]?<unsigned-integer>(\.<unsigned-integer>)?(e<unsigned-integer>)?

Package

ratify-types.

Source

types.lisp.

Function: test-fragment (fragment &optional start end) ¶

Tests for a valid fragment part.

[a-zA-Z0-9!$&’()*+,;=-._~:@?/]+

Package

ratify-uri.

Source

uri.lisp.

Function: test-hierarchical-part (hierarchical &optional start end) ¶

Tests for a valid hierarchical part.

<absolute-path>|//<authority><absolute-path>

Package

ratify-uri.

Source

uri.lisp.

Function: test-host (host &optional start end) ¶

Tests for a valid host name.

[<ip>]|[a-zA-Z0-9-._~%!$&’()*+,;=]+

Package

ratify-uri.

Source

uri.lisp.

Function: test-hostname (hostname &optional start end) ¶

Test a hostname for validity according to http://en.wikipedia.org/wiki/Hostname

[a-zA-Z0-9-]{1,63}(\.[a-zA-Z0-9-]{1,63})*
1<=length<=255

Package

ratify-url.

Source

url.lisp.

Function: test-hour (hour &optional start end) ¶

Tests for a valid hour.

[0-9]{1,2} 0<=val<=23

Package

ratify-date.

Source

date.lisp.

Function: test-integer (integer &optional start end) ¶

Tests for a valid signed integer.

[+-]?<unsigned-integer>

Package

ratify-types.

Source

types.lisp.

Function: test-ip (ip &optional start end) ¶

Tests for a valid IP address.

<ipv6>|<ipv4>

Package

ratify-uri.

Source

uri.lisp.

Function: test-ipv4 (ip &optional start end) ¶

Tests for a valid IPv4

<unsigned-integer>\.<unsigned-integer>\.<unsigned-integer>\.<unsigned-integer> 0<=unsigned-integer<=255

Package

ratify-uri.

Source

uri.lisp.

Function: test-ipv6 (ip &optional start end) ¶

Tests for a valid IPv6

[0-9A-F]:(:|[0-9A-F]:){1,6})[0-9A-F]? 0000<=val<=FFFF

Package

ratify-uri.

Source

uri.lisp.

Function: test-minute (minute &optional start end) ¶

Tests for a valid minute.

[0-9]{1,2}
0<=val<=59

Package

ratify-date.

Source

date.lisp.

Function: test-month (month &optional start end) ¶

Tests for a valid month.

[0-9]{1,2} 1<=val<=12

Package

ratify-date.

Source

date.lisp.

Function: test-number (number &optional start end) ¶

Tests for a valid number.

<real>|<complex>

Package

ratify-types.

Source

types.lisp.

Function: test-numeric (number &optional start end) ¶

Tests for a numeric string.

[0-9]*

Package

ratify-types.

Source

types.lisp.

Function: test-offset (offset &optional start end) ¶

Tests for a valid offset.

[-+]hour:minute

Package

ratify-date.

Source

date.lisp.

Function: test-password (pw &optional start end) ¶

Package

ratify-html.

Source

html.lisp.

Function: test-path-segment (segment &optional start end) ¶

Tests for a valid path segment.

[a-zA-Z0-9!$&’()*+,;=-._~:@]+

Package

ratify-uri.

Source

uri.lisp.

Function: test-port (port &optional start end) ¶

Tests for a valid port.

<unsigned-integer> 0<=val<=65535

Package

ratify-uri.

Source

uri.lisp.

Function: test-property (property &optional start end) ¶

Package

ratify-css.

Source

css.lisp.

Function: test-protocol (protocol &optional start end) ¶

Tests for a valid protocol according to *PERMITTED-PROTOCOLS*

Package

ratify-url.

Source

url.lisp.

Function: test-query (query &optional start end) ¶

Tests for a valid query part.

[a-zA-Z0-9!$&’()*+,;=-._~:@?/]+

Package

ratify-uri.

Source

uri.lisp.

Function: test-radio (radio &optional start end) ¶

Package

ratify-html.

Source

html.lisp.

Function: test-range (range &optional start end) ¶

Package

ratify-html.

Source

html.lisp.

Function: test-ratio (ratio &optional start end) ¶

Tests for a valid ratio.

[+-]?<unsigned-integer>/<unsigned-integer>

Package

ratify-types.

Source

types.lisp.

Function: test-rational (rational &optional start end) ¶

Tests for a valid rational.

[+-]?<unsigned-integer>(/<unsigned-integer>)?

Package

ratify-types.

Source

types.lisp.

Function: test-real (real &optional start end) ¶

Tests for a valid real.

<rational>|<float>

Package

ratify-types.

Source

types.lisp.

Function: test-rootless-path (path &optional start end) ¶

Tests for a valid rootless path.

<segment-nz>(/<segment>)?

Package

ratify-uri.

Source

uri.lisp.

Function: test-scheme (scheme &optional start end) ¶

Tests for a valid scheme.

[a-zA-Z][a-zA-Z0-9-.+]*

Package

ratify-uri.

Source

uri.lisp.

Function: test-search (search &optional start end) ¶

Package

ratify-html.

Source

html.lisp.

Function: test-second (second &optional start end) ¶

Tests for a valid second.

[0-9]{1,2}
0<=val<=59

Package

ratify-date.

Source

date.lisp.

Function: test-string (string &optional start end) ¶

Tests for a valid string.

.+

Package

ratify-types.

Source

types.lisp.

Function: test-tel (tel &optional start end) ¶

Package

ratify-html.

Source

html.lisp.

Function: test-text (text &optional start end) ¶

Package

ratify-html.

Source

html.lisp.

Function: test-textarea (text &optional start end) ¶

Package

ratify-html.

Source

html.lisp.

Function: test-time (time &optional start end) ¶

Tests for a valid time.

<hour>:<minute>:<second>Z<offset>

Package

ratify-date.

Source

date.lisp.

Function: test-unsigned-integer (integer &optional start end) ¶

Tests for a valid unsigned integer.

<numeric>

Package

ratify-types.

Source

types.lisp.

Function: test-uri (uri &optional start end) ¶

Tests for a valid URI according to http://tools.ietf.org/html/rfc3986

<scheme>:<hierarchical-part>(?<query>)?(#<fragment>)?

Package

ratify-uri.

Source

uri.lisp.

Function: test-url (url &optional start end) ¶

Tests for a valid URL.

(<protocol>://)?(<domain>)?<absolute-path>(?<query>)?(#<fragment>)?

Package

ratify-url.

Source

url.lisp.

Function: test-user (user &optional start end) ¶

Tests for a valid user.

[a-zA-Z0-9%!$&’()*+,;=-._~:]+

Package

ratify-uri.

Source

uri.lisp.

Function: test-year (year &optional start end) ¶

Tests for a valid year.

[0-9]{4}

Package

ratify-date.

Source

date.lisp.

Function: text-p (text &optional start end) ¶

Predicate version of TEST-TEXT, returns the passed value on success, NIL on error.

Package

ratify-html.

Source

html.lisp.

Function: textarea-p (text &optional start end) ¶

Predicate version of TEST-TEXTAREA, returns the passed value on success, NIL on error.

Package

ratify-html.

Source

html.lisp.

Function: time-p (time &optional start end) ¶

Predicate version of TEST-TIME, returns the passed value on success, NIL on error.

Package

ratify-date.

Source

date.lisp.

Function: true-alpha-p (char) ¶

Returns T if the character is one of a-Z.

ALPHA-CHAR-P as per CLHS is not strictly limited to just a-Z and returns T for undesired characters like ü on some implementations like SBCL.

Package

ratify-toolkit.

Source

toolkit.lisp.

Function: true-alphanumeric-p (char) ¶

Returns T if the character is one of a-Z 0-9.

ALPHANUMERICP as per CLHS is not strictly limited to just a-Z 0-9 and returns T for undesired characters like ü on some implementations like SBCL.

Package

ratify-toolkit.

Source

toolkit.lisp.

Function: unsigned-integer-p (integer &optional start end) ¶

Predicate version of TEST-UNSIGNED-INTEGER, returns the passed value on success, NIL on error.

Package

ratify-types.

Source

types.lisp.

Function: uri-p (uri &optional start end) ¶

Predicate version of TEST-URI, returns the passed value on success, NIL on error.

Package

ratify-uri.

Source

uri.lisp.

Function: url-p (url &optional start end) ¶

Predicate version of TEST-URL, returns the passed value on success, NIL on error.

Package

ratify-url.

Source

url.lisp.

Function: user-p (user &optional start end) ¶

Predicate version of TEST-USER, returns the passed value on success, NIL on error.

Package

ratify-uri.

Source

uri.lisp.

Function: year-p (year &optional start end) ¶

Predicate version of TEST-YEAR, returns the passed value on success, NIL on error.

Package

ratify-date.

Source

date.lisp.

---

5.1.4 Generic functions

Generic Reader: cause (condition) ¶

Generic Writer: (setf cause) (condition) ¶

Package

ratify-testing.

Methods

Reader Method: cause ((condition test-failed)) ¶

Writer Method: (setf cause) ((condition test-failed)) ¶

Source

testing.lisp.

Target Slot

%cause.

Generic Reader: errors (condition) ¶

Generic Writer: (setf errors) (condition) ¶

Package

ratify-testing.

Methods

Reader Method: errors ((condition combined-error)) ¶

Writer Method: (setf errors) ((condition combined-error)) ¶

Source

testing.lisp.

Target Slot

errors.

Generic Reader: message (condition) ¶

Generic Writer: (setf message) (condition) ¶

Package

ratify-toolkit.

Methods

Reader Method: message ((condition ratification-error)) ¶

Writer Method: (setf message) ((condition ratification-error)) ¶

Source

toolkit.lisp.

Target Slot

%message.

Generic Reader: test-name (condition) ¶

Generic Writer: (setf test-name) (condition) ¶

Package

ratify-testing.

Methods

Reader Method: test-name ((condition test-failed)) ¶

Writer Method: (setf test-name) ((condition test-failed)) ¶

Source

testing.lisp.

Target Slot

%test-name.

Generic Reader: test-object (condition) ¶

Generic Writer: (setf test-object) (condition) ¶

Package

ratify-toolkit.

Methods

Reader Method: test-object ((condition test-failed)) ¶

Writer Method: (setf test-object) ((condition test-failed)) ¶

Source

testing.lisp.

Target Slot

%test-object.

Reader Method: test-object ((condition ratification-error)) ¶

Writer Method: (setf test-object) ((condition ratification-error)) ¶

Source

toolkit.lisp.

Target Slot

%test-object.

---

5.1.5 Conditions

Condition: combined-error ¶

An error object that holds a combination of other errors. Used to test multiple things before unwinding the stack.

Package

ratify-testing.

Source

testing.lisp.

Direct superclasses

error.

Direct methods

• (setf errors).
• errors.

Direct slots

Slot: errors ¶

Initform

(quote nil)

Initargs

:errors

Readers

errors.

Writers

(setf errors).

Condition: ratification-error ¶

Error signalled if a test function hit an error in the format.
The TEST-OBJECT slot contains the object that failed to pass the test. The MESSAGE slot contains a verbal explanation of what went wrong.

Package

ratify-toolkit.

Source

toolkit.lisp.

Direct superclasses

error.

Direct methods

• (setf message).
• message.
• (setf test-object).
• test-object.

Direct slots

Slot: %message ¶

Initform

(quote nil)

Initargs

:message

Readers

message.

Writers

(setf message).

Slot: %test-object ¶

Initform

(quote (error "test-object required"))

Initargs

:test-object

Readers

test-object.

Writers

(setf test-object).

Condition: test-failed ¶

Condition signalled when a test fails.
The TEST-NAME slot specifies the name of the test that was run.
The TEST-OBJECT slot contains the object that failed the test.
The CAUSE slot contains the original error object, usually of type RATIFICATION-ERROR.

Package

ratify-testing.

Source

testing.lisp.

Direct superclasses

error.

Direct methods

• (setf cause).
• cause.
• (setf test-name).
• test-name.
• (setf test-object).
• test-object.

Direct slots

Slot: %test-name ¶

Initform

(quote (error "test-name required"))

Initargs

:test-name

Readers

test-name.

Writers

(setf test-name).

Slot: %test-object ¶

Initform

(quote (error "test-object required"))

Initargs

:test-object

Readers

test-object.

Writers

(setf test-object).

Slot: %cause ¶

Initform

(quote nil)

Initargs

:cause

Readers

cause.

Writers

(setf cause).

---

5.2.1 Special variables

Special Variable: *css-color-names* ¶

Package

ratify-css.

Source

css.lisp.

Special Variable: *parsers* ¶

Hash map mapping keywords to parsing functions. A parse function should take one argument.

Package

ratify-parsing.

Source

parsing.lisp.

Special Variable: *tests* ¶

Hash map mapping keywords to testing functions. A test function should take one argument.

Package

ratify-testing.

Source

testing.lisp.

---

5.2.2 Ordinary functions

Function: css-argslist (argslist start end) ¶

Package

ratify-css.

Source

css.lisp.

Function: email-atpos (email start end) ¶

Package

ratify-email.

Source

email.lisp.

Function: general-delimiter-p (char) ¶

Package

ratify-uri.

Source

uri.lisp.

Function: local-part-p (local-part &optional start end) ¶

Predicate version of TEST-LOCAL-PART, returns the passed value on success, NIL on error.

Package

ratify-email.

Source

email.lisp.

Function: parse-port (port &optional start end) ¶

Package

ratify-uri.

Source

uri.lisp.

Function: pchar-p (char) ¶

Package

ratify-uri.

Source

uri.lisp.

Function: percent-encoded-p (char) ¶

Package

ratify-uri.

Source

uri.lisp.

Function: perform-test-no-skip (test-name test-object) ¶

Package

ratify-testing.

Source

testing.lisp.

Function: reserved-character-p (char) ¶

Package

ratify-uri.

Source

uri.lisp.

Function: sub-delimiter-p (char) ¶

Package

ratify-uri.

Source

uri.lisp.

Function: test-hsl (vals) ¶

Package

ratify-css.

Source

css.lisp.

Function: test-local-part (local-part &optional start end) ¶

Tests for a valid email local-part.

[!#$%&’*+-/=?^_‘{|}~a-zA-Z0-9][!#$%&’*+-/=?^_‘{|}~.a-zA-Z0-9]{0,63}

Package

ratify-email.

Source

email.lisp.

Function: test-percentage (p) ¶

Package

ratify-css.

Source

css.lisp.

Function: test-rgb (vals) ¶

Package

ratify-css.

Source

css.lisp.

Function: unreserved-character-p (char) ¶

Package

ratify-uri.

Source

uri.lisp.

---