Class: TreeHaver::Backends::Prism::Node Private

Inherits:
TreeHaver::Base::Node show all
Defined in:
lib/tree_haver/backends/prism.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Prism node wrapper

Wraps Prism::Node objects to provide tree-sitter-compatible node API.

Prism nodes provide:

  • type: class name without “Node” suffix (e.g., ProgramNode → “program”)
  • location: ::Prism::Location with start/end offsets and line/column
  • child_nodes: array of child nodes
  • Various node-specific accessors

Instance Attribute Summary

Attributes inherited from TreeHaver::Base::Node

#inner_node, #lines, #source

Instance Method Summary collapse

Methods inherited from TreeHaver::Base::Node

#<=>, #==, #child, #child_count, #each, #end_line, #first_child, #inspect, #last_child, #named?, #next_sibling, #parent, #prev_sibling, #source_position, #start_line

Constructor Details

#initialize(node, source) ⇒ Node

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Node.



379
380
381
 
# File 'lib/tree_haver/backends/prism.rb', line 379

def initialize(node, source)
  super(node, source: source)
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method_name, *args, **kwargs, &block) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Delegate unknown methods to the underlying Prism node

This provides passthrough access for Prism-specific node methods
like receiver, message, arguments, etc.

Parameters:

  • method_name (Symbol) —

    method to call

  • args (Array) —

    arguments to pass

  • kwargs (Hash) —

    keyword arguments

  • block (Proc) —

    block to pass

Returns:

  • (Object) —

    result from the underlying node



537
538
539
540
541
542
543
 
# File 'lib/tree_haver/backends/prism.rb', line 537

def method_missing(method_name, *args, **kwargs, &block)
  if inner_node&.respond_to?(method_name)
    inner_node.public_send(method_name, *args, **kwargs, &block)
  else
    super
  end
end

Instance Method Details

#child_by_field_name(name) ⇒ Node? Also known as: field

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get a child by field name (Prism node accessor)

Prism nodes have specific accessors for their children.

Parameters:

  • name (String, Symbol) —

    field/accessor name

Returns:

  • (Node, nil) —

    wrapped child node



497
498
499
500
501
502
503
504
505
506
 
# File 'lib/tree_haver/backends/prism.rb', line 497

def child_by_field_name(name)
  return if inner_node.nil?
  return unless inner_node.respond_to?(name)

  result = inner_node.public_send(name)
  return if result.nil?

  # Wrap if it's a node
  result.is_a?(::Prism::Node) ? Node.new(result, source) : nil
end

#children ⇒ Array<Node>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get all child nodes

Returns:

  • (Array<Node>) —

    array of wrapped child nodes



446
447
448
449
450
451
 
# File 'lib/tree_haver/backends/prism.rb', line 446

def children
  return [] if inner_node.nil?
  return [] unless inner_node.respond_to?(:child_nodes)

  inner_node.child_nodes.compact.map { |n| Node.new(n, source) }
end

#end_byte ⇒ Integer

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get byte offset where the node ends

Returns:

  • (Integer) 


415
416
417
418
419
 
# File 'lib/tree_haver/backends/prism.rb', line 415

def end_byte
  return 0 if inner_node.nil? || !inner_node.respond_to?(:location)
  loc = inner_node.location
  loc&.end_offset || 0
end

#end_point ⇒ Hash{Symbol => Integer}

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get the end position as row/column (0-based)

Returns:

  • (Hash{Symbol => Integer}) 


435
436
437
438
439
440
441
 
# File 'lib/tree_haver/backends/prism.rb', line 435

def end_point
  return {row: 0, column: 0} if inner_node.nil? || !inner_node.respond_to?(:location)
  loc = inner_node.location
  return {row: 0, column: 0} unless loc

  {row: (loc.end_line - 1), column: loc.end_column}
end

#has_error? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Check if this node has errors

Returns:

  • (Boolean) 


472
473
474
475
476
477
478
479
480
481
 
# File 'lib/tree_haver/backends/prism.rb', line 472

def has_error?
  return false if inner_node.nil?

  # Check if this is an error node type
  return true if type.include?("missing") || type.include?("error")

  # Check children recursively (Prism error nodes are usually children)
  return false unless inner_node.respond_to?(:child_nodes)
  inner_node.child_nodes.compact.any? { |n| n.class.name.to_s.include?("Missing") }
end

#kind ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Alias for type (API compatibility)

Returns:

  • (String) —

    node type



399
400
401
 
# File 'lib/tree_haver/backends/prism.rb', line 399

def kind
  type
end

#missing? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Check if this node is a “missing” node (error recovery)

Returns:

  • (Boolean) 


486
487
488
489
 
# File 'lib/tree_haver/backends/prism.rb', line 486

def missing?
  return false if inner_node.nil?
  type.include?("missing")
end

#respond_to_missing?(method_name, include_private = false) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Check if node responds to a method (includes delegation to inner_node)

Parameters:

  • method_name (Symbol) —

    method to check

  • include_private (Boolean) (defaults to: false) —

    include private methods

Returns:

  • (Boolean) 


522
523
524
525
 
# File 'lib/tree_haver/backends/prism.rb', line 522

def respond_to_missing?(method_name, include_private = false)
  return false if inner_node.nil?
  inner_node.respond_to?(method_name, include_private) || super
end

#start_byte ⇒ Integer

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get byte offset where the node starts

Returns:

  • (Integer) 


406
407
408
409
410
 
# File 'lib/tree_haver/backends/prism.rb', line 406

def start_byte
  return 0 if inner_node.nil? || !inner_node.respond_to?(:location)
  loc = inner_node.location
  loc&.start_offset || 0
end

#start_point ⇒ Hash{Symbol => Integer}

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get the start position as row/column (0-based)

Returns:

  • (Hash{Symbol => Integer}) 


424
425
426
427
428
429
430
 
# File 'lib/tree_haver/backends/prism.rb', line 424

def start_point
  return {row: 0, column: 0} if inner_node.nil? || !inner_node.respond_to?(:location)
  loc = inner_node.location
  return {row: 0, column: 0} unless loc

  {row: (loc.start_line - 1), column: loc.start_column}
end

#text ⇒ String Also known as: slice

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get the text content of this node

Returns:

  • (String) 


456
457
458
459
460
461
462
463
464
 
# File 'lib/tree_haver/backends/prism.rb', line 456

def text
  return "" if inner_node.nil?

  if inner_node.respond_to?(:slice)
    inner_node.slice
  else
    super
  end
end

#to_s ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

String representation

Returns:

  • (String) 


513
514
515
 
# File 'lib/tree_haver/backends/prism.rb', line 513

def to_s
  text
end

#type ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get node type from Prism class name

Converts PrismClassName to tree-sitter-style type string.
Example: CallNode → “call_node”, ProgramNode → “program_node”

Returns:

  • (String) —

    node type in snake_case



389
390
391
392
393
394
395
 
# File 'lib/tree_haver/backends/prism.rb', line 389

def type
  return "nil" if inner_node.nil?

  # Convert class name to snake_case type
  class_name = inner_node.class.name.split("::").last
  class_name.gsub(/([A-Z])/, '_\1').downcase.sub(/^_/, "")
end