flexmock 0.2.1 → 0.3.0

data/CHANGELOG

@@ -1,5 +1,9 @@
 = Changes for FlexMock
 
+== Version 0.3.0
+
+* Added Test::Unit integration.
+
 == Version 0.2.1
 
 * Added strict mode in record mode interface to facility using known

data/README

@@ -3,7 +3,7 @@
 FlexMock is a simple mock object for unit testing.  The interface is
 simple, but still provides a good bit of flexibility.
 
-Version :: 0.2.1
+Version :: 0.3.0
 
 = Links
 
@@ -37,14 +37,19 @@ Here's the complete example:
   end
 
   class TestTemperatureSampler < Test::Unit::TestCase
+    include FlexMock::TestCase
+
     def test_tempurature_sampler
       readings = [10, 12, 14]
-      FlexMock.use("temp") do |sensor|
-        sensor.should_receive(:read_temperature).and_return { readings.shift }
+      sensor = flexmock("temp")
+      sensor.should_receive(:read_temperature).and_return { readings.shift }
+
+      sampler = TemperatureSampler.new(sensor)
+      assert_equal 12, sampler.average_temp
 
-        sampler = TemperatureSampler.new(sensor)
-        assert_equal 12, sampler.average_temp
-      end
+      # NOTE:
+      # all mocks created by the +flexmock+ method will be
+      # automatically verified during the test teardown.
     end
   end
 
@@ -180,19 +185,21 @@ The following rules are used for argument matching:
 
   Examples:
 
-      with(FlexMock.eq(Integer))    will match       f(Integer)
-      with(FlexMock.eq(Integer))    will NOT match   f(3)
-
-  If the user includes the FlexMock::ArgumentTypes module in the test
-  class, the above examples can be shortened to:
-
       with(eq(Integer))             will match       f(Integer)
       with(eq(Integer))             will NOT match   f(3)
 
+  Note: If you do not use the FlexMock::TestCase Test Unit integration
+  module, or the FlexMock::ArgumentTypes module, you will have to
+  fully qualify the +eq+ method:
+
+      with(FlexMock.eq(Integer))    will match       f(Integer)
+      with(FlexMock.eq(Integer))    will NOT match   f(3)
+
 * If you wish to match _anything_, then use the <tt>FlexMock.any</tt>
   method in the with argument list.
 
-  Examples (assumes FlexMock::ArguementTypes has been included):
+  Examples (assumes either the FlexMock::TestCase or
+  FlexMock::ArgumentTypes mix-ins has been included):
 
       with(any)             will match       f(3)
       with(any)             will match       f("hello")
@@ -215,17 +222,26 @@ The following rules are used for argument matching:
 The queries my have any arguments.  The update must have a specific
 argument of 5.
 
-   FlexMock('db').use |db|
-     db.should_receive(:query).and_return([1,2,3])
-     db.should_receive(:update).with(5).and_return(nil).once
-     # test code here
+   class TestDb
+     include FlexMock::TestCase         
+
+     def test_db
+       db = flexmock('db')
+       db.should_receive(:query).and_return([1,2,3])
+       db.should_receive(:update).with(5).and_return(nil).once
+       # test code here
+     end
    end
 
 === Expect all queries before any updates
 
+(This and following examples assume that the FlexMock::TestCase module
+is being used.)
+
 All the query message must occur before any of the update messages.
 
-   FlexMock('db').use |db|
+   def test_query_and_update
+     db = flexmock('db')
      db.should_receive(:query).and_return([1,2,3]).ordered
      db.should_recieve(:update).and_return(nil).ordered
      # test code here
@@ -243,7 +259,8 @@ Startup and finish must also happen exactly once.
 Also note that we use the +with+ method to match different arguement
 values to figure out what value to return.
 
-   FlexMock('db').use |db|
+   def test_ordered_queries
+     db = flexmock('db')
      db.should_receive(:startup).once.ordered
      db.should_receive(:query).with("CPWR").and_return(12.3).
        once.ordered(:queries)
@@ -262,7 +279,8 @@ The record mode interface offers much the same features as the
 messages to be sent directly to a recording object rather than be
 specified indirectly using a symbol. 
 
