splashboard 2.10.2

//! `basic_numbers` — `NumberSeries` authored inline. Right for tiny static series the user
//! wants to sparkline / histogram (manual weekly counts, learning curve "1 chapter / day").

use serde::Deserialize;

use crate::fetcher::{FetchContext, RealtimeFetcher, Safety};
use crate::options::OptionSchema;
use crate::payload::{Body, NumberSeriesData, Payload};
use crate::render::Shape;

use super::common;

const SHAPES: &[Shape] = &[Shape::NumberSeries];

const OPTION_SCHEMAS: &[OptionSchema] = &[OptionSchema {
    name: "values",
    type_hint: "list of u64",
    required: false,
    default: Some("[]"),
    description: "The series values in chronological / sequential order. Renderers like `chart_sparkline` consume this directly.",
}];

pub struct BasicNumbers;

#[derive(Debug, Default, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct Options {
    #[serde(default)]
    pub values: Vec<u64>,
}

impl RealtimeFetcher for BasicNumbers {
    fn name(&self) -> &str {
        "basic_numbers"
    }
    fn safety(&self) -> Safety {
        Safety::Safe
    }
    fn description(&self) -> &'static str {
        "Renders a `NumberSeries` from inline `[widget.options].values`. Right for tiny static series the user wants to sparkline or histogram without a dedicated fetcher (weekly tallies, manual progress curves)."
    }
    fn shapes(&self) -> &[Shape] {
        SHAPES
    }
    fn option_schemas(&self) -> &[OptionSchema] {
        OPTION_SCHEMAS
    }
    fn sample_body(&self, shape: Shape) -> Option<Body> {
        (shape == Shape::NumberSeries).then(|| {
            Body::NumberSeries(NumberSeriesData {
                values: vec![3, 5, 8, 13, 21, 34],
            })
        })
    }
    fn compute(&self, ctx: &FetchContext) -> Payload {
        let opts: Options = match common::parse_options(ctx.options.as_ref()) {
            Ok(o) => o,
            Err(msg) => return common::placeholder(&msg),
        };
        common::bare(Body::NumberSeries(NumberSeriesData {
            values: opts.values,
        }))
    }
}

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

    fn compute(toml_src: &str) -> Payload {
        BasicNumbers.compute(&FetchContext {
            options: Some(toml::from_str(toml_src).unwrap()),
            ..Default::default()
        })
    }

    #[test]
    fn contract() {
        assert_eq!(BasicNumbers.name(), "basic_numbers");
        assert_eq!(BasicNumbers.shapes(), &[Shape::NumberSeries]);
    }

    #[test]
    fn emits_values_in_order() {
        let p = compute(r#"values = [3, 5, 8, 13, 21]"#);
        assert_eq!(
            p.body,
            Body::NumberSeries(NumberSeriesData {
                values: vec![3, 5, 8, 13, 21],
            })
        );
    }

    #[test]
    fn no_values_yields_empty_series() {
        let p = BasicNumbers.compute(&FetchContext::default());
        let Body::NumberSeries(d) = p.body else {
            panic!("expected NumberSeries");
        };
        assert!(d.values.is_empty());
    }

    #[test]
    fn metadata_methods_have_content() {
        let f = BasicNumbers;
        assert_eq!(f.safety(), Safety::Safe);
        assert!(!f.description().is_empty());
        assert_eq!(
            f.option_schemas()
                .iter()
                .map(|s| s.name)
                .collect::<Vec<_>>(),
            vec!["values"]
        );
    }

    #[test]
    fn sample_body_matches_declared_shape_only() {
        let f = BasicNumbers;
        assert!(matches!(
            f.sample_body(Shape::NumberSeries),
            Some(Body::NumberSeries(_))
        ));
        assert!(f.sample_body(Shape::Text).is_none());
    }

    #[test]
    fn invalid_options_render_placeholder() {
        let p = BasicNumbers.compute(&FetchContext {
            options: Some(toml::from_str(r#"values = "not-a-list""#).unwrap()),
            ..Default::default()
        });
        let Body::TextBlock(d) = p.body else {
            panic!("expected placeholder");
        };
        assert!(d.lines[0].contains("invalid options"));
    }
}