mocha 2.8.0 → 3.0.0.pre.rc.2

data/lib/mocha/integration/minitest.rb

@@ -1,23 +1,24 @@
-require 'mocha/debug'
+# frozen_string_literal: true
+
 require 'mocha/detection/minitest'
 require 'mocha/integration/minitest/adapter'
 
 module Mocha
   module Integration
     module Minitest
-      def self.activate
+      def self.activate # rubocop:disable Naming/PredicateMethod
         target = Detection::Minitest.testcase
         return false unless target
 
         minitest_version = Gem::Version.new(Detection::Minitest.version)
-        Debug.puts "Detected Minitest version: #{minitest_version}"
+        warn "Detected Minitest version: #{minitest_version}" if $DEBUG
 
         unless Minitest::Adapter.applicable_to?(minitest_version)
           raise 'Versions of minitest earlier than v3.3.0 are not supported.'
         end
 
         unless target < Minitest::Adapter
-          Debug.puts "Applying #{Minitest::Adapter.description}"
+          warn "Applying #{Minitest::Adapter.description}" if $DEBUG
           target.send(:include, Minitest::Adapter)
         end
 

data/lib/mocha/integration/monkey_patcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mocha/api'
 
 module Mocha
@@ -5,12 +7,12 @@ module Mocha
     module MonkeyPatcher
       def self.apply(mod, run_method_patch)
         if mod < Mocha::API
-          Debug.puts "Mocha::API already included in #{mod}"
+          warn "Mocha::API already included in #{mod}" if $DEBUG
         else
           mod.send(:include, Mocha::API)
         end
         if mod.method_defined?(:run_before_mocha)
-          Debug.puts "#{mod}#run_before_mocha method already defined"
+          warn "#{mod}#run_before_mocha method already defined" if $DEBUG
         elsif mod.method_defined?(:run)
           mod.send(:alias_method, :run_before_mocha, :run)
           mod.send(:remove_method, :run)

data/lib/mocha/integration/test_unit/adapter.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 require 'mocha/api'
 require 'mocha/integration/assertion_counter'
 require 'mocha/expectation_error'
 
 module Mocha
   module Integration
+    # Contains {Adapter} that integrates Mocha into recent versions of Test::Unit.
     module TestUnit
       # Integrates Mocha into recent versions of Test::Unit.
       #
@@ -23,13 +26,15 @@ module Mocha
 
         # @private
         def self.included(mod)
-          mod.setup :mocha_setup, before: :prepend
+          mod.setup before: :prepend do
+            assertion_counter = Integration::AssertionCounter.new(self)
+            mocha_setup(assertion_counter)
+          end
 
           mod.exception_handler(:handle_mocha_expectation_error)
 
           mod.cleanup after: :append do
-            assertion_counter = Integration::AssertionCounter.new(self)
-            mocha_verify(assertion_counter)
+            mocha_verify
           end
 
           mod.teardown :mocha_teardown, after: :append
@@ -43,8 +48,9 @@ module Mocha
         end
 
         # @private
-        def handle_mocha_expectation_error(exception)
+        def handle_mocha_expectation_error(exception) # rubocop:disable Naming/PredicateMethod
           return false unless exception.is_a?(Mocha::ExpectationError)
+
           problem_occurred
           add_failure(exception.message, exception.backtrace)
           true

data/lib/mocha/integration/test_unit.rb

@@ -1,23 +1,24 @@
-require 'mocha/debug'
+# frozen_string_literal: true
+
 require 'mocha/detection/test_unit'
 require 'mocha/integration/test_unit/adapter'
 
 module Mocha
   module Integration
     module TestUnit
-      def self.activate
+      def self.activate # rubocop:disable Naming/PredicateMethod
         target = Detection::TestUnit.testcase
         return false unless target
 
         test_unit_version = Gem::Version.new(Detection::TestUnit.version)
-        Debug.puts "Detected Test::Unit version: #{test_unit_version}"
+        warn "Detected Test::Unit version: #{test_unit_version}" if $DEBUG
 
         unless TestUnit::Adapter.applicable_to?(test_unit_version)
           raise 'Versions of test-unit earlier than v2.5.1 are not supported.'
         end
 
         unless target < TestUnit::Adapter
