summaryrefslogtreecommitdiff
path: root/spec/syntax_suggest/unit/explain_syntax_spec.rb
blob: c62a42b925ed6bbb64f05c1b41cc757340e586bf (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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
# frozen_string_literal: true

require_relative "../spec_helper"

module SyntaxSuggest
  RSpec.describe "ExplainSyntax" do
    it "handles shorthand syntaxes with non-bracket characters" do
      source = <<~EOM
        %Q* lol
      EOM

      explain = ExplainSyntax.new(
        code_lines: CodeLine.from_source(source)
      ).call

      expect(explain.missing).to eq([])
      expect(explain.errors.join.strip).to_not be_empty
    end

    it "handles %w[]" do
      source = <<~EOM
        node.is_a?(Op) && %w[| ||].include?(node.value) &&
      EOM

      explain = ExplainSyntax.new(
        code_lines: CodeLine.from_source(source)
      ).call

      expect(explain.missing).to eq([])
    end

    it "doesn't falsely identify strings or symbols as critical chars" do
      source = <<~EOM
        a = ['(', '{', '[', '|']
      EOM

      explain = ExplainSyntax.new(
        code_lines: CodeLine.from_source(source)
      ).call

      expect(explain.missing).to eq([])

      source = <<~EOM
        a = [:'(', :'{', :'[', :'|']
      EOM

      explain = ExplainSyntax.new(
        code_lines: CodeLine.from_source(source)
      ).call

      expect(explain.missing).to eq([])
    end

    it "finds missing |" do
      source = <<~EOM
        Foo.call do |
        end
      EOM

      explain = ExplainSyntax.new(
        code_lines: CodeLine.from_source(source)
      ).call

      expect(explain.missing).to eq(["|"])
      expect(explain.errors).to eq([explain.why("|")])
    end

    it "finds missing {" do
      source = <<~EOM
        class Cat
          lol = {
        end
      EOM

      explain = ExplainSyntax.new(
        code_lines: CodeLine.from_source(source)
      ).call

      expect(explain.missing).to eq(["}"])
      expect(explain.errors).to eq([explain.why("}")])
    end

    it "finds missing }" do
      source = <<~EOM
        def foo
          lol = "foo" => :bar }
        end
      EOM

      explain = ExplainSyntax.new(
        code_lines: CodeLine.from_source(source)
      ).call

      expect(explain.missing).to eq(["{"])
      expect(explain.errors).to eq([explain.why("{")])
    end

    it "finds missing [" do
      source = <<~EOM
        class Cat
          lol = [
        end
      EOM

      explain = ExplainSyntax.new(
        code_lines: CodeLine.from_source(source)
      ).call

      expect(explain.missing).to eq(["]"])
      expect(explain.errors).to eq([explain.why("]")])
    end

    it "finds missing ]" do
      source = <<~EOM
        def foo
          lol = ]
        end
      EOM

      explain = ExplainSyntax.new(
        code_lines: CodeLine.from_source(source)
      ).call

      expect(explain.missing).to eq(["["])
      expect(explain.errors).to eq([explain.why("[")])
    end

    it "finds missing (" do
      source = "def initialize; ); end"

      explain = ExplainSyntax.new(
        code_lines: CodeLine.from_source(source)
      ).call

      expect(explain.missing).to eq(["("])
      expect(explain.errors).to eq([explain.why("(")])
    end

    it "finds missing )" do
      source = "def initialize; (; end"

      explain = ExplainSyntax.new(
        code_lines: CodeLine.from_source(source)
      ).call

      expect(explain.missing).to eq([")"])
      expect(explain.errors).to eq([explain.why(")")])
    end

    it "finds missing keyword" do
      source = <<~EOM
        class Cat
          end
        end
      EOM

      explain = ExplainSyntax.new(
        code_lines: CodeLine.from_source(source)
      ).call

      expect(explain.missing).to eq(["keyword"])
      expect(explain.errors).to eq([explain.why("keyword")])
    end

    it "finds missing end" do
      source = <<~EOM
        class Cat
          def meow
        end
      EOM

      explain = ExplainSyntax.new(
        code_lines: CodeLine.from_source(source)
      ).call

      expect(explain.missing).to eq(["end"])
      expect(explain.errors).to eq([explain.why("end")])
    end

    it "falls back to ripper on unknown errors" do
      source = <<~EOM
        class Cat
          def meow
            1 *
          end
        end
      EOM

      explain = ExplainSyntax.new(
        code_lines: CodeLine.from_source(source)
      ).call

      expect(explain.missing).to eq([])
      expect(explain.errors).to eq(GetParseErrors.errors(source))
    end

    it "handles an unexpected rescue" do
      source = <<~EOM
        def foo
          if bar
            "baz"
          else
            "foo"
        rescue FooBar
          nil
        end
      EOM

      explain = ExplainSyntax.new(
        code_lines: CodeLine.from_source(source)
      ).call

      expect(explain.missing).to eq(["end"])
    end

    # String embeds are `"#{foo} <-- here`
    #
    # We need to count a `#{` as a `{`
    # otherwise it will report that we are
    # missing a curly when we are using valid
    # string embed syntax
    it "is not confused by valid string embed" do
      source = <<~'EOM'
        foo = "#{hello}"
      EOM

      explain = ExplainSyntax.new(
        code_lines: CodeLine.from_source(source)
      ).call
      expect(explain.missing).to eq([])
    end

    # Missing string embed beginnings are not a
    # syntax error. i.e. `"foo}"` or `"{foo}` or "#foo}"
    # would just be strings with extra characters.
    #
    # However missing the end curly will trigger
    # an error: i.e. `"#{foo`
    #
    # String embed beginning is a `#{` rather than
    # a `{`, make sure we handle that case and
    # report the correct missing `}` diagnosis
    it "finds missing string embed end" do
      source = <<~'EOM'
        "#{foo
      EOM

      explain = ExplainSyntax.new(
        code_lines: CodeLine.from_source(source)
      ).call

      expect(explain.missing).to eq(["}"])
    end
  end
end