flexmock 0.4.0 → 0.4.1

data/CHANGELOG

@@ -1,6 +1,11 @@
 = Changes for FlexMock
 
-== Pre Version 0.3.3
+== Version 0.4.1
+
+* Removed include of Test::Unit::Assertions from Expectations.
+* Fixed mocking of kernel methods.
+
+== Version 0.4.0
 
 * Added stubbing for mocking methods of existing objects.
 * Added multiple return values for the +and_returns+ method.

data/README

@@ -3,7 +3,7 @@
 FlexMock is a simple, but flexible, mock object library for Ruby unit
 testing.
 
-Version :: 0.4.0
+Version :: 0.4.1
 
 = Links
 

data/Rakefile

@@ -9,7 +9,7 @@ require 'rake/testtask'
 CLEAN.include('*.tmp')
 CLOBBER.include("html", 'pkg')
 
-PKG_VERSION = '0.4.0'
+PKG_VERSION = '0.4.1'
 
 PKG_FILES = FileList[
   '[A-Z]*',
@@ -147,6 +147,8 @@ task :tag do
   sh %{svn copy #{SVNHOME}/trunk #{SVNHOME}/tags/rel-#{PKG_VERSION} -m 'Release #{PKG_VERSION}'}
 end
 
+RUBY_FILES = FileList['**/*.rb']
+RUBY_FILES.exclude(/^pkg/)
 task :dbg do
-  FileList['**/*.rb'].egrep(/DBG/)
+  RUBY_FILES.egrep(/DBG/)
 end

data/doc/releases/flexmock-0.4.1.rdoc

@@ -0,0 +1,87 @@
+= FlexMock 0.4.1 Released
+
+FlexMock is a flexible mocking library for use in Ruby's Test::Unit
+test framework.  Version 0.4.0 enhances FlexMock with the ability to
+stub and mock methods in existing objects.
+
+== New in 0.4.1
+
+Coming fast on the heels of 0.4.0, version 0.4.1 fixes a problem with
+mocking methods that have the same name as methods defined in Kernel.
+
+== What is FlexMock?
+
+FlexMock is a flexible Ruby mocking library that works with Ruby's
+Test::Unit framework to create easy to use mocks.
+
+=== Features
+
+* Easy integration with Test::Unit.  Mocks created with the flexmock
+  method are automatically verified at the end of the test.
+
+* A fluent interface that allows mock behavior to be specified very
+  easily.
+
+* A "record mode" where an existing implementation can record its
+  interaction with a mock for later validation against a new
+  implementation.
+
+* Easy mocking of individual methods in existing, non-mock objects.
+
+=== Example
+
+Suppose you had a Dog object that wagged a tail when it was happy.
+Something like this:
+
+  class Dog
+    def initialize(a_tail)
+      @tail = a_tail
+    end
+    def happy
+      @tail.wag
+    end
+  end
+
+To test the +Dog+ class without a real +Tail+ object (perhaps because
+real +Tail+ objects activate servos in some robotic equipment), you
+can do something like this:
+
+require 'test/unit'
+require 'flexmock'
+
+  class TestDog < Test::Unit::TestCase
+    include FlexMock::TestCase
+
+    def test_dog_wags_tail_when_happy
+      tail = flexmock("tail")
+      tail.should_receive(:wag).once
+      dog = Dog.new(tail)
+      dog.happy
+    end
+  end
+
+FlexMock will automatically verify that the mocked tail object
+received the message +wag+ exactly one time.  If it doesn't, the test
+will not pass.
+
+See the FlexMock documentation at
+http://onestepback.org/software/flexmock for details on specifying
+arguments and return values on mocked methods, as well as a simple
+technique for mocking tail objects when the Dog class creates the tail
+objects directly.
+
+== Availability
+
+FlexMock is distributed with Rails, or you can make sure you have the
+latest version with a quick RubyGems command:
+
+  gem install flexmock    (you may need root/admin privileges)
+
+Otherwise, you can get it from the more traditional places:
+
+Download::  http://rubyforge.org/project/showfiles.php?group_id=170
+
+You will find documentation at:
+http://onestepback.org/software/flexmock/
+
+-- Jim Weirich

data/lib/flexmock.rb

@@ -115,6 +115,9 @@ class FlexMock
     end
   end
 
+  # Save the original definition of respond_to? for use a bit later.
+  alias mock_respond_to? respond_to?
+
   # Override the built-in respond_to? to include the mocked methods.
   def respond_to?(sym)
     super || (@expectations[sym] ? true : @ignore_missing)
@@ -141,9 +144,26 @@ class FlexMock
     @expectations[sym] ||= ExpectationDirector.new(sym)
     result = Expectation.new(self, sym)
     @expectations[sym] << result
+    override_existing_method(sym) if mock_respond_to?(sym)
     result
   end
 
+  # Override the existing definition of method +sym+ in the mock.
+  # Most methods depend on the method_missing trick to be invoked.
+  # However, if the method already exists, it will not call
+  # method_missing.  This method defines a singleton method on the
+  # mock to explicitly invoke the method_missing logic.
+  def override_existing_method(sym)
+    sclass.class_eval "def #{sym}(*args, &block) method_missing(:#{sym}, *args, &block) end"
+  end
+  private :override_existing_method
+  
+  # Return the singleton class of the mock object.
+  def sclass
+    class << self; self; end
+  end
+  private :sclass
+
   # Declare that the mock object should expect methods by providing a
   # recorder for the methods and having the user invoke the expected
   # methods in a block.  Further expectations may be applied the

data/test/test_should_receive.rb

@@ -12,6 +12,17 @@
 require 'test/unit'
 require 'flexmock'
 
+def mock_top_level_function
+  :mtlf
+end
+
+
+module Kernel
+  def mock_kernel_function
+    :mkf
+  end
+end
+
 class TestFlexMockShoulds < Test::Unit::TestCase
 
   def test_defaults
@@ -566,6 +577,26 @@ class TestFlexMockShoulds < Test::Unit::TestCase
     end
   end
 
+  def test_global_methods_can_be_mocked
+    m = FlexMock.new("m")
+    m.should_receive(:mock_top_level_function).and_return(:mock)
+    assert_equal :mock, m.mock_top_level_function
+  end
+
+  def test_kernel_methods_can_be_mocked
+    m = FlexMock.new("m")
+    m.should_receive(:mock_kernel_function).and_return(:mock)
+    assert_equal :mock, m.mock_kernel_function
+  end
+
+  def test_undefing_kernel_methods_dont_effect_other_mocks
+    m = FlexMock.new("m")
+    m2 = FlexMock.new("m2")
+    m.should_receive(:mock_kernel_function).and_return(:mock)
+    assert_equal :mock, m.mock_kernel_function
+    assert_equal :mkf, m2.mock_kernel_function
+  end
+
   def assert_failure
     assert_raises(Test::Unit::AssertionFailedError) do yield end
   end

data/test/test_stubbing.rb

@@ -107,6 +107,15 @@ class TestStubbing < Test::Unit::TestCase
     def m.mock_verify() end
   end
 
+  def test_not_calling_stubbed_method_is_an_error
+    dog = Dog.new
+    flexstub(dog).should_receive(:bark).once
+    assert_raise(Test::Unit::AssertionFailedError) { 
+      flexstub(dog).mock_verify
+    }
+    dog.bark
+  end
+
   def test_mock_is_verified_when_the_stub_is_verified
     obj = Object.new
     stub_proxy = flexstub(obj)

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0.1
 specification_version: 1
 name: flexmock
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
-date: 2006-09-04 00:00:00 -04:00
+  version: 0.4.1
+date: 2006-09-07 00:00:00 -04:00
 summary: Simple and Flexible Mock Objects for Testing
 require_paths: 
 - lib
@@ -45,6 +45,7 @@ files:
 - flexmock.blurb
 - install.rb
 - doc/releases/flexmock-0.4.0.rdoc
+- doc/releases/flexmock-0.4.1.rdoc
 test_files: []
 
 rdoc_options: 
@@ -57,6 +58,7 @@ extra_rdoc_files:
 - README
 - CHANGELOG
 - doc/releases/flexmock-0.4.0.rdoc
+- doc/releases/flexmock-0.4.1.rdoc
 executables: []
 
 extensions: []