/
bm_sexp.rb
606 lines (513 loc) · 12.9 KB
/
bm_sexp.rb
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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
#Sexp changes from ruby_parser
#and some changes for caching hash value and tracking 'original' line number
#of a Sexp.
class Sexp
attr_accessor :original_line, :or_depth
ASSIGNMENT_BOOL = [:gasgn, :iasgn, :lasgn, :cvdecl, :cvasgn, :cdecl, :or, :and, :colon2, :op_asgn_or]
def method_missing name, *args
#Brakeman does not use this functionality,
#so overriding it to raise a NoMethodError.
#
#The original functionality calls find_node and optionally
#deletes the node if found.
#
#Defining a method named "return" seems like a bad idea, so we have to
#check for it here instead
if name == :return
find_node name, *args
else
raise NoMethodError.new("No method '#{name}' for Sexp", name, args)
end
end
#Create clone of Sexp and nested Sexps but not their non-Sexp contents.
#If a line number is provided, also sets line/original_line on all Sexps.
def deep_clone line = nil
s = Sexp.new
self.each do |e|
if e.is_a? Sexp
s << e.deep_clone(line)
else
s << e
end
end
if line
s.original_line = self.original_line || self.line
s.line(line)
else
s.original_line = self.original_line
s.line(self.line)
end
s
end
def paren
@paren ||= false
end
def value
raise WrongSexpError, "Sexp#value called on multi-item Sexp", caller[1..-1] if size > 2
self[1]
end
def value= exp
raise WrongSexpError, "Sexp#value= called on multi-item Sexp", caller[1..-1] if size > 2
@my_hash_value = nil
self[1] = exp
end
def second
self[1]
end
def to_sym
self.value.to_sym
end
def node_type= type
@my_hash_value = nil
self[0] = type
end
#Join self and exp into an :or Sexp.
#Sets or_depth.
#Used for combining "branched" values in AliasProcessor.
def combine exp, line = nil
combined = Sexp.new(:or, self, exp).line(line || -2)
combined.or_depth = [self.or_depth, exp.or_depth].compact.reduce(0, :+) + 1
combined
end
alias :node_type :sexp_type
alias :values :sexp_body # TODO: retire
alias :old_push :<<
alias :old_compact :compact
alias :old_fara :find_and_replace_all
alias :old_find_node :find_node
def << arg
@my_hash_value = nil
old_push arg
end
def hash
#There still seems to be some instances in which the hash of the
#Sexp changes, but I have not found what method call is doing it.
#Of course, Sexp is subclasses from Array, so who knows what might
#be going on.
@my_hash_value ||= super
end
def compact
@my_hash_value = nil
old_compact
end
def find_and_replace_all *args
@my_hash_value = nil
old_fara(*args)
end
def find_node *args
@my_hash_value = nil
old_find_node(*args)
end
#Raise a WrongSexpError if the nodes type does not match one of the expected
#types.
def expect *types
unless types.include? self.node_type
raise WrongSexpError, "Expected #{types.join ' or '} but given #{self.inspect}", caller[1..-1]
end
end
#Returns target of a method call:
#
#s(:call, s(:call, nil, :x, s(:arglist)), :y, s(:arglist, s(:lit, 1)))
# ^-----------target-----------^
def target
expect :call, :attrasgn, :safe_call, :safe_attrasgn
self[1]
end
#Sets the target of a method call:
def target= exp
expect :call, :attrasgn, :safe_call, :safe_attrasgn
@my_hash_value = nil
self[1] = exp
end
#Returns method of a method call:
#
#s(:call, s(:call, nil, :x, s(:arglist)), :y, s(:arglist, s(:lit, 1)))
# ^- method
def method
expect :call, :attrasgn, :safe_call, :safe_attrasgn, :super, :zsuper, :result
case self.node_type
when :call, :attrasgn, :safe_call, :safe_attrasgn
self[2]
when :super, :zsuper
:super
when :result
self.last
end
end
def method= name
expect :call, :safe_call
self[2] = name
end
#Sets the arglist in a method call.
def arglist= exp
expect :call, :attrasgn, :safe_call, :safe_attrasgn
@my_hash_value = nil
start_index = 3
if exp.is_a? Sexp and exp.node_type == :arglist
exp = exp[1..-1]
end
exp.each_with_index do |e, i|
self[start_index + i] = e
end
end
def set_args *exp
self.arglist = exp
end
#Returns arglist for method call. This differs from Sexp#args, as Sexp#args
#does not return a 'real' Sexp (it does not have a node type) but
#Sexp#arglist returns a s(:arglist, ...)
#
# s(:call, s(:call, nil, :x, s(:arglist)), :y, s(:arglist, s(:lit, 1), s(:lit, 2)))
# ^------------ arglist ------------^
def arglist
expect :call, :attrasgn, :safe_call, :safe_attrasgn, :super, :zsuper
case self.node_type
when :call, :attrasgn, :safe_call, :safe_attrasgn
self[3..-1].unshift :arglist
when :super, :zsuper
if self[1]
self[1..-1].unshift :arglist
else
Sexp.new(:arglist)
end
end
end
#Returns arguments of a method call. This will be an 'untyped' Sexp.
#
# s(:call, s(:call, nil, :x, s(:arglist)), :y, s(:arglist, s(:lit, 1), s(:lit, 2)))
# ^--------args--------^
def args
expect :call, :attrasgn, :safe_call, :safe_attrasgn, :super, :zsuper
case self.node_type
when :call, :attrasgn, :safe_call, :safe_attrasgn
if self[3]
self[3..-1]
else
Sexp.new
end
when :super, :zsuper
if self[1]
self[1..-1]
else
Sexp.new
end
end
end
def each_arg replace = false
expect :call, :attrasgn, :safe_call, :safe_attrasgn, :super, :zsuper
range = nil
case self.node_type
when :call, :attrasgn, :safe_call, :safe_attrasgn
if self[3]
range = (3...self.length)
end
when :super, :zsuper
if self[1]
range = (1...self.length)
end
end
if range
range.each do |i|
res = yield self[i]
self[i] = res if replace
end
end
self
end
def each_arg! &block
@my_hash_value = nil
self.each_arg true, &block
end
#Returns first argument of a method call.
def first_arg
expect :call, :attrasgn, :safe_call, :safe_attrasgn
self[3]
end
#Sets first argument of a method call.
def first_arg= exp
expect :call, :attrasgn, :safe_call, :safe_attrasgn
@my_hash_value = nil
self[3] = exp
end
#Returns second argument of a method call.
def second_arg
expect :call, :attrasgn, :safe_call, :safe_attrasgn
self[4]
end
#Sets second argument of a method call.
def second_arg= exp
expect :call, :attrasgn, :safe_call, :safe_attrasgn
@my_hash_value = nil
self[4] = exp
end
def third_arg
expect :call, :attrasgn, :safe_call, :safe_attrasgn
self[5]
end
def third_arg= exp
expect :call, :attrasgn, :safe_call, :safe_attrasgn
@my_hash_value = nil
self[5] = exp
end
def last_arg
expect :call, :attrasgn, :safe_call, :safe_attrasgn
if self[3]
self[-1]
else
nil
end
end
#Returns condition of an if expression:
#
# s(:if,
# s(:lvar, :condition), <-- condition
# s(:lvar, :then_val),
# s(:lvar, :else_val)))
def condition
expect :if
self[1]
end
def condition= exp
expect :if
self[1] = exp
end
#Returns 'then' clause of an if expression:
#
# s(:if,
# s(:lvar, :condition),
# s(:lvar, :then_val), <-- then clause
# s(:lvar, :else_val)))
def then_clause
expect :if
self[2]
end
#Returns 'else' clause of an if expression:
#
# s(:if,
# s(:lvar, :condition),
# s(:lvar, :then_val),
# s(:lvar, :else_val)))
# ^---else caluse---^
def else_clause
expect :if
self[3]
end
#Method call associated with a block:
#
# s(:iter,
# s(:call, nil, :x, s(:arglist)), <- block_call
# s(:lasgn, :y),
# s(:block, s(:lvar, :y), s(:call, nil, :z, s(:arglist))))
def block_call
expect :iter
self[1]
end
#Returns block of a call with a block.
#Could be a single expression or a block:
#
# s(:iter,
# s(:call, nil, :x, s(:arglist)),
# s(:lasgn, :y),
# s(:block, s(:lvar, :y), s(:call, nil, :z, s(:arglist))))
# ^-------------------- block --------------------------^
def block delete = nil
unless delete.nil? #this is from RubyParser
return find_node :block, delete
end
expect :iter, :scope, :resbody
case self.node_type
when :iter
self[3]
when :scope
self[1]
when :resbody
#This is for Ruby2Ruby ONLY
find_node :block
end
end
#Returns parameters for a block
#
# s(:iter,
# s(:call, nil, :x, s(:arglist)),
# s(:lasgn, :y), <- block_args
# s(:call, nil, :p, s(:arglist, s(:lvar, :y))))
def block_args
expect :iter
if self[2] == 0 # ?! See https://github.com/presidentbeef/brakeman/issues/331
return Sexp.new(:args)
else
self[2]
end
end
def first_param
expect :args
self[1]
end
#Returns the left hand side of assignment or boolean:
#
# s(:lasgn, :x, s(:lit, 1))
# ^--lhs
def lhs
expect(*ASSIGNMENT_BOOL)
self[1]
end
#Sets the left hand side of assignment or boolean.
def lhs= exp
expect(*ASSIGNMENT_BOOL)
@my_hash_value = nil
self[1] = exp
end
#Returns right side (value) of assignment or boolean:
#
# s(:lasgn, :x, s(:lit, 1))
# ^--rhs---^
def rhs
expect :attrasgn, :safe_attrasgn, *ASSIGNMENT_BOOL
if self.node_type == :attrasgn or self.node_type == :safe_attrasgn
if self[2] == :[]=
self[4]
else
self[3]
end
else
self[2]
end
end
#Sets the right hand side of assignment or boolean.
def rhs= exp
expect :attrasgn, :safe_attrasgn, *ASSIGNMENT_BOOL
@my_hash_value = nil
if self.node_type == :attrasgn or self.node_type == :safe_attrasgn
self[3] = exp
else
self[2] = exp
end
end
#Returns name of method being defined in a method definition.
def method_name
expect :defn, :defs
case self.node_type
when :defn
self[1]
when :defs
self[2]
end
end
def formal_args
expect :defn, :defs
case self.node_type
when :defn
self[2]
when :defs
self[3]
end
end
#Sets body, which is now a complicated process because the body is no longer
#a separate Sexp, but just a list of Sexps.
def body= exp
expect :defn, :defs, :class, :module
@my_hash_value = nil
case self.node_type
when :defn, :class
index = 3
when :defs
index = 4
when :module
index = 2
end
self.slice!(index..-1) #Remove old body
#Insert new body
exp.each do |e|
self[index] = e
index += 1
end
end
#Returns body of a method definition, class, or module.
#This will be an untyped Sexp containing a list of Sexps from the body.
def body
expect :defn, :defs, :class, :module
case self.node_type
when :defn, :class
self[3..-1]
when :defs
self[4..-1]
when :module
self[2..-1]
end
end
#Like Sexp#body, except the returned Sexp is of type :rlist
#instead of untyped.
def body_list
self.body.unshift :rlist
end
def render_type
expect :render
self[1]
end
def class_name
expect :class, :module
self[1]
end
alias module_name class_name
def parent_name
expect :class
self[2]
end
#Returns the call Sexp in a result returned from FindCall
def call
expect :result
self.last
end
#Returns the module the call is inside
def module
expect :result
self[1]
end
#Return the class the call is inside
def result_class
expect :result
self[2]
end
require 'set'
def inspect seen = Set.new
if seen.include? self.object_id
's(...)'
else
seen << self.object_id
sexp_str = self.map do |x|
if x.is_a? Sexp
x.inspect seen
else
x.inspect
end
end.join(', ')
"s(#{sexp_str})"
end
end
end
#Invalidate hash cache if the Sexp changes
[:[]=, :clear, :collect!, :compact!, :concat, :delete, :delete_at,
:delete_if, :drop, :drop_while, :fill, :flatten!, :replace, :insert,
:keep_if, :map!, :pop, :push, :reject!, :replace, :reverse!, :rotate!,
:select!, :shift, :shuffle!, :slice!, :sort!, :sort_by!, :transpose,
:uniq!, :unshift].each do |method|
Sexp.class_eval <<-RUBY
def #{method} *args
@my_hash_value = nil
super
end
RUBY
end
#Methods used by RubyParser which would normally go through method_missing but
#we don't want that to happen because it hides Brakeman errors
[:resbody, :lasgn, :iasgn, :splat].each do |method|
Sexp.class_eval <<-RUBY
def #{method} delete = false
if delete
@my_hash_value = false
end
find_node :#{method}, delete
end
RUBY
end
class WrongSexpError < RuntimeError; end