faf-rust-sdk 2.0.0

Rust SDK for FAF (Foundational AI-context Format) - IANA-registered application/vnd.faf+yaml
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
//! WJTTC Tier 2: ENGINE - Core Functionality Tests
//!
//! Core parsing, validation, compression, and discovery.
//! The engine that drives everything.

use faf_rust_sdk::{
    compress, estimate_tokens, find_and_parse, find_faf_file, parse, stringify, validate,
    CompressionLevel,
};
use std::fs;
use tempfile::TempDir;

// =============================================================================
// CORE PARSING (Tests 1-3)
// =============================================================================

#[test]
fn test_parse_minimal() {
    let content = r#"
faf_version: 2.5.0
project:
  name: test-project
"#;
    let faf = parse(content).unwrap();
    assert_eq!(faf.project_name(), "test-project");
    assert_eq!(faf.version(), "2.5.0");
}

#[test]
fn test_parse_full() {
    let content = r#"
faf_version: 2.5.0
ai_score: "90%"
project:
  name: full-test
  goal: Test everything
instant_context:
  what_building: Test app
  tech_stack: Rust, Python
  key_files:
    - src/main.rs
    - src/lib.rs
stack:
  backend: Rust
  database: PostgreSQL
"#;
    let faf = parse(content).unwrap();
    assert_eq!(faf.project_name(), "full-test");
    assert_eq!(faf.tech_stack(), Some("Rust, Python"));
    assert_eq!(faf.key_files().len(), 2);
    assert!(faf.is_high_quality());
}

#[test]
fn test_parse_score() {
    let content = r#"
faf_version: 2.5.0
ai_score: "85%"
project:
  name: test
"#;
    let faf = parse(content).unwrap();
    assert_eq!(faf.score(), Some(85));
}

// =============================================================================
// SCORE VALUES (Tests 4-8)
// =============================================================================

#[test]
fn test_score_0() {
    let content = r#"
faf_version: 2.5.0
ai_score: "0%"
project:
  name: test
"#;
    let faf = parse(content).unwrap();
    assert_eq!(faf.score(), Some(0));
}

#[test]
fn test_score_85() {
    let content = r#"
faf_version: 2.5.0
ai_score: "85%"
project:
  name: test
"#;
    let faf = parse(content).unwrap();
    assert_eq!(faf.score(), Some(85));
}

#[test]
fn test_score_100() {
    let content = r#"
faf_version: 2.5.0
ai_score: "100%"
project:
  name: test
"#;
    let faf = parse(content).unwrap();
    assert_eq!(faf.score(), Some(100));
}

#[test]
fn test_score_no_percent() {
    let content = r#"
faf_version: 2.5.0
ai_score: "85"
project:
  name: test
"#;
    let faf = parse(content).unwrap();
    assert_eq!(faf.score(), Some(85));
}

#[test]
fn test_score_double_percent() {
    let content = r#"
faf_version: 2.5.0
ai_score: "85%%"
project:
  name: test
"#;
    let faf = parse(content).unwrap();
    // Lenient: trim_end_matches removes all trailing %
    assert_eq!(faf.score(), Some(85));
}

// =============================================================================
// VALIDATION SCORING (Tests 9-10)
// =============================================================================

#[test]
fn test_validation_scoring_minimal() {
    let content = r#"
faf_version: 2.5.0
project:
  name: test
"#;
    let faf = parse(content).unwrap();
    let result = validate(&faf);
    assert!(result.valid);
    // Only faf_version (10) + project.name (10) = 20
    assert_eq!(result.score, 20);
}

#[test]
fn test_validation_scoring_full() {
    let content = r#"
faf_version: 2.5.0
project:
  name: test
  goal: Testing
instant_context:
  what_building: App
  tech_stack: Rust
  key_files:
    - main.rs
stack:
  backend: Rust
human_context:
  who: Devs
tags:
  - rust
state:
  phase: dev
"#;
    let faf = parse(content).unwrap();
    let result = validate(&faf);
    assert!(result.valid);
    assert_eq!(result.score, 100);
}

// =============================================================================
// COMPRESSION (Tests 11-13)
// =============================================================================

#[test]
fn test_compression_minimal() {
    let content = r#"
faf_version: 2.5.0
project:
  name: test
  goal: Testing
instant_context:
  what_building: App
  tech_stack: Rust
  key_files:
    - a.rs
    - b.rs
stack:
  backend: Rust
human_context:
  who: Devs
"#;
    let faf = parse(content).unwrap();
    let compressed = compress(&faf, CompressionLevel::Minimal);

    assert_eq!(compressed.project.name, "test");
    assert!(compressed
        .instant_context
        .as_ref()
        .unwrap()
        .tech_stack
        .is_some());
    assert!(compressed.stack.is_none());
    assert!(compressed.human_context.is_none());
}

