Class: Sexp

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby_parser/bm_sexp.rb

Overview

Sexp changes from ruby_parser and some changes for caching hash value and tracking 'original' line number of a Sexp.

Constant Summary

ASSIGNMENT_BOOL =
[:gasgn, :iasgn, :lasgn, :cvdecl, :cvasgn, :cdecl, :or, :and, :colon2, :op_asgn_or]

Instance Attribute Summary collapse

Instance Method Summary collapse

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(name, *args) ⇒ Object



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# File 'lib/ruby_parser/bm_sexp.rb', line 8

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

Instance Attribute Details

#or_depthObject

Returns the value of attribute or_depth



5
6
7
# File 'lib/ruby_parser/bm_sexp.rb', line 5

def or_depth
  @or_depth
end

#original_lineObject

Returns the value of attribute original_line



5
6
7
# File 'lib/ruby_parser/bm_sexp.rb', line 5

def original_line
  @original_line
end

Instance Method Details

#<<(arg) ⇒ Object



95
96
97
98
# File 'lib/ruby_parser/bm_sexp.rb', line 95

def << arg
  @my_hash_value = nil
  old_push arg
end

#arglistObject

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 ------------^


203
204
205
206
207
208
209
210
211
212
213
214
215
216
# File 'lib/ruby_parser/bm_sexp.rb', line 203

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

#arglist=(exp) ⇒ Object

Sets the arglist in a method call.



179
180
181
182
183
184
185
186
187
188
189
190
191
# File 'lib/ruby_parser/bm_sexp.rb', line 179

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

#argsObject

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--------^


222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
# File 'lib/ruby_parser/bm_sexp.rb', line 222

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

#block(delete = nil) ⇒ Object

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 --------------------------^


377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
# File 'lib/ruby_parser/bm_sexp.rb', line 377

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

#block_argsObject

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))))


401
402
403
404
405
406
407
408
# File 'lib/ruby_parser/bm_sexp.rb', line 401

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

#block_callObject

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))))


364
365
366
367
# File 'lib/ruby_parser/bm_sexp.rb', line 364

def block_call
  expect :iter
  self[1]
end

#bodyObject

Returns body of a method definition, class, or module. This will be an untyped Sexp containing a list of Sexps from the body.



510
511
512
513
514
515
516
517
518
519
520
521
# File 'lib/ruby_parser/bm_sexp.rb', line 510

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

#body=(exp) ⇒ Object

Sets body, which is now a complicated process because the body is no longer a separate Sexp, but just a list of Sexps.



486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
# File 'lib/ruby_parser/bm_sexp.rb', line 486

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

#body_listObject

Like Sexp#body, except the returned Sexp is of type :rlist instead of untyped.



525
526
527
# File 'lib/ruby_parser/bm_sexp.rb', line 525

def body_list
  self.body.unshift :rlist
end

#callObject

Returns the call Sexp in a result returned from FindCall



547
548
549
550
551
# File 'lib/ruby_parser/bm_sexp.rb', line 547

def call
  expect :result

  self.last
end

#class_nameObject Also known as: module_name



534
535
536
537
# File 'lib/ruby_parser/bm_sexp.rb', line 534

def class_name
  expect :class, :module
  self[1]
end

#combine(exp, line = nil) ⇒ Object

Join self and exp into an :or Sexp. Sets or_depth. Used for combining “branched” values in AliasProcessor.



79
80
81
82
83
84
85
# File 'lib/ruby_parser/bm_sexp.rb', line 79

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

#compactObject



108
109
110
111
# File 'lib/ruby_parser/bm_sexp.rb', line 108

def compact
  @my_hash_value = nil
  old_compact
end

#conditionObject

Returns condition of an if expression:

s(:if,
 s(:lvar, :condition), <-- condition
 s(:lvar, :then_val),
 s(:lvar, :else_val)))


324
325
326
327
# File 'lib/ruby_parser/bm_sexp.rb', line 324

def condition
  expect :if
  self[1]
end

#condition=(exp) ⇒ Object



329
330
331
332
# File 'lib/ruby_parser/bm_sexp.rb', line 329

def condition= exp
  expect :if
  self[1] = exp
end

#deep_clone(line = nil) ⇒ Object

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.



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# File 'lib/ruby_parser/bm_sexp.rb', line 26

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

#each_arg(replace = false) ⇒ Object



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
# File 'lib/ruby_parser/bm_sexp.rb', line 241

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

#each_arg!(&block) ⇒ Object



266
267
268
269
# File 'lib/ruby_parser/bm_sexp.rb', line 266

def each_arg! &block
  @my_hash_value = nil
  self.each_arg true, &block
end

#each_sexpObject

