nornir 0.4.19

Companion to cargo: dependency tracking, release gating, deploy, benchmarks, and documentation assembly. Project-agnostic.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
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
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
//! Pure-Rust symbol + call + feature-gate extractor.
//!
//! For every `Cargo.toml` under the repo we walk every `.rs` under
//! src/ tests/ benches/ examples/, parse with `syn`, and emit:
//!
//!  - `SymbolRow`      — one per item (fn / struct / enum / trait / impl-fn / mod / type / const / static).
//!  - `CallEdgeRow`    — one per call expression inside an fn body.
//!  - `FeatureGateRow` — one per `#[cfg(...)]` attribute on a discovered item.
//!
//! Limitations vs rustdoc-json:
//!   - No type resolution — `callee_ident` is the raw name.
//!   - No re-exports / generic impl expansion.
//!   - `line` is the 1-based source line of the item name / call site
//!     (via proc-macro2 `span-locations`).

use std::path::Path;

use anyhow::{Context, Result};
use chrono::{DateTime, Utc};
use syn::visit::Visit;
use syn::{Attribute, Expr, ImplItem, Item, ItemImpl, Meta, Visibility};
use syn::spanned::Spanned;
use uuid::Uuid;
use walkdir::WalkDir;

#[derive(Debug, Default)]
pub struct SymbolScan {
    pub snapshot_id: Uuid,
    pub ts: DateTime<Utc>,
    pub repo: String,
    pub symbols: Vec<SymbolRow>,
    pub calls: Vec<CallEdgeRow>,
    pub features: Vec<FeatureGateRow>,
}

#[derive(Debug, Clone, serde::Serialize)]
pub struct SymbolRow {
    pub crate_name: String,
    pub module_path: String,
    pub item_kind: String,
    pub item_name: String,
    pub visibility: String,
    pub file: String,
    pub line: u32,
    pub doc_lines: u32,
    pub signature: Option<String>,
}

#[derive(Debug, Clone, serde::Serialize)]
pub struct CallEdgeRow {
    pub crate_name: String,
    pub caller_path: String,
    pub callee_ident: String,
    pub call_kind: String,
    pub file: String,
    pub line: u32,
}

#[derive(Debug, Clone)]
pub struct FeatureGateRow {
    pub crate_name: String,
    pub module_path: String,
    pub item_name: String,
    pub cfg_expr: String,
    pub file: String,
    pub line: u32,
}

pub fn scan_repo(
    repo_root: &Path,
    repo_name: &str,
    snapshot_id: Uuid,
    ts: DateTime<Utc>,
) -> Result<SymbolScan> {
    let mut out = SymbolScan {
        snapshot_id,
        ts,
        repo: repo_name.to_string(),
        ..Default::default()
    };
    for entry in WalkDir::new(repo_root)
        .into_iter()
        .filter_entry(|e| !is_skipped_dir(&e.file_name().to_string_lossy()))
    {
        let entry = entry.context("walkdir")?;
        if entry.file_name() == "Cargo.toml" {
            scan_one_crate(repo_root, entry.path(), &mut out);
        }
    }
    Ok(out)
}

fn is_skipped_dir(name: &str) -> bool {
    matches!(name, "target" | ".git" | "node_modules" | ".nornir")
}

fn scan_one_crate(repo_root: &Path, cargo_toml: &Path, out: &mut SymbolScan) {
    let Ok(text) = std::fs::read_to_string(cargo_toml) else { return };
    let Ok(doc) = text.parse::<toml::Value>() else { return };
    let Some(crate_name) = doc
        .get("package")
        .and_then(|p| p.get("name"))
        .and_then(|n| n.as_str())
    else { return };
    let Some(crate_dir) = cargo_toml.parent() else { return };

    for sub in &["src", "tests", "benches", "examples"] {
        let dir = crate_dir.join(sub);
        if !dir.is_dir() { continue; }
        for entry in WalkDir::new(&dir)
            .into_iter()
            .filter_entry(|e| !is_skipped_dir(&e.file_name().to_string_lossy()))
        {
            let Ok(entry) = entry else { continue };
            if entry.file_type().is_file()
                && entry.path().extension().and_then(|e| e.to_str()) == Some("rs")
            {
                scan_one_file(repo_root, entry.path(), crate_name, sub, out);
            }
        }
    }
}

fn scan_one_file(
    repo_root: &Path,
    file: &Path,
    crate_name: &str,
    section: &str,
    out: &mut SymbolScan,
) {
    let Ok(text) = std::fs::read_to_string(file) else { return };
    let Ok(syntax) = syn::parse_file(&text) else { return };
    let rel = file.strip_prefix(repo_root).unwrap_or(file).to_string_lossy().to_string();
    let stem = file.file_stem().and_then(|s| s.to_str()).unwrap_or("");
    let base_module = if section == "src" && (stem == "lib" || stem == "main") {
        crate_name.to_string()
    } else if section == "src" {
        format!("{crate_name}::{stem}")
    } else {
        format!("{crate_name}::{section}::{stem}")
    };
    let mut v = Walker {
        crate_name: crate_name.to_string(),
        file: rel,
        module_stack: vec![base_module],
        out,
    };
    v.walk_items(&syntax.items);
}

struct Walker<'a> {
    crate_name: String,
    file: String,
    module_stack: Vec<String>,
    out: &'a mut SymbolScan,
}

impl<'a> Walker<'a> {
    fn cur(&self) -> &str {
        self.module_stack.last().map(|s| s.as_str()).unwrap_or("")
    }

    fn walk_items(&mut self, items: &[Item]) {
        for item in items {
            self.walk_item(item);
        }
    }

    fn walk_item(&mut self, item: &Item) {
        match item {
            Item::Fn(f) => {
                self.emit("fn", &f.sig.ident.to_string(), &vis(&f.vis),
                    Some(format!("fn {}{}", f.sig.ident, fn_inputs(&f.sig.inputs))),
                    &f.attrs, f.sig.ident.span());
                self.walk_fn_body(&f.sig.ident.to_string(), &f.block);
            }
            Item::Struct(s) => self.emit("struct", &s.ident.to_string(), &vis(&s.vis), None, &s.attrs, s.ident.span()),
            Item::Enum(e)   => self.emit("enum",   &e.ident.to_string(), &vis(&e.vis), None, &e.attrs, e.ident.span()),
            Item::Trait(t)  => self.emit("trait",  &t.ident.to_string(), &vis(&t.vis), None, &t.attrs, t.ident.span()),
            Item::Type(t)   => self.emit("type",   &t.ident.to_string(), &vis(&t.vis), None, &t.attrs, t.ident.span()),
            Item::Const(c)  => self.emit("const",  &c.ident.to_string(), &vis(&c.vis), None, &c.attrs, c.ident.span()),
            Item::Static(s) => self.emit("static", &s.ident.to_string(), &vis(&s.vis), None, &s.attrs, s.ident.span()),
            Item::Macro(m) => {
                if let Some(id) = &m.ident {
                    self.emit("macro", &id.to_string(), "pub", None, &m.attrs, id.span());
                }
            }
            Item::Mod(m) => {
                let nested = format!("{}::{}", self.cur(), m.ident);
                self.emit("mod", &m.ident.to_string(), &vis(&m.vis), None, &m.attrs, m.ident.span());
                if let Some((_, sub)) = &m.content {
                    self.module_stack.push(nested);
                    self.walk_items(sub);
                    self.module_stack.pop();
                }
            }
            Item::Impl(i) => self.walk_impl(i),
            _ => {}
        }
    }

    fn walk_impl(&mut self, i: &ItemImpl) {
        let self_ty = tokens_to_string(&i.self_ty);
        let trait_part = i.trait_.as_ref()
            .map(|(_, p, _)| path_to_string(p))
            .unwrap_or_default();
        let impl_label = if trait_part.is_empty() {
            format!("impl {self_ty}")
        } else {
            format!("impl {trait_part} for {self_ty}")
        };
        self.emit("impl", &impl_label, "pub", None, &i.attrs, i.self_ty.span());
        let parent = self.cur().to_string();
        self.module_stack.push(format!("{parent}::{self_ty}"));
        for it in &i.items {
            if let ImplItem::Fn(f) = it {
                self.emit("fn", &f.sig.ident.to_string(), &vis(&f.vis),
                    Some(format!("fn {}{}", f.sig.ident, fn_inputs(&f.sig.inputs))),
                    &f.attrs, f.sig.ident.span());
                self.walk_fn_body(&f.sig.ident.to_string(), &f.block);
            }
        }
        self.module_stack.pop();
    }