#[test]
fn test_compression_standard() {
    let content = r#"
faf_version: 2.5.0
project:
  name: test
  goal: Testing
instant_context:
  what_building: App
  tech_stack: Rust
  key_files:
    - a.rs
    - b.rs
    - c.rs
    - d.rs
    - e.rs
    - f.rs
    - g.rs
stack:
  backend: Rust
human_context:
  who: Devs
"#;
    let faf = parse(content).unwrap();
    let compressed = compress(&faf, CompressionLevel::Standard);

    assert!(compressed.stack.is_some());
    // Key files limited to 5
    assert_eq!(
        compressed.instant_context.as_ref().unwrap().key_files.len(),
        5
    );
    assert!(compressed.human_context.is_none());
}

#[test]
fn test_compression_full() {
    let content = r#"
faf_version: 2.5.0
project:
  name: test
  goal: Testing
stack:
  backend: Rust
"#;
    let faf = parse(content).unwrap();
    let full = compress(&faf, CompressionLevel::Full);

    assert_eq!(full.project.name, faf.data.project.name);
    assert_eq!(full.project.goal, faf.data.project.goal);
    assert!(full.stack.is_some());
}

// =============================================================================
// DISCOVERY (Tests 14-17)
// =============================================================================

#[test]
fn test_discovery_current_dir() {
    let dir = TempDir::new().unwrap();
    let faf_path = dir.path().join("project.faf");
    fs::write(&faf_path, "faf_version: 2.5.0\nproject:\n  name: test").unwrap();

    let found = find_faf_file(Some(dir.path()));
    assert!(found.is_some());
    assert_eq!(found.unwrap(), faf_path);
}

#[test]
fn test_discovery_parent() {
    let parent = TempDir::new().unwrap();
    let child = parent.path().join("subdir");
    fs::create_dir(&child).unwrap();

    let faf_path = parent.path().join("project.faf");
    fs::write(&faf_path, "faf_version: 2.5.0\nproject:\n  name: test").unwrap();

    let found = find_faf_file(Some(&child));
    assert!(found.is_some());
    assert_eq!(found.unwrap(), faf_path);
}

#[test]
fn test_discovery_roundtrip() {
    let dir = TempDir::new().unwrap();
    let faf_path = dir.path().join("project.faf");
    fs::write(
        &faf_path,
        "faf_version: 2.5.0\nproject:\n  name: parsed-test",
    )
    .unwrap();

    let result = find_and_parse(Some(dir.path()));
    assert!(result.is_ok());
    assert_eq!(result.unwrap().project_name(), "parsed-test");
}

#[test]
fn test_discovery_not_found() {
    let dir = TempDir::new().unwrap();
    let found = find_faf_file(Some(dir.path()));
    assert!(found.is_none());
}

// =============================================================================
// QUALITY THRESHOLD (Tests 18-19)
// =============================================================================

#[test]
fn test_quality_threshold_at_70() {
    let content = r#"
faf_version: 2.5.0
ai_score: "70%"
project:
  name: test
"#;
    let faf = parse(content).unwrap();
    assert!(faf.is_high_quality(), "70% should be high quality");
}

#[test]
fn test_quality_threshold_below_70() {
    let content = r#"
faf_version: 2.5.0
ai_score: "69%"
project:
  name: test
"#;
    let faf = parse(content).unwrap();
    assert!(!faf.is_high_quality(), "69% should NOT be high quality");
}

// =============================================================================
// INVALID SCORE GRACEFUL (Test 20)
// =============================================================================

#[test]
fn test_invalid_score_graceful() {
    let content = r#"
faf_version: 2.5.0
ai_score: NOT_A_PERCENTAGE

project:
  name: bad-score
  goal: Invalid score format
"#;
    let result = parse(content);
    assert!(result.is_ok(), "Parser handles invalid score gracefully");
    let faf = result.unwrap();
    assert!(faf.score().is_none());
}

// =============================================================================
// NEW: STRINGIFY ROUND-TRIP (Test 21)
// =============================================================================

#[test]
fn test_stringify_round_trip() {
    let content = r#"
faf_version: 2.5.0
project:
  name: roundtrip-test
  goal: Verify stringify produces parseable output
"#;
    let faf = parse(content).unwrap();
    let yaml_output = stringify(&faf).unwrap();

    // Parse the stringified output - should produce same data
    let reparsed = parse(&yaml_output).unwrap();
    assert_eq!(faf.project_name(), reparsed.project_name());
    assert_eq!(faf.version(), reparsed.version());
    assert_eq!(faf.goal(), reparsed.goal());
}

// =============================================================================
// NEW: ESTIMATE TOKENS (Test 22)
// =============================================================================

#[test]
fn test_estimate_tokens_values() {
    let minimal = estimate_tokens(CompressionLevel::Minimal);
    let standard = estimate_tokens(CompressionLevel::Standard);
    let full = estimate_tokens(CompressionLevel::Full);

    assert_eq!(minimal, 150);
    assert_eq!(standard, 400);
    assert_eq!(full, 800);

    // Verify ordering: minimal < standard < full
    assert!(minimal < standard);
    assert!(standard < full);
}