The factory-alien Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The factory-alien Reference Manual

This is the factory-alien Reference Manual, version 0.0.2, generated automatically by Declt version 3.0 "Montgomery Scott" on Sun May 15 04:43:17 2022 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

.. image:: https://travis-ci.org/fisxoj/factory-alien.svg?branch=master
   :target: https://travis-ci.org/fisxoj/factory-alien
   :alt: Travis CI status badge
.. image:: https://coveralls.io/repos/github/fisxoj/factory-alien/badge.svg?branch=master
   :target: https://coveralls.io/github/fisxoj/factory-alien?branch=master
   :alt: Coveralls status badge
.. image:: https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg
   :alt: Contributor Covenant
   :target: CODE_OF_CONDUCT.md


:Source: `https://github.com/fisxoj/factory-alien `_
:Docs:  `https://fisxoj.github.io/factory-alien/ `_

factory-alien is a common lisp library that's probably awesome.

-------
Example
-------


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 factory-alien

Author

Matt Novenstern <fisxoj@gmail.com>

Home Page

https://fisxoj.github.io/factory-alien/

License

MIT

Description

Factory alien is a library for generating fixture data for testing applications.

Long Description

.. image:: https://travis-ci.org/fisxoj/factory-alien.svg?branch=master
:target: https://travis-ci.org/fisxoj/factory-alien
:alt: Travis CI status badge
.. image:: https://coveralls.io/repos/github/fisxoj/factory-alien/badge.svg?branch=master :target: https://coveralls.io/github/fisxoj/factory-alien?branch=master
:alt: Coveralls status badge
.. image:: https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg :alt: Contributor Covenant
:target: CODE_OF_CONDUCT.md

:Source: ‘https://github.com/fisxoj/factory-alien <https://github.com/fisxoj/factory-alien>‘_ :Docs: ‘https://fisxoj.github.io/factory-alien/ <https://fisxoj.github.io/factory-alien/>‘_

factory-alien is a common lisp library that’s probably awesome.

——-
Example
——-

Version

0.0.2

Dependencies
Source

factory-alien.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 factory-alien.asd

Location

/home/quickref/quicklisp/dists/quicklisp/software/factory-alien-20220331-git/factory-alien.asd

Systems

