package.lisp @@ -19,6 +19,11 @@ the condition text is not very useful). See the Lisp files in the examples directory for some very simple examples of specifications. +== Loading + +(asdf:oos 'asdf:load-op :cl-spec) + + == Usage There are three ways to run a spec. README @@ -11,6 +11,7 @@ - mocks - more matchers - groups +- integrate with clickcheck * Literacy - should it expand to defclass, with an initarg of tests? TODO @@ -4,6 +4,8 @@ ;;; ows 2008-01-05 -- fixed compiler errors and warnings ;;; ows 2008-01-08 -- eval -> funcall, to capture lexical scope +(in-package #:cl-spec) + ;; Utilities (eval-when (:compile-toplevel :load-toplevel :execute) (defmethod obj->string ((s string)) @@ -164,5 +166,3 @@ (defmacro specify (name &body body) `(let ((*spec-specification* ,name)) ,@body)) - -(provide 'bdd) bdd.lisp @@ -1,19 +1,26 @@ -;;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Base: 10 -*- +#| +Copyright 2008 by Oliver Steele. All rights reserved. -(defpackage #:cl-spec-asd (:use :cl :asdf)) +This code is available under the MIT License. +|# + +(defpackage #:cl-spec-asd (:use #:cl #:asdf)) (in-package #:cl-spec-asd) -(defsystem "cl-spec" +(asdf:defsystem "cl-spec" :description "Behavioral Testing for Common Lisp." - :version "0.1" - :author "Oliver Steele <steele@osteele.com>" + :version "0.1.6" + :author "Oliver Steele <steele@osteele.com>, Yurii Rashkovskii" + :maintainer "Oliver Steele <steele@osteele.com>" :licence "MIT License" - :components ((:file "formatters" - :depends-on ("specify" "utilities" "templates")) - (:file "runners") - (:file "specify" :depends-on ("bdd" "utilities")) - (:file "templates"); :depends-on ("utilities")) + :serial t + :components ((:file "package") (:file "utilities") - (:file "bdd")) + (:file "templates"); :depends-on ("utilities")) + (:file "bdd") + (:file "specify" :depends-on ("bdd" "utilities")) + (:file "formatters" + :depends-on ("specify" "utilities" "templates")) + (:file "runners")) ;:depends-on (:lexicons) ) cl-spec.asd @@ -1,12 +1,12 @@ ;;; Copyright 2008 by Oliver Steele. Released under the MIT License. -(define-specification "an empty dictionary" ((dict {})) +(cl-spec:specify "an empty dictionary" ((dict {})) ("should have no keys" (=> (length (keys dict)) should be zero)) ("should not have an entry for :key" (=> (ref1 dict :key) should eq nil))) -(define-specification "a dictionary with one entry" ((dict {a-key 'a-value})) +(cl-spec:specify "a dictionary with one entry" ((dict {a-key 'a-value})) ("should have one key" (=> (length (keys dict)) should eq 1)) ("should have a set of keys that contains its key" examples/dictionary-spec.lisp @@ -1,6 +1,8 @@ ;;; Copyright 2008 by Oliver Steele. Released under the MIT License. -(define-specification "a spec with some failing examples" () +(in-package #:cl-user) + +(cl-spec:specify "a spec with some failing examples" () ("should pass" (=> (+ 1 2) should = 3)) ("should fail" @@ -8,7 +10,7 @@ ("should also fail" (=> (+ 1 2) should = 4))) -(define-specification "a spec with all passing example" () +(cl-spec:specify "a spec with all passing examples" () ("first example should pass" (=> (+ 1 2) should = 3)) ("second example should also pass" examples/failing-spec.lisp @@ -1,5 +1,6 @@ ;;; Copyright 2008 by Oliver Steele. Released under the MIT License. +(in-package #:cl-spec) (defclass specification-formatter () ()) formatters.lisp @@ -1,9 +1,15 @@ ;;; Copyright 2008 by Oliver Steele. Released under the MIT License. +(in-package #:cl-spec) + ;;; ;;; Running ;;; +(defun run-spec (&rest rest) + "An abbreviation for run-specification." + (apply #'run-specification rest)) + (defmethod run-specification ((self specification) &key onsuccess onerror) "Run all the examples. Returns a SPECIFICATION-RESULTS. runners.lisp @@ -1,7 +1,8 @@ ;;; Copyright 2008 by Oliver Steele. Released under the MIT License. +(in-package #:cl-spec) + (require 'dictionary) -(require 'bdd) (defvar *collect-specifications* nil "If true, DEFINE-SPECIFICATION collects specifications into @@ -28,7 +29,7 @@ for DEFINE-SPECIFICATION to collect into.") of named examples.")) (defmethod print-object ((self specification) stream) - (format stream "#<specification ~S>" (specification-name name))) + (format stream "#<specification ~S>" (specification-name specification))) (defmacro define-specification (name bindings &body body) "Define a SPECIFICATION, with a name, variables, and a list of examples. @@ -66,6 +67,8 @@ subdirectory for examples in Lisp syntax." (run-specification spec)) spec))))) +(defmacro specify (name bindings &rest examples) + `(define-specification ,name ,bindings ,@examples)) ;;; ;;; Specification results @@ -79,6 +82,11 @@ subdirectory for examples in Lisp syntax." (defclass abstract-specification-results () ()) +(dolist (name '(examples failures examples-count failures-count elapsed-time)) + (ensure-generic-function (intern (format nil "SPECIFICATION-RESULTS-~A" name)) + :argument-precedence-order '(specification-results))) + + (defclass specification-results-group (abstract-specification-results) ((children :initarg :children :reader specification-results-children specify.lisp @@ -1,5 +1,7 @@ ;;; Copyright 2008 by Oliver Steele. Released under the MIT License. +(in-package #:cl-spec) + ;; A quick and dirty template facilityq that does just enough to ;; enable HTML output from cl-spec. A proper implementation would ;; compile to a function, as well as use a proper parser. templates.lisp 90633abd1672f695d57edb3e1e06830213ac1a7f Oliver Steele steele@osteele.com http://github.com/osteele/cl-spec/commit/86ec419166158682ab6de9dbe6e4d8458435ddca 86ec419166158682ab6de9dbe6e4d8458435ddca 2008-01-15T07:31:35-08:00 2008-01-15T07:31:35-08:00 add package 98705085f67e3a78d86bbd57d4313892bb1eb478 Oliver Steele steele@osteele.com