Skip to content

Commit

Permalink
Rename random integer to random int (#10520)
Browse files Browse the repository at this point in the history
# Description
Consistently use `int` for types and commands

h/t @1Kinoti

Work for #10332

# User-Facing Changes
Deprecate `random integer` in the next release

New command `random int`

# Tests + Formatting
(-)
  • Loading branch information
sholderbach committed Sep 28, 2023
1 parent 8f4ea69 commit cc76746
Show file tree
Hide file tree
Showing 4 changed files with 134 additions and 1 deletion.
1 change: 1 addition & 0 deletions crates/nu-command/src/default_context.rs
Original file line number Diff line number Diff line change
Expand Up @@ -370,6 +370,7 @@ pub fn add_shell_command_context(mut engine_state: EngineState) -> EngineState {
RandomDecimal,
RandomDice,
RandomFloat,
RandomInt,
RandomInteger,
RandomUuid,
};
Expand Down
116 changes: 116 additions & 0 deletions crates/nu-command/src/random/int.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
use nu_engine::CallExt;
use nu_protocol::ast::Call;
use nu_protocol::engine::{Command, EngineState, Stack};
use nu_protocol::{
Category, Example, PipelineData, Range, ShellError, Signature, SyntaxShape, Type, Value,
};
use rand::prelude::{thread_rng, Rng};
use std::cmp::Ordering;

#[derive(Clone)]
pub struct SubCommand;

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

fn signature(&self) -> Signature {
Signature::build("random int")
.input_output_types(vec![(Type::Nothing, Type::Int)])
.allow_variants_without_examples(true)
.optional("range", SyntaxShape::Range, "Range of values")
.category(Category::Random)
}

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

fn search_terms(&self) -> Vec<&str> {
vec!["generate", "natural", "number"]
}

fn run(
&self,
engine_state: &EngineState,
stack: &mut Stack,
call: &Call,
_input: PipelineData,
) -> Result<PipelineData, ShellError> {
integer(engine_state, stack, call)
}

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

fn integer(
engine_state: &EngineState,
stack: &mut Stack,
call: &Call,
) -> Result<PipelineData, ShellError> {
let span = call.head;
let range: Option<Range> = call.opt(engine_state, stack, 0)?;

let (min, max) = if let Some(r) = range {
if r.is_end_inclusive() {
(r.from.as_int()?, r.to.as_int()?)
} else if r.to.as_int()? > 0 {
(r.from.as_int()?, r.to.as_int()? - 1)
} else {
(0, 0)
}
} else {
(0, i64::MAX)
};

match min.partial_cmp(&max) {
Some(Ordering::Greater) => Err(ShellError::InvalidRange {
left_flank: min.to_string(),
right_flank: max.to_string(),
span,
}),
Some(Ordering::Equal) => Ok(PipelineData::Value(Value::int(min, span), None)),
_ => {
let mut thread_rng = thread_rng();
let result: i64 = thread_rng.gen_range(min..=max);

Ok(PipelineData::Value(Value::int(result, span), None))
}
}
}

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

#[test]
fn test_examples() {
use crate::test_examples;

test_examples(SubCommand {})
}
}
16 changes: 15 additions & 1 deletion crates/nu-command/src/random/integer.rs
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,11 @@ impl Command for SubCommand {
}

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

fn extra_usage(&self) -> &str {
"Use `random int` instead"
}

fn search_terms(&self) -> Vec<&str> {
Expand All @@ -38,6 +42,16 @@ impl Command for SubCommand {
call: &Call,
_input: PipelineData,
) -> Result<PipelineData, ShellError> {
nu_protocol::report_error_new(
engine_state,
&ShellError::GenericError(
"Deprecated command".into(),
"`random integer` is deprecated and will be removed in 0.87.".into(),
Some(call.head),
Some("Use `random int` instead".into()),
vec![],
),
);
integer(engine_state, stack, call)
}

Expand Down
2 changes: 2 additions & 0 deletions crates/nu-command/src/random/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ mod chars;
mod decimal;
mod dice;
mod float;
mod int;
mod integer;
mod random_;
mod uuid;
Expand All @@ -12,6 +13,7 @@ pub use self::chars::SubCommand as RandomChars;
pub use self::decimal::SubCommand as RandomDecimal;
pub use self::dice::SubCommand as RandomDice;
pub use self::float::SubCommand as RandomFloat;
pub use self::int::SubCommand as RandomInt;
pub use self::integer::SubCommand as RandomInteger;
pub use self::uuid::SubCommand as RandomUuid;
pub use random_::RandomCommand as Random;

0 comments on commit cc76746

Please sign in to comment.