Iterates over the Sexps in an Sexp, skipping values that are not an Sexp.



125
126
127
128
129
# File 'lib/ruby_parser/bm_sexp.rb', line 125

def each_sexp
  self.each do |e|
    yield e if Sexp === e
  end
end

#else_clauseObject

Returns 'else' clause of an if expression:

s(:if,
 s(:lvar, :condition),
 s(:lvar, :then_val),
 s(:lvar, :else_val)))
 ^---else caluse---^


353
354
355
356
# File 'lib/ruby_parser/bm_sexp.rb', line 353

def else_clause
  expect :if
  self[3]
end

#expect(*types) ⇒ Object

Raise a WrongSexpError if the nodes type does not match one of the expected types.



133
134
135
136
137
# File 'lib/ruby_parser/bm_sexp.rb', line 133

def expect *types
  unless types.include? self.node_type
    raise WrongSexpError, "Expected #{types.join ' or '} but given #{self.inspect}", caller[1..-1]
  end
end

#find_and_replace_all(*args) ⇒ Object



113
114
115
116
# File 'lib/ruby_parser/bm_sexp.rb', line 113

def find_and_replace_all *args
  @my_hash_value = nil
  old_fara(*args)
end

#find_node(*args) ⇒ Object



118
119
120
121
# File 'lib/ruby_parser/bm_sexp.rb', line 118

def find_node *args
  @my_hash_value = nil
  old_find_node(*args)
end

#first_argObject

Returns first argument of a method call.



272
273
274
275
# File 'lib/ruby_parser/bm_sexp.rb', line 272

def first_arg
  expect :call, :attrasgn, :safe_call, :safe_attrasgn
  self[3]
end

#first_arg=(exp) ⇒ Object

Sets first argument of a method call.



278
279
280
281
282
# File 'lib/ruby_parser/bm_sexp.rb', line 278

def first_arg= exp
  expect :call, :attrasgn, :safe_call, :safe_attrasgn
  @my_hash_value = nil
  self[3] = exp
end

#first_paramObject



410
411
412
413
# File 'lib/ruby_parser/bm_sexp.rb', line 410

def first_param
  expect :args
  self[1]
end

#formal_argsObject



473
474
475
476
477
478
479
480
481
482
# File 'lib/ruby_parser/bm_sexp.rb', line 473

def formal_args
  expect :defn, :defs

  case self.node_type
  when :defn
    self[2]
  when :defs
    self[3]
  end
end

#hashObject



100
101
102
103
104
105
106
# File 'lib/ruby_parser/bm_sexp.rb', line 100

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

#inspect(seen = Set.new) ⇒ Object



568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
# File 'lib/ruby_parser/bm_sexp.rb', line 568

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

#last_argObject



308
309
310
311
312
313
314
315
316
# File 'lib/ruby_parser/bm_sexp.rb', line 308

def last_arg
  expect :call, :attrasgn, :safe_call, :safe_attrasgn

  if self[3]
    self[-1]
  else
    nil
  end
end

#lhsObject

Returns the left hand side of assignment or boolean:

s(:lasgn, :x, s(:lit, 1))
           ^--lhs


419
420
421
422
# File 'lib/ruby_parser/bm_sexp.rb', line 419

def lhs
  expect(*ASSIGNMENT_BOOL)
  self[1]
end

#lhs=(exp) ⇒ Object

Sets the left hand side of assignment or boolean.



425
426
427
428
429
# File 'lib/ruby_parser/bm_sexp.rb', line 425

def lhs= exp
  expect(*ASSIGNMENT_BOOL)
  @my_hash_value = nil
  self[1] = exp
end

#methodObject

Returns method of a method call:

s(:call, s(:call, nil, :x, s(:arglist)), :y, s(:arglist, s(:lit, 1)))

^- method


159
160
161
162
163
164
165
166
167
168
169
170
# File 'lib/ruby_parser/bm_sexp.rb', line 159

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

#method=(name) ⇒ Object



172
173
174
175
176
# File 'lib/ruby_parser/bm_sexp.rb', line 172

def method= name
  expect :call, :safe_call

  self[2] = name
end

#method_nameObject

Returns name of method being defined in a method definition.



462
463
464
465
466
467
468
469
470
471
# File 'lib/ruby_parser/bm_sexp.rb', line 462

def method_name
  expect :defn, :defs

  case self.node_type
  when :defn
    self[1]
  when :defs
    self[2]
  end
end

#moduleObject

Returns the module the call is inside



554
555
556
557
558
# File 'lib/ruby_parser/bm_sexp.rb', line 554

def module
  expect :result

  self[1]
end

#node_type=(type) ⇒ Object



71
72
73
74
# File 'lib/ruby_parser/bm_sexp.rb', line 71

