flexmock 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac25b7c70e3a49d1404279263c5ad6e5cfb19128
-  data.tar.gz: 41c3cc477ad1623060a73eacd7dea095226ad6c3
+  metadata.gz: 471129d58809ac2dc9a53b22254f76e352f5b253
+  data.tar.gz: 3ac4914a786029b8cb1c10750b28f7de602c984b
 SHA512:
-  metadata.gz: 486419f39b00d0f8545671d597b7e7832a804545ee40d78bec76a6e46edc68632f16465a7745d0eb4b5bf94fc4612b753134c2c756bdf27ed1c477b71622d827
-  data.tar.gz: 0bc257bddd171c211d20c1424626a67487387094a43e0e57dd8a7bf49b3923caf4f4947c73ce44e33c98ae7b6443879aba603b44749439d39b8caa38ac9d31f9
+  metadata.gz: dcab0eed825f701d642cce8286b9816b087b765beff23fe39205841e1289ecdfc80284a14d59cbbfb90a27d5050c50b25618fd5f27a6f9db4367e2b0b739360c
+  data.tar.gz: 8e97cc8946bb2fac86b6b69cb01dec2c42a2cb3aa67d0307dc696e94228bccd66f82cabe1a8c6bdb92b096ba91b3a6889b898e40af714cbc7c7d071b0496a4aa

data/.travis.yml

@@ -1,10 +1,11 @@
+sudo: false
 language: ruby
 rvm:
   - '2.0'
-  - '2.1'
-  - '2.2'
+  - 2.1.10
+  - 2.2.5
   - 2.3.1
-  - jruby-9.1.2.0
+  - jruby-9.1.5.0
 
 script:
     - rake test

data/README.md

@@ -22,6 +22,13 @@ Only significant changes (new APIs, deprecated APIs or backward-compatible
 changes) are documented here, a.k.a. minor or major version bumps. If you want a
 detailed changelog, go over the commit log in github (it's pretty low-traffic)
 
+2.3.0:
+ - implemented validation of call arity for partial mocks. By setting
+     FlexMock.partials_verify_signatures = true
+   flexmock will verify on partials that the number of arguments, and the
+   keyword arguments passed to the mocked call match the existing method's
+   signature
+
 2.2.0:
 
  - #new_instances now mocks the #initialize method instead of mocking after the

data/lib/flexmock/core.rb

@@ -49,8 +49,10 @@ class FlexMock
 
   class << self
     attr_accessor :partials_are_based
+    attr_accessor :partials_verify_signatures
   end
   self.partials_are_based = false
+  self.partials_verify_signatures = false
 
   # Create a FlexMock object with the given name.  The name is used in
   # error messages.  If no container is given, create a new, one-off
@@ -153,8 +155,10 @@ class FlexMock
   def flexmock_based_on(base_class)
     @base_class = base_class
     if base_class <= Kernel
-      should_receive(:class => base_class)
-      should_receive(:kind_of?).and_return { |against| base_class <= against }
+      if self.class != base_class
+        should_receive(:class => base_class)
+        should_receive(:kind_of?).and_return { |against| base_class <= against }
+      end
     end
   end
 

data/lib/flexmock/expectation.rb

@@ -38,6 +38,7 @@ class FlexMock
       @location = location
       @expected_args = nil
       @count_validators = []
+      @signature_validator = SignatureValidator.new(self)
       @count_validator_class = ExactCountValidator
       @actual_count = 0
       @return_value = nil
@@ -65,6 +66,9 @@ class FlexMock
       @count_validators.each do |validator|
         result << validator.describe
       end
+      if !@signature_validator.null?
+        result << @signature_validator.describe
+      end
       result
     end
 
@@ -79,11 +83,18 @@ class FlexMock
       FlexMock.framework_adapter.check(e.message) { false }
     end
 
+    def validate_signature(args)
+      @signature_validator.validate(args)
+    rescue SignatureValidator::ValidationFailed => e
+      FlexMock.framework_adapter.check(e.message) { false }
+    end
+
     # Verify the current call with the given arguments matches the
     # expectations recorded in this object.
     def verify_call(*args)
       validate_eligible
       validate_order
+      validate_signature(args)
       @actual_count += 1
       perform_yielding(args)
       return_value(args)
@@ -186,6 +197,28 @@ class FlexMock
       self
     end
 
+    # Validate general parameters on the call signature
+    def with_signature(
+        required_arguments: 0, optional_arguments: 0, splat: false,
+        required_keyword_arguments: [], optional_keyword_arguments: [], keyword_splat: false)
+      @signature_validator = SignatureValidator.new(
+          self,
+          required_arguments: required_arguments,
+          optional_arguments: optional_arguments,
+          splat: splat,
+          required_keyword_arguments: required_keyword_arguments,
+          optional_keyword_arguments: optional_keyword_arguments,
+          keyword_splat: keyword_splat)
+      self
+    end
+
+    # Validate that the passed arguments match the method signature from the
+    # given instance method
+    def with_signature_matching(instance_method)
+      @signature_validator = SignatureValidator.from_instance_method(self, instance_method)
+      self
+    end
+
     # :call-seq:
     #   and_return(value)
     #   and_return(value, value, ...)

data/lib/flexmock/expectation_director.rb

@@ -40,7 +40,9 @@ class FlexMock
       call_record.expectation = exp if call_record
       FlexMock.check(
         proc { "no matching handler found for " +
-               FlexMock.format_call(@sym, args) }
+               FlexMock.format_call(@sym, args) +
+               "\nDefined expectations:\n  " +
+               @expectations.map(&:description).join("\n  ") }
       ) { !exp.nil? }
       returned_value = exp.verify_call(*args)
       returned_value

