ruchy 4.1.1

A systems scripting language that transpiles to idiomatic Rust with extreme quality engineering
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
//! Parameter parsing helpers

use crate::frontend::parser::{
    bail, expressions, parse_expr_recursive, Expr, Param, ParserState, Pattern, Result, Span,
    Token, Type, TypeKind,
};

/// Parse function parameters
pub fn parse_params(state: &mut ParserState) -> Result<Vec<Param>> {
    state.tokens.expect(&Token::LeftParen)?;
    let params = parse_param_list(state)?;
    state.tokens.expect(&Token::RightParen)?;
    Ok(params)
}

/// Parse list of parameters (extracted to reduce nesting)
fn parse_param_list(state: &mut ParserState) -> Result<Vec<Param>> {
    let mut params = Vec::new();

    while !matches!(state.tokens.peek(), Some((Token::RightParen, _))) {
        params.push(parse_single_param(state)?);

        if !should_continue_param_list(state)? {
            break;
        }
    }

    Ok(params)
}

/// Parse a single parameter (complexity: 9)
fn parse_single_param(state: &mut ParserState) -> Result<Param> {
    let is_mutable = check_and_consume_mut(state);
    let (pattern, (is_reference, is_ref_mut)) = parse_param_pattern(state)?;
    let mut ty = parse_optional_type_annotation(state)?;

    // For self parameters with references, create the appropriate reference type
    if is_reference {
        if let Pattern::Identifier(name) = &pattern {
            if name == "self" {
                // Create reference type for self parameter
                ty = Type {
                    kind: TypeKind::Reference {
                        is_mut: is_ref_mut,
                        lifetime: None, // Lifetimes on self references not yet supported
                        inner: Box::new(Type {
                            kind: TypeKind::Named("Self".to_string()),
                            span: Span { start: 0, end: 0 },
                        }),
                    },
                    span: ty.span,
                };
            }
        }
    }

    let default_value = parse_optional_default_value(state)?;
    Ok(Param {
        pattern,
        ty,
        span: Span { start: 0, end: 0 },
        is_mutable,
        default_value,
    })
}

/// Check for and consume mut keyword (complexity: 2)
fn check_and_consume_mut(state: &mut ParserState) -> bool {
    if matches!(state.tokens.peek(), Some((Token::Mut, _))) {
        state.tokens.advance();
        true
    } else {
        false
    }
}

/// Parse parameter pattern (complexity: 8 - increased to support destructuring)
/// Returns (pattern, `reference_info`) where `reference_info` is (`is_reference`, `is_mut`)
fn parse_param_pattern(state: &mut ParserState) -> Result<(Pattern, (bool, bool))> {
    match state.tokens.peek() {
        Some((Token::Identifier(name), _)) => {
            // PARSER-087: Check if this is a typed parameter (name: Type)
            // If so, parse as identifier pattern - the & is part of the type annotation, not the pattern
            let name = name.clone();
            state.tokens.advance();
            Ok((Pattern::Identifier(name), (false, false)))
        }
        Some((Token::Ampersand, _)) => {
            // This must be &self or &mut self
            // We don't support other reference patterns in function parameters
            parse_reference_pattern(state)
        }
        Some((Token::DataFrame, _)) => {
            // Handle "df" parameter name (tokenized as DataFrame)
            state.tokens.advance();
            Ok((Pattern::Identifier("df".to_string()), (false, false)))
        }
        Some((Token::Self_, _)) => {
            // Handle "self" parameter name
            state.tokens.advance();
            Ok((Pattern::Identifier("self".to_string()), (false, false)))
        }
        Some((Token::LeftParen, _)) => {
            // Parse tuple destructuring: fun f((x, y)) {}
            let pattern = expressions::parse_tuple_pattern(state)?;
            Ok((pattern, (false, false)))
        }
        Some((Token::LeftBracket, _)) => {
            // Parse list destructuring: fun f([x, y]) {}
            let pattern = expressions::parse_list_pattern(state)?;
            Ok((pattern, (false, false)))
        }
        Some((Token::LeftBrace, _)) => {
            // Parse struct destructuring: fun f({x, y}) {}
            let pattern = expressions::parse_struct_pattern(state)?;
            Ok((pattern, (false, false)))
        }
        Some((Token::Default, _)) => {
            // PARSER-087: Allow 'default' as parameter name (common pattern: default values)
            state.tokens.advance();
            Ok((Pattern::Identifier("default".to_string()), (false, false)))
        }
        Some((Token::From, _)) => {
            bail!(
                "'from' is a reserved keyword (for future import syntax).\n\
                 Suggestion: Use 'from_vertex', 'source', 'start_node', or similar instead.\n\
                 \n\
                 Example:\n\
                 ✗ fun shortest_path(from, to) {{ ... }}  // Error\n\
                 ✓ fun shortest_path(source, target) {{ ... }}  // OK\n\
                 \n\
                 See: https://github.com/paiml/ruchy/issues/23"
            )
        }
        _ => bail!("Function parameters must be simple identifiers or destructuring patterns"),
    }
}

