cranpose-ui 0.1.130

UI primitives for Cranpose
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
use std::{
    cell::{Cell, RefCell},
    rc::Rc,
};

use cranpose_core::{Composition, MemoryApplier, MutableState, NodeId, location_key};
use cranpose_foundation::lazy::{LazyListScope, LazyListState, rememberLazyListState};
use cranpose_ui_graphics::Size as ViewportSize;

use super::*;

#[test]
fn lazy_row_unbounded_width_matches_effective_viewport() {
    let captured_state = Rc::new(RefCell::new(None));
    let mut composition = run_test_composition({
        let captured_state = Rc::clone(&captured_state);
        move || {
            let list_state = rememberLazyListState();
            *captured_state.borrow_mut() = Some(list_state);

            LazyRow(
                Modifier::empty(),
                list_state,
                LazyRowSpec::default(),
                |scope| {
                    scope.items(100, |_| {
                        Spacer(Size {
                            width: 100.0,
                            height: 0.0,
                        });
                    });
                },
            );
        }
    });

    let root = composition.root().expect("lazy row root");
    let handle = composition.runtime_handle();
    let measurements = {
        let mut applier = composition.applier_mut();
        applier.set_runtime_handle(handle);
        let result = measure_layout(
            &mut applier,
            root,
            ViewportSize {
                width: f32::INFINITY,
                height: 320.0,
            },
        )
        .expect("layout measurement");
        applier.clear_runtime_handle();
        result
    };

    let list_state = (*captured_state.borrow()).expect("state captured");
    let expected_width = list_state.layout_info().viewport_size;
    let actual_width = measurements.root_size().width;

    assert!(actual_width.is_finite());
    assert!(
        (actual_width - expected_width).abs() < 0.01,
        "expected lazy row width to match effective viewport {expected_width}, got {actual_width}"
    );
}

#[composable]
#[allow(non_snake_case)]
fn GrowingLazyRow(
    item_count: MutableState<usize>,
    captured_state: Rc<RefCell<Option<LazyListState>>>,
    call_count: Rc<Cell<usize>>,
) {
    let list_state = rememberLazyListState();
    *captured_state.borrow_mut() = Some(list_state);
    let count = item_count.value();
    call_count.set(call_count.get() + 1);

    Column(Modifier::empty(), ColumnSpec::default(), move || {
        Text(
            format!("Count {count}"),
            Modifier::empty(),
            TextStyle::default(),
        );
        LazyRow(
            Modifier::empty().height(120.0),
            list_state,
            LazyRowSpec::new().horizontal_arrangement(LinearArrangement::SpacedBy(8.0)),
            |scope| {
                scope.items(count, |index| {
                    Row(
                        Modifier::empty().height(48.0).width(96.0),
                        RowSpec::default(),
                        move || {
                            Text(
                                format!("Item {}", index),
                                Modifier::empty(),
                                TextStyle::default(),
                            );
                        },
                    );
                });
            },
        );
    });
}

#[test]
fn lazy_row_updates_scroll_bounds_when_item_count_grows_without_scrolling() {
    let _app_context = crate::render_state::app_context_test_scope();
    let mut composition = Composition::new(MemoryApplier::new());
    let runtime = composition.runtime_handle();
    let item_count = MutableState::with_runtime(2usize, runtime.clone());
    let captured_state = Rc::new(RefCell::new(None));
    let call_count = Rc::new(Cell::new(0));

    let key = location_key(file!(), line!(), column!());
    composition
        .render(key, {
            let captured_state = Rc::clone(&captured_state);
            let call_count = Rc::clone(&call_count);
            move || {
                GrowingLazyRow(
                    item_count,
                    Rc::clone(&captured_state),
                    Rc::clone(&call_count),
                );
            }
        })
        .expect("initial render");

    let root = composition.root().expect("lazy row root");
    let viewport = Size {
        width: 260.0,
        height: 320.0,
    };
    measure_root(&mut composition, root, viewport);

    let list_state = (*captured_state.borrow()).expect("state captured");
    assert_eq!(list_state.layout_info().total_items_count, 2);
    assert!(
        !list_state.can_scroll_forward(),
        "initial short row should not scroll"
    );

    item_count.set(24);
    let mut recomposed = false;
    while composition
        .process_invalid_scopes()
        .expect("recompose after item count growth")
    {
        recomposed = true;
    }
    assert!(
        recomposed,
        "expected composition to re-run after item count growth"
    );
    assert!(
        call_count.get() >= 2,
        "expected LazyRow parent composable to execute again after item count growth"
    );
    measure_root(&mut composition, root, viewport);

    assert_eq!(list_state.layout_info().total_items_count, 24);
    assert!(
        list_state.can_scroll_forward(),
        "lazy row should become scrollable when item count grows beyond viewport"
    );
    let texts = render_texts(&mut composition, root);
    assert!(
        texts.iter().any(|text| text == "Count 24"),
        "expected parent composition to observe the grown item count"
    );
}