def node_type= type
  @my_hash_value = nil
  self[0] = type
end

#old_compactObject



91
# File 'lib/ruby_parser/bm_sexp.rb', line 91

alias :old_compact :compact

#old_faraObject



92
# File 'lib/ruby_parser/bm_sexp.rb', line 92

alias :old_fara :find_and_replace_all

#old_find_nodeObject



93
# File 'lib/ruby_parser/bm_sexp.rb', line 93

alias :old_find_node :find_node

#old_pushObject



90
# File 'lib/ruby_parser/bm_sexp.rb', line 90

alias :old_push :<<

#parenObject



48
49
50
# File 'lib/ruby_parser/bm_sexp.rb', line 48

def paren
  @paren ||= false
end

#parent_nameObject



541
542
543
544
# File 'lib/ruby_parser/bm_sexp.rb', line 541

def parent_name
  expect :class
  self[2]
end

#render_typeObject



529
530
531
532
# File 'lib/ruby_parser/bm_sexp.rb', line 529

def render_type
  expect :render
  self[1]
end

#result_classObject

Return the class the call is inside



561
562
563
564
565
# File 'lib/ruby_parser/bm_sexp.rb', line 561

def result_class
  expect :result

  self[2]
end

#rhsObject

Returns right side (value) of assignment or boolean:

s(:lasgn, :x, s(:lit, 1))
              ^--rhs---^


435
436
437
438
439
440
441
442
443
444
445
446
447
# File 'lib/ruby_parser/bm_sexp.rb', line 435

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

#rhs=(exp) ⇒ Object

Sets the right hand side of assignment or boolean.



450
451
452
453
454
455
456
457
458
459
# File 'lib/ruby_parser/bm_sexp.rb', line 450

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

#secondObject



63
64
65
# File 'lib/ruby_parser/bm_sexp.rb', line 63

def second
  self[1]
end

#second_argObject

Returns second argument of a method call.



285
286
287
288
# File 'lib/ruby_parser/bm_sexp.rb', line 285

def second_arg
  expect :call, :attrasgn, :safe_call, :safe_attrasgn
  self[4]
end

#second_arg=(exp) ⇒ Object

Sets second argument of a method call.



291
292
293
294
295
# File 'lib/ruby_parser/bm_sexp.rb', line 291

def second_arg= exp
  expect :call, :attrasgn, :safe_call, :safe_attrasgn
  @my_hash_value = nil
  self[4] = exp
end

#set_args(*exp) ⇒ Object



193
194
195
# File 'lib/ruby_parser/bm_sexp.rb', line 193

def set_args *exp
  self.arglist = exp
end

#targetObject

Returns target of a method call:

s(:call, s(:call, nil, :x, s(:arglist)), :y, s(:arglist, s(:lit, 1)))

^-----------target-----------^


143
144
145
146
# File 'lib/ruby_parser/bm_sexp.rb', line 143

def target
  expect :call, :attrasgn, :safe_call, :safe_attrasgn
  self[1]
end

#target=(exp) ⇒ Object

Sets the target of a method call:



149
150
151
152
153
# File 'lib/ruby_parser/bm_sexp.rb', line 149

def target= exp
  expect :call, :attrasgn, :safe_call, :safe_attrasgn
  @my_hash_value = nil
  self[1] = exp
end

#then_clauseObject

Returns 'then' clause of an if expression:

s(:if,
 s(:lvar, :condition),
 s(:lvar, :then_val), <-- then clause
 s(:lvar, :else_val)))


341
342
343
344
# File 'lib/ruby_parser/bm_sexp.rb', line 341

def then_clause
  expect :if
  self[2]
end

#third_argObject



297
298
299
300
# File 'lib/ruby_parser/bm_sexp.rb', line 297

def third_arg
  expect :call, :attrasgn, :safe_call, :safe_attrasgn
  self[5]
end

#third_arg=(exp) ⇒ Object



302
303
304
305
306
# File 'lib/ruby_parser/bm_sexp.rb', line 302

def third_arg= exp
  expect :call, :attrasgn, :safe_call, :safe_attrasgn
  @my_hash_value = nil
  self[5] = exp
end

#to_symObject



67
68
69
# File 'lib/ruby_parser/bm_sexp.rb', line 67

def to_sym
  self.value.to_sym
end

#valueObject

Raises:



52
53
54
55
# File 'lib/ruby_parser/bm_sexp.rb', line 52

def value
  raise WrongSexpError, "Sexp#value called on multi-item Sexp", caller[1..-1] if size > 2
  self[1]
end

#value=(exp) ⇒ Object

Raises:



57
58
59
60
61
# File 'lib/ruby_parser/bm_sexp.rb', line 57

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