aspect-core 0.1.0

Core traits and types for aspect-oriented programming in Rust
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
//! Parser for pointcut expressions.
//!
//! Parses pointcut strings like:
//! - `execution(pub fn *(..))`
//! - `within(crate::api)`
//! - `execution(pub fn *(..)) && within(crate::api)`
//! - `(execution(pub fn *(..)) || within(crate::admin)) && !within(crate::internal)`

use super::ast::Pointcut;
use super::pattern::{ExecutionPattern, ModulePattern, NamePattern, Visibility};

/// Parse a pointcut expression from a string.
///
/// # Examples
///
/// ```rust
/// use aspect_core::pointcut::parse_pointcut;
///
/// let pc = parse_pointcut("execution(pub fn *(..))").unwrap();
/// let pc = parse_pointcut("within(crate::api)").unwrap();
/// let pc = parse_pointcut("execution(pub fn *(..)) && within(crate::api)").unwrap();
/// ```
pub fn parse_pointcut(input: &str) -> Result<Pointcut, String> {
    let input = input.trim();

    // Handle parentheses for grouping
    if input.starts_with('(') && input.ends_with(')') {
        // Check if this is a balanced outer parenthesis
        if let Some(inner) = strip_outer_parens(input) {
            return parse_pointcut(inner);
        }
    }

    // Handle NOT operator (highest precedence)
    if input.starts_with('!') {
        let inner = parse_pointcut(input[1..].trim())?;
        return Ok(Pointcut::Not(Box::new(inner)));
    }

    // Handle OR operator (lowest precedence)
    if let Some(or_pos) = find_operator(input, " || ") {
        let left = parse_pointcut(&input[..or_pos])?;
        let right = parse_pointcut(&input[or_pos + 4..])?;
        return Ok(Pointcut::Or(Box::new(left), Box::new(right)));
    }

    // Handle AND operator (medium precedence)
    if let Some(and_pos) = find_operator(input, " && ") {
        let left = parse_pointcut(&input[..and_pos])?;
        let right = parse_pointcut(&input[and_pos + 4..])?;
        return Ok(Pointcut::And(Box::new(left), Box::new(right)));
    }

    // Parse basic pointcuts
    if input.starts_with("execution(") {
        parse_execution(input)
    } else if input.starts_with("within(") {
        parse_within(input)
    } else {
        Err(format!("Unknown pointcut type: {}", input))
    }
}

/// Strip outer parentheses if they are balanced and wrap the entire expression.
fn strip_outer_parens(input: &str) -> Option<&str> {
    if !input.starts_with('(') || !input.ends_with(')') {
        return None;
    }

    let inner = &input[1..input.len() - 1];

    // Check if the parentheses are balanced for the entire inner content
    let mut depth = 0;
    for ch in inner.chars() {
        match ch {
            '(' => depth += 1,
            ')' => {
                depth -= 1;
                if depth < 0 {
                    return None; // Unbalanced
                }
            }
            _ => {}
        }
    }

    if depth == 0 {
        Some(inner)
    } else {
        None
    }
}

/// Find an operator outside of parentheses.
/// Returns the position of the operator, or None if not found.
fn find_operator(input: &str, operator: &str) -> Option<usize> {
    let mut depth = 0;
    let op_len = operator.len();
    let chars: Vec<char> = input.chars().collect();

    for i in 0..chars.len() {
        match chars[i] {
            '(' => depth += 1,
            ')' => depth -= 1,
            _ => {
                if depth == 0 && i + op_len <= chars.len() {
                    let slice: String = chars[i..i + op_len].iter().collect();
                    if slice == operator {
                        return Some(i);
                    }
                }
            }
        }
    }

    None
}

/// Parse an execution pointcut: `execution(pub fn save(..))`
fn parse_execution(input: &str) -> Result<Pointcut, String> {
    if !input.starts_with("execution(") || !input.ends_with(')') {
        return Err("Invalid execution syntax".to_string());
    }

    let content = &input[10..input.len() - 1].trim();

    // Parse visibility
    let (visibility, rest) = parse_visibility(content);

    // Expect "fn" keyword
    let rest = rest.trim();
    if !rest.starts_with("fn ") {
        return Err("Expected 'fn' keyword".to_string());
    }
    let rest = &rest[3..].trim();

    // Parse function name pattern
    let name = if let Some(paren_pos) = rest.find('(') {
        &rest[..paren_pos].trim()
    } else {
        return Err("Expected function signature".to_string());
    };

    let name_pattern = parse_name_pattern(name);

    // TODO: Parse parameters and return type

    Ok(Pointcut::Execution(ExecutionPattern {
        visibility,
        name: name_pattern,
        return_type: None,
    }))
}

