mocha 1.7.0 → 1.10.2

data/lib/mocha/raised_exception.rb

@@ -0,0 +1,11 @@
+module Mocha
+  class RaisedException
+    def initialize(exception)
+      @exception = exception
+    end
+
+    def mocha_inspect
+      "raised #{@exception}"
+    end
+  end
+end

data/lib/mocha/return_values.rb

@@ -12,11 +12,11 @@ module Mocha
       @values = values
     end
 
-    def next
+    def next(invocation)
       case @values.length
       when 0 then nil
-      when 1 then @values.first.evaluate
-      else @values.shift.evaluate
+      when 1 then @values.first.evaluate(invocation)
+      else @values.shift.evaluate(invocation)
       end
     end
 

data/lib/mocha/setup.rb

@@ -1,4 +1,9 @@
 require 'mocha/integration'
+require 'mocha/deprecation'
+
+Mocha::Deprecation.warning(
+  "Require 'mocha/test_unit', 'mocha/minitest' or 'mocha/api' instead of 'mocha/setup'."
+)
 
 module Mocha
   def self.activate

data/lib/mocha/single_return_value.rb

@@ -6,7 +6,8 @@ module Mocha
       @value = value
     end
 
-    def evaluate
+    def evaluate(invocation)
+      invocation.returned(@value)
       @value
     end
   end

data/lib/mocha/singleton_class.rb

@@ -0,0 +1,9 @@
+if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('1.9.2')
+  unless Kernel.method_defined?(:singleton_class)
+    module Kernel
+      def singleton_class
+        class << self; self; end
+      end
+    end
+  end
+end

data/lib/mocha/stubbed_method.rb

@@ -0,0 +1,127 @@
+require 'mocha/ruby_version'
+require 'mocha/singleton_class'
+
+module Mocha
+  class StubbedMethod
+    PrependedModule = Class.new(Module)
+
+    attr_reader :stubbee, :method_name
+
+    def initialize(stubbee, method_name)
+      @stubbee = stubbee
+      @original_method = nil
+      @original_visibility = nil
+      @method_name = PRE_RUBY_V19 ? method_name.to_s : method_name.to_sym
+    end
+
+    def stub
+      hide_original_method
+      define_new_method
+    end
+
+    def unstub
+      remove_new_method
+      restore_original_method
+      mock.unstub(method_name.to_sym)
+      return if mock.any_expectations?
+      reset_mocha
+    end
+
+    def mock
+      mock_owner.mocha
+    end
+
+    def reset_mocha
+      mock_owner.reset_mocha
+    end
+
+    def hide_original_method
+      return unless original_method_owner.__method_exists__?(method_name)
+      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
+      end
+    end
+
+    def define_new_method
+      self_in_scope = self
+      method_name_in_scope = method_name
+      stub_method_owner.send(:define_method, method_name) do |*args, &block|
+        self_in_scope.mock.method_missing(method_name_in_scope, *args, &block)
+      end
+      retain_original_visibility(stub_method_owner)
+    end
+
+    def remove_new_method
+      stub_method_owner.send(:remove_method, method_name)
+    end
+
+    def store_original_method
+      @original_method = stubbee_method(method_name)
+    end
+
+    def restore_original_method
+      return if use_prepended_module_for_stub_method?
+      if stub_method_overwrites_original_method?
+        original_method_owner.send(:define_method, method_name, method_body(original_method))
+      end
+      retain_original_visibility(original_method_owner)
+    end
+
+    def matches?(other)
+      return false unless other.class == self.class
+      (stubbee.object_id == other.stubbee.object_id) && (method_name == other.method_name)
+    end
+
+    alias_method :==, :eql?
+
+    def to_s
+      "#{stubbee}.#{method_name}"
+    end
+
+    private
+
+    def retain_original_visibility(method_owner)
+      return unless original_visibility
+      Module.instance_method(original_visibility).bind(method_owner).call(method_name)
+    end
+
+    attr_reader :original_method, :original_visibility
+
+    def store_original_method_visibility
+      @original_visibility = original_method_owner.__method_visibility__(method_name)
+    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_owner
+      @stub_method_owner ||= original_method_owner
+    end
+  end
+end

data/lib/mocha/test_unit.rb

@@ -1,3 +1,8 @@
 require 'mocha/integration/test_unit'
+require 'mocha/deprecation'
 
-Mocha::Integration::TestUnit.activate
+unless Mocha::Integration::TestUnit.activate
+  Mocha::Deprecation.warning(
+    "Test::Unit must be loaded *before* `require 'mocha/test_unit'`."
+  )
+end

data/lib/mocha/thrower.rb

@@ -5,7 +5,8 @@ module Mocha
       @object = object
     end
 
-    def evaluate
+    def evaluate(invocation)
+      invocation.threw(@tag, @object)
       throw @tag, @object
     end
   end

data/lib/mocha/thrown_object.rb

@@ -0,0 +1,12 @@
+module Mocha
+  class ThrownObject
+    def initialize(tag, value = nil)
+      @tag = tag
+      @value = value
+    end
+
+    def mocha_inspect
+      "threw (#{@tag.mocha_inspect}, #{@value.mocha_inspect})"
+    end
+  end
+end

