rsql_formatters 0.19.3

rsql formatters to output rsql results in various formats
Documentation
use crate::Results::{Execute, Query};
use crate::error::Result;
use crate::footer::write_footer;
use crate::formatter::FormatterOptions;
use crate::writers::Output;
use crate::{Highlighter, Results};
use async_trait::async_trait;
use indexmap::IndexMap;
use rsql_drivers::Value;
use serde_json::{json, to_string_pretty};

/// A formatter for JSON
#[derive(Debug, Default)]
pub struct Formatter;

#[async_trait]
impl crate::Formatter for Formatter {
    fn identifier(&self) -> &'static str {
        "json"
    }

    async fn format(
        &self,
        options: &FormatterOptions,
        results: &mut Results,
        output: &mut Output,
    ) -> Result<()> {
        format_json(options, false, results, output).await
    }
}

pub(crate) async fn format_json(
    options: &FormatterOptions,
    jsonl: bool,
    results: &mut Results,
    output: &mut Output,
) -> Result<()> {
    let query_result = match results {
        Query(query_result) => query_result,
        Execute(_) => return write_footer(options, results, 0, output).await,
    };

    let highlighter = Highlighter::new(options, "json");
    let mut json_rows: Vec<IndexMap<&String, Value>> = Vec::new();
    let columns = query_result.columns().to_vec();
    let mut rows: u64 = 0;
    while let Some(row) = query_result.next().await {
        let mut json_row: IndexMap<&String, Value> = IndexMap::new();

        if rows > 0 && jsonl {
            writeln!(output)?;
        }

        for (c, data) in row.iter().enumerate() {
            let column = columns.get(c).expect("column not found");
            if let Value::Bytes(_bytes) = data {
                let value = Value::String(data.to_string());
                json_row.insert(column, value);
            } else {
                json_row.insert(column, data.clone());
            }
        }
        if jsonl {
            let json = json!(json_row).to_string();
            write!(output, "{}", highlighter.highlight(json.as_str())?)?;
        } else {
            json_rows.push(json_row);
        }

        rows += 1;
    }

    if !jsonl {
        let json = to_string_pretty(&json!(json_rows))?;
        write!(output, "{}", highlighter.highlight(json.as_str())?)?;
    }

    writeln!(output)?;
    write_footer(options, results, rows, output).await
}

#[cfg(test)]
mod test {
    use super::*;
    use crate::Formatter;
    use crate::Results::{Execute, Query};
    use crate::formatter::FormatterOptions;
    use crate::writers::Output;
    use indoc::indoc;
    use rsql_drivers::{MemoryQueryResult, Value};
    use std::time::Duration;

    #[tokio::test]
    async fn test_format_execute() -> anyhow::Result<()> {
        let options = FormatterOptions {
            color: false,
            elapsed: Duration::from_nanos(9),
            ..Default::default()
        };
        let output = &mut Output::default();

        let formatter = Formatter;
        formatter.format(&options, &mut Execute(1), output).await?;

        let output = output.to_string().replace("\r\n", "\n");
        let expected = "1 row (9ns)\n";
        assert_eq!(output, expected);
        Ok(())
    }

    #[tokio::test]
    async fn test_format_query() -> anyhow::Result<()> {
        let options = FormatterOptions {
            color: false,
            elapsed: Duration::from_nanos(9),
            ..Default::default()
        };
        let mut query_result = Query(Box::new(MemoryQueryResult::new(
            vec!["id".to_string(), "data".to_string()],
            vec![
                vec![Value::I64(1), Value::Bytes(b"bytes".to_vec())],
                vec![Value::I64(2), Value::String("foo".to_string())],
                vec![Value::I64(3), Value::Null],
            ],
        )));
        let output = &mut Output::default();

        let formatter = Formatter;
        formatter
            .format(&options, &mut query_result, output)
            .await?;

        let output = output.to_string().replace("\r\n", "\n");
        let expected = indoc! {r#"
          [
            {
              "id": 1,
              "data": "Ynl0ZXM="
            },
            {
              "id": 2,
              "data": "foo"
            },
            {
              "id": 3,
              "data": null
            }
          ]
          3 rows (9ns)
        "#};
        assert_eq!(output, expected);
        Ok(())
    }
}