diff options
Diffstat (limited to 'branch-master/mock-api.html')
| -rw-r--r-- | branch-master/mock-api.html | 80 |
1 files changed, 39 insertions, 41 deletions
diff --git a/branch-master/mock-api.html b/branch-master/mock-api.html index ff8ee345..01720cb7 100644 --- a/branch-master/mock-api.html +++ b/branch-master/mock-api.html @@ -37,7 +37,7 @@ namespace. </ul> <span class="toc-header">Namespaces</span> <ul id="left-sidebar-list"> - <li><a href="accumulators-api.html" class="wiki_link">accumulators</a></li><li><a href="agent-utils-api.html" class="wiki_link">agent-utils</a></li><li><a href="base64-api.html" class="wiki_link">base64</a></li><li><a href="classpath-api.html" class="wiki_link">classpath</a></li><li><a href="combinatorics-api.html" class="wiki_link">combinatorics</a></li><li><a href="command-line-api.html" class="wiki_link">command-line</a></li><li><a href="complex-numbers-api.html" class="wiki_link">complex-numbers</a></li><li><a href="cond-api.html" class="wiki_link">cond</a></li><li><a href="condition-api.html" class="wiki_link">condition</a></li><li><a href="core-api.html" class="wiki_link">core</a></li><li><a href="dataflow-api.html" class="wiki_link">dataflow</a></li><li><a href="datalog-api.html" class="wiki_link">datalog</a></li><li><a href="def-api.html" class="wiki_link">def</a></li><li><a href="error-kit-api.html" class="wiki_link">error-kit</a></li><li><a href="except-api.html" class="wiki_link">except</a></li><li><a href="fcase-api.html" class="wiki_link">fcase</a></li><li><a href="find-namespaces-api.html" class="wiki_link">find-namespaces</a></li><li><a href="fnmap-api.html" class="wiki_link">fnmap</a></li><li><a href="gen-html-docs-api.html" class="wiki_link">gen-html-docs</a></li><li><a href="generic.arithmetic-api.html" class="wiki_link">generic.arithmetic</a></li><li><a href="generic.collection-api.html" class="wiki_link">generic.collection</a></li><li><a href="generic.comparison-api.html" class="wiki_link">generic.comparison</a></li><li><a href="generic.functor-api.html" class="wiki_link">generic.functor</a></li><li><a href="generic.math-functions-api.html" class="wiki_link">generic.math-functions</a></li><li><a href="graph-api.html" class="wiki_link">graph</a></li><li><a href="greatest-least-api.html" class="wiki_link">greatest-least</a></li><li><a href="import-static-api.html" class="wiki_link">import-static</a></li><li><a href="io-api.html" class="wiki_link">io</a></li><li><a href="jar-api.html" class="wiki_link">jar</a></li><li><a href="java-utils-api.html" class="wiki_link">java-utils</a></li><li><a href="jmx-api.html" class="wiki_link">jmx</a></li><li><a href="json-api.html" class="wiki_link">json</a></li><li><a href="lazy-seqs-api.html" class="wiki_link">lazy-seqs</a></li><li><a href="lazy-xml-api.html" class="wiki_link">lazy-xml</a></li><li><a href="logging-api.html" class="wiki_link">logging</a></li><li><a href="macro-utils-api.html" class="wiki_link">macro-utils</a></li><li><a href="macros-api.html" class="wiki_link">macros</a></li><li><a href="map-utils-api.html" class="wiki_link">map-utils</a></li><li><a href="math-api.html" class="wiki_link">math</a></li><li><a href="miglayout-api.html" class="wiki_link">miglayout</a></li><li><a href="mmap-api.html" class="wiki_link">mmap</a></li><li><a href="mock-api.html" class="wiki_link">mock</a></li><li><a href="monadic-io-streams-api.html" class="wiki_link">monadic-io-streams</a></li><li><a href="monads-api.html" class="wiki_link">monads</a></li><li><a href="ns-utils-api.html" class="wiki_link">ns-utils</a></li><li><a href="priority-map-api.html" class="wiki_link">priority-map</a></li><li><a href="probabilities.finite-distributions-api.html" class="wiki_link">probabilities.finite-distributions</a></li><li><a href="probabilities.monte-carlo-api.html" class="wiki_link">probabilities.monte-carlo</a></li><li><a href="probabilities.random-numbers-api.html" class="wiki_link">probabilities.random-numbers</a></li><li><a href="profile-api.html" class="wiki_link">profile</a></li><li><a href="properties-api.html" class="wiki_link">properties</a></li><li><a href="prxml-api.html" class="wiki_link">prxml</a></li><li><a href="reflect-api.html" class="wiki_link">reflect</a></li><li><a href="repl-ln-api.html" class="wiki_link">repl-ln</a></li><li><a href="repl-utils-api.html" class="wiki_link">repl-utils</a></li><li><a href="seq-api.html" class="wiki_link">seq</a></li><li><a href="server-socket-api.html" class="wiki_link">server-socket</a></li><li><a href="set-api.html" class="wiki_link">set</a></li><li><a href="singleton-api.html" class="wiki_link">singleton</a></li><li><a href="sql-api.html" class="wiki_link">sql</a></li><li><a href="stream-utils-api.html" class="wiki_link">stream-utils</a></li><li><a href="string-api.html" class="wiki_link">string</a></li><li><a href="strint-api.html" class="wiki_link">strint</a></li><li><a href="swing-utils-api.html" class="wiki_link">swing-utils</a></li><li><a href="test-base64-api.html" class="wiki_link">test-base64</a></li><li><a href="trace-api.html" class="wiki_link">trace</a></li><li><a href="types-api.html" class="wiki_link">types</a></li><li><a href="with-ns-api.html" class="wiki_link">with-ns</a></li><li><a href="zip-filter-api.html" class="wiki_link">zip-filter</a></li> + <li><a href="accumulators-api.html" class="wiki_link">accumulators</a></li><li><a href="agent-utils-api.html" class="wiki_link">agent-utils</a></li><li><a href="base64-api.html" class="wiki_link">base64</a></li><li><a href="classpath-api.html" class="wiki_link">classpath</a></li><li><a href="combinatorics-api.html" class="wiki_link">combinatorics</a></li><li><a href="command-line-api.html" class="wiki_link">command-line</a></li><li><a href="complex-numbers-api.html" class="wiki_link">complex-numbers</a></li><li><a href="cond-api.html" class="wiki_link">cond</a></li><li><a href="condition-api.html" class="wiki_link">condition</a></li><li><a href="core-api.html" class="wiki_link">core</a></li><li><a href="dataflow-api.html" class="wiki_link">dataflow</a></li><li><a href="datalog-api.html" class="wiki_link">datalog</a></li><li><a href="def-api.html" class="wiki_link">def</a></li><li><a href="error-kit-api.html" class="wiki_link">error-kit</a></li><li><a href="except-api.html" class="wiki_link">except</a></li><li><a href="fcase-api.html" class="wiki_link">fcase</a></li><li><a href="find-namespaces-api.html" class="wiki_link">find-namespaces</a></li><li><a href="fnmap-api.html" class="wiki_link">fnmap</a></li><li><a href="gen-html-docs-api.html" class="wiki_link">gen-html-docs</a></li><li><a href="generic.arithmetic-api.html" class="wiki_link">generic.arithmetic</a></li><li><a href="generic.collection-api.html" class="wiki_link">generic.collection</a></li><li><a href="generic.comparison-api.html" class="wiki_link">generic.comparison</a></li><li><a href="generic.functor-api.html" class="wiki_link">generic.functor</a></li><li><a href="generic.math-functions-api.html" class="wiki_link">generic.math-functions</a></li><li><a href="graph-api.html" class="wiki_link">graph</a></li><li><a href="greatest-least-api.html" class="wiki_link">greatest-least</a></li><li><a href="import-static-api.html" class="wiki_link">import-static</a></li><li><a href="jar-api.html" class="wiki_link">jar</a></li><li><a href="java-utils-api.html" class="wiki_link">java-utils</a></li><li><a href="jmx-api.html" class="wiki_link">jmx</a></li><li><a href="json-api.html" class="wiki_link">json</a></li><li><a href="lazy-seqs-api.html" class="wiki_link">lazy-seqs</a></li><li><a href="lazy-xml-api.html" class="wiki_link">lazy-xml</a></li><li><a href="logging-api.html" class="wiki_link">logging</a></li><li><a href="macro-utils-api.html" class="wiki_link">macro-utils</a></li><li><a href="macros-api.html" class="wiki_link">macros</a></li><li><a href="map-utils-api.html" class="wiki_link">map-utils</a></li><li><a href="math-api.html" class="wiki_link">math</a></li><li><a href="miglayout-api.html" class="wiki_link">miglayout</a></li><li><a href="mmap-api.html" class="wiki_link">mmap</a></li><li><a href="mock-api.html" class="wiki_link">mock</a></li><li><a href="monadic-io-streams-api.html" class="wiki_link">monadic-io-streams</a></li><li><a href="monads-api.html" class="wiki_link">monads</a></li><li><a href="ns-utils-api.html" class="wiki_link">ns-utils</a></li><li><a href="priority-map-api.html" class="wiki_link">priority-map</a></li><li><a href="probabilities.finite-distributions-api.html" class="wiki_link">probabilities.finite-distributions</a></li><li><a href="probabilities.monte-carlo-api.html" class="wiki_link">probabilities.monte-carlo</a></li><li><a href="probabilities.random-numbers-api.html" class="wiki_link">probabilities.random-numbers</a></li><li><a href="profile-api.html" class="wiki_link">profile</a></li><li><a href="prxml-api.html" class="wiki_link">prxml</a></li><li><a href="reflect-api.html" class="wiki_link">reflect</a></li><li><a href="repl-ln-api.html" class="wiki_link">repl-ln</a></li><li><a href="repl-utils-api.html" class="wiki_link">repl-utils</a></li><li><a href="seq-api.html" class="wiki_link">seq</a></li><li><a href="server-socket-api.html" class="wiki_link">server-socket</a></li><li><a href="set-api.html" class="wiki_link">set</a></li><li><a href="singleton-api.html" class="wiki_link">singleton</a></li><li><a href="sql-api.html" class="wiki_link">sql</a></li><li><a href="stream-utils-api.html" class="wiki_link">stream-utils</a></li><li><a href="strint-api.html" class="wiki_link">strint</a></li><li><a href="swing-utils-api.html" class="wiki_link">swing-utils</a></li><li><a href="test-base64-api.html" class="wiki_link">test-base64</a></li><li><a href="trace-api.html" class="wiki_link">trace</a></li><li><a href="types-api.html" class="wiki_link">types</a></li><li><a href="with-ns-api.html" class="wiki_link">with-ns</a></li><li><a href="zip-filter-api.html" class="wiki_link">zip-filter</a></li> </ul> <div class="BranchTOC"> <span class="toc-header">Other Versions</span> @@ -131,13 +131,13 @@ namespace. </pre> <pre id="var-docstr">Creates or associates to an existing expectation hash the :calls key with a function that will be called with the given arguments. The return value from -this function will be returned returned by the expected function. If both this -and returns are specified, the return value of "calls" will have precedence. +this function will be returned by the expected function. If both this +and :returns are specified, the return value of :calls will have precedence. Usage: (calls some-fn expectation-hash?)</pre> - + <a href="http://github.com/clojure/clojure-contrib/blob//modules/clojure/contrib/mock.clj#L209" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -146,22 +146,22 @@ Usage: <pre id="var-usage">Usage: (expect expect-bindings & body) </pre> <pre id="var-docstr">Use expect to redirect calls to dependent functions that are made within the -code under test. Instead of calling the functions that would normally be used, +code under test. Instead of calling the functions that would normally be used temporary stubs are used, which can verify function parameters and call counts. -Return values can also be specified as needed. +Return values of overridden functions can also be specified as needed. Usage: (expect [dep-fn (has-args [arg-pred1] (times n (returns x)))] - (function-under-test a b c))</pre> - + (function-under-test a b c))</pre> + <a href="http://github.com/clojure/clojure-contrib/blob//modules/clojure/contrib/mock.clj#L258" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> <h2 id="clojure.contrib.mock/has-args">has-args</h2> <span id="var-type">macro</span><br /> <pre id="var-usage">Usage: (has-args arg-pred-forms) - (has-args arg-pred-forms expect-hash-form) + (has-args arg-pred-forms expectation-hash) </pre> <pre id="var-docstr">Creates or associates to an existing expectation hash the :has-args key with a value corresponding to a function that will either return true if its @@ -173,7 +173,7 @@ Usage: (has-args [arg-pred-1 arg-pred-2 ... arg-pred-n] expectation-hash?)</pre> - + <a href="http://github.com/clojure/clojure-contrib/blob//modules/clojure/contrib/mock.clj#L223" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -186,7 +186,7 @@ function. If no argslist meta data is available for the function, it is not called.</pre> - + <a href="http://github.com/clojure/clojure-contrib/blob//modules/clojure/contrib/mock.clj#L102" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -201,7 +201,7 @@ designed to be called from the mock function generated in the first argument of the mock info object created by make-mock.</pre> - + <a href="http://github.com/clojure/clojure-contrib/blob//modules/clojure/contrib/mock.clj#L113" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -214,7 +214,7 @@ the code under test has all been executed. The function returned takes the name of the associated dependency and the invocation count as arguments.</pre> - + <a href="http://github.com/clojure/clojure-contrib/blob//modules/clojure/contrib/mock.clj#L129" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -223,14 +223,14 @@ name of the associated dependency and the invocation count as arguments.</pre> <pre id="var-usage">Usage: (make-mock fn-name expectation-hash) </pre> <pre id="var-docstr">creates a vector containing the following information for the named function: -1. dependent function replacement - verifies signature, calls arg checker, +1. dependent function replacement - verifies signature, calls arg checker increases count, returns return value. 2. an atom containing the invocation count 3. the invocation count checker function 4. a symbol of the name of the function being replaced.</pre> - + <a href="http://github.com/clojure/clojure-contrib/blob//modules/clojure/contrib/mock.clj#L138" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -246,7 +246,7 @@ Usage: (returns ret-value expectation-hash?)</pre> - + <a href="http://github.com/clojure/clojure-contrib/blob//modules/clojure/contrib/mock.clj#L197" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -257,18 +257,17 @@ Usage: </pre> <pre id="var-docstr">Creates or associates to an existing expectation hash the :times key with a value corresponding to a predicate function which expects an integer value. -This function can either be specified as the first argument to times or can be -the result of calling times with an integer argument, in which case the -predicate will default to being an exact match. This predicate is called at -the end of an expect expression to validate that an expected dependency -function was called the expected number of times. +Also, an integer can be specified, in which case the times will only be an +exact match. The times check is called at the end of an expect expression to +validate that an expected dependency function was called the expected +number of times. Usage: (times n) (times #(> n %)) (times n expectation-hash)</pre> - + <a href="http://github.com/clojure/clojure-contrib/blob//modules/clojure/contrib/mock.clj#L240" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -280,7 +279,7 @@ Usage: count checker for each dependency.</pre> - + <a href="http://github.com/clojure/clojure-contrib/blob//modules/clojure/contrib/mock.clj#L163" id="var-source">Source</a> </div> <h2 id="namespace-name">mock.test-adapter</h2> <pre id="namespace-docstr"></pre> @@ -296,19 +295,19 @@ count checker for each dependency.</pre> </pre> <pre id="var-docstr">Creates or associates to an existing expectation hash the :calls key with a function that will be called with the given arguments. The return value from -this function will be returned returned by the expected function. If both this -and returns are specified, the return value of "calls" will have precedence. +this function will be returned by the expected function. If both this +and :returns are specified, the return value of :calls will have precedence. Usage: (calls some-fn expectation-hash?)</pre> - + <a href="http://github.com/clojure/clojure-contrib/blob//modules/clojure/contrib/mock.clj#L209" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="clojure.contrib.mock.test-adapter/has-args">has-args</h2> <span id="var-type">macro</span><br /> <pre id="var-usage">Usage: (has-args arg-pred-forms) - (has-args arg-pred-forms expect-hash-form) + (has-args arg-pred-forms expectation-hash) </pre> <pre id="var-docstr">Creates or associates to an existing expectation hash the :has-args key with a value corresponding to a function that will either return true if its @@ -320,7 +319,7 @@ Usage: (has-args [arg-pred-1 arg-pred-2 ... arg-pred-n] expectation-hash?)</pre> - + <a href="http://github.com/clojure/clojure-contrib/blob//modules/clojure/contrib/mock.clj#L223" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="clojure.contrib.mock.test-adapter/has-matching-signature?">has-matching-signature?</h2> @@ -332,7 +331,7 @@ function. If no argslist meta data is available for the function, it is not called.</pre> - + <a href="http://github.com/clojure/clojure-contrib/blob//modules/clojure/contrib/mock.clj#L102" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="clojure.contrib.mock.test-adapter/make-arg-checker">make-arg-checker</h2> @@ -346,7 +345,7 @@ designed to be called from the mock function generated in the first argument of the mock info object created by make-mock.</pre> - + <a href="http://github.com/clojure/clojure-contrib/blob//modules/clojure/contrib/mock.clj#L113" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="clojure.contrib.mock.test-adapter/make-count-checker">make-count-checker</h2> @@ -358,7 +357,7 @@ the code under test has all been executed. The function returned takes the name of the associated dependency and the invocation count as arguments.</pre> - + <a href="http://github.com/clojure/clojure-contrib/blob//modules/clojure/contrib/mock.clj#L129" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="clojure.contrib.mock.test-adapter/make-mock">make-mock</h2> @@ -366,14 +365,14 @@ name of the associated dependency and the invocation count as arguments.</pre> <pre id="var-usage">Usage: (make-mock fn-name expectation-hash) </pre> <pre id="var-docstr">creates a vector containing the following information for the named function: -1. dependent function replacement - verifies signature, calls arg checker, +1. dependent function replacement - verifies signature, calls arg checker increases count, returns return value. 2. an atom containing the invocation count 3. the invocation count checker function 4. a symbol of the name of the function being replaced.</pre> - + <a href="http://github.com/clojure/clojure-contrib/blob//modules/clojure/contrib/mock.clj#L138" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="clojure.contrib.mock.test-adapter/report-problem">report-problem</h2> @@ -400,7 +399,7 @@ Usage: (returns ret-value expectation-hash?)</pre> - + <a href="http://github.com/clojure/clojure-contrib/blob//modules/clojure/contrib/mock.clj#L197" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="clojure.contrib.mock.test-adapter/times">times</h2> @@ -410,18 +409,17 @@ Usage: </pre> <pre id="var-docstr">Creates or associates to an existing expectation hash the :times key with a value corresponding to a predicate function which expects an integer value. -This function can either be specified as the first argument to times or can be -the result of calling times with an integer argument, in which case the -predicate will default to being an exact match. This predicate is called at -the end of an expect expression to validate that an expected dependency -function was called the expected number of times. +Also, an integer can be specified, in which case the times will only be an +exact match. The times check is called at the end of an expect expression to +validate that an expected dependency function was called the expected +number of times. Usage: (times n) (times #(> n %)) (times n expectation-hash)</pre> - + <a href="http://github.com/clojure/clojure-contrib/blob//modules/clojure/contrib/mock.clj#L240" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="clojure.contrib.mock.test-adapter/validate-counts">validate-counts</h2> @@ -432,7 +430,7 @@ Usage: count checker for each dependency.</pre> - + <a href="http://github.com/clojure/clojure-contrib/blob//modules/clojure/contrib/mock.clj#L163" id="var-source">Source</a> </div> |