diff options
author | Tom Faulhaber <git_net@infolace.com> | 2010-06-02 10:47:29 -0700 |
---|---|---|
committer | Tom Faulhaber <git_net@infolace.com> | 2010-06-02 10:47:29 -0700 |
commit | b17ce9fbb29483eb8f6e591a1ff282db453a4713 (patch) | |
tree | c802eb892622de7b7a34cce55524fd5f91491817 /branch-1.1.x/mock-api.html | |
parent | b9907dc35b12f46c584f426aacc61b4375f9ea8c (diff) |
Autodoc commit for master/4fe738db, 1.1.x/d132c5f1
Diffstat (limited to 'branch-1.1.x/mock-api.html')
-rw-r--r-- | branch-1.1.x/mock-api.html | 360 |
1 files changed, 358 insertions, 2 deletions
diff --git a/branch-1.1.x/mock-api.html b/branch-1.1.x/mock-api.html index 02f7ddec..56efea5d 100644 --- a/branch-1.1.x/mock-api.html +++ b/branch-1.1.x/mock-api.html @@ -40,7 +40,7 @@ namespace. <a class="wiki_link" href="api-index.html">API Index</a><br /> <a class="wiki_link" href="#">Namespaces:</a> <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="apply-macro-api.html" class="wiki_link">apply-macro</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="duck-streams-api.html" class="wiki_link">duck-streams</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="http.agent-api.html" class="wiki_link">http.agent</a></li><li><a href="http.connection-api.html" class="wiki_link">http.connection</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.read-api.html" class="wiki_link">json.read</a></li><li><a href="json.write-api.html" class="wiki_link">json.write</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="pprint-api.html" class="wiki_link">pprint</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="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-utils-api.html" class="wiki_link">seq-utils</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="shell-out-api.html" class="wiki_link">shell-out</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="str-utils-api.html" class="wiki_link">str-utils</a></li><li><a href="str-utils2-api.html" class="wiki_link">str-utils2</a></li><li><a href="stream-utils-api.html" class="wiki_link">stream-utils</a></li><li><a href="swing-utils-api.html" class="wiki_link">swing-utils</a></li><li><a href="test-is-api.html" class="wiki_link">test-is</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="apply-macro-api.html" class="wiki_link">apply-macro</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="duck-streams-api.html" class="wiki_link">duck-streams</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="http.agent-api.html" class="wiki_link">http.agent</a></li><li><a href="http.connection-api.html" class="wiki_link">http.connection</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="javadoc.browse-api.html" class="wiki_link">javadoc.browse</a></li><li><a href="jmx-api.html" class="wiki_link">jmx</a></li><li><a href="json.read-api.html" class="wiki_link">json.read</a></li><li><a href="json.write-api.html" class="wiki_link">json.write</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="pprint-api.html" class="wiki_link">pprint</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="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-utils-api.html" class="wiki_link">seq-utils</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="shell-out-api.html" class="wiki_link">shell-out</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="str-utils-api.html" class="wiki_link">str-utils</a></li><li><a href="str-utils2-api.html" class="wiki_link">str-utils2</a></li><li><a href="stream-utils-api.html" class="wiki_link">stream-utils</a></li><li><a href="swing-utils-api.html" class="wiki_link">swing-utils</a></li><li><a href="test-is-api.html" class="wiki_link">test-is</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> </div> @@ -53,7 +53,51 @@ namespace. <h1 class="nopad">Table of Contents</h1> <div style="margin-left: 1em;" class="toc-section"> <a href="#toc0">Overview</a> - + <div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.mock/calls">calls</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.mock/expect">expect</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.mock/has-args">has-args</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.mock/has-matching-signature?">has-matching-signature?</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.mock/make-arg-checker">make-arg-checker</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.mock/make-count-checker">make-count-checker</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.mock/make-mock">make-mock</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.mock/returns">returns</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.mock/times">times</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.mock/validate-counts">validate-counts</a> + </div> + <br /> + </div><div style="margin-left: 1em;" class="toc-section"> + <a href="#mock.test-adapter">mock.test-adapter</a> + <div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.mock.test-adapter/calls">calls</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.mock.test-adapter/has-args">has-args</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.mock.test-adapter/has-matching-signature?">has-matching-signature?</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.mock.test-adapter/make-arg-checker">make-arg-checker</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.mock.test-adapter/make-count-checker">make-count-checker</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.mock.test-adapter/make-mock">make-mock</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.mock.test-adapter/report-problem">report-problem</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.mock.test-adapter/returns">returns</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.mock.test-adapter/times">times</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.mock.test-adapter/validate-counts">validate-counts</a> + </div> <br /> </div> </div> @@ -72,7 +116,319 @@ by <span id="author">Unknown</span><br /> <br /> <h2>Public Variables and Functions</h2> +<div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.mock/calls">calls</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (calls val) + (calls val expectation-hash) +</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. +Usage: +(calls some-fn expectation-hash?)</pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/a4a4a534d7dddc1d58fc93a216192bf4bb7b20ff/src/clojure/contrib/mock.clj#L216" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.mock/expect">expect</h2> + <span id="var-type">macro</span><br /> + <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, +temporary stubs are used, which can verify function parameters and call counts. +Return values 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> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/a4a4a534d7dddc1d58fc93a216192bf4bb7b20ff/src/clojure/contrib/mock.clj#L265" 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) +</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 +argument expectations are met or throw an exception with the details of the +first failed argument it encounters. +Only specify as many predicates as you are interested in verifying. The rest +of the values are safely ignored. +Usage: +(has-args [arg-pred-1 arg-pred-2 ... arg-pred-n] expectation-hash?)</pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/a4a4a534d7dddc1d58fc93a216192bf4bb7b20ff/src/clojure/contrib/mock.clj#L228" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.mock/has-matching-signature?">has-matching-signature?</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (has-matching-signature? fn-name args) +</pre> + <pre id="var-docstr">Calls no-matching-function-signature if no match is found for the given +function. If no argslist meta data is available for the function, it is +not called.</pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/a4a4a534d7dddc1d58fc93a216192bf4bb7b20ff/src/clojure/contrib/mock.clj#L105" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.mock/make-arg-checker">make-arg-checker</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (make-arg-checker arg-preds arg-pred-forms) +</pre> + <pre id="var-docstr">Creates the argument verifying function for a replaced dependency within +the expectation bound scope. These functions take the additional argument +of the name of the replaced function, then the rest of their args. It is +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/richhickey/clojure-contrib/blob/a4a4a534d7dddc1d58fc93a216192bf4bb7b20ff/src/clojure/contrib/mock.clj#L116" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.mock/make-count-checker">make-count-checker</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (make-count-checker pred pred-form) +</pre> + <pre id="var-docstr">creates the count checker that is invoked at the end of an expectation, after +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/richhickey/clojure-contrib/blob/a4a4a534d7dddc1d58fc93a216192bf4bb7b20ff/src/clojure/contrib/mock.clj#L131" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.mock/make-mock">make-mock</h2> + <span id="var-type">function</span><br /> + <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, +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/richhickey/clojure-contrib/blob/a4a4a534d7dddc1d58fc93a216192bf4bb7b20ff/src/clojure/contrib/mock.clj#L150" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.mock/returns">returns</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (returns val) + (returns val expectation-hash) +</pre> + <pre id="var-docstr">Creates or associates to an existing expectation hash the :returns key with +a value to be returned by the expectation after a successful invocation +matching its expected arguments (if applicable). +Usage: +(returns ret-value expectation-hash?)</pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/a4a4a534d7dddc1d58fc93a216192bf4bb7b20ff/src/clojure/contrib/mock.clj#L205" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.mock/times">times</h2> + <span id="var-type">macro</span><br /> + <pre id="var-usage">Usage: (times times-fn) + (times times-fn expectation-hash) +</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. +Usage: +(times n) +(times #(> n %)) +(times n expectation-hash)</pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/a4a4a534d7dddc1d58fc93a216192bf4bb7b20ff/src/clojure/contrib/mock.clj#L246" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.mock/validate-counts">validate-counts</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (validate-counts mock-data) +</pre> + <pre id="var-docstr">given the sequence of all mock data for the expectation, simply calls the +count checker for each dependency.</pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/a4a4a534d7dddc1d58fc93a216192bf4bb7b20ff/src/clojure/contrib/mock.clj#L175" id="var-source">Source</a> +</div> +<h2 id="namespace-name">mock.test-adapter</h2> +<pre id="namespace-docstr"></pre> + +<br /> +<div id="var-entry"> + <hr /> + <h2 id="clojure.contrib.mock.test-adapter/calls">calls</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (calls val) + (calls val expectation-hash) +</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. +Usage: +(calls some-fn expectation-hash?)</pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/a4a4a534d7dddc1d58fc93a216192bf4bb7b20ff/src/clojure/contrib/mock.clj#L216" 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) +</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 +argument expectations are met or throw an exception with the details of the +first failed argument it encounters. +Only specify as many predicates as you are interested in verifying. The rest +of the values are safely ignored. +Usage: +(has-args [arg-pred-1 arg-pred-2 ... arg-pred-n] expectation-hash?)</pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/a4a4a534d7dddc1d58fc93a216192bf4bb7b20ff/src/clojure/contrib/mock.clj#L228" 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> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (has-matching-signature? fn-name args) +</pre> + <pre id="var-docstr">Calls no-matching-function-signature if no match is found for the given +function. If no argslist meta data is available for the function, it is +not called.</pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/a4a4a534d7dddc1d58fc93a216192bf4bb7b20ff/src/clojure/contrib/mock.clj#L105" 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> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (make-arg-checker arg-preds arg-pred-forms) +</pre> + <pre id="var-docstr">Creates the argument verifying function for a replaced dependency within +the expectation bound scope. These functions take the additional argument +of the name of the replaced function, then the rest of their args. It is +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/richhickey/clojure-contrib/blob/a4a4a534d7dddc1d58fc93a216192bf4bb7b20ff/src/clojure/contrib/mock.clj#L116" 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> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (make-count-checker pred pred-form) +</pre> + <pre id="var-docstr">creates the count checker that is invoked at the end of an expectation, after +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/richhickey/clojure-contrib/blob/a4a4a534d7dddc1d58fc93a216192bf4bb7b20ff/src/clojure/contrib/mock.clj#L131" id="var-source">Source</a> +</div><div id="var-entry"> + <hr /> + <h2 id="clojure.contrib.mock.test-adapter/make-mock">make-mock</h2> + <span id="var-type">function</span><br /> + <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, +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/richhickey/clojure-contrib/blob/a4a4a534d7dddc1d58fc93a216192bf4bb7b20ff/src/clojure/contrib/mock.clj#L150" id="var-source">Source</a> +</div><div id="var-entry"> + <hr /> + <h2 id="clojure.contrib.mock.test-adapter/report-problem">report-problem</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (report-problem fn-name expected actual msg) +</pre> + <pre id="var-docstr">This function is designed to be used in a binding macro to override +the report-problem function in clojure.contrib.mock. Instead of printing +the error to the console, the error is logged via clojure.test.</pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/a4a4a534d7dddc1d58fc93a216192bf4bb7b20ff/src/clojure/contrib/mock/test_adapter.clj#L19" id="var-source">Source</a> +</div><div id="var-entry"> + <hr /> + <h2 id="clojure.contrib.mock.test-adapter/returns">returns</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (returns val) + (returns val expectation-hash) +</pre> + <pre id="var-docstr">Creates or associates to an existing expectation hash the :returns key with +a value to be returned by the expectation after a successful invocation +matching its expected arguments (if applicable). +Usage: +(returns ret-value expectation-hash?)</pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/a4a4a534d7dddc1d58fc93a216192bf4bb7b20ff/src/clojure/contrib/mock.clj#L205" id="var-source">Source</a> +</div><div id="var-entry"> + <hr /> + <h2 id="clojure.contrib.mock.test-adapter/times">times</h2> + <span id="var-type">macro</span><br /> + <pre id="var-usage">Usage: (times times-fn) + (times times-fn expectation-hash) +</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. +Usage: +(times n) +(times #(> n %)) +(times n expectation-hash)</pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/a4a4a534d7dddc1d58fc93a216192bf4bb7b20ff/src/clojure/contrib/mock.clj#L246" id="var-source">Source</a> +</div><div id="var-entry"> + <hr /> + <h2 id="clojure.contrib.mock.test-adapter/validate-counts">validate-counts</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (validate-counts mock-data) +</pre> + <pre id="var-docstr">given the sequence of all mock data for the expectation, simply calls the +count checker for each dependency.</pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/a4a4a534d7dddc1d58fc93a216192bf4bb7b20ff/src/clojure/contrib/mock.clj#L175" id="var-source">Source</a> +</div> </div> |