Skip to content

Commit

Permalink
[skip ci] Update documentation for v2.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
floehopper committed Apr 10, 2024
1 parent 76495e1 commit 5324009
Show file tree
Hide file tree
Showing 52 changed files with 614 additions and 302 deletions.
8 changes: 4 additions & 4 deletions docs/Mocha.html
Expand Up @@ -6,7 +6,7 @@
<title>
Module: Mocha

&mdash; Mocha 2.1.0
&mdash; Mocha 2.2.0

</title>

Expand Down Expand Up @@ -79,7 +79,7 @@
<dl>
<dt>Defined in:</dt>
<dd>lib/mocha/api.rb<span class="defines">,<br />
lib/mocha/hooks.rb,<br /> lib/mocha/mock.rb,<br /> lib/mocha/expectation.rb,<br /> lib/mocha/object_methods.rb,<br /> lib/mocha/class_methods.rb,<br /> lib/mocha/parameter_matchers.rb,<br /> lib/mocha/parameter_matchers/not.rb,<br /> lib/mocha/parameter_matchers/base.rb,<br /> lib/mocha/parameter_matchers/is_a.rb,<br /> lib/mocha/parameter_matchers/all_of.rb,<br /> lib/mocha/parameter_matchers/any_of.rb,<br /> lib/mocha/parameter_matchers/equals.rb,<br /> lib/mocha/parameter_matchers/has_key.rb,<br /> lib/mocha/parameter_matchers/kind_of.rb,<br /> lib/mocha/parameter_matchers/anything.rb,<br /> lib/mocha/parameter_matchers/has_keys.rb,<br /> lib/mocha/parameter_matchers/includes.rb,<br /> lib/mocha/parameter_matchers/has_entry.rb,<br /> lib/mocha/parameter_matchers/has_value.rb,<br /> lib/mocha/parameter_matchers/optionally.rb,<br /> lib/mocha/parameter_matchers/has_entries.rb,<br /> lib/mocha/parameter_matchers/instance_of.rb,<br /> lib/mocha/parameter_matchers/responds_with.rb,<br /> lib/mocha/parameter_matchers/any_parameters.rb,<br /> lib/mocha/parameter_matchers/equivalent_uri.rb,<br /> lib/mocha/parameter_matchers/regexp_matches.rb,<br /> lib/mocha/parameter_matchers/yaml_equivalent.rb,<br /> lib/mocha/parameter_matchers/instance_methods.rb,<br /> lib/mocha/parameter_matchers/positional_or_keyword_hash.rb,<br /> lib/mocha/state_machine.rb,<br /> lib/mocha/sequence.rb,<br /> lib/mocha/configuration.rb,<br /> lib/mocha/expectation_error_factory.rb,<br /> lib/mocha/expectation_error.rb,<br /> lib/mocha/stubbing_error.rb,<br /> lib/mocha/integration/test_unit/adapter.rb,<br /> lib/mocha/integration/mini_test/adapter.rb</span>
lib/mocha/hooks.rb,<br /> lib/mocha/mock.rb,<br /> lib/mocha/expectation.rb,<br /> lib/mocha/object_methods.rb,<br /> lib/mocha/class_methods.rb,<br /> lib/mocha/parameter_matchers.rb,<br /> lib/mocha/parameter_matchers/not.rb,<br /> lib/mocha/parameter_matchers/base.rb,<br /> lib/mocha/parameter_matchers/is_a.rb,<br /> lib/mocha/parameter_matchers/all_of.rb,<br /> lib/mocha/parameter_matchers/any_of.rb,<br /> lib/mocha/parameter_matchers/equals.rb,<br /> lib/mocha/parameter_matchers/has_key.rb,<br /> lib/mocha/parameter_matchers/kind_of.rb,<br /> lib/mocha/parameter_matchers/anything.rb,<br /> lib/mocha/parameter_matchers/has_keys.rb,<br /> lib/mocha/parameter_matchers/includes.rb,<br /> lib/mocha/parameter_matchers/has_entry.rb,<br /> lib/mocha/parameter_matchers/has_value.rb,<br /> lib/mocha/parameter_matchers/optionally.rb,<br /> lib/mocha/parameter_matchers/has_entries.rb,<br /> lib/mocha/parameter_matchers/instance_of.rb,<br /> lib/mocha/parameter_matchers/responds_with.rb,<br /> lib/mocha/parameter_matchers/any_parameters.rb,<br /> lib/mocha/parameter_matchers/equivalent_uri.rb,<br /> lib/mocha/parameter_matchers/regexp_matches.rb,<br /> lib/mocha/parameter_matchers/yaml_equivalent.rb,<br /> lib/mocha/parameter_matchers/instance_methods.rb,<br /> lib/mocha/parameter_matchers/positional_or_keyword_hash.rb,<br /> lib/mocha/state_machine.rb,<br /> lib/mocha/sequence.rb,<br /> lib/mocha/configuration.rb,<br /> lib/mocha/expectation_error_factory.rb,<br /> lib/mocha/expectation_error.rb,<br /> lib/mocha/stubbing_error.rb,<br /> lib/mocha/integration/test_unit/adapter.rb,<br /> lib/mocha/integration/minitest/adapter.rb</span>
</dd>
</dl>

