The delorean Reference Manual

Table of Contents

The delorean Reference Manual

This is the delorean Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 10:56:28 2020 GMT+0.

1 Introduction

delorean

A simple set of macros for mocking time

Usage

(deftest delorean ()
  (let ((point-in-time (local-time:now)))
    (with-frozen-clock point-in-time
      (sleep 2)
      (is (local-time:timestamp= (local-time:now) point-in-time))))


  (let ((same-time-tomorrow (local-time:timestamp+ (local-time:now) 1 :day)))
    (with-shifted-clock same-time-tomorrow
      (sleep 2)
      (is (local-time:timestamp= (local-time:now)
           (local-time:timestamp-minimize-part
            (local-time:timestamp+ same-time-tomorrow 2 :sec) :nsec)))))

  
  (let ((now (local-time:now)))
    (with-scaled-clock 2
      (sleep 2)
      (is (local-time:timestamp= (local-time:now)
            (local-time:timestamp-minimize-part
              (local-time:timestamp+ now 4 :sec) :nsec))))))

The respective clocks can be nested arbitrarily inside one-another.

Development

Development of delorean is hosted on github at https://github.com/cddr/delorean.

To my knowledge, there is currently 1 user (i.e. me) so I'm just hacking directly on master. If you start to find it useful, let me know and we can formalize the release process a little but I don't foresee lots of changes. It's a pretty simple solution to a small problem.

Check out the Makefile for the details of how to build and test the software. It's shamelessly copied from cffi (Luís Oliveira is awesome). It also includes a target to build documentation using atdoc (David Lichteblau is also awesome).

Bugs?

What bugs? No really, if you find a bug, let me know by raising a github issue.

2 Systems

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

2.1 delorean

Author

Andy Chambers

Description

Delorean is a time machine for unit tests

Dependency

local-time

Source

delorean.asd (file)

Component

delorean.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 delorean.asd

Location

delorean.asd

Systems

delorean (system)

3.1.2 delorean/delorean.lisp

Parent

delorean (system)

Location

delorean.lisp

Packages

delorean

Exported Definitions

• frozen-clock (class)
• scaled-clock (class)
• shifted-clock (class)
• with-frozen-clock (macro)
• with-scaled-clock (macro)
• with-shifted-clock (macro)

Internal Definitions

• created-at (method)
• (setf created-at) (method)
• frozen-time (method)
• (setf frozen-time) (method)
• mock-clock (class)
• parent-clock (method)
• (setf parent-clock) (method)
• parent-now (method)
• scale (method)
• (setf scale) (method)
• shifted-time (method)
• (setf shifted-time) (method)

4 Packages

Packages are listed by definition order.

4.1 delorean

A set of macros loosely based on travisjeffery’s timecop
library with the purpose of making it easier to test time-sensitive code

Source

delorean.lisp (file)

Use List

common-lisp

Exported Definitions

• frozen-clock (class)
• scaled-clock (class)
• shifted-clock (class)
• with-frozen-clock (macro)
• with-scaled-clock (macro)
• with-shifted-clock (macro)

Internal Definitions

