mocha 1.8.0 → 1.13.0

data/lib/mocha/parameter_matchers/has_value.rb

@@ -20,11 +20,10 @@ module Mocha
     #   object.expects(:method_1).with(has_value(1))
     #   object.method_1('key_2' => 2)
     #   # error raised, because method_1 was not called with Hash containing value: 1
-    # rubocop:disable Naming/PredicateName
-    def has_value(value)
+    #
+    def has_value(value) # rubocop:disable Naming/PredicateName
       HasValue.new(value)
     end
-    # rubocop:enable Naming/PredicateName
 
     # Parameter matcher which matches when actual parameter contains +Hash+ entry with expected value.
     class HasValue < Base

data/lib/mocha/parameter_matchers/includes.rb

@@ -72,6 +72,7 @@ module Mocha
       end
 
       # @private
+      # rubocop:disable Metrics/PerceivedComplexity
       def matches?(available_parameters)
         parameter = available_parameters.shift
         return false unless parameter.respond_to?(:include?)
@@ -89,6 +90,7 @@ module Mocha
           AllOf.new(*includes_matchers).matches?([parameter])
         end
       end
+      # rubocop:enable Metrics/PerceivedComplexity
 
       # @private
       def mocha_inspect

data/lib/mocha/parameter_matchers/instance_methods.rb

@@ -0,0 +1,18 @@
+require 'mocha/parameter_matchers/equals'
+
+module Mocha
+  module ParameterMatchers
+    # @private
+    module InstanceMethods
+      # @private
+      def to_matcher
+        Mocha::ParameterMatchers::Equals.new(self)
+      end
+    end
+  end
+end
+
+# @private
+class Object
+  include Mocha::ParameterMatchers::InstanceMethods
+end

data/lib/mocha/parameter_matchers/is_a.rb

@@ -21,11 +21,10 @@ module Mocha
     #   object.expects(:method_1).with(is_a(Integer))
     #   object.method_1('string')
     #   # error raised, because method_1 was not called with an Integer
-    # rubocop:disable Naming/PredicateName
-    def is_a(klass)
+    #
+    def is_a(klass) # rubocop:disable Naming/PredicateName
       IsA.new(klass)
     end
-    # rubocop:enable Naming/PredicateName
 
     # Parameter matcher which matches when actual parameter is a specific class.
     class IsA < Base

data/lib/mocha/parameter_matchers/not.rb

@@ -20,11 +20,10 @@ module Mocha
     #   object.expects(:method_1).with(Not(includes(1)))
     #   object.method_1([0, 1, 2, 3])
     #   # error raised, because method_1 was not called with object not including 1
-    # rubocop:disable Naming/MethodName
-    def Not(matcher)
+    #
+    def Not(matcher) # rubocop:disable Naming/MethodName
       Not.new(matcher)
     end
-    # rubocop:enable Naming/MethodName
 
     # Parameter matcher which inverts the logic of the specified matcher using a logical NOT operation.
     class Not < Base

data/lib/mocha/parameter_matchers.rb

@@ -3,7 +3,7 @@ module Mocha
   module ParameterMatchers; end
 end
 
-require 'mocha/parameter_matchers/object'
+require 'mocha/parameter_matchers/instance_methods'
 
 require 'mocha/parameter_matchers/all_of'
 require 'mocha/parameter_matchers/any_of'
@@ -13,6 +13,7 @@ require 'mocha/parameter_matchers/equals'
 require 'mocha/parameter_matchers/has_entry'
 require 'mocha/parameter_matchers/has_entries'
 require 'mocha/parameter_matchers/has_key'
+require 'mocha/parameter_matchers/has_keys'
 require 'mocha/parameter_matchers/has_value'
 require 'mocha/parameter_matchers/includes'
 require 'mocha/parameter_matchers/instance_of'

data/lib/mocha/raised_exception.rb

@@ -0,0 +1,11 @@
+module Mocha
+  class RaisedException
+    def initialize(exception)
+      @exception = exception
+    end
+
+    def mocha_inspect
+      "raised #{@exception}"
+    end
+  end
+end

data/lib/mocha/return_values.rb

@@ -12,11 +12,11 @@ module Mocha
       @values = values
     end
 
-    def next
+    def next(invocation)
       case @values.length
       when 0 then nil
-      when 1 then @values.first.evaluate
-      else @values.shift.evaluate
+      when 1 then @values.first.evaluate(invocation)
+      else @values.shift.evaluate(invocation)
       end
     end
 

data/lib/mocha/setup.rb

@@ -1,4 +1,9 @@
 require 'mocha/integration'
