splashboard 2.10.2

//! `basic_points` — `PointSeries` authored inline. Supports multiple series for line / scatter
//! charts where each series carries its own name + (x, y) pairs.

use serde::Deserialize;

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

use super::common;

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

const OPTION_SCHEMAS: &[OptionSchema] = &[OptionSchema {
    name: "series",
    type_hint: "list of {name, points: [[x, y], ...]}",
    required: false,
    default: Some("[]"),
    description: "One entry per line / cluster. Points are `[x, y]` float pairs. `chart_line` / `chart_scatter` consume this directly.",
}];

pub struct BasicPoints;

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

#[derive(Debug, Default, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct SeriesConfig {
    pub name: String,
    #[serde(default)]
    pub points: Vec<(f64, f64)>,
}

impl RealtimeFetcher for BasicPoints {
    fn name(&self) -> &str {
        "basic_points"
    }
    fn safety(&self) -> Safety {
        Safety::Safe
    }
    fn description(&self) -> &'static str {
        "Renders a `PointSeries` from inline `[widget.options].series = [{name, points: [[x, y], ...]}]`. Supports multiple series so a single widget can carry several lines / clusters."
    }
    fn shapes(&self) -> &[Shape] {
        SHAPES
    }
    fn option_schemas(&self) -> &[OptionSchema] {
        OPTION_SCHEMAS
    }
    fn sample_body(&self, shape: Shape) -> Option<Body> {
        (shape == Shape::PointSeries).then(|| {
            Body::PointSeries(PointSeriesData {
                series: vec![PointSeries {
                    name: "demo".into(),
                    points: vec![(0.0, 1.0), (1.0, 2.5), (2.0, 1.8), (3.0, 3.0)],
                }],
            })
        })
    }
    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::PointSeries(PointSeriesData {
            series: opts
                .series
                .into_iter()
                .map(|s| PointSeries {
                    name: s.name,
                    points: s.points,
                })
                .collect(),
        }))
    }
}

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

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

    #[test]
    fn contract() {
        assert_eq!(BasicPoints.name(), "basic_points");
        assert_eq!(BasicPoints.shapes(), &[Shape::PointSeries]);
    }

    #[test]
    fn emits_named_series_with_points() {
        let p = compute(
            r#"
            [[series]]
            name = "alpha"
            points = [[0.0, 1.0], [1.0, 2.0]]
            [[series]]
            name = "beta"
            points = [[0.0, 0.5]]
            "#,
        );
        let Body::PointSeries(d) = p.body else {
            panic!("expected PointSeries");
        };
        assert_eq!(d.series.len(), 2);
        assert_eq!(d.series[0].name, "alpha");
        assert_eq!(d.series[0].points, vec![(0.0, 1.0), (1.0, 2.0)]);
        assert_eq!(d.series[1].points, vec![(0.0, 0.5)]);
    }

    #[test]
    fn no_series_yields_empty_payload() {
        let p = BasicPoints.compute(&FetchContext::default());
        let Body::PointSeries(d) = p.body else {
            panic!("expected PointSeries");
        };
        assert!(d.series.is_empty());
    }

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

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

    #[test]
    fn invalid_options_render_placeholder() {
        let p = compute(r#"series = "not-a-list""#);
        let Body::TextBlock(d) = p.body else {
            panic!("expected placeholder");
        };
        assert!(d.lines[0].contains("invalid options"));
    }
}