mocktail 0.0.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67768c396af3e99d7ef7649d2afecf023f1dbdc0e361d960bebbf6befe908d3b
-  data.tar.gz: 196930b31afa82713bf68469c6d3cb434ce67f22f6cc4c7393c7c438201550c9
+  metadata.gz: 05ec28e8027b6d73ee5b3f513ce4d5e23a60ea0266643e344e20e8f995410ce2
+  data.tar.gz: 7baf1cff682de031f3f25cebad265e59e598c4f4103968ea2dda61b6c7605c9c
 SHA512:
-  metadata.gz: e8b1974f7c8068044c95b4113937aa5cd39972722244ff81bd60038cfe56ff2148a87c8b89bf5487e5b195fa25df1e23f31f667c618e2c375f27615e487d77f7
-  data.tar.gz: b0cf6ae9e2e1b7b2ce0d23144753d7dde66af999c110da1ac8815b2a95b4bdd6ad0ac1e7555fd4a1333bbc983811fd5fa32a052ea22bda01395a24dfb96eb6da
+  metadata.gz: 4c5eef4fe5c68abd7d1e506bc59db58daa931fb484118e0ee4d6d286944d2834d0bb3107183102ac65110e12f32992b73fadbfcc26ed750bff060535e4eba5a2
+  data.tar.gz: cff11562ac6bc79475719f17f912ffc2fe8af6315ab90dbdc838143c237542ad788cba2d6c05ee15417799b2f597634244edf3c9f50dac5121adbac551602bdb

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 1.0.0
+
+* First breaking change! 🎉
+* Remove support for `Mocktail.explain(nil)` because fake nil values cannot be
+made falsey. Pretty big mistake
+* Add `Mocktail.explain_nils` which will return explanation objects of every
+call that didn't satisfy a stubbing since the last reset, including the call
+site where it happened and the backtrace to try to tease out which one you're
+looking for
+
 # 0.0.6
 
 * Require pathname, which I missed because `bundle exec` loads it. Wups!

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mocktail (0.0.6)
+    mocktail (1.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -10,29 +10,29 @@ GEM
     coderay (1.1.3)
     docile (1.4.0)
     method_source (1.0.0)
-    minitest (5.14.4)
+    minitest (5.15.0)
     parallel (1.21.0)
-    parser (3.0.2.0)
+    parser (3.0.3.2)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     rainbow (3.0.0)
     rake (13.0.6)
-    regexp_parser (2.1.1)
+    regexp_parser (2.2.0)
     rexml (3.2.5)
-    rubocop (1.20.0)
+    rubocop (1.23.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.9.1, < 2.0)
+      rubocop-ast (>= 1.12.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.11.0)
+    rubocop-ast (1.15.0)
       parser (>= 3.0.1.1)
-    rubocop-performance (1.11.5)
+    rubocop-performance (1.12.0)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
@@ -42,9 +42,9 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.3)
-    standard (1.3.0)
-      rubocop (= 1.20.0)
-      rubocop-performance (= 1.11.5)
+    standard (1.5.0)
+      rubocop (= 1.23.0)
+      rubocop-performance (= 1.12.0)
     unicode-display_width (2.1.0)
 
 PLATFORMS

data/README.md

@@ -580,12 +580,27 @@ ice_tray.fill(:water_type, 30)
 ```
 
 From there, you can just copy-paste the provided method stub as a starting point
-for your new method.
+for your new method:
 
-#### `nil` values returned by faked methods
+```ruby
+class IceTray
+  def fill(water_type, amount)
+  end
+end
+```
+
+### Unexpected nils with Mocktail.explain_nils
+
+Is a faked method returning `nil` and you don't understand why?
+
+By default, methods faked by Mocktail will return `nil` when no stubbing is
+satisfied. A frequent frustration, therefore, is when the way `stubs {}.with {}`
+is configured does not satisfy a call the way you expected. To try to make
+debugging this a little bit easier, the gem provides a top-level
+`Mocktail.explain_nils` method that will return an array of summaries of every
+call to a faked method that failed to satisfy any stubbings.
 
-Suppose you go ahead and implement the `fill` method above and configure a
-stubbing:
+For example, suppose you stub this `fill` method like so:
 
 ```ruby
 ice_tray = Mocktail.of(IceTray)