+require 'mocha/deprecation'
+
+Mocha::Deprecation.warning(
+  "Require 'mocha/test_unit', 'mocha/minitest' or 'mocha/api' instead of 'mocha/setup'."
+)
 
 module Mocha
   def self.activate

data/lib/mocha/single_return_value.rb

@@ -6,7 +6,8 @@ module Mocha
       @value = value
     end
 
-    def evaluate
+    def evaluate(invocation)
+      invocation.returned(@value)
       @value
     end
   end

data/lib/mocha/singleton_class.rb

@@ -0,0 +1,9 @@
+if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('1.9.2')
+  unless Kernel.method_defined?(:singleton_class)
+    module Kernel
+      def singleton_class
+        class << self; self; end
+      end
+    end
+  end
+end

data/lib/mocha/state_machine.rb

@@ -2,46 +2,32 @@ module Mocha
   # A state machine that is used to constrain the order of invocations.
   # An invocation can be constrained to occur when a state {#is}, or {#is_not}, active.
   class StateMachine
-    # Provides a mechanism to change the state of a {StateMachine} at some point in the future.
-    class State
+    # Provides the ability to determine whether a {StateMachine} is in a specified state at some point in the future.
+    class StatePredicate
       # @private
-      def initialize(state_machine, state)
+      def initialize(state_machine, state, description, &active_check)
         @state_machine = state_machine
         @state = state
-      end
-
-      # @private
-      def activate
-        @state_machine.current_state = @state
+        @description = description
+        @active_check = active_check
       end
 
       # @private
       def active?
-        @state_machine.current_state == @state
+        @active_check.call(@state_machine.current_state, @state)
       end
 
       # @private
       def mocha_inspect
-        "#{@state_machine.name} is #{@state.mocha_inspect}"
+        "#{@state_machine.name} #{@description} #{@state.mocha_inspect}"
       end
     end
 
-    # Provides the ability to determine whether a {StateMachine} is in a specified state at some point in the future.
-    class StatePredicate
-      # @private
-      def initialize(state_machine, state)
-        @state_machine = state_machine
-        @state = state
-      end
-
-      # @private
-      def active?
-        @state_machine.current_state != @state
-      end
-
+    # Provides a mechanism to change the state of a {StateMachine} at some point in the future.
+    class State < StatePredicate
       # @private
-      def mocha_inspect
-        "#{@state_machine.name} is not #{@state.mocha_inspect}"
+      def activate
+        @state_machine.current_state = @state
       end
     end
 
@@ -73,30 +59,35 @@ module Mocha
       @current_state = next_state_name
     end
 
-    # Provides a mechanism to change the {StateMachine} into the state specified by +state_name+ at some point in the future.
+    # Provides mechanisms to (a) determine whether the {StateMachine} is in a given state; or (b) to change the {StateMachine} into the given state.
     #
-    # Or provides a mechanism to determine whether the {StateMachine} is in the state specified by +state_name+ at some point in the future.
+    # @param [String] state_name name of expected/desired state.
+    # @return [StatePredicate,State] (a) state predicate which, when queried, will indicate whether the {StateMachine} is in the given state; or (b) state which, when activated, will change the {StateMachine} into the given state.
     #
-    # @param [String] state_name name of new state
-    # @return [State] state which, when activated, will change the {StateMachine} into the state with the specified +state_name+.
+    # @overload def is(expected_state_name)
+    #   Provides a mechanism to determine whether the {StateMachine} is in the state specified by +expected_state_name+ at some point in the future
+    #   @param [String] expected_state_name name of expected state.
+    #   @return [StatePredicate] state predicate which, when queried, will indicate whether the {StateMachine} is in the state specified by +expected_state_name+
+    #
+    # @overload def is(desired_state_name)
+    #   Provides a mechanism to change the {StateMachine} into the state specified by +desired_state_name+ at some point in the future.
+    #   @param [String] desired_state_name name of desired new state.
+    #   @return [State] state which, when activated, will change the {StateMachine} into the state with the specified +desired_state_name+.
     def is(state_name)
-      State.new(self, state_name)
+      State.new(self, state_name, 'is') { |current, given| current == given }
     end
 
-    # Provides a mechanism to determine whether the {StateMachine} is not in the state specified by +state_name+ at some point in the future.
-    # rubocop:disable Naming/PredicateName
-    def is_not(state_name)
-      StatePredicate.new(self, state_name)
+    # Provides a mechanism to determine whether the {StateMachine} is *not* in the state specified by +unexpected_state_name+ at some point in the future.
+    #
+    # @param [String] unexpected_state_name name of unexpected state.
+    # @return [StatePredicate] state predicate which, when queried, will indicate whether the {StateMachine} is *not* in the state specified by +unexpected_state_name+.
+    def is_not(unexpected_state_name) # rubocop:disable Naming/PredicateName
+      StatePredicate.new(self, unexpected_state_name, 'is not') { |current, given| current != given }
     end