    fn walk_fn_body(&mut self, fn_name: &str, body: &syn::Block) {
        let caller = format!("{}::{}", self.cur(), fn_name);
        let mut cv = CallCollector {
            caller,
            crate_name: self.crate_name.clone(),
            file: self.file.clone(),
            out: &mut self.out.calls,
        };
        cv.visit_block(body);
    }

    fn emit(
        &mut self,
        kind: &str,
        name: &str,
        visi: &str,
        sig: Option<String>,
        attrs: &[Attribute],
        span: proc_macro2::Span,
    ) {
        let line = span.start().line as u32;
        let doc_lines = attrs.iter().filter(|a| a.path().is_ident("doc")).count() as u32;
        self.out.symbols.push(SymbolRow {
            crate_name: self.crate_name.clone(),
            module_path: self.cur().to_string(),
            item_kind: kind.to_string(),
            item_name: name.to_string(),
            visibility: visi.to_string(),
            file: self.file.clone(),
            line,
            doc_lines,
            signature: sig,
        });
        for cfg in extract_cfgs(attrs) {
            self.out.features.push(FeatureGateRow {
                crate_name: self.crate_name.clone(),
                module_path: self.cur().to_string(),
                item_name: name.to_string(),
                cfg_expr: cfg,
                file: self.file.clone(),
                line,
            });
        }
    }
}

struct CallCollector<'a> {
    caller: String,
    crate_name: String,
    file: String,
    out: &'a mut Vec<CallEdgeRow>,
}

impl<'ast, 'a> Visit<'ast> for CallCollector<'a> {
    fn visit_expr(&mut self, e: &'ast Expr) {
        match e {
            Expr::Call(c) => {
                let ident = match &*c.func {
                    Expr::Path(p) => path_to_string(&p.path),
                    other => tokens_to_string(other),
                };
                self.out.push(CallEdgeRow {
                    crate_name: self.crate_name.clone(),
                    caller_path: self.caller.clone(),
                    callee_ident: ident,
                    call_kind: "call".into(),
                    file: self.file.clone(),
                    line: c.func.span().start().line as u32,
                });
            }
            Expr::MethodCall(m) => {
                self.out.push(CallEdgeRow {
                    crate_name: self.crate_name.clone(),
                    caller_path: self.caller.clone(),
                    callee_ident: m.method.to_string(),
                    call_kind: "method".into(),
                    file: self.file.clone(),
                    line: m.method.span().start().line as u32,
                });
            }
            _ => {}
        }
        syn::visit::visit_expr(self, e);
    }
}

fn vis(v: &Visibility) -> String {
    match v {
        Visibility::Public(_) => "pub".into(),
        Visibility::Restricted(r) => format!("pub({})", path_to_string(&r.path)),
        Visibility::Inherited => "priv".into(),
    }
}

fn path_to_string(p: &syn::Path) -> String {
    p.segments.iter().map(|s| s.ident.to_string()).collect::<Vec<_>>().join("::")
}

fn tokens_to_string<T: quote::ToTokens>(t: &T) -> String {
    let mut ts = proc_macro2::TokenStream::new();
    t.to_tokens(&mut ts);
    ts.to_string()
}

fn fn_inputs(inputs: &syn::punctuated::Punctuated<syn::FnArg, syn::Token![,]>) -> String {
    let parts: Vec<String> = inputs.iter().map(|a| match a {
        syn::FnArg::Receiver(_) => "self".into(),
        syn::FnArg::Typed(t) => tokens_to_string(&t.ty),
    }).collect();
    format!("({})", parts.join(", "))
}

fn extract_cfgs(attrs: &[Attribute]) -> Vec<String> {
    let mut out = Vec::new();
    for a in attrs {
        if a.path().is_ident("cfg") {
            if let Meta::List(l) = &a.meta {
                out.push(l.tokens.to_string());
            }
        }
    }
    out
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn scans_basic_crate() {
        let dir = tempfile::tempdir().unwrap();
        let root = dir.path();
        std::fs::create_dir_all(root.join("src")).unwrap();
        std::fs::write(root.join("Cargo.toml"), r#"[package]
name = "demo"
version = "0.1.0"
edition = "2021"
"#).unwrap();
        std::fs::write(root.join("src/lib.rs"), r#"
pub fn outer(x: u32) -> u32 {
    helper(x) + 1
}
fn helper(x: u32) -> u32 { x.saturating_add(2) }

pub struct Foo { pub n: u32 }

impl Foo {
    pub fn make() -> Self { Self { n: 0 } }
}

pub trait Bar { fn baz(&self); }

#[cfg(feature = "experimental")]
pub fn gated() {}
"#).unwrap();

        let scan = scan_repo(root, "demo", Uuid::new_v4(), Utc::now()).unwrap();
        // Symbols: outer, helper, Foo, impl Foo, make, Bar, gated, baz? (trait fn is not Item)
        let kinds: Vec<_> = scan.symbols.iter().map(|s| (s.item_kind.as_str(), s.item_name.as_str())).collect();
        assert!(kinds.contains(&("fn", "outer")), "{kinds:?}");
        assert!(kinds.contains(&("fn", "helper")));
        assert!(kinds.contains(&("struct", "Foo")));
        assert!(kinds.iter().any(|(k, _)| *k == "impl"));
        assert!(kinds.contains(&("fn", "make")));
        assert!(kinds.contains(&("trait", "Bar")));
        assert!(kinds.contains(&("fn", "gated")));

        // Calls: outer calls helper + method call .saturating_add
        let callees: Vec<&str> = scan.calls.iter().map(|c| c.callee_ident.as_str()).collect();
        assert!(callees.contains(&"helper"), "{callees:?}");
        assert!(callees.contains(&"saturating_add"));

        // Features: one cfg row on `gated`
        assert!(scan.features.iter().any(|f| f.item_name == "gated" && f.cfg_expr.contains("experimental")));
    }

    #[test]
    fn captures_real_source_lines() {
        // Regression for the old `line = 0` bug: proc-macro2 span-locations
        // must yield the 1-based source line of each item name / call site.
        // The fixture's lib.rs starts with a newline, so `outer` is line 2.
        let dir = tempfile::tempdir().unwrap();
        let root = dir.path();
        std::fs::create_dir_all(root.join("src")).unwrap();
        std::fs::write(root.join("Cargo.toml"), "[package]\nname = \"demo\"\nversion = \"0.1.0\"\nedition = \"2021\"\n").unwrap();
        std::fs::write(root.join("src/lib.rs"), r#"
pub fn outer(x: u32) -> u32 {
    helper(x) + 1
}
fn helper(x: u32) -> u32 { x.saturating_add(2) }

pub struct Foo { pub n: u32 }

#[cfg(feature = "experimental")]
pub fn gated() {}
"#).unwrap();

        let scan = scan_repo(root, "demo", Uuid::new_v4(), Utc::now()).unwrap();

        let line_of = |name: &str| scan.symbols.iter().find(|s| s.item_name == name).map(|s| s.line);
        assert_eq!(line_of("outer"), Some(2));
        assert_eq!(line_of("helper"), Some(5));
        assert_eq!(line_of("Foo"), Some(7));
        assert_eq!(line_of("gated"), Some(10));

        // Every symbol got a real (non-zero) line.
        assert!(scan.symbols.iter().all(|s| s.line > 0), "{:?}",
            scan.symbols.iter().map(|s| (&s.item_name, s.line)).collect::<Vec<_>>());

        // Call sites carry their own lines: `helper(x)` is on line 3.
        let helper_call = scan.calls.iter().find(|c| c.callee_ident == "helper").unwrap();
        assert_eq!(helper_call.line, 3);
        assert!(scan.calls.iter().all(|c| c.line > 0));

        // The cfg feature-gate row shares the gated fn's line.
        let gate = scan.features.iter().find(|f| f.item_name == "gated").unwrap();
        assert_eq!(gate.line, 10);
    }
}