Class: Parser::AST::Node

Inherits:
Object
  • Object
show all
Defined in:
lib/synvert/core/node_ext.rb

Overview

Parser::AST::Node monkey patch.

Instance Method Summary collapse

Instance Method Details

#arguments ⇒ Array<Parser::AST::Node>

Get arguments node of :send, :block or :defined? node.

Returns:

Raises:



101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/synvert/core/node_ext.rb', line 101

def arguments
  case type
  when :def, :block
    ArgumentsNode.new children[1]
  when :defs
    ArgumentsNode.new children[2]
  when :send
    children[2..-1]
  when :defined?
    children
  else
    raise Synvert::Core::MethodNotSupported, "arguments is not handled for #{debug_info}"
  end
end

#body ⇒ Array<Parser::AST::Node>

Get body node of :begin or :block node.

Returns:

Raises:



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/synvert/core/node_ext.rb', line 132

def body
  case type
  when :begin
    children
  when :def, :block
    return [] if children[2].nil?

    :begin == children[2].type ? children[2].body : children[2..-1]
  when :defs
    return [] if children[3].nil?

    :begin == children[3].type ? children[3].body : children[3..-1]
  else
    raise Synvert::Core::MethodNotSupported, "body is not handled for #{debug_info}"
  end
end

#caller ⇒ Parser::AST::Node

Get caller node of :block node.

Returns:

Raises:



120
121
122
123
124
125
126
 
# File 'lib/synvert/core/node_ext.rb', line 120

def caller
  if :block == type
    children[0]
  else
    raise Synvert::Core::MethodNotSupported, "caller is not handled for #{debug_info}"
  end
end

#child_node_range(child_name) ⇒ Parser::Source::Range

Get the source range of child node.

Parameters:

  • name (String) —

    of child node.

Returns:

  • (Parser::Source::Range) —

    source range of child node.



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/synvert/core/node_ext.rb', line 324

def child_node_range(child_name)
  case type
  when :class
    case child_name
    when :name
      loc.name
    when :parent_class
      parent_class&.loc&.expression
    end
  when :send
    case child_name
    when :receiver
      receiver&.loc&.expression
    when :dot
      loc.dot
    when :message
      loc.operator ? Parser::Source::Range.new('(string)', loc.selector.begin_pos, loc.operator.end_pos) : loc.selector
    when :arguments
      Parser::Source::Range.new('(string)', arguments.first.loc.expression.begin_pos, arguments.last.loc.expression.end_pos) unless arguments.empty?
    end
  else
    raise Synvert::Core::MethodNotSupported, "child_node_range is not handled for #{evaluated.inspect}, child_name: #{child_name}"
  end
end

#condition ⇒ Parser::AST::Node

Get condition node of :if node.

Returns:

Raises:



153
154
155
156
157
158
159
 
# File 'lib/synvert/core/node_ext.rb', line 153

def condition
  if :if == type
    children[0]
  else
    raise Synvert::Core::MethodNotSupported, "condition is not handled for #{debug_info}"
  end
end

#debug_info ⇒ Object 



289
290
291
292
293
294
295
296
297
 
# File 'lib/synvert/core/node_ext.rb', line 289

def debug_info
  "\n" +
    [
      "file: #{loc.expression.source_buffer.name}",
      "line: #{loc.expression.line}",
      "source: #{to_source}",
      "node: #{inspect}"
    ].join("\n")
end

#hash_value(key) ⇒ Parser::AST::Node

Get hash value node according to specified key.

Parameters:

  • key (Object) —

    value.

Returns:

Raises:



203
204
205
206
207
208
209
210
 
# File 'lib/synvert/core/node_ext.rb', line 203

def hash_value(key)
  if :hash == type
    value_node = children.find { |pair_node| pair_node.key.to_value == key }
    value_node ? value_node.value : nil
  else
    raise Synvert::Core::MethodNotSupported, "hash_value is not handled for #{debug_info}"
  end
end

#indent ⇒ Integer

Get the indent of current node.

Returns:

  • (Integer) —

    indent.



309
310
311
 
# File 'lib/synvert/core/node_ext.rb', line 309

def indent
  loc.expression.column
end

#key ⇒ Parser::AST::Node

Get key node of hash :pair node.

Returns:

Raises:



216
217
218
219
220
221
222
 
