flexmock 0.8.11 → 0.9.0

data/doc/releases/flexmock-0.9.0.rdoc

@@ -0,0 +1,89 @@
+= FlexMock 0.9.0 Released
+
+FlexMock is a flexible mocking library for use in unit testing and
+behavior specification in Ruby.  Release 0.8.5 is a minor release with
+a few bug fixes.
+
+== Ruby 1.9.3 Compatibility
+
+* Fixed a number of minor warnings reported by the 1.9.3 version of Ruby.
+
+== 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.
+
+* Easy mocking of chains of method calls.
+
+* 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)
+
+You will find documentation at: http://flexmock.rubyforge.org.
+
+-- Jim Weirich
+

data/lib/flexmock.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 #---
-# Copyright 2003, 2004, 2005, 2006, 2007 by Jim Weirich (jim@weirichhouse.org).
+# Copyright 2003-2011 by Jim Weirich (jim@weirichhouse.org).
 # All rights reserved.
 
 # Permission is granted for use, copying, modification, distribution,

data/lib/flexmock/argument_matchers.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 #---
-# Copyright 2003, 2004, 2005, 2006, 2007 by Jim Weirich (jim@weirichhouse.org).
+# Copyright 2003-2011 by Jim Weirich (jim@weirichhouse.org).
 # All rights reserved.
 #
 # Permission is granted for use, copying, modification, distribution,
@@ -52,7 +52,7 @@ class FlexMock
       "on{...}"
     end
   end
-  
+
   ####################################################################
   # Match only things where the block evaluates to true.
   class HashMatcher
@@ -66,7 +66,7 @@ class FlexMock
       "hsh(#{@hash.inspect})"
     end
   end
-  
+
   ####################################################################
   # Match only things where the block evaluates to true.
   class DuckMatcher
@@ -80,6 +80,6 @@ class FlexMock
       "ducktype(#{@methods.map{|m| m.inspect}.join(',')})"
     end
   end
-  
-  
+
+
 end

data/lib/flexmock/argument_types.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 #---
-# Copyright 2003, 2004, 2005, 2006, 2007 by Jim Weirich (jim@weirichhouse.org).
+# Copyright 2003-2011 by Jim Weirich (jim@weirichhouse.org).
 # All rights reserved.
 
 # Permission is granted for use, copying, modification, distribution,

data/lib/flexmock/base.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 #---
-# Copyright 2003, 2004, 2005, 2006, 2007 by Jim Weirich (jim@weirichhouse.org).
+# Copyright 2003-2011 by Jim Weirich (jim@weirichhouse.org).
 # All rights reserved.
 
 # Permission is granted for use, copying, modification, distribution,

data/lib/flexmock/core.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 #---
-# Copyright 2003, 2004, 2005, 2006, 2007 by Jim Weirich (jim@weirichhouse.org).
+# Copyright 2003-2011 by Jim Weirich (jim@weirichhouse.org).
 # All rights reserved.
 #
 # Permission is granted for use, copying, modification, distribution,
@@ -16,7 +16,7 @@ require 'flexmock/ordering'
 ######################################################################
 # FlexMock is a flexible mock object framework for supporting testing.
 #
-# FlexMock has a simple interface that's easy to remember, and leaves 
+# FlexMock has a simple interface that's easy to remember, and leaves
 # the hard stuff to all those other mock object implementations.
 #
 # Basic Usage:
@@ -166,7 +166,7 @@ class FlexMock
     end
     @last_expectation
   end
-  
+
   # 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
@@ -194,8 +194,8 @@ class FlexMock
     "in mock '#{@flexmock_name}': #{ex.message}",
     ex.backtrace
   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

data/lib/flexmock/core_class_methods.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 #---
-# Copyright 2003, 2004, 2005, 2006, 2007 by Jim Weirich (jim@weirichhouse.org).
+# Copyright 2003-2011 by Jim Weirich (jim@weirichhouse.org).
 # All rights reserved.
 
 # Permission is granted for use, copying, modification, distribution,
@@ -41,7 +41,7 @@ class FlexMock
       container = UseContainer.new
       mocks = names.collect { |n| container.flexmock(n) }
       yield(*mocks)
-    rescue Exception => ex
+    rescue Exception => _
       container.got_exception = true
       raise
     ensure
