mocha 1.2.1 → 1.16.1

data/lib/mocha/mockery.rb

@@ -1,4 +1,3 @@
-require 'mocha/ruby_version'
 require 'mocha/central'
 require 'mocha/mock'
 require 'mocha/names'
@@ -7,16 +6,42 @@ require 'mocha/state_machine'
 require 'mocha/logger'
 require 'mocha/configuration'
 require 'mocha/stubbing_error'
+require 'mocha/not_initialized_error'
 require 'mocha/expectation_error_factory'
 
 module Mocha
-
   class Mockery
+    class Null < self
+      def add_mock(*)
+        raise_not_initialized_error
+      end
 
-    class << self
+      def add_state_machine(*)
+        raise_not_initialized_error
+      end
+
+      def stubba
+        Central::Null.new(&method(:raise_not_initialized_error))
+      end
 
+      private
+
+      def raise_not_initialized_error
+        message = 'Mocha methods cannot be used outside the context of a test'
+        raise NotInitializedError.new(message, caller)
+      end
+    end
+
+    class << self
       def instance
-        @instance ||= new
+        @instances.last || Null.new
+      end
+
+      def setup
+        @instances ||= []
+        mockery = new
+        mockery.logger = instance.logger unless @instances.empty?
+        @instances.push(mockery)
       end
 
       def verify(*args)
@@ -25,28 +50,25 @@ module Mocha
 
       def teardown
         instance.teardown
+      ensure
+        @instances.pop
       end
-
-      def reset_instance
-        @instance = nil
-      end
-
     end
 
-    def named_mock(name, &block)
-      add_mock(Mock.new(self, Name.new(name), &block))
+    def named_mock(name)
+      add_mock(Mock.new(self, Name.new(name)))
     end
 
-    def unnamed_mock(&block)
-      add_mock(Mock.new(self, &block))
+    def unnamed_mock
+      add_mock(Mock.new(self))
     end
 
-    def mock_impersonating(object, &block)
-      add_mock(Mock.new(self, ImpersonatingName.new(object), ObjectReceiver.new(object), &block))
+    def mock_impersonating(object)
+      add_mock(Mock.new(self, ImpersonatingName.new(object), ObjectReceiver.new(object)))
     end
 
-    def mock_impersonating_any_instance_of(klass, &block)
-      add_mock(Mock.new(self, ImpersonatingAnyInstanceName.new(klass), AnyInstanceReceiver.new(klass), &block))
+    def mock_impersonating_any_instance_of(klass)
+      add_mock(Mock.new(self, ImpersonatingAnyInstanceName.new(klass), AnyInstanceReceiver.new(klass)))
     end
 
     def new_state_machine(name)
@@ -56,24 +78,22 @@ module Mocha
     def verify(assertion_counter = nil)
       unless mocks.all? { |mock| mock.__verified__?(assertion_counter) }
         message = "not all expectations were satisfied\n#{mocha_inspect}"
-        if unsatisfied_expectations.empty?
-          backtrace = caller
-        else
-          backtrace = unsatisfied_expectations[0].backtrace
-        end
+        backtrace = if unsatisfied_expectations.empty?
+                      caller
+                    else
+                      unsatisfied_expectations[0].backtrace
+                    end
         raise ExpectationErrorFactory.build(message, backtrace)
       end
-      expectations.each do |e|
-        unless Mocha::Configuration.allow?(:stubbing_method_unnecessarily)
-          unless e.used?
-            on_stubbing_method_unnecessarily(e)
-          end
-        end
+      expectations.reject(&:used?).each do |expectation|
+        signature_proc = lambda { expectation.method_signature }
+        check(:stubbing_method_unnecessarily, 'method unnecessarily', signature_proc, expectation.backtrace)
       end
     end
 
     def teardown
       stubba.unstub_all
+      mocks.each(&:__expire__)
       reset
     end
 
@@ -90,78 +110,23 @@ module Mocha
     end
 
     def mocha_inspect
-      message = ""
-      message << "unsatisfied expectations:\n- #{unsatisfied_expectations.map { |e| e.mocha_inspect }.join("\n- ")}\n" unless unsatisfied_expectations.empty?
-      message << "satisfied expectations:\n- #{satisfied_expectations.map { |e| e.mocha_inspect }.join("\n- ")}\n" unless satisfied_expectations.empty?
-      message << "states:\n- #{state_machines.map { |sm| sm.mocha_inspect }.join("\n- ")}" unless state_machines.empty?
+      message = ''
+      message << "unsatisfied expectations:\n- #{unsatisfied_expectations.map(&:mocha_inspect).join("\n- ")}\n" if unsatisfied_expectations.any?
+      message << "satisfied expectations:\n- #{satisfied_expectations.map(&:mocha_inspect).join("\n- ")}\n" if satisfied_expectations.any?
+      message << "states:\n- #{state_machines.map(&:mocha_inspect).join("\n- ")}\n" if state_machines.any?
       message
     end
 
     def on_stubbing(object, method)
