mocktail 1.1.3 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0aa187046d2e07280352ba6f0296f5573bda910acb111e06d0932f0e2518064e
-  data.tar.gz: c3e5e74d586969ea5dd88dc86c20a9d2e6f223f1bb8a438325583a8d8fb20bae
+  metadata.gz: f98c176c091bd92d1c3f28be3c8c3eea66cbc3f3b56f9a2fac3f7f78d5eb2775
+  data.tar.gz: 9422af274277a791b225540f74e3c77f99aff75b908fb1529c56d6f47e35a27f
 SHA512:
-  metadata.gz: 224a377d46c11b830b90a828e6a0c294e940c3492cde42fda9aa0f865b97cdc69773571d4464bd4bbe185aa29e6860c5a4c2b3b87a458382a84b330ddce5df3e
-  data.tar.gz: 10562536842265afc7f6bef9fa63a8ebab657e78941f13bc0e38cb49cf8f43785d1d926d0f5afe103165d337fe2163cba88aa4aee220004c8a2494e5f5493d4c
+  metadata.gz: bc5ae9538c17efdc5675c1f19ca1daaa72dea52162f469fd4a295e68d6d5755792f8533a4c7244d0146e82edfb688dab3a608ea449ba57da3b56ac2e15c75f48
+  data.tar.gz: 381e52bf6c28151c0ab1dfba3f300df8cd8bc5cf218ddcc735e7dfdced93649f5f4e299fffefc449eb24cf3589c4067d23f7cffb313262c54409290ca10ac1a2

data/.standard.yml

@@ -1 +1 @@
-ruby_version: 2.7
+ruby_version: 3.0

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 1.2.1
+
+* Adds support for faking methods that use options hashes that are called with
+  and without curly braces [#17](https://github.com/testdouble/mocktail/pull/17)
+  (This is a sweeping change and there will probably be bugs.)
+
+# 1.2.0
+
+* Introduce the Mocktail.calls() API https://github.com/testdouble/mocktail/pull/16
+
 # 1.1.3
 
 * Improve the robustness of how we call the original methods on doubles &

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mocktail (1.1.3)
+    mocktail (1.2.1)
 
 GEM
   remote: https://rubygems.org/
@@ -9,30 +9,32 @@ GEM
     ast (2.4.2)
     coderay (1.1.3)
     docile (1.4.0)
+    json (2.6.2)
     method_source (1.0.0)
-    minitest (5.15.0)
+    minitest (5.16.3)
     parallel (1.22.1)
-    parser (3.1.2.0)
+    parser (3.1.2.1)
       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.3.0)
+    regexp_parser (2.6.0)
     rexml (3.2.5)
-    rubocop (1.27.0)
+    rubocop (1.39.0)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.16.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.17.0)
+    rubocop-ast (1.23.0)
       parser (>= 3.1.1.0)
-    rubocop-performance (1.13.3)
+    rubocop-performance (1.15.0)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
@@ -42,10 +44,10 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     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)
+    standard (1.18.0)
+      rubocop (= 1.39.0)
+      rubocop-performance (= 1.15.0)
+    unicode-display_width (2.3.0)
 
 PLATFORMS
   arm64-darwin-20

data/README.md

