mocha 1.1.0 → 1.2.0

data/lib/mocha/mockery.rb

@@ -1,3 +1,4 @@
+require 'mocha/ruby_version'
 require 'mocha/central'
 require 'mocha/mock'
 require 'mocha/names'
@@ -97,7 +98,7 @@ module Mocha
     end
 
     def on_stubbing(object, method)
-      method = RUBY_VERSION < '1.9' ? method.to_s : method.to_sym
+      method = PRE_RUBY_V19 ? method.to_s : method.to_sym
       unless Mocha::Configuration.allow?(:stubbing_non_existent_method)
         unless object.method_exists?(method, include_public_methods = true)
           on_stubbing_non_existent_method(object, method)

data/lib/mocha/parameter_matchers/equals.rb

@@ -22,7 +22,7 @@ module Mocha
     #   object = mock()
     #   object.expects(:method_1).with(equals(2))
     #   object.method_1(3)
-    #   # error raised, because method_1 was not called with an +Object+ that equals 3
+    #   # error raised, because method_1 was not called with an +Object+ that equals 2
     def equals(value)
       Equals.new(value)
     end

data/lib/mocha/parameter_matchers/includes.rb

@@ -22,6 +22,46 @@ module Mocha
     # @example Actual parameter does not include all items.
     #   object.method_1(['foo', 'baz'])
     #   # error raised, because ['foo', 'baz'] does not include 'bar'.
+    #
+    # @example Actual parameter includes item which matches nested matcher.
+    #   object = mock()
+    #   object.expects(:method_1).with(includes(has_key(:key)))
+    #   object.method_1(['foo', 'bar', {:key => 'baz'}])
+    #   # no error raised
+    #
+    # @example Actual parameter does not include item matching nested matcher.
+    #   object.method_1(['foo', 'bar', {:other_key => 'baz'}])
+    #   # error raised, because no element matches `has_key(:key)` matcher
+    #
+    # @example Actual parameter is a String including substring.
+    #   object = mock()
+    #   object.expects(:method_1).with(includes('bar'))
+    #   object.method_1('foobarbaz')
+    #   # no error raised
+    #
+    # @example Actual parameter is a String not including substring.
+    #   object.method_1('foobaz')
+    #   # error raised, because 'foobaz' does not include 'bar'
+    #
+    # @example Actual parameter is a Hash including the given key.
+    #   object = mock()
+    #   object.expects(:method_1).with(includes(:bar))
+    #   object.method_1({:foo => 1, :bar => 2})
+    #   # no error raised
+    #
+    # @example Actual parameter is a Hash without the given key.
+    #   object.method_1({:foo => 1, :baz => 2})
+    #   # error raised, because hash does not include key 'bar'
+    #
+    # @example Actual parameter is a Hash with a key matching the given matcher.
+    #   object = mock()
+    #   object.expects(:method_1).with(includes(regexp_matches(/ar/)))
+    #   object.method_1({'foo' => 1, 'bar' => 2})
+    #   # no error raised
+    #
+    # @example Actual parameter is a Hash no key matching the given matcher.
+    #   object.method_1({'foo' => 1, 'baz' => 3})
+    #   # error raised, because hash does not include a key matching /ar/
     def includes(*items)
       Includes.new(*items)
     end
@@ -38,9 +78,12 @@ module Mocha
       def matches?(available_parameters)
         parameter = available_parameters.shift
         return false unless parameter.respond_to?(:include?)
-
         if @items.size == 1
-          return parameter.include?(@items.first)
+          if parameter.respond_to?(:any?) && !parameter.is_a?(String)
+            return parameter.any? { |(p,_)| @items.first.to_matcher.matches?([p]) }
+          else
+            return parameter.include?(@items.first)
+          end
         else
           includes_matchers = @items.map { |item| Includes.new(item) }
           AllOf.new(*includes_matchers).matches?([parameter])

data/lib/mocha/ruby_version.rb

@@ -0,0 +1,4 @@
+module Mocha
+  PRE_RUBY_V19 = Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('1.9')
+  RUBY_V2_PLUS = Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2')
+end

data/lib/mocha/version.rb

@@ -1,3 +1,3 @@
 module Mocha
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/mocha.gemspec

@@ -6,6 +6,7 @@ require "mocha/version"
 Gem::Specification.new do |s|
   s.name = "mocha"
   s.version = Mocha::VERSION
+  s.licenses = ['MIT', 'BSD-2-Clause']
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["James Mead"]
@@ -28,26 +29,47 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency("rake", ">= 0")
+      if RUBY_VERSION >= '1.9.3'
+        s.add_development_dependency("rake", ">= 0")
+      else
+        s.add_development_dependency("rake", "~> 10.0")
+      end
       s.add_development_dependency("introspection", "~> 0.0.1")
-      unless ENV["MOCHA_NO_DOCS"]
+      if RUBY_VERSION >= '2.2.0'
+        s.add_development_dependency("minitest")
+      end
+      if ENV["MOCHA_GENERATE_DOCS"]
         s.add_development_dependency("yard")
-        s.add_development_dependency("redcarpet", "~> 1")
+        s.add_development_dependency("redcarpet")
       end
     else
-      s.add_dependency("rake", ">= 0")
+      if RUBY_VERSION >= '1.9.3'
+        s.add_development_dependency("rake", ">= 0")
+      else
+        s.add_development_dependency("rake", "~> 10.0")
+      end
       s.add_dependency("introspection", "~> 0.0.1")
-      unless ENV["MOCHA_NO_DOCS"]
+      if RUBY_VERSION >= '2.2.0'
+        s.add_dependency("minitest")
+      end
+      if ENV["MOCHA_GENERATE_DOCS"]
         s.add_dependency("yard")
-        s.add_dependency("redcarpet", "~> 1")
+        s.add_dependency("redcarpet")
       end
     end
   else
-    s.add_dependency("rake", ">= 0")
+    if RUBY_VERSION >= '1.9.3'
+      s.add_development_dependency("rake", ">= 0")
+    else
+      s.add_development_dependency("rake", "~> 10.0")
+    end
     s.add_dependency("introspection", "~> 0.0.1")
-    unless ENV["MOCHA_NO_DOCS"]
+    if RUBY_VERSION >= '2.2.0'
+      s.add_dependency("minitest")
+    end
+    if ENV["MOCHA_GENERATE_DOCS"]
       s.add_dependency("yard")
-      s.add_dependency("redcarpet", "~> 1")
+      s.add_dependency("redcarpet")
     end
   end
 end

data/test/acceptance/prepend_test.rb

@@ -1,5 +1,6 @@
 require File.expand_path('../acceptance_test_helper', __FILE__)
 require 'mocha/setup'
+require 'mocha/ruby_version'
 
 class PrependTest < Mocha::TestCase
 
@@ -13,7 +14,7 @@ class PrependTest < Mocha::TestCase
     teardown_acceptance_test
   end
 
-  if RUBY_VERSION >= '2.0'
+  if Mocha::RUBY_V2_PLUS
 
     module Mod1
       def my_method

data/test/acceptance/stub_any_instance_method_test.rb

@@ -22,7 +22,7 @@ class StubAnyInstanceMethodTest < Mocha::TestCase
     instance = klass.new
     test_result = run_as_test do
       klass.any_instance.stubs(:my_instance_method).returns(:new_return_value)
-      assert_method_visiblity instance, :my_instance_method, :public
+      assert_method_visibility instance, :my_instance_method, :public
       assert_equal :new_return_value, instance.my_instance_method
     end
     assert_passed(test_result)
@@ -77,7 +77,7 @@ class StubAnyInstanceMethodTest < Mocha::TestCase
     instance = klass.new
     test_result = run_as_test do
       klass.any_instance.stubs(:my_instance_method).returns(:new_return_value)
-      assert_method_visiblity instance, :my_instance_method, :protected
+      assert_method_visibility instance, :my_instance_method, :protected
     end
     assert_passed(test_result)
   end
@@ -109,7 +109,7 @@ class StubAnyInstanceMethodTest < Mocha::TestCase
     instance = klass.new
     test_result = run_as_test do
       klass.any_instance.stubs(:my_instance_method).returns(:new_return_value)
-      assert_method_visiblity instance, :my_instance_method, :private
+      assert_method_visibility instance, :my_instance_method, :private
     end
     assert_passed(test_result)
   end
@@ -127,16 +127,18 @@ class StubAnyInstanceMethodTest < Mocha::TestCase
     assert_equal 0, klass.any_instance.mocha.__expectations__.length
   end
 
-  def test_should_be_able_to_stub_a_superclass_method
+  def test_should_be_able_to_stub_a_public_superclass_method
     superklass = Class.new do
       def my_superclass_method
         :original_return_value
       end