/// Parse reference patterns (&self, &mut self) (complexity: 8)
/// Returns (pattern, `reference_info`) where `reference_info` is (`is_reference`, `is_mut`)
fn parse_reference_pattern(state: &mut ParserState) -> Result<(Pattern, (bool, bool))> {
    state.tokens.advance(); // consume &
    let is_mut_ref = matches!(state.tokens.peek(), Some((Token::Mut, _)));
    if is_mut_ref {
        state.tokens.advance(); // consume mut
    }

    match state.tokens.peek() {
        Some((Token::Self_, _)) => {
            state.tokens.advance();
            // Return "self" as pattern with reference info
            Ok((Pattern::Identifier("self".to_string()), (true, is_mut_ref)))
        }
        Some((Token::Identifier(n), _)) => {
            // For regular identifiers after &, we need to handle them differently
            // This is for parameters like "other: &Type"
            // The & is part of the type, not the parameter pattern
            // So we should not have consumed the & yet
            // This is a design issue - we need to refactor
            let expected = if is_mut_ref {
                "'self' after '&mut'"
            } else {
                "'self' after '&'"
            };
            bail!("Expected {expected} (got identifier '{n}')")
        }
        _ => {
            let expected = if is_mut_ref {
                "'self' after '&mut'"
            } else {
                "'self' after '&'"
            };
            bail!("Expected {expected}")
        }
    }
}

/// Parse optional type annotation (complexity: 4)
fn parse_optional_type_annotation(state: &mut ParserState) -> Result<Type> {
    if matches!(state.tokens.peek(), Some((Token::Colon, _))) {
        state.tokens.advance(); // consume :
        crate::frontend::parser::utils::parse_type(state)
    } else {
        // Default to 'Any' type for untyped parameters
        Ok(Type {
            kind: TypeKind::Named("Any".to_string()),
            span: Span { start: 0, end: 0 },
        })
    }
}

/// Parse optional default value (complexity: 3)
fn parse_optional_default_value(state: &mut ParserState) -> Result<Option<Box<Expr>>> {
    if matches!(state.tokens.peek(), Some((Token::Equal, _))) {
        state.tokens.advance(); // consume =
        Ok(Some(Box::new(parse_expr_recursive(state)?)))
    } else {
        Ok(None)
    }
}

/// Check if we should continue parsing parameters (complexity: 3)
fn should_continue_param_list(state: &mut ParserState) -> Result<bool> {
    if matches!(state.tokens.peek(), Some((Token::Comma, _))) {
        state.tokens.advance(); // consume comma
        Ok(true)
    } else {
        Ok(false)
    }
}

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

    fn create_state(source: &str) -> ParserState<'_> {
        ParserState::new(source)
    }

    // Test 1: Parse empty params
    #[test]
    fn test_parse_params_empty() {
        let mut state = create_state("()");
        let result = parse_params(&mut state);
        assert!(result.is_ok());
        assert!(result.unwrap().is_empty());
    }

    // Test 2: Parse single identifier param
    #[test]
    fn test_parse_params_single_identifier() {
        let mut state = create_state("(x)");
        let result = parse_params(&mut state);
        assert!(result.is_ok());
        let params = result.unwrap();
        assert_eq!(params.len(), 1);
        assert!(matches!(&params[0].pattern, Pattern::Identifier(n) if n == "x"));
    }

    // Test 3: Parse typed param
    #[test]
    fn test_parse_params_with_type() {
        let mut state = create_state("(x: i32)");
        let result = parse_params(&mut state);
        assert!(result.is_ok());
        let params = result.unwrap();
        assert_eq!(params.len(), 1);
        assert!(matches!(&params[0].ty.kind, TypeKind::Named(n) if n == "i32"));
    }

    // Test 4: Parse multiple params
    #[test]
    fn test_parse_params_multiple() {
        let mut state = create_state("(x, y, z)");
        let result = parse_params(&mut state);
        assert!(result.is_ok());
        let params = result.unwrap();
        assert_eq!(params.len(), 3);
    }

    // Test 5: Parse mutable param
    #[test]
    fn test_parse_params_mutable() {
        let mut state = create_state("(mut x)");
        let result = parse_params(&mut state);
        assert!(result.is_ok());
        let params = result.unwrap();
        assert_eq!(params.len(), 1);
        assert!(params[0].is_mutable);
    }

    // Test 6: Parse self param
    #[test]
    fn test_parse_params_self() {
        let mut state = create_state("(self)");
        let result = parse_params(&mut state);
        assert!(result.is_ok());
        let params = result.unwrap();
        assert_eq!(params.len(), 1);
        assert!(matches!(&params[0].pattern, Pattern::Identifier(n) if n == "self"));
    }

    // Test 7: Parse &self param
    #[test]
    fn test_parse_params_ref_self() {
        let mut state = create_state("(&self)");
        let result = parse_params(&mut state);
        assert!(result.is_ok());
        let params = result.unwrap();
        assert_eq!(params.len(), 1);
        assert!(matches!(
            &params[0].ty.kind,
            TypeKind::Reference { is_mut: false, .. }
        ));
    }

    // Test 8: Parse &mut self param
    #[test]
    fn test_parse_params_ref_mut_self() {
        let mut state = create_state("(&mut self)");
        let result = parse_params(&mut state);
        assert!(result.is_ok());
        let params = result.unwrap();
        assert_eq!(params.len(), 1);
        assert!(matches!(
            &params[0].ty.kind,
            TypeKind::Reference { is_mut: true, .. }
        ));
    }

    // Test 9: Parse df param (DataFrame keyword)
    #[test]
    fn test_parse_params_df_identifier() {
        let mut state = create_state("(df)");
        let result = parse_params(&mut state);
        assert!(result.is_ok());
        let params = result.unwrap();
        assert_eq!(params.len(), 1);
        assert!(matches!(&params[0].pattern, Pattern::Identifier(n) if n == "df"));
    }

    // Test 10: Parse default as identifier
    #[test]
    fn test_parse_params_default_identifier() {
        let mut state = create_state("(default)");
        let result = parse_params(&mut state);
        assert!(result.is_ok());
        let params = result.unwrap();
        assert_eq!(params.len(), 1);
        assert!(matches!(&params[0].pattern, Pattern::Identifier(n) if n == "default"));
    }

    // Test 11: Parse param with default value
    #[test]
    fn test_parse_params_with_default_value() {
        let mut state = create_state("(x = 42)");
        let result = parse_params(&mut state);
        assert!(result.is_ok());
        let params = result.unwrap();
        assert_eq!(params.len(), 1);
        assert!(params[0].default_value.is_some());
    }

    // Test 12: Parse typed param with default value
    #[test]
    fn test_parse_params_typed_with_default() {
        let mut state = create_state("(x: i32 = 0)");
        let result = parse_params(&mut state);
        assert!(result.is_ok());
        let params = result.unwrap();
        assert_eq!(params.len(), 1);
        assert!(matches!(&params[0].ty.kind, TypeKind::Named(n) if n == "i32"));
        assert!(params[0].default_value.is_some());
    }

    // Test 13: Parse mixed params
    #[test]
    fn test_parse_params_mixed() {
        let mut state = create_state("(x: i32, mut y, z = 5)");
        let result = parse_params(&mut state);
        assert!(result.is_ok());
        let params = result.unwrap();
        assert_eq!(params.len(), 3);
        assert!(!params[0].is_mutable);
        assert!(params[1].is_mutable);
        assert!(params[2].default_value.is_some());
    }

    // Test 14: Error on from keyword
    #[test]
    fn test_parse_params_from_keyword_error() {
        let mut state = create_state("(from)");
        let result = parse_params(&mut state);
        assert!(result.is_err());
        let err = result.unwrap_err().to_string();
        assert!(err.contains("reserved keyword"));
    }

    // Test 15: Error on invalid & pattern (not self)
    #[test]
    fn test_parse_params_ref_non_self_error() {
        let mut state = create_state("(&x)");
        let result = parse_params(&mut state);
        assert!(result.is_err());
    }

    // Test 16: Parse reference type param (not &self)
    #[test]
    fn test_parse_params_reference_type() {
        let mut state = create_state("(x: &str)");
        let result = parse_params(&mut state);
        assert!(result.is_ok());
        let params = result.unwrap();
        assert_eq!(params.len(), 1);
        assert!(matches!(&params[0].ty.kind, TypeKind::Reference { .. }));
    }

    // Test 17: check_and_consume_mut with mut
    #[test]
    fn test_check_and_consume_mut_true() {
        let mut state = create_state("mut x");
        let is_mut = check_and_consume_mut(&mut state);
        assert!(is_mut);
    }

    // Test 18: check_and_consume_mut without mut
    #[test]
    fn test_check_and_consume_mut_false() {
        let mut state = create_state("x");
        let is_mut = check_and_consume_mut(&mut state);
        assert!(!is_mut);
    }

    // Test 19: should_continue_param_list with comma
    #[test]
    fn test_should_continue_with_comma() {
        let mut state = create_state(", y");
        let result = should_continue_param_list(&mut state);
        assert!(result.is_ok());
        assert!(result.unwrap());
    }

    // Test 20: should_continue_param_list without comma
    #[test]
    fn test_should_continue_without_comma() {
        let mut state = create_state(")");
        let result = should_continue_param_list(&mut state);
        assert!(result.is_ok());
        assert!(!result.unwrap());
    }
}