-      method = PRE_RUBY_V19 ? method.to_s : method.to_sym
-      unless Mocha::Configuration.allow?(:stubbing_non_existent_method)
-        unless object.method_exists?(method, include_public_methods = true)
-          on_stubbing_non_existent_method(object, method)
-        end
-      end
-      unless Mocha::Configuration.allow?(:stubbing_non_public_method)
-        if object.method_exists?(method, include_public_methods = false)
-          on_stubbing_non_public_method(object, method)
-        end
-      end
-      unless Mocha::Configuration.allow?(:stubbing_method_on_nil)
-        if object.nil?
-          on_stubbing_method_on_nil(object, method)
-        end
-      end
-      unless Mocha::Configuration.allow?(:stubbing_method_on_non_mock_object)
-        on_stubbing_method_on_non_mock_object(object, method)
-      end
-    end
-
-    def on_stubbing_non_existent_method(object, method)
-      if Mocha::Configuration.prevent?(:stubbing_non_existent_method)
-        raise StubbingError.new("stubbing non-existent method: #{object.mocha_inspect}.#{method}", caller)
+      signature_proc = lambda { "#{object.mocha_inspect}.#{method}" }
+      check(:stubbing_non_existent_method, 'non-existent method', signature_proc) do
+        !(object.stubba_class.__method_exists__?(method, true) || object.respond_to?(method))
       end
-      if Mocha::Configuration.warn_when?(:stubbing_non_existent_method)
-        logger.warn "stubbing non-existent method: #{object.mocha_inspect}.#{method}"
-      end
-    end
-
-    def on_stubbing_non_public_method(object, method)
-      if Mocha::Configuration.prevent?(:stubbing_non_public_method)
-        raise StubbingError.new("stubbing non-public method: #{object.mocha_inspect}.#{method}", caller)
-      end
-      if Mocha::Configuration.warn_when?(:stubbing_non_public_method)
-        logger.warn "stubbing non-public method: #{object.mocha_inspect}.#{method}"
-      end
-    end
-
-    def on_stubbing_method_on_nil(object, method)
-      if Mocha::Configuration.prevent?(:stubbing_method_on_nil)
-        raise StubbingError.new("stubbing method on nil: #{object.mocha_inspect}.#{method}", caller)
-      end
-      if Mocha::Configuration.warn_when?(:stubbing_method_on_nil)
-        logger.warn "stubbing method on nil: #{object.mocha_inspect}.#{method}"
-      end
-    end
-
-    def on_stubbing_method_on_non_mock_object(object, method)
-      if Mocha::Configuration.prevent?(:stubbing_method_on_non_mock_object)
-        raise StubbingError.new("stubbing method on non-mock object: #{object.mocha_inspect}.#{method}", caller)
-      end
-      if Mocha::Configuration.warn_when?(:stubbing_method_on_non_mock_object)
-        logger.warn "stubbing method on non-mock object: #{object.mocha_inspect}.#{method}"
-      end
-    end
-
-    def on_stubbing_method_unnecessarily(expectation)
-      if Mocha::Configuration.prevent?(:stubbing_method_unnecessarily)
-        raise StubbingError.new("stubbing method unnecessarily: #{expectation.method_signature}", expectation.backtrace)
-      end
-      if Mocha::Configuration.warn_when?(:stubbing_method_unnecessarily)
-        logger.warn "stubbing method unnecessarily: #{expectation.method_signature}"
+      check(:stubbing_non_public_method, 'non-public method', signature_proc) do
+        object.stubba_class.__method_exists__?(method, false)
       end
+      check(:stubbing_method_on_nil, 'method on nil', signature_proc) { object.nil? }
+      check(:stubbing_method_on_non_mock_object, 'method on non-mock object', signature_proc)
     end
 
     attr_writer :logger
@@ -170,19 +135,27 @@ module Mocha
       @logger ||= Logger.new($stderr)
     end
 
-
     private
 
+    def check(action, description, signature_proc, backtrace = caller)
+      treatment = Mocha.configuration.send(action)
+      return if (treatment == :allow) || (block_given? && !yield)
+      method_signature = signature_proc.call
+      message = "stubbing #{description}: #{method_signature}"
+      raise StubbingError.new(message, backtrace) if treatment == :prevent
+      logger.warn(message) if treatment == :warn
+    end
+
     def expectations
       mocks.map { |mock| mock.__expectations__.to_a }.flatten
     end
 
     def unsatisfied_expectations
-      expectations.reject { |e| e.verified? }
+      expectations.reject(&:verified?)
     end
 
     def satisfied_expectations
-      expectations.select { |e| e.verified? }
+      expectations.select(&:verified?)
     end
 
     def add_mock(mock)
@@ -200,7 +173,5 @@ module Mocha
       @mocks = nil
       @state_machines = nil
     end
-
   end
-
 end

data/lib/mocha/names.rb

@@ -1,7 +1,5 @@
 module Mocha
-
   class ImpersonatingName
-
     def initialize(object)
       @object = object
     end
@@ -9,11 +7,9 @@ module Mocha
     def mocha_inspect
       @object.mocha_inspect
     end
-
   end
 
   class ImpersonatingAnyInstanceName
-
     def initialize(klass)
       @klass = klass
     end
@@ -21,23 +17,19 @@ module Mocha
     def mocha_inspect
       "#<AnyInstance:#{@klass.mocha_inspect}>"
     end
-
   end
 
   class Name
-
     def initialize(name)
-      @name = name
+      @name = name.to_s
     end
 
     def mocha_inspect
       "#<Mock:#{@name}>"
     end
-
   end
 
   class DefaultName
-
     def initialize(mock)
       @mock = mock
     end
@@ -45,9 +37,7 @@ module Mocha
     def mocha_inspect
       address = @mock.__id__ * 2
       address += 0x100000000 if address < 0
-      "#<Mock:0x#{'%x' % address}>"
+      "#<Mock:0x#{format('%x', address)}>"
     end
-
   end
-
 end

data/lib/mocha/not_initialized_error.rb

@@ -0,0 +1,7 @@
+require 'mocha/error_with_filtered_backtrace'
+
+module Mocha
+  # Exception raised when Mocha has not been initialized, e.g. outside the
+  # context of a test.
+  class NotInitializedError < ErrorWithFilteredBacktrace; end
+end

data/lib/mocha/object_methods.rb

@@ -4,18 +4,20 @@ require 'mocha/argument_iterator'
 require 'mocha/expectation_error_factory'
 
 module Mocha
-
   # Methods added to all objects to allow mocking and stubbing on real (i.e. non-mock) objects.
   #
   # Both {#expects} and {#stubs} return an {Expectation} which can be further modified by methods on {Expectation}.
   module ObjectMethods
-
     # @private
     alias_method :_method, :method
 
     # @private
-    def mocha
-      @mocha ||= Mocha::Mockery.instance.mock_impersonating(self)
+    def mocha(instantiate = true)
+      if instantiate
+        @mocha ||= Mocha::Mockery.instance.mock_impersonating(self)
+      else
+        defined?(@mocha) ? @mocha : nil
+      end
     end
 
     # @private
@@ -33,17 +35,22 @@ module Mocha
       self
     end
 
+    # @private
+    def stubba_class
+      singleton_class
+    end
+
     # Adds an expectation that the specified method must be called exactly once with any parameters.
     #
     # The original implementation of the method is replaced during the test and then restored at the end of the test. The temporary replacement method has the same visibility as the original method.
     #
-    # @param [Symbol,String] method_name name of expected method
-    # @param [Hash] expected_methods_vs_return_values expected method name symbols as keys and corresponding return values as values - these expectations are setup as if {#expects} were called multiple times.
+    # @return [Expectation] last-built expectation which can be further modified by methods on {Expectation}.
+    # @raise [StubbingError] if attempting to stub method which is not allowed.
     #
     # @overload def expects(method_name)
+    #   @param [Symbol,String] method_name name of expected method
     # @overload def expects(expected_methods_vs_return_values)
-    # @return [Expectation] last-built expectation which can be further modified by methods on {Expectation}.
-    # @raise [StubbingError] if attempting to stub method which is not allowed.
+    #   @param [Hash] expected_methods_vs_return_values expected method name symbols as keys and corresponding return values as values - these expectations are setup as if {#expects} were called multiple times.
     #
     # @example Setting up an expectation on a non-mock object.
     #   product = Product.new
@@ -71,14 +78,14 @@ module Mocha
       expectation = nil
       mockery = Mocha::Mockery.instance
       iterator = ArgumentIterator.new(expected_methods_vs_return_values)
-      iterator.each { |*args|
+      iterator.each do |*args|
         method_name = args.shift
         mockery.on_stubbing(self, method_name)
         method = stubba_method.new(stubba_object, method_name)
         mockery.stubba.stub(method)
         expectation = mocha.expects(method_name, caller)
-        expectation.returns(args.shift) if args.length > 0
-      }
+        expectation.returns(args.shift) unless args.empty?
+      end
       expectation
     end
 
@@ -86,13 +93,13 @@ module Mocha
     #
     # The original implementation of the method is replaced during the test and then restored at the end of the test. The temporary replacement method has the same visibility as the original method.
     #
-    # @param [Symbol,String] method_name name of stubbed method
-    # @param [Hash] stubbed_methods_vs_return_values stubbed method name symbols as keys and corresponding return values as values - these stubbed methods are setup as if {#stubs} were called multiple times.
+    # @return [Expectation] last-built expectation which can be further modified by methods on {Expectation}.
+    # @raise [StubbingError] if attempting to stub method which is not allowed.
     #
     # @overload def stubs(method_name)
+    #   @param [Symbol,String] method_name name of stubbed method
     # @overload def stubs(stubbed_methods_vs_return_values)
-    # @return [Expectation] last-built expectation which can be further modified by methods on {Expectation}.
-    # @raise [StubbingError] if attempting to stub method which is not allowed.
+    #   @param [Hash] stubbed_methods_vs_return_values stubbed method name symbols as keys and corresponding return values as values - these stubbed methods are setup as if {#stubs} were called multiple times.
     #
     # @example Setting up a stubbed methods on a non-mock object.
     #   product = Product.new
@@ -117,14 +124,14 @@ module Mocha
       expectation = nil
       mockery = Mocha::Mockery.instance
       iterator = ArgumentIterator.new(stubbed_methods_vs_return_values)
-      iterator.each { |*args|
+      iterator.each do |*args|
         method_name = args.shift
         mockery.on_stubbing(self, method_name)
         method = stubba_method.new(stubba_object, method_name)
         mockery.stubba.stub(method)
         expectation = mocha.stubs(method_name, caller)
-        expectation.returns(args.shift) if args.length > 0
-      }
+        expectation.returns(args.shift) unless args.empty?
+      end
       expectation
     end
 
@@ -158,18 +165,5 @@ module Mocha
         mockery.stubba.unstub(method)
       end
     end
-
-    # @private
-    def method_exists?(method, include_public_methods = true)
-      if include_public_methods
-        return true if public_methods(include_superclass_methods = true).include?(method)
-        return true if respond_to?(method.to_sym)
-      end
-      return true if protected_methods(include_superclass_methods = true).include?(method)
-      return true if private_methods(include_superclass_methods = true).include?(method)
-      return false
-    end
-
   end
-
 end

data/lib/mocha/parameter_matchers/all_of.rb

@@ -1,12 +1,10 @@
 require 'mocha/parameter_matchers/base'
 
 module Mocha
-
   module ParameterMatchers
-
     # Matches if all +matchers+ match.
     #
-    # @param [*Array<Base>] parameter_matchers parameter matchers.
+    # @param [*Array<Base>] matchers parameter matchers.
     # @return [AllOf] parameter matcher.
     #
     # @see Expectation#with
@@ -28,7 +26,6 @@ module Mocha
 
     # Parameter matcher which combines a number of other matchers using a logical AND.
     class AllOf < Base
-
       # @private
       def initialize(*matchers)
         @matchers = matchers
@@ -42,11 +39,8 @@ module Mocha
 
       # @private
       def mocha_inspect
-        "all_of(#{@matchers.map { |matcher| matcher.mocha_inspect }.join(", ") })"
+        "all_of(#{@matchers.map(&:mocha_inspect).join(', ')})"
       end
-
     end
-
   end
-
 end

data/lib/mocha/parameter_matchers/any_of.rb

@@ -1,12 +1,10 @@
 require 'mocha/parameter_matchers/base'
 
 module Mocha
-
   module ParameterMatchers
-
     # Matches if any +matchers+ match.
     #
-    # @param [*Array<Base>] parameter_matchers parameter matchers.
+    # @param [*Array<Base>] matchers parameter matchers.
     # @return [AnyOf] parameter matcher.
     #
     # @see Expectation#with
@@ -34,7 +32,6 @@ module Mocha
 
     # Parameter matcher which combines a number of other matchers using a logical OR.
     class AnyOf < Base
-
       # @private
       def initialize(*matchers)
         @matchers = matchers
@@ -48,11 +45,8 @@ module Mocha
 
       # @private
       def mocha_inspect
-        "any_of(#{@matchers.map { |matcher| matcher.mocha_inspect }.join(", ") })"
+        "any_of(#{@matchers.map(&:mocha_inspect).join(', ')})"
       end
-
     end
-
   end
-
 end

data/lib/mocha/parameter_matchers/any_parameters.rb

@@ -1,9 +1,7 @@
 require 'mocha/parameter_matchers/base'
 
 module Mocha
-
   module ParameterMatchers
-
     # Matches any parameters. This is used as the default for a newly built expectation.
     #
     # @return [AnyParameters] parameter matcher.
@@ -26,22 +24,18 @@ module Mocha
 
     # Parameter matcher which always matches whatever the parameters.
     class AnyParameters < Base
-
       # @private
       def matches?(available_parameters)
-        while available_parameters.length > 0 do
+        until available_parameters.empty?
           available_parameters.shift
         end
-        return true
+        true
       end
 
       # @private
       def mocha_inspect
-        "any_parameters"
+        'any_parameters'
       end
-
     end
-
   end
-
 end

data/lib/mocha/parameter_matchers/anything.rb

@@ -1,9 +1,7 @@
 require 'mocha/parameter_matchers/base'
 
 module Mocha
-
   module ParameterMatchers
-
     # Matches any object.
     #
     # @return [Anything] parameter matcher.
@@ -23,20 +21,16 @@ module Mocha
 
     # Parameter matcher which always matches a single parameter.
     class Anything < Base
-
       # @private
       def matches?(available_parameters)
         available_parameters.shift
-        return true
+        true
       end
 
       # @private
       def mocha_inspect
-        "anything"
+        'anything'
       end
-
     end
-
   end
-
 end

data/lib/mocha/parameter_matchers/base.rb

@@ -1,10 +1,7 @@
 module Mocha
-
   module ParameterMatchers
-
     # @abstract Subclass and implement +#matches?+ and +#mocha_inspect+ to define a custom matcher. Also add a suitably named instance method to {ParameterMatchers} to build an instance of the new matcher c.f. {#equals}.
     class Base
-
       # @private
       def to_matcher
         self
@@ -16,7 +13,7 @@ module Mocha
       #
       # This shorthand will not work with an implicit equals match. Instead, an explicit {Equals} matcher should be used.
       #
-      # @param [Base] matcher parameter matcher.
+      # @param [Base] other parameter matcher.
       # @return [AllOf] parameter matcher.
       #
       # @see Expectation#with
@@ -30,8 +27,8 @@ module Mocha
       #
       #   object.expects(:run).with(has_key(:foo) & has_key(:bar))
       #   object.run(:foo => 'foovalue', :bar => 'barvalue)
-      def &(matcher)
-        AllOf.new(self, matcher)
+      def &(other)
+        AllOf.new(self, other)
       end
 
       # A shorthand way of combining two matchers when at least one must match.
@@ -40,7 +37,7 @@ module Mocha
       #
       # This shorthand will not work with an implicit equals match. Instead, an explicit {Equals} matcher should be used.
       #
-      # @param [Base] matcher parameter matcher.
+      # @param [Base] other parameter matcher.
       # @return [AnyOf] parameter matcher.
       #
       # @see Expectation#with
@@ -60,12 +57,9 @@ module Mocha
       #   object.run(1) # passes
       #   object.run(2) # passes
       #   object.run(3) # fails
-      def |(matcher)
-        AnyOf.new(self, matcher)
+      def |(other)
+        AnyOf.new(self, other)
       end
-
     end
-
   end
-
 end

data/lib/mocha/parameter_matchers/equals.rb

@@ -1,9 +1,7 @@
 require 'mocha/parameter_matchers/base'
 
 module Mocha
-
   module ParameterMatchers
-
     # Matches any +Object+ equalling +value+.
     #
     # @param [Object] value expected value.
@@ -29,7 +27,6 @@ module Mocha
 
     # Parameter matcher which matches when actual parameter equals expected value.
     class Equals < Base
-
       # @private
       def initialize(value)
         @value = value
@@ -45,9 +42,6 @@ module Mocha
       def mocha_inspect
         @value.mocha_inspect
       end
-
     end
-
   end
-
 end