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
//! Hooks for implementing pagination

use crate::prelude::Navigation;
use std::ops::{Deref, DerefMut, Range};
use std::rc::Rc;
use yew::prelude::*;

pub const DEFAULT_PER_PAGE: usize = 10;

/// The current control (input settings) of the pagination
#[derive(Copy, Clone, Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
pub struct PaginationControl {
    pub page: usize,
    pub per_page: usize,
}

/// The current state of the pagination
#[derive(Copy, Clone, Debug, Default, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
pub struct PaginationState {
    pub control: PaginationControl,
    pub total: Option<usize>,
}

impl PaginationState {
    fn change_page(mut self, page: usize) -> Self {
        self.control.page = page;
        self
    }

    fn change_per_page(mut self, per_page: usize) -> Self {
        // remember the current offset
        let current_offset = self.control.page * self.control.per_page;

        self.control.per_page = per_page.max(1);

        // point to the page with the same offset as before
        self.control.page = current_offset / self.control.per_page;

        self
    }

    fn change_total(mut self, total: Option<usize>) -> Self {
        // set the new total
        self.total = total;

        // and check if we need to cap the current page
        if let Some(total_pages) = self.total_pages() {
            if total_pages > 0 {
                self.control.page = self.control.page.min(total_pages - 1);
            } else {
                self.control.page = 0;
            }
        }

        self
    }

    pub fn navigate(self, navigation: Navigation) -> Self {
        let mut newpage = self.control.page;
        match navigation {
            Navigation::First => newpage = 0,
            Navigation::Last => {
                if let Some(total_pages) = self.total_pages() {
                    newpage = total_pages.saturating_sub(1);
                }
            }
            Navigation::Next => {
                newpage = newpage.saturating_add(1);
                if let Some(total_pages) = self.total_pages() {
                    newpage = newpage.min(total_pages.max(1) - 1);
                }
            }
            Navigation::Previous => {
                newpage = newpage.saturating_sub(1);
            }
            Navigation::Page(page) => {
                if let Some(total_pages) = self.total_pages() {
                    if page < total_pages {
                        newpage = page;
                    }
                } else {
                    newpage = page;
                }
            }
        };

        self.change_page(newpage)
    }

    pub fn offset(&self) -> usize {
        self.control.per_page * self.control.page
    }

    pub fn range(&self) -> Range<usize> {
        let start = self.offset();
        let mut end = start + self.control.per_page;
        if let Some(total) = self.total {
            end = end.min(total);
        }

        Range { start, end }
    }

    pub fn total_pages(&self) -> Option<usize> {
        self.total
            .map(|total| (total + self.control.per_page - 1) / self.control.per_page)
    }
}

impl Default for PaginationControl {
    fn default() -> Self {
        Self {
            page: 0,
            per_page: DEFAULT_PER_PAGE,
        }
    }
}

#[derive(Debug, PartialEq, Clone)]
pub struct UsePagination {
    pub state: UseStateHandle<PaginationState>,
    pub onnavigation: Callback<Navigation>,
    pub onperpagechange: Callback<usize>,
}

impl Deref for UsePagination {
    type Target = PaginationState;

    fn deref(&self) -> &Self::Target {
        &self.state
    }
}

impl Deref for PaginationState {
    type Target = PaginationControl;

    fn deref(&self) -> &Self::Target {
        &self.control
    }
}

impl DerefMut for PaginationState {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.control
    }
}

/// Create a hook for managing pagination state.
///
/// If known, the hook takes in a total number of items to be shown, otherwise it will be an
/// unbounded pagination control. The state will be initialized using the initializer function.
///
/// The hook returns a struct to manage and track pagination state. It is intended to be used
/// in combination with the [`crate::components::pagination::SimplePagination`] component.
///
/// ## Example
///
/// Also see the quickstart project for a full example.
///
/// ```rust
/// use yew::prelude::*;
/// use patternfly_yew::prelude::*;
///
/// #[function_component(Example)]
/// fn example() -> Html {
///   let total = use_state_eq(||Some(123));
///   let pagination = use_pagination(*total, Default::default);
///
///   html!(
///     <>
///       <SimplePagination
///         pagination={pagination.clone()}
///         total={*total}
///       />
///       // ... render content
///       { format!("Showing items: {:?}", pagination.state.range()) }
///       <SimplePagination
///         pagination={pagination.clone()}
///         total={*total}
///         position={PaginationPosition::Bottom}
///       />
///     </>
///   )
/// }
/// ```
#[hook]
pub fn use_pagination<T>(total: Option<usize>, init: T) -> UsePagination
where
    T: FnOnce() -> PaginationControl,
{
    let state = use_state_eq(|| PaginationState {
        control: init(),
        total,
    });

    use_effect_with((total, state.clone()), move |(total, state)| {
        state.set((**state).change_total(*total));
    });

    let onnavigation = use_callback(state.clone(), |nav: Navigation, state| {
        state.set((**state).navigate(nav))
    });

    let onperpagechange = use_callback(state.clone(), |per_page, state| {
        state.set((**state).change_per_page(per_page))
    });

    UsePagination {
        state,
        onnavigation,
        onperpagechange,
    }
}

/// Apply pagination state to a set of data.
///
/// Ideally, pagination is applied on the source of the data. Like a database query. However,
/// sometimes it can be convenient to even paginate a fully loaded dataset.
///
/// This hook takes a full dataset and returns the currently selected page. It will update
/// whenever the entries or pagination control state changes.
#[hook]
fn use_apply_pagination<T>(entries: Rc<Vec<T>>, control: PaginationControl) -> Rc<Vec<T>>
where
    T: Clone + PartialEq + 'static,
{
    use_memo((entries, control), |(entries, control)| {
        let offset = control.per_page * control.page;
        let limit = control.per_page;
        entries
            .iter()
            // apply pagination window
            .skip(offset)
            .take(limit)
            .cloned()
            .collect::<Vec<_>>()
    })
}

#[cfg(test)]
mod test {

    use super::*;

    fn state(page: usize, per_page: usize, total: Option<usize>) -> PaginationState {
        PaginationState {
            control: PaginationControl { per_page, page },
            total,
        }
    }

    #[test]
    fn test_navigate() {
        let state = state(0, 10, Some(23));
        assert_eq!(state.total_pages(), Some(3));
        assert_eq!(state.control.page, 0);
        assert_eq!(state.offset(), 0);
        assert_eq!(state.range(), 0..10);

        let state = state.navigate(Navigation::First);
        assert_eq!(state.total_pages(), Some(3));
        assert_eq!(state.control.page, 0);
        assert_eq!(state.offset(), 0);
        assert_eq!(state.range(), 0..10);

        let state = state.navigate(Navigation::Last);
        assert_eq!(state.total_pages(), Some(3));
        assert_eq!(state.control.page, 2);
        assert_eq!(state.offset(), 20);
        assert_eq!(state.range(), 20..23);

        let state = state.navigate(Navigation::Previous);
        assert_eq!(state.total_pages(), Some(3));
        assert_eq!(state.control.page, 1);
        assert_eq!(state.offset(), 10);
        assert_eq!(state.range(), 10..20);

        let state = state.navigate(Navigation::Previous);
        assert_eq!(state.total_pages(), Some(3));
        assert_eq!(state.control.page, 0);
        assert_eq!(state.offset(), 0);
        assert_eq!(state.range(), 0..10);
    }

    /// ensure that it's not possible to navigate before the first page
    #[test]
    fn test_underflow() {
        let state = state(0, 10, Some(23));

        let state = state.navigate(Navigation::Previous);
        assert_eq!(state.total_pages(), Some(3));
        assert_eq!(state.control.page, 0);
        assert_eq!(state.offset(), 0);
        assert_eq!(state.range(), 0..10);
    }

    /// ensure start "next" stops with the last page
    #[test]
    fn test_overflow_1() {
        let state = state(0, 10, Some(23));

        let state = state.navigate(Navigation::Last);
        assert_eq!(state.total_pages(), Some(3));
        assert_eq!(state.control.page, 2);
        assert_eq!(state.offset(), 20);
        assert_eq!(state.range(), 20..23);

        let state = state.navigate(Navigation::Next);
        assert_eq!(state.total_pages(), Some(3));
        assert_eq!(state.control.page, 2);
        assert_eq!(state.offset(), 20);
        assert_eq!(state.range(), 20..23);
    }

    /// ensure that navigating beyond the last page doesn't work
    #[test]
    fn test_overflow_2() {
        let state = state(0, 10, Some(23));
        assert_eq!(state.total_pages(), Some(3));

        let state = state.navigate(Navigation::Page(5));
        assert_eq!(state.total_pages(), Some(3));
        assert_eq!(state.control.page, 0);
        assert_eq!(state.offset(), 0);
        assert_eq!(state.range(), 0..10);
    }

    #[test]
    fn test_change_page_size() {
        let state = state(0, 10, Some(23));
        assert_eq!(state.total_pages(), Some(3));
        assert_eq!(state.control.page, 0);
        assert_eq!(state.offset(), 0);
        assert_eq!(state.range(), 0..10);

        let state = state.navigate(Navigation::Next);
        assert_eq!(state.total_pages(), Some(3));
        assert_eq!(state.control.page, 1);
        assert_eq!(state.offset(), 10);
        assert_eq!(state.range(), 10..20);

        let state = state.change_per_page(5);
        assert_eq!(state.total_pages(), Some(5));
        assert_eq!(state.control.page, 2);
        assert_eq!(state.offset(), 10);
        assert_eq!(state.range(), 10..15);
    }

    #[test]
    fn test_change_none() {
        let state = state(0, 10, None);
        assert_eq!(state.total_pages(), None);
        assert_eq!(state.control.page, 0);
        assert_eq!(state.offset(), 0);
        assert_eq!(state.range(), 0..10);
    }

    #[test]
    fn test_change_empty() {
        let state = state(0, 10, Some(0));
        assert_eq!(state.total_pages(), Some(0));
        assert_eq!(state.control.page, 0);
        assert_eq!(state.offset(), 0);
        assert_eq!(state.range(), 0..0);
    }

    #[test]
    fn test_total_pages() {
        for i in 0..100 {
            let state = state(0, 10, Some(i));
            assert_eq!(
                state.total_pages(),
                Some((i as f64 / 10f64).ceil() as usize)
            );
        }
    }
}