devscout-rs 0.6.0

Fast code index for C# and TypeScript codebases -- map, find, refs, impact from the CLI.
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
use super::def_member_facts::member_facts;
use super::preproc_duplicate_header::DUPLICATE_HEADER_HOST_WITH_NESTED_EMITTER_SRC;
use super::*;

// --- Receiver facts ---------------------------------------

#[test]
fn stage2b_facts_come_from_locals_var_new_params_fields_and_primary_ctor_params() {
    let e = extract_src(
        r#"
namespace App.Receivers;

public class Host(IClock clock)
{
  private readonly ILogger _log;

  public void Run(IRepo repo)
  {
    Helper h = new Helper();
    var svc = new Service();
    repo.Save();
    h.Help();
    svc.Go();
    _log.Info();
    clock.Now();
  }
}
"#,
    );
    assert_eq!(
        member_facts(&e),
        vec![
            ("Save", Some("IRepo")),
            ("Help", Some("Helper")),
            ("Go", Some("Service")),
            ("Info", Some("ILogger")),
            ("Now", Some("IClock")),
        ]
    );
}

#[test]
fn stage2b_receiver_type_is_set_only_on_refs_that_earned_a_fact() {
    let e = extract_src(
        r#"
namespace App.Shape;

public class Host
{
  public void Run(IRepo repo) { repo.Save(); }
}
"#,
    );
    let r = e
        .refs
        .iter()
        .find(|r| r.kind == "uses-member")
        .expect("member ref present");
    assert_eq!(r.name, "repo");
    assert_eq!(r.qualified, None);
    assert!(!r.generic);
    assert_eq!(r.receiver_type.as_deref(), Some("IRepo"));
}

#[test]
fn stage2b_no_fact_for_var_from_call_predefined_types_or_an_implicit_lambda_parameter() {
    let e = extract_src(
        r#"
namespace App.NoFacts;

public class Host
{
  public void Run(string text, System.Collections.Generic.Dictionary<string, Widget> items)
  {
    var computed = Compute();
    int count = 0;
    computed.Use();
    text.Trim();
    count.ToString();
    items.ForEach(x => x.Do());
  }
}
"#,
    );
    let facts: Vec<(String, Option<&str>)> = e
        .refs
        .iter()
        .filter(|r| r.kind == "uses-member")
        .map(|r| {
            (
                format!("{}.{}", r.name, r.member.as_deref().unwrap_or("")),
                r.receiver_type.as_deref(),
            )
        })
        .collect();
    assert_eq!(
        facts,
        vec![
            // var + a call initializer: resolve-time territory, never guessed here
            ("computed.Use".to_string(), None),
            // predefined types: no fact
            ("text.Trim".to_string(), None),
            ("count.ToString".to_string(), None),
            // an explicitly typed parameter DOES earn a fact even when its
            // declared type is qualified AND generic -- reduced to
            // "Dictionary" (a TWO-argument generic, deliberately, so this
            // window does NOT also qualify for the lambda-parameter
            // element-typing rule below -- that positive case has its own
            // dedicated stage4_first_single_parameter_lambda_... test)
            ("items.ForEach".to_string(), Some("Dictionary")),
            // implicit lambda parameter, first argument of a call whose
            // receiver is a TWO-argument generic: still no fact
            ("x.Do".to_string(), None),
        ]
    );
}

#[test]
fn stage2b_two_declarations_of_one_local_with_different_types_cancel_to_no_fact() {
    let e = extract_src(
        r#"
namespace App.Conflict;

public class Host
{
  public void Run(bool flag)
  {
    if (flag) { Widget x = new Widget(); x.Go(); }
    else { Gadget x = new Gadget(); x.Go(); }
  }
}
"#,
    );
    assert_eq!(
        member_facts(&e),
        vec![("Go", None), ("Go", None)],
        "the method-level flat table is conflicted for \"x\""
    );
}

#[test]
fn stage2b_same_local_name_declared_twice_with_the_same_type_still_yields_the_fact() {
    let e = extract_src(
        r#"
namespace App.NoConflict;

public class Host
{
  public void Run(bool flag)
  {
    if (flag) { Widget x = new Widget(); x.Go(); }
    else { Widget x = new Widget(); x.Go(); }
  }
}
"#,
    );
    assert_eq!(
        member_facts(&e),
        vec![("Go", Some("Widget")), ("Go", Some("Widget"))]
    );
}

#[test]
fn stage2b_a_parameter_shadows_a_same_named_field_of_a_different_type() {
    let e = extract_src(
        r#"
namespace App.Shadow;

public class Host
{
  private Widget handler;

  public void Run(Gadget handler)
  {
    handler.Go();
  }

  public void Untouched()
  {
    handler.Go();
  }
}
"#,
    );
    assert_eq!(
        member_facts(&e),
        vec![("Go", Some("Gadget")), ("Go", Some("Widget"))],
        "inside Run the parameter wins; the other method still sees the field"
    );
}

#[test]
fn stage2b_a_nested_type_never_inherits_the_enclosing_types_field_table() {
    let e = extract_src(
        r#"
namespace App.Nested;

public class Outer
{
  private Widget handler;

  public class Inner
  {
    public void Run() { handler.Go(); }
  }
}
"#,
    );
    assert_eq!(
        member_facts(&e),
        vec![("Go", None)],
        "a nested type cannot reach an outer instance field"
    );
}