factory-alien (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 factory-alien/sequences.lisp

Parent

factory-alien (system)

Location

sequences.lisp

Packages

factory-alien.sequences

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 factory-alien/traits.lisp

Parent

factory-alien (system)

Location

traits.lisp

Packages

factory-alien.traits

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.4 factory-alien/factories.lisp

Parent

factory-alien (system)

Location

factories.lisp

Packages

factory-alien.factories

Exported Definitions
Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

3.1.5 factory-alien/factory-alien.lisp

Parent

factory-alien (system)

Location

factory-alien.lisp

Packages

factory-alien


Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

4.1 factory-alien.sequences

Source

sequences.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

4.2 factory-alien.traits

Source

traits.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

4.3 factory-alien.factories

Source

factories.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Previous: , Up: Packages   [Contents][Index]

4.4 factory-alien

Source

factory-alien.lisp (file)

Use List

common-lisp


Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Macros

Macro: define-sequence NAME-AND-OPTIONS LAMBDA-LIST &body BODY
Package

factory-alien.sequences

Source

sequences.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Functions

Function: call-sequence NAME
Package

factory-alien.sequences

Source

sequences.lisp (file)

Function: collect-slot-values TRAIT-DEFINITIONS TRAITS INITARGS
Package

factory-alien.traits

Source

traits.lisp (file)

Function: find-factory NAME-OR-CLASS &optional ERRORP

Takes a symbol or class and, if a symbol is given, calls :function:‘find-class‘ on it.

Package

factory-alien.factories

Source

factories.lisp (file)

Function: make-anonymous-sequence FUNCALLABLE &key INITIAL-VALUE

Takes a function of one argument and returns the name of the sequence that calls that function.

Package

factory-alien.sequences

Source

sequences.lisp (file)

Function: process-trait-definitions TRAITS

Creates an alist of (trait-name . slot-initializer-alist), where slot-initializer-alist contains an alist mapping slot name keyword to a function that provides the value for that slot.

Package

factory-alien.traits

Source

traits.lisp (file)

Function: reset-sequence NAME
Package

factory-alien.sequences

Source

sequences.lisp (file)

Function: reset-sequences ()
Package

factory-alien.sequences

Source

sequences.lisp (file)

Function: slot-value OBJECT NAME
Function: (setf slot-value) VALUE OBJECT NAME
Package

factory-alien.factories

Source

factories.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: *anonymous-sequence-counter*

Like :variable:‘*gensym-counter*‘, gets used to generate unique names for anonymous sequences.

Package

factory-alien.sequences

Source

sequences.lisp (file)

Special Variable: *factories*

A map of factory names (as keywords) to instances of :class:‘factory‘.

Package

factory-alien.factories

Source

factories.lisp (file)

Special Variable: *sequence-state*

The counters for every sequence as a mapping of symbol to an instance of :class:‘sequence‘. Named sequences are stored as their keyword symbol, anonymous sequences are given a numbered name by :function:‘make-anonymous-sequence‘.

Package

factory-alien.sequences

Source

sequences.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Macros

Macro: define-factory NAME PARENT-FACTORIES &body BODY-AND-OPTIONS
Package

factory-alien.factories

Source

factories.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Functions

Function: copy-sequence INSTANCE
Package

factory-alien.sequences

Source

sequences.lisp (file)

Function: get-default-trait FACTORY
Package

factory-alien.factories

Source

factories.lisp (file)

Function: id-field-p NAME
Package

factory-alien.factories

Source

factories.lisp (file)

Function: make-sequence &key (VALUE VALUE) (INITIAL-VALUE INITIAL-VALUE) (FUNCALLABLE FUNCALLABLE)
Package

factory-alien.sequences

Source

sequences.lisp (file)

Function: merge-traits A B

If a field exists in b, it takes precedence over the field in a, but all fields in a OR b should end up in the final alist. Modifies b in-place for PERFORMANCE.

Package

factory-alien.traits

Source

traits.lisp (file)

Function: resolve-traits TRAIT-DEFINITION

Given an alist of (slot-name . slot-initializer), call :function:‘initialize-slot‘ on each and return a new alist of (name . value).

Package

factory-alien.traits

Source

traits.lisp (file)

Function: sequence-funcallable INSTANCE
Function: (setf sequence-funcallable) VALUE INSTANCE
Package

factory-alien.sequences

Source

sequences.lisp (file)

Function: sequence-initial-value INSTANCE
Function: (setf sequence-initial-value) VALUE INSTANCE
Package

factory-alien.sequences

Source

sequences.lisp (file)

Function: sequence-p OBJECT
Package

factory-alien.sequences

Source

sequences.lisp (file)

Function: sequence-value INSTANCE
Function: (setf sequence-value) VALUE INSTANCE
Package

factory-alien.sequences

Source

sequences.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.4 Generic functions

Generic Function: build FACTORY TRAITS &rest INITARGS
Package

factory-alien.factories

Source

factories.lisp (file)

Methods
Method: build FACTORY TRAITS &rest INITARGS
Generic Function: initialize-slot TYPE BODY &rest OPTIONS
Package

factory-alien.traits

Source

traits.lisp (file)

Methods
Method: initialize-slot (TYPE (eql sequence)) (SEQUENCE-NAME symbol) &rest OPTIONS
Method: initialize-slot (TYPE (eql initform)) VALUE &rest OPTIONS
Method: initialize-slot (TYPE (eql factory)) FACTORY &rest OPTIONS
Generic Function: instantiable-class OBJECT
Package

factory-alien.factories

Methods
Method: instantiable-class (FACTORY factory)

The class to make an instance of.

Source

factories.lisp (file)

Generic Function: make-trait-initializer TYPE BODY &rest OPTIONS
Package

factory-alien.traits

Source

traits.lisp (file)

Methods
Method: make-trait-initializer TYPE BODY &rest OPTIONS
Method: make-trait-initializer (TYPE (eql sequence)) BODY &rest OPTIONS
Generic Function: parent-factories OBJECT
Package

factory-alien.factories

Methods
Method: parent-factories (FACTORY factory)

List of parent factories that should be run and merged into instances of this one.

Source

factories.lisp (file)

Generic Function: traits OBJECT
Package

factory-alien.factories

Methods
Method: traits (FACTORY factory)

Mapping of traits

Source

factories.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.5 Conditions

Condition: no-such-factory ()
Package

factory-alien.factories

Source

factories.lisp (file)

Direct superclasses

condition (condition)

Direct slots
Slot: factory-name
Initargs

:factory-name


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.6 Structures

Structure: sequence ()
Package

factory-alien.sequences

Source

sequences.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: value
Type

integer

Initform

0

Readers

sequence-value (function)

Writers

(setf sequence-value) (function)

Slot: initial-value
Type

integer

Initform

0

Readers

sequence-initial-value (function)

Writers

(setf sequence-initial-value) (function)

Slot: funcallable
Type

(or symbol function)

Initform

(quote identity)

Readers

sequence-funcallable (function)

Writers

(setf sequence-funcallable) (function)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.7 Classes

Class: factory ()

A factory that holds things like the traits defined for the factory, the classes factories it’s related to, and the class to build.

Package

factory-alien.factories

Source

factories.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: traits

Mapping of traits

Initargs

:traits

Readers

traits (generic function)

Slot: parent-factories

List of parent factories that should be run and merged into instances of this one.

Initargs

:parent-factories

Readers

parent-factories (generic function)

Slot: instantiable-class

The class to make an instance of.

Initargs

:instantiable-class

Readers

instantiable-class (generic function)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L  
Index Entry  Section

F
factory-alien.asd: The factory-alien․asd file
factory-alien/factories.lisp: The factory-alien/factories․lisp file
factory-alien/factory-alien.lisp: The factory-alien/factory-alien․lisp file
factory-alien/sequences.lisp: The factory-alien/sequences․lisp file
factory-alien/traits.lisp: The factory-alien/traits․lisp file
File, Lisp, factory-alien.asd: The factory-alien․asd file
File, Lisp, factory-alien/factories.lisp: The factory-alien/factories․lisp file
File, Lisp, factory-alien/factory-alien.lisp: The factory-alien/factory-alien․lisp file
File, Lisp, factory-alien/sequences.lisp: The factory-alien/sequences․lisp file
File, Lisp, factory-alien/traits.lisp: The factory-alien/traits․lisp file

L
Lisp File, factory-alien.asd: The factory-alien․asd file
Lisp File, factory-alien/factories.lisp: The factory-alien/factories․lisp file
Lisp File, factory-alien/factory-alien.lisp: The factory-alien/factory-alien․lisp file
Lisp File, factory-alien/sequences.lisp: The factory-alien/sequences․lisp file
Lisp File, factory-alien/traits.lisp: The factory-alien/traits․lisp file

Jump to:   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   (  
B   C   D   F   G   I   M   P   R   S   T  
Index Entry  Section

(
(setf sequence-funcallable): Internal functions
(setf sequence-initial-value): Internal functions
(setf sequence-value): Internal functions
(setf slot-value): Exported functions

B
build: Internal generic functions
build: Internal generic functions

C
call-sequence: Exported functions
collect-slot-values: Exported functions
copy-sequence: Internal functions

D
define-factory: Internal macros
define-sequence: Exported macros

F
find-factory: Exported functions
Function, (setf sequence-funcallable): Internal functions
Function, (setf sequence-initial-value): Internal functions
Function, (setf sequence-value): Internal functions
Function, (setf slot-value): Exported functions
Function, call-sequence: Exported functions
Function, collect-slot-values: Exported functions
Function, copy-sequence: Internal functions
Function, find-factory: Exported functions
Function, get-default-trait: Internal functions
Function, id-field-p: Internal functions
Function, make-anonymous-sequence: Exported functions
Function, make-sequence: Internal functions
Function, merge-traits: Internal functions
Function, process-trait-definitions: Exported functions
Function, reset-sequence: Exported functions
Function, reset-sequences: Exported functions
Function, resolve-traits: Internal functions
Function, sequence-funcallable: Internal functions
Function, sequence-initial-value: Internal functions
Function, sequence-p: Internal functions
Function, sequence-value: Internal functions
Function, slot-value: Exported functions

G
Generic Function, build: Internal generic functions
Generic Function, initialize-slot: Internal generic functions
Generic Function, instantiable-class: Internal generic functions
Generic Function, make-trait-initializer: Internal generic functions
Generic Function, parent-factories: Internal generic functions
Generic Function, traits: Internal generic functions
get-default-trait: Internal functions

I
id-field-p: Internal functions
initialize-slot: Internal generic functions
initialize-slot: Internal generic functions
initialize-slot: Internal generic functions
initialize-slot: Internal generic functions
instantiable-class: Internal generic functions
instantiable-class: Internal generic functions

M
Macro, define-factory: Internal macros
Macro, define-sequence: Exported macros
make-anonymous-sequence: Exported functions
make-sequence: Internal functions
make-trait-initializer: Internal generic functions
make-trait-initializer: Internal generic functions
make-trait-initializer: Internal generic functions
merge-traits: Internal functions
Method, build: Internal generic functions
Method, initialize-slot: Internal generic functions
Method, initialize-slot: Internal generic functions
Method, initialize-slot: Internal generic functions
Method, instantiable-class: Internal generic functions
Method, make-trait-initializer: Internal generic functions
Method, make-trait-initializer: Internal generic functions
Method, parent-factories: Internal generic functions
Method, traits: Internal generic functions

P
parent-factories: Internal generic functions
parent-factories: Internal generic functions
process-trait-definitions: Exported functions

R
reset-sequence: Exported functions
reset-sequences: Exported functions
resolve-traits: Internal functions

S
sequence-funcallable: Internal functions
sequence-initial-value: Internal functions
sequence-p: Internal functions
sequence-value: Internal functions
slot-value: Exported functions

T
traits: Internal generic functions
traits: Internal generic functions

Jump to:   (  
B   C   D   F   G   I   M   P   R   S   T  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
F   I   P   S   T   V  
Index Entry  Section

*
*anonymous-sequence-counter*: Internal special variables
*factories*: Internal special variables
*sequence-state*: Internal special variables

F
factory-name: Internal conditions
funcallable: Internal structures

I
initial-value: Internal structures
instantiable-class: Internal classes

P
parent-factories: Internal classes

S
Slot, factory-name: Internal conditions
Slot, funcallable: Internal structures
Slot, initial-value: Internal structures
Slot, instantiable-class: Internal classes
Slot, parent-factories: Internal classes
Slot, traits: Internal classes
Slot, value: Internal structures
Special Variable, *anonymous-sequence-counter*: Internal special variables
Special Variable, *factories*: Internal special variables
Special Variable, *sequence-state*: Internal special variables

T
traits: Internal classes

V
value: Internal structures

Jump to:   *  
F   I   P   S   T   V  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   F   N   P   S  
Index Entry  Section

C
Class, factory: Internal classes
Condition, no-such-factory: Internal conditions

F
factory: Internal classes
factory-alien: The factory-alien system
factory-alien: The factory-alien package
factory-alien.factories: The factory-alien․factories package
factory-alien.sequences: The factory-alien․sequences package
factory-alien.traits: The factory-alien․traits package

N
no-such-factory: Internal conditions

P
Package, factory-alien: The factory-alien package
Package, factory-alien.factories: The factory-alien․factories package
Package, factory-alien.sequences: The factory-alien․sequences package
Package, factory-alien.traits: The factory-alien․traits package

S
sequence: Internal structures
Structure, sequence: Internal structures
System, factory-alien: The factory-alien system

Jump to:   C   F   N   P   S