The oook Reference Manual

Table of Contents

The oook Reference Manual

This is the oook Reference Manual, version 0.2.0, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:20:49 2018 GMT+0.

1 Introduction

OOOK!

OOOK is some data manipulation magic on top of the venerable CL-SQL package, which has been providing a solid SQL abstraction in Common Lisp for years.

The goal of OOOK is to greatly decrease "standard" database-driven web application development time with the trade-off of slightly less flexiblity. With that in mind, some of the features include:

• Clean data "model" (table) definitions
• Automatic handling of model associations (joins) during save / delete
• Serialisation / deserialisation of models for serving as JSON or building from POST data
• HTML generation for data viewing (tables) and editing (forms)

Note: Database design should be driven by the data, not by the code that uses it! To encourage this, OOOK will never have functionality to manipulate the database schema.

Also, OOOK is still under development and the API is changing fairly frequently. It is regularly used in its present state, however, and is mostly stable.

Overview

Create models of tables in the database with defmodel:

(oook:defmodel post (:belongs-to user)
  "Some interesting prose, full of wisdom"
  (date_published :type clsql:wall-time)
  (title :column "post-title")
  content)

(oook:defmodel user (:has-many posts)
  "Someone who writes posts"
  name
  (level :type integer :documentation "Skill level"))

This creates two CLOS classes which model the "post" and "user" database tables, including the relationship between the two. The models have brief dostrings, custom slots (including types) and associations with other models.

Note: the defmodel macro creates two CLSQL view-classes, using clsql:def-view-class, containing the specified slots and a number of additional slots for managing the joins.

Example Workflow:

Create a new user using the standard CLOS make-instance:

