[skip ci] Update documentation for v2.7.0

freerange · Dec 7, 2024 · f2e8ab1 · f2e8ab1
1 parent 8faedac
commit f2e8ab1
Show file tree

Hide file tree

Showing 50 changed files with 160 additions and 130 deletions.
diff --git a/docs/Mocha.html b/docs/Mocha.html
@@ -6,7 +6,7 @@
 <title>
   Module: Mocha
 
-    &mdash; Mocha 2.6.1
+    &mdash; Mocha 2.7.0
 
 </title>
 
@@ -236,7 +236,7 @@ <h5 class="example_title"><div class='inline'>
 </div>
 
       <div id="footer">
-  Generated on Thu Nov 28 14:57:34 2024 by
+  Generated on Sat Dec  7 12:49:09 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.3.6).
 </div>

diff --git a/docs/Mocha/API.html b/docs/Mocha/API.html
@@ -6,7 +6,7 @@
 <title>
   Module: Mocha::API
 
-    &mdash; Mocha 2.6.1
+    &mdash; Mocha 2.7.0
 
 </title>
 
@@ -1247,7 +1247,7 @@ <h5 class="example_title"><div class='inline'>
 </div>
 
       <div id="footer">
-  Generated on Thu Nov 28 14:57:34 2024 by
+  Generated on Sat Dec  7 12:49:10 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.3.6).
 </div>

diff --git a/docs/Mocha/ClassMethods.html b/docs/Mocha/ClassMethods.html
@@ -6,7 +6,7 @@
 <title>
   Module: Mocha::ClassMethods
 
-    &mdash; Mocha 2.6.1
+    &mdash; Mocha 2.7.0
 
 </title>
 
@@ -246,7 +246,7 @@ <h5 class="example_title"><div class='inline'>
 </div>
 
       <div id="footer">
-  Generated on Thu Nov 28 14:57:34 2024 by
+  Generated on Sat Dec  7 12:49:10 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.3.6).
 </div>

diff --git a/docs/Mocha/Configuration.html b/docs/Mocha/Configuration.html
@@ -6,7 +6,7 @@
 <title>
   Class: Mocha::Configuration
 
-    &mdash; Mocha 2.6.1
+    &mdash; Mocha 2.7.0
 
 </title>
 
@@ -1085,7 +1085,7 @@ <h5 class="example_title"><div class='inline'>
 </div>
 
       <div id="footer">
-  Generated on Thu Nov 28 14:57:34 2024 by
+  Generated on Sat Dec  7 12:49:10 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.3.6).
 </div>

diff --git a/docs/Mocha/Expectation.html b/docs/Mocha/Expectation.html
@@ -6,7 +6,7 @@
 <title>
   Class: Mocha::Expectation
 
-    &mdash; Mocha 2.6.1
+    &mdash; Mocha 2.7.0
 
 </title>
 
@@ -2903,7 +2903,7 @@ <h5 class="example_title"><div class='inline'>
 </div>
 
       <div id="footer">
-  Generated on Thu Nov 28 14:57:34 2024 by
+  Generated on Sat Dec  7 12:49:10 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.3.6).
 </div>

diff --git a/docs/Mocha/ExpectationError.html b/docs/Mocha/ExpectationError.html
@@ -6,7 +6,7 @@
 <title>
   Exception: Mocha::ExpectationError
 
-    &mdash; Mocha 2.6.1
+    &mdash; Mocha 2.7.0
 
 </title>
 
@@ -134,7 +134,7 @@ <h2>Overview</h2><div class="docstring">
 </div>
 
       <div id="footer">
-  Generated on Thu Nov 28 14:57:34 2024 by
+  Generated on Sat Dec  7 12:49:10 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.3.6).
 </div>

diff --git a/docs/Mocha/ExpectationErrorFactory.html b/docs/Mocha/ExpectationErrorFactory.html
@@ -6,7 +6,7 @@
 <title>
   Class: Mocha::ExpectationErrorFactory
 
-    &mdash; Mocha 2.6.1
+    &mdash; Mocha 2.7.0
 
 </title>
 
@@ -242,7 +242,7 @@ <h3 class="signature first" id="exception_class-class_method">
 </div>
 
       <div id="footer">
-  Generated on Thu Nov 28 14:57:34 2024 by
+  Generated on Sat Dec  7 12:49:10 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.3.6).
 </div>

diff --git a/docs/Mocha/Hooks.html b/docs/Mocha/Hooks.html
@@ -6,7 +6,7 @@
 <title>
   Module: Mocha::Hooks
 
