nu-command 0.41.0

CLI for nushell
Documentation
use crate::prelude::*;
use nu_engine::WholeStreamCommand;
use nu_errors::ShellError;
use nu_protocol::{Range, Signature, SyntaxShape, UntaggedValue};
use nu_source::Tagged;
use rand::prelude::{thread_rng, Rng};
use std::cmp::Ordering;

pub struct SubCommand;

pub struct IntegerArgs {
    range: Option<Tagged<Range>>,
}

impl WholeStreamCommand for SubCommand {
    fn name(&self) -> &str {
        "random integer"
    }

    fn signature(&self) -> Signature {
        Signature::build("random integer").optional("range", SyntaxShape::Range, "Range of values")
    }

    fn usage(&self) -> &str {
        "Generate a random integer [min..max]"
    }

    fn run(&self, args: CommandArgs) -> Result<OutputStream, ShellError> {
        integer(args)
    }

    fn examples(&self) -> Vec<Example> {
        vec![
            Example {
                description: "Generate an unconstrained random integer",
                example: "random integer",
                result: None,
            },
            Example {
                description: "Generate a random integer less than or equal to 500",
                example: "random integer ..500",
                result: None,
            },
            Example {
                description: "Generate a random integer greater than or equal to 100000",
                example: "random integer 100000..",
                result: None,
            },
            Example {
                description: "Generate a random integer between 1 and 10",
                example: "random integer 1..10",
                result: None,
            },
        ]
    }
}

pub fn integer(args: CommandArgs) -> Result<OutputStream, ShellError> {
    let cmd_args = IntegerArgs {
        range: args.opt(0)?,
    };

    let (min, max) = if let Some(range) = &cmd_args.range {
        (range.min_i64()?, range.max_i64()?)
    } else {
        (0, i64::MAX)
    };

    match min.cmp(&max) {
        Ordering::Greater => Err(ShellError::labeled_error(
            format!("Invalid range {}..{}", min, max),
            "expected a valid range",
            cmd_args
                .range
                .expect("Unexpected ordering error in random integer")
                .span(),
        )),
        Ordering::Equal => Ok(OutputStream::one(
            UntaggedValue::int(min).into_value(Tag::unknown()),
        )),
        _ => {
            let mut thread_rng = thread_rng();
            // add 1 to max, because gen_range is right-exclusive
            let max = max.saturating_add(1);
            let result: i64 = thread_rng.gen_range(min..max);

            Ok(OutputStream::one(
                UntaggedValue::int(result).into_value(Tag::unknown()),
            ))
        }
    }
}

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

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

        test_examples(SubCommand {})
    }
}