data/lib/mocha/version.rb

@@ -1,3 +1,3 @@
 module Mocha
-  VERSION = '1.7.0'.freeze
+  VERSION = '1.10.2'.freeze
 end

data/mocha.gemspec

@@ -2,7 +2,7 @@ lib = File.expand_path('../lib/', __FILE__)
 $LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
 require 'mocha/version'
 
-Gem::Specification.new do |s|
+Gem::Specification.new do |s| # rubocop:disable Metrics/BlockLength
   s.name = 'mocha'
   s.version = Mocha::VERSION
   s.licenses = ['MIT', 'BSD-2-Clause']
@@ -16,12 +16,9 @@ Gem::Specification.new do |s|
   s.files.delete('.travis.yml')
   s.files.delete('.gitignore')
 
-  s.homepage = 'http://gofreerange.com/mocha/docs'
+  s.homepage = 'https://mocha.jamesmead.org'
   s.require_paths = ['lib']
   s.summary = 'Mocking and stubbing library'
-  s.has_rdoc = 'yard'
-
-  s.add_dependency('metaclass', '~> 0.0.1')
 
   unless s.respond_to?(:add_development_dependency)
     class << s
@@ -43,7 +40,7 @@ Gem::Specification.new do |s|
     s.add_development_dependency('minitest')
   end
   if RUBY_VERSION >= '1.9.2'
-    s.add_development_dependency('rubocop')
+    s.add_development_dependency('rubocop', '<= 0.58.2')
   end
   if ENV['MOCHA_GENERATE_DOCS']
     s.add_development_dependency('redcarpet')

data/test/acceptance/acceptance_test_helper.rb

@@ -3,6 +3,12 @@ require 'test_runner'
 require 'mocha/configuration'
 require 'introspection'
 
+if Mocha::Detection::MiniTest.testcase && (ENV['MOCHA_RUN_INTEGRATION_TESTS'] != 'test-unit')
+  require 'mocha/minitest'
+else
+  require 'mocha/test_unit'
+end
+
 module AcceptanceTest
   class FakeLogger
     attr_reader :warnings

data/test/acceptance/bug_18914_test.rb

@@ -1,5 +1,4 @@
 require File.expand_path('../acceptance_test_helper', __FILE__)
-require 'mocha/setup'
 
 class Bug18914Test < Mocha::TestCase
   include AcceptanceTest

data/test/acceptance/bug_21465_test.rb

@@ -1,5 +1,4 @@
 require File.expand_path('../acceptance_test_helper', __FILE__)
-require 'mocha/setup'
 
 class Bug21465Test < Mocha::TestCase
   include AcceptanceTest

data/test/acceptance/bug_21563_test.rb

@@ -1,5 +1,4 @@
 require File.expand_path('../acceptance_test_helper', __FILE__)
-require 'mocha/setup'
 
 class Bug21563Test < Mocha::TestCase
   include AcceptanceTest

data/test/acceptance/display_matching_invocations_alongside_expectations_test.rb

@@ -0,0 +1,69 @@
+require File.expand_path('../acceptance_test_helper', __FILE__)
+
+class DisplayMatchingInvocationsAlongsideExpectationsTest < Mocha::TestCase
+  include AcceptanceTest
+
+  def setup
+    setup_acceptance_test
+    Mocha.configuration.display_matching_invocations_on_failure = true
+  end
+
+  def test_should_display_results
+    test_result = run_as_test do
+      foo = mock('foo')
+      foo.expects(:bar).with(1).returns('a')
+      foo.stubs(:bar).with(any_parameters).returns('f').raises(StandardError).throws(:tag, 'value')
+
+      foo.bar(1, 2)
+      assert_raises(StandardError) { foo.bar(3, 4) }
+      assert_throws(:tag) { foo.bar(5, 6) }
+    end
+    assert_invocations(
+      test_result,
+      '- allowed any number of times, invoked 3 times: #<Mock:foo>.bar(any_parameters)',
+      '  - #<Mock:foo>.bar(1, 2) # => "f"',
+      '  - #<Mock:foo>.bar(3, 4) # => raised StandardError',
+      '  - #<Mock:foo>.bar(5, 6) # => threw (:tag, "value")'
+    )
+  end
+
+  def test_should_display_yields
+    test_result = run_as_test do
+      foo = mock('foo')
+      foo.expects(:bar).with(1).returns('a')
+      foo.stubs(:bar).with(any_parameters).multiple_yields(%w[b c], %w[d e]).returns('f').raises(StandardError).throws(:tag, 'value')
+
+      foo.bar(1, 2) { |_ignored| }
+      assert_raises(StandardError) { foo.bar(3, 4) { |_ignored| } }
+      assert_throws(:tag) { foo.bar(5, 6) { |_ignored| } }
+    end
+    assert_invocations(
+      test_result,
+      '- allowed any number of times, invoked 3 times: #<Mock:foo>.bar(any_parameters)',
+      '  - #<Mock:foo>.bar(1, 2) # => "f" after yielding ("b", "c"), then ("d", "e")',
+      '  - #<Mock:foo>.bar(3, 4) # => raised StandardError after yielding ("b", "c"), then ("d", "e")',
+      '  - #<Mock:foo>.bar(5, 6) # => threw (:tag, "value") after yielding ("b", "c"), then ("d", "e")'
+    )
+  end
+
+  def test_should_display_empty_yield_and_return
+    test_result = run_as_test do
+      foo = mock('foo')
+      foo.expects(:bar).with(1).returns('a')
+      foo.stubs(:bar).with(any_parameters).yields
+
+      foo.bar(1, 2) { |_ignored| }
+    end
+    assert_invocations(
+      test_result,
+      '- allowed any number of times, invoked once: #<Mock:foo>.bar(any_parameters)',
+      '  - #<Mock:foo>.bar(1, 2) # => nil after yielding ()'
+    )
+  end
+
+  def assert_invocations(test_result, *invocations)
+    assert_failed(test_result)
+    assert_equal invocations.unshift('satisfied expectations:'),
+                 test_result.failure_message_lines[-invocations.size..-1]
+  end
+end

