mocktail 1.2.3 → 2.0.0

data/lib/mocktail/sorbet/mocktail/imitates_type/makes_double/gathers_fakeable_instance_methods.rb

@@ -0,0 +1,28 @@
+# typed: strict
+
+module Mocktail
+  class GathersFakeableInstanceMethods
+    extend T::Sig
+
+    sig { params(type: T.any(T::Class[T.anything], Module)).returns(T::Array[Symbol]) }
+    def gather(type)
+      methods = type.instance_methods + [
+        (:respond_to_missing? if type.private_method_defined?(:respond_to_missing?))
+      ].compact
+
+      methods.reject { |m|
+        ignore?(type, m)
+      }
+    end
+
+    sig { params(type: T.any(T::Class[T.anything], Module), method_name: Symbol).returns(T::Boolean) }
+    def ignore?(type, method_name)
+      ignored_ancestors.include?(type.instance_method(method_name).owner)
+    end
+
+    sig { returns(T::Array[Module]) }
+    def ignored_ancestors
+      Object.ancestors
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# typed: strict
+
+require_relative "makes_double/declares_dry_class"
+require_relative "makes_double/gathers_fakeable_instance_methods"
+
+module Mocktail
+  class MakesDouble
+    extend T::Sig
+
+    sig { void }
+    def initialize
+      @declares_dry_class = T.let(DeclaresDryClass.new, DeclaresDryClass)
+      @gathers_fakeable_instance_methods = T.let(GathersFakeableInstanceMethods.new, GathersFakeableInstanceMethods)
+    end
+
+    sig { params(type: T::Class[Object]).returns(Double) }
+    def make(type)
+      dry_methods = @gathers_fakeable_instance_methods.gather(type)
+      dry_type = @declares_dry_class.declare(type, dry_methods)
+
+      Double.new(
+        original_type: type,
+        dry_type: dry_type,
+        dry_instance: dry_type.new,
+        dry_methods: dry_methods
+      )
+    end
+  end
+end

data/lib/mocktail/sorbet/mocktail/imitates_type.rb

@@ -0,0 +1,29 @@
+# typed: strict
+
+require_relative "imitates_type/ensures_imitation_support"
+require_relative "imitates_type/makes_double"
+
+module Mocktail
+  class ImitatesType
+    extend T::Sig
+    extend T::Generic
+
+    sig { void }
+    def initialize
+      @ensures_imitation_support = T.let(EnsuresImitationSupport.new, EnsuresImitationSupport)
+      @makes_double = T.let(MakesDouble.new, MakesDouble)
+    end
+
+    sig {
+      type_parameters(:T)
+        .params(type: T::Class[T.all(T.type_parameter(:T), Object)])
+        .returns(T.all(T.type_parameter(:T), Object))
+    }
+    def imitate(type)
+      @ensures_imitation_support.ensure(type)
+      T.cast(@makes_double.make(type).tap do |double|
+        Mocktail.cabinet.store_double(double)
+      end.dry_instance, T.all(T.type_parameter(:T), Object))
+    end
+  end
+end

data/lib/mocktail/sorbet/mocktail/initialize_based_on_type_system_mode_switching.rb

@@ -0,0 +1,11 @@
+# typed: false
+
+require_relative "typed"
+
+# Constant boolean, so won't statically type-check, but `T.unsafe` can't be used
+# because we haven't required sorbet-runtime yet
+if eval("Mocktail::TYPED", binding, __FILE__, __LINE__)
+  require "sorbet-runtime"
+else
+  require "#{Gem.loaded_specs["sorbet-eraser"].gem_dir}/lib/t"
+end

data/lib/mocktail/sorbet/mocktail/initializes_mocktail.rb

@@ -0,0 +1,25 @@
+# typed: strict
+
+module Mocktail
+  class InitializesMocktail
+    extend T::Sig
+
+    sig { void }
+    def init
+      [
+        Mocktail::Matchers::Any,
+        Mocktail::Matchers::Includes,
+        Mocktail::Matchers::IncludesString,
+        Mocktail::Matchers::IncludesKey,
+        Mocktail::Matchers::IncludesHash,
+        Mocktail::Matchers::IsA,
+        Mocktail::Matchers::Matches,
+        Mocktail::Matchers::Not,
+        Mocktail::Matchers::Numeric,
+        Mocktail::Matchers::That
+      ].each do |matcher_type|
+        Mocktail.register_matcher(matcher_type)
+      end
+    end
+  end
+end

data/lib/mocktail/sorbet/mocktail/matcher_presentation.rb

@@ -0,0 +1,21 @@
+# typed: strict
+
+module Mocktail
+  class MatcherPresentation
+    extend T::Sig
+
+    sig { params(name: Symbol, include_private: T::Boolean).returns(T::Boolean) }
+    def respond_to_missing?(name, include_private = false)
+      !!MatcherRegistry.instance.get(name) || super
+    end
+
+    sig { params(name: Symbol, args: T.anything, kwargs: T.anything, blk: T.nilable(Proc)).returns(T.anything) }
+    def method_missing(name, *args, **kwargs, &blk) # standard:disable Style/ArgumentsForwarding
+      if (matcher = MatcherRegistry.instance.get(name))
+        T.unsafe(matcher).new(*args, **kwargs, &blk) # standard:disable Style/ArgumentsForwarding
+      else
+        super
+      end
+    end
+  end
+end

data/lib/mocktail/sorbet/mocktail/matchers/any.rb

@@ -0,0 +1,27 @@
+# typed: strict
+
+module Mocktail::Matchers
+  class Any < Base
+    extend T::Sig
+
+    sig { returns(Symbol) }
+    def self.matcher_name
+      :any
+    end
+
+    sig { void }
+    def initialize
+      # Empty initialize is necessary b/c Base default expects an argument
+    end
+
+    sig { params(actual: T.anything).returns(T::Boolean) }
+    def match?(actual)
+      true
+    end
+
+    sig { returns(String) }
+    def inspect
+      "any"
+    end
+  end
+end

data/lib/mocktail/sorbet/mocktail/matchers/base.rb

@@ -0,0 +1,39 @@
+# typed: strict
+
+module Mocktail::Matchers
+  class Base
+    extend T::Sig
+    extend T::Helpers
+
+    if T.unsafe(Mocktail::TYPED) && T::Private::RuntimeLevels.default_checked_level != :never
+      abstract!
+    end
+
+    # Custom matchers can receive any args, kwargs, or block they want. Usually
+    # single-argument, though, so that's defaulted here and in #insepct
+    sig { params(expected: BasicObject).void }
+    def initialize(expected)
+      @expected = expected
+    end
+
+    sig { returns(Symbol) }
+    def self.matcher_name
+      raise Mocktail::InvalidMatcherError.new("The `matcher_name` class method must return a valid method name")
+    end
+
+    sig { params(actual: T.untyped).returns(T::Boolean) }
+    def match?(actual)
+      raise Mocktail::InvalidMatcherError.new("Matchers must implement `match?(argument)`")
+    end
+
+    sig { returns(String) }
+    def inspect
+      "#{self.class.matcher_name}(#{T.cast(@expected, Object).inspect})"
+    end
+
+    sig { returns(TrueClass) }
+    def is_mocktail_matcher?
+      true
+    end
+  end
+end

data/lib/mocktail/sorbet/mocktail/matchers/captor.rb

@@ -0,0 +1,76 @@
+# typed: strict
+
+module Mocktail::Matchers
+  # Captors are conceptually complex implementations, but with a simple usage/purpose:
+  # They are values the user can create and hold onto that will return a matcher
+  # and then "capture" the value made by the real call, for later analysis & assertion.
+  #
+  # Unlike other matchers, these don't make any useful sense for stubbing, but are
+  # very useful when asserting complication call verifications
+  #
+  # The fact the user will need the reference outside the verification call is
+  # why this is a top-level method on Mocktail, and not included in the |m| block
+  # arg to stubs/verify
+  #
+  # See Mockito, which is the earliest implementation I know of:
+  # https://javadoc.io/doc/org.mockito/mockito-core/latest/org/mockito/Captor.html
+  class Captor
+    extend T::Sig
+
+    class Capture < Mocktail::Matchers::Base
+      extend T::Sig
+
+      sig { returns(Symbol) }
+      def self.matcher_name
+        :capture
+      end
+
+      sig { returns(T.untyped) }
+      attr_reader :value
+
+      sig { void }
+      def initialize
+        @value = T.let(nil, T.untyped)
+        @captured = T.let(false, T::Boolean)
+      end
+
+      sig { params(actual: T.untyped).returns(TrueClass) }
+      def match?(actual)
+        @value = actual
+        @captured = true
+        true
+      end
+
+      sig { returns(T::Boolean) }
+      def captured?
+        @captured
+      end
+
+      sig { returns(String) }
+      def inspect
+        "capture"
+      end
+    end
+
+    # This T.untyped is intentional. Even though a Capture is surely returned,
+    # in order for a verification demonstration to pass its own type check,
+    # it needs to think it's being returned whatever parameter is expected
+    sig { returns(T.untyped) }
+    attr_reader :capture
+
+    sig { void }
+    def initialize
+      @capture = T.let(Capture.new, Capture)
+    end
+
+    sig { returns(T::Boolean) }
+    def captured?
+      @capture.captured?
+    end
+
+    sig { returns(T.untyped) }
+    def value
+      @capture.value
+    end
+  end
+end

data/lib/mocktail/sorbet/mocktail/matchers/includes.rb

@@ -0,0 +1,32 @@
+# typed: strict
+
+module Mocktail::Matchers
+  class Includes < Base
+    extend T::Sig
+
+    sig { returns(Symbol) }
+    def self.matcher_name
+      :includes
+    end
+
+    sig { params(expecteds: T.untyped).void }
+    def initialize(*expecteds)
+      @expecteds = T.let(expecteds, T::Array[T.untyped])
+    end
+
+    sig { params(actual: T.untyped).returns(T::Boolean) }
+    def match?(actual)
+      @expecteds.all? { |expected|
+        (actual.respond_to?(:include?) && actual.include?(expected)) ||
+          (actual.is_a?(Hash) && expected.is_a?(Hash) && expected.all? { |k, v| actual[k] == v })
+      }
+    rescue
+      false
+    end
+
+    sig { returns(String) }
+    def inspect
+      "#{self.class.matcher_name}(#{@expecteds.map(&:inspect).join(", ")})"
+    end
+  end
+end

data/lib/mocktail/sorbet/mocktail/matchers/includes_hash.rb

@@ -0,0 +1,12 @@
+# typed: strict
+
+module Mocktail::Matchers
+  class IncludesHash < Includes
+    extend T::Sig
+
+    sig { returns(Symbol) }
+    def self.matcher_name
+      :includes_hash
+    end
+  end
+end

data/lib/mocktail/sorbet/mocktail/matchers/includes_key.rb

@@ -0,0 +1,12 @@
+# typed: strict
+
+module Mocktail::Matchers
+  class IncludesKey < Includes
+    extend T::Sig
+
+    sig { returns(Symbol) }
+    def self.matcher_name
+      :includes_key
+    end
+  end
+end

data/lib/mocktail/sorbet/mocktail/matchers/includes_string.rb

@@ -0,0 +1,12 @@
+# typed: strict
+
+module Mocktail::Matchers
+  class IncludesString < Includes
+    extend T::Sig
+
+    sig { returns(Symbol) }
+    def self.matcher_name
+      :includes_string
+    end
+  end
+end

data/lib/mocktail/sorbet/mocktail/matchers/is_a.rb

@@ -0,0 +1,17 @@
+# typed: strict
+
+module Mocktail::Matchers
+  class IsA < Base
+    extend T::Sig
+
+    sig { returns(Symbol) }
+    def self.matcher_name
+      :is_a
+    end
+
+    sig { params(actual: T.untyped).returns(T::Boolean) }
+    def match?(actual)
+      actual.is_a?(@expected)
+    end
+  end
+end

data/lib/mocktail/sorbet/mocktail/matchers/matches.rb

@@ -0,0 +1,19 @@
+# typed: strict
+
+module Mocktail::Matchers
+  class Matches < Base
+    extend T::Sig
+
+    sig { returns(Symbol) }
+    def self.matcher_name
+      :matches
+    end
+
+    sig { params(actual: T.untyped).returns(T::Boolean) }
+    def match?(actual)
+      actual.respond_to?(:match?) && actual.match?(@expected)
+    rescue
+      false
+    end
+  end
+end

data/lib/mocktail/sorbet/mocktail/matchers/not.rb

@@ -0,0 +1,17 @@
+# typed: strict
+
+module Mocktail::Matchers
+  class Not < Base
+    extend T::Sig
+
+    sig { returns(Symbol) }
+    def self.matcher_name
+      :not
+    end
+
+    sig { params(actual: T.untyped).returns(T::Boolean) }
+    def match?(actual)
+      @expected != actual
+    end
+  end
+end

data/lib/mocktail/sorbet/mocktail/matchers/numeric.rb

@@ -0,0 +1,27 @@
+# typed: strict
+
+module Mocktail::Matchers
+  class Numeric < Base
+    extend T::Sig
+
+    sig { returns(Symbol) }
+    def self.matcher_name
+      :numeric
+    end
+
+    sig { void }
+    def initialize
+      # Empty initialize is necessary b/c Base default expects an argument
+    end
+
+    sig { params(actual: T.untyped).returns(T::Boolean) }
+    def match?(actual)
+      actual.is_a?(::Numeric)
+    end
+
+    sig { returns(String) }
+    def inspect
+      "numeric"
+    end
+  end
+end

data/lib/mocktail/sorbet/mocktail/matchers/that.rb

@@ -0,0 +1,32 @@
+# typed: strict
+
+module Mocktail::Matchers
+  class That < Base
+    extend T::Sig
+
+    sig { returns(Symbol) }
+    def self.matcher_name
+      :that
+    end
+
+    sig { params(blk: T.nilable(T.proc.params(actual: T.untyped).returns(T.untyped))).void }
+    def initialize(&blk)
+      if blk.nil?
+        raise ArgumentError.new("The `that` matcher must be passed a block (e.g. `that { |arg| … }`)")
+      end
+      @blk = T.let(blk, T.proc.params(actual: T.untyped).returns(T.untyped))
+    end
+
+    sig { params(actual: T.untyped).returns(T::Boolean) }
+    def match?(actual)
+      @blk.call(actual)
+    rescue
+      false
+    end
+
+    sig { returns(String) }
+    def inspect
+      "that {…}"
+    end
+  end
+end

data/lib/mocktail/sorbet/mocktail/matchers.rb

@@ -0,0 +1,19 @@
+# typed: strict
+
+module Mocktail
+  module Matchers
+  end
+end
+
+require_relative "matchers/base"
+require_relative "matchers/any"
+require_relative "matchers/captor"
+require_relative "matchers/includes"
+require_relative "matchers/includes_string"
+require_relative "matchers/includes_hash"
+require_relative "matchers/includes_key"
+require_relative "matchers/is_a"
+require_relative "matchers/matches"
+require_relative "matchers/not"
+require_relative "matchers/numeric"
+require_relative "matchers/that"

data/lib/mocktail/sorbet/mocktail/raises_neato_no_method_error.rb

@@ -0,0 +1,93 @@
+# typed: strict
+
+require_relative "share/stringifies_call"
+require_relative "share/stringifies_method_name"
+require_relative "share/creates_identifier"
+
+module Mocktail
+  class RaisesNeatoNoMethodError
+    extend T::Sig
+
+    sig { void }
+    def initialize
+      @stringifies_call = T.let(StringifiesCall.new, StringifiesCall)
+      @stringifies_method_name = T.let(StringifiesMethodName.new, StringifiesMethodName)
+      @creates_identifier = T.let(CreatesIdentifier.new, CreatesIdentifier)
+    end
+
+    sig { params(call: Call).void }
+    def call(call)
+      raise NoMethodError, <<~MSG, caller[1..]
+        No method `#{@stringifies_method_name.stringify(call)}' exists for call:
+
+          #{@stringifies_call.stringify(call, anonymous_blocks: true, always_parens: true)}
+
+        Need to define the method? Here's a sample definition:
+
+          def #{"self." if call.singleton}#{call.method}#{params(call)}
+          end
+        #{corrections(call)}
+      MSG
+    end
+
+    private
+
+    sig { params(call: Call).returns(T.nilable(String)) }
+    def params(call)
+      return if (params_lists = [
+        params_list(call.args),
+        kwparams_list(call.kwargs),
+        block_param(call.block)
+      ].compact).empty?
+
+      "(#{params_lists.join(", ")})"
+    end
+
+    sig { params(args: T::Array[T.anything]).returns(T.nilable(String)) }
+    def params_list(args)
+      return if args.empty?
+
+      count_repeats(args.map { |arg|
+        @creates_identifier.create(arg, default: "arg")
+      }).join(", ")
+    end
+
+    sig { params(kwargs: T::Hash[Symbol, T.anything]).returns(T.nilable(String)) }
+    def kwparams_list(kwargs)
+      return if kwargs.empty?
+
+      kwargs.keys.map { |key| "#{key}:" }.join(", ")
+    end
+
+    sig { params(block: T.nilable(Proc)).returns(T.nilable(String)) }
+    def block_param(block)
+      return if block.nil?
+
+      "&blk"
+    end
+
+    sig { params(identifiers: T::Array[String]).returns(T::Array[String]) }
+    def count_repeats(identifiers)
+      identifiers.map.with_index { |id, i|
+        if (preceding_matches = T.must(identifiers[0...i]).count { |other_id| id == other_id }) > 0
+          "#{id}#{preceding_matches + 1}"
+        else
+          id
+        end
+      }
+    end
+
+    sig { params(call: Call).returns(T.nilable(String)) }
+    def corrections(call)
+      return if (corrections = DidYouMean::SpellChecker.new(dictionary: T.must(call.original_type).instance_methods).correct(T.must(call.method))).empty?
+
+      <<~MSG
+
+        There #{(corrections.size == 1) ? "is" : "are"} also #{corrections.size} similar method#{"s" if corrections.size != 1} on #{T.must(call.original_type).name}.
+
+        Did you mean?
+        #{corrections.map { |c| "  #{c}" }.join("\n")}
+      MSG
+    end
+  end
+end

data/lib/mocktail/sorbet/mocktail/records_demonstration.rb

@@ -0,0 +1,43 @@
+# typed: strict
+
+module Mocktail
+  class RecordsDemonstration
+    extend T::Sig
+
+    sig {
+      type_parameters(:T)
+        .params(
+          demonstration: T.proc.params(matchers: Mocktail::MatcherPresentation).returns(T.type_parameter(:T)),
+          demo_config: DemoConfig
+        ).returns(Call)
+    }
+    def record(demonstration, demo_config)
+      cabinet = Mocktail.cabinet
+      prior_call_count = Mocktail.cabinet.calls.dup.size
+
+      begin
+        cabinet.demonstration_in_progress = true
+        ValidatesArguments.optional(demo_config.ignore_arity) do
+          demonstration.call(Mocktail.matchers)
+        end
+      ensure
+        cabinet.demonstration_in_progress = false
+      end
+
+      if prior_call_count + 1 == cabinet.calls.size
+        T.must(cabinet.calls.pop)
+      elsif prior_call_count == cabinet.calls.size
+        raise MissingDemonstrationError.new <<~MSG.tr("\n", " ")
+          `stubs` & `verify` expect an invocation of a mocked method by a passed
+          block, but no invocation occurred.
+        MSG
+      else
+        raise AmbiguousDemonstrationError.new <<~MSG.tr("\n", " ")
+          `stubs` & `verify` expect exactly one invocation of a mocked method,
+          but #{cabinet.calls.size - prior_call_count} were detected. As a
+          result, Mocktail doesn't know which invocation to stub or verify.
+        MSG
+      end
+    end
+  end
+end