Module: Kettle::Dev::PrismUtils

Defined in:

sig/kettle/dev/prism_utils.rbs

Overview

Shared utilities for working with Prism AST nodes

Constant Summary

Prism =

Returns:

• (:Node node,)

Class Method Summary

• .block_call_to? ⇒ Boolean

  Check if a node is a block call to a specific method.

• .call_to? ⇒ Boolean

  Check if a node is a specific method call.

• .extract_const_name ⇒ String^?

  Extract qualified constant name from a constant node.

• .extract_literal_value ⇒ String, ...

  Extract literal value from string or symbol nodes.

• .extract_statements ⇒ Array[Prism::Node]

  Extract statements from a Prism body node.

• .find_leading_comments ⇒ Object

  Find leading comments for a statement node.

• .inline_comments_for_node ⇒ Object

  Find inline comments for a statement node.

• .node_to_source ⇒ String

  Convert a Prism AST node to Ruby source code.

• .normalize_argument ⇒ String

  Normalize an argument node to canonical format.

• .normalize_call_node ⇒ String

  Normalize a call node to use parentheses format.

• .parse_with_comments ⇒ Prism::ParseResult

  Parse Ruby source code and return Prism parse result with comments.

• .statement_key ⇒ Object

  Generate a unique key for a statement node to identify equivalent statements.

Class Method Details

.block_call_to? ⇒ Boolean

Check if a node is a block call to a specific method

Parameters:

• node (Prism::Node)
• method_name (Symbol)

Returns:

• (Boolean)

# File 'sig/kettle/dev/prism_utils.rbs', line 52

def self.block_call_to?: (Prism::Node node, Symbol method_name) -> bool

.call_to? ⇒ Boolean

Check if a node is a specific method call

Parameters:

• node (Prism::Node)
• method_name (Symbol)

Returns:

• (Boolean)

# File 'sig/kettle/dev/prism_utils.rbs', line 49

def self.call_to?: (Prism::Node node, Symbol method_name) -> bool

.extract_const_name ⇒ String^?

Extract qualified constant name from a constant node

Parameters:

• node (Prism::Node, nil)

Returns:

• (String, nil)

# File 'sig/kettle/dev/prism_utils.rbs', line 23

def self.extract_const_name: (Prism::Node? node) -> String?

.extract_literal_value ⇒ String, ...

Extract literal value from string or symbol nodes

Parameters:

• node (Prism::Node, nil)

Returns:

• (String, Symbol, nil)

# File 'sig/kettle/dev/prism_utils.rbs', line 20

def self.extract_literal_value: (Prism::Node? node) -> (String | Symbol)?

.extract_statements ⇒ Array[Prism::Node]

Extract statements from a Prism body node

Parameters:

• body_node (Prism::Node, nil)

Returns:

• (Array[Prism::Node])

# File 'sig/kettle/dev/prism_utils.rbs', line 11

def self.extract_statements: (Prism::Node? body_node) -> Array[Prism::Node]

.find_leading_comments ⇒ Object

Find leading comments for a statement node

# File 'sig/kettle/dev/prism_utils.rbs', line 26

def self.find_leading_comments: (

.inline_comments_for_node ⇒ Object

Find inline comments for a statement node

# File 'sig/kettle/dev/prism_utils.rbs', line 34

def self.inline_comments_for_node: (

.node_to_source ⇒ String

Convert a Prism AST node to Ruby source code

Parameters:

• node (Prism::Node, nil)

Returns:

• (String)

# File 'sig/kettle/dev/prism_utils.rbs', line 40

def self.node_to_source: (Prism::Node? node) -> String

.normalize_argument ⇒ String

Normalize an argument node to canonical format

Parameters:

• arg (Prism::Node)

Returns:

• (String)

# File 'sig/kettle/dev/prism_utils.rbs', line 46

def self.normalize_argument: (Prism::Node arg) -> String

.normalize_call_node ⇒ String

Normalize a call node to use parentheses format

Parameters:

• node (Prism::Node)

Returns:

• (String)

# File 'sig/kettle/dev/prism_utils.rbs', line 43

def self.normalize_call_node: (Prism::Node node) -> String

.parse_with_comments ⇒ Prism::ParseResult

Parse Ruby source code and return Prism parse result with comments

Parameters:

• source (String)

Returns:

• (Prism::ParseResult)

# File 'sig/kettle/dev/prism_utils.rbs', line 8

def self.parse_with_comments: (String source) -> Prism::ParseResult

.statement_key ⇒ Object

Generate a unique key for a statement node to identify equivalent statements

# File 'sig/kettle/dev/prism_utils.rbs', line 14

def self.statement_key: (