-   FlexMock('db').use |db|
+   def test_ordered_queries_in_record_mode
+     db = flexmock('db')
      db.should_expect do |rec|
        rec.startup.once.ordered
        rec.query("CPWR") { 12.3 }.once.ordered(:queries)
@@ -286,7 +304,8 @@ matching on argument lists, and strict ordering of the method calls.
 objects, because the query responses cannot be programmed into the
 recorder object.
 
-  FlexMock.use('builder') do |builder|
+  def test_build_xml
+    builder = flexmock('builder')
     builder.should_expect do |rec|
       rec.should_be_strict
       known_good_way_to_build_xml(rec)  # record the messages
@@ -300,7 +319,8 @@ Sometimes you need to return different values for each call to a
 mocked method.  This example shifts values out of a list for this
 effect.
 
-   FlexMock('file').use |file|
+   def test_multiple_gets
+     file = flexmock('file')
      return_values = ["line 1\n", "line 2\n"]
      file.should_receive(:gets).with_no_args.and_return { return_values.shift }
      # test code here
@@ -313,7 +333,8 @@ interesting value or wish to assert were sent in a particular manner.
 Use the +should_ignore_missing+ method to turn on missing method
 ignoring.
 
-   FlexMock('m').use |m|
+   def test_an_important_message
+     m = flexmock('m')
      m.should_recieve(:an_important_message).and_return(1).once
      m.should_ignore_missing
      # test code here
@@ -339,7 +360,7 @@ test-unit-mock :: http://www.deveiate.org/code/Test-Unit-Mock.shtml
 
 == License
 
-Copyright 2003, 2004, 2005 by Jim Weirich (jim@weirichhouse.org).
+Copyright 2003, 2004, 2005, 2006 by Jim Weirich (jim@weirichhouse.org).
 All rights reserved.
 
 Permission is granted for use, copying, modification, distribution,

data/Rakefile

@@ -8,7 +8,7 @@ require 'rake/testtask'
 
 CLOBBER.include("html", 'pkg')
 
