scribe-analysis 0.5.1

Code analysis algorithms and AST processing for Scribe
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
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
//! # Function and Class Extraction from AST
//!
//! Extracts function definitions, class definitions, and methods from source code
//! using tree-sitter AST parsing for accurate analysis.

use super::ast_language::AstLanguage;
use scribe_core::{Result, ScribeError};
use serde::{Deserialize, Serialize};
use tree_sitter::{Language, Node, Parser, Query, QueryCursor, Tree};

/// Information about a function extracted from source code
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FunctionInfo {
    /// Function name
    pub name: String,
    /// Line number where function starts
    pub start_line: usize,
    /// Line number where function ends
    pub end_line: usize,
    /// Function parameters
    pub parameters: Vec<String>,
    /// Return type (if available)
    pub return_type: Option<String>,
    /// Documentation/docstring
    pub documentation: Option<String>,
    /// Function visibility (public, private, etc.)
    pub visibility: Option<String>,
    /// Whether this is a method (inside a class)
    pub is_method: bool,
    /// Parent class name (if this is a method)
    pub parent_class: Option<String>,
}

/// Information about a class extracted from source code
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ClassInfo {
    /// Class name
    pub name: String,
    /// Line number where class starts
    pub start_line: usize,
    /// Line number where class ends
    pub end_line: usize,
    /// Parent classes/interfaces
    pub parents: Vec<String>,
    /// Documentation/docstring
    pub documentation: Option<String>,
    /// Class visibility
    pub visibility: Option<String>,
    /// Methods in this class
    pub methods: Vec<FunctionInfo>,
}

/// Extracts functions and classes from source code using tree-sitter
pub struct FunctionExtractor {
    language: AstLanguage,
    parser: Parser,
    function_query: Option<Query>,
    class_query: Option<Query>,
}

impl FunctionExtractor {
    /// Create a new function extractor for the given language
    pub fn new(language: AstLanguage) -> Result<Self> {
        let mut parser = Parser::new();

        // Set up tree-sitter language if available
        let (function_query, class_query) =
            if let Some(ts_language) = language.tree_sitter_language() {
                parser
                    .set_language(ts_language)
                    .map_err(|e| ScribeError::Analysis {
                        message: format!("Failed to set tree-sitter language: {}", e),
                        source: None,
                        file: std::path::PathBuf::from("<unknown>"),
                    })?;

                let function_query = Self::create_function_query(language, ts_language)?;
                let class_query = Self::create_class_query(language, ts_language)?;
                (function_query, class_query)
            } else {
                (None, None)
            };

        Ok(Self {
            language,
            parser,
            function_query,
            class_query,
        })
    }

    /// Create tree-sitter query for finding functions
    fn create_function_query(
        language: AstLanguage,
        ts_language: Language,
    ) -> Result<Option<Query>> {
        let query_string = match language {
            AstLanguage::Python => {
                r#"
                (function_definition) @function.definition
            "#
            }
            AstLanguage::JavaScript | AstLanguage::TypeScript => {
                r#"
                (function_declaration) @function.definition
                (method_definition) @function.definition
            "#
            }
            AstLanguage::Rust => {
                r#"
                (function_item) @function.definition
            "#
            }
            AstLanguage::Go => {
                r#"
                (function_declaration) @function.definition
                (method_declaration) @function.definition
            "#
            }
            // Future languages - placeholder queries
            AstLanguage::Java => {
                r#"
                (method_declaration) @function.definition
            "#
            }
            AstLanguage::C | AstLanguage::Cpp => {
                r#"
                (function_definition) @function.definition
            "#
            }
            AstLanguage::Ruby => {
                r#"
                (method) @function.definition
            "#
            }
            AstLanguage::CSharp => {
                r#"
                (method_declaration) @function.definition
            "#
            }
            _ => return Ok(None),
        };

        Query::new(ts_language, query_string)
            .map(Some)
            .map_err(|e| ScribeError::Analysis {
                message: format!("Failed to create function query: {}", e),
                source: None,
                file: std::path::PathBuf::from("<unknown>"),
            })
    }

    /// Create tree-sitter query for finding classes
    fn create_class_query(language: AstLanguage, ts_language: Language) -> Result<Option<Query>> {
        let query_string = match language {
            AstLanguage::Python => {
                r#"
                (class_definition) @class.definition
            "#
            }
            AstLanguage::JavaScript | AstLanguage::TypeScript => {
                r#"
                (class_declaration) @class.definition
            "#
            }
            AstLanguage::Rust => {
                r#"
                (struct_item) @class.definition
            "#
            }
            AstLanguage::Go => {
                r#"
                (type_declaration) @class.definition
            "#
            }
            // Future languages - placeholder queries
            AstLanguage::Java => {
                r#"
                (class_declaration) @class.definition
            "#
            }
            AstLanguage::Cpp => {
                r#"
                (class_specifier) @class.definition
            "#
            }
            AstLanguage::Ruby => {
                r#"
                (class) @class.definition
            "#
            }
            AstLanguage::CSharp => {
                r#"
                (class_declaration) @class.definition
            "#
            }
            _ => return Ok(None),
        };

        Query::new(ts_language, query_string)
            .map(Some)
            .map_err(|e| ScribeError::Analysis {
                message: format!("Failed to create class query: {}", e),
                source: None,
                file: std::path::PathBuf::from("<unknown>"),
            })
    }

    /// Extract all functions from source code
    pub fn extract_functions(&mut self, content: &str) -> Result<Vec<FunctionInfo>> {
        let tree = self
            .parser
            .parse(content, None)
            .ok_or_else(|| ScribeError::Analysis {
                message: "Failed to parse source code".to_string(),
                source: None,
                file: std::path::PathBuf::from("<unknown>"),
            })?;

        let mut functions = Vec::new();

        if let Some(query) = &self.function_query {
            let mut query_cursor = QueryCursor::new();
            let matches = query_cursor.matches(query, tree.root_node(), content.as_bytes());

            for query_match in matches {
                if let Some(function_info) =
                    self.extract_function_from_match(&query_match, content, &tree)?
                {
                    functions.push(function_info);
                }
            }
        }

        Ok(functions)
    }

    /// Extract all classes from source code
    pub fn extract_classes(&mut self, content: &str) -> Result<Vec<ClassInfo>> {
        let tree = self
            .parser
            .parse(content, None)
            .ok_or_else(|| ScribeError::Analysis {
                message: "Failed to parse source code".to_string(),
                source: None,
                file: std::path::PathBuf::from("<unknown>"),
            })?;

        let mut classes = Vec::new();

        if let Some(query) = &self.class_query {
            let mut query_cursor = QueryCursor::new();
            let matches = query_cursor.matches(query, tree.root_node(), content.as_bytes());

            for query_match in matches {
                if let Some(class_info) =
                    self.extract_class_from_match(&query_match, content, &tree)?
                {
                    classes.push(class_info);
                }
            }
        }

        Ok(classes)
    }

    /// Extract function information from a query match
    fn extract_function_from_match(
        &self,
        query_match: &tree_sitter::QueryMatch,
        content: &str,
        tree: &Tree,
    ) -> Result<Option<FunctionInfo>> {
        for capture in query_match.captures {
            let node = capture.node;
            let start_line = node.start_position().row + 1;
            let end_line = node.end_position().row + 1;

            // Extract function name from the AST node structure
            let name = self.extract_function_name(node, content);
            let parameters = self.extract_function_parameters(node, content);

            if let Some(function_name) = name {
                return Ok(Some(FunctionInfo {
                    name: function_name,
                    start_line,
                    end_line,
                    parameters,
                    return_type: None,   // TODO: Extract return type
                    documentation: None, // TODO: Extract documentation
                    visibility: None,    // TODO: Extract visibility
                    is_method: false,    // TODO: Determine if method
                    parent_class: None,  // TODO: Find parent class
                }));
            }
        }
        Ok(None)
    }

    /// Extract class information from a query match
    fn extract_class_from_match(
        &self,
        query_match: &tree_sitter::QueryMatch,
        content: &str,
        tree: &Tree,
    ) -> Result<Option<ClassInfo>> {
        for capture in query_match.captures {
            let node = capture.node;
            let start_line = node.start_position().row + 1;
            let end_line = node.end_position().row + 1;

            // Extract class name from the AST node structure
            let name = self.extract_class_name(node, content);
            let parents = self.extract_class_parents(node, content);

            if let Some(class_name) = name {
                return Ok(Some(ClassInfo {
                    name: class_name,
                    start_line,
                    end_line,
                    parents,
                    documentation: None, // TODO: Extract documentation
                    visibility: None,    // TODO: Extract visibility
                    methods: Vec::new(), // TODO: Extract methods
                }));
            }
        }
        Ok(None)
    }

    /// Extract function name from AST node
    fn extract_function_name(&self, node: Node, content: &str) -> Option<String> {
        // Look for identifier child nodes that represent the function name
        let mut cursor = node.walk();
        cursor.goto_first_child();

        loop {
            let child = cursor.node();
            match child.kind() {
                "identifier" => {
                    if let Ok(name) = child.utf8_text(content.as_bytes()) {
                        return Some(name.to_string());
                    }
                }
                _ => {}
            }

            if !cursor.goto_next_sibling() {
                break;
            }
        }
        None
    }

    /// Extract function parameters from AST node
    fn extract_function_parameters(&self, node: Node, content: &str) -> Vec<String> {
        let mut parameters = Vec::new();
        let mut cursor = node.walk();
        cursor.goto_first_child();

        loop {
            let child = cursor.node();
            match child.kind() {
                "parameters" | "parameter_list" => {
                    // Extract parameter names from parameter list
                    let mut param_cursor = child.walk();
                    param_cursor.goto_first_child();

                    loop {
                        let param_node = param_cursor.node();
                        if param_node.kind() == "identifier" {
                            if let Ok(param_name) = param_node.utf8_text(content.as_bytes()) {
                                if param_name != "self" {
                                    parameters.push(param_name.to_string());
                                }
                            }
                        }

                        if !param_cursor.goto_next_sibling() {
                            break;
                        }
                    }
                    break;
                }
                _ => {}
            }

            if !cursor.goto_next_sibling() {
                break;
            }
        }
        parameters
    }

