mocktail 1.1.0 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a9c74cd3ff5167b99c38892ee6411a1ac3f1379158c062076bfbe6d8479c7b7
-  data.tar.gz: 81dd2b80a78c162a9c4030fa8bc9be42741c3a8c053fa33c319dc13c404234a8
+  metadata.gz: 0aa187046d2e07280352ba6f0296f5573bda910acb111e06d0932f0e2518064e
+  data.tar.gz: c3e5e74d586969ea5dd88dc86c20a9d2e6f223f1bb8a438325583a8d8fb20bae
 SHA512:
-  metadata.gz: bd1fbc482135e89dea00de9249d63b5e851d64ecb2f4afc898b4bb77abf5afc96303cfed6b59665d0e51ab4b2c8dd4c438dc2a7ab93d1c69e1d12d723797cf9a
-  data.tar.gz: 3af137dd6d1488b1ef41ac0b47178a224e160f11dce0ed0cbeb24418ae4a33c86a6e4fa8e3cabb20c8421c8ac1ac8c166045051d996d4aa1dc709e4fcc97ec3a
+  metadata.gz: 224a377d46c11b830b90a828e6a0c294e940c3492cde42fda9aa0f865b97cdc69773571d4464bd4bbe185aa29e6860c5a4c2b3b87a458382a84b330ddce5df3e
+  data.tar.gz: 10562536842265afc7f6bef9fa63a8ebab657e78941f13bc0e38cb49cf8f43785d1d926d0f5afe103165d337fe2163cba88aa4aee220004c8a2494e5f5493d4c

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+# 1.1.3
+
+* Improve the robustness of how we call the original methods on doubles &
+  replaced class methods on mocks internally by Mocktail to avoid behavior being
+  altered by how users configure mock objects
+
+# 1.1.2
+
+* Fix cases where classes that redefine built-in methods could cause issues when
+  Mocktail in turn called those methods internally
+  [#15](https://github.com/testdouble/mocktail/pull/15)
+
+# 1.1.1
+
+* Improve output for undefined singleton methods
+  ([#11](https://github.com/testdouble/mocktail/pull/11) by
+  [@calebhearth](https://github.com/calebhearth))
+
 # 1.1.0
 
 * Feature: add support for passing methods to `Mocktail.explain()`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mocktail (1.1.0)
+    mocktail (1.1.3)
 
 GEM
   remote: https://rubygems.org/
@@ -11,28 +11,28 @@ GEM
     docile (1.4.0)
     method_source (1.0.0)
     minitest (5.15.0)
-    parallel (1.21.0)
-    parser (3.1.0.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.2.0)
+    regexp_parser (2.3.0)
     rexml (3.2.5)
-    rubocop (1.25.0)
+    rubocop (1.27.0)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.15.1, < 2.0)
+      rubocop-ast (>= 1.16.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.15.1)
-      parser (>= 3.0.1.1)
-    rubocop-performance (1.13.2)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.13.3)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
@@ -41,10 +41,10 @@ GEM
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.3)
-    standard (1.7.0)
-      rubocop (= 1.25.0)
-      rubocop-performance (= 1.13.2)
+    simplecov_json_formatter (0.1.4)
+    standard (1.10.0)
+      rubocop (= 1.27.0)
+      rubocop-performance (= 1.13.3)
     unicode-display_width (2.1.0)
 
 PLATFORMS

data/README.md

@@ -10,6 +10,11 @@ library for Ruby that provides a terse and robust API for creating mocks,
 getting them in the hands of the code you're testing, stub & verify behavior,
 and even safely override class methods.
 
+If you'd prefer a voice & video introduction to Mocktail aside from this README,
+you might enjoy this ⚡️[Lightning
+Talk](https://blog.testdouble.com/talks/2022-05-18-please-mock-me?utm_source=twitter&utm_medium=organic-social&utm_campaign=conf-talk)⚡️ 
+from RailsConf 2022.
+
 ## An aperitif
 
 Before getting into the details, let's demonstrate what Mocktail's API looks
@@ -813,10 +818,35 @@ Calling reset in a `teardown` or `after(:each)` hook will also improve the
 usefulness of messages returned by `Mocktail.explain` and
 `Mocktail.explain_nils`.
 
+## References
+
+Mocktail is designed following a somewhat academic understanding of what mocking
+is and how it should be used. Below are several references on this topic.
+
+Blog Posts and Papers:
+
+- [Endo-Testing: Unit Testing with Mock
+  Objects](<https://www2.ccs.neu.edu/research/demeter/related-work/extreme-programming/MockObjectsFinal.PDF>
+  by Tim Mackinnon, Steve Freeman, and Philip Craig, the paper that introduced
+  mocking presented by the creators of mocking.
+- Michael Feathers' [The Flawed Theory Behind Unit
+  Testing](<https://michaelfeathers.typepad.com/michael_feathers_blog/2008/06/the-flawed-theo.html>)
+
+Books:
+
+- [_Growing Object-Oriented Software, Guided by
+  Tests_](<https://bookshop.org/books/growing-object-oriented-software-guided-by-tests/9780321503626>)
+  by Steve Freeman and Nat Price
+
+Talks:
+
+- [Please don’t mock me](https://www.youtube.com/watch?v=Af4M8GMoxi4) by Justin
+  Searls
+
 ## Acknowledgements
 
 Mocktail is created & maintained by the software agency [Test
-Double](https://twitter.com). If you've ever come across our eponymously-named
+Double](https://testdouble.com). If you've ever come across our eponymously-named
 [testdouble.js](https://github.com/testdouble/testdouble.js/), you might find
 Mocktail's API to be quite similar. The term "test double" was originally coined
 by Gerard Meszaros in his book [xUnit Test
@@ -839,4 +869,3 @@ including (but not limited to) one-on-one communications, public posts/comments,
 code reviews, pull requests, and GitHub issues. If violations occur, Test Double
 will take any action they deem appropriate for the infraction, up to and
 including blocking a user from the organization's repositories.
-

data/lib/mocktail/debug.rb

@@ -0,0 +1,49 @@
+module Mocktail
+  module Debug
+    # It would be easy and bad for the mocktail lib to call something like
+    #
+    #   double == other_double
+    #
+    # But if it's a double, that means anyone who stubs that method could change
+    # the internal behavior of the library in unexpected ways (as happened here:
+    # https://github.com/testdouble/mocktail/issues/7 )
+    #
+    # For that reason when we run our tests, we also want to blow up if this
+    # happens unintentionally. This works in conjunction with the test
+    # MockingMethodfulClassesTest, because it mocks every defined method on the
+    # mocked BasicObject
+    def self.guard_against_mocktail_accidentally_calling_mocks_if_debugging!
+      return unless ENV["MOCKTAIL_DEBUG_ACCIDENTAL_INTERNAL_MOCK_CALLS"]
+      raise
+    rescue => e
+      base_path = Pathname.new(__FILE__).dirname.to_s
+      backtrace_minus_this_and_whoever_called_this = e.backtrace[2..]
+      internal_call_sites = backtrace_minus_this_and_whoever_called_this.take_while { |call_site|
+        # the "in `block" is very confusing but necessary to include lines after
+        # a stubs { blah.foo }.with { … } call, since that's when most of the
+        # good stuff happens
+        call_site.start_with?(base_path) || call_site.include?("in `block")
+      }.reject { |call_site| call_site.include?("in `block") }
+
+      approved_call_sites = [
+        "fulfills_stubbing.rb:14",
+        "validates_arguments.rb:16",
+        "validates_arguments.rb:19"
+      ]
+      if internal_call_sites.any? && approved_call_sites.none? { |approved_call_site|
+        internal_call_sites.first.include?(approved_call_site)
+      }
+        raise Error.new <<~MSG
+          Unauthorized internal call of a mock internally by Mocktail itself:
+
+          #{internal_call_sites.first}
+
+          Offending call's complete stack trace:
+
+          #{backtrace_minus_this_and_whoever_called_this.join("\n")}
+          ==END OFFENDING TRACE==
+        MSG
+      end
+    end
+  end
+end

data/lib/mocktail/handles_dry_call/fulfills_stubbing/describes_unsatisfied_stubbing.rb

@@ -1,4 +1,5 @@
 require_relative "../../share/cleans_backtrace"
+require_relative "../../share/bind"
 
 module Mocktail
   class DescribesUnsatisfiedStubbing
@@ -10,7 +11,7 @@ module Mocktail
       UnsatisfyingCall.new(
         call: dry_call,
         other_stubbings: Mocktail.cabinet.stubbings.select { |stubbing|
-          dry_call.double == stubbing.recording.double &&
+          Bind.call(dry_call.double, :==, stubbing.recording.double) &&
             dry_call.method == stubbing.recording.method
         },
         backtrace: @cleans_backtrace.clean(Error.new).backtrace

data/lib/mocktail/imitates_type/makes_double/declares_dry_class.rb

@@ -41,7 +41,10 @@ module Mocktail
     def define_double_methods!(dry_class, type, instance_methods)
       handles_dry_call = @handles_dry_call
       instance_methods.each do |method|
+        dry_class.undef_method(method) if dry_class.method_defined?(method)
+
         dry_class.define_method method, ->(*args, **kwargs, &block) {
+          Debug.guard_against_mocktail_accidentally_calling_mocks_if_debugging!
           handles_dry_call.handle(Call.new(
             singleton: false,
             double: self,

data/lib/mocktail/matchers/any.rb

@@ -4,7 +4,9 @@ module Mocktail::Matchers
       :any
     end
 
-    def initialize
+    # Change this comment to a descriptive one once this is merged:
+    # https://github.com/rubocop/rubocop/pull/10551
+    def initialize # standard:disable Style/RedundantInitialize
     end
 
     def match?(actual)

data/lib/mocktail/matchers/numeric.rb

@@ -4,7 +4,9 @@ module Mocktail::Matchers
       :numeric
     end
 
-    def initialize
+    # Change this comment to a descriptive one once this is merged:
+    # https://github.com/rubocop/rubocop/pull/10551
+    def initialize # standard:disable Style/RedundantInitialize
     end
 
     def match?(actual)

data/lib/mocktail/raises_neato_no_method_error.rb

@@ -18,7 +18,7 @@ module Mocktail
 
         Need to define the method? Here's a sample definition:
 
-          def #{call.method}#{params(call)}
+          def #{"self." if call.singleton}#{call.method}#{params(call)}
           end
         #{corrections(call)}
       MSG

data/lib/mocktail/replaces_type/redefines_singleton_methods.rb

@@ -12,6 +12,7 @@ module Mocktail
         type.method(name)
       } - [type_replacement.replacement_new]
 
+      declare_singleton_method_missing_errors!(type)
       handles_dry_call = @handles_dry_call
       type_replacement.replacement_methods = type_replacement.original_methods.map { |original_method|
         type.singleton_class.send(:undef_method, original_method.name)
@@ -35,5 +36,27 @@ module Mocktail
         type.singleton_method(original_method.name)
       }
     end
+
+    def declare_singleton_method_missing_errors!(type)
+      return if type.singleton_methods.include?(:method_missing)
+
+      raises_neato_no_method_error = RaisesNeatoNoMethodError.new
+      type.define_singleton_method :method_missing,
+        ->(name, *args, **kwargs, &block) {
+          raises_neato_no_method_error.call(
+            Call.new(
+              singleton: true,
+              double: self,
+              original_type: type,
+              dry_type: self.class,
+              method: name,
+              original_method: nil,
+              args: args,
+              kwargs: kwargs,
+              block: block
+            )
+          )
+        }
+    end
   end
 end

data/lib/mocktail/share/bind.rb

@@ -0,0 +1,14 @@
+module Mocktail
+  module Bind
+    def self.call(mock, method_name, *args, **kwargs, &blk)
+      if Mocktail.cabinet.double_for_instance(mock)
+        Object.instance_method(method_name).bind_call(mock, *args, **kwargs, &blk)
+      elsif (type_replacement = TopShelf.instance.type_replacement_if_exists_for(mock)) &&
+          (og_method = type_replacement.original_methods&.find { |m| m.name == method_name })
+        og_method.call(*args, **kwargs, &blk)
+      else
+        mock.__send__(method_name, *args, **kwargs, &blk)
+      end
+    end
+  end
+end

data/lib/mocktail/share/determines_matching_calls.rb

@@ -1,7 +1,9 @@
+require_relative "bind"
+
 module Mocktail
   class DeterminesMatchingCalls
     def determine(real_call, demo_call, demo_config)
-      real_call.double == demo_call.double &&
+      Bind.call(real_call.double, :==, demo_call.double) &&
         real_call.method == demo_call.method &&
 
         # Matcher implementation will replace this:
@@ -49,11 +51,11 @@ module Mocktail
     end
 
     def match?(real_arg, demo_arg)
-      if demo_arg.respond_to?(:is_mocktail_matcher?) &&
+      if Bind.call(demo_arg, :respond_to?, :is_mocktail_matcher?) &&
           demo_arg.is_mocktail_matcher?
         demo_arg.match?(real_arg)
       else
-        demo_arg == real_arg
+        Bind.call(demo_arg, :==, real_arg)
       end
     end
   end

data/lib/mocktail/simulates_argument_error/transforms_params.rb

@@ -1,3 +1,5 @@
+require_relative "../share/bind"
+
 module Mocktail
   class TransformsParams
     def transform(dry_call)
@@ -5,12 +7,12 @@ module Mocktail
 
       Signature.new(
         positional_params: Params.new(
-          all: params.select { |type, _|
-            [:req, :opt, :rest].include?(type)
+          all: params.select { |t, _|
+            [:req, :opt, :rest].any? { |param_type| Bind.call(t, :==, param_type) }
           }.map { |_, name| name },
-          required: params.select { |t, _| t == :req }.map { |_, n| n },
-          optional: params.select { |t, _| t == :opt }.map { |_, n| n },
-          rest: params.find { |type, _| type == :rest } & [1]
+          required: params.select { |t, _| Bind.call(t, :==, :req) }.map { |_, n| n },
+          optional: params.select { |t, _| Bind.call(t, :==, :opt) }.map { |_, n| n },
+          rest: params.find { |t, _| Bind.call(t, :==, :rest) } & [1]
         ),
         positional_args: dry_call.args,
 
@@ -18,13 +20,13 @@ module Mocktail
           all: params.select { |type, _|
             [:keyreq, :key, :keyrest].include?(type)
           }.map { |_, name| name },
-          required: params.select { |t, _| t == :keyreq }.map { |_, n| n },
-          optional: params.select { |t, _| t == :key }.map { |_, n| n },
-          rest: params.find { |type, _| type == :keyrest } & [1]
+          required: params.select { |t, _| Bind.call(t, :==, :keyreq) }.map { |_, n| n },
+          optional: params.select { |t, _| Bind.call(t, :==, :key) }.map { |_, n| n },
+          rest: params.find { |t, _| Bind.call(t, :==, :keyrest) } & [1]
         ),
         keyword_args: dry_call.kwargs,
 
-        block_param: params.find { |type, _| type == :block } & [1],
+        block_param: params.find { |t, _| Bind.call(t, :==, :block) } & [1],
         block_arg: dry_call.block
       )
     end

data/lib/mocktail/value/cabinet.rb

@@ -1,3 +1,5 @@
+require_relative "../share/bind"
+
 # The Cabinet stores all thread-local state, so anything that goes here
 # is guaranteed by Mocktail to be local to the currently-running thread
 module Mocktail
@@ -45,15 +47,22 @@ module Mocktail
     end
 
     def double_for_instance(thing)
-      @doubles.find { |double| double.dry_instance == thing }
+      @doubles.find { |double|
+        # Intentionally calling directly to avoid an infinite recursion in Bind.call
+        Object.instance_method(:==).bind_call(double.dry_instance, thing)
+      }
     end
 
     def stubbings_for_double(double)
-      @stubbings.select { |stubbing| stubbing.recording.double == double.dry_instance }
+      @stubbings.select { |stubbing|
+        Bind.call(stubbing.recording.double, :==, double.dry_instance)
+      }
     end
 
     def calls_for_double(double)
-      @calls.select { |call| call.double == double.dry_instance }
+      @calls.select { |call|
+        Bind.call(call.double, :==, double.dry_instance)
+      }
     end
   end
 end

data/lib/mocktail/version.rb

@@ -1,3 +1,3 @@
 module Mocktail
-  VERSION = "1.1.0"
+  VERSION = "1.1.3"
 end

data/lib/mocktail.rb

@@ -1,3 +1,4 @@
+require_relative "mocktail/debug"
 require_relative "mocktail/dsl"
 require_relative "mocktail/errors"
 require_relative "mocktail/explains_thing"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mocktail
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.3
 platform: ruby
 authors:
 - Justin Searls
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-27 00:00:00.000000000 Z
+date: 2022-06-28 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -29,6 +29,7 @@ files:
 - bin/console
 - bin/setup
 - lib/mocktail.rb
+- lib/mocktail/debug.rb
 - lib/mocktail/dsl.rb
 - lib/mocktail/errors.rb
 - lib/mocktail/explains_nils.rb
@@ -66,6 +67,7 @@ files:
 - lib/mocktail/replaces_type/redefines_new.rb
 - lib/mocktail/replaces_type/redefines_singleton_methods.rb
 - lib/mocktail/resets_state.rb
+- lib/mocktail/share/bind.rb
 - lib/mocktail/share/cleans_backtrace.rb
 - lib/mocktail/share/creates_identifier.rb
 - lib/mocktail/share/determines_matching_calls.rb
@@ -117,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Take your objects, and make them a double