mocha 1.5.0 → 1.10.0.alpha

data/lib/mocha/cardinality.rb

@@ -1,11 +1,8 @@
 module Mocha
-
   class Cardinality
-
     INFINITY = 1 / 0.0
 
     class << self
-
       def exactly(count)
         new(count, count)
       end
@@ -20,58 +17,71 @@ module Mocha
 
       def times(range_or_count)
         case range_or_count
-          when Range then new(range_or_count.first, range_or_count.last)
-          else new(range_or_count, range_or_count)
+        when Range then new(range_or_count.first, range_or_count.last)
+        else new(range_or_count, range_or_count)
         end
       end
-
     end
 
     def initialize(required, maximum)
-      @required, @maximum = required, maximum
+      @required = required
+      @maximum = maximum
+      @invocations = []
     end
 
-    def invocations_allowed?(invocation_count)
-      invocation_count < maximum
+    def <<(invocation)
+      @invocations << invocation
     end
 
-    def satisfied?(invocations_so_far)
-      invocations_so_far >= required
+    def invocations_allowed?
+      @invocations.size < maximum
+    end
+
+    def satisfied?
+      @invocations.size >= required
     end
 
     def needs_verifying?
       !allowed_any_number_of_times?
     end
 
-    def verified?(invocation_count)
-      (invocation_count >= required) && (invocation_count <= maximum)
+    def verified?
+      (@invocations.size >= required) && (@invocations.size <= maximum)
     end
 
     def allowed_any_number_of_times?
-      required == 0 && infinite?(maximum)
+      required.zero? && infinite?(maximum)
     end
 
-    def used?(invocation_count)
-      (invocation_count > 0) || (maximum == 0)
+    def used?
+      @invocations.any? || maximum.zero?
     end
 
-    def mocha_inspect
+    # rubocop:disable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
+    def anticipated_times
       if allowed_any_number_of_times?
-        "allowed any number of times"
+        'allowed any number of times'
+      elsif required.zero? && maximum.zero?
+        "expected #{times(maximum)}"
+      elsif required == maximum
+        "expected exactly #{times(required)}"
+      elsif infinite?(maximum)
+        "expected at least #{times(required)}"
+      elsif required.zero?
+        "expected at most #{times(maximum)}"
       else
-        if required == 0 && maximum == 0
-          "expected never"
-        elsif required == maximum
-          "expected exactly #{times(required)}"
-        elsif infinite?(maximum)
-          "expected at least #{times(required)}"
-        elsif required == 0
-          "expected at most #{times(maximum)}"
-        else
-          "expected between #{required} and #{times(maximum)}"
-        end
+        "expected between #{required} and #{times(maximum)}"
       end
     end
+    # rubocop:enable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
+
+    def invoked_times
+      "invoked #{times(@invocations.size)}"
+    end
+
+    def actual_invocations
+      @invocations.map(&:full_description).join
+    end
 
     protected
 
@@ -79,17 +89,15 @@ module Mocha
 
     def times(number)
       case number
-        when 0 then "no times"
-        when 1 then "once"
-        when 2 then "twice"
-        else "#{number} times"
+      when 0 then 'never'
+      when 1 then 'once'
+      when 2 then 'twice'
+      else "#{number} times"
       end
     end
 
     def infinite?(number)
       number.respond_to?(:infinite?) && number.infinite?
     end
-
   end
-
 end

data/lib/mocha/central.rb

@@ -1,9 +1,6 @@
 module Mocha
-
   class Central
-
     class Null < self
-
       def initialize(&block)
         super
         @raise_not_initialized_error = block
@@ -16,7 +13,6 @@ module Mocha
       def unstub(*)
         @raise_not_initialized_error.call
       end
-
     end
 
     attr_accessor :stubba_methods
@@ -26,25 +22,21 @@ module Mocha
     end
 
     def stub(method)
-      unless stubba_methods.detect { |m| m.matches?(method) }
-        method.stub
-        stubba_methods.push(method)
-      end
+      return if stubba_methods.detect { |m| m.matches?(method) }
+      method.stub
+      stubba_methods.push(method)
     end
 
     def unstub(method)
-      if existing = stubba_methods.detect { |m| m.matches?(method) }
-        existing.unstub
-        stubba_methods.delete(existing)
-      end
+      return unless (existing = stubba_methods.detect { |m| m.matches?(method) })
+      existing.unstub
+      stubba_methods.delete(existing)
     end
 
     def unstub_all
-      while stubba_methods.any? do
+      while stubba_methods.any?
         unstub(stubba_methods.first)
       end
     end
-
   end
-
 end

data/lib/mocha/change_state_side_effect.rb