+      public :my_superclass_method
     end
     klass = Class.new(superklass)
     instance = klass.new
     test_result = run_as_test do
       klass.any_instance.stubs(:my_superclass_method).returns(:new_return_value)
+      assert_method_visibility instance, :my_superclass_method, :public
       assert_equal :new_return_value, instance.my_superclass_method
     end
     assert_passed(test_result)
@@ -145,6 +147,46 @@ class StubAnyInstanceMethodTest < Mocha::TestCase
     assert_equal :original_return_value, instance.my_superclass_method
   end
 
+  def test_should_be_able_to_stub_a_protected_superclass_method
+    superklass = Class.new do
+      def my_superclass_method
+        :original_return_value
+      end
+      protected :my_superclass_method
+    end
+    klass = Class.new(superklass)
+    instance = klass.new
+    test_result = run_as_test do
+      klass.any_instance.stubs(:my_superclass_method).returns(:new_return_value)
+      assert_method_visibility instance, :my_superclass_method, :protected
+      assert_equal :new_return_value, instance.send(:my_superclass_method)
+    end
+    assert_passed(test_result)
+    assert instance.protected_methods(true).any? { |m| m.to_s == 'my_superclass_method' }
+    assert !klass.protected_methods(false).any? { |m| m.to_s == 'my_superclass_method' }
+    assert_equal :original_return_value, instance.send(:my_superclass_method)
+  end
+
+  def test_should_be_able_to_stub_a_private_superclass_method
+    superklass = Class.new do
+      def my_superclass_method
+        :original_return_value
+      end
+      private :my_superclass_method
+    end
+    klass = Class.new(superklass)
+    instance = klass.new
+    test_result = run_as_test do
+      klass.any_instance.stubs(:my_superclass_method).returns(:new_return_value)
+      assert_method_visibility instance, :my_superclass_method, :private
+      assert_equal :new_return_value, instance.send(:my_superclass_method)
+    end
+    assert_passed(test_result)
+    assert instance.private_methods(true).any? { |m| m.to_s == 'my_superclass_method' }
+    assert !klass.private_methods(false).any? { |m| m.to_s == 'my_superclass_method' }
+    assert_equal :original_return_value, instance.send(:my_superclass_method)
+  end
+
   def test_should_be_able_to_stub_method_if_ruby18_public_instance_methods_include_method_but_method_does_not_actually_exist_like_active_record_association_proxy
     ruby18_klass = Class.new do
       class << self
@@ -185,7 +227,7 @@ class StubAnyInstanceMethodTest < Mocha::TestCase
     end
     test_result = run_as_test do
       ruby18_klass.any_instance.stubs(:my_instance_method).returns(:new_return_value)
-      assert_equal :new_return_value, ruby18_klass.new.my_instance_method
+      assert_equal :new_return_value, ruby18_klass.new.send(:my_instance_method)
     end
     assert_passed(test_result)
   end
@@ -200,7 +242,7 @@ class StubAnyInstanceMethodTest < Mocha::TestCase
     end
     test_result = run_as_test do
       ruby19_klass.any_instance.stubs(:my_instance_method).returns(:new_return_value)
-      assert_equal :new_return_value, ruby19_klass.new.my_instance_method
+      assert_equal :new_return_value, ruby19_klass.new.send(:my_instance_method)
     end
     assert_passed(test_result)
   end
@@ -215,7 +257,7 @@ class StubAnyInstanceMethodTest < Mocha::TestCase
     end
     test_result = run_as_test do
       ruby18_klass.any_instance.stubs(:my_instance_method).returns(:new_return_value)
-      assert_equal :new_return_value, ruby18_klass.new.my_instance_method
+      assert_equal :new_return_value, ruby18_klass.new.send(:my_instance_method)
     end
     assert_passed(test_result)
   end
@@ -230,7 +272,7 @@ class StubAnyInstanceMethodTest < Mocha::TestCase
     end
     test_result = run_as_test do
       ruby19_klass.any_instance.stubs(:my_instance_method).returns(:new_return_value)
-      assert_equal :new_return_value, ruby19_klass.new.my_instance_method
+      assert_equal :new_return_value, ruby19_klass.new.send(:my_instance_method)
     end
     assert_passed(test_result)
   end

data/test/acceptance/stub_class_method_defined_on_class_test.rb

@@ -26,7 +26,7 @@ class StubClassMethodDefinedOnClassTest < Mocha::TestCase
     assert_snapshot_unchanged(klass) do
       test_result = run_as_test do
         klass.stubs(:my_class_method).returns(:new_return_value)
