csv_codegen/

lib.rs

use crate::expression::SelectExpression;
use proc_macro2::Delimiter;
use proc_macro2::TokenStream;
use std::ops::Bound;
use syn::token::Paren;
use syn::{Ident, Lit, LitStr, RangeLimits, Token};

mod data;
pub(crate) mod expression;
mod parse;
mod write;

/// Generates Rust code from CSV data using a templating syntax.
///
/// This macro reads a CSV file at compile time and generates code by substituting CSV field values
/// into a template. It supports filtering, pivoting, and various transformations to convert CSV
/// data into valid Rust identifiers, literals, and other tokens.
///
/// # Syntax
///
/// ```ignore
/// csv_codegen::csv_template!(
///     "path/to/file.csv",
///     [pivot(column_range, key_column, value_column),]
///     #for([condition])(
///         template_code
///     )
/// )
/// ```
///
/// # Arguments
///
/// - **CSV path**: Relative path to the CSV file from the crate root
/// - **pivot()** (optional): Transforms specified columns into key-value pairs
///   - `column_range`: Range of columns to pivot (e.g., `5..=9`, `"column_a"..`)
///   - `key_column`: Name for the generated key field
///   - `value_column`: Name for the generated value field
/// - **#for()** : Optionally filters which rows are included in the output
///   - Can be used both at the top level and within repetitions
///   - Condition uses CSV field names and supports `==`, `!=` comparisons
///
/// # Field Substitution
///
/// Fields from the CSV can be substituted into the template using several syntaxes:
///
/// ## Identifier transformations
/// - `#ident(expression)` - Converts to a valid Rust identifier
///   - Removes spaces, special characters, converts to snake_case
///   - Example: "Green Apple" → `#ident(get_{field_name}_value)` → `get_green_apple_value`
/// - `#CONST(expression)` - Converts to a valid Rust constant identifier (SCREAMING_SNAKE_CASE)
/// - `#Type(expression)` - Converts to a valid Rust type identifier (PascalCase)
///
/// ## Literal formatting
/// - `#({field_name}_suffix)` - Appends suffix to create typed literals
///   - `#{price}_f64` converts "42" to `42_f64` (float literal)
///   - `#{count}_u32` converts "10" to `10_u32` (unsigned integer literal)
/// - `#("{field_name}")` - Format as literal string
///
/// # Repetition and Filtering
///
/// Use `#for(condition)(template_code)` to repeat template code for each matching row:
///
/// ```ignore
/// #for(status == "active")(
///     const #CONST({name}): u32 = #({value});
/// )
/// ```
///
/// The condition can reference any CSV field and supports:
/// - `==` equality comparison
/// - `!=` inequality comparison  
/// - String comparisons
///
/// # Pivoting
///
/// The `pivot()` modifier transforms multiple columns into key-value pairs:
///
/// ```rust
/// let product = "Laptop Stand";
/// let quarter = "q3_sales";
/// let sales = csv_codegen::csv_template!("tests/sales.csv", pivot("q1_sales"..="q4_sales", quarter, amount), #for()(
///     match (product, quarter) {
///         #for()(
///             // Each row becomes multiple rows with metric/amount pairs
///             (#("{product}"), #("{quarter}")) => #({amount}),
///         )
///         _ => panic!(),
///     }
/// ));
/// assert_eq!(sales, 320);
/// ```
///
/// Given CSV columns `[name, age, height_cm, weight_kg, score_math, score_english]`,
/// `pivot("height_cm"..="score_english", subject, value)` would create pairs like:
/// - `subject="height_cm", value="175"`
/// - `subject="weight_kg", value="70"`
/// - `subject="score_math", value="95"`
/// - `subject="score_english", value="88"`
///
/// # Examples
///
/// ## Basic code generation
///
/// ```rust
/// // CSV: name,price,category
/// //      apple,1,fruit
/// //      carrot,0.80,vegetable
///
/// csv_codegen::csv_template!("tests/products.csv", #for()(
///     pub const #CONST({name}_PRICE): f64 = #({price}_f64);
/// ));
/// assert_eq!(WIRELESS_HEADPHONES_PRICE, 89.99);
/// ```
///
/// Generates:
/// ```rust
/// pub const APPLE_PRICE: f64 = 1_f64;
/// pub const CARROT_PRICE: f64 = 0.80_f64;
/// ```
///
/// ## Function generation with filtering
///
/// ```rust
/// csv_codegen::csv_template!("tests/products.csv", #for(category == "fruit")(
///     pub fn #ident(get_{name}_price)() -> f64 {
///         #({price}_f64)
///     }
/// ))
/// ```
///
/// Generates:
/// ```rust
/// pub fn get_apple_price() -> f64 {
///     1.20_f64
/// }
/// ```
///
/// ## Match arms with nested filtering
///
/// ```rust
/// csv_codegen::csv_template!("tests/products.csv", #for()(
///     fn get_price(name: &str) -> Option<f64> {
///         match name {
///             #for(price != "")(
///                 #("{name}") => Some(#({price}_f64)),
///             )
///             _ => None,
///         }
///     }
/// ));
/// assert_eq!(get_price("Ergonomic Chair").unwrap(), 399.99);
/// ```
///
/// ## Pivoting example
///
/// ```rust
/// // CSV: product,q1_sales,q2_sales,q3_sales,q4_sales
/// //      widget,100,150,120,200
///
/// csv_codegen::csv_template!("tests/sales.csv", pivot("q1_sales"..="q4_sales", quarter, sales), #for()(
///     struct #Type({product}Product);
///     impl #Type({product}Product) {
///         #for()(
///             pub const #CONST({quarter}): u32 = #({sales}_u32);
///         )
///     }
/// ));
/// assert_eq!(SmartWatchProduct::Q_2_SALES, 180);
/// ```
///
/// # Notes
///
/// - CSV files are read at compile time - changes require recompilation
/// - Field names are derived from CSV headers
/// - Empty cells are treated as empty strings
#[proc_macro]
pub fn csv_template(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
    // Parse macro input
    let input = match syn::parse::<ParsedCsvGenInvocation>(input) {
        Ok(data) => data,
        Err(err) => {
            return err.to_compile_error().into();
        }
    };

    // Parse csv data, and prepare for application to template, some querying is also done when generating code based on subqueries, this is the global filtering
    let mut errors = TokenStream::new();

    let output = match data::query_csv(&input.header) {
        Err(err) => {
            errors.extend(err.into_compile_error());
            input.template.template.render(None, &mut errors)
        }
        Ok(data) => {
            let for_template = input.template;
            for_template.render(Some(&data), &mut errors)
        }
    };

    // Return the generated code
    errors.extend(output);
    errors.into()
}

