flexmock 1.3.2 → 1.3.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c8fc2db94cd104d7f780ee838c07b73a09649317
+  data.tar.gz: 18c344caf1b37f52f0226b563e8c18fe2832d46f
+SHA512:
+  metadata.gz: aaa6e22a1f390003d539e753d1ebbed9f20e37ce2fb825f39cd1032811f3084236ee4bb591e52644a1eb0bf09d173bda64f9169e619f75a4bf033c70279c51e3
+  data.tar.gz: f106c0edb36b898a2907a7e5930b078a6d36ee7389081ce3fc9a192aad29ebe785ff8d848953ba84955449c37405bd75396cd662db375134fe364f8c0e2a5370

data/Gemfile.lock

@@ -1,16 +1,16 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    diff-lcs (1.2.4)
-    rake (10.0.4)
-    rspec (2.13.0)
-      rspec-core (~> 2.13.0)
-      rspec-expectations (~> 2.13.0)
-      rspec-mocks (~> 2.13.0)
-    rspec-core (2.13.1)
-    rspec-expectations (2.13.0)
+    diff-lcs (1.2.5)
+    rake (10.1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
       diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.13.1)
+    rspec-mocks (2.14.4)
 
 PLATFORMS
   ruby

data/Rakefile

@@ -100,7 +100,9 @@ end
 task :rdoc => ["html/index.html", :fixcss]
 
 file "html/index.html" => ["Rakefile"] + RDOC_FILES do
-  sh "rdoc -o html --title FlexMock --line-numbers -m doc/index.rdoc #{RDOC_FILES}"
+  Bundler.with_clean_env do
+    sh "rdoc -o html --title FlexMock --line-numbers -m doc/index.rdoc #{RDOC_FILES}"
+  end
 end
 
 EXAMPLE_RB.zip(EXAMPLE_DOC).each do |source, target|

data/lib/flexmock.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 #---
-# Copyright 2003-2012 by Jim Weirich (jim.weirich@gmail.com).
+# Copyright 2003-2013 by Jim Weirich (jim.weirich@gmail.com).
 # 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-2012 by Jim Weirich (jim.weirich@gmail.com).
+# Copyright 2003-2013 by Jim Weirich (jim.weirich@gmail.com).
 # All rights reserved.
 #
 # Permission is granted for use, copying, modification, distribution,

data/lib/flexmock/argument_types.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 #---
-# Copyright 2003-2012 by Jim Weirich (jim.weirich@gmail.com).
+# Copyright 2003-2013 by Jim Weirich (jim.weirich@gmail.com).
 # All rights reserved.
 
 # Permission is granted for use, copying, modification, distribution,
@@ -13,7 +13,6 @@ require 'flexmock/argument_matchers'
 
 class FlexMock
 
-  ####################################################################
   # Include this module in your test class if you wish to use the +eq+
   # and +any+ argument matching methods without a prefix.  (Otherwise
   # use <tt>FlexMock.any</tt> and <tt>FlexMock.eq(obj)</tt>.

data/lib/flexmock/base.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 #---
-# Copyright 2003-2012 by Jim Weirich (jim.weirich@gmail.com).
+# Copyright 2003-2013 by Jim Weirich (jim.weirich@gmail.com).
 # All rights reserved.
 
 # Permission is granted for use, copying, modification, distribution,
@@ -26,3 +26,4 @@ require 'flexmock/mock_container'
 require 'flexmock/partial_mock'
 require 'flexmock/undefined'
 require 'flexmock/deprecated_methods'
+require 'flexmock/extensions/active_record_model'

data/lib/flexmock/call_record.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+#---
+# Copyright 2003-2013 by Jim Weirich (jim.weirich@gmail.com).
+# All rights reserved.
+#
+# Permission is granted for use, copying, modification, distribution,
+# and distribution of modified versions of this work as long as the
+# above copyright notice is included.
+#+++
+
+class FlexMock
+
+  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
+
+end

data/lib/flexmock/call_validator.rb

@@ -0,0 +1,68 @@
+#!/usr/bin/env ruby
+
+#---
+# Copyright 2003-2013 by Jim Weirich (jim.weirich@gmail.com).
+# All rights reserved.
+#
+# Permission is granted for use, copying, modification, distribution,
+# and distribution of modified versions of this work as long as the
+# above copyright notice is included.
+#+++
+
+class FlexMock
+
+  # A CallValidator checks the list of call records for a particular
+  # method name and arguments.
+  class CallValidator
+
+    # Does the +calls+ list record a method named +method_name+ with
+    # +args+.  Options include:
+    #
+    # * :times => n    -- If given, the call should match exactly +n+ times.
+    # * :and => []     -- A list of argument validations to be run on each
+    #                     matching invocation.
+    # * :on_count => n -- If given, the :and validations on only run on the
+    #                     nth invocation.
+    #
+    def received?(calls, method_name, args, options)
+      count = 0
+      calls.each { |call_record|
+        if call_record.matches?(method_name, args, options)
+          count += 1
+          run_additional_validations(call_record, count, options)
+        end
+      }
+      count_matches?(count, options[:times])
+    end
+
+    private
+
+    def additionals(options)
+      ands = options[:and]
+      if ands.nil?
+        []
+      elsif ands.is_a?(Proc)
+        [ands]
+      else
+        ands
+      end
+    end
+
+    def run_additional_validations(call_record, count, options)
+      if options[:on_count].nil? || count == options[:on_count]
+        additionals(options).each do |add|
+          add.call(*call_record.args)
+        end
+      end
+    end
+
+    def count_matches?(count, times)
+      if times
+        count == times
+      else
+        count > 0
+      end
+    end
+  end
+
+end

data/lib/flexmock/composite_expectation.rb

@@ -0,0 +1,56 @@
+class FlexMock
+
+  # A composite expectation allows several expectations to be grouped into a
+  # single composite and then apply the same constraints to  all expectations
+  # in the group.
+  class CompositeExpectation
+
+    # Initialize the composite expectation.
+    def initialize
+      @expectations = []
+    end
+
+    # Add an expectation to the composite.
+    def add(expectation)
+      @expectations << expectation
+    end
+
+    # Apply the constraint method to all expectations in the composite.
+    def method_missing(sym, *args, &block)
+      @expectations.each do |expectation|
+        expectation.send(sym, *args, &block)
+      end
+      self
+    end
+
+    # 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
+    end
+
+    # Return the associated mock object.
+    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)
+      @expectations.first.mock.
+        flexmock_define_expectation(caller.first, *args, &block)
+    end
+
+    # Return a string representations
+    def to_s
+      if @expectations.size > 1
+        "[" + @expectations.collect { |e| e.to_s }.join(', ') + "]"
+      else
+        @expectations.first.to_s
+      end
+    end
+  end
+
+end

data/lib/flexmock/core.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 #---
-# Copyright 2003-2012 by Jim Weirich (jim.weirich@gmail.com).
+# Copyright 2003-2013 by Jim Weirich (jim.weirich@gmail.com).
 # All rights reserved.
 #
 # Permission is granted for use, copying, modification, distribution,
@@ -10,17 +10,16 @@
 #+++
 
 require 'flexmock/errors'
-require 'flexmock/composite'
 require 'flexmock/ordering'
 require 'flexmock/argument_matching'
 require 'flexmock/explicit_needed'
 require 'flexmock/class_extensions'
+require 'flexmock/expectation_builder'
+require 'flexmock/call_validator'
+require 'flexmock/call_record'
 
-######################################################################
-# FlexMock is a flexible mock object framework for supporting testing.
-#
-# FlexMock has a simple interface that's easy to remember, and leaves
-# the hard stuff to all those other mock object implementations.
+# FlexMock is a flexible mock object framework for creating and using
+# test doubles (mocks, stubs and spies).
 #
 # Basic Usage:
 #
@@ -33,8 +32,6 @@ require 'flexmock/class_extensions'
 # 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")
@@ -42,9 +39,7 @@ require 'flexmock/class_extensions'
 #     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+.
+# Note: Also, if you override +teardown+, make sure you call +super+.
 #
 class FlexMock
   include Ordering
@@ -104,22 +99,6 @@ class FlexMock
     self
   end
 
-  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
@@ -162,25 +141,11 @@ class FlexMock
     should_receive(:class => base_class)
   end
 
+  CALL_VALIDATOR = CallValidator.new
+
   # 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|
-      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]
-    else
-      result = count > 0
-    end
-    result
+  def flexmock_received?(method_name, args, options={})
+    CALL_VALIDATOR.received?(@calls, method_name, args, options)
   end
 
   # Return the list of calls made on this mock. Used in formatting
@@ -191,13 +156,13 @@ class FlexMock
 
   # Invocke the original non-mocked functionality for the given
   # symbol.
-  def flexmock_invoke_original(sym, args)
+  def flexmock_invoke_original(method_name, args)
     return FlexMock.undefined
   end
 
   # Override the built-in +method+ to include the mocked methods.
-  def method(sym)
-    @expectations[sym] || super
+  def method(method_name)
+    @expectations[method_name] || super
   rescue NameError => ex
     if @ignore_missing
       proc { FlexMock.undefined }
@@ -230,14 +195,15 @@ class FlexMock
     flexmock_define_expectation(location, *args)
   end
 
+  # Using +location+, define the expectations specified by +args+.
   def flexmock_define_expectation(location, *args)
-    @last_expectation = ContainerHelper.parse_should_args(self, args) do |sym|
-      @expectations[sym] ||= ExpectationDirector.new(sym)
-      result = Expectation.new(self, sym, location)
-      @expectations[sym] << result
-      override_existing_method(sym) if flexmock_respond_to?(sym)
-      result = ExplicitNeeded.new(result, sym, @base_class) if
-        @base_class && ! @base_class.flexmock_defined?(sym)
+    @last_expectation = EXP_BUILDER.parse_should_args(self, args) do |method_name|
+      @expectations[method_name] ||= ExpectationDirector.new(method_name)
+      result = Expectation.new(self, method_name, location)
+      @expectations[method_name] << result
+      override_existing_method(method_name) if flexmock_respond_to?(method_name)
+      result = ExplicitNeeded.new(result, method_name, @base_class) if
+        @base_class && ! @base_class.flexmock_defined?(method_name)
       result
     end
   end
@@ -271,15 +237,15 @@ class FlexMock
   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
-  # method_missing.  This method defines a singleton method on the
-  # mock to explicitly invoke the method_missing logic.
-  def override_existing_method(sym)
+  # Override the existing definition of method +method_name+ in the
+  # mock. Most methods depend on the method_missing trick to be
+  # invoked. However, if the method already exists, it will not call
+  # method_missing. This method defines a singleton method on the mock
+  # to explicitly invoke the method_missing logic.
+  def override_existing_method(method_name)
     sclass.class_eval <<-EOS
-      def #{sym}(*args, &block)
-        method_missing(:#{sym}, *args, &block)
+      def #{method_name}(*args, &block)
+        method_missing(:#{method_name}, *args, &block)
       end
     EOS
   end

data/lib/flexmock/core_class_methods.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 #---
-# Copyright 2003-2012 by Jim Weirich (jim.weirich@gmail.com).
+# Copyright 2003-2013 by Jim Weirich (jim.weirich@gmail.com).
 # All rights reserved.
 
 # Permission is granted for use, copying, modification, distribution,

data/lib/flexmock/default_framework_adapter.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 #---
-# Copyright 2003-2012 by Jim Weirich (jim.weirich@gmail.com).
+# Copyright 2003-2013 by Jim Weirich (jim.weirich@gmail.com).
 # All rights reserved.
 
 # Permission is granted for use, copying, modification, distribution,

data/lib/flexmock/deprecated_methods.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 #---
-# Copyright 2003-2012 by Jim Weirich (jim.weirich@gmail.com).
+# Copyright 2003-2013 by Jim Weirich (jim.weirich@gmail.com).
 # All rights reserved.
 #
 # Permission is granted for use, copying, modification, distribution,
@@ -38,7 +38,8 @@ class FlexMock
   # that by passing in the number of expected calls as a second
   # paramter.
   def mock_handle(sym, expected_count=nil, &block) # :nodoc:
-    $stderr.puts "mock_handle is deprecated, use the new should_receive interface instead."
+    $stderr.puts "mock_handle is deprecated, " +
+      "use the new should_receive interface instead."
     self.should_receive(sym).times(expected_count).returns(&block)
   end
 
@@ -57,6 +58,10 @@ class FlexMock
   end
 
   module Ordering
-    flexmock_deprecate :mock_allocate_order, :mock_groups, :mock_current_order, :mock_validate_order
+    flexmock_deprecate(
+      :mock_allocate_order,
+      :mock_groups,
+      :mock_current_order,
+      :mock_validate_order)
   end
 end