mocktail 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f1b0c2f99097d0f23cb67928b5455ce5acf9fad24baee1dff64c748b60a8da9
-  data.tar.gz: 9595e5e672d13711a45447b8242977189700e6d0a044f9553e75d642e455f898
+  metadata.gz: 7eb64f90875e53a9bfd5b4d995f8526eb6695dd9bd8a88c850b02eed851cb96d
+  data.tar.gz: ae2b4443a3740c375c70e7e490cbe3463d9672f17665ae47930b6ee614e9891d
 SHA512:
-  metadata.gz: 5469cfd8d09da0ba752c60529cfc016acecea8b69107d07a467e576812e1d1abf74d05f3431228c4789bf3397059e249a3307dd788a7c4bce410a85f8d86d0ee
-  data.tar.gz: c7dea9981f4ed8f76b4f5595c0dd88d747f30371d6c5c6245f8bd498864850700e5ca9f1c1af06b67879b24bcdf90e14d5cfd7b2111838580f3fbd4554b3cbec
+  metadata.gz: de8d47071e93c4d406391a1155dea9b6a1a9ac89f56422ae29e6dda5f134c9e5e724ec8006aba833b5ff19d9d2dff4550384bc349506f5ab9cefe3fd2185af1d
+  data.tar.gz: 5bf88d0aadc08fe9a9380312cf491146439e72e335091e2e79849196b74e93aba20b0fac2d122152a4661008ee243b5b3b39cb6408fc776b2cc2567ffca0924f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mocktail (1.1.1)
+    mocktail (1.1.2)
 
 GEM
   remote: https://rubygems.org/

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
@@ -841,7 +846,7 @@ Talks:
 ## 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

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,17 +1,19 @@
 require_relative "../../share/cleans_backtrace"
+require_relative "../../share/compares_safely"
 
 module Mocktail
   class DescribesUnsatisfiedStubbing
     def initialize
       @cleans_backtrace = CleansBacktrace.new
+      @compares_safely = ComparesSafely.new
     end
 
     def describe(dry_call)
       UnsatisfyingCall.new(
         call: dry_call,
         other_stubbings: Mocktail.cabinet.stubbings.select { |stubbing|
-          dry_call.double == stubbing.recording.double &&
-            dry_call.method == stubbing.recording.method
+          @compares_safely.compare(dry_call.double, stubbing.recording.double) &&
+            @compares_safely.compare(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/share/compares_safely.rb

@@ -0,0 +1,7 @@
+module Mocktail
+  class ComparesSafely
+    def compare(thing, other_thing)
+      Object.instance_method(:==).bind_call(thing, other_thing)
+    end
+  end
+end

data/lib/mocktail/share/determines_matching_calls.rb

@@ -1,8 +1,14 @@
+require_relative "compares_safely"
+
 module Mocktail
   class DeterminesMatchingCalls
+    def initialize
+      @compares_safely = ComparesSafely.new
+    end
+
     def determine(real_call, demo_call, demo_config)
-      real_call.double == demo_call.double &&
-        real_call.method == demo_call.method &&
+      @compares_safely.compare(real_call.double, demo_call.double) &&
+        @compares_safely.compare(real_call.method, demo_call.method) &&
 
         # Matcher implementation will replace this:
         args_match?(real_call.args, demo_call.args, demo_config.ignore_extra_args) &&
@@ -53,7 +59,7 @@ module Mocktail
           demo_arg.is_mocktail_matcher?
         demo_arg.match?(real_arg)
       else
-        demo_arg == real_arg
+        demo_arg == real_arg # TODO <-- test if mock object and call safe compare if so, otherwise ==
       end
     end
   end

data/lib/mocktail/simulates_argument_error/transforms_params.rb

@@ -1,16 +1,22 @@
+require_relative "../share/compares_safely"
+
 module Mocktail
   class TransformsParams
+    def initialize
+      @compares_safely = ComparesSafely.new
+    end
+
     def transform(dry_call)
       params = dry_call.original_method.parameters
 
       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| @compares_safely.compare(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, _| @compares_safely.compare(t, :req) }.map { |_, n| n },
+          optional: params.select { |t, _| @compares_safely.compare(t, :opt) }.map { |_, n| n },
+          rest: params.find { |t, _| @compares_safely.compare(t, :rest) } & [1]
         ),
         positional_args: dry_call.args,
 
@@ -18,13 +24,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, _| @compares_safely.compare(t, :keyreq) }.map { |_, n| n },
+          optional: params.select { |t, _| @compares_safely.compare(t, :key) }.map { |_, n| n },
+          rest: params.find { |t, _| @compares_safely.compare(t, :keyrest) } & [1]
         ),
         keyword_args: dry_call.kwargs,
 
-        block_param: params.find { |type, _| type == :block } & [1],
+        block_param: params.find { |t, _| @compares_safely.compare(t, :block) } & [1],
         block_arg: dry_call.block
       )
     end

data/lib/mocktail/value/cabinet.rb

@@ -1,3 +1,5 @@
+require_relative "../share/compares_safely"
+
 # 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
@@ -6,6 +8,7 @@ module Mocktail
     attr_reader :calls, :stubbings, :unsatisfying_calls
 
     def initialize
+      @compares_safely = ComparesSafely.new
       @doubles = []
       @calls = []
       @stubbings = []
@@ -45,15 +48,19 @@ module Mocktail
     end
 
     def double_for_instance(thing)
-      @doubles.find { |double| double.dry_instance == thing }
+      @doubles.find { |double| @compares_safely.compare(double.dry_instance, thing) }
     end
 
     def stubbings_for_double(double)
-      @stubbings.select { |stubbing| stubbing.recording.double == double.dry_instance }
+      @stubbings.select { |stubbing|
+        @compares_safely.compare(stubbing.recording.double, double.dry_instance)
+      }
     end
 
     def calls_for_double(double)
-      @calls.select { |call| call.double == double.dry_instance }
+      @calls.select { |call|
+        @compares_safely.compare(call.double, double.dry_instance)
+      }
     end
   end
 end

data/lib/mocktail/version.rb

@@ -1,3 +1,3 @@
 module Mocktail
-  VERSION = "1.1.1"
+  VERSION = "1.1.2"
 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.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Justin Searls
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-14 00:00:00.000000000 Z
+date: 2022-06-25 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
@@ -67,6 +68,7 @@ files:
 - lib/mocktail/replaces_type/redefines_singleton_methods.rb
 - lib/mocktail/resets_state.rb
 - lib/mocktail/share/cleans_backtrace.rb
+- lib/mocktail/share/compares_safely.rb
 - lib/mocktail/share/creates_identifier.rb
 - lib/mocktail/share/determines_matching_calls.rb
 - lib/mocktail/share/stringifies_call.rb
@@ -117,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.6
 signing_key:
 specification_version: 4
 summary: Take your objects, and make them a double