@@ -1,7 +1,5 @@
 module Mocha
-
   class ChangeStateSideEffect
-
     def initialize(state)
       @state = state
     end
@@ -13,7 +11,5 @@ module Mocha
     def mocha_inspect
       "then #{@state.mocha_inspect}"
     end
-
   end
-
 end

data/lib/mocha/class_methods.rb

@@ -1,46 +1,36 @@
 require 'mocha/mockery'
-require 'mocha/class_method'
 require 'mocha/any_instance_method'
 
 module Mocha
-
   # Methods added to all classes to allow mocking and stubbing on real (i.e. non-mock) objects.
   module ClassMethods
-
-    # @private
-    def stubba_method
-      Mocha::ClassMethod
-    end
-
     # @private
     class AnyInstance
-
       def initialize(klass)
         @stubba_object = klass
       end
 
-      def mocha
-        @mocha ||= Mocha::Mockery.instance.mock_impersonating_any_instance_of(@stubba_object)
+      def mocha(instantiate = true)
+        if instantiate
+          @mocha ||= Mocha::Mockery.instance.mock_impersonating_any_instance_of(@stubba_object)
+        else
+          defined?(@mocha) ? @mocha : nil
+        end
       end
 
       def stubba_method
         Mocha::AnyInstanceMethod
       end
 
-      def stubba_object
+      def stubba_class
         @stubba_object
       end
 
-      def method_exists?(method, include_public_methods = true)
-        if include_public_methods
-          return true if @stubba_object.public_instance_methods(include_superclass_methods = true).include?(method)
-          return true if @stubba_object.allocate.respond_to?(method.to_sym)
-        end
-        return true if @stubba_object.protected_instance_methods(include_superclass_methods = true).include?(method)
-        return true if @stubba_object.private_instance_methods(include_superclass_methods = true).include?(method)
-        return false
+      def respond_to?(method)
+        @stubba_object.allocate.respond_to?(method.to_sym)
       end
 
+      attr_reader :stubba_object
     end
 
     # @return [Mock] a mock object which will detect calls to any instance of this class.
@@ -59,6 +49,13 @@ module Mocha
       @any_instance ||= AnyInstance.new(self)
     end
 
+    # rubocop:disable Metrics/CyclomaticComplexity
+    def method_visibility(method, include_public_methods = true)
+      (include_public_methods && public_method_defined?(method) && :public) ||
+        (protected_method_defined?(method) && :protected) ||
+        (private_method_defined?(method) && :private)
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity
+    alias_method :method_exists?, :method_visibility
   end
-
 end

data/lib/mocha/configuration.rb

@@ -1,55 +1,323 @@
 module Mocha
+  # Allows setting of configuration options. See {Configuration} for the available options.
+  #
+  # Typically the configuration is set globally in a +test_helper.rb+ or +spec_helper.rb+ file.
+  #
+  # @see Configuration
+  #
+  # @yieldparam configuration [Configuration] the configuration for modification
+  #
+  # @example Setting multiple configuration options
+  #   Mocha.configure do |c|
+  #     c.stubbing_method_unnecessarily = :prevent
+  #     c.stubbing_method_on_non_mock_object = :warn
+  #     c.stubbing_method_on_nil = :allow
+  #   end
+  #
+  def self.configure
+    yield configuration
+  end
 
-  # Configuration settings.
-  class Configuration
+  # @private
+  def self.configuration
+    Configuration.configuration
+  end
 
+  # This class provides a number of ways to configure the library.
+  #
+  # Typically the configuration is set globally in a +test_helper.rb+ or +spec_helper.rb+ file.
+  #
+  # @example Setting multiple configuration options
+  #   Mocha.configure do |c|
+  #     c.stubbing_method_unnecessarily = :prevent
+  #     c.stubbing_method_on_non_mock_object = :warn
+  #     c.stubbing_method_on_nil = :allow
+  #   end
+  #
+  class Configuration
+    # @private
     DEFAULTS = {
       :stubbing_method_unnecessarily => :allow,
       :stubbing_method_on_non_mock_object => :allow,
       :stubbing_non_existent_method => :allow,
       :stubbing_non_public_method => :allow,
       :stubbing_method_on_nil => :prevent,
-    }
+      :display_matching_invocations_on_failure => false
+    }.freeze
 