Expand Down Expand Up @@ -236,9 +236,9 @@ <h3 class="signature first" id="configure-class_method">
</div>

<div id="footer">
Generated on Sat Nov 11 14:17:31 2023 by
Generated on Wed Apr 10 09:23:15 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.2.0).
0.9.36 (ruby-3.2.0).
</div>

</div>
Expand Down
126 changes: 105 additions & 21 deletions docs/Mocha/API.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/Mocha/ClassMethods.html
Expand Up @@ -6,7 +6,7 @@
<title>
Module: Mocha::ClassMethods

&mdash; Mocha 2.1.0
&mdash; Mocha 2.2.0

</title>

Expand Down Expand Up @@ -246,9 +246,9 @@ <h3 class="signature first" id="any_instance-instance_method">
</div>

<div id="footer">
Generated on Sat Nov 11 14:17:31 2023 by
Generated on Wed Apr 10 09:23:15 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.2.0).
0.9.36 (ruby-3.2.0).
</div>

</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/Mocha/Configuration.html
Expand Up @@ -6,7 +6,7 @@
<title>
Class: Mocha::Configuration

&mdash; Mocha 2.1.0
&mdash; Mocha 2.2.0

</title>

Expand Down Expand Up @@ -1085,9 +1085,9 @@ <h3 class="signature " id="stubbing_non_public_method=-instance_method">
</div>

<div id="footer">
Generated on Sat Nov 11 14:17:31 2023 by
Generated on Wed Apr 10 09:23:16 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.2.0).
0.9.36 (ruby-3.2.0).
</div>

</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/Mocha/Expectation.html
Expand Up @@ -6,7 +6,7 @@
<title>
Class: Mocha::Expectation

&mdash; Mocha 2.1.0
&mdash; Mocha 2.2.0

</title>

Expand Down Expand Up @@ -2903,9 +2903,9 @@ <h3 class="signature " id="yields-instance_method">
</div>

<div id="footer">
Generated on Sat Nov 11 14:17:31 2023 by
Generated on Wed Apr 10 09:23:15 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.2.0).
0.9.36 (ruby-3.2.0).
</div>

</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/Mocha/ExpectationError.html
Expand Up @@ -6,7 +6,7 @@
<title>
Exception: Mocha::ExpectationError

&mdash; Mocha 2.1.0
&mdash; Mocha 2.2.0

</title>

Expand Down Expand Up @@ -134,9 +134,9 @@ <h2>Overview</h2><div class="docstring">
</div>

<div id="footer">
Generated on Sat Nov 11 14:17:32 2023 by
Generated on Wed Apr 10 09:23:16 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.2.0).
0.9.36 (ruby-3.2.0).
</div>

</div>
Expand Down
10 changes: 5 additions & 5 deletions docs/Mocha/ExpectationErrorFactory.html
Expand Up @@ -6,7 +6,7 @@
<title>
Class: Mocha::ExpectationErrorFactory

&mdash; Mocha 2.1.0
&mdash; Mocha 2.2.0

</title>

Expand Down Expand Up @@ -106,7 +106,7 @@ <h2>Overview</h2><div class="docstring">

<p>This class should only be used by authors of test libraries and not by typical “users” of Mocha.</p>

