headless_common 0.1.1

Shared types useful for making requests to various Liferay headless APIs
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

use std::{
    fmt::Display,
    ops::{Deref, DerefMut},
};

#[derive(Debug, Default, PartialEq, Clone)]
pub struct SortCollection<'a>(Vec<SortParameter<'a>>);

impl<'a> SortCollection<'a> {
    pub fn new() -> Self {
        Self(Vec::new())
    }
}

impl<'a> Deref for SortCollection<'a> {
    type Target = Vec<SortParameter<'a>>;

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

impl<'a> DerefMut for SortCollection<'a> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}

/// Params common to Page requests
#[derive(Clone, Debug, PartialEq, Default)]
pub struct SortParameter<'a> {
    field: &'a str,
    sort_order: SortOrder,
}

impl<'a> SortParameter<'a> {
    pub fn new(field: &'a str) -> Self {
        Self {
            field,
            ..Default::default()
        }
    }

    pub fn set_sort_order(mut self, sort_order: SortOrder) -> Self {
        self.sort_order = sort_order;
        self
    }

    pub fn set_descending(mut self) -> Self {
        self.sort_order = SortOrder::Descending;
        self
    }

    pub fn set_ascending(mut self) -> Self {
        self.sort_order = SortOrder::Ascending;
        self
    }
}

impl<'a> Display for SortParameter<'a> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}:{}", self.field, self.sort_order)
    }
}

impl<'a> Display for SortCollection<'a> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(
            f,
            "{}",
            self.0
                .iter()
                .map(|item| item.to_string())
                .collect::<Vec<_>>()
                .join(",")
        )
    }
}

#[derive(Clone, Debug, PartialEq, Default)]
pub enum SortOrder {
    #[default]
    Ascending,
    Descending,
}

impl Display for SortOrder {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Ascending => write!(f, "asc"),
            Self::Descending => write!(f, "desc"),
        }
    }
}

#[cfg(test)]
mod test {
    use crate::api::sort::{SortCollection, SortParameter};

    #[test]
    fn single() {
        let mut coll = SortCollection::new();
        coll.push(SortParameter::new("field1"));
        let actual = coll.to_string();
        let expected = "field1:asc";
        assert_eq!(actual, expected);
    }

    #[test]
    fn list() {
        let mut coll = SortCollection::new();
        coll.push(SortParameter::new("field1"));
        coll.push(SortParameter::new("field2").set_descending());
        let actual = coll.to_string();
        let expected = "field1:asc,field2:desc";
        assert_eq!(actual, expected);
    }
}