@@ -598,20 +613,22 @@ you don't understand why:
 
 ```ruby
 def prep
-  ice = ice_tray.fill(:tap_water, 50) # => nil
-  glass.add(ice)
+  ice = ice_tray.fill(:tap_water, 50)
+  glass.add(ice) # => why is `ice` nil?!
 end
 ```
 
-You can pass that `nil` value to `Mocktail.explain` and get an
-`UnsatisfiedStubExplanation` that will include both a `reference` object to explore
- as well a summary message:
+Whenever you're confused by a nil, you can call `Mocktail.explain_nils` for an
+array containing `UnsatisfyingCallExplanation` objects (one for each call to
+a faked method that did not satisfy any configured stubbings).
+
+The returned explanation objects will include both a `reference` object to
+explore as well a summary `message`:
 
 ```ruby
 def prep
-  ice = ice_tray.fill(:tap_water, 50).tap do |wat|
-    puts Mocktail.explain(wat).message
-  end
+  ice = ice_tray.fill(:tap_water, 50)
+  puts Mocktail.explain_nils.first.message
   glass.add(ice)
 end
 ```
@@ -626,16 +643,24 @@ The actual call:
 
   fill(:tap_water, 50)
 
+The call site:
+
+  /path/to/your/code.rb:42:in `prep'
+
 Stubbings configured prior to this call but not satisfied by it:
 
   fill(:tap_water, 30)
 ```
 
+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.
+
 #### Fake instances created by Mocktail
 
-Any instances created by `Mocktail.of` or `Mocktail.of_next` can also be passed
-to `Mocktail.explain`, and they will list out all the calls and stubbings made
-for each of their fake methods.
+Any instances created by `Mocktail.of` or `Mocktail.of_next` can be passed to
+`Mocktail.explain`, and they will list out all the calls and stubbings made for
+each of their fake methods.
 
 Calling `Mocktail.explain(ice_tray).message` following the example above will
 yield:
@@ -662,6 +687,8 @@ passed to `Mocktail.explain()` for a summary of all the stubbing configurations
 and calls made against its faked singleton methods for the currently running
 thread.
 
+Imagine a `Shop` class with `self.open!` and `self.close!` singleton methods:
+
 ```ruby
 Mocktail.replace(Shop)
 
@@ -705,6 +732,10 @@ but you _definitely_ want to call it if you're using `Mocktail.replace` or
 `Mocktail.of_next` anywhere, since those will affect state that is shared across
 tests.
 
+Calling reset in a `teardown` or `after(:each)` hook will also improve the
+usefulness of messages returned by `Mocktail.explain` and
+`Mocktail.explain_nils`.
+
 ## Acknowledgements
 
 Mocktail is created & maintained by the software agency [Test

data/lib/mocktail/explains_nils.rb

@@ -0,0 +1,35 @@
+require_relative "share/stringifies_method_name"
+require_relative "share/stringifies_call"
+
+module Mocktail
+  class ExplainsNils
+    def initialize
+      @stringifies_method_name = StringifiesMethodName.new
+      @stringifies_call = StringifiesCall.new
+    end
+
+    def explain
+      Mocktail.cabinet.unsatisfying_calls.map { |unsatisfying_call|
+        dry_call = unsatisfying_call.call
+        other_stubbings = unsatisfying_call.other_stubbings
+
+        UnsatisfyingCallExplanation.new(unsatisfying_call, <<~MSG)
+          `nil' was returned by a mocked `#{@stringifies_method_name.stringify(dry_call)}' method
+          because none of its configured stubbings were satisfied.
+
+          The actual call:
+
+            #{@stringifies_call.stringify(dry_call, always_parens: true)}
+
+          The call site:
+
+            #{unsatisfying_call.backtrace.first}
+
+          #{@stringifies_call.stringify_multiple(other_stubbings.map(&:recording),
+            nonzero_message: "Stubbings configured prior to this call but not satisfied by it",
+            zero_message: "No stubbings were configured on this method")}
+        MSG
+      }
+    end
+  end
+end

