@@ -33,169 +33,93 @@ <h1>Dr Nic’s JavaScript Test Helpers</h1> <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/drnicutilities"; return false'> <p>Get Version</p> - <a href="http://rubyforge.org/projects/drnicutilities" class="numbers">0.8.0</a> + <a href="http://rubyforge.org/projects/drnicutilities" class="numbers">0.8.1</a> </div> <h2>What</h2> - - - <p>This JavaScript project provides help for unit testing other JavaScript projects:</p> - - - <ul> +<p>This JavaScript project provides help for unit testing other JavaScript projects:</p> +<ul> <li><code>Event.simulate('element', 'eventName')</code></li> - <li><code>Ajax.Request</code> mocking (for <a href="http://www.prototypejs.org/">Prototypejs</a> based projects)</li> - <li>Extra test case assertions (assertDifference, assertNoDifference)</li> - </ul> - - - <h2>Downloading</h2> - - - <p>Latest version: <a href="dist/drnic_js_test_helpers.js">drnic_js_test_helpers.js</a></p> - - - <p>Alternately, to get the complete project source go to the <a href="http://rubyforge.org/frs/?group_id=2351&release_id=19240">downloads</a> -page on rubyforge.org, or by clicking on “Get Version” badge above and clicking + <li><code>Ajax.Request</code> mocking (for <a href="http://www.prototypejs.org/">Prototypejs</a> based projects)</li> + <li>Extra test case assertions (assertDifference, assertNoDifference)</li> +</ul> +<h2>Downloading</h2> +<p>Latest version: <a href="dist/drnic_js_test_helpers.js">drnic_js_test_helpers.js</a></p> +<p>Alternately, to get the complete project source go to the <a href="http://rubyforge.org/frs/?group_id=2351&release_id=19240">downloads</a><br /> +page on rubyforge.org, or by clicking on “Get Version” badge above and clicking<br /> through to “drnic_js_test_helpers”.</p> - - - <p>Save the file within your JavaScript project, say in <code>test/assets</code>, +<p>Save the file within your JavaScript project, say in <code>test/assets</code>,<br /> and link to it from your <span class="caps">HTML</span> test files.</p> - - - <h2>Setup/installation</h2> - - -This library is for use within unittest.js related <span class="caps">HTML</span> test files. If your test <span class="caps">HTML</span> -files are in <code>test/</code> and the library is saved at -<code>test/assets/drnic_js_test_helpers.js</code>, then within the <head> -of each <span class="caps">HTML</span> test file add: - - <p><pre class='syntax'> +<h2>Setup/installation</h2> +<p>This library is for use within unittest.js related <span class="caps">HTML</span> test files. If your test <span class="caps">HTML</span><br /> +files are in <code>test/</code> and the library is saved at<br /> +<code>test/assets/drnic_js_test_helpers.js</code>, then within the <head><br /> +of each <span class="caps">HTML</span> test file add:</p> +<p><pre class='syntax'> <script src="assets/drnic_js_test_helpers.js" type="text/javascript"></script> </pre></p> - - - <h2>Demonstration of usage</h2> - - - <p>This library currently offers some helpers:</p> - - - <ul> +<h2>Demonstration of usage</h2> +<p>This library currently offers some helpers:</p> +<ul> <li>Event simulation – simulating mouse events (click, mouseover, etc), or <span class="caps">HTML</span> events (change, etc)</li> - <li>Ajax request mocking – no Ajax requests available during unit testing, so mock them out</li> - <li>Extra test assertions – bonus assertXXX methods for unittest.js</li> - </ul> - - - <h3>Event simulation</h3> - - - <p><pre class='syntax'>Event.simulate('element', 'eventName')</pre></p> - - - <h3>Ajax request mocking</h3> - - -<code>Ajax.Request</code> mocking (for <a href="http://www.prototypejs.org/">Prototypejs</a> based projects) - - <p>Within your test or setup method:</p> - - - <p><pre class='syntax'>Ajax.Request.setupMock('/some/url', function(request, response) { + <li>Ajax request mocking – no Ajax requests available during unit testing, so mock them out</li> + <li>Extra test assertions – bonus assertXXX methods for unittest.js</li> +</ul> +<h3>Event simulation</h3> +<p><pre class='syntax'>Event.simulate('element', 'eventName')</pre></p> +<h3>Ajax request mocking</h3> +<p><code>Ajax.Request</code> mocking (for <a href="http://www.prototypejs.org/">Prototypejs</a> based projects)</p> +<p>Within your test or setup method:</p> +<p><pre class='syntax'>Ajax.Request.setupMock('/some/url', function(request, response) { response.responseJSON = "{data: 123}"; request.options.onComplete(response); });</pre></p> - - - <p>Now, during your test if <code>new Ajax.Request('/some/url', {onComplete: function() {...}})</code> -is called, then the <code>onComplete</code> callback will be invoked, +<p>Now, during your test if <code>new Ajax.Request('/some/url', {onComplete: function() {...}})</code> <br /> +is called, then the <code>onComplete</code> callback will be invoked, <br /> and <code>responseJSON</code> will have a mocked out value.</p> - - - <p>Within your teardown method it is advisable to clear the mocks, thus each test needs to setup the mock it requires:</p> - - +<p>Within your teardown method it is advisable to clear the mocks, thus each test needs to setup the mock it requires:</p> <pre>teardown: function() { Ajax.Request.clearMocks(); }, </pre> - - <p>The <code>clearMocks</code> call is to restore the Ajax mechanism; which is used -when you run tests via <code>rake test</code> to communicate the test results back -to the command-line test server. If <code>rake test</code> is hanging, it is +<p>The <code>clearMocks</code> call is to restore the Ajax mechanism; which is used<br /> +when you run tests via <code>rake test</code> to communicate the test results back<br /> +to the command-line test server. If <code>rake test</code> is hanging, it is <br /> likely you are not calling <code>clearMocks</code> in your teardown method.</p> - - - <h3>Extra assertions</h3> - - - <p>Your test cases can use the following additional assertions:</p> - - - <ul> +<h3>Extra assertions</h3> +<p>Your test cases can use the following additional assertions:</p> +<ul> <li><code>assertDifference(evalStr, block, count)</code></li> - <li><code>assertNoDifference(evalStr, block)</code> – same as <code>assertDifference(evalStr, block, 0)</code></li> - <li><code>assertTagDifference(tag, block, count)</code></li> - </ul> - - - <p>For example, if you wanted to test that some code created an additional >div< element + <li><code>assertNoDifference(evalStr, block)</code> – same as <code>assertDifference(evalStr, block, 0)</code></li> + <li><code>assertTagDifference(tag, block, count)</code></li> +</ul> +<p>For example, if you wanted to test that some code created an additional >div< element<br /> in the <span class="caps">DOM</span>, then your test might be:</p> - - - <p><pre class='syntax'> +<p><pre class='syntax'> testExtraDiv: function() { with(this) { assertDifference("$$('div').length", function() { // do something that creates new <div> element }, 1, "should not be different"); }}, </pre></p> - - - <p>There is a primitive selector assertion <code>assertTagDifference</code>:</p> - - - <p><pre class='syntax'>assertTagDifference('span', function() { +<p>There is a primitive selector assertion <code>assertTagDifference</code>:<br /> + <br /> +<pre class='syntax'>assertTagDifference('span', function() { var span = document.createElement("span"); Test.$('sample').appendChild(span); }, 1);</pre></p> - - - <h2>Other test helpers</h2> - - - <p>The protolicious source has some helper files, see <a href="http://code.google.com/p/protolicious/source/browse/trunk/">source</a></p> - - - <h2>Forum</h2> - - - <p><a href="http://groups.google.com/group/drnicutilities">http://groups.google.com/group/drnicutilities</a></p> - - - <h2>How to submit patches</h2> - - - <p>Read the <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/">8 steps for fixing other people’s code</a> and for section <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups">8b: Submit patch to Google Groups</a>, use the Google Group above.</p> - - - <p>The source project is a <a href="http://git.or.cz/">Git</a> repository. See Dr Nic’s <a href="http://github.com/drnic/drnic_js_test_helpers/tree/master">master branch</a> for clone/checkout details.</p> - - - <h2>License</h2> - - - <p>This code is free to use under the terms of the <span class="caps">MIT</span> license.</p> - - - <h2>Contact</h2> - - - <p>Comments are welcome. Send an email to <a href="mailto:drnicwilliams@gmail.com">Dr Nic Williams</a> via the <a href="http://groups.google.com/group/drnicutilities">forum</a></p> +<h2>Other test helpers</h2> +<p>The protolicious source has some helper files, see <a href="http://code.google.com/p/protolicious/source/browse/trunk/">source</a></p> +<h2>Forum</h2> +<p><a href="http://groups.google.com/group/drnicutilities">http://groups.google.com/group/drnicutilities</a></p> +<h2>How to submit patches</h2> +<p>Read the <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/">8 steps for fixing other people’s code</a> and for section <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups">8b: Submit patch to Google Groups</a>, use the Google Group above.</p> +<p>The source project is a <a href="http://git.or.cz/">Git</a> repository. See Dr Nic’s <a href="http://github.com/drnic/drnic_js_test_helpers/tree/master">master branch</a> for clone/checkout details.</p> +<h2>License</h2> +<p>This code is free to use under the terms of the <span class="caps">MIT</span> license.</p> +<h2>Contact</h2> +<p>Comments are welcome. Send an email to <a href="mailto:drnicwilliams@gmail.com">Dr Nic Williams</a> via the <a href="http://groups.google.com/group/drnicutilities">forum</a></p> <p class="coda"> - <a href="http://drnicwilliams.com">Dr Nic Williams</a>, 10th April 2008<br> + <a href="http://drnicwilliams.com">Dr Nic Williams</a>, 9th October 2008<br> Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a> </p> </div> website/index.html 93973972cacb3cfa74d3f6747ed885f7f8389c56 Dr Nic Williams drnicwilliams@gmail.com http://github.com/drnic/drnic_js_test_helpers/commit/d2a24bebdebc085a670b4c92289e5bb83bafb264 d2a24bebdebc085a670b4c92289e5bb83bafb264

2008-10-08T21:21:44-07:00

update website with new verison number 4be4783a83cfc94b82048e6066363c995244ec3c Dr Nic Williams drnicwilliams@gmail.com