@@ -12,7 +12,7 @@ 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)⚡️ 
+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
@@ -404,6 +404,10 @@ verify { |m| auditor.record!("ok", user_id: 1) { |block| block.call.is_a?(Date)
 * `ignore_block` will similarly allow the demonstration to forego specifying a
   block, even if the actual call receives one
 
+Note that if you want to verify a method _wasn't_ called at all or called a
+specific number of times—especially if you don't care about the parameters, you
+may want to look at the [Mocktail.calls()](#mocktailcalls) API.
+
 ### Mocktail.matchers
 
 You'll probably never need to call `Mocktail.matchers` directly, because it's
@@ -807,6 +811,53 @@ The `reference` object will have details of the `call` itself, an array of
 `other_stubbings` defined on the faked method, and a `backtrace` to determine
 which call site produced the unexpected `nil` value.
 
+### Mocktail.calls
+
+When practicing test-driven development, you may want to ensure that a
+dependency wasn't called at all. To provide a terse way to express this, 
+Mocktail offers a top-level `calls(double, method_name = nil)` method that 
+returns an array of the calls to the mock (optionally filtered to a 
+particular method name) in the order they were called.
+
+Suppose you were writing a test of this method for example:
+
+```ruby
+def import_users
+  users_response = @gets_users.get
+  if users_response.success?
+    @upserts_users.upsert(users_response.data)
+  end
+end
+```
+
+A test case of the negative branch of that `if` statement (when `success?` is
+false) might simply want to assert that `@upserts_users.upsert` wasn't called at
+all, regardless of its parameters.
+
+The easiest way to do this is to use `Mocktail.calls()` method, which is an
+alias of [Mocktail.explain(double).reference.calls](#mocktailexplain) that can
+filter to a specific method name. In the case of a test of the above method, you
+could assert:
+
+```ruby
+# Assert that the `upsert` method on the mock was never called
+assert_equal 0, Mocktail.calls(@upserts_users, :upsert).size
+
+# Assert that NO METHODS on the mock were called at all:
+assert_equal 0, Mocktail.calls(@upserts_users).size
+```
+
+If you're interested in doing more complicated introspection in the nature of
+the calls, their ordering, and so forth, the `calls` method will return
+`Mocktail::Call` values with the args, kwargs, block, and information about the
+original class and method being mocked.
+
+(While this behavior can technically be accomplished with `verify(times: 0) { …
+}`, it's verbose and error prone to do so. Because `verify` is careful to only
+assert exact argument matches, it can get pretty confusing to remember to tack
+on `ignore_extra_args: true` and to call the method with zero args to cover all
+cases.)
+
 ### Mocktail.reset
 
 This one's simple: you probably want to call `Mocktail.reset` after each test,

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/lib/mocktail/collects_calls.rb

@@ -0,0 +1,13 @@
+module Mocktail
+  class CollectsCalls
+    def collect(double, method_name)
+      calls = ExplainsThing.new.explain(double).reference.calls
+
+      if method_name.nil?
+        calls
+      else
+        calls.select { |call| call.method.to_s == method_name.to_s }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+module Mocktail
+  class ReconstructsCall
+    def reconstruct(double:, call_binding:, default_args:, dry_class:, type:, method:, original_method:, signature:)
+      Call.new(
+        singleton: false,
+        double: double,
+        original_type: type,
+        dry_type: dry_class,
+        method: method,
+        original_method: original_method,
+        args: args_for(signature, call_binding, default_args),
+        kwargs: kwargs_for(signature, call_binding, default_args),
+        block: call_binding.local_variable_get(signature.block_param || ::Mocktail::Signature::DEFAULT_BLOCK_PARAM)
+      )
+    end
+
+    private
+
+    def args_for(signature, call_binding, default_args)
+      arg_names, rest_name = non_default_args(signature.positional_params, default_args)
+
+      arg_values = arg_names.map { |p| call_binding.local_variable_get(p) }
+      rest_value = call_binding.local_variable_get(rest_name) if rest_name
+
+      arg_values + (rest_value || [])
+    end
+
+    def kwargs_for(signature, call_binding, default_args)
+      kwarg_names, kwrest_name = non_default_args(signature.keyword_params, default_args)
+
+      kwarg_values = kwarg_names.to_h { |p| [p, call_binding.local_variable_get(p)] }
+      kwrest_value = call_binding.local_variable_get(kwrest_name) if kwrest_name
+
+      kwarg_values.merge(kwrest_value || {})
+    end
+
+    def non_default_args(params, default_args)
+      named_args = params.allowed
+        .reject { |p| default_args&.key?(p) }
+      rest_arg = if params.rest && !default_args&.key?(params.rest)
+        params.rest
+      end
+
+      [named_args, rest_arg]
+    end
+  end
+end

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

@@ -1,8 +1,11 @@
+require_relative "declares_dry_class/reconstructs_call"
+
 module Mocktail
   class DeclaresDryClass
     def initialize
-      @handles_dry_call = HandlesDryCall.new
       @raises_neato_no_method_error = RaisesNeatoNoMethodError.new
+      @transforms_params = TransformsParams.new
+      @stringifies_method_signature = StringifiesMethodSignature.new
     end
 
     def declare(type, instance_methods)
@@ -39,24 +42,31 @@ module Mocktail
     private
 
     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,
-            original_type: type,
-            dry_type: dry_class,
-            method: method,
-            original_method: type.instance_method(method),
-            args: args,
-            kwargs: kwargs,
-            block: block
-          ))
+        parameters = type.instance_method(method).parameters
+        signature = @transforms_params.transform(Call.new, params: parameters)
+        method_signature = @stringifies_method_signature.stringify(signature)
+        __mocktail_closure = {
+          dry_class: dry_class,
+          type: type,
+          method: method,
+          original_method: type.instance_method(method),
+          signature: signature
         }
+
+        dry_class.define_method method,
+          eval(<<-RUBBY, binding, __FILE__, __LINE__ + 1) # standard:disable Security/Eval
+            ->#{method_signature} do
+              ::Mocktail::Debug.guard_against_mocktail_accidentally_calling_mocks_if_debugging!
+              ::Mocktail::HandlesDryCall.new.handle(::Mocktail::ReconstructsCall.new.reconstruct(
+                double: self,
+                call_binding: __send__(:binding),
+                default_args: (__send__(:binding).local_variable_defined?(:__mocktail_default_args) ? __send__(:binding).local_variable_get(:__mocktail_default_args) : {}),
+                **__mocktail_closure
+              ))
+            end
+          RUBBY
       end
     end
 

data/lib/mocktail/raises_neato_no_method_error.rb

@@ -71,7 +71,7 @@ module Mocktail
 
       <<~MSG
 
-        There #{corrections.size == 1 ? "is" : "are"} also #{corrections.size} similar method#{"s" if corrections.size != 1} on #{call.original_type.name}.
+        There #{(corrections.size == 1) ? "is" : "are"} also #{corrections.size} similar method#{"s" if corrections.size != 1} on #{call.original_type.name}.
 
         Did you mean?
         #{corrections.map { |c| "  #{c}" }.join("\n")}

data/lib/mocktail/replaces_next.rb

@@ -30,7 +30,7 @@ module Mocktail
         }
       end
 
-      mocktails.size == 1 ? mocktails.first : mocktails
+      (mocktails.size == 1) ? mocktails.first : mocktails
     end
   end
 end

data/lib/mocktail/share/determines_matching_calls.rb

@@ -15,6 +15,7 @@ module Mocktail
     private
 
     def args_match?(real_args, demo_args, ignore_extra_args)
+      # Guard clause for performance:
       return true if ignore_extra_args && demo_args.empty?
 
       (

data/lib/mocktail/simulates_argument_error/transforms_params.rb

@@ -2,9 +2,7 @@ require_relative "../share/bind"
 
 module Mocktail
   class TransformsParams
-    def transform(dry_call)
-      params = dry_call.original_method.parameters
-
+    def transform(dry_call, params: dry_call.original_method.parameters)
       Signature.new(
         positional_params: Params.new(
           all: params.select { |t, _|
@@ -12,7 +10,7 @@ module Mocktail
           }.map { |_, name| name },
           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]
+          rest: params.find { |t, _| Bind.call(t, :==, :rest) }&.last
         ),
         positional_args: dry_call.args,
 
@@ -22,11 +20,11 @@ module Mocktail
           }.map { |_, name| name },
           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]
