flexmock 0.6.3 → 0.6.4

data/CHANGES

@@ -1,5 +1,10 @@
 = Changes for FlexMock
 
+== Version 0.6.4
+
+* Renamed flexmodel(...) to flexmock(:model, ...) because visually
+  they were too similar.
+
 == Version 0.6.3
 
 * Added flexmodel() for better support of mocking ActiveRecord models.

data/README

@@ -3,7 +3,7 @@
 FlexMock is a simple, but flexible, mock object library for Ruby unit
 testing.
 
-Version :: 0.6.2.1
+Version :: 0.6.4
 
 = Links
 
@@ -167,10 +167,10 @@ See FlexMock::MockContainer#flexmock for more details.
   passed to the block as an argument. Code in the block can set the desired
   expectations for the mock object.
 
-* <b>mock_model = flexmodel(YourModel, ...) { |mock| mock.should_receive(...) }</b>
+* <b>mock_model = flexmock(:model, YourModel, ...) { |mock| mock.should_receive(...) }</b>
 
-  The flexmodel() method will return a pure mock (not a partial mock)
-  that will have some ActiveRecord specific methods defined.
+  When given :model, flexmock() will return a pure mock (not a partial
+  mock) that will have some ActiveRecord specific methods defined.
   YourModel should be the class of an ActiveRecord model.  These
   predefined methods make it a bit easier to mock out ActiveRecord
   model objects in a Rails application.  Other that the predefined
@@ -186,9 +186,6 @@ See FlexMock::MockContainer#flexmock for more details.
   * is_a?(other) -- returns true if other == YourModel.
   * class -- returns YourModel.
 
-  The flexmodel() method is optional.  You must require
-  'flexmock/activerecord' to enable it.
-
 <b>NOTE:</b>  Versions of FlexMock prior to 0.6.0 used +flexstub+ to create partial mocks.  The +flexmock+ method now assumes all the functionality that was spread out between two different methods.  +flexstub+ is still available for backward compatibility.
 
 === Expectation Declarators

data/Rakefile

@@ -19,7 +19,7 @@ require 'rake/contrib/rubyforgepublisher'
 CLEAN.include('*.tmp')
 CLOBBER.include("html", 'pkg')
 
-PKG_VERSION = '0.6.3'
+PKG_VERSION = '0.6.4'
 
 PKG_FILES = FileList[
   '[A-Z]*',

data/doc/releases/flexmock-0.6.3.rdoc

@@ -1,7 +1,7 @@
-= FlexMock 0.6.2 Released
+= FlexMock 0.6.3 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.
+specification in Ruby. Version 0.6.3 introduces several enhancements.
 
 == New in 0.6.3
 

data/doc/releases/flexmock-0.6.4.rdoc

@@ -0,0 +1,117 @@
+= FlexMock 0.6.4 Released
+
+FlexMock is a flexible mocking library for use in unit testing and
+behavior specification in Ruby. Version 0.6.4 and 0.6.3 introduce
+several enhancements.
+
+== New in 0.6.4 (and 0.6.3)
+
+* Added the flexmock(:model, ...) method for better support when
+  mocking ActiveRecord objects.  flexmock(:model, YourModelClass) will
+  return a pure mock object that responds to some basic ActiveRecord
+  methods with reasonable defaults. 
+
+* The flexmock() method now _always_ returns a combination domain
+  object / mock object.  This means the object return can handle
+  domain methods and mock-specific methods (such as should_receive and
+  mock_teardown).
+
+* A side effect of always returning a domain/mock object is that
+  partial mocks are now enhanced with about 5 or 6 extra methods.
+  Since partial mocks are real objects with just a few methods mocked,
+  there is a (small) potential for a method name conflict.  FlexMock
+  now supports a safe-mode for partial mocks if this is an issue in
+  particular case (see the RDoc README file for more details).
+
+* Fixed a small bug where attempting to mock a method that the partial
+  mock claims to respond to, but doesn't actually have defined would
+  cause an error.  This tended to happen on active record objects
+  where attributes are dynamically handled.
+
+NOTE: 0.6.4 improves the interface for mocking ActiveRecord model
+objects.  The flexmodel() method was too visually similar to
+flexmock() and was to easy to get confused when reading code.  Release
+0.6.3's flexmodel() method has been removed and a new :model mode has
+been added to flexmock(). 
+
+== 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/mock_container.rb

@@ -114,11 +114,15 @@ class FlexMock
       quick_defs = {}
       domain_obj = nil
       safe_mode = false
+      model_class = nil
       while ! args.empty?
         case args.first
         when :base, :safe
           safe_mode = (args.shift == :safe)
           domain_obj = args.shift
+        when :model
+          args.shift
+          model_class = args.shift
         when String, Symbol
           name = args.shift.to_s
         when Hash
@@ -131,20 +135,37 @@ class FlexMock
 
       if domain_obj
         mock = flexmock_make_partial_proxy(domain_obj, name, safe_mode)
+        result = domain_obj
+      elsif model_class
+        id = MockContainer.next_id
+        result = mock = FlexMock.new("#{model_class}_#{id}")
       else
-        mock = FlexMock.new(name || "unknown")
-        domain_obj = mock
+        result = mock = FlexMock.new(name || "unknown")
       end
       flexmock_quick_define(mock, quick_defs)
       yield(mock) if block_given?
       flexmock_remember(mock)
-      block_given? ? domain_obj : mock
-      domain_obj
+      flexmock_mock_model_methods(mock, model_class, id) if model_class
+      result
     end
     alias flexstub flexmock
     
     private
     
+    # Automatically add mocks for some common methods in ActiveRecord
+    # models.
+    def flexmock_mock_model_methods(mock, model_class, id)
+      mock.should_receive(
+        :id => id,
+        :to_params => id.to_s,
+        :new_record? => false,
+        :class => model_class,
+        :errors => flexmock("errors", :count => 0))
+      mock.should_receive(:is_a?).with(any).and_return { |other|
+        other == model_class
+      }
+    end
+
     # Create a PartialMockProxy for the given object.  Use +name+ as
     # the name of the mock object.
     def flexmock_make_partial_proxy(obj, name, safe_mode)
@@ -170,6 +191,11 @@ class FlexMock
       mocking_object.mock_container = self
       mocking_object
     end
+
+    def MockContainer.next_id
+      @id_counter ||= 0
+      @id_counter += 1
+    end
   end
 
 end

data/lib/flexmock/partial_mock.rb

@@ -84,11 +84,12 @@ class FlexMock
 
     def add_mock_method(obj, method_name)
       stow_existing_definition(method_name)
+      eval_line = __LINE__ + 1
       eval %{
         def obj.#{method_name}(*args, &block)
           @flexmock_proxy.#{method_name}(*args, &block)
         end
-      }
+      }, binding, __FILE__, eval_line
     end
 
     # :call-seq:

data/test/test_flexmodel.rb

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 
 require 'test/unit'
-require 'flexmock/activerecord'
 
 class DummyModel
 end
@@ -11,7 +10,7 @@ class TestFlexModel < Test::Unit::TestCase
   include FlexMock::TestCase
 
   def test_initial_conditions
-    model = flexmodel(DummyModel)
+    model = flexmock(:model, DummyModel)
     assert_match(/^DummyModel_\d+/, model.mock_name)
     assert_equal model.id.to_s, model.to_params
     assert ! model.new_record?
@@ -20,21 +19,20 @@ class TestFlexModel < Test::Unit::TestCase
   end
 
   def test_mock_models_have_different_ids
-    m1 = flexmodel(DummyModel)
-    m2 = flexmodel(DummyModel)
+    m1 = flexmock(:model, DummyModel)
+    m2 = flexmock(:model, DummyModel)
     assert m2.id != m1.id
   end
 
   def test_mock_models_can_have_quick_defs
-    model = flexmodel(DummyModel, :xyzzy => :ok)
+    model = flexmock(:model, DummyModel, :xyzzy => :ok)
     assert_equal :ok, model.xyzzy
   end
 
   def test_mock_models_can_have_blocks
-    model = flexmodel(DummyModel) do |m|
+    model = flexmock(:model, DummyModel) do |m|
       m.should_receive(:xyzzy => :okdokay)
     end
     assert_equal :okdokay, model.xyzzy
   end
 end
-

data/test/test_partial_mock.rb

@@ -303,6 +303,7 @@ class TestStubbing < Test::Unit::TestCase
   def test_liar_actually_lies
     liar = Liar.new
     assert liar.respond_to?(:not_defined)
+    assert_raise(NoMethodError) { liar.not_defined }
   end
 
   def test_partial_mock_where_respond_to_is_true_yet_method_is_not_there

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4.1
 specification_version: 1
 name: flexmock
 version: !ruby/object:Gem::Version 
-  version: 0.6.3
-date: 2007-08-16 00:00:00 -04:00
+  version: 0.6.4
+date: 2007-08-17 00:00:00 -04:00
 summary: Simple and Flexible Mock Objects for Testing
 require_paths: 
 - lib
@@ -34,7 +34,6 @@ files:
 - README
 - TAGS
 - lib/flexmock.rb
-- lib/flexmock/activerecord.rb
 - lib/flexmock/argument_matchers.rb
 - lib/flexmock/argument_types.rb
 - lib/flexmock/base.rb
@@ -80,6 +79,7 @@ files:
 - doc/releases/flexmock-0.6.1.rdoc
 - doc/releases/flexmock-0.6.2.rdoc
 - doc/releases/flexmock-0.6.3.rdoc
+- doc/releases/flexmock-0.6.4.rdoc
 test_files: []
 
 rdoc_options: 
@@ -102,6 +102,7 @@ extra_rdoc_files:
 - doc/releases/flexmock-0.6.1.rdoc
 - doc/releases/flexmock-0.6.2.rdoc
 - doc/releases/flexmock-0.6.3.rdoc
+- doc/releases/flexmock-0.6.4.rdoc
 executables: []
 
 extensions: []

data/lib/flexmock/activerecord.rb

@@ -1,27 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'flexmock'
-
-class FlexMock
-  module MockContainer
-    def MockContainer.next_id
-      @id_counter ||= 0
-      @id_counter += 1
-    end
-
-    def flexmodel(model_class, *args, &block)
-      id = MockContainer.next_id
-      mock = flexmock("#{model_class}_#{id}", *args, &block)
-      mock.should_receive(
-        :id => id,
-        :to_params => id.to_s,
-        :new_record? => false,
-        :errors => flexmock("errors", :count => 0), 
-        :class => model_class)
-      mock.should_receive(:is_a?).with(any).and_return { |other|
-        other == model_class
-      }
-      mock
-    end
-  end
-end