mocha 1.8.0 → 1.9.0

data/docs/Mocha/StubbingError.html

@@ -6,7 +6,7 @@
 <title>
   Class: Mocha::StubbingError
   
-    &mdash; Mocha 1.8.0
+    &mdash; Mocha 1.9.0
   
 </title>
 
@@ -140,9 +140,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Jan 15 17:13:06 2019 by
+  Generated on Mon Jun 17 18:38:45 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.16 (ruby-2.5.3).
+  0.9.19 (ruby-2.5.3).
 </div>
 
     </div>

data/docs/Mocha/UnexpectedInvocation.html

@@ -6,7 +6,7 @@
 <title>
   Class: Mocha::UnexpectedInvocation
   
-    &mdash; Mocha 1.8.0
+    &mdash; Mocha 1.9.0
   
 </title>
 
@@ -130,9 +130,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Jan 15 17:13:06 2019 by
+  Generated on Mon Jun 17 18:38:45 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.16 (ruby-2.5.3).
+  0.9.19 (ruby-2.5.3).
 </div>
 
     </div>

data/docs/_index.html

@@ -4,7 +4,7 @@
     <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <title>
-  Mocha 1.8.0
+  Mocha 1.9.0
   
 </title>
 
@@ -52,7 +52,7 @@
         <div class="clear"></div>
       </div>
 
-      <div id="content"><h1 class="noborder title">Mocha 1.8.0</h1>
+      <div id="content"><h1 class="noborder title">Mocha 1.9.0</h1>
 <div id="listing">
   <h1 class="alphaindex">Alphabetic Index</h1>
   
@@ -527,9 +527,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Jan 15 17:13:05 2019 by
+  Generated on Mon Jun 17 18:38:42 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.16 (ruby-2.5.3).
+  0.9.19 (ruby-2.5.3).
 </div>
 
     </div>

data/docs/file.COPYING.html

@@ -6,7 +6,7 @@
 <title>
   File: COPYING
   
-    &mdash; Mocha 1.8.0
+    &mdash; Mocha 1.9.0
   
 </title>
 
@@ -71,9 +71,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Jan 15 17:13:05 2019 by
+  Generated on Mon Jun 17 18:38:43 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.16 (ruby-2.5.3).
+  0.9.19 (ruby-2.5.3).
 </div>
 
     </div>

data/docs/file.MIT-LICENSE.html

@@ -6,7 +6,7 @@
 <title>
   File: MIT-LICENSE
   
-    &mdash; Mocha 1.8.0
+    &mdash; Mocha 1.9.0
   
 </title>
 
@@ -75,9 +75,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Jan 15 17:13:05 2019 by
+  Generated on Mon Jun 17 18:38:43 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.16 (ruby-2.5.3).
+  0.9.19 (ruby-2.5.3).
 </div>
 
     </div>

data/docs/file.README.html

@@ -6,7 +6,7 @@
 <title>
   File: README
   
-    &mdash; Mocha 1.8.0
+    &mdash; Mocha 1.9.0
   
 </title>
 
@@ -310,7 +310,15 @@
 
 <h3>Thread safety</h3>
 
-<p>Mocha is currently <em>not</em> thread-safe. There are two main reasons for this: (a) in multi-threaded code Mocha exceptions may be raised in a thread other than the one which is running the test and thus a Mocha exception may not be correctly intercepted by Mocha exception handling code; and (b) partial mocking changes the state of objects in the <code>ObjectSpace</code> which is shared across all threads in the Ruby process and this access to what is effectively global state is not synchronized.</p>
+<p>Mocha currently <em>does not</em> attempt to be thread-safe.</p>
+
+<h4>Can I test multi-threaded code with Mocha?</h4>
+
+<p>The short answer is no. In multi-threaded code Mocha exceptions may be raised in a thread other than the one which is running the test and thus a Mocha exception may not be correctly intercepted by Mocha exception handling code.</p>
+
+<h4>Can I run my tests across multiple threads?</h4>
+
+<p>Maybe, but probably not. Partial mocking changes the state of objects in the <code>ObjectSpace</code> which is shared across all threads in the Ruby process and this access to what is effectively global state is not synchronized. So, for example, if two tests are running concurrently and one uses <code>#any_instance</code> to modify a class, both tests will see those changes immediately.</p>
 
 <h3>Expectation matching / invocation order</h3>
 