-    &mdash; Mocha 2.6.1
+    &mdash; Mocha 2.7.0
 
 </title>
 
@@ -417,7 +417,7 @@ <h3 class="signature " id="mocha_verify-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Thu Nov 28 14:57:34 2024 by
+  Generated on Sat Dec  7 12:49:10 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.3.6).
 </div>

diff --git a/docs/Mocha/Integration.html b/docs/Mocha/Integration.html
@@ -6,7 +6,7 @@
 <title>
   Module: Mocha::Integration
 
-    &mdash; Mocha 2.6.1
+    &mdash; Mocha 2.7.0
 
 </title>
 
@@ -107,7 +107,7 @@ <h2>Defined Under Namespace</h2>
 </div>
 
       <div id="footer">
-  Generated on Thu Nov 28 14:57:34 2024 by
+  Generated on Sat Dec  7 12:49:10 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.3.6).
 </div>

diff --git a/docs/Mocha/Integration/MiniTest.html b/docs/Mocha/Integration/MiniTest.html
@@ -6,7 +6,7 @@
 <title>
   Module: Mocha::Integration::Minitest
 
-    &mdash; Mocha 2.6.1
+    &mdash; Mocha 2.7.0
 
 </title>
 
@@ -105,7 +105,7 @@ <h2>Defined Under Namespace</h2>
 </div>
 
       <div id="footer">
-  Generated on Thu Nov 28 14:57:34 2024 by
+  Generated on Sat Dec  7 12:49:10 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.3.6).
 </div>

diff --git a/docs/Mocha/Integration/MiniTest/Adapter.html b/docs/Mocha/Integration/MiniTest/Adapter.html
@@ -6,7 +6,7 @@
 <title>
   Module: Mocha::Integration::Minitest::Adapter
 
-    &mdash; Mocha 2.6.1
+    &mdash; Mocha 2.7.0
 
 </title>
 
@@ -146,7 +146,7 @@ <h3 class="inherited">Methods included from <span class='object_link'><a href=".
 </div>
 
       <div id="footer">
-  Generated on Thu Nov 28 14:57:34 2024 by
+  Generated on Sat Dec  7 12:49:10 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.3.6).
 </div>

diff --git a/docs/Mocha/Integration/TestUnit.html b/docs/Mocha/Integration/TestUnit.html
@@ -6,7 +6,7 @@
 <title>
   Module: Mocha::Integration::TestUnit
 
-    &mdash; Mocha 2.6.1
+    &mdash; Mocha 2.7.0
 
 </title>
 
@@ -105,7 +105,7 @@ <h2>Defined Under Namespace</h2>
 </div>
 
       <div id="footer">
-  Generated on Thu Nov 28 14:57:34 2024 by
+  Generated on Sat Dec  7 12:49:10 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.3.6).
 </div>

diff --git a/docs/Mocha/Integration/TestUnit/Adapter.html b/docs/Mocha/Integration/TestUnit/Adapter.html
@@ -6,7 +6,7 @@
 <title>
   Module: Mocha::Integration::TestUnit::Adapter
 
-    &mdash; Mocha 2.6.1
+    &mdash; Mocha 2.7.0
 
 </title>
 
@@ -146,7 +146,7 @@ <h3 class="inherited">Methods included from <span class='object_link'><a href=".
 </div>
 
       <div id="footer">
-  Generated on Thu Nov 28 14:57:34 2024 by
+  Generated on Sat Dec  7 12:49:10 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.3.6).
 </div>

diff --git a/docs/Mocha/Mock.html b/docs/Mocha/Mock.html
@@ -6,7 +6,7 @@
 <title>
   Class: Mocha::Mock
 
-    &mdash; Mocha 2.6.1
+    &mdash; Mocha 2.7.0
 
 </title>
 
@@ -112,6 +112,8 @@ <h2>Overview</h2><div class="docstring">
 
 <p>When a method is invoked on a mock object, the mock object searches through its expectations from newest to oldest to find one that matches the invocation. After the invocation, the matching expectation might stop matching further invocations. For example, an <tt>expects(:foo).once</tt> expectation only matches once and will be ignored on future invocations while an <tt>expects(:foo).at_least_once</tt> expectation will always be matched against invocations.</p>
 
+<p>However, note that if the expectation that matches the invocation has a cardinality of “never”, then an unexpected invocation error is reported.</p>
+
 <p>This scheme allows you to:</p>
 <ul><li>
 <p>Set up default stubs in your the <code>setup</code> method of your test class and override some of those stubs in individual tests.</p>
