formualizer-eval 0.7.0

//! crates/formualizer-eval/src/test_workbook.rs
//! --------------------------------------------
//! Lightweight in-memory workbook for unit/prop tests.
use std::collections::HashMap;
use std::sync::Arc;

use crate::engine::range_view::RangeView;
use crate::function::Function;
use crate::traits::{
    EvaluationContext, FunctionProvider, NamedRangeResolver, Range, RangeResolver,
    ReferenceResolver, Resolver, SourceResolver, Table, TableResolver,
};
use formualizer_common::{ExcelError, LiteralValue, parse_a1_1based};
use formualizer_parse::{
    ExcelErrorKind,
    parser::{ReferenceType, TableReference},
};

type V = LiteralValue;
type CellKey = (u32, u32); // 1-based (row, col)

#[derive(Default, Clone)]
struct Sheet {
    cells: HashMap<CellKey, V>,
}

#[derive(Default)]
pub struct TestWorkbook {
    sheets: HashMap<String, Sheet>,
    named: HashMap<String, Vec<Vec<V>>>,
    tables: HashMap<String, Box<dyn Table>>,
    fns: HashMap<(String, String), Arc<dyn Function>>,
    aliases: HashMap<(String, String), (String, String)>,
}

impl TestWorkbook {
    /* ─────────────── constructors ─────────────── */
    pub fn new() -> Self {
        Self::default()
    }

    fn default_sheet_name(&self) -> &str {
        const FALLBACK: &str = "Sheet1";
        if self.sheets.contains_key(FALLBACK) {
            return FALLBACK;
        }
        self.sheets
            .keys()
            .min()
            .map(|s| s.as_str())
            .unwrap_or(FALLBACK)
    }

    /* ─────────────── cell helpers ─────────────── */
    pub fn with_cell<S: Into<String>>(mut self, sheet: S, row: u32, col: u32, v: V) -> Self {
        let sh = self.sheets.entry(sheet.into()).or_default();
        sh.cells.insert((row, col), v);
        self
    }

    pub fn with_cell_a1<S: Into<String>, A: AsRef<str>>(self, sheet: S, a1: A, v: V) -> Self {
        let (col, row) = parse_a1(a1.as_ref()).expect("bad A1 ref in with_cell_a1");
        self.with_cell(sheet, row, col, v)
    }

    pub fn with_range<S: Into<String>>(
        mut self,
        sheet: S,
        row: u32,
        col: u32,
        data: Vec<Vec<V>>,
    ) -> Self {
        let sh = self.sheets.entry(sheet.into()).or_default();
        for (r_off, r) in data.into_iter().enumerate() {
            for (c_off, v) in r.into_iter().enumerate() {
                sh.cells.insert((row + r_off as u32, col + c_off as u32), v);
            }
        }
        self
    }

    /* ─────────────── named ranges ─────────────── */
    pub fn with_named_range<S: Into<String>>(mut self, name: S, data: Vec<Vec<V>>) -> Self {
        self.named.insert(name.into(), data);
        self
    }

    /* ─────────────── tables (placeholder) ─────── */
    pub fn with_table<T: Table + 'static, S: Into<String>>(mut self, name: S, table: T) -> Self {
        self.tables.insert(name.into(), Box::new(table));
        self
    }

    /// Create a simple in-memory table with headers, optional totals, and data.
    /// headers: column names in order; data: Vec of rows; totals: optional row of totals matching width
    pub fn with_simple_table<S: Into<String>>(
        mut self,
        name: S,
        headers: Vec<String>,
        data: Vec<Vec<V>>,
        totals: Option<Vec<V>>,
    ) -> Self {
        #[derive(Debug)]
        struct SimpleTable {
            headers: Vec<String>,
            data: Vec<Vec<V>>, // HxW
            totals: Option<Vec<V>>,
        }
        impl Table for SimpleTable {
            fn get_cell(&self, row: usize, column: &str) -> Result<V, ExcelError> {
                // row is 0-based within data body
                let column_key = column.to_lowercase();
                let col_idx = self
                    .headers
                    .iter()
                    .position(|h| h.to_lowercase() == column_key)
                    .ok_or_else(|| ExcelError::from(ExcelErrorKind::Ref))?;
                self.data
                    .get(row)
                    .and_then(|r| r.get(col_idx))
                    .cloned()
                    .ok_or_else(|| ExcelError::from(ExcelErrorKind::Ref))
            }
            fn get_column(&self, column: &str) -> Result<Box<dyn Range>, ExcelError> {
                let column_key = column.to_lowercase();
                let col_idx = self
                    .headers
                    .iter()
                    .position(|h| h.to_lowercase() == column_key)
                    .ok_or_else(|| ExcelError::from(ExcelErrorKind::Ref))?;
                let mut col: Vec<Vec<V>> = Vec::with_capacity(self.data.len());
                for r in &self.data {
                    col.push(vec![r.get(col_idx).cloned().unwrap_or(V::Empty)]);
                }
                Ok(Box::new(crate::traits::InMemoryRange::new(col)))
            }
            fn columns(&self) -> Vec<String> {
                self.headers.clone()
            }
            fn data_height(&self) -> usize {
                self.data.len()
            }
            fn has_headers(&self) -> bool {
                true
            }
            fn has_totals(&self) -> bool {
                self.totals.is_some()
            }
            fn headers_row(&self) -> Option<Box<dyn Range>> {
                Some(Box::new(crate::traits::InMemoryRange::new(vec![
                    self.headers
                        .iter()
                        .cloned()
                        .map(LiteralValue::Text)
                        .collect(),
                ])))
            }
            fn totals_row(&self) -> Option<Box<dyn Range>> {
                self.totals.as_ref().map(|t| {
                    Box::new(crate::traits::InMemoryRange::new(vec![t.clone()])) as Box<dyn Range>
                })
            }
            fn data_body(&self) -> Option<Box<dyn Range>> {
                Some(Box::new(crate::traits::InMemoryRange::new(
                    self.data.clone(),
                )))
            }
            fn clone_box(&self) -> Box<dyn Table> {
                Box::new(SimpleTable {
                    headers: self.headers.clone(),
                    data: self.data.clone(),
                    totals: self.totals.clone(),
                })
            }
        }
        let table = SimpleTable {
            headers,
            data,
            totals,
        };
        self.tables.insert(name.into(), Box::new(table));
        self
    }

    /* ─────────────── function helpers ─────────── */
    pub fn with_function(mut self, func: Arc<dyn Function>) -> Self {
        let ns = func.namespace().to_uppercase();
        let name = func.name().to_uppercase();
        for &alias in func.aliases() {
            if !alias.eq_ignore_ascii_case(&name) {
                // store alias mapping in workbook-scoped alias map
                let akey = (ns.clone(), alias.to_uppercase());
                self.aliases.insert(akey, (ns.clone(), name.clone()));
            }
        }
        self.fns.insert((ns, name), func);
        self
    }

    /// Register an alias for a function in this workbook (test helper)
    pub fn with_alias<S: AsRef<str>>(
        mut self,
        ns: S,
        alias: S,
        target_ns: S,
        target_name: S,
    ) -> Self {
        let key = (ns.as_ref().to_uppercase(), alias.as_ref().to_uppercase());
        let val = (
            target_ns.as_ref().to_uppercase(),
            target_name.as_ref().to_uppercase(),
        );
        self.aliases.insert(key, val);
        self
    }

    /* ─────────────── interpreter shortcut ─────── */
    pub fn interpreter(&self) -> crate::interpreter::Interpreter<'_> {
        crate::interpreter::Interpreter::new(self, self.default_sheet_name())
    }
}

/* ─────────────────────── trait impls ─────────────────────── */
impl EvaluationContext for TestWorkbook {
    fn cancellation_token(&self) -> Option<Arc<std::sync::atomic::AtomicBool>> {
        None
    }

    fn resolve_range_view<'c>(
        &'c self,
        reference: &ReferenceType,
        current_sheet: &str,
    ) -> Result<RangeView<'c>, ExcelError> {
        use formualizer_common::LiteralValue as V;
        use formualizer_parse::parser::ReferenceType as RT;

        match reference {
            // Preserve #REF! for invalid single-cell references by embedding as a 1x1 value
            RT::Cell {
                sheet, row, col, ..
            } => {
                let sheet_name = sheet.as_deref().unwrap_or(current_sheet);
                let v = match self.resolve_cell_reference(Some(sheet_name), *row, *col) {
                    Ok(val) => val,
                    Err(e) => V::Error(e),
                };
                let owned = vec![vec![v]];
                Ok(RangeView::from_owned_rows(owned, self.date_system()))
            }
            // Named range: delegate to resolver so missing names become #NAME?
            RT::NamedRange(name) => {
                let rows = self.resolve_named_range_reference(name)?;
                Ok(RangeView::from_owned_rows(rows, self.date_system()))
            }
            // Tables and rectangular ranges: materialize via generic path
            _ => {
                let range_box = self.resolve_range_like(reference)?;
                let owned: Vec<Vec<V>> = range_box.materialise().into_owned();
                Ok(RangeView::from_owned_rows(owned, self.date_system()))
            }
        }
    }

    fn used_rows_for_columns(
        &self,
        sheet: &str,
        start_col: u32,
        end_col: u32,
    ) -> Option<(u32, u32)> {
        let sh = self.sheets.get(sheet)?;
        let mut min_r: Option<u32> = None;
        let mut max_r: Option<u32> = None;
        for &(r, c) in sh.cells.keys() {
            if c >= start_col && c <= end_col {
                min_r = Some(min_r.map(|m| m.min(r)).unwrap_or(r));
                max_r = Some(max_r.map(|m| m.max(r)).unwrap_or(r));
            }
        }
        match (min_r, max_r) {
            (Some(a), Some(b)) => Some((a, b)),
            _ => None,
        }
    }

    fn used_cols_for_rows(&self, sheet: &str, start_row: u32, end_row: u32) -> Option<(u32, u32)> {
        let sh = self.sheets.get(sheet)?;
        let mut min_c: Option<u32> = None;
        let mut max_c: Option<u32> = None;
        for &(r, c) in sh.cells.keys() {
            if r >= start_row && r <= end_row {
                min_c = Some(min_c.map(|m| m.min(c)).unwrap_or(c));
                max_c = Some(max_c.map(|m| m.max(c)).unwrap_or(c));
            }
        }
        match (min_c, max_c) {
            (Some(a), Some(b)) => Some((a, b)),
            _ => None,
        }
    }

    fn sheet_bounds(&self, _sheet: &str) -> Option<(u32, u32)> {
        Some((1_048_576, 16_384))
    }

    fn backend_caps(&self) -> crate::traits::BackendCaps {
        crate::traits::BackendCaps {
            streaming: false,
            used_region: true,
            write: false,
            tables: false,
            async_stream: false,
        }
    }
}
impl ReferenceResolver for TestWorkbook {
    fn resolve_cell_reference(
        &self,
        sheet: Option<&str>,
        row: u32,
        col: u32,
    ) -> Result<V, ExcelError> {
        let sheet_name = sheet.unwrap_or(self.default_sheet_name());
        self.sheets
            .get(sheet_name)
            .and_then(|sh| sh.cells.get(&(row, col)).cloned())
            .ok_or_else(|| ExcelError::from(ExcelErrorKind::Ref))
    }
}

impl RangeResolver for TestWorkbook {
    fn resolve_range_reference(
        &self,
        sheet: Option<&str>,
        sr: Option<u32>,
        sc: Option<u32>,
        er: Option<u32>,
        ec: Option<u32>,
    ) -> Result<Box<dyn Range>, ExcelError> {
        let (sr, sc, er, ec) = match (sr, sc, er, ec) {
            (Some(sr), Some(sc), Some(er), Some(ec)) => (sr, sc, er, ec),
            _ => return Err(ExcelError::from(ExcelErrorKind::NImpl)),
        };
        let sheet_name = sheet.unwrap_or(self.default_sheet_name());
        let sh = self
            .sheets
            .get(sheet_name)
            .ok_or_else(|| ExcelError::from(ExcelErrorKind::Ref))?;
        let mut data = Vec::with_capacity((er - sr + 1) as usize);
        for r in sr..=er {
            let mut row_vec = Vec::with_capacity((ec - sc + 1) as usize);
            for c in sc..=ec {
                row_vec.push(sh.cells.get(&(r, c)).cloned().unwrap_or(V::Empty));
            }
            data.push(row_vec);
        }
        Ok(Box::new(crate::traits::InMemoryRange::new(data)))
    }
}

impl NamedRangeResolver for TestWorkbook {
    fn resolve_named_range_reference(&self, name: &str) -> Result<Vec<Vec<V>>, ExcelError> {
        self.named
            .get(name)
            .cloned()
            .ok_or_else(|| ExcelError::from(ExcelErrorKind::Name))
    }
}

impl TableResolver for TestWorkbook {
    fn resolve_table_reference(&self, tref: &TableReference) -> Result<Box<dyn Table>, ExcelError> {
        self.tables
            .get(&tref.name)
            .map(|table_box| table_box.as_ref().clone_box())
            .ok_or_else(|| ExcelError::from(ExcelErrorKind::NImpl))
    }
}

impl SourceResolver for TestWorkbook {}

impl FunctionProvider for TestWorkbook {
    fn get_function(&self, ns: &str, name: &str) -> Option<Arc<dyn Function>> {
        let nns = ns.to_uppercase();
        let nname = name.to_uppercase();
        // direct hit
        if let Some(f) = self.fns.get(&(nns.clone(), nname.clone())) {
            return Some(f.clone());
        }
        // alias in workbook scope
        if let Some((t_ns, t_name)) = self.aliases.get(&(nns.clone(), nname.clone()))
            && let Some(f) = self.fns.get(&(t_ns.clone(), t_name.clone()))
        {
            return Some(f.clone());
        }
        // fall back to global registry (case-insensitive with aliases)
        crate::function_registry::get(&nns, &nname)
    }
}

/* blanket */
impl Resolver for TestWorkbook {}

/* ─────────────────────── A1 parser ───────────────────────── */
fn parse_a1(a1: &str) -> Option<(u32, u32)> {
    parse_a1_1based(a1).ok().map(|(row, col, _, _)| (col, row))
}