(defvar wizzard
  (make-instance 'user :name "Rincewind" :level 0))

Create a new post and add it to the user:

(push (posts wizzard) (make-instance 'post :title "On Staying Alive")))

Save the new user (and post) in the database:

(oook:save wizzard)  ; Will save both the user and his post

Find something, either by ID with the built-in find-by-id helper, or construct a CLSQL statement for more complex queries (OOOK provides a few other helpers, see the documentation).

(oook:find-by-id 'post 2)  ; Find the post row with ID == 2
(clsql:select 'user)  ; Select all users

POST/JSON serialisation

OOOK makes it simple to build a model instance given a set of POST data, as long as the POST data is constructed according to a few rules. If you use the HTML generation helpers below, this is handled automatically!

More documentation coming soon... But have a look at serialise.lisp!

HTML Generation

OOOK provides some utilties for viewing and editing model data. In the simplest form, you can generate an HTML form to modify a model with a few lines:

(let ((the-post (make-instance 'post :title "New Post")))
  (oook:get-edit-form the-post "/save"))

With the previous definition of post, this returns the following HTML.

<form class="ui form" action=/save method=POST>
 <div class=field>
  <label>Content</label>
  <input type=text name=post[content]> 
 </div>
 <div class=field>
  <label>Title</label>
  <input type=text name=post[title] value="New Post"> 
 </div>
 <div class=field>
  <label>Date_Published</label>
  <input type=date name=post[date_published]> 
 </div>
 <div class=field>
  <label>User Id</label>
  <input type=number name=post[user_id]> 
 </div>
 <button class="ui primary button" type=submit>Save</button> 
</form>

Things to note

• An instance of post is passed in, and its values used to pre-populate the form
• The field names are compatible with the OOOK serialisation functions
• This "quick" helper generates fairly minimal HTML - if you want something fancier, use the other helpers below!

Custom Built Forms

OOOK provides a context manager, with-record-type to make it easier to build custom forms.

Documentation coming soon... But have a look at html.lisp!

Utilities

Enhanced printing

Use oook:def-enhanced-printer to quickly enhance the printed representations of models.

CL-USER> (oook:def-enhanced-printer post :slot 'title)
...
CL-USER> (format t (oook:find-by-id 'post 5))
#<POST "The Joys of Boredom">

Models Implementation Notes

Overview

Like another well known library, all tables are expected to have at least these three columns:

• id: A unique (for this model type) ID for the row (the table's primary key)
• created-at: Time of creation
• last-modified: Time of last modification

These have historically been found to be useful in typical web applications. The id field is always required, and will be an index into the table. The second two can be disabled by passing :timestamped nil to defmodel.

In addition, models you define will typically have a number of other fields, corresponding to columns in the table, and possibly a number of associated models.

Associated models

A model can be associated to other models in a number of ways.

• belongs-to
• has-one
• owns-one
• owns-many

Models are selected exactly as you would with CL-SQL, and, by default, the joins are lazily loaded (i.e. a "join" slot is only populated from the DB when it is accessed).

The fun part is saving.

oook:save will save any associated models that belong to the instance it is called with. New rows will be created as necessary.

has-one (FK in Left)

Left requires one instance of Right, but Right doesn't care or know about this relationship. (e.g. ingredient -> unit).

• Get: get the relevant Right and merge it into Left
• Save: only save the reference to Right
• Delete: do nothing with Right

owns-one (FK in right) - use with belongs-to (blargh redundancy)

Left owns one Right, and Right knows it. Left cannot have more than one Right. (e.g. user <- config)

• Get: get the Right and merge into Left
• Save: update Right with any changes, ensure reference (ID) has not changed
• Delete: delete right as well

belongs-to (FK in Left) - use with owns-many or owns-one

Left is owned by one Right. Left cannot have more than one owner. (e.g. config <- user). However Right might have more than one Left (e.g. step* <- recipe)

• Get: do not try to resolve the parent relation (circular dep)
• Save: ensure the reference to Right has not changed
• Delete: do nothing

owns-many (FK in Right) - use with belongs-to

Left has many Rights, and the Rights know which Left they belong to. (e.g. recipe <- step*)

• Get: Find all Right that match Left's ID
• Save: Save new Rights in Left, delete old Rights no longer in Left
• Delete: delete all rights as well

many-to-many (intersection table)

Not implemented yet

Left references many instances of Right, and Right might be referenced by many instances of Left. (e.g. programmer <-> project, a programmer is part of many projects and a project has many programmers)

Get: do not try to resolve the parent relation (circular dep)

LICENSE

MIT License

Copyright (c) 2017 Ricardo M. H. da Silva

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

2 Systems

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

2.1 oook

Author

Ric da Silva <ric@rmhsilva.com>

License

MIT

Description

Some magic on the shoulders of CLSQL

Version

0.2.0

Dependencies

• alexandria
• anaphora
• cl-inflector
• closer-mop
• clsql
• jonathan
• parse-number
• semantic-spinneret
• spinneret

Source

oook.asd (file)

Component

src (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 oook/src

Parent

oook (system)

Location

src/

Components

• package.lisp (file)
• utils.lisp (file)
• serialise.lisp (file)
• html.lisp (file)
• methods.lisp (file)
• macro.lisp (file)

4 Files

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

4.1 Lisp

4.1.1 oook.asd

Location

oook.asd

Systems

oook (system)

4.1.2 oook/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

• oook
• oook.methods
• oook.serialise
• oook.macro
• oook.utils

4.1.3 oook/src/utils.lisp

Parent

src (module)

Location

src/utils.lisp

Exported Definitions

• def-enhanced-printer (macro)
• parse-as-type (function)
• search-like (function)
• sql-field (function)

Internal Definitions

• ensure-integer (function)
• ensure-slot-type (macro)
• sql-field-keyword (function)

4.1.4 oook/src/serialise.lisp

Parent

src (module)

Location

src/serialise.lisp

Exported Definitions

• *serialisation-options* (special variable)
• from-alist (function)
• pprint-model (function)
• to-alist (function)
• with-serialisation-options (macro)

Internal Definitions

get-slot-type (function)

4.1.5 oook/src/html.lisp

Parent

src (module)

Location

src/html.lisp

Exported Definitions

• gen-html-table (function)
• get-edit-form (function)
• with-record-type (macro)

Internal Definitions

• all-same-type-p (function)
• field-for-normal-slot (function)
• field-label-for (function)
• field-name-for (function)
• slot-type-without-null (function)

4.1.6 oook/src/methods.lisp

Parent

src (module)

Location

src/methods.lisp

Exported Definitions

• destroy (function)
• filter (function)
• find-by-id (function)
• save (function)

Internal Definitions

• do-each-owns-many (macro)
• new-row-p (function)
• update-owns-many (function)
• update-timestamps (function)

4.1.7 oook/src/macro.lisp

Parent

src (module)

Location

src/macro.lisp

Exported Definitions

• *default-slot-type* (special variable)
• created-at (generic function)
• defmodel (macro)
• foreign-key (generic function)
• id (generic function)
• join-fks (generic function)
• last-modified (generic function)
• owns-many (generic function)
• owns-one (generic function)
• serialisable-fields (generic function)
• serialisable-joins (generic function)

Internal Definitions

• make-clsql-base-slot (function)
• make-clsql-join-slot (function)
• make-clsql-key-slot (function)
• make-foreign-key (function)

5 Packages

Packages are listed by definition order.

5.1 oook

Source

package.lisp (file)

Use List

common-lisp

5.2 oook.methods

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• destroy (function)
• filter (function)
• find-by-id (function)
• save (function)

Internal Definitions

• do-each-owns-many (macro)
• new-row-p (function)
• update-owns-many (function)
• update-timestamps (function)

5.3 oook.serialise

A set of serialisation utilities, including to/from alists, to json (using jonathan)

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• *serialisation-options* (special variable)
• from-alist (function)
• gen-html-table (function)
• get-edit-form (function)
• pprint-model (function)
• to-alist (function)
• with-record-type (macro)
• with-serialisation-options (macro)

Internal Definitions

• all-same-type-p (function)
• field-for-normal-slot (function)
• field-label-for (function)
• field-name-for (function)
• get-slot-type (function)
• slot-type-without-null (function)

5.4 oook.macro

Defines the ‘defmodel’ macro, and the associated functions

Source

package.lisp (file)

Nickname

macro

Use List

common-lisp

Exported Definitions

• *default-slot-type* (special variable)
• created-at (generic function)
• defmodel (macro)
• foreign-key (generic function)
• id (generic function)
• join-fks (generic function)
• last-modified (generic function)
• owns-many (generic function)
• owns-one (generic function)
• serialisable-fields (generic function)
• serialisable-joins (generic function)

Internal Definitions

• make-clsql-base-slot (function)
• make-clsql-join-slot (function)
• make-clsql-key-slot (function)
• make-foreign-key (function)

5.5 oook.utils

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• def-enhanced-printer (macro)
• parse-as-type (function)
• search-like (function)
• sql-field (function)

Internal Definitions

• ensure-integer (function)
• ensure-slot-type (macro)
• sql-field-keyword (function)

6 Definitions

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

6.1 Exported definitions

6.1.1 Special variables

Special Variable: *default-slot-type*

Package

oook.macro

Source

macro.lisp (file)

Special Variable: *serialisation-options*

Options that control how objects are serialised

Package

oook.serialise

Source

serialise.lisp (file)

6.1.2 Macros

Macro: def-enhanced-printer TYPE &key SLOT

Enhances ‘print-object’ for ‘type’, adding the ‘slot’ attribute to it

Package

oook.utils

Source

utils.lisp (file)

Macro: defmodel MODEL-NAME (&key TABLE TIMESTAMPED HAS-ONE OWNS-ONE OWNS-MANY BELONGS-TO) &body FIELDS

Define a class that models DB structure

Package

oook.macro

Source

macro.lisp (file)

Macro: with-record-type (CLASS) &body BODY

Package

oook.serialise

Source

html.lisp (file)

Macro: with-serialisation-options (&rest OPTIONS) &body BODY

Execute ‘body’ with json options set to ‘options’

Package

oook.serialise

Source

serialise.lisp (file)

6.1.3 Functions

Function: destroy INST

Delete ‘inst’ and associated models

Package

oook.methods

Source

methods.lisp (file)

Function: filter ()

Package

oook.methods

Source

methods.lisp (file)

Function: find-by-id TYPE ID

Find a model with ‘id’

Package

oook.methods

Source

methods.lisp (file)

Function: from-alist CLASS ALIST &key INCLUDE-JOINS

Create an instance of ‘class’, given ‘alist’ containing mapping of slots to values, in caveman2 parsed params format.

Package

oook.serialise

Source

serialise.lisp (file)

Function: gen-html-table RECORDS &key EXCLUDE-SLOTS TABLE-CLASSES

Print an HTML table listing the data in ‘records’

Package

oook.serialise

Source

html.lisp (file)

Function: get-edit-form RECORD ACTION &key EXCLUDE-SLOTS

Package

oook.serialise

Source

html.lisp (file)

Function: parse-as-type VALUE TYPE

Try to parse ‘type’ from input ‘value’

Package

oook.utils

Source

utils.lisp (file)

Function: pprint-model INST &key STREAM SLOTS INCLUDE-JOINS

Pretty print ‘inst’

Package

oook.serialise

Source

serialise.lisp (file)

Function: save INST

Save ‘inst’ and associated models

Package

oook.methods

Source

methods.lisp (file)

Function: search-like MODEL COLUMN &key LIKE SINGLEP FMT

Search the DB for ‘model’ using LIKE to match column. If ‘singlep’ is t, only one result is returned

Package

oook.utils

Source

utils.lisp (file)

Function: sql-field SYMBOL

Make ‘symbol’ suitable for SQL name

Package

oook.utils

Source

utils.lisp (file)

Function: to-alist INST &key INCLUDE-JOINS

Return an a-list representation of ‘inst’

Package

oook.serialise

Source

serialise.lisp (file)

6.1.4 Generic functions

Generic Function: created-at INST

Package

oook.macro

Source

macro.lisp (file)

Generic Function: foreign-key INST

Package

oook.macro

Source

macro.lisp (file)

Generic Function: id INST

Read the ‘id’ attribute

Package

oook.macro

Source

macro.lisp (file)

Generic Function: join-fks INST

Return the foreign keys for models in has-one and belongs-to

Package

oook.macro

Source

macro.lisp (file)

Generic Function: last-modified INST

Package

oook.macro

Source

macro.lisp (file)

Generic Function: owns-many INST

Package

oook.macro

Source

macro.lisp (file)

Generic Function: owns-one INST

Package

oook.macro

Source

macro.lisp (file)

Generic Function: serialisable-fields INST

Return the slots in ‘inst’ that will be included when ‘to-alist’ is called

Package

oook.macro

Source

macro.lisp (file)

Generic Function: serialisable-joins INST

Package

oook.macro

Source

macro.lisp (file)

6.2 Internal definitions

6.2.1 Macros

Macro: do-each-owns-many (INST RIGHT VALUE) &body BODY

For each model in the owns-many relation of ‘inst’, execute ‘body’ with the symbol ‘right’ bound to the model type, and the symbol ‘value’ bound to the current slot-value of the relation

Package

oook.methods

Source

methods.lisp (file)

Macro: ensure-slot-type INST SLOT TYPE

Create form to ensure that ‘slot’ in ‘inst’ is of type ‘type’

Package

oook.utils

Source

utils.lisp (file)

6.2.2 Functions

Function: all-same-type-p RECORDS

Check everything in ‘records’ is the same type

Package

oook.serialise

Source

html.lisp (file)

Function: ensure-integer THING

Return ‘thing’ as an integer

Package

oook.utils

Source

utils.lisp (file)

Function: field-for-normal-slot CLASS SLOT &optional VALUE

Package

oook.serialise

Source

html.lisp (file)

Function: field-label-for SLOT

Package

oook.serialise

Source

html.lisp (file)

Function: field-name-for CONTAINER-NAME SLOT

Package

oook.serialise

Source

html.lisp (file)

Function: get-slot-type CLASS SLOT

Get the type of ‘slot’ in ‘class’

Package

oook.serialise

Source

serialise.lisp (file)

Function: make-clsql-base-slot SLOT

Create a clsql base slot form from ‘slot’

Package

oook.macro

Source

macro.lisp (file)

Function: make-clsql-join-slot NAME &key MODEL HOME FOREIGN SET

Package

oook.macro

Source

macro.lisp (file)

Function: make-clsql-key-slot NAME

Create a clsql foreign key slot form from ‘slot’

Package

oook.macro

Source

macro.lisp (file)

Function: make-foreign-key SYMBOL

Create a foreign key (append _id) for symbol

Package

oook.macro

Source

macro.lisp (file)

Function: new-row-p INST

Return T if ‘inst’ does not have a row in the DB

Package

oook.methods

Source

methods.lisp (file)

Function: slot-type-without-null CLASS SLOT

If a slot type is something like (OR NULL BOOLEAN), return just BOOLEAN

Package

oook.serialise

Source

html.lisp (file)

Function: sql-field-keyword SYMBOL

Make ‘symbol’ suitable for a field name as a keyword

Package

oook.utils

Source

utils.lisp (file)

Function: update-owns-many INST RIGHT NEW

Remove all olds that are no longer in new, and add the new!

Package

oook.methods

Source

methods.lisp (file)

Function: update-timestamps INST

Update the ‘created-at’ and ‘last-modified’ timestamps in ‘inst’

Package

oook.methods

Source

methods.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types