flexmock 0.6.1 → 0.6.2

data/CHANGELOG

@@ -1,7 +1,13 @@
-2006-10-17  Jim Weirich  <jim@weirichhouse.org>
-
 = Changes for FlexMock
 
+== Version 0.6.2
+
+* flexmock() with a block now always returns the domain object.
+  flexmock() without a block returns the mock object.  Note that for
+  normal mocks, the domain and mock objects are the same.  For partial
+  mocks, the mock is separate from the domain object.
+* Added +and_raise+ to the list of expection specifications.	
+
 == Version 0.6.1
 
 * Fixed bug that prevented mocks from mocking field assignment operators.

data/README

@@ -3,7 +3,7 @@
 FlexMock is a simple, but flexible, mock object library for Ruby unit
 testing.
 
-Version :: 0.6.1
+Version :: 0.6.2
 
 = Links
 
@@ -236,6 +236,14 @@ object. See theFlexMock::Expectation for more details.
 
   Alias for <tt>and_return</tt>.
 
+* <b>and_raise(exception, *args)</b>
+
+  Declares that the expected messsage will raise the specified
+  exception.  If +exception+ is an exception class, then the raised
+  exception will be constructed from the class with +new+ given the
+  supplied arguments.  If +exception+ is an instance of an exception
+  class, then it will be raised directly.
+
 * <b>zero_or_more_times</b>
 
   Declares that the expected message is may be sent zero or more times

data/Rakefile

@@ -19,7 +19,7 @@ require 'rake/contrib/rubyforgepublisher'
 CLEAN.include('*.tmp')
 CLOBBER.include("html", 'pkg')
 
