flexmock 1.2.0 → 1.3.0

data/doc/releases/flexmock-1.3.0.rdoc

@@ -0,0 +1,165 @@
+= FlexMock 1.3.0 Released
+
+FlexMock is a flexible mocking library for use in unit testing and
+behavior specification in Ruby. This release is a minor release with a
+few bug fixes and some simple features.
+
+== Changes in 1.3.0
+
+=== Features
+
+* Add 'and' and 'on' modifiers for the RSpec spy matcher.
+
+* Add 'and' and 'on' options to the assert_spy_called test method.
+
+* General documentation improvement.
+
+=== Bug Fixes
+
+* Fix bug in should_fail test helper that was not detecting failed
+  failures.
+
+== Changes in 1.2.0
+
+=== Features
+
+* Add auto configure by requiring 'flexmock/rspec/configure'.
+
+== Changes in 1.1.0
+
+=== Features
+
+* Add block support to pass_thru.
+
+== Changes in 1.0.0
+
+=== Features
+
+* Mocks may now have a base class that limits what methods may be
+  mocked. This allows early detection of outdated mock setups when the
+  methods in the class are refactored.
+
+* Spy assertions are now allowed. The verification of the calling of
+  mocked methods may now be done in the "then" portion of the test,
+  after the code under test has been run. This allows for much more
+  natural Given/When/Then style testing.
+
+* A custom assert method (assert_spy_called) has been added to make
+  spy assertions easy when using Test::Unit or MiniTest.
+
+* An RSpec matcher (have_received) has been added to make spy
+  assertions easy when using RSpec.
+
+=== Bug Fixes
+
+* Now correctly handling the mocking of meta-programmed methods.
+
+* Using the documented +singleton_methods+ method.
+
+* Accidently trying to partial mock a regular mock is now a no-op.
+
+== 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:
+
+  RSpec.configure do |config|
+    config.mock_with :flexmock
+  end
+
+  describe Dog do
+    it "wags its tail when happy" do
+      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.
+
+Here's the same thing using the new spy support:
+
+  describe Dog do
+    it "wags its tail when happy" do
+      tail = flexmock("tail")
+      dog = Dog.new(tail)
+      dog.happy
+      tail.should have_received(:wag)
+    end
+  end
+
+This style works particularly well with the rspec-given library.
+
+  require 'rspec/given'
+
+  describe Dog do
+    context "when the dog is happy" do
+      Given(:tail) { flexmock(:on, Tail) }
+      Given(:dog) { Dog.new(tail) }
+
+      When { dog.happy }
+
+      Then { tail.should have_received(:wag) }
+    end
+  end
+
+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/core.rb

@@ -99,12 +99,26 @@ class FlexMock
     self
   end
 
-  CallRecord = Struct.new(:method_name, :args, :expectation)
+  CallRecord = Struct.new(:method_name, :args, :block_given, :expectation) do
+    def matches?(sym, actual_args, options)
+      method_name == sym &&
+        ArgumentMatching.all_match?(actual_args, args) &&
+        matches_block?(options[:with_block])
+    end
+
+    private
+
+    def matches_block?(block_option)
+      block_option.nil? ||
+        (block_option && block_given) ||
+        (!block_option && !block_given)
+    end
+  end
 
   # Handle missing methods by attempting to look up a handler.
   def method_missing(sym, *args, &block)
     enhanced_args = block_given? ? args + [block] : args
-    call_record = CallRecord.new(sym, enhanced_args)
+    call_record = CallRecord.new(sym, enhanced_args, block_given?)
     @calls << call_record
     flexmock_wrap do
       if handler = @expectations[sym]
@@ -146,8 +160,15 @@ class FlexMock
   # True if the mock received the given method and arguments.
   def flexmock_received?(sym, args, options={})
     count = 0
+    additional = options[:and] || []
+    additional = [additional] if additional.is_a?(Proc)
     @calls.each { |call_record|
-      count += 1 if (call_record.method_name == sym) && ArgumentMatching.all_match?(args, call_record.args)
+      if call_record.matches?(sym, args, options)
+        count += 1
+        if options[:on_count].nil? || count == options[:on_count]
+          additional.each do |add| add.call(*call_record.args) end
+        end
+      end
     }
     if options[:times]
       result = count == options[:times]

data/lib/flexmock/rspec_spy_matcher.rb

@@ -12,13 +12,12 @@ class FlexMock
         @block = nil
         @times = nil
         @needs_block = nil
+        @additional_validations = []
       end
 
       def matches?(spy)
         @spy = spy