-PKG_VERSION = '0.2.1'
+PKG_VERSION = '0.3.0'
 
 PKG_FILES = FileList[
   '[A-Z]*',
@@ -137,6 +137,13 @@ end
 
 SVNHOME = 'svn://localhost/software/flexmock'
 
+task :specs do
+  specs = FileList['test/spec_*.rb']
+  ENV['RUBYLIB'] = "lib:test:#{ENV['RUBYLIB']}"
+  sh %{spec #{specs}}
+end
+
 task :tag do
   sh %{svn copy #{SVNHOME}/trunk #{SVNHOME}/tags/rel-#{PKG_VERSION} -m 'Release #{PKG_VERSION}'}
 end
+

data/lib/flexmock.rb

@@ -30,9 +30,22 @@ require 'test/unit'
 #   m.should_receive(:downcase).with(String).
 #     returns { |s| s.downcase }.once
 #
-  class FlexMock
-  end
-
+# With Test::Unit Integration:
+#
+#   class TestSomething < Test::Unit::TestCase
+#     include FlexMock::TestCase
+#
+#     def test_something
+#       m = flexmock("name")
+#       m.should_receive(:hi).and_return("Hello")
+#       m.hi
+#     end
+#   end
+#
+# Note: When using Test::Unit integeration, don't forget to include
+# FlexMock::TestCase.  Also, if you override +teardown+, make sure you
+# call +super+.
+#
 class FlexMock
   include Test::Unit::Assertions
 
@@ -156,6 +169,10 @@ class FlexMock
     #       returns(0).once
     #   end                               # mock is verified here
     #
+    # NOTE: If you include FlexMock::TestCase into your test case
+    # file, you can create moks that will be automatically verified in
+    # the test teardown by using the +flexmock+ method. 
+    #
     def use(*names)
       names = ["unknown"] if names.empty?
       got_excecption = false
@@ -313,6 +330,7 @@ class FlexMock
       ProcMatcher.new(&block)
     end
   end
+  extend ArgumentTypes
 
   ####################################################################
   # Base class for all the count validators.
@@ -648,5 +666,45 @@ class FlexMock
     end
   end
   
-  extend ArgumentTypes
+  ####################################################################
+  # Test::Unit::TestCase Integration.
+  #
+  # Include this module in any TestCase class in a Test::Unit test
+  # suite to get integration with FlexMock.  When this module is
+  # included, mocks may be created with a simple call to the
+  # +flexmock+ method.  Mocks created with via the method call will
+  # automatically be verified in the teardown of the test case.
+  #
+  # <b>Note:</b> If you define a +teardown+ method in the test case,
+  # <em>dont' forget to invoke the +super+ method!</em> Failure to
+  # invoke super will cause all mocks to not be verified.
+  #
+  module TestCase
+    include ArgumentTypes
+
+    # Teardown the test case, verifying any mocks that might have been
+    # defined in this test case.
+    def teardown
+      super
+      flexmock_teardown
+    end
+    
+    # Do the flexmock specific teardown stuff.
+    def flexmock_teardown
+      return if @flexmock_created_mocks.nil?
+      @flexmock_created_mocks.each do |m|
+        m.mock_verify
+      end
+    end
+
+    # Create a FlexMock object with the given name.  Mocks created
+    # with this method will be automatically verify during teardown
+    # (assuming the the flexmock teardown isn't overridden).
+    def flexmock(name="unknown")
+      result = FlexMock.new(name)
+      @flexmock_created_mocks ||= []
+      @flexmock_created_mocks << result
+      result
+    end
+  end
 end

data/test/test_tu_integration.rb

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+
+require 'test/unit'
+require 'flexmock'
+
+class TestTuIntegrationMockVerificationInTeardown < Test::Unit::TestCase
+  include FlexMock::TestCase
+
+  def setup
+    super
+  end
+
+  def teardown
+    assert_raise(Test::Unit::AssertionFailedError) do
+      super
+    end
+  end
+
+  def test_mock_verification_occurs_during_teardown
+    flexmock("xyz").should_receive(:hi).with(any).once
+  end
+end
+
+class TestTuIntegrationMockVerificationWithoutSetup < Test::Unit::TestCase
+  include FlexMock::TestCase
+
+  def teardown
+    assert_raise(Test::Unit::AssertionFailedError) do
+      super
+    end
+  end
+
+  def test_mock_verification_occurs_during_teardown
+    flexmock("xyz").should_receive(:hi).with(any).once
+  end
+end
+
+class TestTuIntegrationMockVerificationForgetfulSetup < Test::Unit::TestCase
+  include FlexMock::TestCase
+
+  def setup
+  end
+
+  def teardown
+    assert_raise(Test::Unit::AssertionFailedError) do
+      super
+    end
+  end
+
+  def test_mock_verification_occurs_during_teardown
+    flexmock("xyz").should_receive(:hi).with(any).once
+  end
+end
+
+class TestTuIntegrationSetupOverridenAndNoMocksOk < Test::Unit::TestCase
+  include FlexMock::TestCase
+
+  def setup
+  end
+
+  def test_mock_verification_occurs_during_teardown
+  end
+end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.11.5
+rubygems_version: 0.8.11.15
 specification_version: 1
 name: flexmock
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
-date: 2006-03-21 00:00:00 -05:00
+  version: 0.3.0
+date: 2006-05-14 00:00:00 -04:00
 summary: Simple and Flexible Mock Objects for Testing
 require_paths: 
 - lib
@@ -25,6 +25,7 @@ required_ruby_version: !ruby/object:Gem::Version::Requirement
 platform: ruby
 signing_key: 
 cert_chain: 
+post_install_message: 
 authors: 
 - Jim Weirich
 files: 
@@ -32,12 +33,13 @@ files:
 - Rakefile
 - README
 - lib/flexmock.rb
-- test/test_should_receive.rb
 - test/test_record_mode.rb
+- test/test_should_receive.rb
 - test/test_samples.rb
 - test/test_mock.rb
 - test/test_naming.rb
 - test/test_example.rb
+- test/test_tu_integration.rb
 - flexmock.blurb
 - install.rb
 test_files: []