mocktail 1.2.3 → 2.0.0

data/lib/mocktail/value/stubbing.rb

@@ -1,16 +1,14 @@
 module Mocktail
-  Stubbing = Struct.new(
-    :demonstration,
-    :demo_config,
-    :satisfaction_count,
-    :recording,
-    :effect,
-    keyword_init: true
-  ) do
-    def initialize(**kwargs)
-      super
-      self.satisfaction_count ||= 0
-    end
+  class Stubbing < T::Struct
+    extend T::Sig
+    extend T::Generic
+    MethodReturnType = type_member
+
+    const :demonstration
+    const :demo_config
+    prop :satisfaction_count, default: 0
+    const :recording
+    prop :effect
 
     def satisfied!
       self.satisfaction_count += 1
@@ -18,6 +16,7 @@ module Mocktail
 
     def with(&block)
       self.effect = block
+      nil
     end
   end
 end

data/lib/mocktail/value/top_shelf.rb

@@ -1,5 +1,10 @@
 module Mocktail
+  # The TopShelf is where we keep all the more global, dangerous state.
+  # In particular, this is where Mocktail manages state related to singleton
+  # method replacements carried out with Mocktail.replace(ClassOrModule)
   class TopShelf
+    extend T::Sig
+
     def self.instance
       Thread.current[:mocktail_top_shelf] ||= new
     end

data/lib/mocktail/value/type_replacement.rb

@@ -1,10 +1,9 @@
 module Mocktail
-  TypeReplacement = Struct.new(
-    :type,
-    :original_methods,
-    :replacement_methods,
-    :original_new,
-    :replacement_new,
-    keyword_init: true
-  )
+  class TypeReplacement < T::Struct
+    const :type
+    prop :original_methods
+    prop :replacement_methods
+    prop :original_new
+    prop :replacement_new
+  end
 end

data/lib/mocktail/value/type_replacement_data.rb

@@ -1,11 +1,14 @@
 module Mocktail
-  TypeReplacementData = Struct.new(
-    :type,
-    :replaced_method_names,
-    :calls,
-    :stubbings,
-    keyword_init: true
-  ) do
+  class TypeReplacementData < T::Struct
+    extend T::Sig
+
+    const :type
+    const :replaced_method_names
+    const :calls
+    const :stubbings
+
+    include ExplanationData
+
     def double
       type
     end

data/lib/mocktail/value/unsatisfying_call.rb

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

data/lib/mocktail/value/unsatisfying_call_explanation.rb

@@ -0,0 +1,18 @@
+module Mocktail
+  class UnsatisfyingCallExplanation
+    extend T::Sig
+
+    attr_reader :reference
+
+    attr_reader :message
+
+    def initialize(reference, message)
+      @reference = reference
+      @message = message
+    end
+
+    def type
+      self.class
+    end
+  end
+end

data/lib/mocktail/value.rb

@@ -1,14 +1,17 @@
 require_relative "value/cabinet"
 require_relative "value/call"
 require_relative "value/demo_config"
+require_relative "value/explanation"
+require_relative "value/explanation_data"
 require_relative "value/double"
 require_relative "value/double_data"
-require_relative "value/explanation"
 require_relative "value/fake_method_data"
 require_relative "value/matcher_registry"
+require_relative "value/no_explanation_data"
 require_relative "value/signature"
 require_relative "value/stubbing"
-require_relative "value/top_shelf"
 require_relative "value/type_replacement"
 require_relative "value/type_replacement_data"
+require_relative "value/unsatisfying_call_explanation"
 require_relative "value/unsatisfying_call"
+require_relative "value/top_shelf"

data/lib/mocktail/verifies_call/finds_verifiable_calls.rb

@@ -2,6 +2,8 @@ require_relative "../share/determines_matching_calls"
 
 module Mocktail
   class FindsVerifiableCalls
+    extend T::Sig
+
     def initialize
       @determines_matching_calls = DeterminesMatchingCalls.new
     end

data/lib/mocktail/verifies_call/raises_verification_error/gathers_calls_of_method.rb

@@ -1,5 +1,7 @@
 module Mocktail
   class GathersCallsOfMethod