# File 'lib/synvert/core/node_ext.rb', line 216

def key
  if :pair == type
    children.first
  else
    raise Synvert::Core::MethodNotSupported, "key is not handled for #{debug_info}"
  end
end

#key?(key) ⇒ Boolean

Test if hash node contains specified key.

Parameters:

  • key (Object) —

    value.

Returns:

  • (Boolean) —

    true if specified key exists.

Raises:



190
191
192
193
194
195
196
 
# File 'lib/synvert/core/node_ext.rb', line 190

def key?(key)
  if :hash == type
    children.any? { |pair_node| pair_node.key.to_value == key }
  else
    raise Synvert::Core::MethodNotSupported, "key? is not handled for #{debug_info}"
  end
end

#keys ⇒ Array<Parser::AST::Node>

Get keys node of :hash node.

Returns:

Raises:



165
166
167
168
169
170
171
 
# File 'lib/synvert/core/node_ext.rb', line 165

def keys
  if :hash == type
    children.map { |child| child.children[0] }
  else
    raise Synvert::Core::MethodNotSupported, "keys is not handled for #{debug_info}"
  end
end

#left_value ⇒ Parser::AST::Node

Return the left value.

Returns:

Raises:



240
241
242
243
244
245
246
 
# File 'lib/synvert/core/node_ext.rb', line 240

def left_value
  if i[masgn lvasgn ivasgn].include? type
    children[0]
  else
    raise Synvert::Core::MethodNotSupported, "left_value is not handled for #{debug_info}"
  end
end

#line ⇒ Integer

Get the line of current node.

Returns:

  • (Integer) —

    line.



316
317
318
 
# File 'lib/synvert/core/node_ext.rb', line 316

def line
  loc.expression.line
end

#match?(rules) ⇒ Boolean

Match current node with rules.

Parameters:

  • rules (Hash) —

    rules to match.

Returns:

  • (Boolean) —

    true if matches.



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/synvert/core/node_ext.rb', line 366

def match?(rules)
  flat_hash(rules).keys.all? do |multi_keys|
    case multi_keys.last
    when :any
      actual_values = actual_value(self, multi_keys[0...-1])
      expected = expected_value(rules, multi_keys)
      actual_values.any? { |actual| match_value?(actual, expected) }
    when :not
      actual = actual_value(self, multi_keys[0...-1])
      expected = expected_value(rules, multi_keys)
      !match_value?(actual, expected)
    else
      actual = actual_value(self, multi_keys)
      expected = expected_value(rules, multi_keys)
      match_value?(actual, expected)
    end
  end
end

#message ⇒ Parser::AST::Node

Get message node of :super or :send node.

Returns:

Raises:



86
87
88
89
90
91
92
93
94
95
 
# File 'lib/synvert/core/node_ext.rb', line 86

def message
  case type
  when :super, :zsuper
    :super
  when :send
    children[1]
  else
    raise Synvert::Core::MethodNotSupported, "message is not handled for #{debug_info}"
  end
end

#name ⇒ Parser::AST::Node

Get name node of :class, :module, :const, :mlhs, :def and :defs node.

Returns:

Raises:



33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/synvert/core/node_ext.rb', line 33

def name
  case type
  when :class, :module, :def, :arg, :blockarg, :restarg
    children[0]
  when :defs, :const
    children[1]
  when :mlhs
    self
  else
    raise Synvert::Core::MethodNotSupported, "name is not handled for #{debug_info}"
  end
end

#parent_class ⇒ Parser::AST::Node

Get parent_class node of :class node.

Returns:

Raises:



50
51
52
53
54
55
56
 
# File 'lib/synvert/core/node_ext.rb', line 50

def parent_class
  if :class == type
    children[1]
  else
    raise Synvert::Core::MethodNotSupported, "parent_class is not handled for #{debug_info}"
  end
end

#parent_const ⇒ Parser::AST::Node

Get parent constant node of :const node.

Returns:

Raises:



62
63
64
65
66
67
68
 
# File 'lib/synvert/core/node_ext.rb', line 62

def parent_const
  if :const == type
    children[0]
  else
    raise Synvert::Core::MethodNotSupported, "parent_const is not handled for #{debug_info}"
  end
end

#receiver ⇒ Parser::AST::Node

Get receiver node of :send node.

Returns:

Raises:



74
75
76
77
78
79
80
 
