plushie-core 0.4.0

Extension SDK for Plushie
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
//! Compilation tests for code examples in the widget development docs.
//!
//! These tests verify that the API patterns shown in docs/extension-guide.md
//! and docs/core-widget-guide.md actually compile against the real plushie-core
//! and iced APIs. If the API changes, these tests fail, signaling that the
//! docs need updating.
//!
//! The tests don't render pixels -- they exercise the type system and verify
//! that method calls, field access, and trait implementations are correct.

use plushie_core::prelude::*;
use plushie_core::testing::*;
use serde_json::json;

// column and row are excluded from the prelude because the function
// forms conflict with the column!/row! macros under glob import.
use plushie_core::iced::widget::{column, row};

// ============================================================================
// Extension guide: Gauge example (the opening example)
// ============================================================================

struct DocGauge;

impl WidgetExtension for DocGauge {
    fn type_names(&self) -> &[&str] {
        &["doc_gauge"]
    }

    fn config_key(&self) -> &str {
        "doc_gauge"
    }

    fn render<'a>(&self, node: &'a TreeNode, _env: &WidgetEnv<'a>) -> Element<'a, Message> {
        let value = node.prop_f32("value").unwrap_or(0.0);
        let label = node.prop_str("label").unwrap_or_default();

        column![
            text(format!("{label}: {value:.0}%")),
            progress_bar(0.0..=100.0, value),
        ]
        .spacing(4)
        .into()
    }
}

// Validates: extension-guide.md "The trait" section
#[test]
fn extension_guide_gauge_renders() {
    let ext = DocGauge;
    let node = node_with_props("g1", "doc_gauge", json!({"value": 50.0, "label": "CPU"}));
    let test = TestEnv::default();
    let ctx = test.render_ctx();
    let env = test.env(&ctx);
    let _element = ext.render(&node, &env);
}

// Validates: extension-guide.md "The trait" section
#[test]
fn extension_guide_gauge_no_props() {
    let ext = DocGauge;
    let node = node("g1", "doc_gauge");
    let test = TestEnv::default();
    let ctx = test.render_ctx();
    let env = test.env(&ctx);
    let _element = ext.render(&node, &env);
}

// ============================================================================
// Extension guide: prop parsing patterns
// ============================================================================

// Validates: extension-guide.md "Parsing props" section
#[test]
fn extension_guide_prop_parsing() {
    let props_val = json!({
        "value": 42.5,
        "label": "test",
        "color": "#3498db",
        "show_label": true,
        "width": "fill",
    });
    let props = props_val.as_object();

    // Free function style
    let _value: Option<f32> = prop_f32(props, "value");
    let _label: Option<String> = prop_str(props, "label");
    let _color: Option<Color> = prop_color(props, "color");
    let _show_label: bool = prop_bool_default(props, "show_label", true);
    let _width: Length = prop_length(props, "width", Length::Fill);

    // TreeNode shorthand style
    let node = node_with_props("n1", "test", props_val.clone());
    let _value: Option<f32> = node.prop_f32("value");
    let _label: Option<String> = node.prop_str("label");
    let _color: Option<Color> = node.prop_color("color");
}

// ============================================================================
// Extension guide: rendering with theme
// ============================================================================

// Validates: extension-guide.md "Using the theme" section
#[test]
fn extension_guide_theme_access() {
    let test = TestEnv::default();
    let ctx = test.render_ctx();
    let env = test.env(&ctx);

    let theme = env.theme();
    let palette = theme.palette();
    let _primary = palette.primary.base.color;
    let _is_dark = palette.is_dark;
}

// ============================================================================
// Extension guide: rendering children
// ============================================================================

struct DocContainer;

impl WidgetExtension for DocContainer {
    fn type_names(&self) -> &[&str] {
        &["doc_container"]
    }
    fn config_key(&self) -> &str {
        "doc_container"
    }

    fn render<'a>(&self, node: &'a TreeNode, env: &WidgetEnv<'a>) -> Element<'a, Message> {
        let header = text(node.prop_str("title").unwrap_or_default());
        let children: Vec<Element<'a, Message>> = env.ctx.render_children(node);
        let mut col = column![header].spacing(8);
        for child in children {
            col = col.push(child);
        }
        col.into()
    }
}

// Validates: extension-guide.md "Rendering children" section
#[test]
fn extension_guide_container_renders() {
    let ext = DocContainer;
    let node = node_with_props_and_children(
        "c1",
        "doc_container",
        json!({"title": "Section"}),
        vec![node("child1", "text")],
    );
    let test = TestEnv::default();
    let ctx = test.render_ctx();
    let env = test.env(&ctx);
    let _element = ext.render(&node, &env);
}