-        assert_method_visiblity klass, :my_class_method, :public
+        assert_method_visibility klass, :my_class_method, :public
         assert_equal :new_return_value, klass.my_class_method
       end
       assert_passed(test_result)
@@ -47,7 +47,7 @@ class StubClassMethodDefinedOnClassTest < Mocha::TestCase
     assert_snapshot_unchanged(klass) do
       test_result = run_as_test do
         klass.stubs(:my_class_method).returns(:new_return_value)
-        assert_method_visiblity klass, :my_class_method, :protected
+        assert_method_visibility klass, :my_class_method, :protected
         assert_equal :new_return_value, klass.send(:my_class_method)
       end
       assert_passed(test_result)
@@ -68,7 +68,7 @@ class StubClassMethodDefinedOnClassTest < Mocha::TestCase
     assert_snapshot_unchanged(klass) do
       test_result = run_as_test do
         klass.stubs(:my_class_method).returns(:new_return_value)
-        assert_method_visiblity klass, :my_class_method, :private
+        assert_method_visibility klass, :my_class_method, :private
         assert_equal :new_return_value, klass.send(:my_class_method)
       end
       assert_passed(test_result)

data/test/acceptance/stub_instance_method_defined_on_class_test.rb

@@ -23,7 +23,7 @@ class StubInstanceMethodDefinedOnClassTest < Mocha::TestCase
     assert_snapshot_unchanged(instance) do
       test_result = run_as_test do
         instance.stubs(:my_instance_method).returns(:new_return_value)
-        assert_method_visiblity instance, :my_instance_method, :public
+        assert_method_visibility instance, :my_instance_method, :public
         assert_equal :new_return_value, instance.my_instance_method
       end
       assert_passed(test_result)
@@ -41,7 +41,7 @@ class StubInstanceMethodDefinedOnClassTest < Mocha::TestCase
     assert_snapshot_unchanged(instance) do
       test_result = run_as_test do
         instance.stubs(:my_instance_method).returns(:new_return_value)
-        assert_method_visiblity instance, :my_instance_method, :protected
+        assert_method_visibility instance, :my_instance_method, :protected
         assert_equal :new_return_value, instance.send(:my_instance_method)
       end
       assert_passed(test_result)
@@ -59,7 +59,7 @@ class StubInstanceMethodDefinedOnClassTest < Mocha::TestCase
     assert_snapshot_unchanged(instance) do
       test_result = run_as_test do
         instance.stubs(:my_instance_method).returns(:new_return_value)
-        assert_method_visiblity instance, :my_instance_method, :private
+        assert_method_visibility instance, :my_instance_method, :private
         assert_equal :new_return_value, instance.send(:my_instance_method)
       end
       assert_passed(test_result)

data/test/acceptance/stub_instance_method_defined_on_module_test.rb

@@ -26,6 +26,7 @@ class StubInstanceMethodDefinedOnModuleTest < Mocha::TestCase
     assert_snapshot_unchanged(instance) do
       test_result = run_as_test do
         instance.stubs(:my_module_method).returns(:new_return_value)
+        assert_method_visibility instance, :my_module_method, :public
         assert_equal :new_return_value, instance.my_module_method
       end
       assert_passed(test_result)
@@ -46,6 +47,7 @@ class StubInstanceMethodDefinedOnModuleTest < Mocha::TestCase
     assert_snapshot_unchanged(instance) do
       test_result = run_as_test do
         instance.stubs(:my_module_method).returns(:new_return_value)
+        assert_method_visibility instance, :my_module_method, :protected
         assert_equal :new_return_value, instance.send(:my_module_method)
       end
       assert_passed(test_result)
@@ -66,6 +68,7 @@ class StubInstanceMethodDefinedOnModuleTest < Mocha::TestCase
     assert_snapshot_unchanged(instance) do
       test_result = run_as_test do
         instance.stubs(:my_module_method).returns(:new_return_value)
+        assert_method_visibility instance, :my_module_method, :private
         assert_equal :new_return_value, instance.send(:my_module_method)
       end
       assert_passed(test_result)

data/test/acceptance/stub_method_defined_on_module_and_aliased_test.rb

