diff options
| -rw-r--r-- | src/clojure/contrib/javadoc/browse.clj | 4 | ||||
| -rw-r--r-- | src/clojure/contrib/json/read.clj | 2 | ||||
| -rw-r--r-- | src/clojure/contrib/json/write.clj | 2 | ||||
| -rw-r--r-- | src/clojure/contrib/lazy_seqs.clj | 3 | ||||
| -rw-r--r-- | src/clojure/contrib/test_is.clj | 90 |
5 files changed, 49 insertions, 52 deletions
diff --git a/src/clojure/contrib/javadoc/browse.clj b/src/clojure/contrib/javadoc/browse.clj index 2686f64e..e42c5ecf 100644 --- a/src/clojure/contrib/javadoc/browse.clj +++ b/src/clojure/contrib/javadoc/browse.clj @@ -10,8 +10,8 @@ ; You must not remove this notice, or any other, from this software. (ns - #^{:author "Start a web browser from Clojure", - :doc "Christophe Grand"} + #^{:author "Christophe Grand", + :doc "Start a web browser from Clojure"} clojure.contrib.javadoc.browse (:require [clojure.contrib.shell-out :as sh]) (:import (java.net URI))) diff --git a/src/clojure/contrib/json/read.clj b/src/clojure/contrib/json/read.clj index 084f2a12..47d73499 100644 --- a/src/clojure/contrib/json/read.clj +++ b/src/clojure/contrib/json/read.clj @@ -41,7 +41,7 @@ JavaScript parser. JavaScript functions and object constructors are not supported. Object field names must be quoted strings; they may not be bare symbols.", - :see-also ["http://www.json.org", "JSON Home Page"]} + :see-also [["http://www.json.org", "JSON Home Page"]]} clojure.contrib.json.read (:import (java.io PushbackReader StringReader EOFException)) (:use [clojure.contrib.test-is :only (deftest- is)])) diff --git a/src/clojure/contrib/json/write.clj b/src/clojure/contrib/json/write.clj index 2d149021..5b4731e5 100644 --- a/src/clojure/contrib/json/write.clj +++ b/src/clojure/contrib/json/write.clj @@ -20,7 +20,7 @@ (ns #^{:author "Stuart Sierra", :doc "JavaScript Object Notation (JSON) generator", - :see-also ["http://www.json.org", "JSON Home Page"]} + :see-also [["http://www.json.org", "JSON Home Page"]]} clojure.contrib.json.write (:use [clojure.contrib.test-is :only (deftest- is)])) diff --git a/src/clojure/contrib/lazy_seqs.clj b/src/clojure/contrib/lazy_seqs.clj index 91b2e831..dda5aac5 100644 --- a/src/clojure/contrib/lazy_seqs.clj +++ b/src/clojure/contrib/lazy_seqs.clj @@ -32,7 +32,8 @@ (ns #^{:author "Stephen C. Gilardi", - :doc "==== Lazy sequences ==== + :doc " +==== Lazy sequences ==== primes - based on the \"naive\" implemention described in [1] plus a small \"wheel\" which eliminates multiples of 2, 3, 5, and diff --git a/src/clojure/contrib/test_is.clj b/src/clojure/contrib/test_is.clj index 5ccd60a6..a7b2604b 100644 --- a/src/clojure/contrib/test_is.clj +++ b/src/clojure/contrib/test_is.clj @@ -247,9 +247,9 @@ Chas Emerick, Allen Rohner, and Stuart Halloway", :doc "Inspired by many Common Lisp test frameworks and clojure/test, this file is a Clojure test framework. - + ASSERTIONS - + The core of the library is the \"is\" macro, which lets you make assertions of any arbitrary expression: @@ -259,24 +259,24 @@ Chas Emerick, Allen Rohner, and Stuart Halloway", You can type an \"is\" expression directly at the REPL, which will print a message if it fails. - + user> (is (= 5 (+ 2 2))) - + FAIL in (:1) expected: (= 5 (+ 2 2)) actual: (not (= 5 4)) false - + The \"expected:\" line shows you the original expression, and the \"actual:\" shows you what actually happened. In this case, it shows that (+ 2 2) returned 4, which is not = to 5. Finally, the \"false\" on the last line is the value returned from the expression. The \"is\" macro always returns the result of the inner expression. - + There are two special assertions for testing exceptions. The - \"(is (thrown? c ...))\" form tests if an exception of class c is - thrown: + \"(is (thrown? c ...))\" form tests if an exception of class c is + thrown: (is (thrown? ArithmeticException (/ 1 0))) @@ -288,7 +288,7 @@ Chas Emerick, Allen Rohner, and Stuart Halloway", (/ 1 0))) DOCUMENTING TESTS - + \"is\" takes an optional second argument, a string describing the assertion. This message will be included in the error report. @@ -311,11 +311,10 @@ Chas Emerick, Allen Rohner, and Stuart Halloway", Note that, unlike RSpec, the \"testing\" macro may only be used INSIDE a \"deftest\" or \"with-test\" form (see below). - - - + + DEFINING TESTS - + There are two ways to define tests. The \"with-test\" macro takes a defn or def form as its first argument, followed by any number of assertions. The tests will be stored as metadata on the @@ -329,17 +328,17 @@ Chas Emerick, Allen Rohner, and Stuart Halloway", As of Clojure SVN rev. 1221, this does not work with defmacro. See http://code.google.com/p/clojure/issues/detail?id=51 - + The other way lets you define tests separately from the rest of your code, even in a different namespace: - (deftest addition - (is (= 4 (+ 2 2))) - (is (= 7 (+ 3 4)))) + (deftest addition + (is (= 4 (+ 2 2))) + (is (= 7 (+ 3 4)))) - (deftest subtraction - (is (= 1 (- 4 3))) - (is (= 3 (- 7 4)))) + (deftest subtraction + (is (= 1 (- 4 3))) + (is (= 3 (- 7 4)))) This creates functions named \"addition\" and \"subtraction\", which can be called like any other function. Therefore, tests can be @@ -354,18 +353,17 @@ Chas Emerick, Allen Rohner, and Stuart Halloway", The names of the nested tests will be joined in a list, like \"(arithmetic addition)\", in failure reports. You can use nested tests to set up a context shared by several tests. - - - + + RUNNING TESTS - + Run tests with the function \"(run-tests namespaces...)\": (run-tests 'your.namespace 'some.other.namespace) If you don't specify any namespaces, the current namespace is used. To run all tests in all namespaces, use \"(run-all-tests)\". - + By default, these functions will search for all tests defined in a namespace and run them in an undefined order. However, if you are composing tests, as in the \"arithmetic\" example above, you @@ -376,24 +374,22 @@ Chas Emerick, Allen Rohner, and Stuart Halloway", (defn test-ns-hook [] (arithmetic)) - - - + OMITTING TESTS FROM PRODUCTION CODE - + You can bind the variable \"*load-tests*\" to false when loading or compiling code in production. This will prevent any tests from being created by \"with-test\" or \"deftest\". - - - + + FIXTURES (new) - + Fixtures allow you to run code before and after tests, to set up the context in which tests should be run. - + A fixture is just a function that calls another function passed as an argument. It looks like this: + (defn my-fixture [f] Perform setup, establish bindings, whatever. (f) Then call the function we were passed. @@ -405,58 +401,58 @@ Chas Emerick, Allen Rohner, and Stuart Halloway", with \"deftest\" or \"with-test\". \"each\" fixtures are useful for establishing a consistent before/after state for each test, like clearing out database tables. - + \"each\" fixtures can be attached to the current namespace like this: (use-fixtures :each fixture1 fixture2 ...) The fixture1, fixture2 are just functions like the example above. They can also be anonymous functions, like this: (use-fixtures :each (fn [f] setup... (f) cleanup...)) - + The other kind of fixture, a \"once\" fixture, is only run once, around ALL the tests in the namespace. \"once\" fixtures are useful for tasks that only need to be performed once, like establishing database connections, or for time-consuming tasks. - + Attach \"once\" fixtures to the current namespace like this: (use-fixtures :once fixture1 fixture2 ...) - + SAVING TEST OUTPUT TO A FILE - + All the test reporting functions write to the var *test-out*. By default, this is the same as *out*, but you can rebind it to any PrintWriter. For example, it could be a file opened with clojure.contrib.duck-streams/writer. - + EXTENDING TEST-IS (ADVANCED) - + You can extend the behavior of the \"is\" macro by defining new methods for the \"assert-expr\" multimethod. These methods are called during expansion of the \"is\" macro, so they should return quoted forms to be evaluated. - + You can plug in your own test-reporting framework by rebinding the \"report\" function: (report event) - + The 'event' argument is a map. It will always have a :type key, whose value will be a keyword signaling the type of event being reported. Standard events with :type value of :pass, :fail, and :error are called when an assertion passes, fails, and throws an exception, respectively. In that case, the event will also have the following keys: - + :expected The form that was expected to be true :actual A form representing what actually occurred :message The string message given as an argument to 'is' - + The \"testing\" strings will be a list in \"*testing-contexts*\", and the vars being tested will be a list in \"*testing-vars*\". - + Your \"report\" function should wrap any printing calls in the \"with-test-out\" macro, which rebinds *out* to the current value of *test-out*. - + For additional event types, see the examples in the code. "} clojure.contrib.test-is |