-        @options = {}
-        @options[:times] = @times if @times
-        @options[:with_block] = @needs_block unless @needs_block.nil?
+        @options = construct_options
         @spy.flexmock_received?(@method_name, @args, @options)
       end
 
@@ -61,6 +60,25 @@ class FlexMock
       def twice
         times(2)
       end
+
+      def on(on_count)
+        @on_count = on_count
+        self
+      end
+
+      def and(&block)
+        @additional_validations << block
+        self
+      end
+
+      def construct_options
+        {
+          :times      => @times,
+          :with_block => @needs_block,
+          :on_count   => @on_count,
+          :and        => @additional_validations,
+        }
+      end
     end
 
     def have_received(method_name)

data/lib/flexmock/version.rb

@@ -2,7 +2,7 @@ class FlexMock
   module Version
     NUMBERS = [
       MAJOR = 1,
-      MINOR = 2,
+      MINOR = 3,
       BUILD = 0,
     ]
   end

data/test/rspec_integration/spy_example_spec.rb

@@ -22,23 +22,27 @@ describe "Dog" do
       dog.wags(:tail)
     end
 
-    it "wags the tail" do
+    it "accepts no with" do
+      dog.should have_received(:wags)
+    end
+
+    it "accepts with restriction" do
       dog.should have_received(:wags).with(:tail)
     end
 
-    it "does not bark the tail" do
+    it "accepts not methods called" do
       dog.should_not have_received(:bark)
     end
 
-    it "rejects wag(:foot)" do
+    it "rejects incorrect with restriction" do
       should_fail(/^expected wag\(:foot\) to be received by <FlexMock:Dog Mock>/i) do
         dog.should have_received(:wag).with(:foot)
       end
     end
 
-    it "rejects not wag(:tail)" do
-      should_fail(/^expected wag\(:foot\) to be received by <FlexMock:Dog Mock>/i) do
-        dog.should_not have_received(:wag).with(:tail)
+    it "rejects not on correct matcher" do
+      should_fail(/^expected wags\(:tail\) to NOT be received by <FlexMock:Dog Mock>/i) do
+        dog.should_not have_received(:wags).with(:tail)
       end
     end
   end
@@ -102,6 +106,65 @@ describe "Dog" do
     end
   end
 
+  context "with additional validations" do
+    it "accepts when correct" do
+      dog.wags(:tail)
+      dog.should have_received(:wags).and { |arg| arg.should == :tail }
+    end
+
+    it "rejects when incorrect" do
+      dog.wags(:tail)
+      should_fail(/expected: :foot.*got: :tail/im) do
+        dog.should have_received(:wags).and { |arg| arg.should == :foot }
+      end
+    end
+
+    it "rejects on all calls" do
+      dog.wags(:foot)
+      dog.wags(:foot)
+      dog.wags(:tail)
+      should_fail(/expected: :foot.*got: :tail/im) do
+        dog.should have_received(:wags).and { |arg| arg.should == :foot }
+      end
+    end
+
+    it "runs the first additional block" do
+      dog.wags(:tail)
+      should_fail(/expected: :foot.*got: :tail/im) do
+        dog.should have_received(:wags).and { |args|
+          args.should == :foot
+        }.and { |args|
+          args.should == :tail
+        }
+      end
+    end
+
+    it "runs the second additional block" do
+      dog.wags(:tail)
+      should_fail(/expected: :foot.*got: :tail/im) do
+        dog.should have_received(:wags).and { |args|
+          args.should == :tail
+        }.and { |args|
+          args.should == :foot
+        }
+      end
+    end
+  end
+
+  context "with ordinal constraints" do
+    it "detects the first call" do
+      dog.wags(:tail)
+      dog.wags(:foot)
+      dog.should have_received(:wags).and { |arg| arg.should == :tail }.on(1)
+    end
+
+    it "detects the second call" do
+      dog.wags(:tail)
+      dog.wags(:foot)
+      dog.should have_received(:wags).and { |arg| arg.should == :foot }.on(2)
+    end
+  end
+
   context "with blocks" do
     before do
       dog.wags { }
@@ -126,16 +189,19 @@ describe "Dog" do
 
     it "rejects barks with a block" do
       should_fail(/with a block/) do
-        dog.should have_received(:wags).with_a_block
+        dog.should have_received(:barks).with_a_block
       end
     end
   end
 
   def should_fail(message_pattern)
+    failed = false
     begin
       yield
     rescue RSpec::Expectations::ExpectationNotMetError => ex
+      failed = true
       ex.message.should match(message_pattern)
     end
+    RSpec::Expectations.fail_with "Expected block to fail with message #{message_pattern.inspect}, no failure detected" unless failed
   end
 end

data/test/spys_test.rb