+    extend T::Sig
+
     def gather(dry_call)
       Mocktail.cabinet.calls.select { |call|
         call.double == dry_call.double &&

data/lib/mocktail/verifies_call/raises_verification_error.rb

@@ -4,6 +4,8 @@ require_relative "../share/stringifies_call"
 
 module Mocktail
   class RaisesVerificationError
+    extend T::Sig
+
     def initialize
       @gathers_calls_of_method = GathersCallsOfMethod.new
       @stringifies_method_name = StringifiesMethodName.new

data/lib/mocktail/verifies_call.rb

@@ -4,6 +4,8 @@ require_relative "verifies_call/raises_verification_error"
 
 module Mocktail
   class VerifiesCall
+    extend T::Sig
+
     def initialize
       @records_demonstration = RecordsDemonstration.new
       @finds_verifiable_calls = FindsVerifiableCalls.new
@@ -17,6 +19,7 @@ module Mocktail
       unless verification_satisfied?(verifiable_calls.size, demo_config)
         @raises_verification_error.raise(recording, verifiable_calls, demo_config)
       end
+      nil
     end
 
     private

data/lib/mocktail/version.rb

@@ -1,3 +1,10 @@
 module Mocktail
-  VERSION = "1.2.3"
+  # The gemspec will define Module::VERSION as loaded from lib/, but if the
+  # user loads mocktail/sorbet, its version file will be effectively redefining
+  # it. Undef it first to ensure we don't spew warnings
+  if defined?(VERSION)
+    Mocktail.send(:remove_const, :VERSION)
+  end
+
+  VERSION = "2.0.0"
 end

data/lib/mocktail.rb

@@ -1,9 +1,23 @@
+require "pathname"
+
+if defined?(Mocktail::TYPED)
+  if eval("Mocktail::TYPED", binding, __FILE__, __LINE__)
+    warn "`require \"mocktail\"' was called, but Mocktail was already required as `require \"mocktail/sorbet\"', so we're NOT going to load it to avoid constants from being redefined. If you want to use Mocktail WITHOUT sorbet runtime checks, remove whatever is requiring `mocktail/sorbet'."
+  else
+    warn "`require \"mocktail/sorbet\"' was called, but Mocktail was already required as `require \"mocktail\"', so we're NOT going to load it to avoid constants from being redefined. If you want to use Mocktail WITH sorbet runtime checks, remove whatever is requiring `mocktail'."
+  end
+  return
+end
+
+require_relative "mocktail/initialize_based_on_type_system_mode_switching"
+
 require_relative "mocktail/collects_calls"
 require_relative "mocktail/debug"
 require_relative "mocktail/dsl"
 require_relative "mocktail/errors"
 require_relative "mocktail/explains_thing"
 require_relative "mocktail/explains_nils"
+require_relative "mocktail/grabs_original_method_parameters"
 require_relative "mocktail/handles_dry_call"
 require_relative "mocktail/handles_dry_new_call"
 require_relative "mocktail/imitates_type"
@@ -23,20 +37,44 @@ require_relative "mocktail/verifies_call"
 require_relative "mocktail/version"
 
 module Mocktail
+  extend T::Sig
+  extend DSL
+  BASE_PATH = (Pathname.new(__FILE__) + "..").to_s
+
   # Returns an instance of `type` whose implementation is mocked out
+
   def self.of(type)
     ImitatesType.new.imitate(type)
   end
 
   # Returns an instance of `klass` whose implementation is mocked out AND
   # stubs its constructor to return that fake the next time klass.new is called
+
   def self.of_next(type, count: 1)
-    ReplacesNext.new.replace(type, count)
+    count ||= 1
+    if count == 1
+      ReplacesNext.new.replace_once(type)
+    elsif !Mocktail::TYPED || T::Private::RuntimeLevels.default_checked_level == :never
+      ReplacesNext.new.replace(type, count)
+    else
+      raise TypeCheckingError.new <<~MSG
+        Calling `Mocktail.of_next()' with a `count' value other than 1 is not supported when
+        type checking is enabled. There are two ways to fix this:
+
+        1. Use `Mocktail.of_next_with_count(type, count)' instead, which will always return
+           an array of fake objects.
+
+        2. Disable runtime type checking by setting `T::Private::RuntimeLevels.default_checked_level = :never'
+           or by setting the envronment variable `SORBET_RUNTIME_DEFAULT_CHECKED_LEVEL=never'
+      MSG
+    end
   end
 
-  # See lib/mocktail/dsl.rb
-  define_singleton_method :stubs, DSL.instance_method(:stubs)
-  define_singleton_method :verify, DSL.instance_method(:verify)
+  # An alias of of_next that always returns an array of fakes
+
+  def self.of_next_with_count(type, count)
+    ReplacesNext.new.replace(type, count)
+  end
 
   def self.matchers
     MatcherPresentation.new
@@ -52,6 +90,7 @@ module Mocktail
 
   # Replaces every singleton method on `type` with a fake, and when instantiated
   # or included will also fake instance methods
+
   def self.replace(type)
     ReplacesType.new.replace(type)
     nil
@@ -72,13 +111,15 @@ module Mocktail
   # 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)
+    CollectsCalls.new.collect(double, method_name&.to_sym)
   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!
+
   def self.cabinet
     Thread.current[:mocktail_store] ||= Cabinet.new
   end

data/mocktail.gemspec

@@ -1,4 +1,8 @@
-require_relative "lib/mocktail/version"
+begin
+  require_relative "lib/mocktail/version"
+rescue LoadError
+  require_relative "src/mocktail/version"
+end
 
 Gem::Specification.new do |spec|
   spec.name = "mocktail"
@@ -18,14 +22,14 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features|src|sub_projects|spoom_data|sorbet|script|docs)/}) }
   end
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "sorbet-runtime", "~> 0.5.9204"
+  spec.add_dependency "sorbet-eraser", "~> 0.3.1"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html