# File 'lib/synvert/core/node_ext.rb', line 74

def receiver
  if :send == type
    children[0]
  else
    raise Synvert::Core::MethodNotSupported, "receiver is not handled for #{debug_info}"
  end
end

#recursive_children {|child| ... } ⇒ Object

Recursively iterate all child nodes of current node.

Yields:

  • (child) —

    Gives a child node.

Yield Parameters:



353
354
355
356
357
358
359
360
 
# File 'lib/synvert/core/node_ext.rb', line 353

def recursive_children(&block)
  children.each do |child|
    if child.is_a?(Parser::AST::Node)
      yield child
      child.recursive_children(&block)
    end
  end
end

#rewritten_source(code) ⇒ String

Get rewritten source code.

Examples:

node.rewritten_source("create({{arguments}})") #=> "create(:post)"

Parameters:

  • code (String) —

    raw code.

Returns:

  • (String) —

    rewritten code, replace string in block } in raw code.

Raises:



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
 
# File 'lib/synvert/core/node_ext.rb', line 392

def rewritten_source(code)
  code.gsub(/{{(.*?)}}/m) do
    old_code = Regexp.last_match(1)
    if respond_to? old_code.split(/\.|\[/).first
      evaluated = instance_eval old_code
      case evaluated
      when Parser::AST::Node
        evaluated.loc.expression.source
      when Array, ArgumentsNode
        if evaluated.size > 0
          file_source = evaluated.first.loc.expression.source_buffer.source
          source = file_source[evaluated.first.loc.expression.begin_pos...evaluated.last.loc.expression.end_pos]
          lines = source.split "\n"
          lines_count = lines.length
          if lines_count > 1 && lines_count == evaluated.size
            new_code = []
            lines.each_with_index { |line, index|
              new_code << (index == 0 ? line : line[evaluated.first.indent - 2..-1])
            }
            new_code.join("\n")
          else
            source
          end
        end
      when String, Symbol
        evaluated
      when NilClass
        'nil'
      else
        raise Synvert::Core::MethodNotSupported, "rewritten_source is not handled for #{evaluated.inspect}"
      end
    else
      "{{#{old_code}}}"
    end
  end
end

#right_value ⇒ Array<Parser::AST::Node>

Return the right value.

Returns:

Raises:



252
253
254
255
256
257
258
 
# File 'lib/synvert/core/node_ext.rb', line 252

def right_value
  if i[masgn lvasgn ivasgn].include? type
    children[1]
  else
    raise Synvert::Core::MethodNotSupported, "right_value is not handled for #{debug_info}"
  end
end

#to_s ⇒ Object 



283
284
285
286
287
 
# File 'lib/synvert/core/node_ext.rb', line 283

def to_s
  if :mlhs == type
    "(#{children.map(&:name).join(', ')})"
  end
end

#to_source ⇒ String

Get the source code of current node.

Returns:

  • (String) —

    source code.



302
303
304
 
# File 'lib/synvert/core/node_ext.rb', line 302

def to_source
  loc.expression&.source
end

#to_value ⇒ Object

Return the exact value.

Returns:

  • (Object) —

    exact value.

Raises:



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/synvert/core/node_ext.rb', line 264

def to_value
  case type
  when :int, :str, :sym
    children.last
  when :true
    true
  when :false
    false
  when :array
    children.map(&:to_value)
  when :irange
    (children.first.to_value..children.last.to_value)
  when :begin
    children.first.to_value
  else
    raise Synvert::Core::MethodNotSupported, "to_value is not handled for #{debug_info}"
  end
end

#value ⇒ Parser::AST::Node

Get value node of hash :pair node.

Returns:

Raises:



228
229
230
231
232
233
234
 
# File 'lib/synvert/core/node_ext.rb', line 228

def value
  if :pair == type
    children.last
  else
    raise Synvert::Core::MethodNotSupported, "value is not handled for #{debug_info}"
  end
end

#values ⇒ Array<Parser::AST::Node>

Get values node of :hash node.

Returns:

Raises:



177
178
179
180
181
182
183
 
# File 'lib/synvert/core/node_ext.rb', line 177

def values
  if :hash == type
    children.map { |child| child.children[1] }
  else
    raise Synvert::Core::MethodNotSupported, "keys is not handled for #{debug_info}"
  end
end