mocha 1.1.0 → 1.13.0

data/lib/mocha/sequence.rb

@@ -1,16 +1,14 @@
 module Mocha
-
   # Used to constrain the order in which expectations can occur.
   #
   # @see API#sequence
   # @see Expectation#in_sequence
   class Sequence
-
     # @private
     class InSequenceOrderingConstraint
-
       def initialize(sequence, index)
-        @sequence, @index = sequence, index
+        @sequence = sequence
+        @index = index
       end
 
       def allows_invocation_now?
@@ -20,7 +18,6 @@ module Mocha
       def mocha_inspect
         "in sequence #{@sequence.mocha_inspect}"
       end
-
     end
 
     # @private
@@ -38,14 +35,12 @@ module Mocha
 
     # @private
     def satisfied_to_index?(index)
-      @expectations[0...index].all? { |expectation| expectation.satisfied? }
+      @expectations[0...index].all?(&:satisfied?)
     end
 
     # @private
     def mocha_inspect
-      "#{@name.mocha_inspect}"
+      @name.mocha_inspect.to_s
     end
-
   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

@@ -1,17 +1,14 @@
 require 'mocha/is_a'
 
 module Mocha
-
   class SingleReturnValue
-
     def initialize(value)
       @value = value
     end
 
-    def evaluate
+    def evaluate(invocation)
+      invocation.returned(@value)
       @value
     end
-
   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

@@ -1,52 +1,34 @@
 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
-
-      # @private
-      def initialize(state_machine, state)
-        @state_machine, @state = state_machine, state
-      end
-
+    # Provides the ability to determine whether a {StateMachine} is in a specified state at some point in the future.
+    class StatePredicate
       # @private
-      def activate
-        @state_machine.current_state = @state
+      def initialize(state_machine, state, description, &active_check)
+        @state_machine = state_machine
+        @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 = state_machine, 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
 
     # @private
@@ -77,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.
+    #
+    # @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.
     #
-    # Or provides a mechanism to determine whether the {StateMachine} is in the state specified by +state_name+ at some point in the future.
+    # @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+
     #
-    # @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(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.
-    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
 
     # @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/stubbing_error.rb

@@ -1,19 +1,8 @@
-require 'mocha/backtrace_filter'
+require 'mocha/error_with_filtered_backtrace'
 
 module Mocha
-
   # Exception raised when stubbing a particular method is not allowed.
   #
   # @see Configuration.prevent
-  class StubbingError < StandardError
-
-    # @private
-    def initialize(message = nil, backtrace = [])
-      super(message)
-      filter = BacktraceFilter.new
-      set_backtrace(filter.filtered(backtrace))
-    end
-
-  end
-
+  class StubbingError < ErrorWithFilteredBacktrace; end
 end

data/lib/mocha/test_unit.rb

@@ -1,3 +1,8 @@
-require "mocha/integration/test_unit"
+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

@@ -1,15 +1,13 @@
 module Mocha
-
   class Thrower
-
     def initialize(tag, object = nil)
-      @tag, @object = tag, object
+      @tag = tag
+      @object = object
     end
 
-    def evaluate
+    def evaluate(invocation)
+      invocation.threw(@tag, @object)
       throw @tag, @object
     end
-
   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.1.0"
+  VERSION = '1.13.0'.freeze
 end

data/lib/mocha/yield_parameters.rb

@@ -1,31 +1,21 @@
-require 'mocha/no_yields'
-require 'mocha/single_yield'
-require 'mocha/multiple_yields'
-
 module Mocha
-
   class YieldParameters
-
     def initialize
       @parameter_groups = []
     end
 
     def next_invocation
       case @parameter_groups.length
-        when 0 then NoYields.new
-        when 1 then @parameter_groups.first
-        else @parameter_groups.shift
+      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

@@ -1,53 +1,55 @@
-# -*- encoding: utf-8 -*-
 lib = File.expand_path('../lib/', __FILE__)
 $LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
-require "mocha/version"
+require 'mocha/version'
 
-Gem::Specification.new do |s|
-  s.name = "mocha"
+Gem::Specification.new do |s| # rubocop:disable Metrics/BlockLength
+  s.name = 'mocha'
   s.version = Mocha::VERSION
+  s.licenses = ['MIT', 'BSD-2-Clause']
+  s.required_ruby_version = '>= 1.8.7'
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["James Mead"]
-  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.authors = ['James Mead']
+  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.delete(".gitignore")
-
-  s.homepage = "http://gofreerange.com/mocha/docs"
-  s.require_paths = ["lib"]
-  s.rubyforge_project = "mocha"
-  s.summary = "Mocking and stubbing library"
-  s.has_rdoc = "yard"
+  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.add_dependency("metaclass", "~> 0.0.1")
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  s.homepage = 'https://mocha.jamesmead.org'
+  s.require_paths = ['lib']
+  s.summary = 'Mocking and stubbing library'
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency("rake", ">= 0")
-      s.add_development_dependency("introspection", "~> 0.0.1")
-      unless ENV["MOCHA_NO_DOCS"]
-        s.add_development_dependency("yard")
-        s.add_development_dependency("redcarpet", "~> 1")
-      end
-    else
-      s.add_dependency("rake", ">= 0")
-      s.add_dependency("introspection", "~> 0.0.1")
-      unless ENV["MOCHA_NO_DOCS"]
-        s.add_dependency("yard")
-        s.add_dependency("redcarpet", "~> 1")
+  unless s.respond_to?(:add_development_dependency)
+    class << s
+      def add_development_dependency(*args)
+        add_dependency(*args)
       end
     end
+  end
+
+  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
-    s.add_dependency("rake", ">= 0")
-    s.add_dependency("introspection", "~> 0.0.1")
-    unless ENV["MOCHA_NO_DOCS"]
-      s.add_dependency("yard")
-      s.add_dependency("redcarpet", "~> 1")
-    end
+    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 >= '2.2.0'
+    s.add_development_dependency('rubocop', '<= 0.58.2')
+  end
+  if ENV['MOCHA_GENERATE_DOCS']
+    s.add_development_dependency('redcarpet')
+    s.add_development_dependency('yard')
   end
 end

data/yard-templates/default/layout/html/google_analytics.erb

@@ -1,11 +1,8 @@
-<script src="/javascripts/app.js" type="text/javascript" charset="utf-8"></script>
-
+<script async src="https://www.googletagmanager.com/gtag/js?id=<%= ENV['GOOGLE_ANALYTICS_WEB_PROPERTY_ID'] %>"></script>
 <script>
-  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
-  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
-  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
-  })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+  window.dataLayer = window.dataLayer || [];
+  function gtag(){dataLayer.push(arguments);}
+  gtag('js', new Date());
 
-  ga('create', '<%= ENV['GOOGLE_ANALYTICS_WEB_PROPERTY_ID'] %>', 'gofreerange.com');
-  ga('send', 'pageview');
-</script>
+  gtag('config', '<%= ENV['GOOGLE_ANALYTICS_WEB_PROPERTY_ID'] %>');
+</script>

data/yard-templates/default/layout/html/setup.rb

@@ -1,6 +1,5 @@
 def init
   super
-  if ENV['GOOGLE_ANALYTICS_WEB_PROPERTY_ID']
-    sections[:layout] << :google_analytics
-  end
+  return unless ENV['GOOGLE_ANALYTICS_WEB_PROPERTY_ID']
+  sections[:layout] << :google_analytics
 end