модуль DidYouMean

Джем DidYouMean добавляет функциональность для предложений возможных имён методов/классов при ошибках, таких как NameError и NoMethodError. В Ruby 2.3 или более поздних версиях он автоматически активируется во время запуска.

@example

methosd
# => NameError: undefined local variable or method `methosd' for main:Object
#   Did you mean?  methods
#                  method

OBject
# => NameError: uninitialized constant OBject
#    Did you mean?  Object

@full_name = "Yuki Nishijima"
first_name, last_name = full_name.split(" ")
# => NameError: undefined local variable or method `full_name' for main:Object
#    Did you mean?  @full_name

@@full_name = "Yuki Nishijima"
@@full_anme
# => NameError: uninitialized class variable @@full_anme in Object
#    Did you mean?  @@full_name

full_name = "Yuki Nishijima"
full_name.starts_with?("Y")
# => NoMethodError: undefined method `starts_with?' for "Yuki Nishijima":String
#    Did you mean?  start_with?

hash = {foo: 1, bar: 2, baz: 3}
hash.fetch(:fooo)
# => KeyError: key not found: :fooo
#    Did you mean?  :foo

Отключение `did_you_mean`

Иногда вам может потребоваться отключить джем did_you_mean для отладки проблем в самом объекте ошибки. Вы можете полностью отключить его, указав параметр --disable-did_you_mean в команде ruby:

$ ruby --disable-did_you_mean -e "1.zeor?"
-e:1:in `<main>': undefined method `zeor?' for 1:Integer (NameError)

Если у вас нет прямого доступа к команде ruby (например, +rails console+, irb), вы можете применить параметры, используя переменную окружения RUBYOPT:

$ RUBYOPT='--disable-did_you_mean' irb
irb:0> 1.zeor?
# => NoMethodError (undefined method `zeor?' for 1:Integer)

Получение исходного сообщения об ошибке

Иногда вам не нужно полностью отключать джем, но необходимо получить исходное сообщение об ошибке без предложений (например, при тестировании). В этом случае вы можете использовать метод original_message в объекте ошибки:

no_method_error = begin
                    1.zeor?
                  rescue NoMethodError => error
                    error
                  end

no_method_error.message
# => NoMethodError (undefined method `zeor?' for 1:Integer)
#    Did you mean?  zero?

no_method_error.original_message
# => NoMethodError (undefined method `zeor?' for 1:Integer)

Константы

PlainFormatter: Форматтер DidYouMean::Formatter является базовым и по умолчанию для джема. Форматтер отвечает на метод message_for и возвращает удобочитаемую строку.
VERSION
VerboseFormatter: Форматтер DidYouMean::Formatter является базовым и по умолчанию для джема. Форматтер отвечает на метод message_for и возвращает удобочитаемую строку.

Публичные методы класса

correct_error (error_class, 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

Добавляет функциональность DidYouMean к ошибке, используя указанный проверщик орфографии

formatter ()

Исходный код

# File lib/did_you_mean.rb, line 117
def self.formatter
  if defined?(Ractor)
    Ractor.current[:__did_you_mean_formatter__] || Formatter
  else
    Formatter
  end
end

Возвращает текущий установленный форматтер. По умолчанию он настроен на DidYouMean::Formatter.

formatter= (formatter)

Исходный код

# File lib/did_you_mean.rb, line 126
def self.formatter=(formatter)
  if defined?(Ractor)
    Ractor.current[:__did_you_mean_formatter__] = formatter
  end
end

Обновляет основной форматтер, используемый для форматирования предложений.

spell_checkers ()

Исходный код

# File lib/did_you_mean.rb, line 92
def self.spell_checkers
  @spell_checkers
end

Возвращает совместную карту типов ошибок и объектов проверки орфографии.

Ruby Core © 1993–2024 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.

модуль DidYouMean

Отключение did_you_mean

Получение исходного сообщения об ошибке

Отключение `did_you_mean`