    /// Extract class name from AST node
    fn extract_class_name(&self, node: Node, content: &str) -> Option<String> {
        // Look for identifier child nodes that represent the class name
        let mut cursor = node.walk();
        cursor.goto_first_child();

        loop {
            let child = cursor.node();
            match child.kind() {
                "identifier" | "type_identifier" => {
                    if let Ok(name) = child.utf8_text(content.as_bytes()) {
                        return Some(name.to_string());
                    }
                }
                _ => {}
            }

            if !cursor.goto_next_sibling() {
                break;
            }
        }
        None
    }

    /// Extract class parent classes from AST node
    fn extract_class_parents(&self, node: Node, content: &str) -> Vec<String> {
        let mut parents = Vec::new();
        let mut cursor = node.walk();
        cursor.goto_first_child();

        loop {
            let child = cursor.node();
            match child.kind() {
                "argument_list" | "superclass" | "inheritance" => {
                    // Extract parent class names
                    let mut parent_cursor = child.walk();
                    parent_cursor.goto_first_child();

                    loop {
                        let parent_node = parent_cursor.node();
                        if parent_node.kind() == "identifier"
                            || parent_node.kind() == "type_identifier"
                        {
                            if let Ok(parent_name) = parent_node.utf8_text(content.as_bytes()) {
                                parents.push(parent_name.to_string());
                            }
                        }

                        if !parent_cursor.goto_next_sibling() {
                            break;
                        }
                    }
                }
                _ => {}
            }

            if !cursor.goto_next_sibling() {
                break;
            }
        }
        parents
    }

    /// Extract parameter names from parameter list text
    fn extract_parameters(&self, params_text: &str, _node: Node) -> Vec<String> {
        // Simple parameter extraction - can be improved per language
        params_text
            .split(',')
            .filter_map(|param| {
                let param = param.trim();
                if param.is_empty() || param == "self" {
                    None
                } else {
                    // Extract just the parameter name (before type annotations)
                    let name = param.split(':').next().unwrap_or(param).trim();
                    if name.is_empty() {
                        None
                    } else {
                        Some(name.to_string())
                    }
                }
            })
            .collect()
    }

    /// Extract parent class names from inheritance clause
    fn extract_parent_classes(&self, parents_text: &str) -> Vec<String> {
        // Simple parent class extraction - can be improved per language
        parents_text
            .split(',')
            .filter_map(|parent| {
                let parent = parent.trim();
                if parent.is_empty() {
                    None
                } else {
                    Some(parent.to_string())
                }
            })
            .collect()
    }
}

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

    #[test]
    fn test_function_extractor_creation() {
        let extractor = FunctionExtractor::new(AstLanguage::Python);
        assert!(extractor.is_ok());
    }

    #[test]
    fn test_python_function_extraction() {
        let mut extractor = FunctionExtractor::new(AstLanguage::Python).unwrap();
        let python_code = r#"
def hello_world():
    """A simple function."""
    print("Hello, World!")

def add_numbers(a, b):
    """Add two numbers together."""
    return a + b

class Calculator:
    """A simple calculator."""
    
    def multiply(self, x, y):
        """Multiply two numbers."""
        return x * y
"#;

        let functions = extractor.extract_functions(python_code).unwrap();
        assert!(!functions.is_empty());

        // Should find at least the standalone functions
        let function_names: Vec<&String> = functions.iter().map(|f| &f.name).collect();
        assert!(function_names.contains(&&"hello_world".to_string()));
        assert!(function_names.contains(&&"add_numbers".to_string()));
    }

    #[test]
    fn test_python_class_extraction() {
        let mut extractor = FunctionExtractor::new(AstLanguage::Python).unwrap();
        let python_code = r#"
class Calculator:
    """A simple calculator."""
    pass

class AdvancedCalculator(Calculator):
    """An advanced calculator that inherits from Calculator."""
    pass
"#;

        let classes = extractor.extract_classes(python_code).unwrap();
        assert!(!classes.is_empty());

        let class_names: Vec<&String> = classes.iter().map(|c| &c.name).collect();
        assert!(class_names.contains(&&"Calculator".to_string()));
        assert!(class_names.contains(&&"AdvancedCalculator".to_string()));
    }

    #[test]
    fn test_javascript_function_extraction() {
        let mut extractor = FunctionExtractor::new(AstLanguage::JavaScript).unwrap();
        let js_code = r#"
function greetUser(name) {
    return `Hello, ${name}!`;
}

class UserManager {
    constructor() {
        this.users = [];
    }
    
    addUser(user) {
        this.users.push(user);
    }
}
"#;

        let functions = extractor.extract_functions(js_code).unwrap();
        assert!(!functions.is_empty());
    }
}