-          Debug.puts "Applying #{TestUnit::Adapter.description}"
+          warn "Applying #{TestUnit::Adapter.description}" if $DEBUG
           target.send(:include, TestUnit::Adapter)
         end
 

data/lib/mocha/integration.rb

@@ -0,0 +1,5 @@
+module Mocha
+  # Contains adapters that provide built-in support for +Minitest+ and +Test::Unit+.
+  module Integration
+  end
+end

data/lib/mocha/invocation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mocha/parameters_matcher'
 require 'mocha/raised_exception'
 require 'mocha/return_values'
@@ -21,6 +23,7 @@ module Mocha
       yield_parameters.next_invocation.each do |yield_args|
         @yields << ParametersMatcher.new(yield_args)
         raise LocalJumpError unless @block
+
         @block.call(*yield_args)
       end
       return_values.next(self)
@@ -43,9 +46,9 @@ module Mocha
     end
 
     def call_description
-      description = "#{@mock.mocha_inspect}.#{@method_name}#{argument_description}"
-      description << ' { ... }' unless @block.nil?
-      description
+      strings = ["#{@mock.mocha_inspect}.#{@method_name}#{argument_description}"]
+      strings << ' { ... }' unless @block.nil?
+      strings.join
     end
 
     def short_call_description
@@ -53,9 +56,9 @@ module Mocha
     end
 
     def result_description
-      desc = "# => #{@result.mocha_inspect}"
-      desc << " after yielding #{@yields.map(&:mocha_inspect).join(', then ')}" if @yields.any?
-      desc
+      strings = ["# => #{@result.mocha_inspect}"]
+      strings << " after yielding #{@yields.map(&:mocha_inspect).join(', then ')}" if @yields.any?
+      strings.join
     end
 
     def full_description

data/lib/mocha/logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mocha
   class Logger
     def initialize(io)

data/lib/mocha/macos_version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mocha
   MACOS = /darwin/.match(RUBY_PLATFORM)
   MACOS_VERSION = MACOS && /darwin(\d+)/.match(RUBY_PLATFORM)[1].to_i

data/lib/mocha/method_matcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mocha
   class MethodMatcher
     attr_reader :expected_method_name

data/lib/mocha/minitest.rb

@@ -1,4 +1,5 @@
-require 'mocha/ruby_version'
+# frozen_string_literal: true
+
 require 'mocha/integration/minitest'
 
 unless Mocha::Integration::Minitest.activate

data/lib/mocha/mock.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'ruby2_keywords'
 require 'mocha/expectation'
 require 'mocha/expectation_list'
 require 'mocha/invocation'
-require 'mocha/names'
-require 'mocha/receivers'
+require 'mocha/default_name'
+require 'mocha/default_receiver'
 require 'mocha/method_matcher'
 require 'mocha/parameters_matcher'
 require 'mocha/argument_iterator'
@@ -114,8 +116,7 @@ module Mocha
     def expects(method_name_or_hash, backtrace = nil)
       expectation = nil
       iterator = ArgumentIterator.new(method_name_or_hash)
-      iterator.each do |*args|
-        method_name = args.shift
+      iterator.each do |method_name, *args|
         ensure_method_not_already_defined(method_name)
         expectation = Expectation.new(self, method_name, backtrace)
         expectation.in_sequence(@mockery.sequences.last) if @mockery.sequences.any?
@@ -153,8 +154,7 @@ module Mocha
     def stubs(method_name_or_hash, backtrace = nil)
       expectation = nil
       iterator = ArgumentIterator.new(method_name_or_hash)
-      iterator.each do |*args|
-        method_name = args.shift
+      iterator.each do |method_name, *args|
         ensure_method_not_already_defined(method_name)
         expectation = Expectation.new(self, method_name, backtrace)
         expectation.at_least(0)
@@ -276,8 +276,9 @@ module Mocha
     end
 
     # @private
-    def initialize(mockery, name = nil, receiver = nil)
+    def initialize(mockery, assertion_counter, name = nil, receiver = nil)
       @mockery = mockery
+      @assertion_counter = assertion_counter
       @name = name || DefaultName.new(self)
       @receiver = receiver || DefaultReceiver.new(self)
       @expectations = ExpectationList.new
