| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155 |
- //! Ruby extraction — a faithful Rust port of `TreeSitterExtractor`'s Ruby
- //! paths (src/extraction/tree-sitter.ts) plus languages/ruby.ts.
- //!
- //! Same porting contract as the other walkers: behavior parity, bug-for-bug.
- //! The authoritative quirk list is docs/design/ruby-kernel-port-checklist.md —
- //! including the load-bearing oddities this file preserves on purpose:
- //! `importTypes: ['call']` funnels EVERY non-body call into extractImport (so
- //! class-body DSL like `attr_accessor`, `has_many`, `define_method` and its
- //! whole block emit NOTHING), hook-handled modules MULTIPLY-CAPTURE fn-ref
- //! containers (each nesting level re-scans its subtree after popping), the
- //! sibling-scan visibility trio (bare `private` is invisible; `private :sym` /
- //! `private def x` poison every later sibling def; the def inside
- //! `private def` stays public), brace-block bodies (`block_body`) are
- //! invisible to bare-call extraction while `do…end` bodies emit, and the
- //! value-ref DFS visits statements in REVERSE source order. Positions in
- //! UTF-16 code units. Files with parse errors defer to wasm (~0% incidence).
- use crate::buffers::{
- build_meta, edge_kind_index, node_kind_index, Arena, BoolFlags, EdgeRow, EmitOut, NodeRow,
- RefRow, StrRef, Tables, FLAG_IS_EXPORTED, FUNCTION_REF_CODE, NONE, NONE_STR,
- REF_FLAG_FILE_PATH,
- };
- use crate::docstring::preceding_docstring;
- use crate::ids;
- use crate::textutil as util;
- use regex::Regex;
- use std::collections::{HashMap, HashSet};
- use std::sync::OnceLock;
- use tree_sitter::{Node, Parser};
- const MAX_VALUE_REF_NODES: usize = 20_000;
- /// NAME_STOPLIST (function-ref.ts).
- fn is_stoplisted(name: &str) -> bool {
- matches!(
- name,
- "this" | "self" | "super" | "null" | "nil" | "true" | "false" | "undefined" | "new"
- | "NULL" | "nullptr" | "None"
- )
- }
- /// isRubyHookCall (function-ref.ts:282-286).
- fn is_ruby_hook_call(name: &str) -> bool {
- static RE: OnceLock<Regex> = OnceLock::new();
- let re = RE.get_or_init(|| Regex::new(r"^(skip_)?(before|after|around)_[a-z_]+$").unwrap());
- re.is_match(name)
- || matches!(name, "validate" | "set_callback" | "helper_method" | "rescue_from")
- }
- /// The hook-DSL symbol shape (`/^[A-Za-z_][A-Za-z0-9_?!]*$/`).
- fn ruby_sym_re() -> &'static Regex {
- static RE: OnceLock<Regex> = OnceLock::new();
- RE.get_or_init(|| Regex::new(r"^[A-Za-z_][A-Za-z0-9_?!]*$").unwrap())
- }
- /// Node `path.posix.normalize` for the require_relative path join
- /// (emitRubyRequireRefs): resolve `.`/`..` lexically, collapse `//`, keep
- /// unresolvable leading `..`s, preserve a trailing slash.
- fn posix_normalize(p: &str) -> String {
- let is_abs = p.starts_with('/');
- let had_trailing = p.len() > 1 && p.ends_with('/');
- let mut out: Vec<&str> = Vec::new();
- for seg in p.split('/') {
- match seg {
- "" | "." => {}
- ".." => {
- if matches!(out.last(), Some(&last) if last != "..") {
- out.pop();
- } else if !is_abs {
- out.push("..");
- }
- }
- s => out.push(s),
- }
- }
- let mut joined = out.join("/");
- if is_abs {
- joined = format!("/{joined}");
- }
- if joined.is_empty() || joined == "/" {
- return if is_abs { "/".to_string() } else { ".".to_string() };
- }
- if had_trailing {
- joined.push('/');
- }
- joined
- }
- struct Scope {
- row: u32,
- kind: &'static str,
- name: String,
- }
- #[derive(Default)]
- struct Extra {
- docstring: Option<String>,
- signature: Option<String>,
- visibility: Option<u8>,
- }
- struct ValueScope<'t> {
- row: u32,
- node: Node<'t>,
- name: String,
- }
- struct Cand {
- from: u32,
- name: String,
- line: u32,
- column_byte: usize,
- row: usize,
- }
- pub struct Walker<'t> {
- src: &'t str,
- file_path: &'t str,
- line_starts: Vec<usize>,
- arena: Arena,
- tables: Tables,
- stack: Vec<Scope>,
- node_ids: Vec<String>,
- defined_fn_names: HashSet<String>,
- imported_names: HashSet<String>,
- fn_ref_cands: Vec<Cand>,
- fs_values: HashMap<String, u32>,
- fs_value_counts: HashMap<String, u32>,
- value_scopes: Vec<ValueScope<'t>>,
- }
- pub fn extract(file_path: &str, source: &str) -> Result<EmitOut, String> {
- let grammar = crate::langs::grammar_for("ruby").ok_or("no ruby grammar")?;
- let t0 = std::time::Instant::now();
- let mut parser = Parser::new();
- parser
- .set_language(&grammar)
- .map_err(|e| format!("set_language(ruby) failed: {e}"))?;
- let tree = parser
- .parse(source, None)
- .ok_or_else(|| "parser returned null tree".to_string())?;
- if tree.root_node().has_error() {
- return Err("defer: parse tree contains errors — wasm recovery is canonical".to_string());
- }
- let mut w = Walker {
- src: source,
- file_path,
- line_starts: util::line_starts(source),
- arena: Arena::default(),
- tables: Tables::default(),
- stack: Vec::new(),
- node_ids: Vec::new(),
- defined_fn_names: HashSet::new(),
- imported_names: HashSet::new(),
- fn_ref_cands: Vec::new(),
- fs_values: HashMap::new(),
- fs_value_counts: HashMap::new(),
- value_scopes: Vec::new(),
- };
- let line_count = source.bytes().filter(|b| *b == b'\n').count() as u32 + 1;
- let base_name = file_path.rsplit(['/', '\\']).next().unwrap_or(file_path);
- let mut flags = BoolFlags::default();
- flags.set(FLAG_IS_EXPORTED, false);
- let file_id = w.arena.put(&ids::file_node_id(file_path));
- let name_ref = w.arena.put(base_name);
- let qn_ref = w.arena.put(file_path);
- w.tables.push_node(&NodeRow {
- kind: node_kind_index("file").unwrap(),
- visibility: 0,
- flags,
- start_line: 1,
- end_line: line_count,
- start_column: 0,
- end_column: 0,
- name: name_ref,
- qualified_name: qn_ref,
- id: file_id,
- docstring: NONE_STR,
- signature: NONE_STR,
- decorators: NONE_STR,
- type_parameters: NONE_STR,
- return_type: NONE_STR,
- extra_json: NONE_STR,
- });
- w.node_ids.push(ids::file_node_id(file_path));
- w.stack.push(Scope { row: 0, kind: "file", name: base_name.to_string() });
- w.visit_node(tree.root_node());
- w.flush_fn_ref_candidates();
- w.flush_value_refs(tree.root_node());
- w.stack.pop();
- let duration_ms = t0.elapsed().as_secs_f64() * 1000.0;
- let meta = build_meta(&w.tables, w.arena.len(), NONE_STR, duration_ms);
- Ok(EmitOut {
- meta,
- nodes: w.tables.nodes,
- edges: w.tables.edges,
- refs: w.tables.refs,
- arena: w.arena.into_vec(),
- })
- }
- impl<'t> Walker<'t> {
- fn text(&self, node: Node) -> &'t str {
- &self.src[node.byte_range()]
- }
- fn line_of(&self, node: Node) -> u32 {
- node.start_position().row as u32 + 1
- }
- fn col_of(&self, node: Node) -> u32 {
- util::col16(self.src, &self.line_starts, node.start_position().row, node.start_byte())
- }
- fn end_col_of(&self, node: Node) -> u32 {
- util::col16(self.src, &self.line_starts, node.end_position().row, node.end_byte())
- }
- fn top_row(&self) -> u32 {
- self.stack.last().map(|s| s.row).unwrap_or(0)
- }
- fn inside_class_like(&self) -> bool {
- self.stack
- .last()
- .map(|s| matches!(s.kind, "class" | "struct" | "interface" | "trait" | "enum" | "module"))
- .unwrap_or(false)
- }
- fn push_ref(&mut self, from_row: u32, name: &str, kind_code: u8, line: u32, column: u32) {
- let name_ref = self.arena.put(name);
- self.tables.push_ref(&RefRow {
- from_idx: from_row,
- kind: kind_code,
- line,
- column,
- reference_name: name_ref,
- candidates: NONE_STR,
- from_id_str: NONE_STR,
- });
- if kind_code == edge_kind_index("imports").unwrap() {
- if util::simple_name().is_match(name) {
- self.imported_names.insert(name.to_string());
- } else if let Some(c) = util::qualified_import().captures(name) {
- self.imported_names.insert(c[1].to_string());
- }
- }
- }
- fn push_ref_at(&mut self, from_row: u32, name: &str, kind_code: u8, node: Node) {
- self.push_ref(from_row, name, kind_code, self.line_of(node), self.col_of(node));
- }
- // --- createNode ------------------------------------------------------------
- fn create_node(&mut self, kind: &'static str, name: &str, node: Node<'t>, extra: Extra) -> Option<u32> {
- if name.is_empty() {
- return None;
- }
- let start_line = self.line_of(node);
- let id = ids::node_id(self.file_path, kind, name, start_line);
- let end_line = node.end_position().row as u32 + 1; // no resolveBody for ruby
- let qualified = {
- let mut parts: Vec<&str> = Vec::new();
- for s in &self.stack {
- if s.kind != "file" {
- parts.push(&s.name);
- }
- }
- let mut qn = parts.join("::");
- if !qn.is_empty() {
- qn.push_str("::");
- }
- qn.push_str(name);
- qn
- };
- let name_ref = self.arena.put(name);
- let qn_ref = self.arena.put(&qualified);
- let id_ref = self.arena.put(&id);
- let doc_ref = opt_str(&mut self.arena, extra.docstring.as_deref());
- let sig_ref = opt_str(&mut self.arena, extra.signature.as_deref());
- let row = self.tables.push_node(&NodeRow {
- kind: node_kind_index(kind).unwrap(),
- visibility: extra.visibility.unwrap_or(0),
- flags: BoolFlags::default(), // no isExported/isAsync/isStatic hooks
- start_line,
- end_line,
- start_column: self.col_of(node),
- end_column: self.end_col_of(node),
- name: name_ref,
- qualified_name: qn_ref,
- id: id_ref,
- docstring: doc_ref,
- signature: sig_ref,
- decorators: NONE_STR, // ruby has no decorator node kinds — always a no-op
- type_parameters: NONE_STR,
- return_type: NONE_STR,
- extra_json: NONE_STR,
- });
- self.node_ids.push(id);
- let parent_row = self.top_row();
- self.tables.push_edge(&EdgeRow {
- source_idx: parent_row,
- target_idx: row,
- kind: edge_kind_index("contains").unwrap(),
- provenance: 0,
- line: NONE,
- column: NONE,
- metadata_json: NONE_STR,
- source_id_str: NONE_STR,
- target_id_str: NONE_STR,
- });
- if kind == "function" || kind == "method" {
- self.defined_fn_names.insert(name.to_string());
- }
- // captureValueRefScope
- let target_kind_ok = kind == "constant" || kind == "variable";
- if target_kind_ok
- && util::utf16_len(name) >= 3
- && util::has_upper_or_underscore().is_match(name)
- {
- let parent_ok = self
- .stack
- .last()
- .map(|s| matches!(s.kind, "file" | "class" | "module" | "struct" | "enum"))
- .unwrap_or(false);
- if parent_ok {
- self.fs_values.insert(name.to_string(), row);
- *self.fs_value_counts.entry(name.to_string()).or_insert(0) += 1;
- }
- }
- if matches!(kind, "function" | "method" | "constant" | "variable") {
- self.value_scopes.push(ValueScope { row, node, name: name.to_string() });
- }
- Some(row)
- }
- fn extract_name(&self, node: Node) -> String {
- if let Some(name_node) = node.child_by_field_name("name") {
- return self.text(name_node).to_string();
- }
- for i in 0..node.named_child_count() {
- if let Some(c) = node.named_child(i) {
- if matches!(c.kind(), "identifier" | "type_identifier" | "simple_identifier" | "constant") {
- return self.text(c).to_string();
- }
- }
- }
- "<anonymous>".to_string()
- }
- /// rubyExtractor.getVisibility — walk the previousNamedSibling chain
- /// (unbounded, through non-matching siblings); the first `call` sibling
- /// whose `method` text is private/protected/public decides; else public.
- /// Bug-for-bug: a BARE `private` line parses as identifier (invisible),
- /// and a matching call poisons every later sibling def regardless of
- /// ruby's actual arg-scoped semantics.
- fn visibility_of(&self, node: Node) -> u8 {
- let mut sibling = node.prev_named_sibling();
- while let Some(s) = sibling {
- if s.kind() == "call" {
- if let Some(method) = s.child_by_field_name("method") {
- match self.text(method) {
- "private" => return 2,
- "protected" => return 3,
- "public" => return 1,
- _ => {}
- }
- }
- }
- sibling = s.prev_named_sibling();
- }
- 1 // public
- }
- // --- the visitNode hook (languages/ruby.ts:19-76) ---------------------------
- /// Returns true when the hook handled the node (mixin call or module).
- /// The DISPATCHER then runs scan_fn_ref_subtree on the handled subtree —
- /// the source of the module multiply-capture quirk (scan runs with the
- /// module already POPPED, so candidates re-attribute to the outer scope).
- fn try_visit_hook(&mut self, node: Node<'t>) -> bool {
- stack_guard!();
- let kind = node.kind();
- if kind == "call" && node.child_by_field_name("receiver").is_none() {
- if let Some(method) = node.child_by_field_name("method") {
- if matches!(self.text(method), "include" | "extend" | "prepend") {
- let args = node.child_by_field_name("arguments").or_else(|| {
- (0..node.named_child_count())
- .filter_map(|i| node.named_child(i))
- .find(|c| c.kind() == "argument_list")
- });
- // (nodeStack is never empty — the file node is pushed.)
- if let Some(args) = args {
- let parent = self.top_row();
- let implements = edge_kind_index("implements").unwrap();
- let line = self.line_of(node);
- let col = self.col_of(node);
- for i in 0..args.named_child_count() {
- let Some(arg) = args.named_child(i) else { continue };
- // `Mod` is constant, `Foo::Bar` is scope_resolution;
- // `extend self` / dynamic args are skipped. Unlike
- // every other extraction ref, the hook sets
- // `filePath: ctx.filePath` — flagged on the wire.
- if matches!(arg.kind(), "constant" | "scope_resolution") {
- let name_ref = self.arena.put(self.text(arg));
- self.tables.push_ref_flagged(
- &RefRow {
- from_idx: parent,
- kind: implements,
- line,
- column: col,
- reference_name: name_ref,
- candidates: NONE_STR,
- from_id_str: NONE_STR,
- },
- REF_FLAG_FILE_PATH,
- );
- }
- }
- return true;
- }
- // no args node → hook declines (falls to extractImport → nothing)
- }
- }
- }
- if kind != "module" {
- return false;
- }
- let Some(name_node) = node.child_by_field_name("name") else { return false };
- // `module A::B` keeps the scope_resolution text verbatim as the name.
- let name = self.text(name_node).to_string();
- let Some(row) = self.create_node("module", &name, node, Extra::default()) else {
- return false;
- };
- self.stack.push(Scope { row, kind: "module", name });
- if let Some(body) = node.child_by_field_name("body") {
- for i in 0..body.named_child_count() {
- if let Some(c) = body.named_child(i) {
- self.visit_node(c);
- }
- }
- }
- self.stack.pop();
- true
- }
- // --- the dispatcher (visitNode, Ruby-relevant branches) ----------------------
- fn visit_node(&mut self, node: Node<'t>) {
- stack_guard!();
- // Language hook FIRST (tree-sitter.ts:943) — a handled subtree is
- // scanned for fn-ref candidates and never reaches the ladder (or the
- // maybeCaptureFnRefs call below).
- if self.try_visit_hook(node) {
- self.scan_fn_ref_subtree(node, 0);
- return;
- }
- let kind = node.kind();
- let mut skip_children = false;
- self.maybe_capture_fn_refs(node);
- if kind == "method" {
- // functionTypes ∩ methodTypes: inside class-like (module counts!)
- // ⇒ method, else function.
- if self.inside_class_like() {
- self.extract_method(node);
- } else {
- self.extract_function(node);
- }
- skip_children = true;
- } else if kind == "class" {
- self.extract_class(node);
- skip_children = true;
- } else if kind == "singleton_method" {
- // methodTypes-only: extractMethod's 1747 gate bounces a top-level
- // `def self.x` to extractFunction — a plain function named x (the
- // receiver object is ignored everywhere).
- if self.inside_class_like() {
- self.extract_method(node);
- } else {
- self.extract_function(node);
- }
- skip_children = true;
- } else if kind == "assignment"
- && (!self.inside_class_like() || self.is_class_scope_constant_assignment(node))
- {
- // File scope: identifier AND constant LHS extract; class/module
- // scope: ONLY constant LHS (isClassScopeConstantAssignment). The
- // RHS is never walked (no instantiates/calls from initializers).
- self.extract_variable(node);
- self.scan_fn_ref_subtree(node, 0);
- skip_children = true;
- } else if kind == "call" {
- // importTypes:['call'] — EVERY non-body call funnels here. Only
- // require/require_relative-with-string emit; everything else is
- // invisible (children still visited: no skipChildren).
- self.extract_import(node);
- }
- // `singleton_class` (`class << self`), `alias`, top-level `if`/`begin`,
- // `uninterpreted`, operator_assignment: no branch — recursed.
- if !skip_children {
- for i in 0..node.named_child_count() {
- if let Some(c) = node.named_child(i) {
- self.visit_node(c);
- }
- }
- }
- }
- /// isClassScopeConstantAssignment (tree-sitter.ts:1508).
- fn is_class_scope_constant_assignment(&self, node: Node) -> bool {
- let left = node.child_by_field_name("left").or_else(|| node.named_child(0));
- left.map(|l| l.kind() == "constant").unwrap_or(false)
- }
- // --- visitFunctionBody ------------------------------------------------------
- fn visit_function_body(&mut self, body: Node<'t>) {
- stack_guard!();
- self.visit_for_calls_and_structure(body);
- }
- fn visit_for_calls_and_structure(&mut self, node: Node<'t>) {
- stack_guard!();
- let kind = node.kind();
- self.maybe_capture_fn_refs(node);
- if kind == "call" {
- self.extract_call(node);
- } else if let Some(bare) = self.bare_call_name(node) {
- // extractBareCall: statement-level identifiers in BLOCK_PARENTS
- // bodies (`do…end` = body_statement; brace blocks are block_body —
- // NOT in the set, so `5.times { beep }` emits nothing for beep).
- let name = bare.to_string();
- let from = self.top_row();
- self.push_ref_at(from, &name, edge_kind_index("calls").unwrap(), node);
- }
- // (No INSTANTIATION_KINDS for ruby — `.new` is handled in extract_call;
- // extractStaticMemberRef is gated off; no type annotations.)
- // Nested NAMED defs become their own function nodes; classes extract.
- // A `module` inside a body mints NOTHING (the visitNode hook does not
- // run here) — its children just recurse. Same for singleton_method
- // (functionTypes-only check): unmatched, recursed.
- if kind == "method" {
- let name = self.extract_name(node);
- if name != "<anonymous>" {
- self.extract_function(node);
- return;
- }
- }
- if kind == "class" {
- self.extract_class(node);
- return;
- }
- for i in 0..node.named_child_count() {
- if let Some(c) = node.named_child(i) {
- self.visit_for_calls_and_structure(c);
- }
- }
- }
- /// rubyExtractor.extractBareCall (languages/ruby.ts:77-105).
- fn bare_call_name(&self, node: Node) -> Option<&'t str> {
- if node.kind() != "identifier" {
- return None;
- }
- let parent = node.parent()?;
- if !matches!(
- parent.kind(),
- "body_statement" | "then" | "else" | "do" | "begin" | "rescue" | "ensure" | "when"
- ) {
- return None;
- }
- let name = self.text(node);
- if matches!(
- name,
- "true" | "false" | "nil" | "self" | "super" | "__FILE__" | "__LINE__" | "__dir__"
- ) {
- return None;
- }
- // charCodeAt(0) in [65,90] — ASCII uppercase only (constants).
- let first = name.as_bytes().first().copied().unwrap_or(0);
- if (65..=90).contains(&first) {
- return None;
- }
- Some(name)
- }
- // --- extractors --------------------------------------------------------------
- fn extract_function(&mut self, node: Node<'t>) {
- stack_guard!();
- let name = self.extract_name(node);
- if name == "<anonymous>" {
- if let Some(body) = node.child_by_field_name("body") {
- self.visit_function_body(body);
- }
- return;
- }
- let extra = Extra {
- docstring: preceding_docstring(node, self.src),
- signature: None, // no getSignature hook
- visibility: Some(self.visibility_of(node)),
- };
- let Some(row) = self.create_node("function", &name, node, extra) else { return };
- // (ruby ∉ TYPE_ANNOTATION_LANGUAGES; decorators are a structural no-op)
- self.stack.push(Scope { row, kind: "function", name });
- if let Some(body) = node.child_by_field_name("body") {
- self.visit_function_body(body);
- }
- self.stack.pop();
- // `parameters` are NEVER walked — a call in a default value emits nothing.
- }
- fn extract_method(&mut self, node: Node<'t>) {
- stack_guard!();
- let name = self.extract_name(node);
- let extra = Extra {
- docstring: preceding_docstring(node, self.src),
- signature: None,
- visibility: Some(self.visibility_of(node)),
- };
- let Some(row) = self.create_node("method", &name, node, extra) else { return };
- self.stack.push(Scope { row, kind: "method", name });
- if let Some(body) = node.child_by_field_name("body") {
- self.visit_function_body(body);
- }
- self.stack.pop();
- }
- fn extract_class(&mut self, node: Node<'t>) {
- stack_guard!();
- let name = self.extract_name(node);
- let extra = Extra {
- docstring: preceding_docstring(node, self.src),
- signature: None,
- visibility: Some(self.visibility_of(node)),
- };
- let Some(row) = self.create_node("class", &name, node, extra) else { return };
- // extractInheritance: the `superclass` clause — ONE extends ref, FULL
- // text (scope_resolution / even `Struct.new(:a)` expressions verbatim),
- // positioned at the type child.
- let extends_kind = edge_kind_index("extends").unwrap();
- for i in 0..node.named_child_count() {
- let Some(child) = node.named_child(i) else { continue };
- if child.kind() == "superclass" {
- if let Some(target) = child.named_child(0) {
- let tname = self.text(target).to_string();
- self.push_ref_at(row, &tname, extends_kind, target);
- }
- }
- }
- self.stack.push(Scope { row, kind: "class", name });
- // Bodiless `class X; end` has no body field → the class node itself
- // is walked (name/superclass children revisit harmlessly).
- let body = node.child_by_field_name("body").unwrap_or(node);
- for i in 0..body.named_child_count() {
- if let Some(c) = body.named_child(i) {
- self.visit_node(c);
- }
- }
- self.stack.pop();
- }
- /// extractVariable — the python/ruby assignment branch (2709-2727):
- /// identifier or constant LHS mints a `variable` node (no isConst hook —
- /// `MAX = 3` is kind variable) at the ASSIGNMENT node's position, with the
- /// `= <first 100 utf16 units>` initializer signature.
- fn extract_variable(&mut self, node: Node<'t>) {
- let docstring = preceding_docstring(node, self.src);
- let left = node.child_by_field_name("left").or_else(|| node.named_child(0));
- let right = node.child_by_field_name("right").or_else(|| node.named_child(1));
- let Some(left) = left else { return };
- if !matches!(left.kind(), "identifier" | "constant") {
- return;
- }
- let name = self.text(left).to_string();
- let signature = right.map(|r| util::init_signature(self.text(r)));
- self.create_node("variable", &name, node, Extra { docstring, signature, visibility: None });
- }
- /// extractImport — every non-body `call` lands here (importTypes:['call']).
- /// Hook (languages/ruby.ts:123): FIRST identifier named child must read
- /// require/require_relative (a lowercase receiver is found first and
- /// declines; a constant receiver — `Kernel.require "x"` — reaches the
- /// method identifier and IS a require); argument_list → string →
- /// string_content → moduleName. Then the generic imports ref and
- /// emitRubyRequireRefs' path ref.
- fn extract_import(&mut self, node: Node<'t>) {
- let ident = (0..node.named_child_count())
- .filter_map(|i| node.named_child(i))
- .find(|c| c.kind() == "identifier");
- let Some(ident) = ident else { return };
- let mname = self.text(ident);
- if mname != "require" && mname != "require_relative" {
- return;
- }
- let arg_list = (0..node.named_child_count())
- .filter_map(|i| node.named_child(i))
- .find(|c| c.kind() == "argument_list");
- let Some(arg_list) = arg_list else { return };
- let string = (0..arg_list.named_child_count())
- .filter_map(|i| arg_list.named_child(i))
- .find(|c| c.kind() == "string");
- let Some(string) = string else { return };
- let content = (0..string.named_child_count())
- .filter_map(|i| string.named_child(i))
- .find(|c| c.kind() == "string_content");
- let Some(content) = content else { return };
- // Interpolated paths take the FIRST string_content only — moduleName
- // `interp/` (+ a garbage `interp/.rb` path ref) — deterministic quirk.
- let module_name = self.text(content).to_string();
- let import_text = self.text(node).trim().to_string();
- if module_name.is_empty() {
- return;
- }
- self.create_node(
- "import",
- &module_name,
- node,
- Extra { signature: Some(import_text), ..Extra::default() },
- );
- let parent = self.top_row();
- let imports_kind = edge_kind_index("imports").unwrap();
- self.push_ref_at(parent, &module_name.clone(), imports_kind, node);
- // emitRubyRequireRefs (3532): the file-path ref. Bare gem/stdlib
- // requires (no `/`) emit nothing; paths get `.rb` appended.
- let req = self.text(content).trim();
- if req.is_empty() {
- return;
- }
- let ref_path = if mname == "require_relative" {
- let dir = match self.file_path.rfind('/') {
- Some(i) => &self.file_path[..i],
- None => "",
- };
- let joined = if dir.is_empty() { req.to_string() } else { format!("{dir}/{req}") };
- posix_normalize(&joined)
- } else {
- req.to_string()
- };
- if !ref_path.contains('/') {
- return;
- }
- let ref_path =
- if ref_path.ends_with(".rb") { ref_path } else { format!("{ref_path}.rb") };
- self.push_ref_at(parent, &ref_path, imports_kind, node);
- }
- /// extractCall — the bespoke ruby branch (tree-sitter.ts:3905-3960),
- /// reached only from the body walker.
- fn extract_call(&mut self, node: Node<'t>) {
- if self.stack.is_empty() {
- return;
- }
- let caller = self.top_row();
- let method_name = match node.child_by_field_name("method") {
- Some(m) => self.text(m),
- None => "",
- };
- if method_name.is_empty() {
- return; // operator/element-reference call with no method name
- }
- let line = self.line_of(node);
- let col = self.col_of(node);
- let calls_kind = edge_kind_index("calls").unwrap();
- let Some(receiver) = node.child_by_field_name("receiver") else {
- // Bare `foo(...)` — just the method name.
- self.push_ref(caller, &method_name.to_string(), calls_kind, line, col);
- return;
- };
- let receiver_name = self.text(receiver);
- // `Foo.new` / `NS::Widget.new` → instantiates ref to the LAST `::`
- // segment; a non-capitalized receiver falls through to a calls ref
- // (`lower.new`).
- if method_name == "new" {
- let class_name = match receiver_name.rfind("::") {
- Some(i) => &receiver_name[i + 2..],
- None => receiver_name,
- };
- if class_name.as_bytes().first().map(|b| b.is_ascii_uppercase()).unwrap_or(false) {
- self.push_ref(
- caller,
- &class_name.to_string(),
- edge_kind_index("instantiates").unwrap(),
- line,
- col,
- );
- return;
- }
- }
- // SKIP_RECEIVERS by TEXT — ruby's set is {self, super} only. `&.`
- // joins with a plain `.`; chains/literals keep raw receiver text.
- let skip = matches!(receiver_name, "self" | "super");
- let callee = if skip {
- method_name.to_string()
- } else {
- format!("{receiver_name}.{method_name}")
- };
- self.push_ref(caller, &callee, calls_kind, line, col);
- // Capitalized constant receiver (`Klass.static_call`, `RETRY_MAX.times`)
- // → an ADDITIONAL references ref at the RECEIVER's position.
- // (scope_resolution receivers get none — type ≠ constant.)
- if !skip && receiver.kind() == "constant" {
- self.push_ref_at(
- caller,
- &receiver_name.to_string(),
- edge_kind_index("references").unwrap(),
- receiver,
- );
- }
- }
- // --- function-as-value refs (RUBY_SPEC, function-ref.ts:262) -----------------
- fn maybe_capture_fn_refs(&mut self, node: Node<'t>) {
- enum Mode {
- Args,
- PairValue,
- }
- let mode = match node.kind() {
- "argument_list" => Mode::Args,
- "pair" => Mode::PairValue,
- _ => return,
- };
- if self.stack.is_empty() {
- return;
- }
- let from = self.top_row();
- let mut values: Vec<Node> = Vec::new();
- match mode {
- Mode::Args => {
- for i in 0..node.named_child_count() {
- if let Some(c) = node.named_child(i) {
- values.push(c);
- }
- }
- }
- Mode::PairValue => {
- let value = node.child_by_field_name("value").or_else(|| {
- if node.named_child_count() > 0 {
- node.named_child(node.named_child_count() - 1)
- } else {
- None
- }
- });
- if let Some(v) = value {
- values.push(v);
- }
- }
- }
- for v in values {
- self.normalize_fn_ref_value(v, from, 0);
- }
- }
- /// normalizeValue for RUBY_SPEC: idTypes EMPTY (bare identifiers never
- /// qualify); `block_argument` is a transparent layer; specials are the
- /// `method(:sym)` call form and hook-DSL `simple_symbol`s.
- fn normalize_fn_ref_value(&mut self, v: Node<'t>, from: u32, depth: u32) {
- stack_guard!();
- if depth > 4 {
- return;
- }
- match v.kind() {
- "block_argument" => {
- for i in 0..v.named_child_count() {
- if let Some(c) = v.named_child(i) {
- self.normalize_fn_ref_value(c, from, depth + 1);
- }
- }
- }
- "call" => {
- // `method(:target_cb)` — method field literally `method`, one
- // simple_symbol argument. Candidate = bare symbol name at the
- // SYMBOL node (gated at flush on defined-in-file ∪ imports).
- let Some(method) = v.child_by_field_name("method") else { return };
- if self.text(method) != "method" {
- return;
- }
- let Some(args) = v.child_by_field_name("arguments") else { return };
- if args.named_child_count() != 1 {
- return;
- }
- let Some(sym) = args.named_child(0) else { return };
- if sym.kind() != "simple_symbol" {
- return;
- }
- let name = self.text(sym).strip_prefix(':').unwrap_or(self.text(sym));
- if !name.is_empty() {
- self.push_fn_ref_cand(from, name, sym);
- }
- }
- "simple_symbol" => {
- // Hook-DSL symbols (`before_action :authenticate`) → class-
- // scoped `this.<sym>` candidates (always flushed).
- let Some(call) = ruby_enclosing_call(v) else { return };
- let Some(method) = call.child_by_field_name("method") else { return };
- if !is_ruby_hook_call(self.text(method)) {
- return;
- }
- let sym = self.text(v).strip_prefix(':').unwrap_or(self.text(v));
- if !ruby_sym_re().is_match(sym) {
- return;
- }
- let name = format!("this.{sym}");
- self.push_fn_ref_cand(from, &name, v);
- }
- _ => {}
- }
- }
- fn push_fn_ref_cand(&mut self, from: u32, name: &str, node: Node) {
- if name.is_empty() || is_stoplisted(name) {
- return;
- }
- let p = node.start_position();
- self.fn_ref_cands.push(Cand {
- from,
- name: name.to_string(),
- line: p.row as u32 + 1,
- column_byte: node.start_byte(),
- row: p.row,
- });
- }
- fn scan_fn_ref_subtree(&mut self, node: Node<'t>, depth: u32) {
- stack_guard!();
- if depth > 12 {
- return;
- }
- // Halts at functionTypes (`method`) + the fixed arrow/lambda list;
- // NOT at class/module nodes — the module multiply-capture rides this.
- if depth > 0
- && matches!(
- node.kind(),
- "method" | "arrow_function" | "function_expression" | "lambda_literal"
- | "lambda_expression"
- )
- {
- return;
- }
- self.maybe_capture_fn_refs(node);
- for i in 0..node.named_child_count() {
- if let Some(c) = node.named_child(i) {
- self.scan_fn_ref_subtree(c, depth + 1);
- }
- }
- }
- fn flush_fn_ref_candidates(&mut self) {
- let cands = std::mem::take(&mut self.fn_ref_cands);
- if cands.is_empty() || util::is_generated_file(self.file_path) {
- return;
- }
- let mut seen: HashSet<(String, String)> = HashSet::new();
- for c in cands {
- // `this.`-prefixed candidates always flush (class-scoped resolver);
- // bare `method(:x)` names gate on defined-in-file ∪ imports (ruby's
- // path-shaped imports match neither name regex, so effectively
- // defined-in-file).
- if !c.name.starts_with("this.")
- && !c.name.contains("::")
- && !self.defined_fn_names.contains(&c.name)
- && !self.imported_names.contains(&c.name)
- {
- continue;
- }
- if !seen.insert((self.node_ids[c.from as usize].clone(), c.name.clone())) {
- continue;
- }
- let column = util::col16(self.src, &self.line_starts, c.row, c.column_byte);
- let name_ref = self.arena.put(&c.name);
- self.tables.push_ref(&RefRow {
- from_idx: c.from,
- kind: FUNCTION_REF_CODE,
- line: c.line,
- column,
- reference_name: name_ref,
- candidates: NONE_STR,
- from_id_str: NONE_STR,
- });
- }
- }
- // --- value references (crib of python.rs — same traversal, same cases) ------
- fn flush_value_refs(&mut self, root: Node<'t>) {
- let scopes = std::mem::take(&mut self.value_scopes);
- let mut targets = std::mem::take(&mut self.fs_values);
- let counts = std::mem::take(&mut self.fs_value_counts);
- if std::env::var("CODEGRAPH_VALUE_REFS").as_deref() == Ok("0") {
- return;
- }
- if targets.is_empty() || scopes.is_empty() || util::is_generated_file(self.file_path) {
- return;
- }
- // Shadow prune — ruby's declarator shape is `assignment`. A
- // constant-typed LHS has no named children → constants are never
- // counted (never pruned); identifier LHSes (and each identifier of a
- // multiple-assign left) bump.
- let mut decl_counts: HashMap<&str, u32> = HashMap::new();
- let mut dstack: Vec<Node> = vec![root];
- let mut dvisited = 0usize;
- while let Some(n) = dstack.pop() {
- if dvisited >= MAX_VALUE_REF_NODES {
- break;
- }
- dvisited += 1;
- if n.kind() == "assignment" {
- let left = n
- .child_by_field_name("left")
- .or_else(|| n.child_by_field_name("pattern"))
- .or_else(|| n.named_child(0));
- if let Some(left) = left {
- if left.kind() == "identifier" {
- let nm = self.text(left);
- if targets.contains_key(nm) {
- *decl_counts.entry(nm).or_insert(0) += 1;
- }
- } else {
- for i in 0..left.named_child_count() {
- if let Some(c) = left.named_child(i) {
- if c.kind() == "identifier" {
- let nm = self.text(c);
- if targets.contains_key(nm) {
- *decl_counts.entry(nm).or_insert(0) += 1;
- }
- }
- }
- }
- }
- }
- }
- for i in 0..n.named_child_count() {
- if let Some(c) = n.named_child(i) {
- dstack.push(c);
- }
- }
- }
- let shadowed: Vec<String> = decl_counts
- .iter()
- .filter(|(nm, c)| **c > counts.get(**nm).copied().unwrap_or(1))
- .map(|(nm, _)| nm.to_string())
- .collect();
- for nm in shadowed {
- targets.remove(&nm);
- }
- if targets.is_empty() {
- return;
- }
- let refs_kind = edge_kind_index("references").unwrap();
- for scope in &scopes {
- let mut seen: HashSet<&str> = HashSet::new();
- let mut stack: Vec<Node> = vec![scope.node];
- let mut visited = 0usize;
- while let Some(n) = stack.pop() {
- if visited >= MAX_VALUE_REF_NODES {
- break;
- }
- visited += 1;
- // `constant` is the ruby-live reader kind (a constant read IS
- // a constant node); reverse-source-order traversal preserved.
- if matches!(n.kind(), "identifier" | "constant" | "name" | "simple_identifier") {
- let ref_name = self.text(n);
- if let Some(&target_row) = targets.get(ref_name) {
- let target_id = self.node_ids[target_row as usize].as_str();
- if target_id != self.node_ids[scope.row as usize]
- && ref_name != scope.name
- && !seen.contains(&target_id)
- {
- seen.insert(target_id);
- let meta = self.arena.put(r#"{"valueRef":true}"#);
- self.tables.push_edge(&EdgeRow {
- source_idx: scope.row,
- target_idx: target_row,
- kind: refs_kind,
- provenance: 0,
- line: NONE,
- column: NONE,
- metadata_json: meta,
- source_id_str: NONE_STR,
- target_id_str: NONE_STR,
- });
- }
- }
- }
- for i in 0..n.named_child_count() {
- if let Some(c) = n.named_child(i) {
- stack.push(c);
- }
- }
- }
- }
- }
- }
- /// The Ruby `call` node whose argument_list (or keyword pair) contains `node`
- /// — nearest `call` ancestor within 4 parent hops (function-ref.ts:837).
- fn ruby_enclosing_call(node: Node) -> Option<Node> {
- let mut cur = node.parent();
- for _ in 0..4 {
- let c = cur?;
- if c.kind() == "call" {
- return Some(c);
- }
- cur = c.parent();
- }
- None
- }
- fn opt_str(arena: &mut Arena, s: Option<&str>) -> StrRef {
- match s {
- Some(s) => arena.put(s),
- None => NONE_STR,
- }
- }
- #[cfg(test)]
- mod tests {
- use super::posix_normalize;
- #[test]
- fn normalize_matches_node_posix() {
- assert_eq!(posix_normalize("lib/foo/../bar/baz"), "lib/bar/baz");
- assert_eq!(posix_normalize("../x/./y"), "../x/y");
- assert_eq!(posix_normalize("a/../.."), "..");
- assert_eq!(posix_normalize("./foo/bar"), "foo/bar");
- assert_eq!(posix_normalize("a//b"), "a/b");
- assert_eq!(posix_normalize("a/b/"), "a/b/");
- }
- }
|