<p>For example, it is used by <code>Mocha::Integration::MiniTest::Adapter</code> in order to have Mocha raise a <code>MiniTest::Assertion</code> which can then be sensibly handled by <code>MiniTest::Unit::TestCase</code>.</p>
<p>For example, it is used by <code>Mocha::Integration::Minitest::Adapter</code> in order to have Mocha raise a <code>Minitest::Assertion</code> which can then be sensibly handled by <code>Minitest::Unit::TestCase</code>.</p>


</div>
Expand All @@ -117,7 +117,7 @@ <h2>Overview</h2><div class="docstring">
<p class="tag_title">See Also:</p>
<ul class="see">

<li><span class='object_link'><a href="Integration/MiniTest/Adapter.html" title="Mocha::Integration::MiniTest::Adapter (module)">Integration::MiniTest::Adapter</a></span></li>
<li><span class='object_link'><a href="Integration/Minitest/Adapter.html" title="Mocha::Integration::Minitest::Adapter (module)">Integration::Minitest::Adapter</a></span></li>

</ul>

Expand Down Expand Up @@ -242,9 +242,9 @@ <h3 class="signature first" id="exception_class-class_method">
</div>

<div id="footer">
Generated on Sat Nov 11 14:17:31 2023 by
Generated on Wed Apr 10 09:23:16 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.2.0).
0.9.36 (ruby-3.2.0).
</div>

</div>
Expand Down
83 changes: 74 additions & 9 deletions docs/Mocha/Hooks.html
Expand Up @@ -6,7 +6,7 @@
<title>
Module: Mocha::Hooks

&mdash; Mocha 2.1.0
&mdash; Mocha 2.2.0

</title>

Expand Down Expand Up @@ -97,7 +97,7 @@ <h2>Overview</h2><div class="docstring">

<p>This module is provided as part of the <code>Mocha::API</code> module and is therefore part of the public API, but should only be used by authors of test libraries and not by typical “users” of Mocha.</p>

<p>Integration with Test::Unit and MiniTest are provided as part of Mocha, because they are (or were once) part of the Ruby standard library. Integration with other test libraries is not provided as <strong>part</strong> of Mocha, but is supported by means of the methods in this module.</p>
<p>Integration with Test::Unit and Minitest are provided as part of Mocha, because they are (or were once) part of the Ruby standard library. Integration with other test libraries is not provided as <strong>part</strong> of Mocha, but is supported by means of the methods in this module.</p>

<p>See the code in the <code>Adapter</code> modules for examples of how to use the methods in this module. <code>Mocha::ExpectationErrorFactory</code> may be used if you want <code>Mocha</code> to raise a different type of exception.</p>

Expand All @@ -112,7 +112,7 @@ <h2>Overview</h2><div class="docstring">

<li><span class='object_link'><a href="Integration/TestUnit/Adapter.html" title="Mocha::Integration::TestUnit::Adapter (module)">Integration::TestUnit::Adapter</a></span></li>

<li><span class='object_link'><a href="Integration/MiniTest/Adapter.html" title="Mocha::Integration::MiniTest::Adapter (module)">Integration::MiniTest::Adapter</a></span></li>
<li><span class='object_link'><a href="Integration/Minitest/Adapter.html" title="Mocha::Integration::Minitest::Adapter (module)">Integration::Minitest::Adapter</a></span></li>

<li><span class='object_link'><a href="ExpectationErrorFactory.html" title="Mocha::ExpectationErrorFactory (class)">ExpectationErrorFactory</a></span></li>

Expand Down Expand Up @@ -162,7 +162,7 @@ <h2>
<li class="public ">
<span class="summary_signature">

<a href="#mocha_teardown-instance_method" title="#mocha_teardown (instance method)">#<strong>mocha_teardown</strong> &#x21d2; Object </a>
<a href="#mocha_teardown-instance_method" title="#mocha_teardown (instance method)">#<strong>mocha_teardown</strong>(origin = mocha_test_name) &#x21d2; Object </a>



Expand All @@ -180,6 +180,30 @@ <h2>
<p>Resets Mocha after a test (only for use by authors of test libraries).</p>
</div></span>

</li>


<li class="public ">
<span class="summary_signature">

<a href="#mocha_test_name-instance_method" title="#mocha_test_name (instance method)">#<strong>mocha_test_name</strong> &#x21d2; Object </a>



</span>









<span class="summary_desc"><div class='inline'>
<p>Returns a string representing the unit test name, to be included in some Mocha to help track down potential bugs.</p>
</div></span>