@@ -359,13 +367,13 @@
 <li>Commit &amp; push to GitHub</li>
 <li><p>Check Travis CI build is passing - <a href="https://travis-ci.org/freerange/mocha">https://travis-ci.org/freerange/mocha</a></p></li>
 <li><p>Sign in to Google Analytics - <a href="https://analytics.google.com/analytics/web/">https://analytics.google.com/analytics/web/</a></p></li>
-<li><p>Find the web property ID for Go Free Range Ltd &gt; Mocha Documentation (UA-45002715-2)</p></li>
+<li><p>Find the web property ID for Go Free Range Ltd &gt; Mocha Documentation (UA-625523-7)</p></li>
 <li><p>Generate documentation:</p></li>
 </ul>
 
 <pre class="code bash"><code class="bash">$ MOCHA_GENERATE_DOCS=true bundle install
 
-$ MOCHA_GENERATE_DOCS=true GOOGLE_ANALYTICS_WEB_PROPERTY_ID=UA-45002715-2 rake generate_docs
+$ MOCHA_GENERATE_DOCS=true GOOGLE_ANALYTICS_WEB_PROPERTY_ID=UA-625523-7 rake generate_docs
 </code></pre>
 
 <ul>
@@ -408,9 +416,9 @@ Pushed mocha 1.2.0 to rubygems.org.
 </div>
 
       <div id="footer">
-  Generated on Tue Jan 15 17:13:05 2019 by
+  Generated on Mon Jun 17 18:38:43 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.16 (ruby-2.5.3).
+  0.9.19 (ruby-2.5.3).
 </div>
 
     </div>

data/docs/file.RELEASE.html

@@ -6,7 +6,7 @@
 <title>
   File: RELEASE
   
-    &mdash; Mocha 1.8.0
+    &mdash; Mocha 1.9.0
   
 </title>
 
@@ -59,6 +59,18 @@
 
       <div id="content"><div id='filecontents'><h1>Release Notes</h1>
 
