Module: DidYouMean
Overview
The DidYouMean
gem adds functionality to suggest possible method/class names upon errors such as NameError
and NoMethodError
. In Ruby 2.3 or later, it is automatically activated during startup.
Disabling did_you_mean
Occasionally, you may want to disable the did_you_mean
gem for e.g. debugging issues in the error object itself. You can disable it entirely by specifying --disable-did_you_mean
option to the ruby
command:
$ ruby --disable-did_you_mean -e "1.zeor?"
-e:1:in `<main>': undefined method `zeor?' for 1:Integer (NameError)
When you do not have direct access to the ruby
command (e.g. rails console, irb
), you could applyoptions using the RUBYOPT
environment variable:
$ RUBYOPT='--disable-did_you_mean' irb
irb:0> 1.zeor?
# => NoMethodError (undefined method `zeor?' for 1:Integer)
Getting the original error message
Sometimes, you do not want to disable the gem entirely, but need to get the original error message without suggestions (e.g. testing). In this case, you could use the #original_message
method on the error object:
no_method_error = begin
1.zeor?
rescue NoMethodError => error
error
end
no_method_error.
# => NoMethodError (undefined method `zeor?' for 1:Integer)
# Did you mean? zero?
no_method_error.
# => NoMethodError (undefined method `zeor?' for 1:Integer)
Constant Summary
-
PlainFormatter =
# File 'lib/did_you_mean/formatter.rb', line 41Formatter
-
SPELL_CHECKERS =
TODO: Remove on 3.3:
DeprecatedMapping.new
-
VERSION =
# File 'lib/did_you_mean/version.rb', line 2"1.6.1".freeze
-
VerboseFormatter =
For compatibility:
Formatter
Class Attribute Summary
-
.formatter
rw
Returns the currently set formatter.
-
.formatter=(formatter)
rw
Updates the primary formatter used to format the suggestions.
Class Method Summary
-
.correct_error(error_class, spell_checker)
Adds
DidYouMean
functionality to an error using a given spell checker. -
.spell_checkers
Returns a sharable hash map of error types and spell checker objects.
Class Attribute Details
.formatter (rw)
Returns the currently set formatter. By default, it is set to ::DidYouMean::Formatter
.
.formatter=(formatter) (rw)
Updates the primary formatter used to format the suggestions.
Class Method Details
.correct_error(error_class, spell_checker)
Adds DidYouMean
functionality to an error using a given spell checker
# File 'lib/did_you_mean.rb', line 97
def self.correct_error(error_class, spell_checker) if defined?(Ractor) new_mapping = { **@spell_checkers, error_class.to_s => spell_checker } new_mapping.default = NullChecker @spell_checkers = Ractor.make_shareable(new_mapping) else spell_checkers[error_class.to_s] = spell_checker end error_class.prepend(Correctable) if error_class.is_a?(Class) && !(error_class < Correctable) end
.spell_checkers
Returns a sharable hash map of error types and spell checker objects.
# File 'lib/did_you_mean.rb', line 92
def self.spell_checkers @spell_checkers end