-    class << self
+    attr_reader :options
+    protected :options
+
+    # @private
+    def initialize(options = {})
+      @options = DEFAULTS.merge(options)
+    end
+
+    # @private
+    def initialize_copy(other)
+      @options = other.options.dup
+    end
+
+    # @private
+    def merge(other)
+      self.class.new(@options.merge(other.options))
+    end
+
+    # Configure whether stubbing methods unnecessarily is allowed.
+    #
+    # This is useful for identifying unused stubs. Unused stubs are often accidentally introduced when code is {http://martinfowler.com/bliki/DefinitionOfRefactoring.html refactored}.
+    #
+    # When +value+ is +:allow+, do nothing. This is the default.
+    # When +value+ is +:warn+, display a warning.
+    # When +value+ is +:prevent+, raise a {StubbingError}.
+    #
+    # @param [Symbol] value one of +:allow+, +:warn+, +:prevent+.
+    #
+    # @example Preventing unnecessary stubbing of a method
+    #   Mocha.configure do |c|
+    #     c.stubbing_method_unnecessarily = :prevent
+    #   end
+    #
+    #   example = mock('example')
+    #   example.stubs(:unused_stub)
+    #   # => Mocha::StubbingError: stubbing method unnecessarily:
+    #   # =>   #<Mock:example>.unused_stub(any_parameters)
+    #
+    def stubbing_method_unnecessarily=(value)
+      @options[:stubbing_method_unnecessarily] = value
+    end
+
+    # @private
+    def stubbing_method_unnecessarily
+      @options[:stubbing_method_unnecessarily]
+    end
+
+    # Configure whether stubbing methods on non-mock objects is allowed.
+    #
+    # If you like the idea of {http://www.jmock.org/oopsla2004.pdf mocking roles not objects} and {http://www.mockobjects.com/2007/04/test-smell-mocking-concrete-classes.html you don't like stubbing concrete classes}, this is the setting for you. However, while this restriction makes a lot of sense in Java with its {http://java.sun.com/docs/books/tutorial/java/concepts/interface.html explicit interfaces}, it may be moot in Ruby where roles are probably best represented as Modules.
+    #
+    # When +value+ is +:allow+, do nothing. This is the default.
+    # When +value+ is +:warn+, display a warning.
+    # When +value+ is +:prevent+, raise a {StubbingError}.
+    #
+    # @param [Symbol] value one of +:allow+, +:warn+, +:prevent+.
+    #
+    # @example Preventing stubbing of a method on a non-mock object
+    #   Mocha.configure do |c|
+    #     c.stubbing_method_on_non_mock_object = :prevent
+    #   end
+    #
+    #   class Example
+    #     def example_method; end
+    #   end
+    #
+    #   example = Example.new
+    #   example.stubs(:example_method)
+    #   # => Mocha::StubbingError: stubbing method on non-mock object:
+    #   # =>   #<Example:0x593620>.example_method
+    #
+    def stubbing_method_on_non_mock_object=(value)
+      @options[:stubbing_method_on_non_mock_object] = value
+    end
+
+    # @private
+    def stubbing_method_on_non_mock_object
+      @options[:stubbing_method_on_non_mock_object]
+    end
+
+    # Configure whether stubbing of non-existent methods is allowed.
+    #
+    # This is useful if you want to ensure that methods you're mocking really exist. A common criticism of unit tests with mock objects is that such a test may (incorrectly) pass when an equivalent non-mocking test would (correctly) fail. While you should always have some integration tests, particularly for critical business functionality, this Mocha configuration setting should catch scenarios when mocked methods and real methods have become misaligned.
+    #
+    # When +value+ is +:allow+, do nothing. This is the default.
+    # When +value+ is +:warn+, display a warning.
+    # When +value+ is +:prevent+, raise a {StubbingError}.
+    #
+    # @param [Symbol] value one of +:allow+, +:warn+, +:prevent+.
+    #
+    # @example Preventing stubbing of a non-existent method
+    #
+    #   Mocha.configure do |c|
+    #     c.stubbing_non_existent_method = :prevent
+    #   end
+    #
+    #   class Example
+    #   end
+    #
+    #   example = Example.new
+    #   example.stubs(:method_that_doesnt_exist)
+    #   # => Mocha::StubbingError: stubbing non-existent method:
+    #   # =>   #<Example:0x593760>.method_that_doesnt_exist
+    #
+    def stubbing_non_existent_method=(value)
+      @options[:stubbing_non_existent_method] = value
+    end
+
+    # @private
+    def stubbing_non_existent_method
+      @options[:stubbing_non_existent_method]
+    end
+
+    # Configure whether stubbing of non-public methods is allowed.
+    #
+    # Many people think that it's good practice only to mock public methods. This is one way to prevent your tests being too tightly coupled to the internal implementation of a class. Such tests tend to be very brittle and not much use when refactoring.
+    #
+    # When +value+ is +:allow+, do nothing. This is the default.
+    # When +value+ is +:warn+, display a warning.
+    # When +value+ is +:prevent+, raise a {StubbingError}.
+    #
+    # @param [Symbol] value one of +:allow+, +:warn+, +:prevent+.
+    #
+    # @example Preventing stubbing of a non-public method
+    #   Mocha.configure do |c|
+    #     c.stubbing_non_public_method = :prevent
+    #   end
+    #
+    #   class Example
+    #     def internal_method; end
+    #     private :internal_method
+    #   end
+    #
+    #   example = Example.new
+    #   example.stubs(:internal_method)
+    #   # => Mocha::StubbingError: stubbing non-public method:
+    #   # =>   #<Example:0x593530>.internal_method
+    #
+    def stubbing_non_public_method=(value)
+      @options[:stubbing_non_public_method] = value
+    end
+
+    # @private
+    def stubbing_non_public_method
+      @options[:stubbing_non_public_method]
+    end
+
+    # Configure whether stubbing methods on the +nil+ object is allowed.
+    #
+    # This is usually done accidentally, but there might be rare cases where it is intended.
+    #
+    # This option only works for Ruby < v2.2.0. In later versions of Ruby +nil+ is frozen and so a {StubbingError} will be raised if you attempt to stub a method on +nil+.
+    #
+    # When +value+ is +:allow+, do nothing.
+    # When +value+ is +:warn+, display a warning.
+    # When +value+ is +:prevent+, raise a {StubbingError}. This is the default.
+    #
+    # @param [Symbol] value one of +:allow+, +:warn+, +:prevent+.
+    #
+    def stubbing_method_on_nil=(value)
+      @options[:stubbing_method_on_nil] = value
+    end
 
+    # @private
+    def stubbing_method_on_nil
+      @options[:stubbing_method_on_nil]
+    end
+
+    # Display matching invocations alongside expectations on Mocha-related test failure.
+    #
+    # @param [Boolean] value +true+ to enable display of matching invocations; disabled by default.
+    #
+    # @example Enable display of matching invocations
+    #   Mocha.configure do |c|
+    #     c.display_matching_invocations_on_failure = true
+    #   end
+    #
+    #   foo = mock('foo')
+    #   foo.expects(:bar)
+    #   foo.stubs(:baz).returns('baz').raises(RuntimeError).throws(:tag, 'value')
+    #
+    #   foo.baz(1, 2)
+    #   assert_raises(RuntimeError) { foo.baz(3, 4) }
+    #   assert_throws(:tag) { foo.baz(5, 6) }
+    #
+    #   not all expectations were satisfied
+    #   unsatisfied expectations:
+    #   - expected exactly once, invoked never: #<Mock:foo>.bar
+    #   satisfied expectations:
+    #   - allowed any number of times, invoked 3 times: #<Mock:foo>.baz(any_parameters)
+    #     - #<Mock:foo>.baz(1, 2) # => "baz"
+    #     - #<Mock:foo>.baz(3, 4) # => raised RuntimeError
+    #     - #<Mock:foo>.baz(5, 6) # => threw (:tag, "value")
+    def display_matching_invocations_on_failure=(value)
+      @options[:display_matching_invocations_on_failure] = value
+    end
+
+    # @private
+    def display_matching_invocations_on_failure?
+      @options[:display_matching_invocations_on_failure]
+    end
+
+    class << self
       # Allow the specified +action+.
       #
       # @param [Symbol] action one of +:stubbing_method_unnecessarily+, +:stubbing_method_on_non_mock_object+, +:stubbing_non_existent_method+, +:stubbing_non_public_method+, +:stubbing_method_on_nil+.
       # @yield optional block during which the configuration change will be changed before being returned to its original value at the end of the block.
+      # @deprecated If a block is supplied, call {.override} with a +Hash+ containing an entry with the +action+ as the key and +:allow+ as the value. If no block is supplied, call the appropriate +action+ writer method with +value+ set to +:allow+ via {Mocha.configure}. The writer method will be the one of the following corresponding to the +action+:
+      #   * {#stubbing_method_unnecessarily=}
+      #   * {#stubbing_method_on_non_mock_object=}
+      #   * {#stubbing_non_existent_method=}
+      #   * {#stubbing_non_public_method=}
+      #   * {#stubbing_method_on_nil=}
       def allow(action, &block)
+        if block_given?
+          Deprecation.warning("Use Mocha::Configuration.override(#{action}: :allow) with the same block")
+        else
+          Deprecation.warning("Use Mocha.configure { |c| c.#{action} = :allow }")
+        end
         change_config action, :allow, &block
       end
 
       # @private
       def allow?(action)