#[composable]
#[allow(non_snake_case)]
fn HorizontalScrollIndicatorLazyRow(captured_state: Rc<RefCell<Option<LazyListState>>>) {
    let list_state = rememberLazyListState();
    *captured_state.borrow_mut() = Some(list_state);

    Column(Modifier::empty(), ColumnSpec::default(), move || {
        Text(
            format!("First visible {}", list_state.first_visible_item_index()),
            Modifier::empty(),
            TextStyle::default(),
        );
        Text(
            format!("Can scroll back {}", list_state.can_scroll_backward()),
            Modifier::empty(),
            TextStyle::default(),
        );
        LazyRow(
            Modifier::empty().fill_max_height().width(240.0),
            list_state,
            LazyRowSpec::new().horizontal_arrangement(LinearArrangement::SpacedBy(8.0)),
            |scope| {
                scope.items(80, |index| {
                    Text(
                        format!("Item {}", index),
                        Modifier::empty().width(48.0),
                        TextStyle::default(),
                    );
                });
            },
        );
    });
}

const INDICATOR_VIEWPORT: Size = Size {
    width: 320.0,
    height: 320.0,
};

fn measured_indicator_lazy_row() -> (
    Composition<MemoryApplier>,
    NodeId,
    Rc<RefCell<Option<LazyListState>>>,
) {
    let mut composition = Composition::new(MemoryApplier::new());
    let captured_state = Rc::new(RefCell::new(None));

    composition
        .render(location_key(file!(), line!(), column!()), {
            let captured_state = Rc::clone(&captured_state);
            move || {
                HorizontalScrollIndicatorLazyRow(Rc::clone(&captured_state));
            }
        })
        .expect("initial render");

    let root = composition.root().expect("lazy row root");
    measure_root(&mut composition, root, INDICATOR_VIEWPORT);
    (composition, root, captured_state)
}

#[test]
fn lazy_row_gesture_scroll_moves_rendered_items_along_the_horizontal_axis() {
    let _app_context = crate::render_state::app_context_test_scope();
    let (mut composition, root, captured_state) = measured_indicator_lazy_row();
    let viewport = INDICATOR_VIEWPORT;
    let initial_texts = render_texts(&mut composition, root);
    assert!(
        initial_texts.iter().any(|text| text == "First visible 0"),
        "test must subscribe a composition scope to the scroll position"
    );
    assert!(
        initial_texts
            .iter()
            .any(|text| text == "Can scroll back false"),
        "test must subscribe a composition scope to lazy scroll bounds"
    );
    let initial_records = render_text_records(&mut composition, root);
    let initial_item_0_x = text_x(&initial_records, "Item 0");
    let initial_item_0_y = text_y(&initial_records, "Item 0");

    let list_state = (*captured_state.borrow()).expect("state captured");
    list_state.dispatch_scroll_delta(-40.0);
    measure_root(&mut composition, root, viewport);

    assert!(
        list_state.can_scroll_backward_non_reactive(),
        "gesture scroll should update retained lazy scroll bounds"
    );
    assert!(
        composition
            .process_invalid_scopes()
            .expect("gesture scroll invalidation processing"),
        "gesture scroll must recompose scopes that observe public scroll position"
    );
    measure_root(&mut composition, root, viewport);
    let scrolled_texts = render_texts(&mut composition, root);
    assert!(
        scrolled_texts
            .iter()
            .any(|text| text == "Can scroll back true"),
        "scroll observer text did not track gesture-updated backward capability; got {scrolled_texts:?}"
    );

    let scrolled_records = render_text_records(&mut composition, root);
    let scrolled_item_0_x = text_x(&scrolled_records, "Item 0");
    let scrolled_item_0_y = text_y(&scrolled_records, "Item 0");
    assert!(
        (initial_item_0_x - scrolled_item_0_x - 40.0).abs() < 0.5,
        "scrolling a lazy row should move its rendered items along x by the scroll delta: \
         initial_x={initial_item_0_x}, scrolled_x={scrolled_item_0_x}"
    );
    assert!(
        (initial_item_0_y - scrolled_item_0_y).abs() < 0.01,
        "scrolling a lazy row must not move its rendered items along y: \
         initial_y={initial_item_0_y}, scrolled_y={scrolled_item_0_y}"
    );
}