@@ -66,16 +66,16 @@ class FlexMock
 
   end
 
-  # Container object to be used by the FlexMock.use method.  
+  # Container object to be used by the FlexMock.use method.
   class UseContainer
     include MockContainer
-    
+
     attr_accessor :got_exception
-    
+
     def initialize
       @got_exception = false
     end
-    
+
     def passed?
       ! got_exception
     end

data/lib/flexmock/default_framework_adapter.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 #---
-# Copyright 2003, 2004, 2005, 2006, 2007 by Jim Weirich (jim@weirichhouse.org).
+# Copyright 2003-2011 by Jim Weirich (jim@weirichhouse.org).
 # All rights reserved.
 
 # Permission is granted for use, copying, modification, distribution,
@@ -28,4 +28,4 @@ class FlexMock
       AssertionFailedError
     end
   end
-end
+end

data/lib/flexmock/deprecated_methods.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 #---
-# Copyright 2003, 2004, 2005, 2006, 2007 by Jim Weirich (jim@weirichhouse.org).
+# Copyright 2003-2011 by Jim Weirich (jim@weirichhouse.org).
 # All rights reserved.
 #
 # Permission is granted for use, copying, modification, distribution,

data/lib/flexmock/errors.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 #---
-# Copyright 2003, 2004, 2005, 2006, 2007 by Jim Weirich (jim@weirichhouse.org).
+# Copyright 2003-2011 by Jim Weirich (jim@weirichhouse.org).
 # All rights reserved.
 #
 # Permission is granted for use, copying, modification, distribution,

data/lib/flexmock/expectation.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 #---
-# Copyright 2003, 2004, 2005, 2006, 2007 by Jim Weirich (jim@weirichhouse.org).
+# Copyright 2003-2011 by Jim Weirich (jim@weirichhouse.org).
 # All rights reserved.
 
 # Permission is granted for use, copying, modification, distribution,
@@ -12,7 +12,7 @@
 require 'flexmock/noop'
 
 class FlexMock
-  
+
   ####################################################################
   # An Expectation is returned from each +should_receive+ message sent
   # to mock object.  Each expectation records how a message matching
@@ -69,7 +69,7 @@ class FlexMock
     def return_value(args)
       case @return_queue.size
       when 0
-        block = lambda { |*args| @return_value }
+        block = lambda { |*a| @return_value }
       when 1
         block = @return_queue.first
       else
@@ -85,7 +85,7 @@ class FlexMock
       unless @yield_queue.empty?
         block = args.last
         values = (@yield_queue.size == 1) ? @yield_queue.first : @yield_queue.shift
-        if block && block.respond_to?(:call) 
+        if block && block.respond_to?(:call)
           @return_value = block.call(*values)
         else
           fail MockError, "No Block given to mock with 'and_yield' expectation"
@@ -103,7 +103,7 @@ class FlexMock
     # Is this expectation constrained by any call counts?
     def call_count_constrained?
       ! @count_validators.empty?
-    end      
+    end
 
     # Validate that the order
     def validate_order
@@ -186,7 +186,7 @@ class FlexMock
     # +returns+ is an alias for +and_return+.
     #
     def and_return(*args, &block)
-      if block_given? 
+      if block_given?
         @return_queue << block
       else
         args.each do |arg|
@@ -230,7 +230,7 @@ class FlexMock
     end
     alias :yields :and_yield
 
-    
+
     # :call-seq:
     #   and_raise(an_exception)
     #   and_raise(SomeException)
@@ -241,12 +241,12 @@ class FlexMock
     #
     # * 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_raise+.
     #
     def and_raise(exception, *args)
@@ -418,7 +418,7 @@ class FlexMock
 
     # The following methods return a value, so we make an arbitrary choice
     # and return the value for the first expectation in the composite.
-    
+
     # Return the order number of the first expectation in the list.
     def order_number
       @expectations.first.order_number
@@ -428,7 +428,7 @@ class FlexMock
     def mock
       @expectations.first.mock
     end
-    
+
     # Start a new method expectation.  The following constraints will be
     # applied to the new expectation.
     def should_receive(*args, &block)
@@ -462,7 +462,7 @@ class FlexMock
       @expectations << [sym, args, block]
       self
     end
-    
+
     # Apply the recorded messages to the given object in a chaining fashion
     # (i.e. the result of the previous call is used as the target of the next
     # call).

data/lib/flexmock/expectation_director.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 #---
-# Copyright 2003, 2004, 2005, 2006, 2007 by Jim Weirich (jim@weirichhouse.org).
+# Copyright 2003-2011 by Jim Weirich (jim@weirichhouse.org).
 # All rights reserved.
 
 # Permission is granted for use, copying, modification, distribution,

data/lib/flexmock/mock_container.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 #---
-# Copyright 2003, 2004, 2005, 2006, 2007 by Jim Weirich (jim@weirichhouse.org).
+# Copyright 2003-2011 by Jim Weirich (jim@weirichhouse.org).
 # All rights reserved.
 
 # Permission is granted for use, copying, modification, distribution,
@@ -29,7 +29,7 @@ class FlexMock
     # Do the flexmock specific teardown stuff.  If you need finer control,
     # you can use either +flexmock_verify+ or +flexmock_close+.
     def flexmock_teardown
-      flexmock_verify if passed?
+      flexmock_verify unless flexmock_test_has_failed?
     ensure
       flexmock_close
     end
@@ -164,6 +164,16 @@ class FlexMock
       mocking_object.flexmock_container = self
       mocking_object
     end
+
+    private
+
+    # In frameworks (e.g. MiniTest) passed? will return nil to
+    # indicate the test isn't over yet.  From our point of view we are
+    # only interested if the test has actually failed, so we wrap the
+    # raw call to passed? and handle accordingly.
+    def flexmock_test_has_failed?
+      passed? == false
+    end
   end
 
   # #################################################################

data/lib/flexmock/noop.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 #---
-# Copyright 2003, 2004, 2005, 2006, 2007 by Jim Weirich (jim@weirichhouse.org).
+# Copyright 2003-2011 by Jim Weirich (jim@weirichhouse.org).
 # All rights reserved.
 
 # Permission is granted for use, copying, modification, distribution,
@@ -10,4 +10,4 @@
 #+++
 
 # No-op include file.  Used as a kludge so that only the comments in the
-# core.rb file are applied to the FlexMock class.
+# core.rb file are applied to the FlexMock class.

data/lib/flexmock/ordering.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 #---
-# Copyright 2003, 2004, 2005, 2006, 2007 by Jim Weirich (jim@weirichhouse.org).
+# Copyright 2003-2011 by Jim Weirich (jim@weirichhouse.org).
 # All rights reserved.
 
 # Permission is granted for use, copying, modification, distribution,

data/lib/flexmock/partial_mock.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 #---
-# Copyright 2003, 2004, 2005, 2006, 2007 by Jim Weirich (jim@weirichhouse.org).
+# Copyright 2003-2011 by Jim Weirich (jim@weirichhouse.org).
 # All rights reserved.
 
 # Permission is granted for use, copying, modification, distribution,
@@ -125,6 +125,7 @@ class FlexMock
       allocators = [:new] if allocators.empty?
       result = ExpectationRecorder.new
       allocators.each do |allocate_method|
+        check_allocate_method(allocate_method)
         # HACK: Without the following lambda, Ruby 1.9 will not bind
         # the allocate_method parameter correctly.
         lambda { }
@@ -182,6 +183,12 @@ class FlexMock
 
     private
 
+    def check_allocate_method(allocate_method)
+      if allocate_method == :allocate && RUBY_VERSION >= "1.9"
+        fail UsageError, "Cannot mock the allocation method using new_instances in Ruby 1.9"
+      end
+    end
+
     # The singleton class of the object.
     def sclass
       class << @obj; self; end
@@ -235,7 +242,7 @@ class FlexMock
           end
         end
         new_alias
-      rescue NameError => ex
+      rescue NameError => _
         # Alias attempt failed
         nil
       end
@@ -259,7 +266,7 @@ class FlexMock
             instance_variable_get('@flexmock_proxy').mock.#{method_name}(*args, &block)
           end
         }, __FILE__, eval_line
-        make_rcov_recognize_the_above_eval_is_covered = true
+        _ = true       # make rcov recognize the above eval is covered
       end
     end