data/lib/flexmock/partial_mock.rb

@@ -58,7 +58,8 @@ class FlexMock
       :should_receive, :new_instances,
       :should_receive_with_location,
       :flexmock_get,   :flexmock_teardown, :flexmock_verify,
-      :flexmock_received?, :flexmock_calls, :flexmock_find_expectation
+      :flexmock_received?, :flexmock_calls, :flexmock_find_expectation,
+      :invoke_original
     ]
 
     # Initialize a PartialMockProxy object.
@@ -108,12 +109,27 @@ class FlexMock
       flexmock_define_expectation(caller, *args)
     end
 
+    # Invoke the original of a mocked method
+    #
+    # Usually called in a #and_return statement
+    def invoke_original(m, *args, &block)
+      if block
+        args << block
+      end
+      flexmock_invoke_original(m, args)
+    end
+
     def flexmock_define_expectation(location, *args)
       EXP_BUILDER.parse_should_args(self, args) do |method_name|
-        unless @methods_proxied.include?(method_name)
+        if !@methods_proxied.include?(method_name)
           hide_existing_method(method_name)
         end
         ex = @mock.flexmock_define_expectation(location, method_name)
+        if FlexMock.partials_verify_signatures
+          if existing_method = @method_definitions[method_name]
+            ex.with_signature_matching(existing_method)
+          end
+        end
         ex.mock = self
         ex
       end
@@ -334,8 +350,9 @@ class FlexMock
     # not a singleton, all we need to do is override it with our own
     # singleton.
     def hide_existing_method(method_name)
-      stow_existing_definition(method_name)
+      existing_method = stow_existing_definition(method_name)
       define_proxy_method(method_name)
+      existing_method
     end
 
     # Stow the existing method definition so that it can be recovered
@@ -345,6 +362,7 @@ class FlexMock
         @method_definitions[method_name] = target_class_eval { instance_method(method_name) }
         @methods_proxied << method_name
       end
+      @method_definitions[method_name]
     rescue NameError
     end
 

data/lib/flexmock/validators.rb

@@ -9,6 +9,7 @@
 # above copyright notice is included.
 #+++
 
+require 'set'
 require 'flexmock/noop'
 require 'flexmock/spy_describers'
 
@@ -136,4 +137,148 @@ class FlexMock
       "At most #{@limit}"
     end
   end