data/test/acceptance/exception_rescue_test.rb

@@ -1,5 +1,4 @@
 require File.expand_path('../acceptance_test_helper', __FILE__)
-require 'mocha/setup'
 
 class ExceptionRescueTest < Mocha::TestCase
   include AcceptanceTest
@@ -48,7 +47,7 @@ class ExceptionRescueTest < Mocha::TestCase
     assert_equal [
       'not all expectations were satisfied',
       'unsatisfied expectations:',
-      '- expected exactly once, not yet invoked: #<Mock:mock>.some_method(any_parameters)'
+      '- expected exactly once, invoked never: #<Mock:mock>.some_method(any_parameters)'
     ], test_result.failure_message_lines
   end
 end

data/test/acceptance/expectations_on_multiple_methods_test.rb

@@ -1,5 +1,4 @@
 require File.expand_path('../acceptance_test_helper', __FILE__)
-require 'mocha/setup'
 
 class ExpectationsOnMultipleMethodsTest < Mocha::TestCase
   include AcceptanceTest

data/test/acceptance/expected_invocation_count_test.rb

@@ -1,5 +1,4 @@
 require File.expand_path('../acceptance_test_helper', __FILE__)
-require 'mocha/setup'
 
 class ExpectedInvocationCountTest < Mocha::TestCase
   include AcceptanceTest
@@ -155,7 +154,7 @@ class ExpectedInvocationCountTest < Mocha::TestCase
     assert_equal [
       'not all expectations were satisfied',
       'unsatisfied expectations:',
-      '- expected at least once, not yet invoked: #<Mock:mock>.method(any_parameters)'
+      '- expected at least once, invoked never: #<Mock:mock>.method(any_parameters)'
     ], test_result.failure_message_lines
   end
 
@@ -224,7 +223,7 @@ class ExpectedInvocationCountTest < Mocha::TestCase
     assert_equal [
       'unexpected invocation: #<Mock:mock>.method()',
       'unsatisfied expectations:',
-      '- expected exactly once, not yet invoked: #<Mock:mock>.method(1)'
+      '- expected exactly once, invoked never: #<Mock:mock>.method(1)'
     ], test_result.failure_message_lines
   end
 end

data/test/acceptance/failure_messages_test.rb

@@ -1,5 +1,4 @@
 require File.expand_path('../acceptance_test_helper', __FILE__)
-require 'mocha/setup'
 
 class FailureMessagesTest < Mocha::TestCase
   OBJECT_ADDRESS_PATTERN = '0x[0-9A-Fa-f]{1,12}'.freeze

data/test/acceptance/issue_272_test.rb

@@ -1,5 +1,4 @@
 require File.expand_path('../acceptance_test_helper', __FILE__)
-require 'mocha/setup'
 
 class Issue272Test < Mocha::TestCase
   include AcceptanceTest
@@ -38,7 +37,7 @@ class Issue272Test < Mocha::TestCase
       Klass.stubs(:foo).returns('stubbed-foo')
       # hangs in next line executing:
       # `@original_method = stubbee._method(method)`
-      # in Mocha::ClassMethod#hide_original_method
+      # in Mocha::StubbedMethod#hide_original_method
       # but only in Ruby v2.3, not v2.2
       Klass.stubs(:bar).returns('stubbed-bar')
       assert_equal 'stubbed-foo', Klass.foo

data/test/acceptance/issue_65_test.rb

@@ -1,5 +1,4 @@
 require File.expand_path('../acceptance_test_helper', __FILE__)
-require 'mocha/setup'
 
 class Issue65Test < Mocha::TestCase
   include AcceptanceTest

data/test/acceptance/issue_70_test.rb

@@ -1,5 +1,4 @@
 require File.expand_path('../acceptance_test_helper', __FILE__)
-require 'mocha/setup'
 
 class Issue70Test < Mocha::TestCase
   include AcceptanceTest