Class: DidYouMean::MethodNameChecker

Inherits:
Object
  • Object
show all
Defined in:
lib/did_you_mean/spell_checkers/method_name_checker.rb

Constant Summary collapse

NAMES_TO_EXCLUDE = 
{ NilClass => nil.methods }
RB_RESERVED_WORDS =

MethodNameChecker::RB_RESERVED_WORDS is the list of reserved words in Ruby that take an argument. Unlike VariableNameChecker::RB_RESERVED_WORDS, these reserved words require an argument, and a NoMethodError is raised due to the presence of the argument.

The MethodNameChecker will use this list to suggest a reversed word if a NoMethodError is raised and found closest matches.

Also see VariableNameChecker::RB_RESERVED_WORDS.

%i(
  alias
  case
  def
  defined?
  elsif
  end
  ensure
  for
  rescue
  super
  undef
  unless
  until
  when
  while
  yield
)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(exception) ⇒ MethodNameChecker

Returns a new instance of MethodNameChecker.



42
43
44
45
46
 
# File 'lib/did_you_mean/spell_checkers/method_name_checker.rb', line 42

def initialize(exception)
  @method_name  = exception.name
  @receiver     = exception.receiver
  @private_call = exception.respond_to?(:private_call?) ? exception.private_call? : false
end

Instance Attribute Details

#method_name ⇒ Object (readonly)

Returns the value of attribute method_name.



5
6
7
 
# File 'lib/did_you_mean/spell_checkers/method_name_checker.rb', line 5

def method_name
  @method_name
end

#receiver ⇒ Object (readonly)

Returns the value of attribute receiver.



5
6
7
 
# File 'lib/did_you_mean/spell_checkers/method_name_checker.rb', line 5

def receiver
  @receiver
end

Instance Method Details

#corrections ⇒ Object 



48
49
50
51
52
53
54
55
 
# File 'lib/did_you_mean/spell_checkers/method_name_checker.rb', line 48

def corrections
  @corrections ||= begin
                     dictionary = method_names
                     dictionary = RB_RESERVED_WORDS + dictionary if @private_call

                     SpellChecker.new(dictionary: dictionary).correct(method_name) - names_to_exclude
                   end
end

#method_names ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/did_you_mean/spell_checkers/method_name_checker.rb', line 57

def method_names
  if Object === receiver
    method_names = receiver.methods + receiver.singleton_methods
    method_names += receiver.private_methods if @private_call
    method_names.uniq!
    # Assume that people trying to use a writer are not interested in a reader
    # and vice versa
    if method_name.match?(/=\Z/)
      method_names.select! { |name| name.match?(/=\Z/) }
    else
      method_names.reject! { |name| name.match?(/=\Z/) }
    end
    method_names
  else
    []
  end
end

#names_to_exclude ⇒ Object 



75
76
77
 
# File 'lib/did_you_mean/spell_checkers/method_name_checker.rb', line 75

def names_to_exclude
  Object === receiver ? NAMES_TO_EXCLUDE[receiver.class] : []
end