+
+  # Validate that the call matches a given signature
+  #
+  # The validator created by {#initialize} matches any method call
+  class SignatureValidator
+    class ValidationFailed < RuntimeError
+    end
+
+    # The number of required arguments
+    attr_reader :required_arguments
+    # The number of optional arguments
+    attr_reader :optional_arguments
+    # Whether there is a positional argument splat
+    def splat?
+      @splat
+    end
+    # The names of required keyword arguments
+    # @return [Set<Symbol>]
+    attr_reader :required_keyword_arguments
+    # The names of optional keyword arguments
+    # @return [Set<Symbol>]
+    attr_reader :optional_keyword_arguments
+    # Whether there is a splat for keyword arguments (double-star)
+    def keyword_splat?
+      @keyword_splat
+    end
+
+    # Whether this method may have keyword arguments
+    def expects_keyword_arguments?
+      keyword_splat? || !required_keyword_arguments.empty? || !optional_keyword_arguments.empty?
+    end
+
+    # Whether this method may have keyword arguments
+    def requires_keyword_arguments?
+      !required_keyword_arguments.empty?
+    end
+
+    def initialize(
+        expectation,
+        required_arguments: 0,
+        optional_arguments: 0,
+        splat: true,
+        required_keyword_arguments: [],
+        optional_keyword_arguments: [],
+        keyword_splat: true)
+      @exp = expectation
+      @required_arguments = required_arguments
+      @optional_arguments = optional_arguments
+      @required_keyword_arguments = required_keyword_arguments.to_set
+      @optional_keyword_arguments = optional_keyword_arguments.to_set
+      @splat = splat
+      @keyword_splat = keyword_splat
+    end
+
+    # Whether this tests anything
+    #
+    # It will return if this validator would validate any set of arguments
+    def null?
+      splat? && keyword_splat?
+    end
+
+    def describe
+      ".with_signature(
+          required_arguments: #{self.required_arguments},
+          optional_arguments: #{self.optional_arguments},
+          required_keyword_arguments: #{self.required_keyword_arguments.to_a},
+          optional_keyword_arguments: #{self.optional_keyword_arguments.to_a},
+          splat: #{self.splat?},
+          keyword_splat: #{self.keyword_splat?})"
+    end
+
+    # Validates whether the given arguments match the expected signature
+    #
+    # @param [Array] args
+    # @raise ValidationFailed
+    def validate(args)
+      kw_args = Hash.new
+      if expects_keyword_arguments?
+        last_is_kw_hash =
+            begin
+                args.last.kind_of?(Hash)
+            rescue NoMethodError
+                false
+            end
+
+        if last_is_kw_hash
+          kw_args = args[-1]
+          args = args[0..-2]
+        elsif requires_keyword_arguments?
+          raise ValidationFailed, "#{@exp} expects keyword arguments but none were provided"
+        end
+      end
+
+      # There is currently no way to disambiguate "given a block" from "given a
+      # proc as last argument" ... give some leeway in this case
+
+      if required_arguments > args.size
+        raise ValidationFailed, "#{@exp} expects at least #{required_arguments} positional arguments but got only #{args.size}"
+      elsif !splat? && (required_arguments + optional_arguments) < args.size
+        if !args.last.kind_of?(Proc) || (required_arguments + optional_arguments) < args.size - 1
+          raise ValidationFailed, "#{@exp} expects at most #{required_arguments + optional_arguments} positional arguments but got #{args.size}"
+        end
+      end
+
+      missing_keyword_arguments = required_keyword_arguments.
+        find_all { |k| !kw_args.has_key?(k) }
+      if !missing_keyword_arguments.empty?
+        raise ValidationFailed, "#{@exp} missing required keyword arguments #{missing_keyword_arguments.map(&:to_s).sort.join(", ")}"
+      end
+      if !keyword_splat?
+        kw_args.each_key do |k|
+          if !optional_keyword_arguments.include?(k) && !required_keyword_arguments.include?(k)
+            raise ValidationFailed, "#{@exp} given unexpected keyword argument #{k}"
+          end
+        end
+      end
+    end
+
+    # Create a validator that represents the signature of an existing method
+    def self.from_instance_method(exp, instance_method)
+      required_arguments, optional_arguments, splat = 0, 0, false
+      required_keyword_arguments, optional_keyword_arguments, keyword_splat = Set.new, Set.new, false
+      instance_method.parameters.each do |type, name|
+        case type
+        when :req then required_arguments += 1
+        when :opt then optional_arguments += 1
+        when :rest then splat = true
+        when :keyreq then required_keyword_arguments << name
+        when :key then optional_keyword_arguments << name
+        when :keyrest then keyword_splat = true
+        when :block
+        else raise ArgumentError, "cannot interpret parameter type #{type}"
+        end
+      end
+      new(exp,
+          required_arguments: required_arguments,
+          optional_arguments: optional_arguments,
+          splat: splat,
+          required_keyword_arguments: required_keyword_arguments,
+          optional_keyword_arguments: optional_keyword_arguments,
+          keyword_splat: keyword_splat)
+    end
+  end
 end
+

data/lib/flexmock/version.rb

@@ -1,3 +1,3 @@
 class FlexMock
-    VERSION = "2.2.1"
+    VERSION = "2.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flexmock
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Jim Weirich
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-12 00:00:00.000000000 Z
+date: 2016-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest