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
use hyper;
use std;

use DatabaseName;
use DatabasePath;
use DesignDocumentName;
use DesignDocumentPath;
use Error;
use ViewName;
use error::BadPathKind;

/// Trait for converting a type into a `ViewPath`.
pub trait IntoViewPath {
    /// Converts self into a `ViewPath`.
    fn into_view_path(self) -> Result<ViewPath, Error>;
}

impl<'a> IntoViewPath for &'a str {
    fn into_view_path(self) -> Result<ViewPath, Error> {
        use std::str::FromStr;
        ViewPath::from_str(self)
    }
}

impl IntoViewPath for ViewPath {
    fn into_view_path(self) -> Result<ViewPath, Error> {
        Ok(self)
    }
}

impl<T: Into<DesignDocumentPath>> IntoViewPath for (T, ViewName) {
    fn into_view_path(self) -> Result<ViewPath, Error> {
        let ddoc_path = self.0.into();
        let (db_name, ddoc_name) = ddoc_path.into();
        let view_path = ViewPath {
            db_name: db_name,
            ddoc_name: ddoc_name,
            view_name: self.1,
        };
        Ok(view_path)
    }
}

/// Path part of a URI specifying a view.
///
/// A view path comprises five URI path components specifying a database name,
/// design document name, and view name—the
/// `/db/_design/design-doc/_view/view-name` part of
/// `http://example.com:5984/db/_design/design-doc/_view/view-name`.
///
/// View paths are percent-encoded. For example,
/// `/foo/_design/bar/_view/qux%2Fbaz` identifies the
/// database named `foo`, the design document named `bar`, and the view named
/// `qux%2Fbaz`. When a `ViewPath` is constructed from name and path types, the
/// percent-encoding is done automatically. When constructing a `ViewPath` from
/// a string, the string must be percent-encoded.
///
/// Although the `ViewPath` type implements the `Ord` and `PartialOrd` traits,
/// it provides no guarantees how that ordering is defined and may change the
/// definition between any two releases of the couchdb crate. That is, for two
/// `ViewPath` values `a` and `b`, the expression `a < b` may hold true now but
/// not in a subsequent release. Consequently, applications must not rely upon
/// any particular ordering definition.
///
#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct ViewPath {
    db_name: DatabaseName,
    ddoc_name: DesignDocumentName,
    view_name: ViewName,
}

impl ViewPath {
    /// Constructs a `ViewPath` from a given string.
    ///
    /// The `path` string must begin with a leading slash and be
    /// percent-encoded—e.g., `/foo/_design/bar/_view/qux%2Fbaz` for the
    /// database named `foo`, the design document named `bar`, and the view
    /// named `qux/baz`.
    ///
    pub fn parse<T: AsRef<str>>(path: T) -> Result<Self, Error> {
        use std::str::FromStr;
        ViewPath::from_str(path.as_ref())
    }

    /// Converts self into a URI.
    pub fn into_uri(self, base_uri: hyper::Url) -> hyper::Url {

        let mut uri = base_uri;

        {
            use super::percent::percent_encode_uri_path;

            let mut p = uri.path_mut().unwrap();
            if p.last().map_or(false, |x| x.is_empty()) {
                p.pop();
            }

            p.reserve(5);
            p.push(percent_encode_uri_path(&self.db_name));
            p.push("_design".to_string());
            p.push(percent_encode_uri_path(&self.ddoc_name));
            p.push("_view".to_string());
            p.push(percent_encode_uri_path(&self.view_name));
        }

        uri
    }
}

impl std::fmt::Display for ViewPath {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> Result<(), std::fmt::Error> {
        use super::percent::percent_encode_uri_path;
        write!(f,
               "/{}/_design/{}/_view/{}",
               percent_encode_uri_path(&self.db_name),
               percent_encode_uri_path(&self.ddoc_name),
               percent_encode_uri_path(&self.view_name))
    }
}

impl std::str::FromStr for ViewPath {
    type Err = Error;
    fn from_str(path: &str) -> Result<Self, Self::Err> {

        use super::percent::percent_decode;

        if !path.starts_with("/") {
            return Err(Error::BadViewPath(BadPathKind::NoLeadingSlash));
        }

        let path = &path[1..];

        // CouchDB allows database, document, and view names to contain a slash,
        // but we require any slash within a name to be percent-encoded.

        let parts = path.split("/").collect::<Vec<_>>();
        if parts.len() < 5 {
            return Err(Error::BadViewPath(BadPathKind::NotView));
        }
        if 5 < parts.len() {
            return Err(Error::BadViewPath(BadPathKind::NotView));
        }
        if parts[0].is_empty() || parts[1] != "_design" || parts[2].is_empty() ||
           parts[3] != "_view" || parts[4].is_empty() {
            return Err(Error::BadViewPath(BadPathKind::NotView));
        }

        let db_name = DatabaseName::from(try!(percent_decode(parts[0]).map_err(|_| {
            Error::BadViewPath(BadPathKind::BadPercentEncoding)
        })));
        let ddoc_name = DesignDocumentName::from(try!(percent_decode(parts[2]).map_err(|_| {
            Error::BadViewPath(BadPathKind::BadPercentEncoding)
        })));
        let view_name = ViewName::from(try!(percent_decode(parts[4]).map_err(|_| {
            Error::BadViewPath(BadPathKind::BadPercentEncoding)
        })));

        let view_path = ViewPath {
            db_name: db_name,
            ddoc_name: ddoc_name,
            view_name: view_name,
        };

        Ok(view_path)
    }
}

impl<T: Into<DatabasePath>> From<(T, DesignDocumentName, ViewName)> for ViewPath {
    fn from(parts: (T, DesignDocumentName, ViewName)) -> Self {
        ViewPath {
            db_name: parts.0.into().into(),
            ddoc_name: parts.1,
            view_name: parts.2,
        }
    }
}

impl From<ViewPath> for (DatabaseName, DesignDocumentName, ViewName) {
    fn from(view_path: ViewPath) -> Self {
        (view_path.db_name, view_path.ddoc_name, view_path.view_name)
    }
}

#[cfg(test)]
mod tests {

    use hyper;

    use DatabaseName;
    use DesignDocumentName;
    use DesignDocumentPath;
    use Error;
    use IntoViewPath;
    use ViewName;
    use ViewPath;
    use error::BadPathKind;

    fn make_view_path<T: Into<DatabaseName>, U: Into<DesignDocumentName>, V: Into<ViewName>>
        (db_name: T,
         ddoc_name: U,
         view_name: V)
         -> ViewPath {
        ViewPath {
            db_name: db_name.into(),
            ddoc_name: ddoc_name.into(),
            view_name: view_name.into(),
        }
    }

    #[test]
    fn into_view_path_from_str_ref_ok() {
        let expected = make_view_path("foo", "bar", "qux");
        let got = "/foo/_design/bar/_view/qux".into_view_path().unwrap();
        assert_eq!(expected, got);
    }

    #[test]
    fn into_view_path_from_str_ref_nok() {
        "bad_path".into_view_path().unwrap_err();
    }

    #[test]
    fn into_view_path_from_view_path() {
        let expected = make_view_path("foo", "bar", "qux");
        let got = make_view_path("foo", "bar", "qux").into_view_path().unwrap();
        assert_eq!(expected, got);
    }

    #[test]
    fn into_view_path_from_design_document_path_and_view_name() {
        let expected = make_view_path("foo", "bar", "qux");
        let source = (DesignDocumentPath::parse("/foo/_design/bar").unwrap(),
                      ViewName::from("qux"));
        let got = source.into_view_path().unwrap();
        assert_eq!(expected, got);
    }

    #[test]
    fn view_path_parse_ok() {
        let expected = make_view_path("foo", "bar", "qux");
        let got = ViewPath::parse("/foo/_design/bar/_view/qux").unwrap();
        assert_eq!(expected, got);
    }

    #[test]
    fn view_path_parse_nok() {
        ViewPath::parse("bad_path").unwrap_err();
    }

    #[test]
    fn view_path_into_uri_basic() {
        let expected = "http://example.com:1234/foo/_design/bar/_view/qux";
        let base = hyper::Url::parse("http://example.com:1234").unwrap();
        let uri = make_view_path("foo", "bar", "qux").into_uri(base);
        assert_eq!(expected, uri.to_string());
    }

    #[test]
    fn view_path_into_uri_trailing_slash() {
        let expected = "http://example.com:1234/foo/_design/bar/_view/qux";
        let base = hyper::Url::parse("http://example.com:1234/").unwrap();
        let uri = make_view_path("foo", "bar", "qux").into_uri(base);
        assert_eq!(expected, uri.to_string());
    }

    #[test]
    fn view_path_into_uri_nonempty_path() {
        let expected = "http://example.com:1234/nonempty_path/foo/_design/bar/_view/qux";
        let base = hyper::Url::parse("http://example.com:1234/nonempty_path").unwrap();
        let uri = make_view_path("foo", "bar", "qux").into_uri(base);
        assert_eq!(expected, uri.to_string());
    }

    #[test]
    fn view_path_into_uri_nonempty_path_with_trailing_slash() {
        let expected = "http://example.com:1234/nonempty_path/foo/_design/bar/_view/qux";
        let base = hyper::Url::parse("http://example.com:1234/nonempty_path/").unwrap();
        let uri = make_view_path("foo", "bar", "qux").into_uri(base);
        assert_eq!(expected, uri.to_string());
    }

    #[test]
    fn view_path_into_uri_percent_encoded() {
        let expected = "http://example.com:\
                        1234/foo%2F%25%20bar/_design/qux%2F%25%20baz/_view/kit%2F%25%20lea";
        let base = hyper::Url::parse("http://example.com:1234").unwrap();
        let uri = make_view_path("foo/% bar", "qux/% baz", "kit/% lea").into_uri(base);
        assert_eq!(expected, uri.to_string());
    }

    #[test]
    fn view_path_display() {
        let expected = "/foo%2F%25%20bar/_design/qux%2F%25%20baz/_view/kit%2F%25%20lea";
        let got = format!("{}", make_view_path("foo/% bar", "qux/% baz", "kit/% lea"));
        assert_eq!(expected, got);
    }

    #[test]
    fn view_path_from_str_ok() {
        use std::str::FromStr;
        let expected = make_view_path("foo/% bar", "qux/% baz", "kit/% lea");
        let got = ViewPath::from_str("/foo%2F%25%20bar/_design/qux%2F%25%20baz/_view/kit%2F%25%20\
                                      lea")
                      .unwrap();
        assert_eq!(expected, got);
    }

    #[test]
    fn view_path_from_str_nok_no_leading_slash() {
        use std::str::FromStr;
        let got = ViewPath::from_str("foo/_design/bar/_view/qux");
        expect_path_parse_error!(got, BadViewPath, NoLeadingSlash);
    }

    #[test]
    fn view_path_from_str_nok_bad_design_path_component() {
        use std::str::FromStr;
        let got = ViewPath::from_str("/foo/not_a_design/bar/_view/qux");
        expect_path_parse_error!(got, BadViewPath, NotView);
    }

    #[test]
    fn view_path_from_str_nok_no_design_path_component() {
        use std::str::FromStr;
        let got = ViewPath::from_str("/foo/bar/_view/qux");
        expect_path_parse_error!(got, BadViewPath, NotView);
    }

    #[test]
    fn view_path_from_str_nok_bad_view_path_component() {
        use std::str::FromStr;
        let got = ViewPath::from_str("/foo/_design/bar/not_a_view/qux");
        expect_path_parse_error!(got, BadViewPath, NotView);
    }

    #[test]
    fn view_path_from_str_nok_no_view_path_component() {
        use std::str::FromStr;
        let got = ViewPath::from_str("/foo/_design/bar/qux");
        expect_path_parse_error!(got, BadViewPath, NotView);
    }

    #[test]
    fn view_path_from_str_nok_slash_in_database_name() {
        use std::str::FromStr;
        let got = ViewPath::from_str("/foo/bar/_design/qux/_view/kit");
        expect_path_parse_error!(got, BadViewPath, NotView);
    }

    #[test]
    fn view_path_from_str_nok_slash_in_document_name() {
        use std::str::FromStr;
        let got = ViewPath::from_str("/foo/_design/bar/qux/_view/kit");
        expect_path_parse_error!(got, BadViewPath, NotView);
    }

    #[test]
    fn view_path_from_str_nok_slash_in_view_name() {
        use std::str::FromStr;
        let got = ViewPath::from_str("/foo/_design/bar/_view/qux/kit");
        expect_path_parse_error!(got, BadViewPath, NotView);
    }

    #[test]
    fn view_path_from_str_nok_no_path_component_after_view() {
        use std::str::FromStr;
        let got = ViewPath::from_str("/foo/_design/bar/_view");
        expect_path_parse_error!(got, BadViewPath, NotView);
    }

    #[test]
    fn view_path_from_str_nok_empty_database_name() {
        use std::str::FromStr;
        let got = ViewPath::from_str("//_design/bar/_view/qux");
        expect_path_parse_error!(got, BadViewPath, NotView);
    }

    #[test]
    fn view_path_from_str_nok_empty_document_name() {
        use std::str::FromStr;
        let got = ViewPath::from_str("/foo/_design//_view/qux");
        expect_path_parse_error!(got, BadViewPath, NotView);
    }

    #[test]
    fn view_path_from_str_nok_empty_view_name() {
        use std::str::FromStr;
        let got = ViewPath::from_str("/foo/_design/bar/_view/");
        expect_path_parse_error!(got, BadViewPath, NotView);
    }

    #[test]
    fn view_path_from_str_nok_bad_percent_encoded_database_name() {
        use std::str::FromStr;
        let got = ViewPath::from_str("/foo%/_design/bar/_view/qux");
        expect_path_parse_error!(got, BadViewPath, BadPercentEncoding);
    }

    #[test]
    fn view_path_from_str_nok_bad_percent_encoded_document_name() {
        use std::str::FromStr;
        let got = ViewPath::from_str("/foo/_design/bar%/_view/qux");
        expect_path_parse_error!(got, BadViewPath, BadPercentEncoding);
    }

    #[test]
    fn view_path_from_str_nok_bad_percent_encoded_view_name() {
        use std::str::FromStr;
        let got = ViewPath::from_str("/foo/_design/bar/_view/qux%");
        expect_path_parse_error!(got, BadViewPath, BadPercentEncoding);
    }

    #[test]
    fn view_name_from_database_path_and_design_document_name_and_view_name() {
        let expected = make_view_path("foo", "bar", "qux");
        let source = (DatabaseName::from("foo"),
                      DesignDocumentName::from("bar"),
                      ViewName::from("qux"));
        let got = source.into();
        assert_eq!(expected, got);
    }

    #[test]
    fn database_name_and_design_document_name_and_view_name_from_view_path() {
        let expected = (DatabaseName::from("foo"),
                        DesignDocumentName::from("bar"),
                        ViewName::from("qux"));
        let source = make_view_path("foo", "bar", "qux");
        let got = source.into();
        assert_eq!(expected, got);
    }
}