-        configuration[action] == :allow
+        configuration.allow?(action)
       end
 
       # Warn if the specified +action+ is attempted.
       #
       # @param [Symbol] action one of +:stubbing_method_unnecessarily+, +:stubbing_method_on_non_mock_object+, +:stubbing_non_existent_method+, +:stubbing_non_public_method+, +:stubbing_method_on_nil+.
       # @yield optional block during which the configuration change will be changed before being returned to its original value at the end of the block.
+      # @deprecated If a block is supplied, call {.override} with a +Hash+ containing an entry with the +action+ as the key and +:warn+ as the value. If no block is supplied, call the appropriate +action+ writer method with +value+ set to +:warn+ via {Mocha.configure}. The writer method will be the one of the following corresponding to the +action+:
+      #   * {#stubbing_method_unnecessarily=}
+      #   * {#stubbing_method_on_non_mock_object=}
+      #   * {#stubbing_non_existent_method=}
+      #   * {#stubbing_non_public_method=}
+      #   * {#stubbing_method_on_nil=}
       def warn_when(action, &block)
+        if block_given?
+          Deprecation.warning("Use Mocha::Configuration.override(#{action}: :warn) with the same block")
+        else
+          Deprecation.warning("Use Mocha.configure { |c| c.#{action} = :warn }")
+        end
         change_config action, :warn, &block
       end
 
       # @private
       def warn_when?(action)
-        configuration[action] == :warn
+        configuration.warn_when?(action)
       end
 
-      # Raise a {StubbingError} if if the specified +action+ is attempted.
+      # Raise a {StubbingError} if the specified +action+ is attempted.
       #
       # @param [Symbol] action one of +:stubbing_method_unnecessarily+, +:stubbing_method_on_non_mock_object+, +:stubbing_non_existent_method+, +:stubbing_non_public_method+, +:stubbing_method_on_nil+.
       # @yield optional block during which the configuration change will be changed before being returned to its original value at the end of the block.
+      # @deprecated If a block is supplied, call {.override} with a +Hash+ containing an entry with the +action+ as the key and +:prevent+ as the value. If no block is supplied, call the appropriate +action+ writer method with +value+ set to +:prevent+ via {Mocha.configure}. The writer method will be the one of the following corresponding to the +action+:
+      #   * {#stubbing_method_unnecessarily=}
+      #   * {#stubbing_method_on_non_mock_object=}
+      #   * {#stubbing_non_existent_method=}
+      #   * {#stubbing_non_public_method=}
+      #   * {#stubbing_method_on_nil=}
       def prevent(action, &block)
+        if block_given?
+          Deprecation.warning("Use Mocha::Configuration.override(#{action}: :prevent) with the same block")
+        else
+          Deprecation.warning("Use Mocha.configure { |c| c.#{action} = :prevent }")
+        end
         change_config action, :prevent, &block
       end
 
       # @private
       def prevent?(action)
-        configuration[action] == :prevent
+        configuration.prevent?(action)
       end
 
       # @private
@@ -57,33 +325,52 @@ module Mocha
         @configuration = nil
       end
 
-      private
+      # Temporarily modify {Configuration} options.
+      #
+      # The supplied +temporary_options+ will override the current configuration for the duration of the supplied block.
+      # The configuration will be returned to its original state when the block returns.
+      #
+      # @param [Hash] temporary_options the configuration options to apply for the duration of the block.
+      # @yield block during which the configuration change will be in force.
+      #
+      # @example Temporarily allow stubbing of +nil+
+      #   Mocha::Configuration.override(stubbing_method_on_nil: :allow) do
+      #     nil.stubs(:foo)
+      #   end
+      def override(temporary_options)
+        original_configuration = configuration
+        @configuration = configuration.merge(new(temporary_options))
+        yield
+      ensure
+        @configuration = original_configuration
+      end
 
       # @private
       def configuration
-        @configuration ||= DEFAULTS.dup
+        @configuration ||= new
       end
 
+      private
+
       # @private
       def change_config(action, new_value, &block)
         if block_given?
           temporarily_change_config action, new_value, &block
         else
-          configuration[action] = new_value
+          configuration.send("#{action}=".to_sym, new_value)
         end
       end
 
       # @private
-      def temporarily_change_config(action, new_value, &block)
-        original_value = configuration[action]
-        configuration[action] = new_value
+      def temporarily_change_config(action, new_value)
+        original_configuration = configuration
+        new_configuration = configuration.dup
+        new_configuration.send("#{action}=".to_sym, new_value)
+        @configuration = new_configuration
         yield
       ensure
-        configuration[action] = original_value
+        @configuration = original_configuration
       end
-
     end
-
   end
-
 end