-    # rubocop:enable Naming/PredicateName
 
     # @private
     def mocha_inspect
-      if @current_state
-        "#{@name} is #{@current_state.mocha_inspect}"
-      else
-        "#{@name} has no current state"
-      end
+      %(#{@name} #{@current_state ? "is #{@current_state.mocha_inspect}" : 'has no current state'})
     end
   end
 end

data/lib/mocha/stubbed_method.rb

@@ -0,0 +1,125 @@
+require 'mocha/ruby_version'
+require 'mocha/singleton_class'
+
+module Mocha
+  class StubbedMethod
+    PrependedModule = Class.new(Module)
+
+    attr_reader :stubbee, :method_name
+
+    def initialize(stubbee, method_name)
+      @stubbee = stubbee
+      @original_method = nil
+      @original_visibility = nil
+      @method_name = PRE_RUBY_V19 ? method_name.to_s : method_name.to_sym
+    end
+
+    def stub
+      hide_original_method
+      define_new_method
+    end
+
+    def unstub
+      remove_new_method
+      restore_original_method
+      mock.unstub(method_name.to_sym)
+      return if mock.any_expectations?
+      reset_mocha
+    end
+
+    def mock
+      mock_owner.mocha
+    end
+
+    def reset_mocha
+      mock_owner.reset_mocha
+    end
+
+    def hide_original_method
+      return unless original_method_owner.__method_exists__?(method_name)
+      store_original_method_visibility
+      if use_prepended_module_for_stub_method?
+        use_prepended_module_for_stub_method
+      else
+        begin
+          store_original_method
+        # rubocop:disable Lint/HandleExceptions
+        rescue NameError
+          # deal with nasties like ActiveRecord::Associations::AssociationProxy
+        end
+        # rubocop:enable Lint/HandleExceptions
+        if stub_method_overwrites_original_method?
+          remove_original_method_from_stubbee
+        end
+      end
+    end
+
+    def define_new_method
+      self_in_scope = self
+      method_name_in_scope = method_name
+      stub_method_owner.send(:define_method, method_name) do |*args, &block|
+        self_in_scope.mock.method_missing(method_name_in_scope, *args, &block)
+      end
+      retain_original_visibility(stub_method_owner)
+    end
+
+    def remove_new_method
+      stub_method_owner.send(:remove_method, method_name)
+    end
+
+    def store_original_method
+      @original_method = stubbee_method(method_name)
+    end
+
+    def restore_original_method
+      return if use_prepended_module_for_stub_method?
+      if stub_method_overwrites_original_method?
+        original_method_owner.send(:define_method, method_name, method_body(@original_method))
+      end
+      retain_original_visibility(original_method_owner)
+    end
+
+    def matches?(other)
+      return false unless other.class == self.class
+      (stubbee.object_id == other.stubbee.object_id) && (method_name == other.method_name)
+    end
+
+    alias_method :==, :eql?
+
+    def to_s
+      "#{stubbee}.#{method_name}"
+    end
+
+    private
+
+    def retain_original_visibility(method_owner)
+      return unless @original_visibility
+      Module.instance_method(@original_visibility).bind(method_owner).call(method_name)
+    end
+
+    def store_original_method_visibility
+      @original_visibility = original_method_owner.__method_visibility__(method_name)
+    end
+
+    def stub_method_overwrites_original_method?
+      @original_method && @original_method.owner == original_method_owner
+    end
+
+    def remove_original_method_from_stubbee
+      original_method_owner.send(:remove_method, method_name)
+    end
+
+    def use_prepended_module_for_stub_method?
+      RUBY_V2_PLUS
+    end
+
+    def use_prepended_module_for_stub_method
+      @stub_method_owner = PrependedModule.new
+      original_method_owner.__send__ :prepend, @stub_method_owner
+    end
+
+    def stub_method_owner
+      @stub_method_owner ||= original_method_owner
+    end
+  end
+end

data/lib/mocha/test_unit.rb

@@ -1,3 +1,8 @@
 require 'mocha/integration/test_unit'
+require 'mocha/deprecation'
 
-Mocha::Integration::TestUnit.activate
+unless Mocha::Integration::TestUnit.activate
+  Mocha::Deprecation.warning(
+    "Test::Unit must be loaded *before* `require 'mocha/test_unit'`."
+  )
+end

data/lib/mocha/thrower.rb

@@ -5,7 +5,8 @@ module Mocha
       @object = object
     end
 
-    def evaluate
+    def evaluate(invocation)
+      invocation.threw(@tag, @object)
       throw @tag, @object
     end
   end

data/lib/mocha/thrown_object.rb

@@ -0,0 +1,12 @@
+module Mocha
+  class ThrownObject
+    def initialize(tag, value = nil)
+      @tag = tag
+      @value = value
+    end
+
+    def mocha_inspect
+      "threw (#{@tag.mocha_inspect}, #{@value.mocha_inspect})"
+    end
+  end
+end

data/lib/mocha/version.rb

@@ -1,3 +1,3 @@
 module Mocha
-  VERSION = '1.8.0'.freeze
+  VERSION = '1.13.0'.freeze
 end

data/lib/mocha/yield_parameters.rb

@@ -1,7 +1,3 @@
-require 'mocha/no_yields'
-require 'mocha/single_yield'
-require 'mocha/multiple_yields'
-
 module Mocha
   class YieldParameters
     def initialize
@@ -10,18 +6,16 @@ module Mocha
 
     def next_invocation
       case @parameter_groups.length
-      when 0 then NoYields.new
+      when 0 then []
       when 1 then @parameter_groups.first
       else @parameter_groups.shift
       end
     end
 
-    def add(*parameters)
-      @parameter_groups << SingleYield.new(*parameters)
-    end
-
-    def multiple_add(*parameter_groups)
-      @parameter_groups << MultipleYields.new(*parameter_groups)
+    def add(*parameter_groups)
+      @parameter_groups << parameter_groups.map do |pg|
+        pg.is_a?(Array) ? pg : [pg]
+      end
     end
   end
 end

data/lib/mocha.rb

@@ -1 +1,9 @@
 require 'mocha/version'
+require 'mocha/ruby_version'
+require 'mocha/deprecation'
+
+if Mocha::PRE_RUBY_V19
+  Mocha::Deprecation.warning(
+    'Versions of Ruby earlier than v1.9 will not be supported in future versions of Mocha.'
+  )
+end

data/mocha.gemspec

@@ -2,7 +2,7 @@ lib = File.expand_path('../lib/', __FILE__)
 $LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
 require 'mocha/version'
 
-Gem::Specification.new do |s|
+Gem::Specification.new do |s| # rubocop:disable Metrics/BlockLength
   s.name = 'mocha'
   s.version = Mocha::VERSION
   s.licenses = ['MIT', 'BSD-2-Clause']
@@ -12,16 +12,16 @@ Gem::Specification.new do |s|
   s.description = 'Mocking and stubbing library with JMock/SchMock syntax, which allows mocking and stubbing of methods on real (non-mock) classes.'
   s.email = 'mocha-developer@googlegroups.com'
 
-  s.files = `git ls-files`.split("\n")
-  s.files.delete('.travis.yml')
+  s.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(docs|test)/}) }
+  end
+  s.files.delete('.circleci/config.yml')
   s.files.delete('.gitignore')
 
   s.homepage = 'https://mocha.jamesmead.org'
   s.require_paths = ['lib']
   s.summary = 'Mocking and stubbing library'
 
-  s.add_dependency('metaclass', '~> 0.0.1')
-
   unless s.respond_to?(:add_development_dependency)
     class << s
       def add_development_dependency(*args)
@@ -30,18 +30,22 @@ Gem::Specification.new do |s|
     end
   end
 
-  if RUBY_VERSION >= '1.9.3'
-    s.add_development_dependency('rake')
+  if RUBY_VERSION < '1.9.3'
+    s.add_development_dependency 'rake', '~> 10.0'
+  elsif RUBY_VERSION < '2'
+    s.add_development_dependency 'rake', '~> 12.2.1'
+  elsif RUBY_VERSION < '2.2'
+    s.add_development_dependency 'rake', '~> 12.3.3'
   else
-    # Rake >= v11 does not support Ruby < v1.9.3 so use
-    s.add_development_dependency('rake', '~> 10.0')
+    s.add_development_dependency 'rake'
   end
+
   s.add_development_dependency('introspection', '~> 0.0.1')
   if RUBY_VERSION >= '2.2.0'
     # No test libraries in standard library
     s.add_development_dependency('minitest')
   end
-  if RUBY_VERSION >= '1.9.2'
+  if RUBY_VERSION >= '2.2.0'
     s.add_development_dependency('rubocop', '<= 0.58.2')
   end
   if ENV['MOCHA_GENERATE_DOCS']