barkml 0.8.5

Declarative configuration language
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
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
use super::{Result, error};
use crate::ast::{Statement, Value, ValueType};
use indexmap::IndexSet;
use snafu::OptionExt;
use std::fmt;

/// Enhanced walker for navigating and extracting data from BarkML statements and values
///
/// This enum provides a comprehensive and ergonomic way to traverse the AST and extract values
/// from BarkML documents. It handles both Statement and Value nodes with enhanced error handling,
/// type safety, and performance optimizations.
///
/// # Features
///
/// - Type-safe value extraction with automatic conversion
/// - Path-based navigation with dot notation support
/// - Comprehensive error handling with location information
/// - Performance optimizations for common operations
/// - Support for complex queries and filtering
/// - Debugging and introspection capabilities
///
#[derive(Clone)]
pub enum Walk<'source> {
    /// A reference to a Statement node in the AST
    Statement(&'source Statement),

    /// A reference to a Value node in the AST
    Value(&'source Value),
}

impl<'source> Walk<'source> {
    /// Create a new walker over the given module statement
    pub fn new(module: &'source Statement) -> Self {
        Self::Statement(module)
    }

    /// Create a new walker over a value
    pub fn from_value(value: &'source Value) -> Self {
        Self::Value(value)
    }

    /// Get the current location information for error reporting
    pub fn location(&self) -> &crate::ast::Location {
        match self {
            Self::Statement(stmt) => &stmt.meta.location,
            Self::Value(value) => &value.meta.location,
        }
    }

    /// Get the type of the current node
    pub fn node_type(&self) -> NodeType {
        match self {
            Self::Statement(stmt) => NodeType::Statement(stmt.type_.clone()),
            Self::Value(value) => NodeType::Value(value.type_of()),
        }
    }

    /// Check if the current node is a statement
    pub const fn is_statement(&self) -> bool {
        matches!(self, Self::Statement(_))
    }

    /// Check if the current node is a value
    pub const fn is_value(&self) -> bool {
        matches!(self, Self::Value(_))
    }

    /// Fetch a child statement by field name with enhanced error handling
    pub fn get_child(&self, field: &str) -> Result<&Statement> {
        match self {
            Self::Statement(stmt) => {
                let children = stmt.get_grouped().context(error::NotScopeSnafu {
                    location: stmt.meta.location.clone(),
                })?;

                children.get(field).context(error::NoFieldSnafu {
                    field: field.to_string(),
                    location: stmt.meta.location.clone(),
                })
            }
            Self::Value(value) => error::NotScopeSnafu {
                location: value.meta.location.clone(),
            }
            .fail(),
        }
    }

    /// Fetch and convert a value from a field with path support
    pub fn get<T>(&self, field: &str) -> Result<T>
    where
        T: TryFrom<&'source Value, Error = error::Error>,
    {
        // Support dot notation for nested paths
        if field.contains('.') {
            return self.get_by_path(field);
        }

        match self {
            Self::Statement(stmt) => {
                let children = stmt
                    .get_grouped()
                    .or_else(|| stmt.get_labeled().map(|x| x.1))
                    .context(error::NotScopeSnafu {
                        location: stmt.meta.location.clone(),
                    })?;

                let target_stmt = children.get(field).context(error::NoFieldSnafu {
                    location: stmt.meta.location.clone(),
                    field: field.to_string(),
                })?;

                let value = target_stmt.get_value().context(error::NoValueSnafu {
                    location: stmt.meta.location.clone(),
                    field: field.to_string(),
                })?;

                value.try_into()
            }
            Self::Value(value) => {
                let table = value.as_table().context(error::NotScopeSnafu {
                    location: value.meta.location.clone(),
                })?;

                let target_value = table.get(field).context(error::NoFieldSnafu {
                    location: value.meta.location.clone(),
                    field: field.to_string(),
                })?;

                target_value.try_into()
            }
        }
    }

    /// Get a value by dot-separated path (e.g., "config.database.host")
    pub fn get_by_path<T>(&self, path: &str) -> Result<T>
    where
        T: TryFrom<&'source Value, Error = error::Error>,
    {
        let parts: Vec<&str> = path.split('.').collect();
        let mut current = self.clone();

        // Navigate to the target
        for (i, part) in parts.iter().enumerate() {
            if i == parts.len() - 1 {
                // Last part - extract the value
                return current.get(part);
            } else {
                // Intermediate part - navigate deeper
                current = current.walk(part)?;
            }
        }

        unreachable!("Path navigation should have returned or errored")
    }

    /// Get the identifier of the current statement
    pub fn get_id(&self) -> Option<&str> {
        match self {
            Self::Statement(stmt) => Some(&stmt.id),
            Self::Value(_) => None,
        }
    }

    /// Fetch and convert a block label to the requested type
    pub fn get_label<T>(&self, index: usize) -> Result<T>
    where
        T: TryFrom<&'source Value, Error = error::Error>,
    {
        match self {
            Self::Statement(stmt) => {
                let (labels, _) = stmt.get_labeled().context(error::NotScopeSnafu {
                    location: stmt.meta.location.clone(),
                })?;

                let label = labels.get(index).context(error::NoElementSnafu {
                    location: stmt.meta.location.clone(),
                    index,
                })?;

                label.try_into()
            }
            Self::Value(value) => error::NotScopeSnafu {
                location: value.meta.location.clone(),
            }
            .fail(),
        }
    }

    /// Get all section names in the current scope
    pub fn get_sections(&self) -> Result<IndexSet<String>> {
        match self {
            Self::Statement(stmt) => {
                let children = stmt.get_grouped().context(error::NotScopeSnafu {
                    location: stmt.meta.location.clone(),
                })?;

                Ok(children
                    .iter()
                    .filter_map(|(k, s)| {
                        if matches!(s.type_, crate::StatementType::Section(..)) {
                            Some(k.clone())
                        } else {
                            None
                        }
                    })
                    .collect())
            }
            Self::Value(value) => error::NotScopeSnafu {
                location: value.meta.location.clone(),
            }
            .fail(),
        }
    }

    /// Get all block names in the current scope
    pub fn get_all_blocks(&self) -> Result<IndexSet<String>> {
        match self {
            Self::Statement(stmt) => {
                let children = stmt.get_grouped().context(error::NotScopeSnafu {
                    location: stmt.meta.location.clone(),
                })?;

                Ok(children
                    .iter()
                    .filter_map(|(k, s)| {
                        if matches!(s.type_, crate::StatementType::Block { .. }) {
                            Some(k.clone())
                        } else {
                            None
                        }
                    })
                    .collect())
            }
            Self::Value(value) => error::NotScopeSnafu {
                location: value.meta.location.clone(),
            }
            .fail(),
        }
    }

    /// Get all blocks with a specific ID
    pub fn get_blocks(&self, field: &str) -> Result<IndexSet<String>> {
        match self {
            Self::Statement(stmt) => {
                let children = stmt
                    .get_grouped()
                    .or_else(|| stmt.get_labeled().map(|x| x.1))
                    .context(error::NotScopeSnafu {
                        location: stmt.meta.location.clone(),
                    })?;

                Ok(children
                    .iter()
                    .filter_map(|(k, s)| {
                        if s.get_labeled().is_some() && s.id == field {
                            Some(k.clone())
                        } else {
                            None
                        }
                    })
                    .collect())
            }
            Self::Value(value) => error::NotScopeSnafu {
                location: value.meta.location.clone(),
            }
            .fail(),
        }
    }

    /// Create a new walker for a nested field
    pub fn walk(&self, field: &str) -> Result<Self> {
        match self {
            Self::Statement(stmt) => {
                if let Some(children) = stmt
                    .get_grouped()
                    .or_else(|| stmt.get_labeled().map(|x| x.1))
                {
                    let target = children.get(field).context(error::NoFieldSnafu {
                        location: stmt.meta.location.clone(),
                        field: field.to_string(),
                    })?;
                    Ok(Self::Statement(target))
                } else if let Some(value) = stmt.get_value() {
                    Ok(Self::Value(value))
                } else {
                    error::NotScopeSnafu {
                        location: stmt.meta.location.clone(),
                    }
                    .fail()
                }
            }
            Self::Value(value) => {
                let table = value.as_table().context(error::NotScopeSnafu {
                    location: value.meta.location.clone(),
                })?;

                let target = table.get(field).context(error::NoFieldSnafu {
                    location: value.meta.location.clone(),
                    field: field.to_string(),
                })?;

                Ok(Self::Value(target))
            }
        }
    }

    /// Get all field names in the current scope
    pub fn field_names(&self) -> Result<Vec<String>> {
        match self {
            Self::Statement(stmt) => {
                let children = stmt
                    .get_grouped()
                    .or_else(|| stmt.get_labeled().map(|x| x.1))
                    .context(error::NotScopeSnafu {
                        location: stmt.meta.location.clone(),
                    })?;

                Ok(children.keys().cloned().collect())
            }
            Self::Value(value) => {
                let table = value.as_table().context(error::NotScopeSnafu {
                    location: value.meta.location.clone(),
                })?;

                Ok(table.keys().cloned().collect())
            }
        }
    }

    /// Check if a field exists
    pub fn has_field(&self, field: &str) -> bool {
        self.get_child(field).is_ok() || self.walk(field).is_ok()
    }

    /// Get the number of children/fields
    pub fn len(&self) -> usize {
        match self {
            Self::Statement(stmt) => stmt
                .get_grouped()
                .or_else(|| stmt.get_labeled().map(|x| x.1))
                .map(|children| children.len())
                .unwrap_or(0),
            Self::Value(value) => value.as_table().map(|table| table.len()).unwrap_or(0),
        }
    }

    /// Check if the current node is empty
    pub fn is_empty(&self) -> bool {
        self.len() == 0
    }
}

/// Represents the type of a node in the AST
#[derive(Debug, Clone)]
pub enum NodeType {
    Statement(crate::StatementType),
    Value(ValueType),
}

impl fmt::Display for NodeType {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            NodeType::Statement(stmt_type) => write!(
                f,
                "Statement({})",
                match stmt_type {
                    crate::StatementType::Control(_) => "Control",
                    crate::StatementType::Assignment(_) => "Assignment",
                    crate::StatementType::Block { .. } => "Block",
                    crate::StatementType::Section(_) => "Section",
                    crate::StatementType::Module(_) => "Module",
                }
            ),
            NodeType::Value(value_type) => write!(f, "Value({})", value_type),
        }
    }
}