#[test]
fn stage2b_a_flattened_chain_tail_never_inherits_the_heads_receiver_type() {
    // Stage-1 chain-tail regression class, extended for receiverType: a
    // tail must NOT inherit a fact it did not earn. Structurally
    // impossible here because the tail's qualifier is dotted.
    let e = extract_src(
        r#"
namespace App.Consumers;

public class Chain
{
  public void Run()
  {
    Widget w = new Widget();
    w.Inner.Tail();
  }
}
"#,
    );
    let head = e
        .refs
        .iter()
        .find(|r| r.member.as_deref() == Some("Inner"))
        .expect("head ref present");
    let tail = e
        .refs
        .iter()
        .find(|r| r.member.as_deref() == Some("Tail"))
        .expect("tail ref present");
    assert_eq!(
        head.receiver_type.as_deref(),
        Some("Widget"),
        "the head is the ref the local declaration vouches for"
    );
    assert_eq!(
        tail.qualified.as_deref(),
        Some("w.Inner"),
        "the tail's qualifier is the flattened chain window"
    );
    assert_eq!(
        tail.receiver_type, None,
        "the tail must NOT inherit the head's receiverType"
    );
}

#[test]
fn stage2b_a_generic_qualifier_never_carries_a_receiver_fact() {
    // A type-argument list is syntax no local, parameter or field can
    // carry, so the bare-only guard refuses the lookup outright even when
    // a same-named local happens to exist.
    let e = extract_src(
        r#"
namespace App.Generic;

public class Host
{
  public void Run()
  {
    Widget Cache = new Widget();
    Cache<int>.Go();
  }
}
"#,
    );
    let r = e
        .refs
        .iter()
        .find(|r| r.member.as_deref() == Some("Go"))
        .expect("member ref present");
    assert!(r.generic);
    assert_eq!(r.receiver_type, None);
}

#[test]
fn stage2b_a_local_declared_in_a_using_or_for_statement_is_a_fact() {
    let e = extract_src(
        r#"
namespace App.Statements;

public class Host
{
  public void Run()
  {
    using (Stream s = Open()) { s.Read(); }
    for (Counter c = Start(); ; ) { c.Tick(); }
  }
}
"#,
    );
    assert_eq!(
        member_facts(&e),
        vec![("Read", Some("Stream")), ("Tick", Some("Counter"))]
    );
}

#[test]
fn stage2b_an_explicitly_typed_foreach_variable_is_a_fact() {
    // foreach_statement carries its own `type`/`left` fields,
    // not a variable_declaration node, so it needs its own rule rather
    // than falling out of the ordinary declaration walk for free. An
    // explicitly typed loop variable is answered by that type node
    // exactly like any other declaration.
    let e = extract_src(
        r#"
namespace App.ForEach;

public class Host
{
  public void Run(System.Collections.Generic.List<Widget> items)
  {
    foreach (Widget w in items) { w.Go(); }
  }
}
"#,
    );
    let go = e
        .refs
        .iter()
        .find(|r| r.member.as_deref() == Some("Go"))
        .expect("member ref present");
    assert_eq!(go.receiver_type.as_deref(), Some("Widget"));
}

#[test]
fn stage2b_a_local_function_folds_into_the_enclosing_members_flat_table() {
    let e = extract_src(
        r#"
namespace App.LocalFn;

public class Host
{
  public void Run()
  {
    Widget w = new Widget();
    void Inner() { w.Go(); }
  }
}
"#,
    );
    let go = e
        .refs
        .iter()
        .find(|r| r.member.as_deref() == Some("Go"))
        .expect("member ref present");
    assert_eq!(
        go.receiver_type.as_deref(),
        Some("Widget"),
        "a local function sees the enclosing method's locals"
    );
}

#[test]
fn stage2b_an_explicitly_typed_declaration_never_reads_its_new_initializer() {
    let e = extract_src(
        r#"
namespace App.Explicit;

public class Host
{
  public void Run()
  {
    object o = new Widget();
    o.Go();
  }
}
"#,
    );
    let go = e
        .refs
        .iter()
        .find(|r| r.member.as_deref() == Some("Go"))
        .expect("member ref present");
    assert_eq!(
        go.receiver_type, None,
        "`object` is a predefined type: no fact, and Widget is never substituted for it"
    );
}

#[test]
fn stage2b_the_surviving_header_arm_supplies_receiver_facts_at_both_nesting_levels() {
    // The duplicate-header preproc shape (see
    // DUPLICATE_HEADER_HOST_WITH_NESTED_EMITTER_SRC), at both nesting
    // levels. `WIDGET_V2` is undefined, so in each of the two methods
    // only the `#else` arm's `IReadOnlyList<Widget> items` parameter
    // reaches the parser -- each `items` ref vouches through its own
    // method's parameter, and `sink` vouches through the inner
    // method's own (unconditional) parameter.
    let e = extract_src(DUPLICATE_HEADER_HOST_WITH_NESTED_EMITTER_SRC);
    let facts: Vec<(&str, Option<&str>)> = e
        .refs
        .iter()
        .filter(|r| r.kind == "uses-member")
        .map(|r| (r.name.as_str(), r.receiver_type.as_deref()))
        .collect();
    assert_eq!(
        facts,
        vec![
            ("items", Some("IReadOnlyList")),
            ("items", Some("IReadOnlyList")),
            ("sink", Some("Sink")),
        ]
    );
}