-PKG_VERSION = '0.6.1'
+PKG_VERSION = '0.6.2'
 
 PKG_FILES = FileList[
   '[A-Z]*',
@@ -66,13 +66,16 @@ end
 
 # RCov Target --------------------------------------------------------
 
-require 'rcov/rcovtask'
-
-Rcov::RcovTask.new do |t|
-  t.libs << "test"
-  t.rcov_opts = ['-xRakefile', '-xrakefile', '-xpublish.rf', '--text-report']
-  t.test_files = FileList['test/test*.rb']
-  t.verbose = true
+begin
+  require 'rcov/rcovtask'
+  
+  Rcov::RcovTask.new do |t|
+    t.libs << "test"
+    t.rcov_opts = ['-xRakefile', '-xrakefile', '-xpublish.rf', '--text-report']
+    t.test_files = FileList['test/test*.rb']
+    t.verbose = true
+  end
+rescue LoadError => ex
 end
 
 # RDoc Target --------------------------------------------------------

data/doc/releases/flexmock-0.6.2.rdoc

@@ -0,0 +1,101 @@
+= FlexMock 0.6.2 Released
+
+FlexMock is a flexible mocking library for use in unit testing and behavior
+specification in Ruby. Version 0.6.2 introduces a two minor enhancements.
+
+== New in 0.6.2
+
+* When creating a partial mock using a block, flexmock() now returns
+  the domain object rather than the mock proxy.  This allows the
+  following to work:
+
+    obj = flexmock(Something.new) { |m| m.should_receive(:hi).once }
+    obj.hi
+
+  See http://onestepback.org/index.cgi/Tech/Ruby/FlexMockReturns.red
+  for more details.
+
+* The +and_raise+ method is now supported for directly specifying that
+  exceptions will be thrown from a mock.
+
+== What is FlexMock?
+
+FlexMock is a flexible framework for creating mock object for testing. When
+running unit tests, it is often desirable to use isolate the objects being
+tested from the "real world" by having them interact with simplified test
+objects. Sometimes these test objects simply return values when called, other
+times they verify that certain methods were called with particular arguments
+in a particular order.
+
+FlexMock makes creating these test objects easy.
+
+=== Features
+
+* Easy integration with both Test::Unit and RSpec. Mocks created with the
+  flexmock method are automatically verified at the end of the test or
+  example.
+
+* 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.
+
+* The ability to cause classes to instantiate test instances (instead of real
+  instances) for the duration of a test.
+
+=== 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/test_unit'
+
+  class TestDog < Test::Unit::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://flexmock.rubyforge.org 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
+
+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://flexmock.rubyforge.org.
+
+-- Jim Weirich
+

data/lib/flexmock/expectation.rb

@@ -139,7 +139,7 @@ class FlexMock
     #  mock.should_receive(:f).with(String). # returns an
     #    returns { |str| str.upcase }        # upcased string
     #
-    # +and_return+ is an alias for +returns+.
+    # +returns+ is an alias for +and_return+.
     #
     def and_return(*args, &block)
       @return_block = 
@@ -152,6 +152,30 @@ class FlexMock
     end
     alias :returns :and_return  # :nodoc:
 
+    
+    # :call-seq:
+    #   and_raise(an_exception)
+    #   and_raise(SomeException)
+    #   and_raise(SomeException, args, ...)
+    #
+    # Declares that the method will raise the given exception (with
+    # an optional message) when executed.
+    #
+    # * If an exception instance is given, then that instance will be
+    #   raised.
+    #   
+    # * If an exception class is given, the exception raised with be
+    #   an instance of that class constructed with +new+.  Any
+    #   additional arguments in the argument list will be passed to
+    #   the +new+ constructor when it is invoked.
+    #   
+    # +raises+ is an alias for +and_return+.
+    #
+    def and_raise(exception, *args)
+      and_return { raise exception, *args }
+    end
+    alias :raises :and_raise
+
     # Declare that the method may be called any number of times.
     def zero_or_more_times
       at_least.never

data/lib/flexmock/mock_container.rb

@@ -13,14 +13,14 @@ require 'flexmock/noop'
 
 class FlexMock
   
-  ####################################################################
+  # ######################################################################
   # Mock container methods
   #
-  # Include this module in 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.
-  # 
+  # Include this module in 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.
+  #   
   module MockContainer
     # Do the flexmock specific teardown stuff.  If you need finer control,
     # you can use either +flexmock_verify+ or +flexmock_close+.
@@ -48,11 +48,10 @@ class FlexMock
       @flexmock_created_mocks = []
     end
     
-    # Create a mocking object in the FlexMock framework.  The +flexmock+ 
-    # method has a number of options available, depending on just what
-    # kind of mocking object your require.  Mocks created via +flexmock+
-    # will be automatically verify during the teardown phase of your 
-    # test framework.
+    # Create a mocking object in the FlexMock framework.  The +flexmock+
+    # method has a number of options available, depending on just what kind of
+    # mocking object your require.  Mocks created via +flexmock+ will be
+    # automatically verify during the teardown phase of your test framework.
     #
     # :call-seq:
     #   flexmock() { |mock| ... }
@@ -64,6 +63,16 @@ class FlexMock
     #   flexmock(real_object, name, expect_hash) { |mock| ... }
     #   flexmock(:base, string, name, expect_hash) { |mock| ... }
     #
+    # <b>Note:</b> A plain flexmock() call without a block will return the
+    # mock object (the object that interprets <tt>should_receive</tt> and its
+    # brethern). A flexmock() call that _includes_ a block will return the
+    # domain objects (the object that will interpret domain messages) since
+    # the mock will be passed to the block for configuration. With regular
+    # mocks, this distinction is unimportant because the mock object and the
+    # domain object are the same object.  However, with partial mocks, the
+    # mock object is separation from the domain object.  Keep that distinciton
+    # in mind.
+    #
     # name ::
     #   Name of the mock object.  If no name is given, "unknown" is used for
     #   full mocks and "flexmock(<em>real_object</em>)" is used for partial
@@ -93,37 +102,40 @@ class FlexMock
     #   partial mock object.  This explicit tag is only needed if you 
     #   want to use a string or a symbol as the mock base (string and
     #   symbols would normally be interpretted as the mock name).
-    # 
+    #       
     # &block ::
     #   If a block is given, then the mock object is passed to the block and
-    #   expectations may be configured within the block.
+    #   expectations may be configured within the block.  When a block is given
+    #   for a partial mock, flexmock will return the domain object rather than 
+    #   the mock object.  
     #
     def flexmock(*args)
       name = nil
       quick_defs = {}
-      stub_target = nil
+      domain_obj = nil
       while ! args.empty?
         case args.first
         when :base
           args.shift
-          stub_target = args.shift
+          domain_obj = args.shift
         when String, Symbol
           name = args.shift.to_s
         when Hash
           quick_defs = args.shift
         else
-          stub_target = args.shift
+          domain_obj = args.shift
         end
       end
-      if stub_target
-        mock = flexmock_make_stub(stub_target, name)
+      if domain_obj
+        mock = flexmock_make_partial_proxy(domain_obj, name)
       else
         mock = FlexMock.new(name || "unknown")
+        domain_obj = mock
       end
       flexmock_quick_define(mock, quick_defs)
       yield(mock) if block_given?
       flexmock_remember(mock)
-      mock
+      block_given? ? domain_obj : mock
     end
     alias flexstub flexmock
     
@@ -131,7 +143,7 @@ class FlexMock
     
     # Create a PartialMock for the given object.  Use +name+ as the name 
     # of the mock object.
-    def flexmock_make_stub(obj, name)
+    def flexmock_make_partial_proxy(obj, name)
       name ||= "flexmock(#{obj.class.to_s})"
       obj.instance_eval {
         @flexmock_proxy ||= PartialMock.new(obj, FlexMock.new(name))

data/test/test_extended_should_receive.rb

@@ -33,8 +33,15 @@ module ExtendedShouldReceiveTests
     assert_equal :baz, @obj.bar(1)
   end
   
+  def test_count_contraints_apply_to_all_expectations
+    @mock.should_receive(:foo, :bar => :baz).once
+    @obj.foo
+    assert_raise(Test::Unit::AssertionFailedError) { @mock.mock_verify }
+  end
+  
   def test_multiple_should_receives_are_allowed
-    @mock.should_receive(:hi).and_return(:bye).should_receive(:hello => :goodbye)
+    @mock.should_receive(:hi).and_return(:bye).
+      should_receive(:hello => :goodbye)
     assert_equal :bye, @obj.hi
     assert_equal :goodbye, @obj.hello
   end

data/test/test_partial_mock.rb

@@ -199,5 +199,20 @@ class TestStubbing < Test::Unit::TestCase
     partial_mock = flexmock(obj)
     assert_equal "flexmock(Object)", partial_mock.mock.mock_name
   end
+
+  def test_partials_can_be_defined_in_a_block
+    dog = Dog.new
+    flexmock(dog) do |m|
+      m.should_receive(:bark).and_return(:growl)
+    end
+    assert_equal :growl, dog.bark
+  end
+
+  def test_partials_defining_block_return_real_obj_not_proxy
+    dog = flexmock(Dog.new) do |m|
+      m.should_receive(:bark).and_return(:growl)
+    end
+    assert_equal :growl, dog.bark
+  end
   
 end

data/test/test_should_receive.rb

@@ -76,6 +76,48 @@ class TestFlexMockShoulds < Test::Unit::TestCase
     end
   end
 
+  class MyError < RuntimeError
+  end
+
+  def test_and_raises_with_exception_class_throws_exception
+    FlexMock.use do |m|
+      m.should_receive(:failure).and_raise(MyError)
+      assert_raise MyError do
+        m.failure
+      end
+    end
+  end
+
+  def test_and_raises_with_arguments_throws_exception_made_with_args
+    FlexMock.use do |m|
+      m.should_receive(:failure).and_raise(MyError, "my message")
+      ex = assert_raise MyError do
+        m.failure
+      end
+      assert_equal "my message", ex.message
+    end
+  end
+
+  def test_and_raises_with_a_specific_exception_throws_the_exception
+    FlexMock.use do |m|
+      err = MyError.new
+      m.should_receive(:failure).and_raise(err)
+      ex = assert_raise MyError do
+        m.failure
+      end
+      assert_equal err, ex
+    end
+  end
+
+  def test_raises_is_an_alias_for_and_raise
+    FlexMock.use do |m|
+      m.should_receive(:failure).raises(RuntimeError)
+      ex = assert_raise RuntimeError do
+        m.failure
+      end
+    end
+  end
+
   def test_multiple_expectations
     FlexMock.use do |m|
       m.should_receive(:hi).with(1).returns(10)

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.2
+rubygems_version: 0.9.4.1
 specification_version: 1
 name: flexmock
 version: !ruby/object:Gem::Version 
-  version: 0.6.1
-date: 2007-05-08 00:00:00 -04:00
+  version: 0.6.2
+date: 2007-06-27 00:00:00 -04:00
 summary: Simple and Flexible Mock Objects for Testing
 require_paths: 
 - lib
@@ -75,6 +75,7 @@ files:
 - doc/releases/flexmock-0.5.1.rdoc
 - doc/releases/flexmock-0.6.0.rdoc
 - doc/releases/flexmock-0.6.1.rdoc
+- doc/releases/flexmock-0.6.2.rdoc
 test_files: []
 
 rdoc_options: 
@@ -95,6 +96,7 @@ extra_rdoc_files:
 - doc/releases/flexmock-0.5.1.rdoc
 - doc/releases/flexmock-0.6.0.rdoc
 - doc/releases/flexmock-0.6.1.rdoc
+- doc/releases/flexmock-0.6.2.rdoc
 executables: []
 
 extensions: []