/// Parse a within pointcut: `within(crate::api)`
fn parse_within(input: &str) -> Result<Pointcut, String> {
    if !input.starts_with("within(") || !input.ends_with(')') {
        return Err("Invalid within syntax".to_string());
    }

    let module_path = input[7..input.len() - 1].trim();

    Ok(Pointcut::Within(ModulePattern {
        path: module_path.to_string(),
    }))
}

/// Parse visibility from the beginning of a string.
/// Returns (Option<Visibility>, remaining_string)
fn parse_visibility(input: &str) -> (Option<Visibility>, &str) {
    if input.starts_with("pub(crate) ") {
        (Some(Visibility::Crate), &input[11..])
    } else if input.starts_with("pub(super) ") {
        (Some(Visibility::Super), &input[11..])
    } else if input.starts_with("pub ") {
        (Some(Visibility::Public), &input[4..])
    } else {
        (None, input)
    }
}

/// Parse a name pattern (exact, wildcard, prefix, suffix).
fn parse_name_pattern(name: &str) -> NamePattern {
    if name == "*" {
        NamePattern::Wildcard
    } else if name.starts_with('*') && name.ends_with('*') && name.len() > 2 {
        NamePattern::Contains(name[1..name.len() - 1].to_string())
    } else if name.starts_with('*') {
        NamePattern::Suffix(name[1..].to_string())
    } else if name.ends_with('*') {
        NamePattern::Prefix(name[..name.len() - 1].to_string())
    } else {
        NamePattern::Exact(name.to_string())
    }
}

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

    #[test]
    fn test_parse_execution_wildcard() {
        let pc = parse_pointcut("execution(pub fn *(..))").unwrap();
        match pc {
            Pointcut::Execution(pattern) => {
                assert_eq!(pattern.visibility, Some(Visibility::Public));
                assert_eq!(pattern.name, NamePattern::Wildcard);
            }
            _ => panic!("Expected Execution pointcut"),
        }
    }

    #[test]
    fn test_parse_execution_exact_name() {
        let pc = parse_pointcut("execution(fn save_user(..))").unwrap();
        match pc {
            Pointcut::Execution(pattern) => {
                assert_eq!(pattern.visibility, None);
                assert_eq!(pattern.name, NamePattern::Exact("save_user".to_string()));
            }
            _ => panic!("Expected Execution pointcut"),
        }
    }

    #[test]
    fn test_parse_execution_prefix() {
        let pc = parse_pointcut("execution(pub fn save*(..))").unwrap();
        match pc {
            Pointcut::Execution(pattern) => {
                assert_eq!(pattern.name, NamePattern::Prefix("save".to_string()));
            }
            _ => panic!("Expected Execution pointcut"),
        }
    }

    #[test]
    fn test_parse_within() {
        let pc = parse_pointcut("within(crate::api)").unwrap();
        match pc {
            Pointcut::Within(pattern) => {
                assert_eq!(pattern.path, "crate::api");
            }
            _ => panic!("Expected Within pointcut"),
        }
    }

    #[test]
    fn test_parse_and() {
        let pc = parse_pointcut("execution(pub fn *(..)) && within(crate::api)").unwrap();
        match pc {
            Pointcut::And(left, right) => {
                assert!(matches!(*left, Pointcut::Execution(_)));
                assert!(matches!(*right, Pointcut::Within(_)));
            }
            _ => panic!("Expected And pointcut"),
        }
    }

    #[test]
    fn test_parse_or() {
        let pc = parse_pointcut("execution(fn save(..)) || execution(fn update(..))").unwrap();
        match pc {
            Pointcut::Or(_, _) => {}
            _ => panic!("Expected Or pointcut"),
        }
    }

    #[test]
    fn test_parse_not() {
        let pc = parse_pointcut("!within(crate::internal)").unwrap();
        match pc {
            Pointcut::Not(inner) => {
                assert!(matches!(*inner, Pointcut::Within(_)));
            }
            _ => panic!("Expected Not pointcut"),
        }
    }

    #[test]
    fn test_parse_parentheses() {
        let pc = parse_pointcut("(execution(pub fn *(..)))").unwrap();
        assert!(matches!(pc, Pointcut::Execution(_)));
    }

    #[test]
    fn test_parse_complex_with_parentheses() {
        // (A || B) && C should parse as AND with OR on the left
        let pc = parse_pointcut(
            "(execution(pub fn *(..)) || within(crate::admin)) && within(crate::api)",
        )
        .unwrap();

        match pc {
            Pointcut::And(left, right) => {
                assert!(matches!(*left, Pointcut::Or(_, _)));
                assert!(matches!(*right, Pointcut::Within(_)));
            }
            _ => panic!("Expected And with Or on left"),
        }
    }

    #[test]
    fn test_parse_operator_precedence() {
        // Without parens: A || B && C should parse as A || (B && C)
        // because AND has higher precedence than OR
        let pc1 = parse_pointcut(
            "execution(fn a(..)) || execution(fn b(..)) && within(crate::api)",
        )
        .unwrap();

        match pc1 {
            Pointcut::Or(left, right) => {
                assert!(matches!(*left, Pointcut::Execution(_)));
                assert!(matches!(*right, Pointcut::And(_, _)));
            }
            _ => panic!("Expected Or with And on right"),
        }
    }

    #[test]
    fn test_parse_nested_parentheses() {
        let pc = parse_pointcut("((execution(pub fn *(..))))").unwrap();
        assert!(matches!(pc, Pointcut::Execution(_)));
    }

    // Property-based tests
    #[cfg(test)]
    mod proptests {
        use super::*;
        use proptest::prelude::*;

        // Generate valid function names
        fn arb_function_name() -> impl Strategy<Value = String> {
            prop::string::string_regex("[a-z_][a-z0-9_]*").unwrap()
        }

        // Generate valid module paths
        fn arb_module_path() -> impl Strategy<Value = String> {
            prop::collection::vec(arb_function_name(), 1..5)
                .prop_map(|parts| format!("crate::{}", parts.join("::")))
        }

        // Generate valid visibility
        fn arb_visibility() -> impl Strategy<Value = &'static str> {
            prop_oneof![
                Just("pub"),
                Just("pub(crate)"),
                Just("pub(super)"),
                Just(""),
            ]
        }

        proptest! {
            #[test]
            fn parse_execution_never_panics(
                vis in arb_visibility(),
                name in arb_function_name()
            ) {
                let expr = if vis.is_empty() {
                    format!("execution(fn {}(..))", name)
                } else {
                    format!("execution({} fn {}(..))", vis, name)
                };
                // Should either parse or return error, never panic
                let _ = parse_pointcut(&expr);
            }

            #[test]
            fn parse_within_never_panics(path in arb_module_path()) {
                let expr = format!("within({})", path);
                let _ = parse_pointcut(&expr);
            }

            #[test]
            fn parse_and_is_associative(
                name1 in arb_function_name(),
                name2 in arb_function_name(),
                path in arb_module_path()
            ) {
                let expr = format!(
                    "execution(fn {}(..)) && execution(fn {}(..)) && within({})",
                    name1, name2, path
                );
                // Should parse successfully
                prop_assert!(parse_pointcut(&expr).is_ok());
            }

            #[test]
            fn parse_with_random_parentheses(
                name in arb_function_name(),
                extra_parens in 0usize..3
            ) {
                let mut expr = format!("execution(fn {}(..))", name);
                for _ in 0..extra_parens {
                    expr = format!("({})", expr);
                }
                // Should parse successfully
                prop_assert!(parse_pointcut(&expr).is_ok());
            }

            #[test]
            fn roundtrip_basic_patterns(
                vis in arb_visibility(),
                name in arb_function_name()
            ) {
                let expr = if vis.is_empty() {
                    format!("execution(fn {}(..))", name)
                } else {
                    format!("execution({} fn {}(..))", vis, name)
                };

                if let Ok(pc) = parse_pointcut(&expr) {
                    // Should be an Execution pointcut
                    prop_assert!(matches!(pc, Pointcut::Execution(_)));
                }
            }
        }
    }
}