// ============================================================================
// Extension guide: state management with ExtensionCaches
// ============================================================================

#[derive(Debug)]
struct SparklineState {
    data: Vec<f32>,
    min: f32,
    max: f32,
}

struct DocSparkline;

impl WidgetExtension for DocSparkline {
    fn type_names(&self) -> &[&str] {
        &["doc_sparkline"]
    }
    fn config_key(&self) -> &str {
        "doc_sparkline"
    }

    fn prepare(&mut self, node: &TreeNode, caches: &mut ExtensionCaches, _theme: &Theme) {
        let data: Vec<f32> = prop_f32_array(node.props(), "data").unwrap_or_default();
        let (min, max) = data
            .iter()
            .fold((f32::MAX, f32::MIN), |(lo, hi), &v| (lo.min(v), hi.max(v)));
        caches.insert(
            self.config_key(),
            &node.id,
            SparklineState { data, min, max },
        );
    }

    fn render<'a>(&self, node: &'a TreeNode, env: &WidgetEnv<'a>) -> Element<'a, Message> {
        let _state: Option<&SparklineState> = env.caches.get(self.config_key(), &node.id);
        text("sparkline").into()
    }
}

// Validates: extension-guide.md "Tier B: stateful with ExtensionCaches" section
#[test]
fn extension_guide_state_management() {
    let mut ext = DocSparkline;
    let node = node_with_props("s1", "doc_sparkline", json!({"data": [1.0, 2.0, 3.0]}));
    let mut caches = ExtensionCaches::new();
    ext.prepare(&node, &mut caches, &Theme::Dark);

    let state: Option<&SparklineState> = caches.get("doc_sparkline", "s1");
    let state = state.unwrap();
    assert_eq!(state.data, vec![1.0, 2.0, 3.0]);
    assert!((state.min - 1.0).abs() < f32::EPSILON);
    assert!((state.max - 3.0).abs() < f32::EPSILON);
}

// ============================================================================
// Extension guide: GenerationCounter pattern
// ============================================================================

struct ChartState {
    data: Vec<f32>,
    generation: GenerationCounter,
}

// Validates: extension-guide.md "Canvas cache invalidation" section
#[test]
fn extension_guide_generation_counter() {
    let mut caches = ExtensionCaches::new();
    let state = caches.get_or_insert("chart", "c1", || ChartState {
        data: vec![],
        generation: GenerationCounter::new(),
    });
    let gen_before = state.generation.get();
    state.data = vec![1.0, 2.0];
    state.generation.bump();
    assert_ne!(gen_before, state.generation.get());
}

// ============================================================================
// Extension guide: EventResult patterns
// ============================================================================

// Validates: extension-guide.md "Tier B: handling events" section
#[test]
fn extension_guide_event_result() {
    // Consumed: suppress original, emit replacement
    let result = EventResult::Consumed(vec![OutgoingEvent::extension_event(
        "item_selected",
        "w1",
        Some(json!({"index": 3})),
    )]);
    match result {
        EventResult::Consumed(events) => assert_eq!(events[0].family, "item_selected"),
        _ => panic!("expected Consumed"),
    }

    // Observed: forward original + emit additional
    let result = EventResult::Observed(vec![OutgoingEvent::extension_event(
        "scroll_stats",
        "w1",
        None,
    )]);
    assert!(matches!(result, EventResult::Observed(_)));

    // PassThrough: forward as-is
    let result = EventResult::PassThrough;
    assert!(matches!(result, EventResult::PassThrough));
}

// ============================================================================
// Extension guide: CoalesceHint
// ============================================================================

// Validates: extension-guide.md "CoalesceHint for continuous events" section
#[test]
fn extension_guide_coalesce_hint() {
    let event =
        OutgoingEvent::extension_event("cursor_pos", "w1", Some(json!({"x": 10.0, "y": 20.0})))
            .with_coalesce(CoalesceHint::Replace);
    assert!(event.coalesce.is_some());
}

// ============================================================================
// Extension guide: handle_command pattern
// ============================================================================

struct DocCommandWidget;

impl WidgetExtension for DocCommandWidget {
    fn type_names(&self) -> &[&str] {
        &["doc_cmd"]
    }
    fn config_key(&self) -> &str {
        "doc_cmd"
    }

    fn render<'a>(&self, _node: &'a TreeNode, _env: &WidgetEnv<'a>) -> Element<'a, Message> {
        text("cmd widget").into()
    }

    fn handle_command(
        &mut self,
        node_id: &str,
        op: &str,
        payload: &Value,
        _caches: &mut ExtensionCaches,
    ) -> Vec<OutgoingEvent> {
        match op {
            "export" => {
                let format = payload
                    .get("format")
                    .and_then(|v| v.as_str())
                    .unwrap_or("png");
                vec![OutgoingEvent::extension_event(
                    "exported",
                    node_id,
                    Some(json!({"format": format, "size": 1024})),
                )]
            }
            _ => vec![],
        }
    }
}

// Validates: extension-guide.md "Tier C: receiving commands from the host" section
#[test]
fn extension_guide_handle_command() {
    let mut ext = DocCommandWidget;
    let mut caches = ExtensionCaches::new();
    let events = ext.handle_command("w1", "export", &json!({"format": "svg"}), &mut caches);
    assert_eq!(events.len(), 1);
    assert_eq!(events[0].family, "exported");
}

// ============================================================================
// Extension guide: cleanup pattern
// ============================================================================

struct DocCleanupWidget {
    closed_connections: Vec<String>,
}

impl WidgetExtension for DocCleanupWidget {
    fn type_names(&self) -> &[&str] {
        &["doc_cleanup"]
    }
    fn config_key(&self) -> &str {
        "doc_cleanup"
    }

    fn render<'a>(&self, _node: &'a TreeNode, _env: &WidgetEnv<'a>) -> Element<'a, Message> {
        text("cleanup widget").into()
    }

    fn cleanup(&mut self, node_id: &str, _caches: &mut ExtensionCaches) {
        // Cache entry is auto-removed after this method returns.
        // Only implement this for external resource cleanup.
        self.closed_connections.push(node_id.to_string());
    }
}

// Validates: extension-guide.md "Cleanup" section
#[test]
fn extension_guide_cleanup_external_resources() {
    let mut ext = DocCleanupWidget {
        closed_connections: vec![],
    };
    let mut caches = ExtensionCaches::new();
    ext.cleanup("w1", &mut caches);
    assert_eq!(ext.closed_connections, vec!["w1"]);
}

// ============================================================================
// Extension guide: Rating widget (complete example)
// ============================================================================

struct DocRating;

impl WidgetExtension for DocRating {
    fn type_names(&self) -> &[&str] {
        &["doc_rating"]
    }
    fn config_key(&self) -> &str {
        "doc_rating"
    }

    fn render<'a>(&self, node: &'a TreeNode, env: &WidgetEnv<'a>) -> Element<'a, Message> {
        let value = node.prop_f32("value").unwrap_or(0.0) as usize;
        let max = prop_u32(node.props(), "max").unwrap_or(5) as usize;
        let size = node.prop_f32("size").unwrap_or(24.0);
        let color = node
            .prop_color("color")
            .unwrap_or(env.theme().palette().primary.base.color);
        let disabled_color = Color {
            a: color.a * 0.3,
            ..color
        };

        let id = node.id.clone();
        let mut stars = row![].spacing(2);

        for i in 1..=max {
            let filled = i <= value;
            let star_color = if filled { color } else { disabled_color };
            let label = if filled { "\u{2605}" } else { "\u{2606}" };

            let star_text = text(label).size(size).color(star_color);

            let star_button = button(star_text)
                .on_press(Message::widget_event(&id, "select", json!({"value": i})))
                .padding(0)
                .style(button::text);

            stars = stars.push(star_button);
        }

        stars.into()
    }

    fn new_instance(&self) -> Box<dyn WidgetExtension> {
        Box::new(DocRating)
    }
}

// Validates: extension-guide.md "Complete example: a rating widget" section
#[test]
fn extension_guide_rating_renders() {
    let ext = DocRating;
    let node = node_with_props(
        "r1",
        "doc_rating",
        json!({"value": 3, "max": 5, "size": 32}),
    );
    let test = TestEnv::default();
    let ctx = test.render_ctx();
    let env = test.env(&ctx);
    let _element = ext.render(&node, &env);
}

// Validates: extension-guide.md "Complete example: a rating widget" section
#[test]
fn extension_guide_rating_no_props() {
    let ext = DocRating;
    let node = node("r1", "doc_rating");
    let test = TestEnv::default();
    let ctx = test.render_ctx();
    let env = test.env(&ctx);
    let _element = ext.render(&node, &env);
}

// ============================================================================
// Extension guide: new_instance
// ============================================================================

// Validates: extension-guide.md "Multi-session support" section
#[test]
fn extension_guide_new_instance() {
    let ext = DocRating;
    let _instance: Box<dyn WidgetExtension> = ext.new_instance();
}