123456789_123456789_123456789_123456789_123456789_

Module: RSpec::Mocks::TestDouble

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In:
ClassVerifyingDouble, Double, InstanceVerifyingDouble, ObjectVerifyingDouble, ObjectVerifyingDoubleMethods
Defined in: rspec-mocks/lib/rspec/mocks/test_double.rb

Overview

Implements the methods needed for a pure test double. RSpec::Mocks::Double includes this module, and it is provided for cases where you want a pure test double without subclassing RSpec::Mocks::Double.

Instance Attribute Summary

Instance Method Summary

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(message, *args, &block) (private)

Raises:

  • (NoMethodError)
[ GitHub ] 

  


# File 'rspec-mocks/lib/rspec/mocks/test_double.rb', line 74



def method_missing(message, *args, &block)
  proxy = __mock_proxy
  proxy.record_message_received(message, *args, &block)

  if proxy.null_object?
    case message
    when :to_int        then return 0
    when :to_a, :to_ary then return nil
    when :to_str        then return to_s
    else return self
    end
  end

  # Defined private and protected methods will still trigger `method_missing`
  # when called publicly. We want ruby's method visibility error to get raised,
  # so we simply delegate to `super` in that case.
  # ...well, we would delegate to `super`, but there's a JRuby
  # bug, so we raise our own visibility error instead:
  # https://github.com/jruby/jruby/issues/1398
  visibility = proxy.visibility_for(message)
  if visibility == :private || visibility == :protected
    ErrorGenerator.new(self).raise_non_public_error(
      message, visibility
    )
  end

  # Required wrapping doubles in an Array on Ruby 1.9.2
  raise NoMethodError if [:to_a, :to_ary].include? message
  proxy.raise_unexpected_message_error(message, args)
end


  







Instance Attribute Details



  

    #null_object?  ⇒ Boolean  (readonly)
  



  

    

Returns true if this object has received ‘as_null_object`


  





  


  [ GitHub ]


  

  


# File 'rspec-mocks/lib/rspec/mocks/test_double.rb', line 28



def null_object?
  __mock_proxy.null_object?
end


  







Instance Method Details



  

    #==(other)  
  



  

    

This allows for comparing the mock to other objects that proxy such as ActiveRecords belongs_to proxy objects. By making the other object run the comparison, we’re sure the call gets delegated to the proxy target.


  



  [ GitHub ]


  

  


# File 'rspec-mocks/lib/rspec/mocks/test_double.rb', line 36



def ==(other)
  other == __mock_proxy
end


  








  

    #__build_mock_proxy(order_group)   (private)
  

  [ GitHub ]


  

  


# File 'rspec-mocks/lib/rspec/mocks/test_double.rb', line 115



def __build_mock_proxy(order_group)
  TestDoubleProxy.new(self, order_group)
end


  








  

    #__build_mock_proxy_unless_expired(order_group)  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'rspec-mocks/lib/rspec/mocks/test_double.rb', line 56



def __build_mock_proxy_unless_expired(order_group)
  __raise_expired_error || __build_mock_proxy(order_group)
end


  








  

    #__disallow_further_usage!  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'rspec-mocks/lib/rspec/mocks/test_double.rb', line 61



def __disallow_further_usage!
  @__expired = true
end


  








  

    #__mock_proxy   (private)
  

  [ GitHub ]


  

  


# File 'rspec-mocks/lib/rspec/mocks/test_double.rb', line 111



def __mock_proxy
  ::RSpec::Mocks.space.proxy_for(self)
end


  








  

    #__raise_expired_error   (private)
  

  [ GitHub ]


  

  


# File 'rspec-mocks/lib/rspec/mocks/test_double.rb', line 119



def __raise_expired_error
  return false unless @__expired
  ErrorGenerator.new(self).raise_expired_test_double_error
end


  








  

    #as_null_object  
  



  

    

Tells the object to respond to all messages. If specific stub values are declared, they’ll work as expected. If not, the receiver is returned.


  



  [ GitHub ]


  

  


# File 'rspec-mocks/lib/rspec/mocks/test_double.rb', line 23



def as_null_object
  __mock_proxy.as_null_object
end


  








  

    #assign_stubs(stubs)   (private)
  

  [ GitHub ]


  

  


# File 'rspec-mocks/lib/rspec/mocks/test_double.rb', line 105



def assign_stubs(stubs)
  stubs.each_pair do |message, response|
    __mock_proxy.add_simple_stub(message, response)
  end
end


  








  

    #freeze  
  



  

    

Override for default freeze implementation to prevent freezing of test doubles.


  



  [ GitHub ]


  

  


# File 'rspec-mocks/lib/rspec/mocks/test_double.rb', line 67



def freeze
  RSpec.warn_with("WARNING: you attempted to freeze a test double. This is explicitly a no-op as freezing doubles can lead to undesired behaviour when resetting tests.")
  self
end


  








  

    #initialize(name = nil, stubs = {})  
  



  

    

Creates a new test double with a name (that will be used in error messages only)


  



  [ GitHub ]


  

  


# File 'rspec-mocks/lib/rspec/mocks/test_double.rb', line 9



def initialize(name=nil, stubs={})
  @__expired = false
  if Hash === name && stubs.empty?
    stubs = name
    @name = nil
  else
    @name = name
  end
  assign_stubs(stubs)
end


  








  

    #initialize_copy(other)   (private)
  

  [ GitHub ]


  

  


# File 'rspec-mocks/lib/rspec/mocks/test_double.rb', line 124



def initialize_copy(other)
  as_null_object if other.null_object?
  super
end


  








  

    #inspect  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'rspec-mocks/lib/rspec/mocks/test_double.rb', line 41



def inspect
  TestDoubleFormatter.format(self)
end


  








  

    #respond_to?(message, incl_private = false)  ⇒ Boolean 
  

  

    This method is for internal use only.
  



  

    
  





  


  [ GitHub ]


  

  


# File 'rspec-mocks/lib/rspec/mocks/test_double.rb', line 51



def respond_to?(message, incl_private=false)
  __mock_proxy.null_object? ? true : super
end


  








  

    #to_s  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'rspec-mocks/lib/rspec/mocks/test_double.rb', line 46



def to_s
  inspect.tr('<', '[').tr('>', ']')
end