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

use super::{operate, PathSubcommandArguments};
use crate::prelude::*;
use nu_engine::WholeStreamCommand;
use nu_errors::ShellError;
use nu_protocol::{ColumnPath, Signature, SyntaxShape, UntaggedValue, Value};
use nu_source::Tagged;
use std::path::{Path, PathBuf};

pub struct PathRelativeTo;

struct PathRelativeToArguments {
    path: Tagged<PathBuf>,
    rest: Vec<ColumnPath>,
}

impl PathSubcommandArguments for PathRelativeToArguments {
    fn get_column_paths(&self) -> &Vec<ColumnPath> {
        &self.rest
    }
}

impl WholeStreamCommand for PathRelativeTo {
    fn name(&self) -> &str {
        "path relative-to"
    }

    fn signature(&self) -> Signature {
        Signature::build("path relative-to")
            .required(
                "path",
                SyntaxShape::FilePath,
                "Parent shared with the input path",
            )
            .rest(
                "rest",
                SyntaxShape::ColumnPath,
                "Optionally operate by column path",
            )
    }

    fn usage(&self) -> &str {
        "Get a path as relative to another path."
    }

    fn extra_usage(&self) -> &str {
        r#"Can be used only when the input and the argument paths are either both
absolute or both relative. The argument path needs to be a parent of the input
path."#
    }

    fn run(&self, args: CommandArgs) -> Result<OutputStream, ShellError> {
        let tag = args.call_info.name_tag.clone();
        let cmd_args = Arc::new(PathRelativeToArguments {
            path: args.req(0)?,
            rest: args.rest(1)?,
        });

        Ok(operate(args.input, &action, tag.span, cmd_args))
    }

    #[cfg(windows)]
    fn examples(&self) -> Vec<Example> {
        vec![
            Example {
                description: "Find a relative path from two absolute paths",
                example: r"'C:\Users\viking' | path relative-to 'C:\Users'",
                result: Some(vec![Value::from(UntaggedValue::filepath(r"viking"))]),
            },
            Example {
                description: "Find a relative path from two relative paths",
                example: r"'eggs\bacon\sausage\spam' | path relative-to 'eggs\bacon\sausage'",
                result: Some(vec![Value::from(UntaggedValue::filepath(r"spam"))]),
            },
        ]
    }

    #[cfg(not(windows))]
    fn examples(&self) -> Vec<Example> {
        vec![
            Example {
                description: "Find a relative path from two absolute paths",
                example: r"'/home/viking' | path relative-to '/home'",
                result: Some(vec![Value::from(UntaggedValue::filepath(r"viking"))]),
            },
            Example {
                description: "Find a relative path from two relative paths",
                example: r"'eggs/bacon/sausage/spam' | path relative-to 'eggs/bacon/sausage'",
                result: Some(vec![Value::from(UntaggedValue::filepath(r"spam"))]),
            },
        ]
    }
}

fn action(path: &Path, tag: Tag, args: &PathRelativeToArguments) -> Value {
    match path.strip_prefix(&args.path.item) {
        Ok(p) => UntaggedValue::filepath(p).into_value(tag),
        Err(_) => Value::error(ShellError::labeled_error_with_secondary(
            format!(
                "'{}' is not a subpath of '{}'",
                path.to_string_lossy(),
                &args.path.item.to_string_lossy()
            ),
            "should be a parent of the input path",
            args.path.tag.span,
            "originates from here",
            tag.span,
        )),
    }
}

#[cfg(test)]
mod tests {
    use super::PathRelativeTo;
    use super::ShellError;

    #[test]
    fn examples_work_as_expected() -> Result<(), ShellError> {
        use crate::examples::test as test_examples;

        test_examples(PathRelativeTo {})
    }
}