sorbet/rbi/gems/rspec-support@3.13.1.rbi
# typed: true
# DO NOT EDIT MANUALLY
# This is an autogenerated file for types exported from the `rspec-support` gem.
# Please instead update this file by running `bin/tapioca gem rspec-support`.
# source://rspec-support//lib/rspec/support.rb#3
module RSpec
extend ::RSpec::Support::Warnings
class << self
# source://rspec-core/3.13.0/lib/rspec/core.rb#70
def clear_examples; end
# source://rspec-core/3.13.0/lib/rspec/core.rb#85
def configuration; end
# source://rspec-core/3.13.0/lib/rspec/core.rb#49
def configuration=(_arg0); end
# source://rspec-core/3.13.0/lib/rspec/core.rb#97
def configure; end
# source://rspec-core/3.13.0/lib/rspec/core.rb#194
def const_missing(name); end
# source://rspec-core/3.13.0/lib/rspec/core/dsl.rb#42
def context(*args, &example_group_block); end
# source://rspec-core/3.13.0/lib/rspec/core.rb#122
def current_example; end
# source://rspec-core/3.13.0/lib/rspec/core.rb#128
def current_example=(example); end
# source://rspec-core/3.13.0/lib/rspec/core.rb#154
def current_scope; end
# source://rspec-core/3.13.0/lib/rspec/core.rb#134
def current_scope=(scope); end
# source://rspec-core/3.13.0/lib/rspec/core/dsl.rb#42
def describe(*args, &example_group_block); end
# source://rspec-core/3.13.0/lib/rspec/core/dsl.rb#42
def example_group(*args, &example_group_block); end
# source://rspec-core/3.13.0/lib/rspec/core/dsl.rb#42
def fcontext(*args, &example_group_block); end
# source://rspec-core/3.13.0/lib/rspec/core/dsl.rb#42
def fdescribe(*args, &example_group_block); end
# source://rspec-core/3.13.0/lib/rspec/core.rb#58
def reset; end
# source://rspec-core/3.13.0/lib/rspec/core/shared_example_group.rb#110
def shared_context(name, *args, &block); end
# source://rspec-core/3.13.0/lib/rspec/core/shared_example_group.rb#110
def shared_examples(name, *args, &block); end
# source://rspec-core/3.13.0/lib/rspec/core/shared_example_group.rb#110
def shared_examples_for(name, *args, &block); end
# source://rspec-core/3.13.0/lib/rspec/core.rb#160
def world; end
# source://rspec-core/3.13.0/lib/rspec/core.rb#49
def world=(_arg0); end
# source://rspec-core/3.13.0/lib/rspec/core/dsl.rb#42
def xcontext(*args, &example_group_block); end
# source://rspec-core/3.13.0/lib/rspec/core/dsl.rb#42
def xdescribe(*args, &example_group_block); end
end
end
# Consistent implementation for "cleaning" the caller method to strip out
# non-rspec lines. This enables errors to be reported at the call site in
# the code using the library, which is far more useful than the particular
# internal method that raised an error.
#
# source://rspec-support//lib/rspec/support/caller_filter.rb#10
class RSpec::CallerFilter
class << self
# Earlier rubies do not support the two argument form of `caller`. This
# fallback is logically the same, but slower.
#
# source://rspec-support//lib/rspec/support/caller_filter.rb#49
def first_non_rspec_line(skip_frames = T.unsafe(nil), increment = T.unsafe(nil)); end
end
end
# source://rspec-support//lib/rspec/support/caller_filter.rb#20
RSpec::CallerFilter::ADDITIONAL_TOP_LEVEL_FILES = T.let(T.unsafe(nil), Array)
# rubygems/core_ext/kernel_require.rb isn't actually part of rspec (obviously) but we want
# it ignored when we are looking for the first meaningful line of the backtrace outside
# of RSpec. It can show up in the backtrace as the immediate first caller
# when `CallerFilter.first_non_rspec_line` is called from the top level of a required
# file, but it depends on if rubygems is loaded or not. We don't want to have to deal
# with this complexity in our `RSpec.deprecate` calls, so we ignore it here.
#
# source://rspec-support//lib/rspec/support/caller_filter.rb#30
RSpec::CallerFilter::IGNORE_REGEX = T.let(T.unsafe(nil), Regexp)
# source://rspec-support//lib/rspec/support/caller_filter.rb#22
RSpec::CallerFilter::LIB_REGEX = T.let(T.unsafe(nil), Regexp)
# source://rspec-support//lib/rspec/support/caller_filter.rb#11
RSpec::CallerFilter::RSPEC_LIBS = T.let(T.unsafe(nil), Array)
# source://rspec-support//lib/rspec/support.rb#4
module RSpec::Support
class << self
# Used internally to get a class of a given object, even if it does not respond to #class.
#
# @api private
#
# source://rspec-support//lib/rspec/support.rb#86
def class_of(object); end
# Defines a helper method that is optimized to require files from the
# named lib. The passed block MUST be `{ |f| require_relative f }`
# because for `require_relative` to work properly from within the named
# lib the line of code must be IN that lib.
#
# `require_relative` is preferred when available because it is always O(1),
# regardless of the number of dirs in $LOAD_PATH. `require`, on the other
# hand, does a linear O(N) search over the dirs in the $LOAD_PATH until
# it can resolve the file relative to one of the dirs.
#
# @api private
#
# source://rspec-support//lib/rspec/support.rb#16
def define_optimized_require_for_rspec(lib, &require_relative); end
# Remove a previously registered matcher. Useful for cleaning up after
# yourself in specs.
#
# @private
#
# source://rspec-support//lib/rspec/support/matcher_definition.rb#24
def deregister_matcher_definition(&block); end
# @api private
#
# source://rspec-support//lib/rspec/support.rb#113
def failure_notifier; end
# @api private
#
# source://rspec-support//lib/rspec/support.rb#105
def failure_notifier=(callable); end
# @private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/matcher_definition.rb#29
def is_a_matcher?(object); end
# @private
#
# source://rspec-support//lib/rspec/support/matcher_definition.rb#6
def matcher_definitions; end
# source://rspec-support//lib/rspec/support.rb#54
def method_handle_for(object, method_name); end
# @api private
#
# source://rspec-support//lib/rspec/support.rb#118
def notify_failure(failure, options = T.unsafe(nil)); end
# Used internally to break cyclic dependency between mocks, expectations,
# and support. We don't currently have a consistent implementation of our
# matchers, though we are considering changing that:
# https://github.com/rspec/rspec-mocks/issues/513
#
# @private
#
# source://rspec-support//lib/rspec/support/matcher_definition.rb#16
def register_matcher_definition(&block); end
# source://rspec-support//lib/rspec/support.rb#25
def require_rspec_core(f); end
# source://rspec-support//lib/rspec/support.rb#25
def require_rspec_expectations(f); end
# source://rspec-support//lib/rspec/support.rb#25
def require_rspec_matchers(f); end
# source://rspec-support//lib/rspec/support.rb#25
def require_rspec_support(f); end
# gives a string representation of an object for use in RSpec descriptions
#
# @api private
#
# source://rspec-support//lib/rspec/support/matcher_definition.rb#36
def rspec_description_for_object(object); end
# source://rspec-support//lib/rspec/support.rb#95
def thread_local_data; end
# @api private
#
# source://rspec-support//lib/rspec/support.rb#140
def warning_notifier; end
# @api private
#
# source://rspec-support//lib/rspec/support.rb#133
def warning_notifier=(_arg0); end
# @api private
#
# source://rspec-support//lib/rspec/support.rb#123
def with_failure_notifier(callable); end
end
end
# @private
#
# source://rspec-support//lib/rspec/support.rb#145
module RSpec::Support::AllExceptionsExceptOnesWeMustNotRescue
class << self
# source://rspec-support//lib/rspec/support.rb#150
def ===(exception); end
end
end
# These exceptions are dangerous to rescue as rescuing them
# would interfere with things we should not interfere with.
#
# source://rspec-support//lib/rspec/support.rb#148
RSpec::Support::AllExceptionsExceptOnesWeMustNotRescue::AVOID_RESCUING = T.let(T.unsafe(nil), Array)
# Deals with the slightly different semantics of block arguments.
# For methods, arguments are required unless a default value is provided.
# For blocks, arguments are optional, even if no default value is provided.
#
# However, we want to treat block args as required since you virtually
# always want to pass a value for each received argument and our
# `and_yield` has treated block args as required for many years.
#
# @api private
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#268
class RSpec::Support::BlockSignature < ::RSpec::Support::MethodSignature
# @api private
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#270
def classify_parameters; end
end
# @private
#
# source://rspec-support//lib/rspec/support/comparable_version.rb#6
class RSpec::Support::ComparableVersion
include ::Comparable
# @return [ComparableVersion] a new instance of ComparableVersion
#
# source://rspec-support//lib/rspec/support/comparable_version.rb#11
def initialize(string); end
# source://rspec-support//lib/rspec/support/comparable_version.rb#15
def <=>(other); end
# source://rspec-support//lib/rspec/support/comparable_version.rb#37
def segments; end
# Returns the value of attribute string.
#
# source://rspec-support//lib/rspec/support/comparable_version.rb#9
def string; end
end
# @private
#
# source://rspec-support//lib/rspec/support.rb#110
RSpec::Support::DEFAULT_FAILURE_NOTIFIER = T.let(T.unsafe(nil), Proc)
# @private
#
# source://rspec-support//lib/rspec/support.rb#137
RSpec::Support::DEFAULT_WARNING_NOTIFIER = T.let(T.unsafe(nil), Proc)
# source://rspec-support//lib/rspec/support/differ.rb#12
class RSpec::Support::Differ
# @return [Differ] a new instance of Differ
#
# source://rspec-support//lib/rspec/support/differ.rb#69
def initialize(opts = T.unsafe(nil)); end
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/differ.rb#65
def color?; end
# source://rspec-support//lib/rspec/support/differ.rb#13
def diff(actual, expected); end
# source://rspec-support//lib/rspec/support/differ.rb#59
def diff_as_object(actual, expected); end
# source://rspec-support//lib/rspec/support/differ.rb#30
def diff_as_string(actual, expected); end
private
# source://rspec-support//lib/rspec/support/differ.rb#130
def add_old_hunk_to_hunk(hunk, oldhunk); end
# source://rspec-support//lib/rspec/support/differ.rb#126
def add_to_output(output, string); end
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/differ.rb#80
def all_strings?(*args); end
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/differ.rb#84
def any_multiline_strings?(*args); end
# source://rspec-support//lib/rspec/support/differ.rb#155
def blue(text); end
# source://rspec-support//lib/rspec/support/differ.rb#117
def build_hunks(actual, expected); end
# source://rspec-support//lib/rspec/support/differ.rb#92
def coerce_to_string(string_or_array); end
# source://rspec-support//lib/rspec/support/differ.rb#143
def color(text, color_code); end
# source://rspec-support//lib/rspec/support/differ.rb#163
def color_diff(diff); end
# source://rspec-support//lib/rspec/support/differ.rb#97
def diffably_stringify(array); end
# source://rspec-support//lib/rspec/support/differ.rb#121
def finalize_output(output, final_line); end
# source://rspec-support//lib/rspec/support/differ.rb#139
def format_type; end
# source://rspec-support//lib/rspec/support/differ.rb#151
def green(text); end
# source://rspec-support//lib/rspec/support/differ.rb#204
def handle_encoding_errors(actual, expected); end
# source://rspec-support//lib/rspec/support/differ.rb#194
def hash_to_string(hash); end
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/differ.rb#108
def multiline?(string); end
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/differ.rb#88
def no_numbers?(*args); end
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/differ.rb#76
def no_procs?(*args); end
# source://rspec-support//lib/rspec/support/differ.rb#159
def normal(text); end
# source://rspec-support//lib/rspec/support/differ.rb#180
def object_to_string(object); end
# source://rspec-support//lib/rspec/support/differ.rb#147
def red(text); end
# source://rspec-support//lib/rspec/support/differ.rb#134
def safely_flatten(array); end
end
# Replacement for fileutils#mkdir_p because we don't want to require parts
# of stdlib in RSpec.
#
# @api private
#
# source://rspec-support//lib/rspec/support/directory_maker.rb#11
class RSpec::Support::DirectoryMaker
class << self
# Implements nested directory construction
#
# @api private
#
# source://rspec-support//lib/rspec/support/directory_maker.rb#15
def mkdir_p(path); end
private
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/directory_maker.rb#57
def directory_exists?(dirname); end
# @api private
#
# source://rspec-support//lib/rspec/support/directory_maker.rb#52
def generate_path(stack, part); end
# @api private
#
# source://rspec-support//lib/rspec/support/directory_maker.rb#49
def generate_stack(path); end
end
end
# @private
#
# source://rspec-support//lib/rspec/support/encoded_string.rb#6
class RSpec::Support::EncodedString
# @return [EncodedString] a new instance of EncodedString
#
# source://rspec-support//lib/rspec/support/encoded_string.rb#16
def initialize(string, encoding = T.unsafe(nil)); end
# source://rspec-support//lib/rspec/support/encoded_string.rb#28
def <<(string); end
# source://rspec-support//lib/rspec/support/encoded_string.rb#25
def ==(*args, &block); end
# source://rspec-support//lib/rspec/support/encoded_string.rb#25
def empty?(*args, &block); end
# source://rspec-support//lib/rspec/support/encoded_string.rb#25
def encoding(*args, &block); end
# source://rspec-support//lib/rspec/support/encoded_string.rb#25
def eql?(*args, &block); end
# source://rspec-support//lib/rspec/support/encoded_string.rb#25
def lines(*args, &block); end
# Returns the value of attribute source_encoding.
#
# source://rspec-support//lib/rspec/support/encoded_string.rb#21
def source_encoding; end
# source://rspec-support//lib/rspec/support/encoded_string.rb#41
def split(regex_or_string); end
# source://rspec-support//lib/rspec/support/encoded_string.rb#46
def to_s; end
# source://rspec-support//lib/rspec/support/encoded_string.rb#46
def to_str; end
private
# source://rspec-support//lib/rspec/support/encoded_string.rb#139
def detect_source_encoding(string); end
# Encoding Exceptions:
#
# Raised by Encoding and String methods:
# Encoding::UndefinedConversionError:
# when a transcoding operation fails
# if the String contains characters invalid for the target encoding
# e.g. "\x80".encode('UTF-8','ASCII-8BIT')
# vs "\x80".encode('UTF-8','ASCII-8BIT', undef: :replace, replace: '<undef>')
# # => '<undef>'
# Encoding::CompatibilityError
# when Encoding.compatible?(str1, str2) is nil
# e.g. utf_16le_emoji_string.split("\n")
# e.g. valid_unicode_string.encode(utf8_encoding) << ascii_string
# Encoding::InvalidByteSequenceError:
# when the string being transcoded contains a byte invalid for
# either the source or target encoding
# e.g. "\x80".encode('UTF-8','US-ASCII')
# vs "\x80".encode('UTF-8','US-ASCII', invalid: :replace, replace: '<byte>')
# # => '<byte>'
# ArgumentError
# when operating on a string with invalid bytes
# e.g."\x80".split("\n")
# TypeError
# when a symbol is passed as an encoding
# Encoding.find(:"UTF-8")
# when calling force_encoding on an object
# that doesn't respond to #to_str
#
# Raised by transcoding methods:
# Encoding::ConverterNotFoundError:
# when a named encoding does not correspond with a known converter
# e.g. 'abc'.force_encoding('UTF-8').encode('foo')
# or a converter path cannot be found
# e.g. "\x80".force_encoding('ASCII-8BIT').encode('Emacs-Mule')
#
# Raised by byte <-> char conversions
# RangeError: out of char range
# e.g. the UTF-16LE emoji: 128169.chr
#
# source://rspec-support//lib/rspec/support/encoded_string.rb#93
def matching_encoding(string); end
# http://stackoverflow.com/a/8711118/879854
# Loop over chars in a string replacing chars
# with invalid encoding, which is a pretty good proxy
# for the invalid byte sequence that causes an ArgumentError
#
# source://rspec-support//lib/rspec/support/encoded_string.rb#124
def remove_invalid_bytes(string); end
class << self
# source://rspec-support//lib/rspec/support/encoded_string.rb#143
def pick_encoding(source_a, source_b); end
end
end
# Ruby's default replacement string is:
# U+FFFD ("\xEF\xBF\xBD"), for Unicode encoding forms, else
# ? ("\x3F")
#
# source://rspec-support//lib/rspec/support/encoded_string.rb#14
RSpec::Support::EncodedString::REPLACE = T.let(T.unsafe(nil), String)
# source://rspec-support//lib/rspec/support/encoded_string.rb#9
RSpec::Support::EncodedString::US_ASCII = T.let(T.unsafe(nil), String)
# Reduce allocations by storing constants.
#
# source://rspec-support//lib/rspec/support/encoded_string.rb#8
RSpec::Support::EncodedString::UTF_8 = T.let(T.unsafe(nil), String)
# Provides a means to fuzzy-match between two arbitrary objects.
# Understands array/hash nesting. Uses `===` or `==` to
# perform the matching.
#
# source://rspec-support//lib/rspec/support/fuzzy_matcher.rb#8
module RSpec::Support::FuzzyMatcher
class << self
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/fuzzy_matcher.rb#10
def values_match?(expected, actual); end
private
# @private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/fuzzy_matcher.rb#29
def arrays_match?(expected_list, actual_list); end
# @private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/fuzzy_matcher.rb#38
def hashes_match?(expected_hash, actual_hash); end
end
end
# @private
#
# source://rspec-support//lib/rspec/support/hunk_generator.rb#9
class RSpec::Support::HunkGenerator
# @return [HunkGenerator] a new instance of HunkGenerator
#
# source://rspec-support//lib/rspec/support/hunk_generator.rb#10
def initialize(actual, expected); end
# source://rspec-support//lib/rspec/support/hunk_generator.rb#15
def hunks; end
private
# source://rspec-support//lib/rspec/support/hunk_generator.rb#32
def actual_lines; end
# source://rspec-support//lib/rspec/support/hunk_generator.rb#36
def build_hunk(piece); end
# source://rspec-support//lib/rspec/support/hunk_generator.rb#44
def context_lines; end
# source://rspec-support//lib/rspec/support/hunk_generator.rb#24
def diffs; end
# source://rspec-support//lib/rspec/support/hunk_generator.rb#28
def expected_lines; end
end
# @api private
#
# source://rspec-support//lib/rspec/support.rb#40
RSpec::Support::KERNEL_METHOD_METHOD = T.let(T.unsafe(nil), UnboundMethod)
# Allows matchers to be used instead of providing keyword arguments. In
# practice, when this happens only the arity of the method is verified.
#
# @private
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#395
class RSpec::Support::LooseSignatureVerifier < ::RSpec::Support::MethodSignatureVerifier
private
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#398
def split_args(*args); end
end
# If a matcher is used in a signature in place of keyword arguments, all
# keyword argument validation needs to be skipped since the matcher is
# opaque.
#
# Instead, keyword arguments will be validated when the method is called
# and they are actually known.
#
# @private
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#415
class RSpec::Support::LooseSignatureVerifier::SignatureWithKeywordArgumentsMatcher
# @return [SignatureWithKeywordArgumentsMatcher] a new instance of SignatureWithKeywordArgumentsMatcher
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#416
def initialize(signature); end
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#436
def has_kw_args_in?(args); end
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#424
def invalid_kw_args_from(_kw_args); end
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#420
def missing_kw_args_from(_kw_args); end
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#428
def non_kw_args_arity_description; end
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#432
def valid_non_kw_args?(*args); end
end
# Extracts info about the number of arguments and allowed/required
# keyword args of a given method.
#
# @private
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#13
class RSpec::Support::MethodSignature
# @return [MethodSignature] a new instance of MethodSignature
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#16
def initialize(method); end
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#98
def arbitrary_kw_args?; end
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#38
def classify_arity(arity = T.unsafe(nil)); end
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#106
def classify_parameters; end
# Without considering what the last arg is, could it
# contain keyword arguments?
#
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#92
def could_contain_kw_args?(args); end
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#51
def description; end
# If the last argument is Hash, Ruby will treat only symbol keys as keyword arguments
# the rest will be grouped in another Hash and passed as positional argument.
#
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#84
def has_kw_args_in?(args); end
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#77
def invalid_kw_args_from(given_kw_args); end
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#14
def max_non_kw_args; end
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#14
def min_non_kw_args; end
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#73
def missing_kw_args_from(given_kw_args); end
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#23
def non_kw_args_arity_description; end
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#14
def optional_kw_args; end
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#14
def required_kw_args; end
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#102
def unlimited_args?; end
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#31
def valid_non_kw_args?(positional_arg_count, optional_max_arg_count = T.unsafe(nil)); end
end
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#162
RSpec::Support::MethodSignature::INFINITY = T.let(T.unsafe(nil), Float)
# Encapsulates expectations about the number of arguments and
# allowed/required keyword args of a given method.
#
# @api private
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#219
class RSpec::Support::MethodSignatureExpectation
# @api private
# @return [MethodSignatureExpectation] a new instance of MethodSignatureExpectation
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#220
def initialize; end
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#247
def empty?; end
# @api private
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#231
def expect_arbitrary_keywords; end
# @api private
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#231
def expect_arbitrary_keywords=(_arg0); end
# @api private
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#231
def expect_unlimited_arguments; end
# @api private
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#231
def expect_unlimited_arguments=(_arg0); end
# @api private
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#229
def keywords; end
# @api private
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#254
def keywords=(values); end
# @api private
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#229
def max_count; end
# @api private
# @raise [ArgumentError]
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#233
def max_count=(number); end
# @api private
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#229
def min_count; end
# @api private
# @raise [ArgumentError]
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#240
def min_count=(number); end
end
# Abstract base class for signature verifiers.
#
# @api private
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#280
class RSpec::Support::MethodSignatureVerifier
# @api private
# @return [MethodSignatureVerifier] a new instance of MethodSignatureVerifier
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#283
def initialize(signature, args = T.unsafe(nil)); end
# @api private
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#326
def error_message; end
# @api private
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#281
def kw_args; end
# @api private
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#281
def max_non_kw_args; end
# @api private
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#281
def min_non_kw_args; end
# @api private
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#281
def non_kw_args; end
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#318
def valid?; end
# @api private
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#290
def with_expectation(expectation); end
private
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#357
def arbitrary_kw_args?; end
# @api private
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#353
def invalid_kw_args; end
# @api private
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#349
def missing_kw_args; end
# @api private
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#365
def split_args(*args); end
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#361
def unlimited_args?; end
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#345
def valid_non_kw_args?; end
end
# On 1.9 and up, this is in core, so we just use the real one
#
# source://rspec-support//lib/rspec/support/reentrant_mutex.rb#65
class RSpec::Support::Mutex < ::Thread::Mutex
class << self
# source://rspec-support//lib/rspec/support/reentrant_mutex.rb#70
def new; end
end
end
# If you mock Mutex.new you break our usage of Mutex, so
# instead we capture the original method to return Mutexes.
#
# source://rspec-support//lib/rspec/support/reentrant_mutex.rb#68
RSpec::Support::Mutex::NEW_MUTEX_METHOD = T.let(T.unsafe(nil), Method)
# Provides query methods for different OS or OS features.
#
# @api private
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#11
module RSpec::Support::OS
private
# @api private
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#14
def windows?; end
# @api private
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#18
def windows_file_path?; end
class << self
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#14
def windows?; end
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#18
def windows_file_path?; end
end
end
# Provide additional output details beyond what `inspect` provides when
# printing Time, DateTime, or BigDecimal
#
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#10
class RSpec::Support::ObjectFormatter
# @api private
# @return [ObjectFormatter] a new instance of ObjectFormatter
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#29
def initialize(max_formatted_output_length = T.unsafe(nil)); end
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#34
def format(object); end
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#13
def max_formatted_output_length; end
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#13
def max_formatted_output_length=(_arg0); end
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#70
def prepare_array(array); end
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#94
def prepare_element(element); end
# Prepares the provided object to be formatted by wrapping it as needed
# in something that, when `inspect` is called on it, will produce the
# desired output.
#
# This allows us to apply the desired formatting to hash/array data structures
# at any level of nesting, simply by walking that structure and replacing items
# with custom items that have `inspect` defined to return the desired output
# for that item. Then we can just use `Array#inspect` or `Hash#inspect` to
# format the entire thing.
#
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#58
def prepare_for_inspection(object); end
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#76
def prepare_hash(input_hash); end
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#113
def recursive_structure?(object); end
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#86
def sort_hash_keys(input_hash); end
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#106
def with_entering_structure(structure); end
private
# Returns the substring defined by the start_index and end_index
# If the string ends with a partial ANSI code code then that
# will be removed as printing partial ANSI
# codes to the terminal can lead to corruption
#
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#268
def truncate_string(str, start_index, end_index); end
class << self
# Methods are deferred to a default instance of the class to maintain the interface
# For example, calling ObjectFormatter.format is still possible
#
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#17
def default_instance; end
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#21
def format(object); end
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#25
def prepare_for_inspection(object); end
end
end
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#127
class RSpec::Support::ObjectFormatter::BaseInspector < ::Struct
# Returns the value of attribute formatter
#
# @return [Object] the current value of formatter
def formatter; end
# Sets the attribute formatter
#
# @param value [Object] the value to set the attribute formatter to.
# @return [Object] the newly set value
def formatter=(_); end
# @api private
# @raise [NotImplementedError]
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#132
def inspect; end
# Returns the value of attribute object
#
# @return [Object] the current value of object
def object; end
# Sets the attribute object
#
# @param value [Object] the value to set the attribute object to.
# @return [Object] the newly set value
def object=(_); end
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#136
def pretty_print(pp); end
class << self
def [](*_arg0); end
# @api private
# @raise [NotImplementedError]
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#128
def can_inspect?(_object); end
def inspect; end
def keyword_init?; end
def members; end
def new(*_arg0); end
end
end
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#177
class RSpec::Support::ObjectFormatter::BigDecimalInspector < ::RSpec::Support::ObjectFormatter::BaseInspector
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#182
def inspect; end
class << self
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#178
def can_inspect?(object); end
end
end
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#159
class RSpec::Support::ObjectFormatter::DateTimeInspector < ::RSpec::Support::ObjectFormatter::BaseInspector
# ActiveSupport sometimes overrides inspect. If `ActiveSupport` is
# defined use a custom format string that includes more time precision.
#
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#168
def inspect; end
class << self
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#162
def can_inspect?(object); end
end
end
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#160
RSpec::Support::ObjectFormatter::DateTimeInspector::FORMAT = T.let(T.unsafe(nil), String)
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#224
class RSpec::Support::ObjectFormatter::DelegatorInspector < ::RSpec::Support::ObjectFormatter::BaseInspector
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#229
def inspect; end
class << self
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#225
def can_inspect?(object); end
end
end
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#187
class RSpec::Support::ObjectFormatter::DescribableMatcherInspector < ::RSpec::Support::ObjectFormatter::BaseInspector
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#192
def inspect; end
class << self
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#188
def can_inspect?(object); end
end
end
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#11
RSpec::Support::ObjectFormatter::ELLIPSIS = T.let(T.unsafe(nil), String)
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#247
RSpec::Support::ObjectFormatter::INSPECTOR_CLASSES = T.let(T.unsafe(nil), Array)
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#117
class RSpec::Support::ObjectFormatter::InspectableItem < ::Struct
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#118
def inspect; end
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#122
def pretty_print(pp); end
# Returns the value of attribute text
#
# @return [Object] the current value of text
def text; end
# Sets the attribute text
#
# @param value [Object] the value to set the attribute text to.
# @return [Object] the newly set value
def text=(_); end
class << self
def [](*_arg0); end
def inspect; end
def keyword_init?; end
def members; end
def new(*_arg0); end
end
end
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#234
class RSpec::Support::ObjectFormatter::InspectableObjectInspector < ::RSpec::Support::ObjectFormatter::BaseInspector
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#242
def inspect; end
class << self
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#235
def can_inspect?(object); end
end
end
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#141
class RSpec::Support::ObjectFormatter::TimeInspector < ::RSpec::Support::ObjectFormatter::BaseInspector
# for 1.8.7
#
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#149
def inspect; end
class << self
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#144
def can_inspect?(object); end
end
end
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#142
RSpec::Support::ObjectFormatter::TimeInspector::FORMAT = T.let(T.unsafe(nil), String)
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#197
class RSpec::Support::ObjectFormatter::UninspectableObjectInspector < ::RSpec::Support::ObjectFormatter::BaseInspector
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#207
def inspect; end
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#211
def klass; end
# http://stackoverflow.com/a/2818916
#
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#216
def native_object_id; end
class << self
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#200
def can_inspect?(object); end
end
end
# @api private
#
# source://rspec-support//lib/rspec/support/object_formatter.rb#198
RSpec::Support::ObjectFormatter::UninspectableObjectInspector::OBJECT_ID_FORMAT = T.let(T.unsafe(nil), String)
# Provides recursive constant lookup methods useful for
# constant stubbing.
#
# source://rspec-support//lib/rspec/support/recursive_const_methods.rb#7
module RSpec::Support::RecursiveConstMethods
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/recursive_const_methods.rb#45
def const_defined_on?(mod, const_name); end
# source://rspec-support//lib/rspec/support/recursive_const_methods.rb#53
def constants_defined_on(mod); end
# @raise [NameError]
#
# source://rspec-support//lib/rspec/support/recursive_const_methods.rb#49
def get_const_defined_on(mod, const_name); end
# source://rspec-support//lib/rspec/support/recursive_const_methods.rb#73
def normalize_const_name(const_name); end
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/recursive_const_methods.rb#64
def recursive_const_defined?(const_name); end
# source://rspec-support//lib/rspec/support/recursive_const_methods.rb#58
def recursive_const_get(const_name); end
end
# Allows a thread to lock out other threads from a critical section of code,
# while allowing the thread with the lock to reenter that section.
#
# Based on Monitor as of 2.2 -
# https://github.com/ruby/ruby/blob/eb7ddaa3a47bf48045d26c72eb0f263a53524ebc/lib/monitor.rb#L9
#
# Depends on Mutex, but Mutex is only available as part of core since 1.9.1:
# exists - http://ruby-doc.org/core-1.9.1/Mutex.html
# dne - http://ruby-doc.org/core-1.9.0/Mutex.html
#
# @private
#
# source://rspec-support//lib/rspec/support/reentrant_mutex.rb#16
class RSpec::Support::ReentrantMutex
# @return [ReentrantMutex] a new instance of ReentrantMutex
#
# source://rspec-support//lib/rspec/support/reentrant_mutex.rb#17
def initialize; end
# source://rspec-support//lib/rspec/support/reentrant_mutex.rb#23
def synchronize; end
private
# source://rspec-support//lib/rspec/support/reentrant_mutex.rb#35
def enter; end
# source://rspec-support//lib/rspec/support/reentrant_mutex.rb#40
def exit; end
end
# Provides query methods for different rubies
#
# @api private
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#26
module RSpec::Support::Ruby
private
# @api private
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#29
def jruby?; end
# @api private
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#37
def jruby_9000?; end
# @api private
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#33
def jruby_version; end
# @api private
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#49
def mri?; end
# @api private
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#45
def non_mri?; end
# @api private
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#41
def rbx?; end
# @api private
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#53
def truffleruby?; end
class << self
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#29
def jruby?; end
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#37
def jruby_9000?; end
# @api private
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#33
def jruby_version; end
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#49
def mri?; end
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#45
def non_mri?; end
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#41
def rbx?; end
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#53
def truffleruby?; end
end
end
# Provides query methods for ruby features that differ among
# implementations.
#
# @api private
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#62
module RSpec::Support::RubyFeatures
private
# @api private
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#85
def caller_locations_supported?; end
# @api private
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#155
def distincts_kw_args_from_positional_hash?; end
# On JRuby 1.7 `--1.8` mode, `Process.respond_to?(:fork)` returns true,
# but when you try to fork, it raises an error:
# NotImplementedError: fork is not available on this platform
#
# When we drop support for JRuby 1.7 and/or Ruby 1.8, we can drop
# this special case.
#
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#76
def fork_supported?; end
# https://rubyreferences.github.io/rubychanges/3.0.html#keyword-arguments-are-now-fully-separated-from-positional-arguments
#
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#111
def kw_arg_separation?; end
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#160
def kw_args_supported?; end
# @api private
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#216
def module_prepends_supported?; end
# @api private
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#212
def module_refinement_supported?; end
# @api private
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#81
def optional_and_splat_args_supported?; end
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#164
def required_kw_args_supported?; end
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#146
def ripper_supported?; end
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#90
def supports_exception_cause?; end
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#168
def supports_rebinding_module_methods?; end
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#100
def supports_syntax_suggest?; end
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#121
def supports_taint?; end
class << self
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#85
def caller_locations_supported?; end
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#155
def distincts_kw_args_from_positional_hash?; end
# source://rspec-support//lib/rspec/support/ruby_features.rb#76
def fork_supported?; end
# source://rspec-support//lib/rspec/support/ruby_features.rb#111
def kw_arg_separation?; end
# source://rspec-support//lib/rspec/support/ruby_features.rb#160
def kw_args_supported?; end
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#216
def module_prepends_supported?; end
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#212
def module_refinement_supported?; end
# @api private
# @return [Boolean]
#
# source://rspec-support//lib/rspec/support/ruby_features.rb#81
def optional_and_splat_args_supported?; end
# source://rspec-support//lib/rspec/support/ruby_features.rb#164
def required_kw_args_supported?; end
# source://rspec-support//lib/rspec/support/ruby_features.rb#146
def ripper_supported?; end
# source://rspec-support//lib/rspec/support/ruby_features.rb#90
def supports_exception_cause?; end
# source://rspec-support//lib/rspec/support/ruby_features.rb#168
def supports_rebinding_module_methods?; end
# source://rspec-support//lib/rspec/support/ruby_features.rb#100
def supports_syntax_suggest?; end
# source://rspec-support//lib/rspec/support/ruby_features.rb#121
def supports_taint?; end
end
end
# Figures out whether a given method can accept various arguments.
# Surprisingly non-trivial.
#
# @private
#
# source://rspec-support//lib/rspec/support/method_signature_verifier.rb#389
RSpec::Support::StrictSignatureVerifier = RSpec::Support::MethodSignatureVerifier
# source://rspec-support//lib/rspec/support/version.rb#5
module RSpec::Support::Version; end
# source://rspec-support//lib/rspec/support/version.rb#6
RSpec::Support::Version::STRING = T.let(T.unsafe(nil), String)
# source://rspec-support//lib/rspec/support/warnings.rb#8
module RSpec::Support::Warnings
# source://rspec-support//lib/rspec/support/warnings.rb#9
def deprecate(deprecated, options = T.unsafe(nil)); end
# Used internally to print deprecation warnings
# when rspec-core isn't loaded
#
# @private
#
# source://rspec-support//lib/rspec/support/warnings.rb#17
def warn_deprecation(message, options = T.unsafe(nil)); end
# Used internally to print longer warnings
#
# @private
#
# source://rspec-support//lib/rspec/support/warnings.rb#31
def warn_with(message, options = T.unsafe(nil)); end
# Used internally to print warnings
#
# @private
#
# source://rspec-support//lib/rspec/support/warnings.rb#24
def warning(text, options = T.unsafe(nil)); end
end
# source://rspec-support//lib/rspec/support/with_keywords_when_needed.rb#7
module RSpec::Support::WithKeywordsWhenNeeded
private
# Remove this in RSpec 4 in favour of explicitly passed in kwargs where
# this is used. Works around a warning in Ruby 2.7
#
# source://rspec-support//lib/rspec/support/with_keywords_when_needed.rb#17
def class_exec(klass, *args, **_arg2, &block); end
class << self
# source://rspec-support//lib/rspec/support/with_keywords_when_needed.rb#17
def class_exec(klass, *args, **_arg2, &block); end
end
end