impl<'source> fmt::Debug for Walk<'source> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Statement(stmt) => f
                .debug_struct("Walk::Statement")
                .field("id", &stmt.id)
                .field("type", &stmt.type_)
                .field("location", &stmt.meta.location)
                .finish(),
            Self::Value(value) => f
                .debug_struct("Walk::Value")
                .field("type", &value.type_of())
                .field("location", &value.meta.location)
                .finish(),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::ast::{Metadata, Statement, Value};
    use indexmap::IndexMap;

    fn create_test_statement() -> Statement {
        let mut children = IndexMap::new();

        let value = Value::new_string("test_value".to_string(), Metadata::default());
        let stmt = Statement::new_assign("test_field", None, value, Metadata::default()).unwrap();
        children.insert("test_field".to_string(), stmt);

        Statement::new_module("test", children, Metadata::default())
    }

    #[test]
    fn test_walker_creation() {
        let stmt = create_test_statement();
        let walker = Walk::new(&stmt);

        assert!(walker.is_statement());
        assert!(!walker.is_value());
        assert_eq!(walker.get_id(), Some("test"));
    }

    #[test]
    fn test_field_access() {
        let stmt = create_test_statement();
        let walker = Walk::new(&stmt);

        assert!(walker.has_field("test_field"));
        assert!(!walker.has_field("nonexistent"));

        let value: String = walker.get("test_field").unwrap();
        assert_eq!(value, "test_value");
    }

    #[test]
    fn test_navigation() {
        let stmt = create_test_statement();
        let walker = Walk::new(&stmt);

        let child_walker = walker.walk("test_field").unwrap();
        assert!(child_walker.is_statement());
    }

    #[test]
    fn test_field_enumeration() {
        let stmt = create_test_statement();
        let walker = Walk::new(&stmt);

        let fields = walker.field_names().unwrap();
        assert_eq!(fields.len(), 1);
        assert!(fields.contains(&"test_field".to_string()));

        assert_eq!(walker.len(), 1);
        assert!(!walker.is_empty());
    }

    #[test]
    fn test_node_type() {
        let stmt = create_test_statement();
        let walker = Walk::new(&stmt);

        let node_type = walker.node_type();
        assert!(matches!(node_type, NodeType::Statement(_)));
    }
}