nu-path 0.117.0

Path handling library for Nushell
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
409
410
411
412
413
414
415
416
417
418
419
420
421
422
#[cfg(windows)]
use omnipath::WinPathExt;
use std::path::{Component, Path, PathBuf, Prefix};

/// Returns whether a path component is n-dots.
fn is_ndots(s: &std::ffi::OsStr) -> bool {
    s.as_encoded_bytes().iter().all(|c| *c == b'.') && s.len() >= 3
}

/// Normalize the path, expanding occurrences of n-dots.
///
/// It performs the same normalization as `nu_path::components()`, except it also expands n-dots,
/// such as "..." and "....", into multiple "..".
///
/// The resulting path will use platform-specific path separators, regardless of what path separators was used in the input.
pub fn expand_ndots(path: impl AsRef<Path>) -> PathBuf {
    let path = path.as_ref();

    let mut result = PathBuf::with_capacity(path.as_os_str().len());
    let mut has_special_prefix = false;
    for component in crate::components(path) {
        match component {
            Component::Normal(s) if is_ndots(s) => {
                let n = s.len();
                // Push ".." to the path (n - 1) times.
                for _ in 0..n - 1 {
                    result.push("..");
                }
            }
            Component::Prefix(prefix) => {
                match prefix.kind() {
                    Prefix::Disk(_) => {
                        // Here, only the disk letter gets parsed as prefix,
                        // so the following RootDir component makes sense
                    }
                    _ => {
                        has_special_prefix = true;
                    }
                }
                result.push(component)
            }
            Component::RootDir if has_special_prefix => {
                // Ignore; this would add a trailing backslash to the path that wasn't in the input
            }
            _ => result.push(component),
        }
    }

    result
}

/// Normalize the path, expanding occurrences of "." and "..".
///
/// It performs the same normalization as `nu_path::components()`, except it also expands ".."
/// when its preceding component is a normal component, ignoring the possibility of symlinks.
/// In other words, it operates on the lexical structure of the path.
///
/// This won't expand "/.." even though the parent directory of "/" is often
/// considered to be itself.
///
/// The resulting path will use platform-specific path separators, regardless of what path separators was used in the input.
pub fn expand_dots(path: impl AsRef<Path>) -> PathBuf {
    // Check if the last component of the path is a normal component.
    fn last_component_is_normal(path: &Path) -> bool {
        matches!(path.components().next_back(), Some(Component::Normal(_)))
    }

    let path = path.as_ref();

    let mut has_special_prefix = false;
    let mut result = PathBuf::with_capacity(path.as_os_str().len());
    for component in crate::components(path) {
        match component {
            Component::ParentDir if last_component_is_normal(&result) => {
                result.pop();
            }
            Component::CurDir if last_component_is_normal(&result) => {
                // no-op
            }
            Component::Prefix(prefix) => {
                match prefix.kind() {
                    Prefix::Disk(_) => {
                        // Here, only the disk letter gets parsed as prefix,
                        // so the following RootDir component makes sense
                    }
                    _ => {
                        has_special_prefix = true;
                    }
                }
                result.push(component)
            }
            Component::RootDir if has_special_prefix => {
                // Ignore; this would add a trailing backslash to the path that wasn't in the input
            }
            _ => {
                let prev_component = result.components().next_back();
                if prev_component == Some(Component::RootDir) && component == Component::ParentDir {
                    continue;
                }
                result.push(component)
            }
        }
    }

    simiplified(&result)
}

/// Expand ndots, but only if it looks like it probably contains them, because there is some lossy
/// path normalization that happens.
pub fn expand_ndots_safe(path: impl AsRef<Path>) -> PathBuf {
    let string = path.as_ref().to_string_lossy();

    // Don't use it if it contains ://, because that looks like a URL scheme and the path normalization
    // will mess with that.
    // Don't use it if it starts with `./`, as to not break golang wildcard syntax
    // (since generally you're probably not using `./` with ndots)
    // Otherwise use it only if some component consists solely of at least `...`. A mere substring
    // such as `origin/main...` is not an n-dots component, and normalizing it would needlessly
    // rewrite the separators (e.g. to backslashes on Windows). Splitting with `components()` keeps
    // this check in line with how `expand_ndots` tokenizes the path.
    if !string.contains("://")
        && !string.starts_with("./")
        && path
            .as_ref()
            .components()
            .any(|c| matches!(c, Component::Normal(s) if is_ndots(s)))
    {
        expand_ndots(path)
    } else {
        path.as_ref().to_owned()
    }
}

#[cfg(windows)]
fn simiplified(path: &std::path::Path) -> PathBuf {
    path.to_winuser_path()
        .unwrap_or_else(|_| path.to_path_buf())
}

#[cfg(not(windows))]
fn simiplified(path: &std::path::Path) -> PathBuf {
    path.to_path_buf()
}

#[cfg(test)]
mod test_expand_ndots {
    use super::*;
    use crate::assert_path_eq;

    #[test]
    fn empty_path() {
        let path = Path::new("");
        assert_path_eq!(expand_ndots(path), "");
    }

    #[test]
    fn root_dir() {
        let path = Path::new("/");
        let expected = if cfg!(windows) { "\\" } else { "/" };
        assert_path_eq!(expand_ndots(path), expected);
    }

    #[test]
    fn two_dots() {
        let path = Path::new("..");
        assert_path_eq!(expand_ndots(path), "..");
    }

    #[test]
    fn three_dots() {
        let path = Path::new("...");
        let expected = if cfg!(windows) { r"..\.." } else { "../.." };
        assert_path_eq!(expand_ndots(path), expected);
    }

    #[test]
    fn five_dots() {
        let path = Path::new(".....");
        let expected = if cfg!(windows) {
            r"..\..\..\.."
        } else {
            "../../../.."
        };
        assert_path_eq!(expand_ndots(path), expected);
    }

    #[test]
    fn three_dots_with_trailing_slash() {
        let path = Path::new("/tmp/.../");
        let expected = if cfg!(windows) {
            r"\tmp\..\..\"
        } else {
            "/tmp/../../"
        };
        assert_path_eq!(expand_ndots(path), expected);
    }

    #[test]
    fn filenames_with_dots() {
        let path = Path::new("...foo.../");
        let expected = if cfg!(windows) {
            r"...foo...\"
        } else {
            "...foo.../"
        };
        assert_path_eq!(expand_ndots(path), expected);
    }

    #[test]
    fn multiple_ndots() {
        let path = Path::new("..././...");
        let expected = if cfg!(windows) {
            r"..\..\..\.."
        } else {
            "../../../.."
        };
        assert_path_eq!(expand_ndots(path), expected);
    }

    #[test]
    fn trailing_dots() {
        let path = Path::new("/foo/bar/..");
        let expected = if cfg!(windows) {
            r"\foo\bar\.."
        } else {
            "/foo/bar/.."
        };
        assert_path_eq!(expand_ndots(path), expected);
    }

    #[test]
    fn dots_inside_component_untouched() {
        // `...` only counts as n-dots when it is a whole path component (#16858)
        assert_path_eq!(expand_ndots_safe("origin/main..."), "origin/main...");
        assert_path_eq!(expand_ndots_safe("a.../b"), "a.../b");
        // a non-ndots path is returned as is, so the doubled slash survives
        assert_path_eq!(expand_ndots_safe("origin//main..."), "origin//main...");
    }

    #[test]
    fn drive_relative_ndots() {
        // `C:...` is the prefix `C:` followed by an n-dots component
        let expected = if cfg!(windows) { r"C:..\.." } else { "C:..." };
        assert_path_eq!(expand_ndots_safe("C:..."), expected);
    }

    #[test]
    fn backslash_separated_ndots() {
        // `\` is a separator only on Windows; elsewhere `a\...\b` is a single file name
        let expected = if cfg!(windows) {
            r"a\..\..\b"
        } else {
            r"a\...\b"
        };
        assert_path_eq!(expand_ndots_safe(r"a\...\b"), expected);
    }

    #[test]
    fn leading_dot_slash() {
        let path = Path::new("./...");
        assert_path_eq!(expand_ndots_safe(path), "./...");
    }

    #[test]
    fn unc_share_no_dots() {
        let path = Path::new(r"\\server\share");
        assert_path_eq!(expand_ndots(path), path);
    }

    #[test]
    fn unc_file_no_dots() {
        let path = Path::new(r"\\server\share\dir\file.nu");
        assert_path_eq!(expand_ndots(path), path);
    }

    #[test]
    fn verbatim_no_dots() {
        let path = Path::new(r"\\?\pictures\elephants");
        assert_path_eq!(expand_ndots(path), path);
    }

    #[test]
    fn verbatim_unc_share_no_dots() {
        let path = Path::new(r"\\?\UNC\server\share");
        assert_path_eq!(expand_ndots(path), path);
    }

    #[test]
    fn verbatim_unc_file_no_dots() {
        let path = Path::new(r"\\?\UNC\server\share\dir\file.nu");
        assert_path_eq!(expand_ndots(path), path);
    }

    #[test]
    fn verbatim_disk_no_dots() {
        let path = Path::new(r"\\?\c:\");
        assert_path_eq!(expand_ndots(path), path);
    }

    #[test]
    fn device_path_no_dots() {
        let path = Path::new(r"\\.\CON");
        assert_path_eq!(expand_ndots(path), path);
    }

    #[test]
    fn disk_no_dots() {
        let path = Path::new(r"c:\Users\Ellie\nu_scripts");
        assert_path_eq!(expand_ndots(path), path);
    }
}

#[cfg(test)]
mod test_expand_dots {
    use super::*;
    use crate::assert_path_eq;

    #[test]
    fn empty_path() {
        let path = Path::new("");
        assert_path_eq!(expand_dots(path), "");
    }

    #[test]
    fn single_dot() {
        let path = Path::new("./");
        let expected = if cfg!(windows) { r".\" } else { "./" };
        assert_path_eq!(expand_dots(path), expected);
    }

    #[test]
    fn more_single_dots() {
        let path = Path::new("././.");
        let expected = ".";
        assert_path_eq!(expand_dots(path), expected);
    }

    #[test]
    fn double_dots() {
        let path = Path::new("../../..");
        let expected = if cfg!(windows) {
            r"..\..\.."
        } else {
            "../../.."
        };
        assert_path_eq!(expand_dots(path), expected);
    }

    #[test]
    fn backtrack_once() {
        let path = Path::new("/foo/bar/../baz/");
        let expected = if cfg!(windows) {
            r"\foo\baz\"
        } else {
            "/foo/baz/"
        };
        assert_path_eq!(expand_dots(path), expected);
    }

    #[test]
    fn backtrack_to_root() {
        let path = Path::new("/foo/bar/../../../../baz");
        let expected = if cfg!(windows) { r"\baz" } else { "/baz" };
        assert_path_eq!(expand_dots(path), expected);
    }

    #[test]
    fn unc_share_no_dots() {
        let path = Path::new(r"\\server\share");
        assert_path_eq!(expand_dots(path), path);
    }

    #[test]
    fn unc_file_no_dots() {
        let path = Path::new(r"\\server\share\dir\file.nu");
        assert_path_eq!(expand_dots(path), path);
    }

    #[test]
    #[ignore = "bug in upstream library"]
    fn verbatim_no_dots() {
        // omnipath::windows::sys::Path::to_winuser_path seems to turn this verbatim path into a device path
        let path = Path::new(r"\\?\pictures\elephants");
        assert_path_eq!(expand_dots(path), path);
    }

    #[cfg_attr(not(windows), ignore = "only for Windows")]
    #[test]
    fn verbatim_unc_share_no_dots() {
        let path = Path::new(r"\\?\UNC\server\share");
        let expected = Path::new(r"\\server\share");
        assert_path_eq!(expand_dots(path), expected);
    }

    #[cfg_attr(not(windows), ignore = "only for Windows")]
    #[test]
    fn verbatim_unc_file_no_dots() {
        let path = Path::new(r"\\?\UNC\server\share\dir\file.nu");
        let expected = Path::new(r"\\server\share\dir\file.nu");
        assert_path_eq!(expand_dots(path), expected);
    }

    #[cfg_attr(not(windows), ignore = "only for Windows")]
    #[test]
    fn verbatim_disk_no_dots() {
        let path = Path::new(r"\\?\C:\");
        let expected = Path::new(r"C:\");
        assert_path_eq!(expand_dots(path), expected);
    }

    #[test]
    fn device_path_no_dots() {
        let path = Path::new(r"\\.\CON");
        assert_path_eq!(expand_dots(path), path);
    }

    #[test]
    fn disk_no_dots() {
        let path = Path::new(r"c:\Users\Ellie\nu_scripts");
        assert_path_eq!(expand_dots(path), path);
    }
}