@@ -315,13 +316,13 @@ module Mocha
     end
 
     # @private
-    def method_missing(symbol, *arguments, &block) # rubocop:disable Style/MethodMissingSuper
+    def method_missing(symbol, *arguments, &block)
       handle_method_call(symbol, arguments, block)
     end
     ruby2_keywords(:method_missing)
 
     # @private
-    def handle_method_call(symbol, arguments, block) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+    def handle_method_call(symbol, arguments, block)
       check_expiry
       check_responder_responds_to(symbol)
       invocation = Invocation.new(self, symbol, arguments, block)
@@ -355,8 +356,8 @@ module Mocha
     end
 
     # @private
-    def __verified__?(assertion_counter = nil)
-      @expectations.verified?(assertion_counter)
+    def __verified__?
+      @expectations.verified?(@assertion_counter)
     end
 
     # @private
@@ -389,7 +390,10 @@ module Mocha
     def raise_unexpected_invocation_error(invocation, matching_expectation)
       if @unexpected_invocation.nil?
         @unexpected_invocation = invocation
-        matching_expectation.invoke(invocation) if matching_expectation
+        if matching_expectation
+          matching_expectation.invoke(invocation)
+          @assertion_counter.increment
+        end
         call_description = @unexpected_invocation.call_description
         if matching_expectation && !matching_expectation.in_correct_order?
           call_description += ' invoked out of order'

data/lib/mocha/mockery.rb

@@ -1,7 +1,12 @@
+# frozen_string_literal: true
+
 require 'mocha/central'
 require 'mocha/mock'
-require 'mocha/names'
-require 'mocha/receivers'
+require 'mocha/name'
+require 'mocha/impersonating_name'
+require 'mocha/impersonating_any_instance_name'
+require 'mocha/object_receiver'
+require 'mocha/any_instance_receiver'
 require 'mocha/state_machine'
 require 'mocha/logger'
 require 'mocha/configuration'
@@ -12,6 +17,10 @@ require 'mocha/expectation_error_factory'
 module Mocha
   class Mockery
     class Null < self
+      def self.build
+        new(nil)
+      end
+
       def add_mock(*)
         raise_not_initialized_error
       end
@@ -34,49 +43,57 @@ module Mocha
 
     class << self
       def instance
-        @instances.last || Null.new
+        @instances.last || Null.build
       end
 
-      def setup
+      def setup(assertion_counter)
         @instances ||= []
-        mockery = new
+        mockery = new(assertion_counter)
         mockery.logger = instance.logger unless @instances.empty?
         @instances.push(mockery)
       end
 
-      def verify(*args)
-        instance.verify(*args)
+      def verify
+        instance.verify
       end
 
       def teardown(origin = nil)
+        if @instances.nil?
+          raise NotInitializedError, 'Mocha::Mockery.teardown called before Mocha::Mockery.setup'
+        end
+
         instance.teardown(origin)
       ensure
-        @instances.pop
+        @instances.pop unless @instances.nil?
       end
     end
 
+    def initialize(assertion_counter)
+      @assertion_counter = assertion_counter
+    end
+
     def named_mock(name)
-      add_mock(Mock.new(self, Name.new(name)))
+      add_mock(Mock.new(self, @assertion_counter, Name.new(name)))
     end
 
     def unnamed_mock
-      add_mock(Mock.new(self))
+      add_mock(Mock.new(self, @assertion_counter))
     end
 
     def mock_impersonating(object)
-      add_mock(Mock.new(self, ImpersonatingName.new(object), ObjectReceiver.new(object)))
+      add_mock(Mock.new(self, @assertion_counter, ImpersonatingName.new(object), ObjectReceiver.new(object)))
     end
 
     def mock_impersonating_any_instance_of(klass)
-      add_mock(Mock.new(self, ImpersonatingAnyInstanceName.new(klass), AnyInstanceReceiver.new(klass)))
+      add_mock(Mock.new(self, @assertion_counter, ImpersonatingAnyInstanceName.new(klass), AnyInstanceReceiver.new(klass)))
     end
 
     def new_state_machine(name)
       add_state_machine(StateMachine.new(name))
     end
 
