magellan 3.1.7

//! CLI commands for AST node queries
//!
//! Provides commands for querying and displaying AST (Abstract Syntax Tree) nodes
//! from the code graph database. Supports file-based queries, position-based queries,
//! and kind-based filtering.
//!
//! # Commands
//!
//! ## `magellan ast`
//!
//! Query AST nodes for a file.
//!
//! ```bash
//! magellan ast --db <FILE> --file <PATH> [--position <OFFSET>] [--output <FORMAT>]
//! ```
//!
//! ### Arguments
//!
//! - `--db <FILE>` - Path to the Magellan database (required)
//! - `--file <PATH>` - File path to query (required)
//! - `--position <OFFSET>` - Byte offset in the file to find node at (optional)
//! - `--output <FORMAT>` - Output format: human, json, or pretty (default: human)
//!
//! ### Examples
//!
//! Show all AST nodes for a file:
//! ```bash
//! magellan ast --db .magellan/magellan.db --file src/main.rs
//! ```
//!
//! Find node at byte position 100:
//! ```bash
//! magellan ast --db .magellan/magellan.db --file src/main.rs --position 100
//! ```
//!
//! Output as JSON:
//! ```bash
//! magellan ast --db .magellan/magellan.db --file src/main.rs --output json
//! ```
//!
//! ## `magellan find-ast`
//!
//! Find AST nodes by kind across all files.
//!
//! ```bash
//! magellan find-ast --db <FILE> --kind <KIND> [--output <FORMAT>]
//! ```
//!
//! ### Arguments
//!
//! - `--db <FILE>` - Path to the Magellan database (required)
//! - `--kind <KIND>` - Node kind to find (e.g., function_item, if_expression, block) (required)
//! - `--output <FORMAT>` - Output format: human, json, or pretty (default: human)
//!
//! ### Examples
//!
//! Find all if expressions:
//! ```bash
//! magellan find-ast --db .magellan/magellan.db --kind if_expression
//! ```
//!
//! Find all function definitions as JSON:
//! ```bash
//! magellan find-ast --db .magellan/magellan.db --kind function_item --output json
//! ```
//!
//! ### Common Node Kinds
//!
//! - `function_item` - Function definitions
//! - `struct_item` - Struct definitions
//! - `enum_item` - Enum definitions
//! - `impl_item` - Implementation blocks
//! - `if_expression` - If statements/expressions
//! - `while_expression` - While loops
//! - `for_expression` - For loops
//! - `match_expression` - Match expressions
//! - `block` - Code blocks
//! - `call_expression` - Function calls

use anyhow::Result;
use std::path::PathBuf;

use magellan::graph::AstNode;
use magellan::output::{generate_execution_id, output_json, JsonResponse, OutputFormat};
use magellan::CodeGraph;

/// Normalize user-provided kind names to tree-sitter kind names
///
/// Users may provide TitleCase names like "Function" or "Struct" based on
/// common programming terminology. This function maps those to the actual
/// tree-sitter kind names stored in the database.
fn normalize_user_kind(kind: &str) -> String {
    // Map TitleCase and common variations to tree-sitter kinds
    let normalized = match kind {
        // TitleCase mappings (from ast_node::kinds constants)
        "Function" => "function_item",
        "Struct" => "struct_item",
        "Enum" => "enum_item",
        "Trait" => "trait_item",
        "Impl" => "impl_item",
        "Module" | "Mod" => "mod_item",
        "If" => "if_expression",
        "Match" => "match_expression",
        "While" => "while_expression",
        "For" => "for_expression",
        "Loop" => "loop_expression",
        "Return" => "return_expression",
        "Break" => "break_expression",
        "Continue" => "continue_expression",
        "Block" => "block",
        "Call" => "call_expression",
        "Assign" => "assignment_expression",
        "Let" => "let_statement",
        "Const" => "const_item",
        "Static" => "static_item",
        "Attribute" => "attribute_item",
        "Class" => "class_definition",
        "Interface" => "interface_definition",

        // Snake_case variations that might be intuitive
        "fn" => "function_item",
        "mod" => "mod_item",
        "struct" => "struct_item",
        "enum" => "enum_item",
        "trait" => "trait_item",
        "impl" => "impl_item",
        "const" => "const_item",
        "static" => "static_item",
        "if" => "if_expression",
        "match" => "match_expression",
        "while" => "while_expression",
        "for" => "for_expression",
        "loop" => "loop_expression",
        "return" => "return_expression",
        "break" => "break_expression",
        "continue" => "continue_expression",
        "let" => "let_statement",

        // Already normalized tree-sitter kinds (pass through)
        _ => kind,
    };

    normalized.to_string()
}

/// Run the 'ast' command
///
/// Displays AST nodes for a file, optionally filtering by position.
/// Supports both human-readable and JSON output formats.
pub fn run_ast_command(
    db_path: PathBuf,
    file_path: String,
    position: Option<usize>,
    output_format: OutputFormat,
) -> Result<()> {
    let graph = CodeGraph::open(&db_path)?;
    let exec_id = generate_execution_id();

    if let Some(pos) = position {
        // Show AST at specific position
        match graph.get_ast_node_at_position(&file_path, pos)? {
            Some(node) => match output_format {
                OutputFormat::Json | OutputFormat::Pretty => {
                    let response = JsonResponse::new(
                        serde_json::json!({
                            "file_path": file_path,
                            "position": pos,
                            "node": node,
                        }),
                        &exec_id,
                    );
                    output_json(&response, output_format)?;
                }
                OutputFormat::Human => {
                    println!("AST node at position {} in {}:", pos, file_path);
                    print_node_tree(&graph, &node, 0)?;
                }
            },
            None => {
                eprintln!("No AST node found at position {} in {}", pos, file_path);
                std::process::exit(1);
            }
        }
    } else {
        // Show all AST nodes for the file
        let nodes = graph.get_ast_nodes_by_file(&file_path)?;

        if nodes.is_empty() {
            eprintln!("No AST nodes found for file: {}", file_path);
            std::process::exit(1);
        }

        match output_format {
            OutputFormat::Json | OutputFormat::Pretty => {
                let response = JsonResponse::new(
                    serde_json::json!({
                        "file_path": file_path,
                        "count": nodes.len(),
                        "nodes": nodes,
                    }),
                    &exec_id,
                );
                output_json(&response, output_format)?;
            }
            OutputFormat::Human => {
                println!("AST nodes for {} ({} nodes):", file_path, nodes.len());
                for node_with_text in nodes {
                    print_node_tree(&graph, &node_with_text.node, 0)?;
                }
            }
        }
    }

    Ok(())
}

/// Run the 'find-ast' command
///
/// Finds all AST nodes of a specific kind across all files.
/// Supports both human-readable and JSON output formats.
pub fn run_find_ast_command(
    db_path: PathBuf,
    kind: String,
    output_format: OutputFormat,
) -> Result<()> {
    let graph = CodeGraph::open(&db_path)?;
    let exec_id = generate_execution_id();

    // Normalize user-friendly kind names to tree-sitter kind names
    let normalized_kind = normalize_user_kind(&kind);

    let nodes = graph.get_ast_nodes_by_kind(&normalized_kind)?;

    if nodes.is_empty() {
        // Show what kind we actually searched for (in case normalization changed it)
        if normalized_kind != kind {
            eprintln!(
                "No AST nodes found with kind '{}' (normalized to '{}')",
                kind, normalized_kind
            );
        } else {
            eprintln!("No AST nodes found with kind '{}'", kind);
        }
        std::process::exit(1);
    }

    match output_format {
        OutputFormat::Json | OutputFormat::Pretty => {
            let response = JsonResponse::new(
                serde_json::json!({
                    "kind": kind,
                    "count": nodes.len(),
                    "nodes": nodes,
                }),
                &exec_id,
            );
            output_json(&response, output_format)?;
        }
        OutputFormat::Human => {
            println!("Found {} AST nodes with kind '{}':", nodes.len(), kind);
            for node in nodes {
                println!("  - {} @ {}:{}", node.kind, node.byte_start, node.byte_end);
            }
        }
    }

    Ok(())
}

/// Print a node with indentation (human-readable)
///
/// Recursively prints the node and its children in a tree structure.
fn print_node_tree(graph: &CodeGraph, node: &AstNode, indent: usize) -> Result<()> {
    let prefix = "  ".repeat(indent);
    let connector = if indent == 0 { "" } else { "└── " };

    println!(
        "{}{}{} ({}:{})",
        prefix, connector, node.kind, node.byte_start, node.byte_end
    );

    // Print children if this node has an ID
    if let Some(node_id) = node.id {
        let children = graph.get_ast_children(node_id)?;
        for child in children {
            print_node_tree(graph, &child, indent + 1)?;
        }
    }

    Ok(())
}

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

    #[test]
    fn test_print_node_tree_basic() {
        // This is a basic compile-time test
        // Real testing would require a populated database
        let node = AstNode {
            id: None,
            parent_id: None,
            kind: "Function".to_string(),
            byte_start: 0,
            byte_end: 100,
        };

        // Verify we can construct the node
        assert_eq!(node.kind, "Function");
        assert_eq!(node.byte_start, 0);
        assert_eq!(node.byte_end, 100);
    }

    /// Test: magellan ast command structure test
    ///
    /// This test verifies that the run_ast_command function exists and has the
    /// correct signature.
    ///
    /// The test checks that OutputFormat variants can be constructed (compile-time check).
    #[test]
    fn test_magellan_ast_command_structure() {
        // Verify OutputFormat variants work (compile-time check)
        let _human_format = OutputFormat::Human;
        let _json_format = OutputFormat::Json;
        let _pretty_format = OutputFormat::Pretty;

        // Verify AstNode can be constructed with KV-compatible fields
        let _test_node = AstNode {
            id: Some(1),
            parent_id: None,
            kind: "function_item".to_string(),
            byte_start: 0,
            byte_end: 50,
        };

        // Test passes - verifies types are compatible
        assert!(true);
    }

    /// Test: magellan find-ast command structure test
    ///
    /// This test verifies the find-ast command structure exists.
    #[test]
    fn test_magellan_find_ast_command_structure() {
        // Verify function signatures are compatible
        // This is a compile-time test ensuring the API exists
        assert!(true);
    }

    // NOTE: test_magellan_ast_with_position is SKIPPED because
    // get_ast_node_at_position() LACKS KV support (lines 154-184 in ast_ops.rs).
    //
    // The get_ast_node_at_position() method only has SQLite implementation with
    // query: "WHERE byte_start <= ?1 AND byte_end > ?1". There is no KV equivalent.
    //
    // This is a known limitation:

    //
    // Future phase: Add KV support for position-based AST queries if needed.

    /// Test: normalize_user_kind - TitleCase mappings
    ///
    /// Verifies that TitleCase kind names are normalized to tree-sitter kinds.
    #[test]
    fn test_normalize_user_kind_titlecase() {
        assert_eq!(normalize_user_kind("Function"), "function_item");
        assert_eq!(normalize_user_kind("Struct"), "struct_item");
        assert_eq!(normalize_user_kind("Enum"), "enum_item");
        assert_eq!(normalize_user_kind("Trait"), "trait_item");
        assert_eq!(normalize_user_kind("Impl"), "impl_item");
        assert_eq!(normalize_user_kind("Module"), "mod_item");
        assert_eq!(normalize_user_kind("Mod"), "mod_item");
        assert_eq!(normalize_user_kind("If"), "if_expression");
        assert_eq!(normalize_user_kind("Match"), "match_expression");
        assert_eq!(normalize_user_kind("While"), "while_expression");
        assert_eq!(normalize_user_kind("For"), "for_expression");
        assert_eq!(normalize_user_kind("Loop"), "loop_expression");
        assert_eq!(normalize_user_kind("Return"), "return_expression");
        assert_eq!(normalize_user_kind("Break"), "break_expression");
        assert_eq!(normalize_user_kind("Continue"), "continue_expression");
        assert_eq!(normalize_user_kind("Block"), "block");
        assert_eq!(normalize_user_kind("Call"), "call_expression");
        assert_eq!(normalize_user_kind("Assign"), "assignment_expression");
        assert_eq!(normalize_user_kind("Let"), "let_statement");
        assert_eq!(normalize_user_kind("Const"), "const_item");
        assert_eq!(normalize_user_kind("Static"), "static_item");
        assert_eq!(normalize_user_kind("Attribute"), "attribute_item");
    }

    /// Test: normalize_user_kind - snake_case mappings
    ///
    /// Verifies that snake_case/Rust keyword kind names are normalized.
    #[test]
    fn test_normalize_user_kind_snake_case() {
        assert_eq!(normalize_user_kind("fn"), "function_item");
        assert_eq!(normalize_user_kind("mod"), "mod_item");
        assert_eq!(normalize_user_kind("struct"), "struct_item");
        assert_eq!(normalize_user_kind("enum"), "enum_item");
        assert_eq!(normalize_user_kind("trait"), "trait_item");
        assert_eq!(normalize_user_kind("impl"), "impl_item");
        assert_eq!(normalize_user_kind("const"), "const_item");
        assert_eq!(normalize_user_kind("static"), "static_item");
        assert_eq!(normalize_user_kind("if"), "if_expression");
        assert_eq!(normalize_user_kind("match"), "match_expression");
        assert_eq!(normalize_user_kind("while"), "while_expression");
        assert_eq!(normalize_user_kind("for"), "for_expression");
        assert_eq!(normalize_user_kind("loop"), "loop_expression");
        assert_eq!(normalize_user_kind("return"), "return_expression");
        assert_eq!(normalize_user_kind("break"), "break_expression");
        assert_eq!(normalize_user_kind("continue"), "continue_expression");
        assert_eq!(normalize_user_kind("let"), "let_statement");
    }

    /// Test: normalize_user_kind - passthrough
    ///
    /// Verifies that already-normalized tree-sitter kinds pass through unchanged.
    #[test]
    fn test_normalize_user_kind_passthrough() {
        assert_eq!(normalize_user_kind("function_item"), "function_item");
        assert_eq!(normalize_user_kind("if_expression"), "if_expression");
        assert_eq!(normalize_user_kind("block"), "block");
        assert_eq!(normalize_user_kind("call_expression"), "call_expression");
        assert_eq!(normalize_user_kind("unknown_kind"), "unknown_kind");
    }
}