struct ParsedCsvGenInvocation {
    pub header: Header,
    pub template: ForTemplate,
}

struct Header {
    from: LitStr,
    pivot: Option<PivotSpec>,
}

mod kw {
    syn::custom_keyword!(pivot);
}

struct PivotSpec {
    _kw: kw::pivot,
    _parens: Paren,
    column_from: Option<syn::Lit>,
    _range_limits: RangeLimits,
    column_to: Bound<syn::Lit>,
    key_field_name: syn::Ident,
    value_field_name: syn::Ident,
}

#[derive(Debug)]
struct ForTemplate {
    _hash: Token![#],
    _for_kw: Token![for],
    _predicate_parens: Paren,
    filter: Option<WherePredicate>,
    _template_parens: Paren,
    template: TemplatedTokenStream,
    else_template: Option<ElseTemplate>,
}

#[derive(Debug)]
struct ElseTemplate {
    _hash: Token![#],
    _else_kw: Token![else],
    _template_parens: Paren,
    template: TemplatedTokenStream,
}

#[derive(Debug)]
struct WherePredicate {
    pub field: Ident,
    pub operator: WhereOp,
    pub value: Lit,
}

#[allow(dead_code)]
#[derive(Debug)]
enum WhereOp {
    Equal(Token![==]),
    NotEqual(Token![!=]),
}

#[derive(Debug)]
struct TemplatedTokenStream(Vec<TemplatedTokenTree>);

#[derive(Debug)]
enum TemplatedTokenTree {
    Group(TemplatedGroup),
    Ident(proc_macro2::Ident),
    Punct(proc_macro2::Punct),
    Literal(proc_macro2::Literal),
    Replacement(Replacement),
    Error(syn::Error),
}

#[derive(Debug)]
struct TemplatedGroup {
    delimiter: Delimiter,
    stream: TemplatedTokenStream,
}

#[derive(Debug)]
enum Replacement {
    Expression(SelectExpression),
    Group(ForTemplate),
}