@@ -318,12 +320,12 @@ <h3 class="signature first" id="method_missing-instance_method">
       <pre class="lines">
 
 
-315
-316
-317</pre>
+318
+319
+320</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/mocha/mock.rb', line 315</span>
+      <pre class="code"><span class="info file"># File 'lib/mocha/mock.rb', line 318</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_method_missing'>method_missing</span><span class='lparen'>(</span><span class='id identifier rubyid_symbol'>symbol</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_arguments'>arguments</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span> <span class='comment'># rubocop:disable Style/MethodMissingSuper
 </span>  <span class='id identifier rubyid_handle_method_call'>handle_method_call</span><span class='lparen'>(</span><span class='id identifier rubyid_symbol'>symbol</span><span class='comma'>,</span> <span class='id identifier rubyid_arguments'>arguments</span><span class='comma'>,</span> <span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
@@ -514,9 +516,6 @@ <h5 class="example_title"><div class='inline'>
       <pre class="lines">
 
 
-111
-112
-113
 114
 115
 116
@@ -526,10 +525,13 @@ <h5 class="example_title"><div class='inline'>
 120
 121
 122
-123</pre>
+123
+124
+125
+126</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/mocha/mock.rb', line 111</span>
+      <pre class="code"><span class="info file"># File 'lib/mocha/mock.rb', line 114</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_expects'>expects</span><span class='lparen'>(</span><span class='id identifier rubyid_method_name_or_hash'>method_name_or_hash</span><span class='comma'>,</span> <span class='id identifier rubyid_backtrace'>backtrace</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_expectation'>expectation</span> <span class='op'>=</span> <span class='kw'>nil</span>
@@ -685,13 +687,13 @@ <h5 class="example_title"><div class='inline'>
       <pre class="lines">
 
 
-238
-239
-240
-241</pre>
+241
+242
+243
+244</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/mocha/mock.rb', line 238</span>
+      <pre class="code"><span class="info file"># File 'lib/mocha/mock.rb', line 241</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_responds_like'>responds_like</span><span class='lparen'>(</span><span class='id identifier rubyid_responder'>responder</span><span class='rparen'>)</span>
   <span class='ivar'>@responder</span> <span class='op'>=</span> <span class='id identifier rubyid_responder'>responder</span>
@@ -809,12 +811,12 @@ <h5 class="example_title"><div class='inline'>
       <pre class="lines">
 
 
-271
-272
-273</pre>
+274
+275
+276</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/mocha/mock.rb', line 271</span>
+      <pre class="code"><span class="info file"># File 'lib/mocha/mock.rb', line 274</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_responds_like_instance_of'>responds_like_instance_of</span><span class='lparen'>(</span><span class='id identifier rubyid_responder_class'>responder_class</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_responds_like'>responds_like</span><span class='lparen'>(</span><span class='id identifier rubyid_responder_class'>responder_class</span><span class='period'>.</span><span class='id identifier rubyid_allocate'>allocate</span><span class='rparen'>)</span>
@@ -981,9 +983,6 @@ <h5 class="example_title"><div class='inline'>
       <pre class="lines">
 
 
-150
-151
-152
 153
 154
 155
@@ -994,10 +993,13 @@ <h5 class="example_title"><div class='inline'>
 160
 161
 162
-163</pre>
+163
+164
+165
+166</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/mocha/mock.rb', line 150</span>
+      <pre class="code"><span class="info file"># File 'lib/mocha/mock.rb', line 153</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_stubs'>stubs</span><span class='lparen'>(</span><span class='id identifier rubyid_method_name_or_hash'>method_name_or_hash</span><span class='comma'>,</span> <span class='id identifier rubyid_backtrace'>backtrace</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_expectation'>expectation</span> <span class='op'>=</span> <span class='kw'>nil</span>
@@ -1092,14 +1094,14 @@ <h5 class="example_title"><div class='inline'>
       <pre class="lines">
 
 
-183
-184
-185
 186
-187</pre>
+187
+188
+189
+190</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/mocha/mock.rb', line 183</span>
+      <pre class="code"><span class="info file"># File 'lib/mocha/mock.rb', line 186</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_unstub'>unstub</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_method_names'>method_names</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_method_names'>method_names</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_method_name'>method_name</span><span class='op'>|</span>
@@ -1116,7 +1118,7 @@ <h5 class="example_title"><div class='inline'>
 </div>
 
       <div id="footer">
-  Generated on Thu Nov 28 14:57:34 2024 by
+  Generated on Sat Dec  7 12:49:10 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.3.6).
 </div>