mocktail 1.2.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c303d4fb9ecc3a03e30fcfb52425cec2c4f3b2ca2ad3dadda3f9a09c1b8785a
-  data.tar.gz: 90b573a3b6417d1c084fa7ced22af80b0533e36c45240d42c9627b3bfde2a032
+  metadata.gz: 0d2944636158dbc47b6da4246d28303f274e2740b7d61ccf3359ff1ce668ab40
+  data.tar.gz: ea0aa33b02f8f9dac5be81bf6a5a394d181f078127a7b9e22fb55d5c30c85808
 SHA512:
-  metadata.gz: f2aa7140202bfb3d5cadc45964f344cce19ba688d807b9c25b2033d27dd15710424fc00315633129429215892ea149160d2fbba2a8671bb2237867b12ce7c225
-  data.tar.gz: 95f1c02d8f23849f0a5932e8cddb3f811dc01962e13e0553f1964ebf9f77489b49ce375506e3f2a5f9132bcda7493b2ffc8a03dc61dd4f5018f84fe33995245f
+  metadata.gz: 15456b62e2fe1157c17b694c9c8d83d1fa42fa64f4cc3a3aa998a3d21ccf8ae13320694ed3ed1ac500a1636210ae9b153b1070fa427ed9dfd04e5a43b29d56b6
+  data.tar.gz: 193f8fca67cfb78fc2eefc21b0c70cf5f9ddb9028b0ff948472c119ea0350dda587a4a150e7b8cc283ed9cfe4f8e451a323f9517517d73dbfd84a20cedfce2ed

data/.standard.yml

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

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 1.2.2
+
+* As promised in 1.2.1, there were bugs. [#19](https://github.com/testdouble/mocktail/pull/19)
+
+# 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

data/Gemfile

@@ -8,3 +8,4 @@ gem "minitest"
 gem "standard"
 gem "pry"
 gem "simplecov"
+gem "m"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mocktail (1.2.0)
+    mocktail (1.2.2)
 
 GEM
   remote: https://rubygems.org/
@@ -9,30 +9,35 @@ GEM
     ast (2.4.2)
     coderay (1.1.3)
     docile (1.4.0)
+    json (2.6.2)
+    m (1.6.1)
+      method_source (>= 0.6.7)
+      rake (>= 0.9.2.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,16 +47,17 @@ 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
   ruby
 
 DEPENDENCIES
+  m
   minitest
   mocktail!
   pry

data/README.md

@@ -814,11 +814,10 @@ 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, and don't particularly care about the
-parameters. 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.
+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:
 

data/bin/m

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'm' 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("m", "m")

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,8 +2,8 @@ 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)
+      params = name_unnamed_params(params)
 
       Signature.new(
         positional_params: Params.new(
@@ -12,7 +12,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,13 +22,25 @@ 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
+
+    private
+
+    def name_unnamed_params(params)
+      params.map.with_index { |param, i|
+        if param.size == 1
+          param + ["unnamed_arg_#{i + 1}"]
+        else
+          param
+        end
+      }
+    end
   end
 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.2.0"
+  VERSION = "1.2.2"
 end

data/lib/mocktail.rb

@@ -17,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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mocktail
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.2
 platform: ruby
 authors:
 - Justin Searls
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-21 00:00:00.000000000 Z
+date: 2022-11-19 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -27,6 +27,7 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/m
 - bin/rake
 - bin/setup
 - lib/mocktail.rb
@@ -47,6 +48,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
@@ -79,6 +81,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