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
use std::borrow::Borrow;
use std::fmt::{self, Display, Formatter};
use std::ops::Deref;
use std::str::FromStr;

use serde::de::{self, Deserialize, Deserializer, Visitor};
use serde::ser::{Serialize, Serializer};

use error::Error;
use sealed::Sealed;
use value::Stringify;

/// Represents a single member name.
///
/// When a new `Key` is parsed, the underlying value's casing convention is converted to
/// kebab-case.
///
/// # Example
///
/// ```
/// # extern crate json_api;
/// #
/// # use std::str::FromStr;
/// #
/// # use json_api::Error;
/// # use json_api::value::Key;
/// #
/// # fn example() -> Result<(), Error> {
/// let key = Key::from_str("someFieldName")?;
/// assert_eq!(key, "some-field-name");
/// #
/// # Ok(())
/// # }
/// #
/// # fn main() {
/// # example().unwrap()
/// # }
/// ```
#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct Key(String);

impl Key {
    #[doc(hidden)]
    #[inline]
    pub fn from_raw(value: String) -> Self {
        Key(value)
    }
}

impl AsRef<[u8]> for Key {
    fn as_ref(&self) -> &[u8] {
        self.as_bytes()
    }
}

impl AsRef<str> for Key {
    fn as_ref(&self) -> &str {
        self
    }
}

impl Borrow<str> for Key {
    fn borrow(&self) -> &str {
        self
    }
}

impl Deref for Key {
    type Target = str;

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

impl Display for Key {
    fn fmt(&self, f: &mut Formatter) -> fmt::Result {
        f.write_str(self)
    }
}

impl From<Key> for String {
    fn from(key: Key) -> Self {
        let Key(value) = key;
        value
    }
}

impl FromStr for Key {
    type Err = Error;

    fn from_str(source: &str) -> Result<Key, Self::Err> {
        if source.is_empty() {
            bail!("cannot be blank");
        }

        // We should reserve a bit more than what we need so in
        // the event that we end up converting camelCase to
        // kebab-case, we don't have to reallocate.
        let mut dest = String::with_capacity(source.len() + 10);
        let mut chars = source.chars().peekable();

        while let Some(value) = chars.next() {
            match value {
                '\u{002e}' |
                '\u{002f}' |
                '\u{0040}' |
                '\u{0060}' |
                '\u{0000}'...'\u{001f}' |
                '\u{0021}'...'\u{0029}' |
                '\u{002a}'...'\u{002c}' |
                '\u{003a}'...'\u{003f}' |
                '\u{005b}'...'\u{005e}' |
                '\u{007b}'...'\u{007f}' => {
                    bail!("reserved '{}'", value);
                }
                '_' | '-' | ' ' if dest.is_empty() => {
                    bail!("cannot start with '{}'", value);
                }
                '_' | '-' | ' ' => match chars.peek() {
                    Some(&'-') | Some(&'_') | Some(&' ') | Some(&'A'...'Z') => {
                        continue;
                    }
                    Some(_) => {
                        dest.push('-');
                    }
                    None => {
                        bail!("cannot end with '{}'", value);
                    }
                },
                'A'...'Z' if dest.ends_with('-') => {
                    dest.push(as_lowercase(value));
                }
                'A'...'Z' => {
                    dest.push('-');
                    dest.push(as_lowercase(value));
                }
                _ => {
                    dest.push(value);
                }
            }
        }

        Ok(Key(dest))
    }
}

impl PartialEq<String> for Key {
    fn eq(&self, rhs: &String) -> bool {
        &self.0 == rhs
    }
}

impl PartialEq<str> for Key {
    fn eq(&self, rhs: &str) -> bool {
        &**self == rhs
    }
}

impl<'a> PartialEq<&'a str> for Key {
    fn eq(&self, rhs: &&str) -> bool {
        &**self == *rhs
    }
}

impl<'de> Deserialize<'de> for Key {
    fn deserialize<D>(deserializer: D) -> Result<Key, D::Error>
    where
        D: Deserializer<'de>,
    {
        struct KeyVisitor;

        impl<'de> Visitor<'de> for KeyVisitor {
            type Value = Key;

            fn expecting(&self, f: &mut Formatter) -> fmt::Result {
                f.write_str("a valid json api member name")
            }

            fn visit_str<E>(self, value: &str) -> Result<Self::Value, E>
            where
                E: de::Error,
            {
                value.parse().map_err(de::Error::custom)
            }
        }

        deserializer.deserialize_str(KeyVisitor)
    }
}

impl Serialize for Key {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.serialize_str(self)
    }
}

impl Sealed for Key {}

impl Stringify for Key {
    fn to_bytes(&self) -> Vec<u8> {
        self.as_bytes().to_vec()
    }
}

#[inline]
fn as_lowercase(value: char) -> char {
    (value as u8 + 32) as char
}