</li>


Expand Down Expand Up @@ -262,7 +286,7 @@ <h3 class="signature first" id="mocha_setup-instance_method">
<div class="method_details ">
<h3 class="signature " id="mocha_teardown-instance_method">

#<strong>mocha_teardown</strong> &#x21d2; <tt><span class='object_link'>Object</span></tt>
#<strong>mocha_teardown</strong>(origin = mocha_test_name) &#x21d2; <tt><span class='object_link'>Object</span></tt>



Expand Down Expand Up @@ -294,8 +318,49 @@ <h3 class="signature " id="mocha_teardown-instance_method">
<td>
<pre class="code"><span class="info file"># File 'lib/mocha/hooks.rb', line 38</span>

<span class='kw'>def</span> <span class='id identifier rubyid_mocha_teardown'>mocha_teardown</span>
<span class='const'>Mockery</span><span class='period'>.</span><span class='id identifier rubyid_teardown'>teardown</span>
<span class='kw'>def</span> <span class='id identifier rubyid_mocha_teardown'>mocha_teardown</span><span class='lparen'>(</span><span class='id identifier rubyid_origin'>origin</span> <span class='op'>=</span> <span class='id identifier rubyid_mocha_test_name'>mocha_test_name</span><span class='rparen'>)</span>
<span class='const'>Mockery</span><span class='period'>.</span><span class='id identifier rubyid_teardown'>teardown</span><span class='lparen'>(</span><span class='id identifier rubyid_origin'>origin</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>

<div class="method_details ">
<h3 class="signature " id="mocha_test_name-instance_method">

#<strong>mocha_test_name</strong> &#x21d2; <tt><span class='object_link'>Object</span></tt>





</h3><div class="docstring">
<div class="discussion">

<p>Returns a string representing the unit test name, to be included in some Mocha to help track down potential bugs.</p>


</div>
</div>
<div class="tags">


</div><table class="source_code">
<tr>
<td>
<pre class="lines">


44
45
46</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/mocha/hooks.rb', line 44</span>

<span class='kw'>def</span> <span class='id identifier rubyid_mocha_test_name'>mocha_test_name</span>
<span class='kw'>nil</span>
<span class='kw'>end</span></pre>
</td>
</tr>
Expand Down Expand Up @@ -352,9 +417,9 @@ <h3 class="signature " id="mocha_verify-instance_method">
</div>

<div id="footer">
Generated on Sat Nov 11 14:17:31 2023 by
Generated on Wed Apr 10 09:23:15 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.2.0).
0.9.36 (ruby-3.2.0).
</div>

</div>
Expand Down
10 changes: 5 additions & 5 deletions docs/Mocha/Integration.html
Expand Up @@ -6,7 +6,7 @@
<title>
Module: Mocha::Integration

&mdash; Mocha 2.1.0
&mdash; Mocha 2.2.0

</title>

Expand Down Expand Up @@ -79,7 +79,7 @@
<dl>
<dt>Defined in:</dt>
<dd>lib/mocha/integration/test_unit/adapter.rb<span class="defines">,<br />
lib/mocha/integration/mini_test/adapter.rb</span>
lib/mocha/integration/minitest/adapter.rb</span>
</dd>
</dl>

Expand All @@ -89,7 +89,7 @@ <h2>Defined Under Namespace</h2>
<p class="children">


<strong class="modules">Modules:</strong> <span class='object_link'><a href="Integration/MiniTest.html" title="Mocha::Integration::MiniTest (module)">MiniTest</a></span>, <span class='object_link'><a href="Integration/TestUnit.html" title="Mocha::Integration::TestUnit (module)">TestUnit</a></span>
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Integration/Minitest.html" title="Mocha::Integration::Minitest (module)">Minitest</a></span>, <span class='object_link'><a href="Integration/TestUnit.html" title="Mocha::Integration::TestUnit (module)">TestUnit</a></span>



Expand All @@ -107,9 +107,9 @@ <h2>Defined Under Namespace</h2>
</div>

<div id="footer">
Generated on Sat Nov 11 14:17:31 2023 by
Generated on Wed Apr 10 09:23:15 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.2.0).
0.9.36 (ruby-3.2.0).
</div>

</div>
Expand Down

0 comments on commit 5324009

Please sign in to comment.