@@ -90,6 +90,59 @@ class TestSpys < Test::Unit::TestCase
     assert_spy_called @spy, :foo, Proc
   end
 
+  def test_spy_accepts_correct_additional_validations
+    @spy.foo(2)
+    is_even = proc { |n| assert_equal 0, n%2 }
+    assert_spy_called @spy, { and: is_even }, :foo, Integer
+  end
+
+  def test_spy_accepts_multiple_additional_validations_first_failing
+    @spy.foo(4)
+    is_two  = proc { |n| assert_equal 2, n }
+    is_even = proc { |n| assert_equal 0, n%2 }
+    assert_failed(/2.*expected but was.*4/mi) do
+      assert_spy_called @spy, { and: [is_two, is_even] }, :foo, Integer
+    end
+  end
+
+  def test_spy_accepts_multiple_additional_validations_second_failing
+    @spy.foo(4)
+    is_even = proc { |n| assert_equal 0, n%2 }
+    is_two  = proc { |n| assert_equal 2, n }
+    assert_failed(/2.*expected but was.*4/mi) do
+      assert_spy_called @spy, { and: [is_even, is_two] }, :foo, Integer
+    end
+  end
+
+  def test_spy_rejects_incorrect_additional_validations
+    @spy.foo(3)
+    is_even = proc { |n| assert_equal 0, n%2 }
+    assert_failed(/0.*expected but was.*1/mi) do
+      assert_spy_called @spy, { and: is_even }, :foo, Integer
+    end
+  end
+
+  def test_spy_selectively_applies_additional_validations
+    @spy.foo(2)
+    @spy.foo(3)
+    @spy.foo(4)
+    is_even = proc { |n| assert_equal 0, n%2 }
+    assert_failed(/0.*expected but was.*1/mi) do
+      assert_spy_called @spy, { and: is_even, on: 2 }, :foo, Integer
+    end
+  end
+
+  def assert_failed(message_pattern)
+    failed = false
+    begin
+      yield
+    rescue MiniTest::Assertion => ex
+      failed = true
+      assert_match message_pattern, ex.message
+    end
+    refute(!failed, "Expected block to fail")
+  end
+
   def test_spy_methods_can_be_stubbed
     @spy.should_receive(:foo).and_return(:hi)
     result = @spy.foo

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flexmock
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-15 00:00:00.000000000 Z
+date: 2013-01-27 00:00:00.000000000 Z
 dependencies: []
 description: ! "\n      FlexMock is a extremely simple mock object class compatible\n
   \     with the Test::Unit framework.  Although the FlexMock's\n      interface is
@@ -18,7 +18,7 @@ email: jim.weirich@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.rdoc
+- doc/index.rdoc
 - CHANGES
 - doc/GoogleExample.rdoc
 - doc/releases/flexmock-0.4.0.rdoc
@@ -42,6 +42,10 @@ extra_rdoc_files:
 - doc/releases/flexmock-0.9.0.rdoc
 - doc/releases/flexmock-1.0.0.rdoc
 - doc/releases/flexmock-1.0.3.rdoc
+- doc/releases/flexmock-1.0.4.rdoc
+- doc/releases/flexmock-1.1.0.rdoc
+- doc/releases/flexmock-1.2.0.rdoc
+- doc/releases/flexmock-1.3.0.rdoc
 - doc/examples/rspec_examples_spec.rdoc
 - doc/examples/test_unit_examples_test.rdoc
 files:
@@ -49,7 +53,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - Rakefile
-- README.rdoc
+- README.md
 - TAGS
 - lib/flexmock/argument_matchers.rb
 - lib/flexmock/argument_matching.rb
@@ -117,6 +121,7 @@ files:
 - test/undefined_test.rb
 - flexmock.blurb
 - install.rb
+- doc/index.rdoc
 - doc/GoogleExample.rdoc
 - doc/releases/flexmock-0.4.0.rdoc
 - doc/releases/flexmock-0.4.1.rdoc
@@ -139,6 +144,10 @@ files:
 - doc/releases/flexmock-0.9.0.rdoc
 - doc/releases/flexmock-1.0.0.rdoc
 - doc/releases/flexmock-1.0.3.rdoc
+- doc/releases/flexmock-1.0.4.rdoc
+- doc/releases/flexmock-1.1.0.rdoc
+- doc/releases/flexmock-1.2.0.rdoc
+- doc/releases/flexmock-1.3.0.rdoc
 - doc/examples/rspec_examples_spec.rdoc
 - doc/examples/test_unit_examples_test.rdoc
 homepage: https://github.com/jimweirich/flexmock
@@ -160,7 +169,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -972765428365068748
+      hash: -2506978520909989178
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: