mocktail 2.0.0 → 3.0.0

data/src/mocktail.rb

@@ -0,0 +1,154 @@
+# typed: strict
+
+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"
+require_relative "mocktail/initializes_mocktail"
+require_relative "mocktail/matcher_presentation"
+require_relative "mocktail/matchers"
+require_relative "mocktail/raises_neato_no_method_error"
+require_relative "mocktail/registers_matcher"
+require_relative "mocktail/registers_stubbing"
+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"
+
+module Mocktail
+  extend T::Sig
+  extend DSL
+  BASE_PATH = T.let((Pathname.new(__FILE__) + "..").to_s, String)
+
+  # Returns an instance of `type` whose implementation is mocked out
+  sig {
+    type_parameters(:T)
+      .params(type: T::Class[T.all(T.type_parameter(:T), Object)])
+      .returns(T.all(T.type_parameter(:T), Object))
+  }
+  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
+  sig {
+    type_parameters(:T)
+      .params(type: T::Class[T.all(T.type_parameter(:T), Object)], count: T.nilable(Integer))
+      .returns(T.type_parameter(:T))
+  }
+  def self.of_next(type, count: 1)
+    count ||= 1
+    if count == 1
+      ReplacesNext.new.replace_once(type)
+    elsif !T.unsafe(Mocktail::TYPED) || T::Private::RuntimeLevels.default_checked_level == :never
+      T.unsafe(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
+
+  # An alias of of_next that always returns an array of fakes
+  sig {
+    type_parameters(:T)
+      .params(type: T::Class[T.all(T.type_parameter(:T), Object)], count: Integer)
+      .returns(T::Array[T.type_parameter(:T)])
+  }
+  def self.of_next_with_count(type, count)
+    ReplacesNext.new.replace(type, count)
+  end
+
+  sig { returns(Mocktail::MatcherPresentation) }
+  def self.matchers
+    MatcherPresentation.new
+  end
+
+  sig { returns(Mocktail::Matchers::Captor) }
+  def self.captor
+    Matchers::Captor.new
+  end
+
+  sig { params(matcher: T.class_of(Mocktail::Matchers::Base)).void }
+  def self.register_matcher(matcher)
+    RegistersMatcher.new.register(matcher)
+  end
+
+  # Replaces every singleton method on `type` with a fake, and when instantiated
+  # or included will also fake instance methods
+  sig { params(type: T.any(T::Class[T.anything], Module)).void }
+  def self.replace(type)
+    ReplacesType.new.replace(type)
+    nil
+  end
+
+  sig { void }
+  def self.reset
+    ResetsState.new.reset
+  end
+
+  sig {
+    params(thing: Object)
+      .returns(Explanation)
+  }
+  def self.explain(thing)
+    ExplainsThing.new.explain(thing)
+  end
+
+  sig { returns(T::Array[Mocktail::UnsatisfyingCallExplanation]) }
+  def self.explain_nils
+    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
+  sig {
+    params(double: Object, method_name: T.nilable(T.any(String, Symbol)))
+      .returns(T::Array[Mocktail::Call])
+  }
+  def self.calls(double, method_name = nil)
+    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!
+  sig { returns Cabinet }
+  def self.cabinet
+    Thread.current[:mocktail_store] ||= Cabinet.new
+  end
+end
+
+Mocktail::InitializesMocktail.new.init

data/sub_projects/rbi_generator/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+gem "mocktail", require: false, path: "../.."
+gem "tapioca", require: false

data/sub_projects/rbi_generator/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: ../..
+  specs:
+    mocktail (3.0.0)
+      sorbet-eraser (~> 0.3.1)
+      sorbet-runtime (~> 0.5.9204)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    benchmark (0.4.0)
+    erubi (1.13.1)
+    logger (1.7.0)
+    netrc (0.11.0)
+    parallel (1.26.3)
+    prism (1.4.0)
+    rbi (0.3.1)
+      prism (~> 1.0)
+      rbs (>= 3.4.4)
+      sorbet-runtime (>= 0.5.9204)
+    rbs (3.9.2)
+      logger
+    sorbet (0.5.11971)
+      sorbet-static (= 0.5.11971)
+    sorbet-eraser (0.3.1)
+    sorbet-runtime (0.5.11971)
+    sorbet-static (0.5.11971-universal-darwin)
+    sorbet-static-and-runtime (0.5.11971)
+      sorbet (= 0.5.11971)
+      sorbet-runtime (= 0.5.11971)
+    spoom (1.6.1)
+      erubi (>= 1.10.0)
+      prism (>= 0.28.0)
+      rbi (>= 0.2.3)
+      sorbet-static-and-runtime (>= 0.5.10187)
+      thor (>= 0.19.2)
+    tapioca (0.16.11)
+      benchmark
+      bundler (>= 2.2.25)
+      netrc (>= 0.11.0)
+      parallel (>= 1.21.0)
+      rbi (~> 0.2)
+      sorbet-static-and-runtime (>= 0.5.11087)
+      spoom (>= 1.2.0)
+      thor (>= 1.2.0)
+      yard-sorbet
+    thor (1.3.2)
+    yard (0.9.45)
+    yard-sorbet (0.9.0)
+      sorbet-runtime
+      yard
+
+PLATFORMS
+  arm64-darwin-22
+  arm64-darwin-24
+  arm64-darwin-25
+
+DEPENDENCIES
+  mocktail!
+  tapioca
+
+BUNDLED WITH
+   2.4.13

data/sub_projects/rbi_generator/sorbet/rbi/gems/.gitattributes

@@ -0,0 +1 @@
+**/*.rbi linguist-generated=true

data/sub_projects/sorbet_user/Gemfile

@@ -0,0 +1,13 @@
+source "https://rubygems.org"
+
+gem "mocktail", path: "../..", require: "mocktail/sorbet"
+
+gem "standard"
+gem "standard-sorbet"
+gem "minitest", "~> 5.26" # 6.0+ requires Ruby >= 3.2, dropping support for Ruby 3.1
+gem "rake"
+gem "m"
+
+gem "sorbet"
+gem "sorbet-runtime"
+gem "tapioca"

data/sub_projects/sorbet_user/Gemfile.lock

@@ -0,0 +1,126 @@
+PATH
+  remote: ../..
+  specs:
+    mocktail (3.0.0)
+      sorbet-eraser (~> 0.3.1)
+      sorbet-runtime (~> 0.5.9204)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.3)
+    benchmark (0.4.0)
+    erubi (1.13.1)
+    json (2.21.2)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    m (1.6.2)
+      method_source (>= 0.6.7)
+      rake (>= 0.9.2.2)
+    method_source (1.1.0)
+    minitest (5.27.0)
+    netrc (0.11.0)
+    parallel (1.26.3)
+    parser (3.3.7.4)
+      ast (~> 2.4.1)
+      racc
+    prism (1.4.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    rbi (0.3.1)
+      prism (~> 1.0)
+      rbs (>= 3.4.4)
+      sorbet-runtime (>= 0.5.9204)
+    rbs (3.9.2)
+      logger
+    regexp_parser (2.10.0)
+    rubocop (1.73.2)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.43.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-performance (1.24.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+    rubocop-sorbet (0.9.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1)
+    ruby-progressbar (1.13.0)
+    sorbet (0.5.11971)
+      sorbet-static (= 0.5.11971)
+    sorbet-eraser (0.3.1)
+    sorbet-runtime (0.5.11971)
+    sorbet-static (0.5.11971-universal-darwin)
+    sorbet-static-and-runtime (0.5.11971)
+      sorbet (= 0.5.11971)
+      sorbet-runtime (= 0.5.11971)
+    spoom (1.6.1)
+      erubi (>= 1.10.0)
+      prism (>= 0.28.0)
+      rbi (>= 0.2.3)
+      sorbet-static-and-runtime (>= 0.5.10187)
+      thor (>= 0.19.2)
+    standard (1.47.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.73.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.7)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.7.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.24.0)
+    standard-sorbet (0.0.3)
+      lint_roller (~> 1.1)
+      rubocop-sorbet (~> 0.9.0)
+    tapioca (0.16.11)
+      benchmark
+      bundler (>= 2.2.25)
+      netrc (>= 0.11.0)
+      parallel (>= 1.21.0)
+      rbi (~> 0.2)
+      sorbet-static-and-runtime (>= 0.5.11087)
+      spoom (>= 1.2.0)
+      thor (>= 1.2.0)
+      yard-sorbet
+    thor (1.3.2)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.2.0)
+    yard (0.9.45)
+    yard-sorbet (0.9.0)
+      sorbet-runtime
+      yard
+
+PLATFORMS
+  arm64-darwin-22
+  arm64-darwin-24
+  arm64-darwin-25
+
+DEPENDENCIES
+  m
+  minitest (~> 5.26)
+  mocktail!
+  rake
+  sorbet
+  sorbet-runtime
+  standard
+  standard-sorbet
+  tapioca
+
+BUNDLED WITH
+   2.4.13

data/sub_projects/sorbet_user/Rakefile

@@ -0,0 +1,10 @@
+require "rake/testtask"
+require "standard/rake"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: [:test, "standard:fix"]

data/sub_projects/sorbet_user/bin/tapioca

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'tapioca' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("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("tapioca", "tapioca")

data/sub_projects/sorbet_user/rbi/mocktail.rbi

@@ -0,0 +1,9 @@
+# typed: true
+
+class Mocktail::MatcherPresentation
+  sig {
+    returns(T.untyped)
+  }
+  def is_5
+  end
+end

data/sub_projects/sorbet_user/script/test

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+set -xeuo pipefail
+
+echo "-----> [Sorbet Example Project] Nuking and regenerating Mocktail RBI files"
+rm -rf sorbet/rbi/gems/mocktail*
+bin/tapioca gems
+
+echo "-----> [Sorbet Example Project] Type-checking"
+bundle exec srb tc
+
+echo "-----> [Sorbet Example Project] Running tests"
+bundle exec rake

data/sub_projects/sorbet_user/sorbet/config

@@ -0,0 +1,4 @@
+--dir
+.
+--ignore=tmp/
+--ignore=vendor/

data/sub_projects/sorbet_user/sorbet/rbi/gems/.gitattributes

@@ -0,0 +1 @@
+**/*.rbi linguist-generated=true