+<h2>1.9.0</h2>
+
+<ul>
+<li>Add TruffleRuby to Travis CI build matrix - thanks to @deepj (#354)</li>
+<li>Explicitly set Travis CI OS to Ubuntu Trusty 14.04 (ded1fa45)</li>
+<li>Expand explanation of thread-safety concerns - thanks to @techbelly (#357)</li>
+<li>Refactor class method and any instance method - thanks to @chrisroos (#358)</li>
+<li>Rely on default bundler version in Travis CI builds (3352e9c5)</li>
+<li>Fix local build-matrix script (11abe231)</li>
+<li>No need to install latest bundler in build-matrix script (8247a894)</li>
+</ul>
+
 <h2>1.8.0</h2>
 
 <ul>
@@ -865,9 +877,9 @@ Hash with wrong number of entries.
 </div>
 
       <div id="footer">
-  Generated on Tue Jan 15 17:13:05 2019 by
+  Generated on Mon Jun 17 18:38:43 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.16 (ruby-2.5.3).
+  0.9.19 (ruby-2.5.3).
 </div>
 
     </div>

data/docs/frames.html

@@ -2,7 +2,7 @@
 <html>
 <head>
   <meta charset="utf-8">
-	<title>Mocha 1.8.0</title>
+	<title>Mocha 1.9.0</title>
 </head>
 <script type="text/javascript" charset="utf-8">
   var match = unescape(window.location.hash).match(/^#!(.+)/);

data/docs/index.html

@@ -6,7 +6,7 @@
 <title>
   File: README
   
-    &mdash; Mocha 1.8.0
+    &mdash; Mocha 1.9.0
   
 </title>
 
@@ -310,7 +310,15 @@
 
 <h3>Thread safety</h3>
 
-<p>Mocha is currently <em>not</em> thread-safe. There are two main reasons for this: (a) in multi-threaded code Mocha exceptions may be raised in a thread other than the one which is running the test and thus a Mocha exception may not be correctly intercepted by Mocha exception handling code; and (b) partial mocking changes the state of objects in the <code>ObjectSpace</code> which is shared across all threads in the Ruby process and this access to what is effectively global state is not synchronized.</p>
+<p>Mocha currently <em>does not</em> attempt to be thread-safe.</p>
+
+<h4>Can I test multi-threaded code with Mocha?</h4>
+
+<p>The short answer is no. In multi-threaded code Mocha exceptions may be raised in a thread other than the one which is running the test and thus a Mocha exception may not be correctly intercepted by Mocha exception handling code.</p>
+
+<h4>Can I run my tests across multiple threads?</h4>
+
+<p>Maybe, but probably not. Partial mocking changes the state of objects in the <code>ObjectSpace</code> which is shared across all threads in the Ruby process and this access to what is effectively global state is not synchronized. So, for example, if two tests are running concurrently and one uses <code>#any_instance</code> to modify a class, both tests will see those changes immediately.</p>
 
 <h3>Expectation matching / invocation order</h3>
 
@@ -359,13 +367,13 @@
 <li>Commit &amp; push to GitHub</li>
 <li><p>Check Travis CI build is passing - <a href="https://travis-ci.org/freerange/mocha">https://travis-ci.org/freerange/mocha</a></p></li>
 <li><p>Sign in to Google Analytics - <a href="https://analytics.google.com/analytics/web/">https://analytics.google.com/analytics/web/</a></p></li>
-<li><p>Find the web property ID for Go Free Range Ltd &gt; Mocha Documentation (UA-45002715-2)</p></li>
+<li><p>Find the web property ID for Go Free Range Ltd &gt; Mocha Documentation (UA-625523-7)</p></li>
 <li><p>Generate documentation:</p></li>
 </ul>
 
 <pre class="code bash"><code class="bash">$ MOCHA_GENERATE_DOCS=true bundle install
 
-$ MOCHA_GENERATE_DOCS=true GOOGLE_ANALYTICS_WEB_PROPERTY_ID=UA-45002715-2 rake generate_docs
+$ MOCHA_GENERATE_DOCS=true GOOGLE_ANALYTICS_WEB_PROPERTY_ID=UA-625523-7 rake generate_docs
 </code></pre>
 
 <ul>
@@ -408,9 +416,9 @@ Pushed mocha 1.2.0 to rubygems.org.
 </div>
 
       <div id="footer">
-  Generated on Tue Jan 15 17:13:05 2019 by
+  Generated on Mon Jun 17 18:38:42 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.16 (ruby-2.5.3).
+  0.9.19 (ruby-2.5.3).
 </div>
 
     </div>

data/docs/js/app.js

@@ -275,6 +275,16 @@ function mainFocus() {
   setTimeout(function() { $('#main').focus(); }, 10);
 }
 
+function navigationChange() {
+  // This works around the broken anchor navigation with the YARD template.
+  window.onpopstate = function() {
+    var hash = window.location.hash;
+    if (hash !== '' && $(hash)[0]) {
+      $(hash)[0].scrollIntoView();
+    }
+  };
+}
+
 $(document).ready(function() {
   navResizer();
   navExpander();
@@ -287,6 +297,7 @@ $(document).ready(function() {
   constantSummaryToggle();
   generateTOC();
   mainFocus();
+  navigationChange();
 });
 
 })();

data/docs/top-level-namespace.html

@@ -6,7 +6,7 @@
 <title>
   Top Level Namespace
   
-    &mdash; Mocha 1.8.0
+    &mdash; Mocha 1.9.0
   
 </title>
 
@@ -108,9 +108,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Jan 15 17:13:05 2019 by
+  Generated on Mon Jun 17 18:38:43 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.16 (ruby-2.5.3).
+  0.9.19 (ruby-2.5.3).
 </div>
 
     </div>

data/lib/mocha/any_instance_method.rb

@@ -11,56 +11,30 @@ module Mocha
       stubbee.any_instance.reset_mocha
     end
 
-    def hide_original_method
-      return unless (@original_visibility = method_visibility(method))
-      begin
-        if RUBY_V2_PLUS
-          @definition_target = PrependedModule.new
-          stubbee.__send__ :prepend, @definition_target
-        else
-          @original_method = stubbee.instance_method(method)
-          if @original_method && @original_method.owner == stubbee
-            stubbee.send(:remove_method, method)
-          end
-        end
-      # rubocop:disable Lint/HandleExceptions
-      rescue NameError
-        # deal with nasties like ActiveRecord::Associations::AssociationProxy
-      end
-      # rubocop:enable Lint/HandleExceptions
-    end
-
-    def define_new_method
-      definition_target.class_eval(<<-CODE, __FILE__, __LINE__ + 1)
-        def #{method}(*args, &block)
-          self.class.any_instance.mocha.method_missing(:#{method}, *args, &block)
-        end
-      CODE
-      return unless @original_visibility
-      Module.instance_method(@original_visibility).bind(definition_target).call(method)
+    def restore_original_method
+      return if use_prepended_module_for_stub_method?
+      return unless stub_method_overwrites_original_method?
+      original_method_owner.send(:define_method, method_name, original_method)
+      Module.instance_method(original_visibility).bind(original_method_owner).call(method_name)
     end
 
-    def remove_new_method
-      definition_target.send(:remove_method, method)
-    end
+    private
 
-    def restore_original_method
-      return if RUBY_V2_PLUS
-      return unless @original_method && @original_method.owner == stubbee
-      stubbee.send(:define_method, method, @original_method)
-      Module.instance_method(@original_visibility).bind(stubbee).call(method)
+    def store_original_method
+      @original_method = original_method_owner.instance_method(method_name)
     end
 
-    def method_visibility(method)
-      (stubbee.public_instance_methods(true).include?(method) && :public) ||
-        (stubbee.protected_instance_methods(true).include?(method) && :protected) ||
-        (stubbee.private_instance_methods(true).include?(method) && :private)
+    def stub_method_definition
+      method_implementation = <<-CODE
+      def #{method_name}(*args, &block)
+        self.class.any_instance.mocha.method_missing(:#{method_name}, *args, &block)
+      end
+      CODE
+      [method_implementation, __FILE__, __LINE__ - 4]
     end
 
-    private
-
-    def definition_target
-      @definition_target ||= stubbee
+    def original_method_owner
+      stubbee
     end
   end
 end

data/lib/mocha/class_method.rb

@@ -5,13 +5,13 @@ module Mocha
   class ClassMethod
     PrependedModule = Class.new(Module)
 
-    attr_reader :stubbee, :method
+    attr_reader :stubbee, :method_name
 
-    def initialize(stubbee, method)
+    def initialize(stubbee, method_name)
       @stubbee = stubbee
       @original_method = nil
       @original_visibility = nil
-      @method = PRE_RUBY_V19 ? method.to_s : method.to_sym
+      @method_name = PRE_RUBY_V19 ? method_name.to_s : method_name.to_sym
     end
 
     def stub
@@ -22,7 +22,7 @@ module Mocha
     def unstub
       remove_new_method
       restore_original_method
-      mock.unstub(method.to_sym)
+      mock.unstub(method_name.to_sym)
       return if mock.any_expectations?
       reset_mocha
     end
@@ -36,78 +36,112 @@ module Mocha
     end
 
     def hide_original_method
-      return unless (@original_visibility = method_visibility(method))
-      begin
-        if RUBY_V2_PLUS
-          @definition_target = PrependedModule.new
-          stubbee.__metaclass__.__send__ :prepend, @definition_target
-        else
-          @original_method = stubbee._method(method)
-          if @original_method && @original_method.owner == stubbee.__metaclass__
-            stubbee.__metaclass__.send(:remove_method, method)
-          end
+      return unless method_defined_in_stubbee_or_in_ancestor_chain?
+      store_original_method_visibility
+      if use_prepended_module_for_stub_method?
+        use_prepended_module_for_stub_method
+      else
+        begin
+          store_original_method
+        # rubocop:disable Lint/HandleExceptions
+        rescue NameError
+          # deal with nasties like ActiveRecord::Associations::AssociationProxy
+        end
+        # rubocop:enable Lint/HandleExceptions
+        if stub_method_overwrites_original_method?
+          remove_original_method_from_stubbee
         end
-      # rubocop:disable Lint/HandleExceptions
-      rescue NameError
-        # deal with nasties like ActiveRecord::Associations::AssociationProxy
       end
-      # rubocop:enable Lint/HandleExceptions
     end
 
     def define_new_method
-      definition_target.class_eval(<<-CODE, __FILE__, __LINE__ + 1)
-        def #{method}(*args, &block)
-          mocha.method_missing(:#{method}, *args, &block)
-        end
-      CODE
-      return unless @original_visibility
-      Module.instance_method(@original_visibility).bind(definition_target).call(method)
+      stub_method_owner.class_eval(*stub_method_definition)
+      return unless original_visibility
+      Module.instance_method(original_visibility).bind(stub_method_owner).call(method_name)
     end
 
     def remove_new_method
-      definition_target.send(:remove_method, method)
+      stub_method_owner.send(:remove_method, method_name)
     end
 
     def restore_original_method
-      return if RUBY_V2_PLUS
-      if @original_method && @original_method.owner == stubbee.__metaclass__
+      return if use_prepended_module_for_stub_method?
+      if stub_method_overwrites_original_method?
         if PRE_RUBY_V19
-          original_method = @original_method
-          stubbee.__metaclass__.send(:define_method, method) do |*args, &block|
-            original_method.call(*args, &block)
+          original_method_in_scope = original_method
+          original_method_owner.send(:define_method, method_name) do |*args, &block|
+            original_method_in_scope.call(*args, &block)
           end
         else
-          stubbee.__metaclass__.send(:define_method, method, @original_method)
+          original_method_owner.send(:define_method, method_name, original_method)
         end
       end
-      return unless @original_visibility
-      Module.instance_method(@original_visibility).bind(stubbee.__metaclass__).call(method)
+      return unless original_visibility
+      Module.instance_method(original_visibility).bind(stubbee.__metaclass__).call(method_name)
     end
 
     def matches?(other)
       return false unless other.class == self.class
-      (stubbee.object_id == other.stubbee.object_id) && (method == other.method)
+      (stubbee.object_id == other.stubbee.object_id) && (method_name == other.method_name)
     end
 
     alias_method :==, :eql?
 
     def to_s
-      "#{stubbee}.#{method}"
+      "#{stubbee}.#{method_name}"
     end
 
-    def method_visibility(method)
-      symbol = method.to_sym
-      metaclass = stubbee.__metaclass__
-
-      (metaclass.public_method_defined?(symbol) && :public) ||
-        (metaclass.protected_method_defined?(symbol) && :protected) ||
-        (metaclass.private_method_defined?(symbol) && :private)
+    def method_visibility
+      (original_method_owner.public_method_defined?(method_name) && :public) ||
+        (original_method_owner.protected_method_defined?(method_name) && :protected) ||
+        (original_method_owner.private_method_defined?(method_name) && :private)
     end
+    alias_method :method_defined_in_stubbee_or_in_ancestor_chain?, :method_visibility
 
     private
 
-    def definition_target
-      @definition_target ||= stubbee.__metaclass__
+    attr_reader :original_method, :original_visibility
+
+    def store_original_method
+      @original_method = stubbee._method(method_name)
+    end
+
+    def store_original_method_visibility
+      @original_visibility = method_visibility
+    end
+
+    def stub_method_overwrites_original_method?
+      original_method && original_method.owner == original_method_owner
+    end
+
+    def remove_original_method_from_stubbee
+      original_method_owner.send(:remove_method, method_name)
+    end
+
+    def use_prepended_module_for_stub_method?
+      RUBY_V2_PLUS
+    end
+
+    def use_prepended_module_for_stub_method
+      @stub_method_owner = PrependedModule.new
+      original_method_owner.__send__ :prepend, @stub_method_owner
+    end
+
+    def stub_method_definition
+      method_implementation = <<-CODE
+      def #{method_name}(*args, &block)
+        mocha.method_missing(:#{method_name}, *args, &block)
+      end
+      CODE
+      [method_implementation, __FILE__, __LINE__ - 4]
+    end
+
+    def stub_method_owner
+      @stub_method_owner ||= original_method_owner
+    end
+
+    def original_method_owner
+      stubbee.__metaclass__
     end
   end
 end