data/lib/mocktail/explains_thing.rb

@@ -9,9 +9,7 @@ module Mocktail
     end
 
     def explain(thing)
-      if is_stub_returned_nil?(thing)
-        unsatisfied_stub_explanation(thing)
-      elsif (double = Mocktail.cabinet.double_for_instance(thing))
+      if (double = Mocktail.cabinet.double_for_instance(thing))
         double_explanation(double)
       elsif (type_replacement = TopShelf.instance.type_replacement_if_exists_for(thing))
         replaced_type_explanation(type_replacement)
@@ -22,31 +20,6 @@ module Mocktail
 
     private
 
-    # Our fake nil doesn't even implement respond_to?, instead quacking like nil
-    def is_stub_returned_nil?(thing)
-      thing.was_returned_by_unsatisfied_stub?
-    rescue NoMethodError
-    end
-
-    def unsatisfied_stub_explanation(stub_returned_nil)
-      unsatisfied_stubbing = stub_returned_nil.unsatisfied_stubbing
-      dry_call = unsatisfied_stubbing.call
-      other_stubbings = unsatisfied_stubbing.other_stubbings
-
-      UnsatisfiedStubExplanation.new(unsatisfied_stubbing, <<~MSG)
-        This `nil' was returned by a mocked `#{@stringifies_method_name.stringify(dry_call)}' method
-        because none of its configured stubbings were satisfied.
-
-        The actual call:
-
-          #{@stringifies_call.stringify(dry_call, always_parens: true)}
-
-        #{describe_multiple_calls(other_stubbings.map(&:recording),
-          "Stubbings configured prior to this call but not satisfied by it",
-          "No stubbings were configured on this method")}
-      MSG
-    end
-
     def double_explanation(double)
       double_data = DoubleData.new(
         type: double.original_type,
@@ -95,35 +68,23 @@ module Mocktail
       ))
 
       [
-        describe_multiple_calls(
+        @stringifies_call.stringify_multiple(
           double_data.stubbings.map(&:recording).select { |call|
             call.method == method
           },
-          "`#{method_name}' stubbings",
-          "`#{method_name}' has no stubbings"
+          nonzero_message: "`#{method_name}' stubbings",
+          zero_message: "`#{method_name}' has no stubbings"
         ),
-        describe_multiple_calls(
+        @stringifies_call.stringify_multiple(
           double_data.calls.select { |call|
             call.method == method
           },
-          "`#{method_name}' calls",
-          "`#{method_name}' has no calls"
+          nonzero_message: "`#{method_name}' calls",
+          zero_message: "`#{method_name}' has no calls"
         )
       ].join("\n")
     end
 
-    def describe_multiple_calls(calls, nonzero_message, zero_message)
-      if calls.empty?
-        "#{zero_message}.\n"
-      else
-        <<~MSG
-          #{nonzero_message}:
-
-          #{calls.map { |call| "  " + @stringifies_call.stringify(call) }.join("\n\n")}
-        MSG
-      end
-    end
-
     def no_explanation(thing)
       NoExplanation.new(thing,
         "Unfortunately, Mocktail doesn't know what this thing is: #{thing.inspect}")

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

@@ -1,12 +1,19 @@
+require_relative "../../share/cleans_backtrace"
+
 module Mocktail
   class DescribesUnsatisfiedStubbing
+    def initialize
+      @cleans_backtrace = CleansBacktrace.new
+    end
+
     def describe(dry_call)
-      UnsatisfiedStubbing.new(
+      UnsatisfyingCall.new(
         call: dry_call,
         other_stubbings: Mocktail.cabinet.stubbings.select { |stubbing|
-                           dry_call.double == stubbing.recording.double &&
-                             dry_call.method == stubbing.recording.method
-                         }
+          dry_call.double == stubbing.recording.double &&
+            dry_call.method == stubbing.recording.method
+        },
+        backtrace: @cleans_backtrace.clean(Error.new).backtrace
       )
     end
   end

data/lib/mocktail/handles_dry_call/fulfills_stubbing.rb

@@ -13,13 +13,25 @@ module Mocktail
         stubbing.satisfied!
         stubbing.effect&.call(dry_call)
       else
-        StubReturnedNil.new(@describes_unsatisfied_stubbing.describe(dry_call))
+        store_unsatisfying_call!(dry_call)
+        nil
       end
     end
 
     def satisfaction(dry_call)
       return if Mocktail.cabinet.demonstration_in_progress?
+
       @finds_satisfaction.find(dry_call)
     end
+
+    private
+
+    def store_unsatisfying_call!(dry_call)
+      return if Mocktail.cabinet.demonstration_in_progress?
+
+      Mocktail.cabinet.store_unsatisfying_call(
+        @describes_unsatisfied_stubbing.describe(dry_call)
+      )
+    end
   end
 end

data/lib/mocktail/matchers/captor.rb

@@ -34,6 +34,10 @@ module Mocktail::Matchers
       def captured?
         @captured
       end
+
+      def inspect
+        "capture"
+      end
     end
 
     attr_reader :capture

data/lib/mocktail/matchers/that.rb

@@ -6,7 +6,7 @@ module Mocktail::Matchers
 
     def initialize(&blk)
       if blk.nil?
-        raise "The `that` matcher must be passed a block (e.g. `that { |arg| … }`)"
+        raise ArgumentError.new("The `that` matcher must be passed a block (e.g. `that { |arg| … }`)")
       end
       @blk = blk
     end

data/lib/mocktail/share/stringifies_call.rb

@@ -4,6 +4,20 @@ module Mocktail
       "#{call.method}#{args_to_s(call, parens: always_parens)}#{blockify(call.block, anonymous: anonymous_blocks)}"
     end
 
+    def stringify_multiple(calls, nonzero_message:, zero_message:,
+      anonymous_blocks: false, always_parens: false)
+
+      if calls.empty?
+        "#{zero_message}.\n"
+      else
+        <<~MSG
+          #{nonzero_message}:
+
+          #{calls.map { |call| "  " + stringify(call) }.join("\n\n")}
+        MSG
+      end
+    end
+
     private
 
     def args_to_s(call, parens: true)

data/lib/mocktail/simulates_argument_error.rb

@@ -1,7 +1,7 @@
 require_relative "simulates_argument_error/transforms_params"
 require_relative "simulates_argument_error/reconciles_args_with_params"
 require_relative "simulates_argument_error/recreates_message"
-require_relative "simulates_argument_error/cleans_backtrace"
+require_relative "share/cleans_backtrace"
 require_relative "share/stringifies_call"
 
 module Mocktail

data/lib/mocktail/value/cabinet.rb

@@ -3,18 +3,20 @@
 module Mocktail
   class Cabinet
     attr_writer :demonstration_in_progress
-    attr_reader :calls, :stubbings
+    attr_reader :calls, :stubbings, :unsatisfying_calls
 
     def initialize
       @doubles = []
       @calls = []
       @stubbings = []
+      @unsatisfying_calls = []
       @demonstration_in_progress = false
     end
 
     def reset!
       @calls = []
       @stubbings = []
+      @unsatisfying_calls = []
       # Could cause an exception or prevent pollution—you decide!
       @demonstration_in_progress = false
       # note we don't reset doubles as they don't carry any
@@ -34,6 +36,10 @@ module Mocktail
       @stubbings << stubbing
     end
 
+    def store_unsatisfying_call(unsatisfying_call)
+      @unsatisfying_calls << unsatisfying_call
+    end
+
     def demonstration_in_progress?
       @demonstration_in_progress
     end

data/lib/mocktail/value/explanation.rb

@@ -15,7 +15,7 @@ module Mocktail
   class NoExplanation < Explanation
   end
 
-  class UnsatisfiedStubExplanation < Explanation
+  class UnsatisfyingCallExplanation < Explanation
   end
 
   class DoubleExplanation < Explanation

data/lib/mocktail/value/{unsatisfied_stubbing.rb → unsatisfying_call.rb}

@@ -1,7 +1,8 @@
 module Mocktail
-  class UnsatisfiedStubbing < Struct.new(
+  class UnsatisfyingCall < Struct.new(
     :call,
     :other_stubbings,
+    :backtrace,
     keyword_init: true
   )
   end

data/lib/mocktail/value.rb

@@ -7,8 +7,7 @@ require_relative "value/explanation"
 require_relative "value/matcher_registry"
 require_relative "value/signature"
 require_relative "value/stubbing"
-require_relative "value/stub_returned_nil"
 require_relative "value/top_shelf"
 require_relative "value/type_replacement"
 require_relative "value/type_replacement_data"
-require_relative "value/unsatisfied_stubbing"
+require_relative "value/unsatisfying_call"

data/lib/mocktail/version.rb

@@ -1,3 +1,3 @@
 module Mocktail
-  VERSION = "0.0.6"
+  VERSION = "1.0.0"
 end

data/lib/mocktail.rb

@@ -1,6 +1,7 @@
 require_relative "mocktail/dsl"
 require_relative "mocktail/errors"
 require_relative "mocktail/explains_thing"
+require_relative "mocktail/explains_nils"
 require_relative "mocktail/handles_dry_call"
 require_relative "mocktail/handles_dry_new_call"
 require_relative "mocktail/imitates_type"
@@ -61,6 +62,10 @@ module Mocktail
     ExplainsThing.new.explain(thing)
   end
 
+  def self.explain_nils
+    ExplainsNils.new.explain
+  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: 0.0.6
+  version: 1.0.0
 platform: ruby
 authors:
 - Justin Searls
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-04 00:00:00.000000000 Z
+date: 2021-12-20 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -31,6 +31,7 @@ files:
 - lib/mocktail.rb
 - lib/mocktail/dsl.rb
 - lib/mocktail/errors.rb
+- lib/mocktail/explains_nils.rb
 - lib/mocktail/explains_thing.rb
 - lib/mocktail/handles_dry_call.rb
 - lib/mocktail/handles_dry_call/fulfills_stubbing.rb
@@ -65,12 +66,12 @@ files:
 - lib/mocktail/replaces_type/redefines_new.rb
 - lib/mocktail/replaces_type/redefines_singleton_methods.rb
 - lib/mocktail/resets_state.rb
+- lib/mocktail/share/cleans_backtrace.rb
 - lib/mocktail/share/creates_identifier.rb
 - lib/mocktail/share/determines_matching_calls.rb
 - lib/mocktail/share/stringifies_call.rb
 - lib/mocktail/share/stringifies_method_name.rb
 - lib/mocktail/simulates_argument_error.rb
-- lib/mocktail/simulates_argument_error/cleans_backtrace.rb
 - 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
@@ -83,12 +84,11 @@ files:
 - lib/mocktail/value/explanation.rb
 - lib/mocktail/value/matcher_registry.rb
 - lib/mocktail/value/signature.rb
-- lib/mocktail/value/stub_returned_nil.rb
 - lib/mocktail/value/stubbing.rb
 - lib/mocktail/value/top_shelf.rb
 - lib/mocktail/value/type_replacement.rb
 - lib/mocktail/value/type_replacement_data.rb
-- lib/mocktail/value/unsatisfied_stubbing.rb
+- lib/mocktail/value/unsatisfying_call.rb
 - lib/mocktail/verifies_call.rb
 - lib/mocktail/verifies_call/finds_verifiable_calls.rb
 - lib/mocktail/verifies_call/raises_verification_error.rb

data/lib/mocktail/value/stub_returned_nil.rb

@@ -1,26 +0,0 @@
-module Mocktail
-  class StubReturnedNil < BasicObject
-    attr_reader :unsatisfied_stubbing
-
-    def initialize(unsatisfied_stubbing)
-      @unsatisfied_stubbing = unsatisfied_stubbing
-    end
-
-    def was_returned_by_unsatisfied_stub?
-      true
-    end
-
-    def tap
-      yield self
-      self
-    end
-
-    def method_missing(name, *args, **kwargs, &blk)
-      nil.send(name, *args, **kwargs, &blk)
-    end
-
-    def respond_to_missing?(name, include_all = false)
-      nil.respond_to?(name, include_all)
-    end
-  end
-end