-    def verify(assertion_counter = nil)
-      unless mocks.all? { |mock| mock.__verified__?(assertion_counter) }
+    def verify
+      unless mocks.all?(&:__verified__?)
         message = "not all expectations were satisfied\n#{mocha_inspect}"
         backtrace = if unsatisfied_expectations.empty?
                       caller
@@ -124,12 +141,11 @@ module Mocha
     def on_stubbing(object, method)
       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))
+        !(object.stubba_class.__method_exists__?(method) || object.stubba_respond_to?(method))
       end
       check(:stubbing_non_public_method, 'non-public method', signature_proc) do
-        object.stubba_class.__method_exists__?(method, false)
+        object.stubba_class.__method_exists__?(method, include_public_methods: 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
 
@@ -144,9 +160,11 @@ module Mocha
     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
 

data/lib/mocha/name.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Mocha
+  class Name
+    def initialize(name)
+      @name = name.to_s
+    end
+
+    def mocha_inspect
+      "#<Mock:#{@name}>"
+    end
+  end
+end

data/lib/mocha/not_initialized_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mocha/error_with_filtered_backtrace'
 
 module Mocha

data/lib/mocha/object_methods.rb

@@ -1,18 +1,27 @@
+# frozen_string_literal: true
+
 require 'mocha/mockery'
 require 'mocha/instance_method'
 require 'mocha/argument_iterator'
 require 'mocha/expectation_error_factory'
+require 'mocha/ignoring_warning'
 
 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
+    extend IgnoringWarning
+
     # @private
-    alias_method :_method, :method
+    JRUBY_ALIAS_SPECIAL_METHODS_WARNING = /accesses caller method's state and should not be aliased/.freeze
+
+    ignoring_warning(JRUBY_ALIAS_SPECIAL_METHODS_WARNING, if_: RUBY_ENGINE == 'jruby') do
+      alias_method :_method, :method
+    end
 
     # @private
-    def mocha(instantiate = true)
+    def mocha(instantiate: true)
       if instantiate
         @mocha ||= Mocha::Mockery.instance.mock_impersonating(self)
       else
@@ -40,6 +49,11 @@ module Mocha
       singleton_class
     end
 
+    # @private
+    def stubba_respond_to?(symbol)
+      respond_to?(symbol)
+    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.
@@ -75,11 +89,11 @@ module Mocha
       if frozen?
         raise StubbingError.new("can't stub method on frozen object: #{mocha_inspect}", caller)
       end
+
       expectation = nil
       mockery = Mocha::Mockery.instance
       iterator = ArgumentIterator.new(expected_methods_vs_return_values)
-      iterator.each do |*args|
-        method_name = args.shift
+      iterator.each do |method_name, *args|
         mockery.on_stubbing(self, method_name)
         method = stubba_method.new(stubba_object, method_name)
         mockery.stubba.stub(method)
@@ -121,11 +135,11 @@ module Mocha
       if frozen?
         raise StubbingError.new("can't stub method on frozen object: #{mocha_inspect}", caller)
       end
+
       expectation = nil
       mockery = Mocha::Mockery.instance
       iterator = ArgumentIterator.new(stubbed_methods_vs_return_values)
-      iterator.each do |*args|
-        method_name = args.shift
+      iterator.each do |method_name, *args|
         mockery.on_stubbing(self, method_name)
         method = stubba_method.new(stubba_object, method_name)
         mockery.stubba.stub(method)

data/lib/mocha/object_receiver.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Mocha
+  class ObjectReceiver
+    def initialize(object)
+      @object = object
+    end
+
+    def mocks
+      object = @object
+      mocks = []
+      while object
+        mocha = object.mocha(instantiate: false)
+        mocks << mocha if mocha
+        object = object.is_a?(Class) ? object.superclass : nil
+      end
+      mocks
+    end
+  end
+end

data/lib/mocha/parameter_matchers/all_of.rb

@@ -1,5 +1,6 @@
-require 'mocha/parameter_matchers/base'
-require 'mocha/parameter_matchers/deprecations'
+# frozen_string_literal: true
+
+require 'mocha/parameter_matchers/base_methods'
 
 module Mocha
   module ParameterMatchers
@@ -27,8 +28,6 @@ module Mocha
       end
     end
 
-    define_deprecated_matcher_method(:all_of)
-
     # Parameter matcher which combines a number of other matchers using a logical AND.
     class AllOf
       include BaseMethods
@@ -49,7 +48,5 @@ module Mocha
         "all_of(#{@matchers.map(&:mocha_inspect).join(', ')})"
       end
     end
-
-    provide_deprecated_access_to(:AllOf)
   end
 end

data/lib/mocha/parameter_matchers/any_of.rb

@@ -1,5 +1,6 @@
-require 'mocha/parameter_matchers/base'
-require 'mocha/parameter_matchers/deprecations'
+# frozen_string_literal: true
+
+require 'mocha/parameter_matchers/base_methods'
 
 module Mocha
   module ParameterMatchers
@@ -33,8 +34,6 @@ module Mocha
       end
     end
 
-    define_deprecated_matcher_method(:any_of)
-
     # Parameter matcher which combines a number of other matchers using a logical OR.
     class AnyOf
       include BaseMethods
@@ -55,7 +54,5 @@ module Mocha
         "any_of(#{@matchers.map(&:mocha_inspect).join(', ')})"
       end
     end
-
-    provide_deprecated_access_to(:AnyOf)
   end
 end

data/lib/mocha/parameter_matchers/any_parameters.rb

@@ -1,5 +1,6 @@
-require 'mocha/parameter_matchers/base'
-require 'mocha/parameter_matchers/deprecations'
+# frozen_string_literal: true
+
+require 'mocha/parameter_matchers/base_methods'
 
 module Mocha
   module ParameterMatchers
@@ -25,8 +26,6 @@ module Mocha
       end
     end
 
-    define_deprecated_matcher_method(:any_parameters)
-
     # Parameter matcher which always matches whatever the parameters.
     class AnyParameters
       include BaseMethods
@@ -44,7 +43,5 @@ module Mocha
         'any_parameters'
       end
     end
-
-    provide_deprecated_access_to(:AnyParameters)
   end
 end

data/lib/mocha/parameter_matchers/anything.rb

@@ -1,5 +1,6 @@
-require 'mocha/parameter_matchers/base'
-require 'mocha/parameter_matchers/deprecations'
+# frozen_string_literal: true
+
+require 'mocha/parameter_matchers/base_methods'
 
 module Mocha
   module ParameterMatchers
@@ -22,8 +23,6 @@ module Mocha
       end
     end
 
-    define_deprecated_matcher_method(:anything)
-
     # Parameter matcher which always matches a single parameter.
     class Anything
       include BaseMethods
@@ -39,7 +38,5 @@ module Mocha
         'anything'
       end
     end
-
-    provide_deprecated_access_to(:Anything)
   end
 end

data/lib/mocha/parameter_matchers/{base.rb → base_methods.rb}

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
+
 require 'mocha/deprecation'
-require 'mocha/parameter_matchers/deprecations'
 
 module Mocha
   module ParameterMatchers
@@ -59,20 +60,5 @@ module Mocha
         AnyOf.new(self, other)
       end
     end
-
-    # @deprecated Include +BaseMethods+ module instead.
-    class Base
-      include BaseMethods
-
-      # @private
-      def self.inherited(subclass)
-        super
-        Deprecation.warning(
-          "Include #{BaseMethods} module into #{subclass} instead of inheriting from #{self}."
-        )
-      end
-    end
-
-    provide_deprecated_access_to(:Base)
   end
 end

data/lib/mocha/parameter_matchers/equals.rb

@@ -1,5 +1,6 @@
-require 'mocha/parameter_matchers/base'
-require 'mocha/parameter_matchers/deprecations'
+# frozen_string_literal: true
+
+require 'mocha/parameter_matchers/base_methods'
 
 module Mocha
   module ParameterMatchers
@@ -28,8 +29,6 @@ module Mocha
       end
     end
 
-    define_deprecated_matcher_method(:equals)
-
     # Parameter matcher which matches when actual parameter equals expected value.
     class Equals
       include BaseMethods
@@ -50,7 +49,5 @@ module Mocha
         @value.mocha_inspect
       end
     end
-
-    provide_deprecated_access_to(:Equals)
   end
 end