interactive_parse/

lib.rs

use std::{cell::Cell, collections::BTreeMap};

use error::{SchemaError, SchemaResult};
use inquire::{Confirm, CustomType, Select, Text};
use log::debug;
use schemars::schema::{
    ArrayValidation, InstanceType, ObjectValidation, Schema, SchemaObject, SingleOrVec,
    SubschemaValidation,
};
use serde_json::{json, Map, Value};
use undo::clear_lines;

use crate::undo::{RecurseIter, RecurseLoop, Undo};

pub mod error;
pub mod traits;
pub mod undo;

pub use traits::*;

pub(crate) fn parse_schema(
    definitions: &BTreeMap<String, Schema>,
    title: Option<String>,
    name: String,
    schema: SchemaObject,
    current_depth: &Cell<u16>,
) -> SchemaResult<Value> {
    let depth_checkpoint = current_depth.get();
    match parse_schema_inner(
        definitions,
        title.clone(),
        name.clone(),
        schema.clone(),
        current_depth,
    ) {
        Ok(value) => Ok(value),
        Err(SchemaError::Undo { depth }) => {
            if depth <= depth_checkpoint && depth_checkpoint != 0 {
                debug!("forwarding error in parse schema, depth: {depth}, depth_checkpoint: {depth_checkpoint}");
                Err(SchemaError::Undo { depth })
            } else {
                current_depth.set(depth_checkpoint);
                clear_lines(depth - depth_checkpoint + 1);
                parse_schema(definitions, title, name, schema, current_depth)
            }
        }
        Err(e) => Err(e),
    }
}

pub(crate) fn parse_schema_inner(
    definitions: &BTreeMap<String, Schema>,
    title: Option<String>,
    name: String,
    schema: SchemaObject,
    current_depth: &Cell<u16>,
) -> SchemaResult<Value> {
    debug!("Entered parse_schema");
    let description = get_description(&schema);
    debug!("description: {}", description);
    match schema.instance_type.clone() {
        Some(SingleOrVec::Single(instance_type)) => get_single_instance(
            definitions,
            schema.array,
            schema.object,
            schema.subschemas,
            instance_type,
            title,
            name,
            description,
            current_depth,
        ),
        Some(SingleOrVec::Vec(vec)) => {
            // This usually represents an optional regular type
            let instance_type =
                Box::new(vec.into_iter().find(|x| x != &InstanceType::Null).unwrap());
            if Confirm::new("Add optional value?")
                .with_help_message(format!("{}{}", get_title_str(&title), name).as_str())
                .prompt_skippable()?
                .undo(current_depth)?
            {
                get_single_instance(
                    definitions,
                    schema.array,
                    schema.object,
                    schema.subschemas,
                    instance_type,
                    title,
                    name,
                    description,
                    current_depth,
                )
            } else {
                Ok(Value::Null)
            }
        }
        None => {
            // This represents a referenced type
            if let Some(reference) = schema.reference {
                let reference = reference.strip_prefix("#/definitions/").unwrap();
                let schema = definitions.get(reference).unwrap();
                let schema = get_schema_object_ref(schema)?;
                parse_schema(
                    definitions,
                    Some(reference.to_string()),
                    name,
                    schema.clone(),
                    current_depth,
                )
            }
            // Or it could be a subschema
            else {
                get_subschema(
                    definitions,
                    title,
                    name,
                    schema.subschemas,
                    description,
                    current_depth,
                )
            }
        }
    }
}

fn update_title(mut title: Option<String>, schema: &SchemaObject) -> Option<String> {
    if let Some(metadata) = &schema.metadata {
        title = metadata.title.clone();
    }
    title
}

fn get_title_str(title: &Option<String>) -> String {
    let mut title_str = String::new();
    if let Some(title) = title {
        title_str.push_str(format!("<{title}> ").as_str());
    }
    title_str
}

fn get_description(schema: &SchemaObject) -> String {
    match &schema.metadata {
        Some(metadata) => match &metadata.description {
            Some(description_ref) => {
                let mut description = description_ref.clone();
                if description.len() > 60 {
                    description.truncate(60);
                    description.push_str("...");
                }
                format!(": {description}")
            }
            None => String::default(),
        },
        None => String::default(),
    }
}

#[allow(clippy::too_many_arguments)]
#[allow(clippy::boxed_local)]
fn get_single_instance(
    definitions: &BTreeMap<String, Schema>,
    array_info: Option<Box<ArrayValidation>>,
    object_info: Option<Box<ObjectValidation>>,
    subschema: Option<Box<SubschemaValidation>>,
    instance: Box<InstanceType>,
    title: Option<String>,
    name: String,
    description: String,
    current_depth: &Cell<u16>,
) -> SchemaResult<Value> {
    debug!("Entered get_single_instance");
    match *instance {
        InstanceType::String => get_string(name, description, current_depth),
        InstanceType::Number => get_num(name, description, current_depth),
        InstanceType::Integer => get_int(name, description, current_depth),
        InstanceType::Boolean => get_bool(name, description, current_depth),
        InstanceType::Array => get_array(
            definitions,
            array_info,
            title,
            name,
            description,
            current_depth,
        ),
        InstanceType::Object => get_object(
            definitions,
            object_info,
            title,
            name,
            description,
            current_depth,
        ),
        InstanceType::Null => {
            // This represents an optional enum
            // Likely the subschema will have info here.
            get_subschema(
                definitions,
                title,
                name,
                subschema,
                description,
                current_depth,
            )
        }
    }
}

fn get_subschema(
    definitions: &BTreeMap<String, Schema>,
    title: Option<String>,
    name: String,
    subschema: Option<Box<SubschemaValidation>>,
    description: String,
    current_depth: &Cell<u16>,
) -> SchemaResult<Value> {
    debug!("Entered get_subschema");
    let subschema = subschema.unwrap();
    // First we check the one_of field.
    if let Some(schema_vec) = subschema.one_of {
        let mut options = Vec::new();
        for schema in &schema_vec {
            let Schema::Object(schema_object) = schema else {
                                panic!("invalid schema");
                            };
            // debug!("schema: {schema:#?}");
            let name = if let Some(object) = schema_object.clone().object {
                object.properties.into_iter().next().unwrap().0
            } else if let Some(enum_values) = schema_object.clone().enum_values {
                if let Value::String(name) = enum_values.get(0).expect("invalid schema") {
                    name.clone()
                } else {
                    panic!("invalid schema");
                }
            } else {
                panic!("invalid schema")
            };
            options.push(name);
        }
        let option = Select::new("Select one:", options.clone())
            .with_help_message(
                format!("{}{}{}", get_title_str(&title), name, description.as_str()).as_str(),
            )
            .prompt_skippable()?
            .undo(current_depth)?;
        let position = options.iter().position(|x| x == &option).unwrap();
        let schema_object = get_schema_object(schema_vec[position].clone())?;
        if schema_object.object.is_some() {
            let title = update_title(title, &schema_object);
            Ok(parse_schema(
                definitions,
                title,
                name,
                schema_object,
                current_depth,
            )?)
        } else if let Some(enum_values) = schema_object.enum_values {
            Ok(enum_values.get(0).expect("invalid schema").clone())
        } else {
            panic!("invalid schema")
        }
    }
    // Next check the all_of field.
    else if let Some(schema_vec) = subschema.all_of {
        let mut values = Vec::new();
        for schema in schema_vec {
            let object = get_schema_object(schema)?;
            let title = update_title(title.clone(), &object);
            values.push(parse_schema(
                definitions,
                title.clone(),
                name.clone(),
                object,
                current_depth,
            )?)
        }
        match values.len() {
            1 => Ok(values.pop().unwrap()),
            _ => Ok(Value::Array(values)),
        }
    }
    // Next check the any_of field.
    // This seems to be a weird way to get options
    else if let Some(schema_vec) = subschema.any_of {
        let non_null = schema_vec
            .into_iter()
            .find(|x| {
                let Schema::Object(object) = x else {
                            panic!("invalid schema");
                        };
                object.instance_type != Some(SingleOrVec::Single(Box::new(InstanceType::Null)))
            })
            .unwrap();
        let Schema::Object(object) = non_null else {
                            panic!("invalid schema");
                        };
        let title = update_title(title, &object);

        if Confirm::new("Add optional value?")
            .with_help_message(format!("{}{}", get_title_str(&title), name).as_str())
            .prompt_skippable()?
            .undo(current_depth)?
        {
            parse_schema(definitions, title, name, object, current_depth)
        } else {
            Ok(Value::Null)
        }
    } else {
        panic!("invalid schema");
    }
}

fn get_int(name: String, description: String, current_depth: &Cell<u16>) -> SchemaResult<Value> {
    debug!("Entered get_int");
    Ok(json!(CustomType::<i64>::new(name.as_str())
        .with_help_message(format!("int{description}").as_str())
        .prompt_skippable()?
        .undo(current_depth)?))
}

fn get_string(name: String, description: String, current_depth: &Cell<u16>) -> SchemaResult<Value> {
    debug!("Entered get_string");
    Ok(Value::String(
        Text::new(name.as_str())
            .with_help_message(format!("string{description}").as_str())
            .prompt_skippable()?
            .undo(current_depth)?,
    ))
}

fn get_num(name: String, description: String, current_depth: &Cell<u16>) -> SchemaResult<Value> {
    debug!("Entered get_num");
    Ok(json!(CustomType::<f64>::new(name.as_str())
        .with_help_message(format!("num{description}").as_str())
        .prompt_skippable()?
        .undo(current_depth)?))
}

fn get_bool(name: String, description: String, current_depth: &Cell<u16>) -> SchemaResult<Value> {
    debug!("Entered get_bool");
    Ok(json!(CustomType::<bool>::new(name.as_str())
        .with_help_message(format!("bool{description}").as_str())
        .prompt_skippable()?
        .undo(current_depth)?))
}

fn get_array(
    definitions: &BTreeMap<String, Schema>,
    array_info: Option<Box<ArrayValidation>>,
    title: Option<String>,
    name: String,
    description: String,
    current_depth: &Cell<u16>,
) -> SchemaResult<Value> {
    debug!("Entered get_array");
    let array_info = array_info.unwrap();
    let range = array_info.min_items..array_info.max_items;
    debug!("array range: {range:?}");

    let mut array = Vec::new();
    match array_info.items.unwrap() {
        SingleOrVec::Single(schema) => {
            debug!("Single type array");
            array = (0..).recurse_iter(current_depth, |i| {
                if let Some(end) = range.end {
                    if array.len() == end as usize {
                        return Ok(RecurseLoop::Return(None));
                    }
                }

                let start = range.start.unwrap_or_default();
                if i >= start as usize
                    && !Confirm::new("Add element?")
                        .with_help_message(
                            format!("{}{}{}", get_title_str(&title), name, description).as_str(),
                        )
                        .prompt_skippable()?
                        .undo(current_depth)?
                {
                    return Ok(RecurseLoop::Return(None));
                }

                let object = get_schema_object(*schema.clone())?;
                let value = parse_schema(
                    definitions,
                    title.clone(),
                    format!("{}[{}]", name.clone(), i),
                    object,
                    current_depth,
                )?;
                Ok(RecurseLoop::Continue(value))
            })?;
        }
        SingleOrVec::Vec(schemas) => {
            debug!("Vec type array");
            array = (0..).recurse_iter(current_depth, |i| {
                if let Some(end) = range.end {
                    if i == end as usize {
                        return Ok(RecurseLoop::Return(None));
                    }
                }

                let schema = schemas[i].clone();

                let start = range.start.unwrap_or_default();
                if i >= start as usize
                    && !Confirm::new("Add element?")
                        .with_help_message(
                            format!("{}{}{}", get_title_str(&title), name, description).as_str(),
                        )
                        .prompt_skippable()?
                        .undo(current_depth)?
                {
                    return Ok(RecurseLoop::Return(None));
                }
                let object = get_schema_object(schema)?;
                let value = parse_schema(
                    definitions,
                    title.clone(),
                    format!("{}.{}", name.clone(), i),
                    object,
                    current_depth,
                )?;

                Ok(RecurseLoop::Continue(value))
            })?;
        }
    };
    Ok(Value::Array(array))
}

fn get_object(
    definitions: &BTreeMap<String, Schema>,
    object_info: Option<Box<ObjectValidation>>,
    title: Option<String>,
    _name: String,
    _description: String,
    current_depth: &Cell<u16>,
) -> SchemaResult<Value> {
    debug!("Entered get_object");
    let map = object_info
        .unwrap()
        .properties
        .iter()
        .recurse_iter(current_depth, |(name, schema)| {
            let schema_object = get_schema_object(schema.clone())?;
            let object = parse_schema(
                definitions,
                title.clone(),
                name.to_string(),
                schema_object,
                current_depth,
            )?;
            Ok(RecurseLoop::Continue((name, object)))
        })?
        .into_iter()
        .map(|(name, object)| (name.clone(), object))
        .collect::<Map<String, Value>>();
    Ok(Value::Object(map))
}

fn get_schema_object(schema: Schema) -> SchemaResult<SchemaObject> {
    debug!("Entered get_schema_object");
    match schema {
        Schema::Bool(_) => Err(SchemaError::SchemaIsBool),
        Schema::Object(object) => Ok(object),
    }
}

fn get_schema_object_ref(schema: &Schema) -> SchemaResult<&SchemaObject> {
    debug!("Entered get_schema_object_ref");
    match schema {
        Schema::Bool(_) => Err(SchemaError::SchemaIsBool),
        Schema::Object(object) => Ok(object),
    }
}

#[cfg(test)]
mod tests {

    use inquire::Text;
    use schemars::JsonSchema;
    use serde::{Deserialize, Serialize};

    use crate::{clear_lines, traits::InteractiveParseObj};

    /// This is the struct used for testing.
    #[derive(JsonSchema, Serialize, Deserialize, Debug)]
    pub struct MyStruct {
        /// This is an integer.
        pub my_int: Option<i32>,
        /// This is a boolean.
        pub my_bool: bool,
        /// This is an optional tuple of ints.
        pub my_tuple: Option<(i32, Option<i32>)>,
        /// This is a vec of ints.
        pub my_vec: Vec<i32>,
        /// This is an enumerated type.
        pub my_enum: Option<MyEnum>,
        /// This is an object.
        pub str_2: Option<MyStruct2>,
        /// This is a vec of tuples.
        pub vec_map: MyVecMap,
    }

    /// Doc comment on struct
    #[derive(JsonSchema, Serialize, Deserialize, Debug)]
    pub struct MyStruct2 {
        /// Doc comment on field
        pub option_int: Option<i32>,
    }

    /// Doc comment on struct
    #[derive(JsonSchema, Serialize, Deserialize, Debug)]
    pub struct MyStruct3 {
        /// Doc comment on field
        pub option_int: Option<f64>,
    }

    /// Doc comment on enum
    #[derive(JsonSchema, Serialize, Deserialize, Debug)]
    pub enum MyEnum {
        /// This is a unit variant.
        Unit,
        /// This is a unit variant.
        Unit2,
        /// This is a tuple variant.
        StringNewType(Option<String>, u32),
        /// This is a struct variant.
        StructVariant {
            /// This is a vec of floats.
            floats: Vec<f32>,
        },
    }

    // This type is exiting early in the vec.
    /// Doc comment on struct
    #[derive(JsonSchema, Serialize, Deserialize, Debug)]
    pub struct MyVecMap(Vec<(String, u32)>);

    fn log_init() {
        let _ =
            env_logger::Builder::from_env(env_logger::Env::default().default_filter_or("debug"))
                .is_test(true)
                .try_init();
    }

    #[ignore]
    #[test]
    fn test() {
        log_init();
        let my_struct = MyStruct::parse_to_obj().unwrap();
        dbg!(my_struct);
    }

    #[ignore]
    #[test]
    fn test_enum() {
        // log_init();
        let my_struct = MyEnum::parse_to_obj().unwrap();
        dbg!(my_struct);
    }

    #[ignore]
    #[test]
    fn test_vec_map() {
        // log_init();
        let my_vec_map = MyVecMap::parse_to_obj().unwrap();
        dbg!(my_vec_map);
    }

    #[ignore]
    #[test]
    fn test_clear_lines() {
        Text::new("Enter a string")
            .with_help_message("This is a help message")
            .prompt_skippable()
            .unwrap();
        Text::new("Enter a string")
            .with_help_message("This is a help message")
            .prompt_skippable()
            .unwrap();
        clear_lines(2);
    }
}