@@ -0,0 +1,39 @@
+require File.expand_path('../acceptance_test_helper', __FILE__)
+require 'mocha/setup'
+
+unless Mocha::PRE_RUBY_V19
+  class StubMethodDefinedOnModuleAndAliasedTest < Mocha::TestCase
+    include AcceptanceTest
+
+    def setup
+      setup_acceptance_test
+    end
+
+    def teardown
+      teardown_acceptance_test
+    end
+
+    def test_stubbing_class_method_defined_by_aliasing_module_instance_method
+      mod = Module.new do
+        def module_instance_method
+          'module-instance-method'
+        end
+      end
+
+      klass = Class.new do
+        extend mod
+        class << self
+          alias_method :aliased_module_instance_method, :module_instance_method
+        end
+      end
+
+      assert_snapshot_unchanged(klass) do
+        test_result = run_as_test do
+          klass.stubs(:aliased_module_instance_method).returns('stubbed-aliased-module-instance-method')
+          assert_equal 'stubbed-aliased-module-instance-method', klass.aliased_module_instance_method
+        end
+        assert_passed(test_result)
+      end
+    end
+  end
+end

data/test/acceptance/stubbing_nil_test.rb

@@ -13,47 +13,49 @@ class StubbingNilTest < Mocha::TestCase
     teardown_acceptance_test
   end
 
-  def test_should_allow_stubbing_method_on_nil
-    Mocha::Configuration.allow(:stubbing_method_on_nil)
-    test_result = run_as_test do
-      nil.stubs(:stubbed_method)
+  if RUBY_VERSION < '2.2.0'
+    def test_should_allow_stubbing_method_on_nil
+      Mocha::Configuration.allow(:stubbing_method_on_nil)
+      test_result = run_as_test do
+        nil.stubs(:stubbed_method)
+      end
+      assert_passed(test_result)
+      assert !@logger.warnings.include?("stubbing method on nil: nil.stubbed_method")
     end
-    assert_passed(test_result)
-    assert !@logger.warnings.include?("stubbing method on nil: nil.stubbed_method")
-  end
 
-  def test_should_warn_on_stubbing_method_on_nil
-    Mocha::Configuration.warn_when(:stubbing_method_on_nil)
-    test_result = run_as_test do
-      nil.stubs(:stubbed_method)
+    def test_should_warn_on_stubbing_method_on_nil
+      Mocha::Configuration.warn_when(:stubbing_method_on_nil)
+      test_result = run_as_test do
+        nil.stubs(:stubbed_method)
+      end
+      assert_passed(test_result)
+      assert @logger.warnings.include?("stubbing method on nil: nil.stubbed_method")
     end
-    assert_passed(test_result)
-    assert @logger.warnings.include?("stubbing method on nil: nil.stubbed_method")
-  end
 
-  def test_should_prevent_stubbing_method_on_nil
-    Mocha::Configuration.prevent(:stubbing_method_on_nil)
-    test_result = run_as_test do
-      nil.stubs(:stubbed_method)
+    def test_should_prevent_stubbing_method_on_nil
+      Mocha::Configuration.prevent(:stubbing_method_on_nil)
+      test_result = run_as_test do
+        nil.stubs(:stubbed_method)
+      end
+      assert_failed(test_result)
+      assert test_result.error_messages.include?("Mocha::StubbingError: stubbing method on nil: nil.stubbed_method")
     end
-    assert_failed(test_result)
-    assert test_result.error_messages.include?("Mocha::StubbingError: stubbing method on nil: nil.stubbed_method")
-  end
 
-  def test_should_default_to_prevent_stubbing_method_on_non_mock_object
-    test_result = run_as_test do
-      nil.stubs(:stubbed_method)
+    def test_should_default_to_prevent_stubbing_method_on_non_mock_object
+      test_result = run_as_test do
+        nil.stubs(:stubbed_method)
+      end
+      assert_failed(test_result)
+      assert test_result.error_messages.include?("Mocha::StubbingError: stubbing method on nil: nil.stubbed_method")
     end
-    assert_failed(test_result)
-    assert test_result.error_messages.include?("Mocha::StubbingError: stubbing method on nil: nil.stubbed_method")
-  end
 
-  def test_should_allow_stubbing_method_on_non_nil_object
-    Mocha::Configuration.prevent(:stubbing_method_on_nil)
-    object = Object.new
-    test_result = run_as_test do
-      object.stubs(:stubbed_method)
+    def test_should_allow_stubbing_method_on_non_nil_object
+      Mocha::Configuration.prevent(:stubbing_method_on_nil)
+      object = Object.new
+      test_result = run_as_test do
+        object.stubs(:stubbed_method)
+      end
+      assert_passed(test_result)
     end
-    assert_passed(test_result)
   end
 end