#[derive(Debug)]
struct RenderedText {
    value: String,
    x: f32,
    y: f32,
}

fn render_texts(composition: &mut Composition<MemoryApplier>, root: NodeId) -> Vec<String> {
    render_text_records(composition, root)
        .into_iter()
        .map(|record| record.value)
        .collect()
}

fn render_text_records(
    composition: &mut Composition<MemoryApplier>,
    root: NodeId,
) -> Vec<RenderedText> {
    let handle = composition.runtime_handle();
    let mut applier = composition.applier_mut();
    applier.set_runtime_handle(handle);
    let layout = applier
        .compute_layout(
            root,
            Size {
                width: 320.0,
                height: 320.0,
            },
        )
        .expect("layout");
    applier.clear_runtime_handle();
    let renderer = HeadlessRenderer::new();
    let scene = renderer.render(&layout);
    scene
        .operations()
        .iter()
        .filter_map(|op| match op {
            RenderOp::Text { rect, value, .. } => Some(RenderedText {
                value: value.clone(),
                x: rect.x,
                y: rect.y,
            }),
            _ => None,
        })
        .collect()
}

fn text_x(records: &[RenderedText], value: &str) -> f32 {
    records
        .iter()
        .find(|record| record.value == value)
        .unwrap_or_else(|| panic!("expected rendered text {value:?}, got {records:?}"))
        .x
}

fn text_y(records: &[RenderedText], value: &str) -> f32 {
    records
        .iter()
        .find(|record| record.value == value)
        .unwrap_or_else(|| panic!("expected rendered text {value:?}, got {records:?}"))
        .y
}

fn measure_root(composition: &mut Composition<MemoryApplier>, root: NodeId, size: Size) {
    let handle = composition.runtime_handle();
    let mut applier = composition.applier_mut();
    applier.set_runtime_handle(handle);
    let _ = applier.compute_layout(root, size).expect("layout");
    applier.clear_runtime_handle();
}

#[test]
fn a_reader_page_moves_a_lazy_row_forward() {
    let _app_context = crate::render_state::app_context_test_scope();
    let (mut composition, root, captured_state) = measured_indicator_lazy_row();
    let viewport = INDICATOR_VIEWPORT;
    let initial_records = render_text_records(&mut composition, root);
    let initial_item_0_x = text_x(&initial_records, "Item 0");
    let list_state = (*captured_state.borrow()).expect("state captured");

    let mut config = cranpose_foundation::SemanticsConfiguration::default();
    crate::modifier::lazy_scroll_semantics(list_state, false, false)(&mut config);
    let scroll_by = config
        .scroll_by
        .expect("a lazy row takes a page from a reader");
    assert!(
        config.horizontal_scroll.is_some(),
        "a lazy row says it scrolls"
    );
    assert!(scroll_by.invoke(40.0, 0.0), "a page forward moves the row");

    measure_root(&mut composition, root, viewport);
    let scrolled_records = render_text_records(&mut composition, root);
    let scrolled_item_0_x = text_x(&scrolled_records, "Item 0");
    assert!(
        (initial_item_0_x - scrolled_item_0_x - 40.0).abs() < 0.5,
        "a positive page delta moves the rows the way a forward scroll does: \
         initial_x={initial_item_0_x}, scrolled_x={scrolled_item_0_x}"
    );
    assert!(list_state.can_scroll_backward_non_reactive());
}

#[test]
fn a_reader_hears_how_many_items_a_lazy_row_holds() {
    let _app_context = crate::render_state::app_context_test_scope();
    let (_composition, _root, captured_state) = measured_indicator_lazy_row();
    let list_state = (*captured_state.borrow()).expect("state captured");

    let mut config = cranpose_foundation::SemanticsConfiguration::default();
    crate::modifier::lazy_scroll_semantics(list_state, false, false)(&mut config);
    let collection = config
        .collection
        .expect("a lazy row says how many items it holds");
    assert_eq!((collection.rows, collection.columns), (1, 80));
}