• created-at (generic function)
• created-at (method)
• (setf created-at) (method)
• (setf created-at) (generic function)
• frozen-time (generic function)
• frozen-time (method)
• (setf frozen-time) (method)
• (setf frozen-time) (generic function)
• mock-clock (class)
• parent-clock (generic function)
• parent-clock (method)
• (setf parent-clock) (method)
• (setf parent-clock) (generic function)
• parent-now (generic function)
• parent-now (method)
• scale (generic function)
• scale (method)
• (setf scale) (method)
• (setf scale) (generic function)
• shifted-time (generic function)
• shifted-time (method)
• (setf shifted-time) (method)
• (setf shifted-time) (generic function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Macros

Macro: with-frozen-clock TIME &body BODY

Freezes the notion of local-time’s ‘now’ function

Within body (and any code called by body), calling (now) will always return ‘time’

Package

delorean

Source

delorean.lisp (file)

Macro: with-scaled-clock SCALE &body BODY

Accelerates (or decelarates) time by a factor indicated by ‘scale’

Package

delorean

Source

delorean.lisp (file)

Macro: with-shifted-clock TO &body BODY

Teleports to the time indicated by ‘to’ before executing ‘body’

Package

delorean

Source

delorean.lisp (file)

5.1.2 Classes

Class: frozen-clock ()

A clock which allows time to be frozen in perpetuity

Package

delorean

Source

delorean.lisp (file)

Direct superclasses

mock-clock (class)

Direct methods

• clock-now (method)
• frozen-time (method)
• frozen-time (method)

Direct slots

Slot: frozen-time

Initargs

:frozen-time

Readers

frozen-time (generic function)

Writers

(setf frozen-time) (generic function)

Class: scaled-clock ()

A clock which allows time to proceed faster or slower than normal

Package

delorean

Source

delorean.lisp (file)

Direct superclasses

mock-clock (class)

Direct methods

• clock-now (method)
• scale (method)
• scale (method)

Direct slots

Slot: scale

Initargs

:scale

Readers

scale (generic function)

Writers

(setf scale) (generic function)

Class: shifted-clock ()

A clock which allows time to be shifted to the specified time

Package

delorean

Source

delorean.lisp (file)

Direct superclasses

mock-clock (class)

Direct methods

• clock-now (method)
• shifted-time (method)
• shifted-time (method)

Direct slots

Slot: shifted-time

Initargs

:shifted-time

Readers

shifted-time (generic function)

Writers

(setf shifted-time) (generic function)

5.2 Internal definitions

5.2.1 Generic functions

Generic Function: created-at OBJECT

Generic Function: (setf created-at) NEW-VALUE OBJECT

Package

delorean

Methods

Method: created-at (MOCK-CLOCK mock-clock)

automatically generated reader method

Source

delorean.lisp (file)

Method: (setf created-at) NEW-VALUE (MOCK-CLOCK mock-clock)

automatically generated writer method

Source

delorean.lisp (file)

Generic Function: frozen-time OBJECT

Generic Function: (setf frozen-time) NEW-VALUE OBJECT

Package

delorean

Methods

Method: frozen-time (FROZEN-CLOCK frozen-clock)

automatically generated reader method

Source

delorean.lisp (file)

Method: (setf frozen-time) NEW-VALUE (FROZEN-CLOCK frozen-clock)

automatically generated writer method

Source

delorean.lisp (file)

Generic Function: parent-clock OBJECT

Generic Function: (setf parent-clock) NEW-VALUE OBJECT

Package

delorean

Methods

Method: parent-clock (MOCK-CLOCK mock-clock)

automatically generated reader method

Source

delorean.lisp (file)

Method: (setf parent-clock) NEW-VALUE (MOCK-CLOCK mock-clock)

automatically generated writer method

Source

delorean.lisp (file)

Generic Function: parent-now SELF

Package

delorean

Methods

Method: parent-now (SELF mock-clock)

Source

delorean.lisp (file)

Generic Function: scale OBJECT

Generic Function: (setf scale) NEW-VALUE OBJECT

Package

delorean

Methods

Method: scale (SCALED-CLOCK scaled-clock)

automatically generated reader method

Source

delorean.lisp (file)

Method: (setf scale) NEW-VALUE (SCALED-CLOCK scaled-clock)

automatically generated writer method

Source

delorean.lisp (file)

Generic Function: shifted-time OBJECT

Generic Function: (setf shifted-time) NEW-VALUE OBJECT

Package

delorean

Methods

Method: shifted-time (SHIFTED-CLOCK shifted-clock)

automatically generated reader method

Source

delorean.lisp (file)

Method: (setf shifted-time) NEW-VALUE (SHIFTED-CLOCK shifted-clock)

automatically generated writer method

Source

delorean.lisp (file)

5.2.2 Classes

Class: mock-clock ()

The base class that is extended by all mock clocks

Package

delorean

Source

delorean.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• frozen-clock (class)
• shifted-clock (class)
• scaled-clock (class)

Direct methods

• parent-now (method)
• parent-clock (method)
• parent-clock (method)
• created-at (method)
• created-at (method)

Direct slots

Slot: created-at

Initargs

:created-at

Readers

created-at (generic function)

Writers

(setf created-at) (generic function)

Slot: parent-clock

Initargs

:parent-clock

Readers

parent-clock (generic function)

Writers

(setf parent-clock) (generic function)

Direct Default Initargs

Initarg	Value
:created-at	(local-time:now)
:parent-clock	local-time:*clock*

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types