+          rest: params.find { |t, _| Bind.call(t, :==, :keyrest) }&.last
         ),
         keyword_args: dry_call.kwargs,
 
-        block_param: params.find { |t, _| Bind.call(t, :==, :block) } & [1],
+        block_param: params.find { |t, _| Bind.call(t, :==, :block) }&.last,
         block_arg: dry_call.block
       )
     end

data/lib/mocktail/stringifies_method_signature.rb

@@ -0,0 +1,45 @@
+module Mocktail
+  class StringifiesMethodSignature
+    def stringify(signature)
+      positional_params = positional(signature)
+      keyword_params = keyword(signature)
+      block_param = block(signature)
+
+      "(#{[positional_params, keyword_params, block_param].compact.join(", ")})"
+    end
+
+    private
+
+    def positional(signature)
+      params = signature.positional_params.all.map do |name|
+        if signature.positional_params.allowed.include?(name)
+          "#{name} = ((__mocktail_default_args ||= {})[:#{name}] = nil)"
+        elsif signature.positional_params.rest == name
+          "*#{(name == :*) ? Signature::DEFAULT_REST_ARGS : name}"
+        end
+      end.compact
+
+      params.join(", ") if params.any?
+    end
+
+    def keyword(signature)
+      params = signature.keyword_params.all.map do |name|
+        if signature.keyword_params.allowed.include?(name)
+          "#{name}: ((__mocktail_default_args ||= {})[:#{name}] = nil)"
+        elsif signature.keyword_params.rest == name
+          "**#{(name == :**) ? Signature::DEFAULT_REST_KWARGS : name}"
+        end
+      end.compact
+
+      params.join(", ") if params.any?
+    end
+
+    def block(signature)
+      if signature.block_param && signature.block_param != :&
+        "&#{signature.block_param}"
+      else
+        "&#{Signature::DEFAULT_BLOCK_PARAM}"
+      end
+    end
+  end
+end

data/lib/mocktail/value/signature.rb

@@ -8,6 +8,9 @@ module Mocktail
     :block_arg,
     keyword_init: true
   )
+    DEFAULT_REST_ARGS = "args"
+    DEFAULT_REST_KWARGS = "kwargs"
+    DEFAULT_BLOCK_PARAM = "blk"
   end
 
   class Params < Struct.new(
@@ -26,7 +29,7 @@ module Mocktail
     end
 
     def allowed
-      required + optional
+      all.select { |name| required.include?(name) || optional.include?(name) }
     end
 
     def rest?

data/lib/mocktail/version.rb

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

data/lib/mocktail.rb

@@ -1,3 +1,4 @@
+require_relative "mocktail/collects_calls"
 require_relative "mocktail/debug"
 require_relative "mocktail/dsl"
 require_relative "mocktail/errors"
@@ -16,6 +17,7 @@ require_relative "mocktail/replaces_next"
 require_relative "mocktail/replaces_type"
 require_relative "mocktail/resets_state"
 require_relative "mocktail/simulates_argument_error"
+require_relative "mocktail/stringifies_method_signature"
 require_relative "mocktail/value"
 require_relative "mocktail/verifies_call"
 require_relative "mocktail/version"
@@ -67,6 +69,13 @@ module Mocktail
     ExplainsNils.new.explain
   end
 
+  # An alias for Mocktail.explain(double).reference.calls
+  # Takes an optional second parameter of the method name to filter only
+  # calls to that method
+  def self.calls(double, method_name = nil)
+    CollectsCalls.new.collect(double, method_name)
+  end
+
   # Stores most transactional state about calls & stubbing configurations
   # Anything returned by this is undocumented and could change at any time, so
   # don't commit code that relies on it!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mocktail
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.1
 platform: ruby
 authors:
 - Justin Searls
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-28 00:00:00.000000000 Z
+date: 2022-11-17 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -27,8 +27,10 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/rake
 - bin/setup
 - lib/mocktail.rb
+- lib/mocktail/collects_calls.rb
 - lib/mocktail/debug.rb
 - lib/mocktail/dsl.rb
 - lib/mocktail/errors.rb
@@ -45,6 +47,7 @@ files:
 - lib/mocktail/imitates_type/ensures_imitation_support.rb
 - lib/mocktail/imitates_type/makes_double.rb
 - lib/mocktail/imitates_type/makes_double/declares_dry_class.rb
+- lib/mocktail/imitates_type/makes_double/declares_dry_class/reconstructs_call.rb
 - lib/mocktail/imitates_type/makes_double/gathers_fakeable_instance_methods.rb
 - lib/mocktail/initializes_mocktail.rb
 - lib/mocktail/matcher_presentation.rb
@@ -77,6 +80,7 @@ files:
 - lib/mocktail/simulates_argument_error/reconciles_args_with_params.rb
 - lib/mocktail/simulates_argument_error/recreates_message.rb
 - lib/mocktail/simulates_argument_error/transforms_params.rb
+- lib/mocktail/stringifies_method_signature.rb
 - lib/mocktail/value.rb
 - lib/mocktail/value/cabinet.rb
 - lib/mocktail/value/call.rb
@@ -119,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.20
 signing_key:
 specification_version: 4
 summary: Take your objects, and make them a double