summaryrefslogtreecommitdiff
path: root/test/did_you_mean/spell_checking/test_variable_name_check.rb
blob: 9d8b86eb5b891c24c60335f2dec4a853e17bd1ab (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
require_relative '../helper'

class VariableNameCheckTest < Test::Unit::TestCase
  include DidYouMean::TestHelper

  class User
    def initialize
      @email_address = 'email_address@address.net'
      @first_name    = nil
      @last_name     = nil
    end

    def first_name; end
    def to_s
      "#{@first_name} #{@last_name} <#{email_address}>"
    end

    private

    def cia_codename; "Alexa" end
  end

  module UserModule
    def from_module; end
  end

  def setup
    @user = User.new.extend(UserModule)
  end

  def test_corrections_include_instance_method
    error = assert_raise(NameError) do
      @user.instance_eval { flrst_name }
    end

    @user.instance_eval do
      remove_instance_variable :@first_name
      remove_instance_variable :@last_name
    end

    assert_correction :first_name, error.corrections
    assert_match "Did you mean?  first_name", get_message(error)
  end

  def test_corrections_include_method_from_module
    error = assert_raise(NameError) do
      @user.instance_eval { fr0m_module }
    end

    assert_correction :from_module, error.corrections
    assert_match "Did you mean?  from_module", get_message(error)
  end

  def test_corrections_include_local_variable_name
    if RUBY_ENGINE != "jruby"
      person = person = nil
      error = (eprson rescue $!) # Do not use @assert_raise here as it changes a scope.

      assert_correction :person, error.corrections
      assert_match "Did you mean?  person", get_message(error)
    end
  end

  def test_corrections_include_ruby_predefined_objects
    some_var = some_var = nil

    false_error = assert_raise(NameError) do
      some_var = fals
    end

    true_error = assert_raise(NameError) do
      some_var = treu
    end

    nil_error = assert_raise(NameError) do
      some_var = nul
    end

    file_error = assert_raise(NameError) do
      __FIEL__
    end

    assert_correction :false, false_error.corrections
    assert_match "Did you mean?  false", get_message(false_error)

    assert_correction :true, true_error.corrections
    assert_match "Did you mean?  true", get_message(true_error)

    assert_correction :nil, nil_error.corrections
    assert_match "Did you mean?  nil", get_message(nil_error)

    assert_correction :__FILE__, file_error.corrections
    assert_match "Did you mean?  __FILE__", get_message(file_error)
  end

  def test_suggests_yield
    error = assert_raise(NameError) { yeild }

    assert_correction :yield, error.corrections
    assert_match "Did you mean?  yield", get_message(error)
  end

  def test_corrections_include_instance_variable_name
    error = assert_raise(NameError){ @user.to_s }

    assert_correction :@email_address, error.corrections
    assert_match "Did you mean?  @email_address", get_message(error)
  end

  def test_corrections_include_private_method
    error = assert_raise(NameError) do
      @user.instance_eval { cia_code_name }
    end

    assert_correction :cia_codename, error.corrections
    assert_match "Did you mean?  cia_codename",  get_message(error)
  end

  @@does_exist = true

  def test_corrections_include_class_variable_name
    error = assert_raise(NameError){ @@doesnt_exist }

    assert_correction :@@does_exist, error.corrections
    assert_match "Did you mean?  @@does_exist", get_message(error)
  end

  def test_struct_name_error
    value = Struct.new(:does_exist).new
    error = assert_raise(NameError){ value[:doesnt_exist] }

    assert_correction [:does_exist, :does_exist=], error.corrections
    assert_match "Did you mean?  does_exist", get_message(error)
  end

  def test_exclude_typical_incorrect_suggestions
    error = assert_raise(NameError){ foo }
    assert_empty error.corrections
  end
end