mirror of
https://github.com/nushell/nushell
synced 2024-12-24 12:03:18 +00:00
Nu plugins now depend on nu-plugin crate.
This commit is contained in:
parent
b4bc5fe9af
commit
f6c62bf121
43 changed files with 1113 additions and 2002 deletions
28
Cargo.lock
generated
28
Cargo.lock
generated
|
@ -1955,6 +1955,7 @@ dependencies = [
|
||||||
"nu-errors",
|
"nu-errors",
|
||||||
"nu-macros",
|
"nu-macros",
|
||||||
"nu-parser",
|
"nu-parser",
|
||||||
|
"nu-plugin",
|
||||||
"nu-protocol",
|
"nu-protocol",
|
||||||
"nu-source",
|
"nu-source",
|
||||||
"nu-test-support",
|
"nu-test-support",
|
||||||
|
@ -2082,6 +2083,21 @@ dependencies = [
|
||||||
"unicode-xid",
|
"unicode-xid",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "nu-plugin"
|
||||||
|
version = "0.7.0"
|
||||||
|
dependencies = [
|
||||||
|
"indexmap",
|
||||||
|
"nu-build",
|
||||||
|
"nu-errors",
|
||||||
|
"nu-protocol",
|
||||||
|
"nu-source",
|
||||||
|
"nu-value-ext",
|
||||||
|
"num-bigint",
|
||||||
|
"serde 1.0.103",
|
||||||
|
"serde_json",
|
||||||
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "nu-protocol"
|
name = "nu-protocol"
|
||||||
version = "0.7.0"
|
version = "0.7.0"
|
||||||
|
@ -2159,6 +2175,7 @@ version = "0.7.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"nu-build",
|
"nu-build",
|
||||||
"nu-errors",
|
"nu-errors",
|
||||||
|
"nu-plugin",
|
||||||
"nu-protocol",
|
"nu-protocol",
|
||||||
"nu-source",
|
"nu-source",
|
||||||
]
|
]
|
||||||
|
@ -2173,6 +2190,7 @@ dependencies = [
|
||||||
"neso",
|
"neso",
|
||||||
"nu-build",
|
"nu-build",
|
||||||
"nu-errors",
|
"nu-errors",
|
||||||
|
"nu-plugin",
|
||||||
"nu-protocol",
|
"nu-protocol",
|
||||||
"nu-source",
|
"nu-source",
|
||||||
"pretty-hex",
|
"pretty-hex",
|
||||||
|
@ -2186,6 +2204,7 @@ dependencies = [
|
||||||
"futures-preview",
|
"futures-preview",
|
||||||
"nu-build",
|
"nu-build",
|
||||||
"nu-errors",
|
"nu-errors",
|
||||||
|
"nu-plugin",
|
||||||
"nu-protocol",
|
"nu-protocol",
|
||||||
"nu-source",
|
"nu-source",
|
||||||
"surf",
|
"surf",
|
||||||
|
@ -2199,6 +2218,7 @@ dependencies = [
|
||||||
"indexmap",
|
"indexmap",
|
||||||
"nu-build",
|
"nu-build",
|
||||||
"nu-errors",
|
"nu-errors",
|
||||||
|
"nu-plugin",
|
||||||
"nu-protocol",
|
"nu-protocol",
|
||||||
"nu-source",
|
"nu-source",
|
||||||
"nu-value-ext",
|
"nu-value-ext",
|
||||||
|
@ -2212,6 +2232,7 @@ dependencies = [
|
||||||
"futures-preview",
|
"futures-preview",
|
||||||
"nu-build",
|
"nu-build",
|
||||||
"nu-errors",
|
"nu-errors",
|
||||||
|
"nu-plugin",
|
||||||
"nu-protocol",
|
"nu-protocol",
|
||||||
"nu-source",
|
"nu-source",
|
||||||
"regex",
|
"regex",
|
||||||
|
@ -2225,6 +2246,7 @@ dependencies = [
|
||||||
"futures-preview",
|
"futures-preview",
|
||||||
"nu-build",
|
"nu-build",
|
||||||
"nu-errors",
|
"nu-errors",
|
||||||
|
"nu-plugin",
|
||||||
"nu-protocol",
|
"nu-protocol",
|
||||||
"nu-source",
|
"nu-source",
|
||||||
"num-traits 0.2.10",
|
"num-traits 0.2.10",
|
||||||
|
@ -2243,6 +2265,7 @@ dependencies = [
|
||||||
"heim",
|
"heim",
|
||||||
"nu-build",
|
"nu-build",
|
||||||
"nu-errors",
|
"nu-errors",
|
||||||
|
"nu-plugin",
|
||||||
"nu-protocol",
|
"nu-protocol",
|
||||||
"nu-source",
|
"nu-source",
|
||||||
"pin-utils",
|
"pin-utils",
|
||||||
|
@ -2255,6 +2278,7 @@ dependencies = [
|
||||||
"indexmap",
|
"indexmap",
|
||||||
"nu-build",
|
"nu-build",
|
||||||
"nu-errors",
|
"nu-errors",
|
||||||
|
"nu-plugin",
|
||||||
"nu-protocol",
|
"nu-protocol",
|
||||||
"nu-source",
|
"nu-source",
|
||||||
"nu-value-ext",
|
"nu-value-ext",
|
||||||
|
@ -2268,6 +2292,7 @@ version = "0.7.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"nu-build",
|
"nu-build",
|
||||||
"nu-errors",
|
"nu-errors",
|
||||||
|
"nu-plugin",
|
||||||
"nu-protocol",
|
"nu-protocol",
|
||||||
"nu-source",
|
"nu-source",
|
||||||
]
|
]
|
||||||
|
@ -2282,6 +2307,7 @@ dependencies = [
|
||||||
"heim",
|
"heim",
|
||||||
"nu-build",
|
"nu-build",
|
||||||
"nu-errors",
|
"nu-errors",
|
||||||
|
"nu-plugin",
|
||||||
"nu-protocol",
|
"nu-protocol",
|
||||||
"nu-source",
|
"nu-source",
|
||||||
]
|
]
|
||||||
|
@ -2294,6 +2320,7 @@ dependencies = [
|
||||||
"crossterm",
|
"crossterm",
|
||||||
"nu-build",
|
"nu-build",
|
||||||
"nu-errors",
|
"nu-errors",
|
||||||
|
"nu-plugin",
|
||||||
"nu-protocol",
|
"nu-protocol",
|
||||||
"nu-source",
|
"nu-source",
|
||||||
"onig_sys",
|
"onig_sys",
|
||||||
|
@ -2308,6 +2335,7 @@ dependencies = [
|
||||||
"derive-new",
|
"derive-new",
|
||||||
"nu-build",
|
"nu-build",
|
||||||
"nu-errors",
|
"nu-errors",
|
||||||
|
"nu-plugin",
|
||||||
"nu-protocol",
|
"nu-protocol",
|
||||||
"nu-source",
|
"nu-source",
|
||||||
"ptree",
|
"ptree",
|
||||||
|
|
|
@ -30,6 +30,7 @@ members = [
|
||||||
"crates/nu_plugin_textview",
|
"crates/nu_plugin_textview",
|
||||||
"crates/nu_plugin_tree",
|
"crates/nu_plugin_tree",
|
||||||
"crates/nu-protocol",
|
"crates/nu-protocol",
|
||||||
|
"crates/nu-plugin",
|
||||||
"crates/nu-parser",
|
"crates/nu-parser",
|
||||||
"crates/nu-value-ext",
|
"crates/nu-value-ext",
|
||||||
"crates/nu-build"
|
"crates/nu-build"
|
||||||
|
@ -39,6 +40,7 @@ members = [
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
nu-source = { version = "0.7.0", path = "./crates/nu-source" }
|
nu-source = { version = "0.7.0", path = "./crates/nu-source" }
|
||||||
|
nu-plugin = { version = "0.7.0", path = "./crates/nu-plugin" }
|
||||||
nu-protocol = { version = "0.7.0", path = "./crates/nu-protocol" }
|
nu-protocol = { version = "0.7.0", path = "./crates/nu-protocol" }
|
||||||
nu-errors = { version = "0.7.0", path = "./crates/nu-errors" }
|
nu-errors = { version = "0.7.0", path = "./crates/nu-errors" }
|
||||||
nu-parser = { version = "0.7.0", path = "./crates/nu-parser" }
|
nu-parser = { version = "0.7.0", path = "./crates/nu-parser" }
|
||||||
|
@ -143,7 +145,7 @@ sys = ["heim", "battery"]
|
||||||
ps = ["heim", "futures-timer"]
|
ps = ["heim", "futures-timer"]
|
||||||
textview = ["crossterm", "syntect", "onig_sys", "url"]
|
textview = ["crossterm", "syntect", "onig_sys", "url"]
|
||||||
inc = ["semver"]
|
inc = ["semver"]
|
||||||
str = []
|
str = ["nu_plugin_str"]
|
||||||
|
|
||||||
# Stable
|
# Stable
|
||||||
average = ["nu_plugin_average"]
|
average = ["nu_plugin_average"]
|
||||||
|
|
23
crates/nu-plugin/Cargo.toml
Normal file
23
crates/nu-plugin/Cargo.toml
Normal file
|
@ -0,0 +1,23 @@
|
||||||
|
[package]
|
||||||
|
name = "nu-plugin"
|
||||||
|
version = "0.7.0"
|
||||||
|
authors = ["Yehuda Katz <wycats@gmail.com>", "Jonathan Turner <jonathan.d.turner@gmail.com>", "Andrés N. Robalino <andres@androbtech.com>"]
|
||||||
|
edition = "2018"
|
||||||
|
description = "Nushell Plugin"
|
||||||
|
license = "MIT"
|
||||||
|
|
||||||
|
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
nu-protocol = { path = "../nu-protocol", version = "0.7.0" }
|
||||||
|
nu-source = { path = "../nu-source", version = "0.7.0" }
|
||||||
|
nu-errors = { path = "../nu-errors", version = "0.7.0" }
|
||||||
|
nu-value-ext = { path = "../nu-value-ext", version = "0.7.0" }
|
||||||
|
|
||||||
|
indexmap = { version = "1.3.0", features = ["serde-1"] }
|
||||||
|
serde = { version = "1.0.103", features = ["derive"] }
|
||||||
|
num-bigint = { version = "0.2.3", features = ["serde"] }
|
||||||
|
serde_json = "1.0.44"
|
||||||
|
|
||||||
|
[build-dependencies]
|
||||||
|
nu-build = { version = "0.7.0", path = "../nu-build" }
|
3
crates/nu-plugin/build.rs
Normal file
3
crates/nu-plugin/build.rs
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
fn main() -> Result<(), Box<dyn std::error::Error>> {
|
||||||
|
nu_build::build()
|
||||||
|
}
|
4
crates/nu-plugin/src/lib.rs
Normal file
4
crates/nu-plugin/src/lib.rs
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
mod plugin;
|
||||||
|
pub mod test_helpers;
|
||||||
|
|
||||||
|
pub use crate::plugin::{serve_plugin, Plugin};
|
|
@ -1,8 +1,5 @@
|
||||||
use crate::call_info::CallInfo;
|
|
||||||
use crate::return_value::ReturnValue;
|
|
||||||
use crate::signature::Signature;
|
|
||||||
use crate::value::Value;
|
|
||||||
use nu_errors::ShellError;
|
use nu_errors::ShellError;
|
||||||
|
use nu_protocol::{outln, CallInfo, ReturnValue, Signature, Value};
|
||||||
use serde::{Deserialize, Serialize};
|
use serde::{Deserialize, Serialize};
|
||||||
use std::io;
|
use std::io;
|
||||||
|
|
159
crates/nu-plugin/src/test_helpers.rs
Normal file
159
crates/nu-plugin/src/test_helpers.rs
Normal file
|
@ -0,0 +1,159 @@
|
||||||
|
use crate::Plugin;
|
||||||
|
use indexmap::IndexMap;
|
||||||
|
use nu_errors::ShellError;
|
||||||
|
use nu_protocol::{CallInfo, EvaluatedArgs, Primitive, ReturnValue, UntaggedValue, Value};
|
||||||
|
use nu_source::Tag;
|
||||||
|
use nu_value_ext::ValueExt;
|
||||||
|
|
||||||
|
pub struct PluginTest<'a, T: Plugin> {
|
||||||
|
plugin: &'a mut T,
|
||||||
|
call_info: CallInfo,
|
||||||
|
input: Value,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<'a, T: Plugin> PluginTest<'a, T> {
|
||||||
|
pub fn for_plugin(plugin: &'a mut T) -> Self {
|
||||||
|
PluginTest {
|
||||||
|
plugin: plugin,
|
||||||
|
call_info: CallStub::new().create(),
|
||||||
|
input: UntaggedValue::nothing().into_value(Tag::unknown()),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn args(&mut self, call_info: CallInfo) -> &mut PluginTest<'a, T> {
|
||||||
|
self.call_info = call_info;
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn configure(&mut self, callback: impl FnOnce(Vec<String>)) -> &mut PluginTest<'a, T> {
|
||||||
|
let signature = self
|
||||||
|
.plugin
|
||||||
|
.config()
|
||||||
|
.expect("There was a problem configuring the plugin.");
|
||||||
|
callback(signature.named.keys().map(String::from).collect());
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn input(&mut self, value: Value) -> &mut PluginTest<'a, T> {
|
||||||
|
self.input = value;
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn test(&mut self) -> Result<Vec<ReturnValue>, ShellError> {
|
||||||
|
let return_values = self.plugin.filter(self.input.clone());
|
||||||
|
|
||||||
|
let mut return_values = match return_values {
|
||||||
|
Ok(filtered) => filtered,
|
||||||
|
Err(reason) => return Err(reason),
|
||||||
|
};
|
||||||
|
|
||||||
|
let end = self.plugin.end_filter();
|
||||||
|
|
||||||
|
match end {
|
||||||
|
Ok(filter_ended) => return_values.extend(filter_ended),
|
||||||
|
Err(reason) => return Err(reason),
|
||||||
|
}
|
||||||
|
|
||||||
|
self.plugin.quit();
|
||||||
|
Ok(return_values)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn setup(
|
||||||
|
&mut self,
|
||||||
|
callback: impl FnOnce(&mut T, Result<Vec<ReturnValue>, ShellError>),
|
||||||
|
) -> &mut PluginTest<'a, T> {
|
||||||
|
let call_stub = self.call_info.clone();
|
||||||
|
|
||||||
|
self.configure(|flags_configured| {
|
||||||
|
let flags_registered = &call_stub.args.named;
|
||||||
|
|
||||||
|
let flag_passed = match flags_registered {
|
||||||
|
Some(names) => Some(names.keys().map(String::from).collect::<Vec<String>>()),
|
||||||
|
None => None,
|
||||||
|
};
|
||||||
|
|
||||||
|
if let Some(flags) = flag_passed {
|
||||||
|
for flag in flags {
|
||||||
|
assert!(
|
||||||
|
flags_configured.iter().any(|f| *f == flag),
|
||||||
|
format!(
|
||||||
|
"The flag you passed ({}) is not configured in the plugin.",
|
||||||
|
flag
|
||||||
|
)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
let began = self.plugin.begin_filter(call_stub);
|
||||||
|
|
||||||
|
let return_values = match began {
|
||||||
|
Ok(values) => Ok(values),
|
||||||
|
Err(reason) => Err(reason),
|
||||||
|
};
|
||||||
|
|
||||||
|
callback(self.plugin, return_values);
|
||||||
|
self
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn plugin<T: Plugin>(plugin: &mut T) -> PluginTest<T> {
|
||||||
|
PluginTest::for_plugin(plugin)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn table(list: &Vec<Value>) -> Value {
|
||||||
|
UntaggedValue::table(list).into_untagged_value()
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn column_path(paths: &Vec<Value>) -> Value {
|
||||||
|
UntaggedValue::Primitive(Primitive::ColumnPath(
|
||||||
|
table(&paths.iter().cloned().collect())
|
||||||
|
.as_column_path()
|
||||||
|
.unwrap()
|
||||||
|
.item,
|
||||||
|
))
|
||||||
|
.into_untagged_value()
|
||||||
|
}
|
||||||
|
pub struct CallStub {
|
||||||
|
positionals: Vec<Value>,
|
||||||
|
flags: IndexMap<String, Value>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl CallStub {
|
||||||
|
pub fn new() -> CallStub {
|
||||||
|
CallStub {
|
||||||
|
positionals: vec![],
|
||||||
|
flags: indexmap::IndexMap::new(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn with_named_parameter(&mut self, name: &str, value: Value) -> &mut Self {
|
||||||
|
self.flags.insert(name.to_string(), value);
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn with_long_flag(&mut self, name: &str) -> &mut Self {
|
||||||
|
self.flags.insert(
|
||||||
|
name.to_string(),
|
||||||
|
UntaggedValue::boolean(true).into_value(Tag::unknown()),
|
||||||
|
);
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn with_parameter(&mut self, name: &str) -> &mut Self {
|
||||||
|
let fields: Vec<Value> = name
|
||||||
|
.split(".")
|
||||||
|
.map(|s| UntaggedValue::string(s.to_string()).into_value(Tag::unknown()))
|
||||||
|
.collect();
|
||||||
|
|
||||||
|
self.positionals.push(column_path(&fields));
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn create(&self) -> CallInfo {
|
||||||
|
CallInfo {
|
||||||
|
args: EvaluatedArgs::new(Some(self.positionals.clone()), Some(self.flags.clone())),
|
||||||
|
name_tag: Tag::unknown(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
|
@ -3,7 +3,6 @@ mod macros;
|
||||||
|
|
||||||
mod call_info;
|
mod call_info;
|
||||||
mod maybe_owned;
|
mod maybe_owned;
|
||||||
mod plugin;
|
|
||||||
mod return_value;
|
mod return_value;
|
||||||
mod signature;
|
mod signature;
|
||||||
mod syntax_shape;
|
mod syntax_shape;
|
||||||
|
@ -13,7 +12,6 @@ mod value;
|
||||||
|
|
||||||
pub use crate::call_info::{CallInfo, EvaluatedArgs};
|
pub use crate::call_info::{CallInfo, EvaluatedArgs};
|
||||||
pub use crate::maybe_owned::MaybeOwned;
|
pub use crate::maybe_owned::MaybeOwned;
|
||||||
pub use crate::plugin::{serve_plugin, Plugin};
|
|
||||||
pub use crate::return_value::{CommandAction, ReturnSuccess, ReturnValue};
|
pub use crate::return_value::{CommandAction, ReturnSuccess, ReturnValue};
|
||||||
pub use crate::signature::{NamedType, PositionalType, Signature};
|
pub use crate::signature::{NamedType, PositionalType, Signature};
|
||||||
pub use crate::syntax_shape::SyntaxShape;
|
pub use crate::syntax_shape::SyntaxShape;
|
||||||
|
|
|
@ -62,6 +62,14 @@ impl Into<ReturnValue> for Value {
|
||||||
}
|
}
|
||||||
|
|
||||||
impl ReturnSuccess {
|
impl ReturnSuccess {
|
||||||
|
pub fn raw_value(&self) -> Option<Value> {
|
||||||
|
match self {
|
||||||
|
ReturnSuccess::Value(raw) => Some(raw.clone()),
|
||||||
|
ReturnSuccess::DebugValue(raw) => Some(raw.clone()),
|
||||||
|
ReturnSuccess::Action(_) => None,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
pub fn change_cwd(path: String) -> ReturnValue {
|
pub fn change_cwd(path: String) -> ReturnValue {
|
||||||
Ok(ReturnSuccess::Action(CommandAction::ChangePath(path)))
|
Ok(ReturnSuccess::Action(CommandAction::ChangePath(path)))
|
||||||
}
|
}
|
||||||
|
|
|
@ -9,6 +9,7 @@ license = "MIT"
|
||||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
|
nu-plugin = { path = "../nu-plugin", version="0.7.0" }
|
||||||
nu-protocol = { path = "../nu-protocol", version = "0.7.0" }
|
nu-protocol = { path = "../nu-protocol", version = "0.7.0" }
|
||||||
nu-source = { path = "../nu-source", version = "0.7.0" }
|
nu-source = { path = "../nu-source", version = "0.7.0" }
|
||||||
nu-errors = { path = "../nu-errors", version = "0.7.0" }
|
nu-errors = { path = "../nu-errors", version = "0.7.0" }
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
use nu_errors::{CoerceInto, ShellError};
|
use nu_errors::{CoerceInto, ShellError};
|
||||||
|
use nu_plugin::{serve_plugin, Plugin};
|
||||||
use nu_protocol::{
|
use nu_protocol::{
|
||||||
serve_plugin, CallInfo, Plugin, Primitive, ReturnSuccess, ReturnValue, Signature,
|
CallInfo, Primitive, ReturnSuccess, ReturnValue, Signature, UntaggedValue, Value,
|
||||||
UntaggedValue, Value,
|
|
||||||
};
|
};
|
||||||
use nu_source::TaggedItem;
|
use nu_source::TaggedItem;
|
||||||
|
|
||||||
|
|
|
@ -11,6 +11,7 @@ license = "MIT"
|
||||||
[dependencies]
|
[dependencies]
|
||||||
ansi_term = "0.12.1"
|
ansi_term = "0.12.1"
|
||||||
crossterm = { version = "0.10.2" }
|
crossterm = { version = "0.10.2" }
|
||||||
|
nu-plugin = { path = "../nu-plugin", version="0.7.0" }
|
||||||
nu-protocol = { path = "../nu-protocol", version = "0.7.0" }
|
nu-protocol = { path = "../nu-protocol", version = "0.7.0" }
|
||||||
nu-source = { path = "../nu-source", version = "0.7.0" }
|
nu-source = { path = "../nu-source", version = "0.7.0" }
|
||||||
nu-errors = { path = "../nu-errors", version = "0.7.0" }
|
nu-errors = { path = "../nu-errors", version = "0.7.0" }
|
||||||
|
|
|
@ -1,8 +1,7 @@
|
||||||
use crossterm::{cursor, terminal, Attribute, RawScreen};
|
use crossterm::{cursor, terminal, Attribute, RawScreen};
|
||||||
use nu_errors::ShellError;
|
use nu_errors::ShellError;
|
||||||
use nu_protocol::{
|
use nu_plugin::{serve_plugin, Plugin};
|
||||||
outln, serve_plugin, CallInfo, Plugin, Primitive, Signature, UntaggedValue, Value,
|
use nu_protocol::{outln, CallInfo, Primitive, Signature, UntaggedValue, Value};
|
||||||
};
|
|
||||||
use nu_source::AnchorLocation;
|
use nu_source::AnchorLocation;
|
||||||
use pretty_hex::*;
|
use pretty_hex::*;
|
||||||
|
|
||||||
|
|
|
@ -9,6 +9,7 @@ license = "MIT"
|
||||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
|
nu-plugin = { path = "../nu-plugin", version="0.7.0" }
|
||||||
nu-protocol = { path = "../nu-protocol", version = "0.7.0" }
|
nu-protocol = { path = "../nu-protocol", version = "0.7.0" }
|
||||||
nu-source = { path = "../nu-source", version = "0.7.0" }
|
nu-source = { path = "../nu-source", version = "0.7.0" }
|
||||||
nu-errors = { path = "../nu-errors", version = "0.7.0" }
|
nu-errors = { path = "../nu-errors", version = "0.7.0" }
|
||||||
|
|
|
@ -1,9 +1,10 @@
|
||||||
use futures::executor::block_on;
|
use futures::executor::block_on;
|
||||||
use mime::Mime;
|
use mime::Mime;
|
||||||
use nu_errors::ShellError;
|
use nu_errors::ShellError;
|
||||||
|
use nu_plugin::{serve_plugin, Plugin};
|
||||||
use nu_protocol::{
|
use nu_protocol::{
|
||||||
serve_plugin, CallInfo, CommandAction, Plugin, ReturnSuccess, ReturnValue, Signature,
|
CallInfo, CommandAction, ReturnSuccess, ReturnValue, Signature, SyntaxShape, UntaggedValue,
|
||||||
SyntaxShape, UntaggedValue, Value,
|
Value,
|
||||||
};
|
};
|
||||||
use nu_source::{AnchorLocation, Span, Tag};
|
use nu_source::{AnchorLocation, Span, Tag};
|
||||||
use std::path::PathBuf;
|
use std::path::PathBuf;
|
||||||
|
|
|
@ -9,6 +9,7 @@ license = "MIT"
|
||||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
|
nu-plugin = { path = "../nu-plugin", version="0.7.0" }
|
||||||
nu-protocol = { path = "../nu-protocol", version = "0.7.0" }
|
nu-protocol = { path = "../nu-protocol", version = "0.7.0" }
|
||||||
nu-source = { path = "../nu-source", version = "0.7.0" }
|
nu-source = { path = "../nu-source", version = "0.7.0" }
|
||||||
nu-errors = { path = "../nu-errors", version = "0.7.0" }
|
nu-errors = { path = "../nu-errors", version = "0.7.0" }
|
||||||
|
|
|
@ -1,7 +1,8 @@
|
||||||
use nu_errors::ShellError;
|
use nu_errors::ShellError;
|
||||||
|
use nu_plugin::{serve_plugin, Plugin};
|
||||||
use nu_protocol::{
|
use nu_protocol::{
|
||||||
did_you_mean, serve_plugin, CallInfo, ColumnPath, Plugin, Primitive, ReturnSuccess,
|
did_you_mean, CallInfo, ColumnPath, Primitive, ReturnSuccess, ReturnValue, ShellTypeName,
|
||||||
ReturnValue, ShellTypeName, Signature, SyntaxShape, UntaggedValue, Value,
|
Signature, SyntaxShape, UntaggedValue, Value,
|
||||||
};
|
};
|
||||||
use nu_source::{span_for_spanned_list, HasSpan, SpannedItem, Tagged};
|
use nu_source::{span_for_spanned_list, HasSpan, SpannedItem, Tagged};
|
||||||
use nu_value_ext::ValueExt;
|
use nu_value_ext::ValueExt;
|
||||||
|
@ -218,11 +219,11 @@ mod tests {
|
||||||
|
|
||||||
use super::{Inc, SemVerAction};
|
use super::{Inc, SemVerAction};
|
||||||
use indexmap::IndexMap;
|
use indexmap::IndexMap;
|
||||||
|
use nu_plugin::Plugin;
|
||||||
use nu_protocol::{
|
use nu_protocol::{
|
||||||
CallInfo, EvaluatedArgs, PathMember, ReturnSuccess, UnspannedPathMember, UntaggedValue,
|
CallInfo, EvaluatedArgs, PathMember, ReturnSuccess, TaggedDictBuilder, UnspannedPathMember,
|
||||||
Value,
|
UntaggedValue, Value,
|
||||||
};
|
};
|
||||||
use nu_protocol::{Plugin, TaggedDictBuilder};
|
|
||||||
use nu_source::{Span, Tag};
|
use nu_source::{Span, Tag};
|
||||||
|
|
||||||
struct CallStub {
|
struct CallStub {
|
||||||
|
|
|
@ -9,6 +9,7 @@ license = "MIT"
|
||||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
|
nu-plugin = { path = "../nu-plugin", version="0.7.0" }
|
||||||
nu-protocol = { path = "../nu-protocol", version = "0.7.0" }
|
nu-protocol = { path = "../nu-protocol", version = "0.7.0" }
|
||||||
nu-source = { path = "../nu-source", version = "0.7.0" }
|
nu-source = { path = "../nu-source", version = "0.7.0" }
|
||||||
nu-errors = { path = "../nu-errors", version = "0.7.0" }
|
nu-errors = { path = "../nu-errors", version = "0.7.0" }
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
use nu_errors::ShellError;
|
use nu_errors::ShellError;
|
||||||
|
use nu_plugin::{serve_plugin, Plugin};
|
||||||
use nu_protocol::{
|
use nu_protocol::{
|
||||||
serve_plugin, CallInfo, Plugin, Primitive, ReturnSuccess, ReturnValue, Signature, SyntaxShape,
|
CallInfo, Primitive, ReturnSuccess, ReturnValue, Signature, SyntaxShape, UntaggedValue, Value,
|
||||||
UntaggedValue, Value,
|
|
||||||
};
|
};
|
||||||
|
|
||||||
use regex::Regex;
|
use regex::Regex;
|
||||||
|
|
|
@ -9,6 +9,7 @@ license = "MIT"
|
||||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
|
nu-plugin = { path = "../nu-plugin", version="0.7.0" }
|
||||||
nu-protocol = { path = "../nu-protocol", version = "0.7.0" }
|
nu-protocol = { path = "../nu-protocol", version = "0.7.0" }
|
||||||
nu-source = { path = "../nu-source", version = "0.7.0" }
|
nu-source = { path = "../nu-source", version = "0.7.0" }
|
||||||
nu-errors = { path = "../nu-errors", version = "0.7.0" }
|
nu-errors = { path = "../nu-errors", version = "0.7.0" }
|
||||||
|
|
|
@ -2,9 +2,10 @@ use base64::encode;
|
||||||
use futures::executor::block_on;
|
use futures::executor::block_on;
|
||||||
use mime::Mime;
|
use mime::Mime;
|
||||||
use nu_errors::{CoerceInto, ShellError};
|
use nu_errors::{CoerceInto, ShellError};
|
||||||
|
use nu_plugin::{serve_plugin, Plugin};
|
||||||
use nu_protocol::{
|
use nu_protocol::{
|
||||||
serve_plugin, CallInfo, CommandAction, Plugin, Primitive, ReturnSuccess, ReturnValue,
|
CallInfo, CommandAction, Primitive, ReturnSuccess, ReturnValue, Signature, SyntaxShape,
|
||||||
Signature, SyntaxShape, UnspannedPathMember, UntaggedValue, Value,
|
UnspannedPathMember, UntaggedValue, Value,
|
||||||
};
|
};
|
||||||
use nu_source::{AnchorLocation, Tag, TaggedItem};
|
use nu_source::{AnchorLocation, Tag, TaggedItem};
|
||||||
use num_traits::cast::ToPrimitive;
|
use num_traits::cast::ToPrimitive;
|
||||||
|
|
|
@ -9,6 +9,7 @@ license = "MIT"
|
||||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
|
nu-plugin = { path = "../nu-plugin", version="0.7.0" }
|
||||||
nu-protocol = { path = "../nu-protocol", version = "0.7.0" }
|
nu-protocol = { path = "../nu-protocol", version = "0.7.0" }
|
||||||
nu-source = { path = "../nu-source", version = "0.7.0" }
|
nu-source = { path = "../nu-source", version = "0.7.0" }
|
||||||
nu-errors = { path = "../nu-errors", version = "0.7.0" }
|
nu-errors = { path = "../nu-errors", version = "0.7.0" }
|
||||||
|
|
|
@ -7,9 +7,9 @@ use heim::units::{information, ratio, Ratio};
|
||||||
use std::usize;
|
use std::usize;
|
||||||
|
|
||||||
use nu_errors::ShellError;
|
use nu_errors::ShellError;
|
||||||
|
use nu_plugin::{serve_plugin, Plugin};
|
||||||
use nu_protocol::{
|
use nu_protocol::{
|
||||||
serve_plugin, CallInfo, Plugin, ReturnSuccess, ReturnValue, Signature, TaggedDictBuilder,
|
CallInfo, ReturnSuccess, ReturnValue, Signature, TaggedDictBuilder, UntaggedValue, Value,
|
||||||
UntaggedValue, Value,
|
|
||||||
};
|
};
|
||||||
use nu_source::Tag;
|
use nu_source::Tag;
|
||||||
|
|
||||||
|
|
|
@ -9,6 +9,7 @@ license = "MIT"
|
||||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
|
nu-plugin = { path = "../nu-plugin", version="0.7.0" }
|
||||||
nu-protocol = { path = "../nu-protocol", version = "0.7.0" }
|
nu-protocol = { path = "../nu-protocol", version = "0.7.0" }
|
||||||
nu-source = { path = "../nu-source", version = "0.7.0" }
|
nu-source = { path = "../nu-source", version = "0.7.0" }
|
||||||
nu-errors = { path = "../nu-errors", version = "0.7.0" }
|
nu-errors = { path = "../nu-errors", version = "0.7.0" }
|
||||||
|
|
88
crates/nu_plugin_str/src/lib.rs
Normal file
88
crates/nu_plugin_str/src/lib.rs
Normal file
|
@ -0,0 +1,88 @@
|
||||||
|
mod nu_plugin_str;
|
||||||
|
mod strutils;
|
||||||
|
|
||||||
|
pub use strutils::Str;
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::Str;
|
||||||
|
use crate::strutils::Action;
|
||||||
|
use nu_errors::ShellError;
|
||||||
|
use nu_protocol::{Primitive, ReturnSuccess, TaggedDictBuilder, UntaggedValue, Value};
|
||||||
|
use nu_source::Tag;
|
||||||
|
use nu_value_ext::ValueExt;
|
||||||
|
use num_bigint::BigInt;
|
||||||
|
|
||||||
|
impl Str {
|
||||||
|
pub fn expect_action(&self, action: Action) {
|
||||||
|
match &self.action {
|
||||||
|
Some(set) if set == &action => {}
|
||||||
|
Some(other) => panic!(format!("\nExpected {:#?}\n\ngot {:#?}", action, other)),
|
||||||
|
None => panic!(format!("\nAction {:#?} not found.", action)),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn expect_field(&self, field: Value) {
|
||||||
|
let field = match field.as_column_path() {
|
||||||
|
Ok(column_path) => column_path,
|
||||||
|
Err(reason) => panic!(format!(
|
||||||
|
"\nExpected {:#?} to be a ColumnPath, \n\ngot {:#?}",
|
||||||
|
field, reason
|
||||||
|
)),
|
||||||
|
};
|
||||||
|
|
||||||
|
match &self.field {
|
||||||
|
Some(column_path) if column_path == &field => {}
|
||||||
|
Some(other) => panic!(format!("\nExpected {:#?} \n\ngot {:#?}", field, other)),
|
||||||
|
None => panic!(format!("\nField {:#?} not found.", field)),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn get_data(for_value: Value, key: &str) -> Value {
|
||||||
|
for_value.get_data(&key.to_string()).borrow().clone()
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn expect_return_value_at(
|
||||||
|
for_results: Result<Vec<Result<ReturnSuccess, ShellError>>, ShellError>,
|
||||||
|
at: usize,
|
||||||
|
) -> Value {
|
||||||
|
let return_values = for_results
|
||||||
|
.expect("Failed! This seems to be an error getting back the results from the plugin.");
|
||||||
|
|
||||||
|
for (idx, item) in return_values.iter().enumerate() {
|
||||||
|
let item = match item {
|
||||||
|
Ok(return_value) => return_value,
|
||||||
|
Err(reason) => panic!(format!("{}", reason)),
|
||||||
|
};
|
||||||
|
|
||||||
|
if idx == at {
|
||||||
|
return item.raw_value().unwrap();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
panic!(format!(
|
||||||
|
"Couldn't get return value from stream at {}. (There are {} items)",
|
||||||
|
at,
|
||||||
|
return_values.len() - 1
|
||||||
|
))
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn int(i: impl Into<BigInt>) -> Value {
|
||||||
|
UntaggedValue::Primitive(Primitive::Int(i.into())).into_untagged_value()
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn string(input: impl Into<String>) -> Value {
|
||||||
|
UntaggedValue::string(input.into()).into_untagged_value()
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn structured_sample_record(key: &str, value: &str) -> Value {
|
||||||
|
let mut record = TaggedDictBuilder::new(Tag::unknown());
|
||||||
|
record.insert_untagged(key.clone(), UntaggedValue::string(value));
|
||||||
|
record.into_value()
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn unstructured_sample_record(value: &str) -> Value {
|
||||||
|
UntaggedValue::string(value).into_value(Tag::unknown())
|
||||||
|
}
|
||||||
|
}
|
|
@ -1,980 +1,6 @@
|
||||||
use nu_errors::ShellError;
|
use nu_plugin::serve_plugin;
|
||||||
use nu_protocol::{
|
use nu_plugin_str::Str;
|
||||||
did_you_mean, serve_plugin, CallInfo, ColumnPath, Plugin, Primitive, ReturnSuccess,
|
|
||||||
ReturnValue, ShellTypeName, Signature, SyntaxShape, UntaggedValue, Value,
|
|
||||||
};
|
|
||||||
use nu_source::{span_for_spanned_list, Tagged};
|
|
||||||
use nu_value_ext::ValueExt;
|
|
||||||
|
|
||||||
use regex::Regex;
|
|
||||||
use std::cmp;
|
|
||||||
|
|
||||||
#[derive(Debug, Eq, PartialEq)]
|
|
||||||
enum Action {
|
|
||||||
Downcase,
|
|
||||||
Upcase,
|
|
||||||
ToInteger,
|
|
||||||
Substring(usize, usize),
|
|
||||||
Replace(ReplaceAction),
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug, Eq, PartialEq)]
|
|
||||||
enum ReplaceAction {
|
|
||||||
Direct(String),
|
|
||||||
FindAndReplace(String, String),
|
|
||||||
}
|
|
||||||
|
|
||||||
struct Str {
|
|
||||||
field: Option<Tagged<ColumnPath>>,
|
|
||||||
error: Option<String>,
|
|
||||||
action: Option<Action>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Str {
|
|
||||||
fn new() -> Str {
|
|
||||||
Str {
|
|
||||||
field: None,
|
|
||||||
error: None,
|
|
||||||
action: None,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn apply(&self, input: &str) -> Result<UntaggedValue, ShellError> {
|
|
||||||
let applied = match self.action.as_ref() {
|
|
||||||
Some(Action::Downcase) => UntaggedValue::string(input.to_ascii_lowercase()),
|
|
||||||
Some(Action::Upcase) => UntaggedValue::string(input.to_ascii_uppercase()),
|
|
||||||
Some(Action::Substring(s, e)) => {
|
|
||||||
let end: usize = cmp::min(*e, input.len());
|
|
||||||
let start: usize = *s;
|
|
||||||
if start > input.len() - 1 {
|
|
||||||
UntaggedValue::string("")
|
|
||||||
} else {
|
|
||||||
UntaggedValue::string(
|
|
||||||
&input
|
|
||||||
.chars()
|
|
||||||
.skip(start)
|
|
||||||
.take(end - start)
|
|
||||||
.collect::<String>(),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Some(Action::Replace(mode)) => match mode {
|
|
||||||
ReplaceAction::Direct(replacement) => UntaggedValue::string(replacement.as_str()),
|
|
||||||
ReplaceAction::FindAndReplace(find, replacement) => {
|
|
||||||
let regex = Regex::new(find.as_str());
|
|
||||||
|
|
||||||
match regex {
|
|
||||||
Ok(re) => UntaggedValue::string(
|
|
||||||
re.replace(input, replacement.as_str()).to_owned(),
|
|
||||||
),
|
|
||||||
Err(_) => UntaggedValue::string(input),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
Some(Action::ToInteger) => match input.trim() {
|
|
||||||
other => match other.parse::<i64>() {
|
|
||||||
Ok(v) => UntaggedValue::int(v),
|
|
||||||
Err(_) => UntaggedValue::string(input),
|
|
||||||
},
|
|
||||||
},
|
|
||||||
None => UntaggedValue::string(input),
|
|
||||||
};
|
|
||||||
|
|
||||||
Ok(applied)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn for_field(&mut self, column_path: Tagged<ColumnPath>) {
|
|
||||||
self.field = Some(column_path);
|
|
||||||
}
|
|
||||||
|
|
||||||
fn permit(&mut self) -> bool {
|
|
||||||
self.action.is_none()
|
|
||||||
}
|
|
||||||
|
|
||||||
fn log_error(&mut self, message: &str) {
|
|
||||||
self.error = Some(message.to_string());
|
|
||||||
}
|
|
||||||
|
|
||||||
fn for_to_int(&mut self) {
|
|
||||||
if self.permit() {
|
|
||||||
self.action = Some(Action::ToInteger);
|
|
||||||
} else {
|
|
||||||
self.log_error("can only apply one");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn for_downcase(&mut self) {
|
|
||||||
if self.permit() {
|
|
||||||
self.action = Some(Action::Downcase);
|
|
||||||
} else {
|
|
||||||
self.log_error("can only apply one");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn for_upcase(&mut self) {
|
|
||||||
if self.permit() {
|
|
||||||
self.action = Some(Action::Upcase);
|
|
||||||
} else {
|
|
||||||
self.log_error("can only apply one");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn for_substring(&mut self, s: String) {
|
|
||||||
let v: Vec<&str> = s.split(',').collect();
|
|
||||||
let start: usize = match v[0] {
|
|
||||||
"" => 0,
|
|
||||||
_ => v[0].trim().parse().unwrap(),
|
|
||||||
};
|
|
||||||
let end: usize = match v[1] {
|
|
||||||
"" => usize::max_value(),
|
|
||||||
_ => v[1].trim().parse().unwrap(),
|
|
||||||
};
|
|
||||||
if start > end {
|
|
||||||
self.log_error("End must be greater than or equal to Start");
|
|
||||||
} else if self.permit() {
|
|
||||||
self.action = Some(Action::Substring(start, end));
|
|
||||||
} else {
|
|
||||||
self.log_error("can only apply one");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn for_replace(&mut self, mode: ReplaceAction) {
|
|
||||||
if self.permit() {
|
|
||||||
self.action = Some(Action::Replace(mode));
|
|
||||||
} else {
|
|
||||||
self.log_error("can only apply one");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn usage() -> &'static str {
|
|
||||||
"Usage: str field [--downcase|--upcase|--to-int|--substring \"start,end\"|--replace|--find-replace [pattern replacement]]]"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Str {
|
|
||||||
fn strutils(&self, value: Value) -> Result<Value, ShellError> {
|
|
||||||
match &value.value {
|
|
||||||
UntaggedValue::Primitive(Primitive::String(ref s)) => {
|
|
||||||
Ok(self.apply(&s)?.into_value(value.tag()))
|
|
||||||
}
|
|
||||||
UntaggedValue::Primitive(Primitive::Line(ref s)) => {
|
|
||||||
Ok(self.apply(&s)?.into_value(value.tag()))
|
|
||||||
}
|
|
||||||
UntaggedValue::Row(_) => match self.field {
|
|
||||||
Some(ref f) => {
|
|
||||||
let fields = f.clone();
|
|
||||||
|
|
||||||
let replace_for =
|
|
||||||
value.get_data_by_column_path(
|
|
||||||
&f,
|
|
||||||
Box::new(move |(obj_source, column_path_tried, error)| {
|
|
||||||
match did_you_mean(&obj_source, &column_path_tried) {
|
|
||||||
Some(suggestions) => ShellError::labeled_error(
|
|
||||||
"Unknown column",
|
|
||||||
format!("did you mean '{}'?", suggestions[0].1),
|
|
||||||
span_for_spanned_list(fields.iter().map(|p| p.span)),
|
|
||||||
),
|
|
||||||
None => error,
|
|
||||||
}
|
|
||||||
}),
|
|
||||||
);
|
|
||||||
|
|
||||||
let got = replace_for?;
|
|
||||||
let replacement = self.strutils(got.clone())?;
|
|
||||||
|
|
||||||
match value.replace_data_at_column_path(
|
|
||||||
&f,
|
|
||||||
replacement.value.clone().into_untagged_value(),
|
|
||||||
) {
|
|
||||||
Some(v) => Ok(v),
|
|
||||||
None => Err(ShellError::labeled_error(
|
|
||||||
"str could not find field to replace",
|
|
||||||
"column name",
|
|
||||||
value.tag(),
|
|
||||||
)),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
None => Err(ShellError::untagged_runtime_error(format!(
|
|
||||||
"{}: {}",
|
|
||||||
"str needs a column when applied to a value in a row",
|
|
||||||
Str::usage()
|
|
||||||
))),
|
|
||||||
},
|
|
||||||
_ => Err(ShellError::labeled_error(
|
|
||||||
"Unrecognized type in stream",
|
|
||||||
value.type_name(),
|
|
||||||
value.tag,
|
|
||||||
)),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Plugin for Str {
|
|
||||||
fn config(&mut self) -> Result<Signature, ShellError> {
|
|
||||||
Ok(Signature::build("str")
|
|
||||||
.desc("Apply string function. Optional use the column of a table")
|
|
||||||
.switch("downcase", "convert string to lowercase")
|
|
||||||
.switch("upcase", "convert string to uppercase")
|
|
||||||
.switch("to-int", "convert string to integer")
|
|
||||||
.named("replace", SyntaxShape::String, "replaces the string")
|
|
||||||
.named(
|
|
||||||
"find-replace",
|
|
||||||
SyntaxShape::Any,
|
|
||||||
"finds and replaces [pattern replacement]",
|
|
||||||
)
|
|
||||||
.named(
|
|
||||||
"substring",
|
|
||||||
SyntaxShape::String,
|
|
||||||
"convert string to portion of original, requires \"start,end\"",
|
|
||||||
)
|
|
||||||
.rest(SyntaxShape::ColumnPath, "the column(s) to convert")
|
|
||||||
.filter())
|
|
||||||
}
|
|
||||||
|
|
||||||
fn begin_filter(&mut self, call_info: CallInfo) -> Result<Vec<ReturnValue>, ShellError> {
|
|
||||||
let args = call_info.args;
|
|
||||||
|
|
||||||
if args.has("downcase") {
|
|
||||||
self.for_downcase();
|
|
||||||
}
|
|
||||||
if args.has("upcase") {
|
|
||||||
self.for_upcase();
|
|
||||||
}
|
|
||||||
if args.has("to-int") {
|
|
||||||
self.for_to_int();
|
|
||||||
}
|
|
||||||
if args.has("substring") {
|
|
||||||
if let Some(start_end) = args.get("substring") {
|
|
||||||
match start_end {
|
|
||||||
Value {
|
|
||||||
value: UntaggedValue::Primitive(Primitive::String(s)),
|
|
||||||
..
|
|
||||||
} => {
|
|
||||||
self.for_substring(s.to_string());
|
|
||||||
}
|
|
||||||
_ => {
|
|
||||||
return Err(ShellError::labeled_error(
|
|
||||||
"Unrecognized type in params",
|
|
||||||
start_end.type_name(),
|
|
||||||
&start_end.tag,
|
|
||||||
))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if args.has("replace") {
|
|
||||||
if let Some(Value {
|
|
||||||
value: UntaggedValue::Primitive(Primitive::String(replacement)),
|
|
||||||
..
|
|
||||||
}) = args.get("replace")
|
|
||||||
{
|
|
||||||
self.for_replace(ReplaceAction::Direct(replacement.clone()));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if args.has("find-replace") {
|
|
||||||
if let Some(Value {
|
|
||||||
value: UntaggedValue::Table(arguments),
|
|
||||||
..
|
|
||||||
}) = args.get("find-replace")
|
|
||||||
{
|
|
||||||
self.for_replace(ReplaceAction::FindAndReplace(
|
|
||||||
arguments.get(0).unwrap().as_string()?.to_string(),
|
|
||||||
arguments.get(1).unwrap().as_string()?.to_string(),
|
|
||||||
));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if let Some(possible_field) = args.nth(0) {
|
|
||||||
let possible_field = possible_field.as_column_path()?;
|
|
||||||
self.for_field(possible_field);
|
|
||||||
}
|
|
||||||
|
|
||||||
match &self.error {
|
|
||||||
Some(reason) => Err(ShellError::untagged_runtime_error(format!(
|
|
||||||
"{}: {}",
|
|
||||||
reason,
|
|
||||||
Str::usage()
|
|
||||||
))),
|
|
||||||
None => Ok(vec![]),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn filter(&mut self, input: Value) -> Result<Vec<ReturnValue>, ShellError> {
|
|
||||||
Ok(vec![ReturnSuccess::value(self.strutils(input)?)])
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn main() {
|
fn main() {
|
||||||
serve_plugin(&mut Str::new());
|
serve_plugin(&mut Str::new())
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(test)]
|
|
||||||
mod tests {
|
|
||||||
use super::{Action, ReplaceAction, Str};
|
|
||||||
use indexmap::IndexMap;
|
|
||||||
use nu_protocol::{
|
|
||||||
CallInfo, EvaluatedArgs, Plugin, Primitive, ReturnSuccess, TaggedDictBuilder,
|
|
||||||
UntaggedValue, Value,
|
|
||||||
};
|
|
||||||
use nu_source::Tag;
|
|
||||||
use nu_value_ext::ValueExt;
|
|
||||||
use num_bigint::BigInt;
|
|
||||||
|
|
||||||
fn string(input: impl Into<String>) -> Value {
|
|
||||||
UntaggedValue::string(input.into()).into_untagged_value()
|
|
||||||
}
|
|
||||||
|
|
||||||
fn table(list: &Vec<Value>) -> Value {
|
|
||||||
UntaggedValue::table(list).into_untagged_value()
|
|
||||||
}
|
|
||||||
|
|
||||||
fn column_path(paths: &Vec<Value>) -> Value {
|
|
||||||
UntaggedValue::Primitive(Primitive::ColumnPath(
|
|
||||||
table(&paths.iter().cloned().collect())
|
|
||||||
.as_column_path()
|
|
||||||
.unwrap()
|
|
||||||
.item,
|
|
||||||
))
|
|
||||||
.into_untagged_value()
|
|
||||||
}
|
|
||||||
struct CallStub {
|
|
||||||
positionals: Vec<Value>,
|
|
||||||
flags: IndexMap<String, Value>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl CallStub {
|
|
||||||
fn new() -> CallStub {
|
|
||||||
CallStub {
|
|
||||||
positionals: vec![],
|
|
||||||
flags: indexmap::IndexMap::new(),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn with_named_parameter(&mut self, name: &str, value: Value) -> &mut Self {
|
|
||||||
self.flags.insert(name.to_string(), value);
|
|
||||||
self
|
|
||||||
}
|
|
||||||
|
|
||||||
fn with_long_flag(&mut self, name: &str) -> &mut Self {
|
|
||||||
self.flags.insert(
|
|
||||||
name.to_string(),
|
|
||||||
UntaggedValue::boolean(true).into_value(Tag::unknown()),
|
|
||||||
);
|
|
||||||
self
|
|
||||||
}
|
|
||||||
|
|
||||||
fn with_parameter(&mut self, name: &str) -> &mut Self {
|
|
||||||
let fields: Vec<Value> = name
|
|
||||||
.split(".")
|
|
||||||
.map(|s| UntaggedValue::string(s.to_string()).into_value(Tag::unknown()))
|
|
||||||
.collect();
|
|
||||||
|
|
||||||
self.positionals.push(column_path(&fields));
|
|
||||||
self
|
|
||||||
}
|
|
||||||
|
|
||||||
fn create(&self) -> CallInfo {
|
|
||||||
CallInfo {
|
|
||||||
args: EvaluatedArgs::new(Some(self.positionals.clone()), Some(self.flags.clone())),
|
|
||||||
name_tag: Tag::unknown(),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn structured_sample_record(key: &str, value: &str) -> Value {
|
|
||||||
let mut record = TaggedDictBuilder::new(Tag::unknown());
|
|
||||||
record.insert_untagged(key.clone(), UntaggedValue::string(value));
|
|
||||||
record.into_value()
|
|
||||||
}
|
|
||||||
|
|
||||||
fn unstructured_sample_record(value: &str) -> Value {
|
|
||||||
UntaggedValue::string(value).into_value(Tag::unknown())
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_configuration_flags_wired() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
let configured = plugin.config().unwrap();
|
|
||||||
|
|
||||||
for action_flag in &[
|
|
||||||
"downcase",
|
|
||||||
"upcase",
|
|
||||||
"to-int",
|
|
||||||
"substring",
|
|
||||||
"replace",
|
|
||||||
"find-replace",
|
|
||||||
] {
|
|
||||||
assert!(configured.named.get(*action_flag).is_some());
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_accepts_downcase() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(CallStub::new().with_long_flag("downcase").create())
|
|
||||||
.is_ok());
|
|
||||||
assert_eq!(plugin.action.unwrap(), Action::Downcase);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_accepts_upcase() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(CallStub::new().with_long_flag("upcase").create())
|
|
||||||
.is_ok());
|
|
||||||
assert_eq!(plugin.action.unwrap(), Action::Upcase);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_accepts_to_int() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(CallStub::new().with_long_flag("to-int").create())
|
|
||||||
.is_ok());
|
|
||||||
assert_eq!(plugin.action.unwrap(), Action::ToInteger);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_accepts_replace() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
let argument = String::from("replace_text");
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(
|
|
||||||
CallStub::new()
|
|
||||||
.with_named_parameter("replace", string(&argument))
|
|
||||||
.create()
|
|
||||||
)
|
|
||||||
.is_ok());
|
|
||||||
|
|
||||||
match plugin.action {
|
|
||||||
Some(Action::Replace(ReplaceAction::Direct(replace_with))) => {
|
|
||||||
assert_eq!(replace_with, argument)
|
|
||||||
}
|
|
||||||
Some(_) | None => panic!("Din't accept."),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_accepts_find_replace() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
let search_argument = String::from("kittens");
|
|
||||||
let replace_argument = String::from("jotandrehuda");
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(
|
|
||||||
CallStub::new()
|
|
||||||
.with_named_parameter(
|
|
||||||
"find-replace",
|
|
||||||
table(&vec![string(&search_argument), string(&replace_argument)])
|
|
||||||
)
|
|
||||||
.create()
|
|
||||||
)
|
|
||||||
.is_ok());
|
|
||||||
|
|
||||||
match plugin.action {
|
|
||||||
Some(Action::Replace(ReplaceAction::FindAndReplace(find_with, replace_with))) => {
|
|
||||||
assert_eq!(find_with, search_argument);
|
|
||||||
assert_eq!(replace_with, replace_argument);
|
|
||||||
}
|
|
||||||
Some(_) | None => panic!("Din't accept."),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_accepts_field() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(
|
|
||||||
CallStub::new()
|
|
||||||
.with_parameter("package.description")
|
|
||||||
.create()
|
|
||||||
)
|
|
||||||
.is_ok());
|
|
||||||
|
|
||||||
let actual = &*plugin.field.unwrap();
|
|
||||||
let actual = UntaggedValue::Primitive(Primitive::ColumnPath(actual.clone()));
|
|
||||||
let actual = actual.into_value(Tag::unknown());
|
|
||||||
|
|
||||||
assert_eq!(
|
|
||||||
actual,
|
|
||||||
column_path(&vec![string("package"), string("description")])
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_accepts_only_one_action() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(
|
|
||||||
CallStub::new()
|
|
||||||
.with_long_flag("upcase")
|
|
||||||
.with_long_flag("downcase")
|
|
||||||
.with_long_flag("to-int")
|
|
||||||
.with_long_flag("substring")
|
|
||||||
.create(),
|
|
||||||
)
|
|
||||||
.is_err());
|
|
||||||
assert_eq!(plugin.error, Some("can only apply one".to_string()));
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_downcases() {
|
|
||||||
let mut strutils = Str::new();
|
|
||||||
strutils.for_downcase();
|
|
||||||
assert_eq!(
|
|
||||||
strutils.apply("ANDRES").unwrap(),
|
|
||||||
UntaggedValue::string("andres")
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_upcases() {
|
|
||||||
let mut strutils = Str::new();
|
|
||||||
strutils.for_upcase();
|
|
||||||
assert_eq!(
|
|
||||||
strutils.apply("andres").unwrap(),
|
|
||||||
UntaggedValue::string("ANDRES")
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_to_int() {
|
|
||||||
let mut strutils = Str::new();
|
|
||||||
strutils.for_to_int();
|
|
||||||
assert_eq!(
|
|
||||||
strutils.apply("9999").unwrap(),
|
|
||||||
UntaggedValue::int(9999 as i64)
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_replace() {
|
|
||||||
let mut strutils = Str::new();
|
|
||||||
strutils.for_replace(ReplaceAction::Direct("robalino".to_string()));
|
|
||||||
|
|
||||||
assert_eq!(
|
|
||||||
strutils.apply("andres").unwrap(),
|
|
||||||
UntaggedValue::string("robalino")
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_find_replace() {
|
|
||||||
let mut strutils = Str::new();
|
|
||||||
strutils.for_replace(ReplaceAction::FindAndReplace(
|
|
||||||
"kittens".to_string(),
|
|
||||||
"jotandrehuda".to_string(),
|
|
||||||
));
|
|
||||||
assert_eq!(
|
|
||||||
strutils.apply("wykittens").unwrap(),
|
|
||||||
UntaggedValue::string("wyjotandrehuda")
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_applies_upcase_with_field() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(
|
|
||||||
CallStub::new()
|
|
||||||
.with_long_flag("upcase")
|
|
||||||
.with_parameter("name")
|
|
||||||
.create()
|
|
||||||
)
|
|
||||||
.is_ok());
|
|
||||||
|
|
||||||
let subject = structured_sample_record("name", "jotandrehuda");
|
|
||||||
let output = plugin.filter(subject).unwrap();
|
|
||||||
|
|
||||||
match output[0].as_ref().unwrap() {
|
|
||||||
ReturnSuccess::Value(Value {
|
|
||||||
value: UntaggedValue::Row(o),
|
|
||||||
..
|
|
||||||
}) => assert_eq!(
|
|
||||||
*o.get_data(&String::from("name")).borrow(),
|
|
||||||
UntaggedValue::string(String::from("JOTANDREHUDA")).into_untagged_value()
|
|
||||||
),
|
|
||||||
_ => {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_applies_upcase_without_field() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(CallStub::new().with_long_flag("upcase").create())
|
|
||||||
.is_ok());
|
|
||||||
|
|
||||||
let subject = unstructured_sample_record("jotandrehuda");
|
|
||||||
let output = plugin.filter(subject).unwrap();
|
|
||||||
|
|
||||||
match output[0].as_ref().unwrap() {
|
|
||||||
ReturnSuccess::Value(Value {
|
|
||||||
value: UntaggedValue::Primitive(Primitive::String(s)),
|
|
||||||
..
|
|
||||||
}) => assert_eq!(*s, String::from("JOTANDREHUDA")),
|
|
||||||
_ => {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_applies_downcase_with_field() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(
|
|
||||||
CallStub::new()
|
|
||||||
.with_long_flag("downcase")
|
|
||||||
.with_parameter("name")
|
|
||||||
.create()
|
|
||||||
)
|
|
||||||
.is_ok());
|
|
||||||
|
|
||||||
let subject = structured_sample_record("name", "JOTANDREHUDA");
|
|
||||||
let output = plugin.filter(subject).unwrap();
|
|
||||||
|
|
||||||
match output[0].as_ref().unwrap() {
|
|
||||||
ReturnSuccess::Value(Value {
|
|
||||||
value: UntaggedValue::Row(o),
|
|
||||||
..
|
|
||||||
}) => assert_eq!(
|
|
||||||
*o.get_data(&String::from("name")).borrow(),
|
|
||||||
UntaggedValue::string(String::from("jotandrehuda")).into_untagged_value()
|
|
||||||
),
|
|
||||||
_ => {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_applies_downcase_without_field() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(CallStub::new().with_long_flag("downcase").create())
|
|
||||||
.is_ok());
|
|
||||||
|
|
||||||
let subject = unstructured_sample_record("JOTANDREHUDA");
|
|
||||||
let output = plugin.filter(subject).unwrap();
|
|
||||||
|
|
||||||
match output[0].as_ref().unwrap() {
|
|
||||||
ReturnSuccess::Value(Value {
|
|
||||||
value: UntaggedValue::Primitive(Primitive::String(s)),
|
|
||||||
..
|
|
||||||
}) => assert_eq!(*s, String::from("jotandrehuda")),
|
|
||||||
_ => {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_applies_to_int_with_field() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(
|
|
||||||
CallStub::new()
|
|
||||||
.with_long_flag("to-int")
|
|
||||||
.with_parameter("Nu_birthday")
|
|
||||||
.create()
|
|
||||||
)
|
|
||||||
.is_ok());
|
|
||||||
|
|
||||||
let subject = structured_sample_record("Nu_birthday", "10");
|
|
||||||
let output = plugin.filter(subject).unwrap();
|
|
||||||
|
|
||||||
match output[0].as_ref().unwrap() {
|
|
||||||
ReturnSuccess::Value(Value {
|
|
||||||
value: UntaggedValue::Row(o),
|
|
||||||
..
|
|
||||||
}) => assert_eq!(
|
|
||||||
*o.get_data(&String::from("Nu_birthday")).borrow(),
|
|
||||||
UntaggedValue::int(10).into_untagged_value()
|
|
||||||
),
|
|
||||||
_ => {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_applies_to_int_without_field() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(CallStub::new().with_long_flag("to-int").create())
|
|
||||||
.is_ok());
|
|
||||||
|
|
||||||
let subject = unstructured_sample_record("10");
|
|
||||||
let output = plugin.filter(subject).unwrap();
|
|
||||||
|
|
||||||
match output[0].as_ref().unwrap() {
|
|
||||||
ReturnSuccess::Value(Value {
|
|
||||||
value: UntaggedValue::Primitive(Primitive::Int(i)),
|
|
||||||
..
|
|
||||||
}) => assert_eq!(*i, BigInt::from(10)),
|
|
||||||
_ => {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_applies_substring_without_field() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(
|
|
||||||
CallStub::new()
|
|
||||||
.with_named_parameter("substring", string("0,1"))
|
|
||||||
.create()
|
|
||||||
)
|
|
||||||
.is_ok());
|
|
||||||
|
|
||||||
let subject = unstructured_sample_record("0123456789");
|
|
||||||
let output = plugin.filter(subject).unwrap();
|
|
||||||
|
|
||||||
match output[0].as_ref().unwrap() {
|
|
||||||
ReturnSuccess::Value(Value {
|
|
||||||
value: UntaggedValue::Primitive(Primitive::String(s)),
|
|
||||||
..
|
|
||||||
}) => assert_eq!(*s, String::from("0")),
|
|
||||||
_ => {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_applies_substring_exceeding_string_length() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(
|
|
||||||
CallStub::new()
|
|
||||||
.with_named_parameter("substring", string("0,11"))
|
|
||||||
.create()
|
|
||||||
)
|
|
||||||
.is_ok());
|
|
||||||
|
|
||||||
let subject = unstructured_sample_record("0123456789");
|
|
||||||
let output = plugin.filter(subject).unwrap();
|
|
||||||
|
|
||||||
match output[0].as_ref().unwrap() {
|
|
||||||
ReturnSuccess::Value(Value {
|
|
||||||
value: UntaggedValue::Primitive(Primitive::String(s)),
|
|
||||||
..
|
|
||||||
}) => assert_eq!(*s, String::from("0123456789")),
|
|
||||||
_ => {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_applies_substring_returns_blank_if_start_exceeds_length() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(
|
|
||||||
CallStub::new()
|
|
||||||
.with_named_parameter("substring", string("20,30"))
|
|
||||||
.create()
|
|
||||||
)
|
|
||||||
.is_ok());
|
|
||||||
|
|
||||||
let subject = unstructured_sample_record("0123456789");
|
|
||||||
let output = plugin.filter(subject).unwrap();
|
|
||||||
|
|
||||||
match output[0].as_ref().unwrap() {
|
|
||||||
ReturnSuccess::Value(Value {
|
|
||||||
value: UntaggedValue::Primitive(Primitive::String(s)),
|
|
||||||
..
|
|
||||||
}) => assert_eq!(*s, String::from("")),
|
|
||||||
_ => {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_applies_substring_treats_blank_start_as_zero() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(
|
|
||||||
CallStub::new()
|
|
||||||
.with_named_parameter("substring", string(",5"))
|
|
||||||
.create()
|
|
||||||
)
|
|
||||||
.is_ok());
|
|
||||||
|
|
||||||
let subject = unstructured_sample_record("0123456789");
|
|
||||||
let output = plugin.filter(subject).unwrap();
|
|
||||||
|
|
||||||
match output[0].as_ref().unwrap() {
|
|
||||||
ReturnSuccess::Value(Value {
|
|
||||||
value: UntaggedValue::Primitive(Primitive::String(s)),
|
|
||||||
..
|
|
||||||
}) => assert_eq!(*s, String::from("01234")),
|
|
||||||
_ => {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_applies_substring_treats_blank_end_as_length() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(
|
|
||||||
CallStub::new()
|
|
||||||
.with_named_parameter("substring", string("2,"))
|
|
||||||
.create()
|
|
||||||
)
|
|
||||||
.is_ok());
|
|
||||||
|
|
||||||
let subject = unstructured_sample_record("0123456789");
|
|
||||||
let output = plugin.filter(subject).unwrap();
|
|
||||||
|
|
||||||
match output[0].as_ref().unwrap() {
|
|
||||||
ReturnSuccess::Value(Value {
|
|
||||||
value: UntaggedValue::Primitive(Primitive::String(s)),
|
|
||||||
..
|
|
||||||
}) => assert_eq!(*s, String::from("23456789")),
|
|
||||||
_ => {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_applies_substring_returns_error_if_start_exceeds_end() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(
|
|
||||||
CallStub::new()
|
|
||||||
.with_named_parameter("substring", string("3,1"))
|
|
||||||
.create()
|
|
||||||
)
|
|
||||||
.is_err());
|
|
||||||
assert_eq!(
|
|
||||||
plugin.error,
|
|
||||||
Some("End must be greater than or equal to Start".to_string())
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_applies_replace_with_field() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(
|
|
||||||
CallStub::new()
|
|
||||||
.with_parameter("rustconf")
|
|
||||||
.with_named_parameter("replace", string("22nd August 2019"))
|
|
||||||
.create()
|
|
||||||
)
|
|
||||||
.is_ok());
|
|
||||||
|
|
||||||
let subject = structured_sample_record("rustconf", "1st January 1970");
|
|
||||||
let output = plugin.filter(subject).unwrap();
|
|
||||||
|
|
||||||
match output[0].as_ref().unwrap() {
|
|
||||||
ReturnSuccess::Value(Value {
|
|
||||||
value: UntaggedValue::Row(o),
|
|
||||||
..
|
|
||||||
}) => assert_eq!(
|
|
||||||
*o.get_data(&String::from("rustconf")).borrow(),
|
|
||||||
Value {
|
|
||||||
value: UntaggedValue::string(String::from("22nd August 2019")),
|
|
||||||
tag: Tag::unknown()
|
|
||||||
}
|
|
||||||
),
|
|
||||||
_ => {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_applies_replace_without_field() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(
|
|
||||||
CallStub::new()
|
|
||||||
.with_named_parameter("replace", string("22nd August 2019"))
|
|
||||||
.create()
|
|
||||||
)
|
|
||||||
.is_ok());
|
|
||||||
|
|
||||||
let subject = unstructured_sample_record("1st January 1970");
|
|
||||||
let output = plugin.filter(subject).unwrap();
|
|
||||||
|
|
||||||
match output[0].as_ref().unwrap() {
|
|
||||||
ReturnSuccess::Value(Value {
|
|
||||||
value: UntaggedValue::Primitive(Primitive::String(s)),
|
|
||||||
..
|
|
||||||
}) => assert_eq!(*s, String::from("22nd August 2019")),
|
|
||||||
_ => {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_applies_find_replace_with_field() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(
|
|
||||||
CallStub::new()
|
|
||||||
.with_parameter("staff")
|
|
||||||
.with_named_parameter(
|
|
||||||
"find-replace",
|
|
||||||
table(&vec![string("kittens"), string("jotandrehuda")])
|
|
||||||
)
|
|
||||||
.create()
|
|
||||||
)
|
|
||||||
.is_ok());
|
|
||||||
|
|
||||||
let subject = structured_sample_record("staff", "wykittens");
|
|
||||||
let output = plugin.filter(subject).unwrap();
|
|
||||||
|
|
||||||
match output[0].as_ref().unwrap() {
|
|
||||||
ReturnSuccess::Value(Value {
|
|
||||||
value: UntaggedValue::Row(o),
|
|
||||||
..
|
|
||||||
}) => assert_eq!(
|
|
||||||
*o.get_data(&String::from("staff")).borrow(),
|
|
||||||
Value {
|
|
||||||
value: UntaggedValue::string(String::from("wyjotandrehuda")),
|
|
||||||
tag: Tag::unknown()
|
|
||||||
}
|
|
||||||
),
|
|
||||||
_ => {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_applies_find_replace_without_field() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(
|
|
||||||
CallStub::new()
|
|
||||||
.with_named_parameter(
|
|
||||||
"find-replace",
|
|
||||||
table(&vec![string("kittens"), string("jotandrehuda")])
|
|
||||||
)
|
|
||||||
.create()
|
|
||||||
)
|
|
||||||
.is_ok());
|
|
||||||
|
|
||||||
let subject = unstructured_sample_record("wykittens");
|
|
||||||
let output = plugin.filter(subject).unwrap();
|
|
||||||
|
|
||||||
match output[0].as_ref().unwrap() {
|
|
||||||
ReturnSuccess::Value(Value {
|
|
||||||
value: UntaggedValue::Primitive(Primitive::String(s)),
|
|
||||||
..
|
|
||||||
}) => assert_eq!(*s, String::from("wyjotandrehuda")),
|
|
||||||
_ => {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
108
crates/nu_plugin_str/src/nu_plugin_str/mod.rs
Normal file
108
crates/nu_plugin_str/src/nu_plugin_str/mod.rs
Normal file
|
@ -0,0 +1,108 @@
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests;
|
||||||
|
|
||||||
|
use crate::strutils::ReplaceAction;
|
||||||
|
use crate::Str;
|
||||||
|
use nu_errors::ShellError;
|
||||||
|
use nu_plugin::Plugin;
|
||||||
|
use nu_protocol::{
|
||||||
|
CallInfo, Primitive, ReturnSuccess, ReturnValue, ShellTypeName, Signature, SyntaxShape,
|
||||||
|
UntaggedValue, Value,
|
||||||
|
};
|
||||||
|
use nu_value_ext::ValueExt;
|
||||||
|
|
||||||
|
impl Plugin for Str {
|
||||||
|
fn config(&mut self) -> Result<Signature, ShellError> {
|
||||||
|
Ok(Signature::build("str")
|
||||||
|
.desc("Apply string function. Optional use the column of a table")
|
||||||
|
.switch("downcase", "convert string to lowercase")
|
||||||
|
.switch("upcase", "convert string to uppercase")
|
||||||
|
.switch("to-int", "convert string to integer")
|
||||||
|
.named("replace", SyntaxShape::String, "replaces the string")
|
||||||
|
.named(
|
||||||
|
"find-replace",
|
||||||
|
SyntaxShape::Any,
|
||||||
|
"finds and replaces [pattern replacement]",
|
||||||
|
)
|
||||||
|
.named(
|
||||||
|
"substring",
|
||||||
|
SyntaxShape::String,
|
||||||
|
"convert string to portion of original, requires \"start,end\"",
|
||||||
|
)
|
||||||
|
.rest(SyntaxShape::ColumnPath, "the column(s) to convert")
|
||||||
|
.filter())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn begin_filter(&mut self, call_info: CallInfo) -> Result<Vec<ReturnValue>, ShellError> {
|
||||||
|
let args = call_info.args;
|
||||||
|
|
||||||
|
if args.has("downcase") {
|
||||||
|
self.for_downcase();
|
||||||
|
}
|
||||||
|
if args.has("upcase") {
|
||||||
|
self.for_upcase();
|
||||||
|
}
|
||||||
|
if args.has("to-int") {
|
||||||
|
self.for_to_int();
|
||||||
|
}
|
||||||
|
if args.has("substring") {
|
||||||
|
if let Some(start_end) = args.get("substring") {
|
||||||
|
match start_end {
|
||||||
|
Value {
|
||||||
|
value: UntaggedValue::Primitive(Primitive::String(s)),
|
||||||
|
..
|
||||||
|
} => {
|
||||||
|
self.for_substring(s.to_string());
|
||||||
|
}
|
||||||
|
_ => {
|
||||||
|
return Err(ShellError::labeled_error(
|
||||||
|
"Unrecognized type in params",
|
||||||
|
start_end.type_name(),
|
||||||
|
&start_end.tag,
|
||||||
|
))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if args.has("replace") {
|
||||||
|
if let Some(Value {
|
||||||
|
value: UntaggedValue::Primitive(Primitive::String(replacement)),
|
||||||
|
..
|
||||||
|
}) = args.get("replace")
|
||||||
|
{
|
||||||
|
self.for_replace(ReplaceAction::Direct(replacement.clone()));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if args.has("find-replace") {
|
||||||
|
if let Some(Value {
|
||||||
|
value: UntaggedValue::Table(arguments),
|
||||||
|
..
|
||||||
|
}) = args.get("find-replace")
|
||||||
|
{
|
||||||
|
self.for_replace(ReplaceAction::FindAndReplace(
|
||||||
|
arguments.get(0).unwrap().as_string()?.to_string(),
|
||||||
|
arguments.get(1).unwrap().as_string()?.to_string(),
|
||||||
|
));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if let Some(possible_field) = args.nth(0) {
|
||||||
|
let possible_field = possible_field.as_column_path()?;
|
||||||
|
self.for_field(possible_field);
|
||||||
|
}
|
||||||
|
|
||||||
|
match &self.error {
|
||||||
|
Some(reason) => Err(ShellError::untagged_runtime_error(format!(
|
||||||
|
"{}: {}",
|
||||||
|
reason,
|
||||||
|
Str::usage()
|
||||||
|
))),
|
||||||
|
None => Ok(vec![]),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn filter(&mut self, input: Value) -> Result<Vec<ReturnValue>, ShellError> {
|
||||||
|
Ok(vec![ReturnSuccess::value(self.strutils(input)?)])
|
||||||
|
}
|
||||||
|
}
|
367
crates/nu_plugin_str/src/nu_plugin_str/tests.rs
Normal file
367
crates/nu_plugin_str/src/nu_plugin_str/tests.rs
Normal file
|
@ -0,0 +1,367 @@
|
||||||
|
mod integration {
|
||||||
|
use crate::strutils::{Action, ReplaceAction};
|
||||||
|
use crate::tests::{
|
||||||
|
expect_return_value_at, get_data, int, string, structured_sample_record,
|
||||||
|
unstructured_sample_record,
|
||||||
|
};
|
||||||
|
use crate::Str;
|
||||||
|
use nu_plugin::test_helpers::{column_path, plugin, table, CallStub};
|
||||||
|
use nu_protocol::UntaggedValue;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn picks_up_one_action_flag_only() {
|
||||||
|
plugin(&mut Str::new())
|
||||||
|
.args(
|
||||||
|
CallStub::new()
|
||||||
|
.with_long_flag("upcase")
|
||||||
|
.with_long_flag("downcase")
|
||||||
|
.create(),
|
||||||
|
)
|
||||||
|
.setup(|plugin, returned_values| {
|
||||||
|
let actual = format!("{}", returned_values.unwrap_err());
|
||||||
|
|
||||||
|
assert!(actual.contains("can only apply one"));
|
||||||
|
assert_eq!(plugin.error, Some("can only apply one".to_string()));
|
||||||
|
});
|
||||||
|
}
|
||||||
|
#[test]
|
||||||
|
fn picks_up_downcase_flag() {
|
||||||
|
plugin(&mut Str::new())
|
||||||
|
.args(CallStub::new().with_long_flag("downcase").create())
|
||||||
|
.setup(|plugin, _| plugin.expect_action(Action::Downcase));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn picks_up_upcase_flag() {
|
||||||
|
plugin(&mut Str::new())
|
||||||
|
.args(CallStub::new().with_long_flag("upcase").create())
|
||||||
|
.setup(|plugin, _| plugin.expect_action(Action::Upcase));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn picks_up_to_int_flag() {
|
||||||
|
plugin(&mut Str::new())
|
||||||
|
.args(CallStub::new().with_long_flag("to-int").create())
|
||||||
|
.setup(|plugin, _| plugin.expect_action(Action::ToInteger));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn picks_up_arguments_for_replace_flag() {
|
||||||
|
let argument = String::from("replace_text");
|
||||||
|
|
||||||
|
plugin(&mut Str::new())
|
||||||
|
.args(
|
||||||
|
CallStub::new()
|
||||||
|
.with_named_parameter("replace", string(&argument))
|
||||||
|
.create(),
|
||||||
|
)
|
||||||
|
.setup(|plugin, _| {
|
||||||
|
let strategy = ReplaceAction::Direct(argument);
|
||||||
|
plugin.expect_action(Action::Replace(strategy));
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn picks_up_arguments_for_find_replace() {
|
||||||
|
let search_argument = String::from("kittens");
|
||||||
|
let replace_argument = String::from("jotandrehuda");
|
||||||
|
|
||||||
|
plugin(&mut Str::new())
|
||||||
|
.args(
|
||||||
|
CallStub::new()
|
||||||
|
.with_named_parameter(
|
||||||
|
"find-replace",
|
||||||
|
table(&vec![string(&search_argument), string(&replace_argument)]),
|
||||||
|
)
|
||||||
|
.create(),
|
||||||
|
)
|
||||||
|
.setup(|plugin, _| {
|
||||||
|
let strategy = ReplaceAction::FindAndReplace(search_argument, replace_argument);
|
||||||
|
plugin.expect_action(Action::Replace(strategy))
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn picks_up_argument_for_field() {
|
||||||
|
plugin(&mut Str::new())
|
||||||
|
.args(
|
||||||
|
CallStub::new()
|
||||||
|
.with_parameter("package.description")
|
||||||
|
.create(),
|
||||||
|
)
|
||||||
|
.setup(|plugin, _| {
|
||||||
|
plugin.expect_field(column_path(&vec![string("package"), string("description")]))
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn substring_errors_if_start_index_is_greater_than_end_index() {
|
||||||
|
plugin(&mut Str::new())
|
||||||
|
.args(
|
||||||
|
CallStub::new()
|
||||||
|
.with_named_parameter("substring", string("3,1"))
|
||||||
|
.create(),
|
||||||
|
)
|
||||||
|
.setup(|plugin, returned_values| {
|
||||||
|
let actual = format!("{}", returned_values.unwrap_err());
|
||||||
|
|
||||||
|
assert!(actual.contains("End must be greater than or equal to Start"));
|
||||||
|
assert_eq!(
|
||||||
|
plugin.error,
|
||||||
|
Some("End must be greater than or equal to Start".to_string())
|
||||||
|
);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn upcases_the_input_using_the_field_passed_as_parameter() {
|
||||||
|
let run = plugin(&mut Str::new())
|
||||||
|
.args(
|
||||||
|
CallStub::new()
|
||||||
|
.with_long_flag("upcase")
|
||||||
|
.with_parameter("name")
|
||||||
|
.create(),
|
||||||
|
)
|
||||||
|
.input(structured_sample_record("name", "jotandrehuda"))
|
||||||
|
.setup(|_, _| {})
|
||||||
|
.test();
|
||||||
|
|
||||||
|
let actual = expect_return_value_at(run, 0);
|
||||||
|
|
||||||
|
assert_eq!(get_data(actual, "name"), string("JOTANDREHUDA"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn downcases_the_input_using_the_field_passed_as_parameter() {
|
||||||
|
let run = plugin(&mut Str::new())
|
||||||
|
.args(
|
||||||
|
CallStub::new()
|
||||||
|
.with_long_flag("downcase")
|
||||||
|
.with_parameter("name")
|
||||||
|
.create(),
|
||||||
|
)
|
||||||
|
.input(structured_sample_record("name", "JOTANDREHUDA"))
|
||||||
|
.setup(|_, _| {})
|
||||||
|
.test();
|
||||||
|
|
||||||
|
let actual = expect_return_value_at(run, 0);
|
||||||
|
|
||||||
|
assert_eq!(get_data(actual, "name"), string("jotandrehuda"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn converts_the_input_to_integer_using_the_field_passed_as_parameter() {
|
||||||
|
let run = plugin(&mut Str::new())
|
||||||
|
.args(
|
||||||
|
CallStub::new()
|
||||||
|
.with_long_flag("to-int")
|
||||||
|
.with_parameter("Nu_birthday")
|
||||||
|
.create(),
|
||||||
|
)
|
||||||
|
.input(structured_sample_record("Nu_birthday", "10"))
|
||||||
|
.setup(|_, _| {})
|
||||||
|
.test();
|
||||||
|
|
||||||
|
let actual = expect_return_value_at(run, 0);
|
||||||
|
|
||||||
|
assert_eq!(get_data(actual, "Nu_birthday"), int(10));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn replaces_the_input_using_the_field_passed_as_parameter() {
|
||||||
|
let run = plugin(&mut Str::new())
|
||||||
|
.args(
|
||||||
|
CallStub::new()
|
||||||
|
.with_parameter("rustconf")
|
||||||
|
.with_named_parameter("replace", string("22nd August 2019"))
|
||||||
|
.create(),
|
||||||
|
)
|
||||||
|
.input(structured_sample_record("rustconf", "1st January 1970"))
|
||||||
|
.setup(|_, _| {})
|
||||||
|
.test();
|
||||||
|
|
||||||
|
let actual = expect_return_value_at(run, 0);
|
||||||
|
|
||||||
|
assert_eq!(get_data(actual, "rustconf"), string("22nd August 2019"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn find_and_replaces_the_input_using_the_field_passed_as_parameter() {
|
||||||
|
let run = plugin(&mut Str::new())
|
||||||
|
.args(
|
||||||
|
CallStub::new()
|
||||||
|
.with_parameter("staff")
|
||||||
|
.with_named_parameter(
|
||||||
|
"find-replace",
|
||||||
|
table(&vec![string("kittens"), string("jotandrehuda")]),
|
||||||
|
)
|
||||||
|
.create(),
|
||||||
|
)
|
||||||
|
.input(structured_sample_record("staff", "wykittens"))
|
||||||
|
.setup(|_, _| {})
|
||||||
|
.test();
|
||||||
|
|
||||||
|
let actual = expect_return_value_at(run, 0);
|
||||||
|
|
||||||
|
assert_eq!(get_data(actual, "staff"), string("wyjotandrehuda"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn upcases_the_input() {
|
||||||
|
let run = plugin(&mut Str::new())
|
||||||
|
.args(CallStub::new().with_long_flag("upcase").create())
|
||||||
|
.input(unstructured_sample_record("joandrehuda"))
|
||||||
|
.setup(|_, _| {})
|
||||||
|
.test();
|
||||||
|
|
||||||
|
let actual = expect_return_value_at(run, 0);
|
||||||
|
assert_eq!(actual, string("JOANDREHUDA"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn downcases_the_input() {
|
||||||
|
let run = plugin(&mut Str::new())
|
||||||
|
.args(CallStub::new().with_long_flag("downcase").create())
|
||||||
|
.input(unstructured_sample_record("JOANDREHUDA"))
|
||||||
|
.setup(|_, _| {})
|
||||||
|
.test();
|
||||||
|
|
||||||
|
let actual = expect_return_value_at(run, 0);
|
||||||
|
assert_eq!(actual, string("joandrehuda"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn converts_the_input_to_integer() {
|
||||||
|
let run = plugin(&mut Str::new())
|
||||||
|
.args(CallStub::new().with_long_flag("to-int").create())
|
||||||
|
.input(unstructured_sample_record("10"))
|
||||||
|
.setup(|_, _| {})
|
||||||
|
.test();
|
||||||
|
|
||||||
|
let actual = expect_return_value_at(run, 0);
|
||||||
|
|
||||||
|
assert_eq!(actual, UntaggedValue::int(10).into_untagged_value());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn substrings_the_input() {
|
||||||
|
let run = plugin(&mut Str::new())
|
||||||
|
.args(
|
||||||
|
CallStub::new()
|
||||||
|
.with_named_parameter("substring", string("0,1"))
|
||||||
|
.create(),
|
||||||
|
)
|
||||||
|
.input(unstructured_sample_record("0123456789"))
|
||||||
|
.setup(|_, _| {})
|
||||||
|
.test();
|
||||||
|
|
||||||
|
let actual = expect_return_value_at(run, 0);
|
||||||
|
|
||||||
|
assert_eq!(actual, string("0"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn substrings_the_input_and_returns_the_string_if_end_index_exceeds_length() {
|
||||||
|
let run = plugin(&mut Str::new())
|
||||||
|
.args(
|
||||||
|
CallStub::new()
|
||||||
|
.with_named_parameter("substring", string("0,11"))
|
||||||
|
.create(),
|
||||||
|
)
|
||||||
|
.input(unstructured_sample_record("0123456789"))
|
||||||
|
.setup(|_, _| {})
|
||||||
|
.test();
|
||||||
|
|
||||||
|
let actual = expect_return_value_at(run, 0);
|
||||||
|
|
||||||
|
assert_eq!(actual, string("0123456789"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn substrings_the_input_and_returns_blank_if_start_index_exceeds_length() {
|
||||||
|
let run = plugin(&mut Str::new())
|
||||||
|
.args(
|
||||||
|
CallStub::new()
|
||||||
|
.with_named_parameter("substring", string("20,30"))
|
||||||
|
.create(),
|
||||||
|
)
|
||||||
|
.input(unstructured_sample_record("0123456789"))
|
||||||
|
.setup(|_, _| {})
|
||||||
|
.test();
|
||||||
|
|
||||||
|
let actual = expect_return_value_at(run, 0);
|
||||||
|
|
||||||
|
assert_eq!(actual, string(""));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn substrings_the_input_and_treats_start_index_as_zero_if_blank_start_index_given() {
|
||||||
|
let run = plugin(&mut Str::new())
|
||||||
|
.args(
|
||||||
|
CallStub::new()
|
||||||
|
.with_named_parameter("substring", string(",5"))
|
||||||
|
.create(),
|
||||||
|
)
|
||||||
|
.input(unstructured_sample_record("0123456789"))
|
||||||
|
.setup(|_, _| {})
|
||||||
|
.test();
|
||||||
|
|
||||||
|
let actual = expect_return_value_at(run, 0);
|
||||||
|
|
||||||
|
assert_eq!(actual, string("01234"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn substrings_the_input_and_treats_end_index_as_length_if_blank_end_index_given() {
|
||||||
|
let run = plugin(&mut Str::new())
|
||||||
|
.args(
|
||||||
|
CallStub::new()
|
||||||
|
.with_named_parameter("substring", string("2,"))
|
||||||
|
.create(),
|
||||||
|
)
|
||||||
|
.input(unstructured_sample_record("0123456789"))
|
||||||
|
.setup(|_, _| {})
|
||||||
|
.test();
|
||||||
|
|
||||||
|
let actual = expect_return_value_at(run, 0);
|
||||||
|
|
||||||
|
assert_eq!(actual, string("23456789"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn replaces_the_input() {
|
||||||
|
let run = plugin(&mut Str::new())
|
||||||
|
.args(
|
||||||
|
CallStub::new()
|
||||||
|
.with_named_parameter("replace", string("22nd August 2019"))
|
||||||
|
.create(),
|
||||||
|
)
|
||||||
|
.input(unstructured_sample_record("1st January 1970"))
|
||||||
|
.setup(|_, _| {})
|
||||||
|
.test();
|
||||||
|
|
||||||
|
let actual = expect_return_value_at(run, 0);
|
||||||
|
|
||||||
|
assert_eq!(actual, string("22nd August 2019"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn find_and_replaces_the_input() {
|
||||||
|
let run = plugin(&mut Str::new())
|
||||||
|
.args(
|
||||||
|
CallStub::new()
|
||||||
|
.with_named_parameter(
|
||||||
|
"find-replace",
|
||||||
|
table(&vec![string("kittens"), string("jotandrehuda")]),
|
||||||
|
)
|
||||||
|
.create(),
|
||||||
|
)
|
||||||
|
.input(unstructured_sample_record("wykittens"))
|
||||||
|
.setup(|_, _| {})
|
||||||
|
.test();
|
||||||
|
|
||||||
|
let actual = expect_return_value_at(run, 0);
|
||||||
|
|
||||||
|
assert_eq!(actual, string("wyjotandrehuda"));
|
||||||
|
}
|
||||||
|
}
|
262
crates/nu_plugin_str/src/strutils.rs
Normal file
262
crates/nu_plugin_str/src/strutils.rs
Normal file
|
@ -0,0 +1,262 @@
|
||||||
|
use nu_errors::ShellError;
|
||||||
|
use nu_protocol::{did_you_mean, ColumnPath, Primitive, ShellTypeName, UntaggedValue, Value};
|
||||||
|
use nu_source::{span_for_spanned_list, Tagged};
|
||||||
|
use nu_value_ext::ValueExt;
|
||||||
|
|
||||||
|
use regex::Regex;
|
||||||
|
use std::cmp;
|
||||||
|
|
||||||
|
#[derive(Debug, Eq, PartialEq)]
|
||||||
|
pub enum Action {
|
||||||
|
Downcase,
|
||||||
|
Upcase,
|
||||||
|
ToInteger,
|
||||||
|
Substring(usize, usize),
|
||||||
|
Replace(ReplaceAction),
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Eq, PartialEq)]
|
||||||
|
pub enum ReplaceAction {
|
||||||
|
Direct(String),
|
||||||
|
FindAndReplace(String, String),
|
||||||
|
}
|
||||||
|
|
||||||
|
pub struct Str {
|
||||||
|
pub field: Option<Tagged<ColumnPath>>,
|
||||||
|
pub error: Option<String>,
|
||||||
|
pub action: Option<Action>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Str {
|
||||||
|
pub fn new() -> Str {
|
||||||
|
Str {
|
||||||
|
field: None,
|
||||||
|
error: None,
|
||||||
|
action: None,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn apply(&self, input: &str) -> Result<UntaggedValue, ShellError> {
|
||||||
|
let applied = match self.action.as_ref() {
|
||||||
|
Some(Action::Downcase) => UntaggedValue::string(input.to_ascii_lowercase()),
|
||||||
|
Some(Action::Upcase) => UntaggedValue::string(input.to_ascii_uppercase()),
|
||||||
|
Some(Action::Substring(s, e)) => {
|
||||||
|
let end: usize = cmp::min(*e, input.len());
|
||||||
|
let start: usize = *s;
|
||||||
|
if start > input.len() - 1 {
|
||||||
|
UntaggedValue::string("")
|
||||||
|
} else {
|
||||||
|
UntaggedValue::string(
|
||||||
|
&input
|
||||||
|
.chars()
|
||||||
|
.skip(start)
|
||||||
|
.take(end - start)
|
||||||
|
.collect::<String>(),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Some(Action::Replace(mode)) => match mode {
|
||||||
|
ReplaceAction::Direct(replacement) => UntaggedValue::string(replacement.as_str()),
|
||||||
|
ReplaceAction::FindAndReplace(find, replacement) => {
|
||||||
|
let regex = Regex::new(find.as_str());
|
||||||
|
|
||||||
|
match regex {
|
||||||
|
Ok(re) => UntaggedValue::string(
|
||||||
|
re.replace(input, replacement.as_str()).to_owned(),
|
||||||
|
),
|
||||||
|
Err(_) => UntaggedValue::string(input),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
Some(Action::ToInteger) => match input.trim() {
|
||||||
|
other => match other.parse::<i64>() {
|
||||||
|
Ok(v) => UntaggedValue::int(v),
|
||||||
|
Err(_) => UntaggedValue::string(input),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
None => UntaggedValue::string(input),
|
||||||
|
};
|
||||||
|
|
||||||
|
Ok(applied)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn for_field(&mut self, column_path: Tagged<ColumnPath>) {
|
||||||
|
self.field = Some(column_path);
|
||||||
|
}
|
||||||
|
|
||||||
|
fn permit(&mut self) -> bool {
|
||||||
|
self.action.is_none()
|
||||||
|
}
|
||||||
|
|
||||||
|
fn log_error(&mut self, message: &str) {
|
||||||
|
self.error = Some(message.to_string());
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn for_to_int(&mut self) {
|
||||||
|
if self.permit() {
|
||||||
|
self.action = Some(Action::ToInteger);
|
||||||
|
} else {
|
||||||
|
self.log_error("can only apply one");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn for_downcase(&mut self) {
|
||||||
|
if self.permit() {
|
||||||
|
self.action = Some(Action::Downcase);
|
||||||
|
} else {
|
||||||
|
self.log_error("can only apply one");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn for_upcase(&mut self) {
|
||||||
|
if self.permit() {
|
||||||
|
self.action = Some(Action::Upcase);
|
||||||
|
} else {
|
||||||
|
self.log_error("can only apply one");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn for_substring(&mut self, s: String) {
|
||||||
|
let v: Vec<&str> = s.split(',').collect();
|
||||||
|
let start: usize = match v[0] {
|
||||||
|
"" => 0,
|
||||||
|
_ => v[0].trim().parse().unwrap(),
|
||||||
|
};
|
||||||
|
let end: usize = match v[1] {
|
||||||
|
"" => usize::max_value(),
|
||||||
|
_ => v[1].trim().parse().unwrap(),
|
||||||
|
};
|
||||||
|
if start > end {
|
||||||
|
self.log_error("End must be greater than or equal to Start");
|
||||||
|
} else if self.permit() {
|
||||||
|
self.action = Some(Action::Substring(start, end));
|
||||||
|
} else {
|
||||||
|
self.log_error("can only apply one");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn for_replace(&mut self, mode: ReplaceAction) {
|
||||||
|
if self.permit() {
|
||||||
|
self.action = Some(Action::Replace(mode));
|
||||||
|
} else {
|
||||||
|
self.log_error("can only apply one");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn usage() -> &'static str {
|
||||||
|
"Usage: str field [--downcase|--upcase|--to-int|--substring \"start,end\"|--replace|--find-replace [pattern replacement]]]"
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn strutils(&self, value: Value) -> Result<Value, ShellError> {
|
||||||
|
match &value.value {
|
||||||
|
UntaggedValue::Primitive(Primitive::String(ref s)) => {
|
||||||
|
Ok(self.apply(&s)?.into_value(value.tag()))
|
||||||
|
}
|
||||||
|
UntaggedValue::Primitive(Primitive::Line(ref s)) => {
|
||||||
|
Ok(self.apply(&s)?.into_value(value.tag()))
|
||||||
|
}
|
||||||
|
UntaggedValue::Row(_) => match self.field {
|
||||||
|
Some(ref f) => {
|
||||||
|
let fields = f.clone();
|
||||||
|
|
||||||
|
let replace_for =
|
||||||
|
value.get_data_by_column_path(
|
||||||
|
&f,
|
||||||
|
Box::new(move |(obj_source, column_path_tried, error)| {
|
||||||
|
match did_you_mean(&obj_source, &column_path_tried) {
|
||||||
|
Some(suggestions) => ShellError::labeled_error(
|
||||||
|
"Unknown column",
|
||||||
|
format!("did you mean '{}'?", suggestions[0].1),
|
||||||
|
span_for_spanned_list(fields.iter().map(|p| p.span)),
|
||||||
|
),
|
||||||
|
None => error,
|
||||||
|
}
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
|
||||||
|
let got = replace_for?;
|
||||||
|
let replacement = self.strutils(got.clone())?;
|
||||||
|
|
||||||
|
match value.replace_data_at_column_path(
|
||||||
|
&f,
|
||||||
|
replacement.value.clone().into_untagged_value(),
|
||||||
|
) {
|
||||||
|
Some(v) => Ok(v),
|
||||||
|
None => Err(ShellError::labeled_error(
|
||||||
|
"str could not find field to replace",
|
||||||
|
"column name",
|
||||||
|
value.tag(),
|
||||||
|
)),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
None => Err(ShellError::untagged_runtime_error(format!(
|
||||||
|
"{}: {}",
|
||||||
|
"str needs a column when applied to a value in a row",
|
||||||
|
Str::usage()
|
||||||
|
))),
|
||||||
|
},
|
||||||
|
_ => Err(ShellError::labeled_error(
|
||||||
|
"Unrecognized type in stream",
|
||||||
|
value.type_name(),
|
||||||
|
value.tag,
|
||||||
|
)),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
pub mod tests {
|
||||||
|
use super::{ReplaceAction, Str};
|
||||||
|
use crate::tests::{int, string};
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn downcases() {
|
||||||
|
let mut strutils = Str::new();
|
||||||
|
|
||||||
|
strutils.for_downcase();
|
||||||
|
|
||||||
|
assert_eq!(strutils.apply("ANDRES").unwrap(), string("andres").value);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn upcases() {
|
||||||
|
let mut strutils = Str::new();
|
||||||
|
|
||||||
|
strutils.for_upcase();
|
||||||
|
|
||||||
|
assert_eq!(strutils.apply("andres").unwrap(), string("ANDRES").value);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn converts_to_int() {
|
||||||
|
let mut strutils = Str::new();
|
||||||
|
|
||||||
|
strutils.for_to_int();
|
||||||
|
|
||||||
|
assert_eq!(strutils.apply("9999").unwrap(), int(9999 as i64).value);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn replaces() {
|
||||||
|
let mut strutils = Str::new();
|
||||||
|
|
||||||
|
strutils.for_replace(ReplaceAction::Direct("robalino".to_string()));
|
||||||
|
|
||||||
|
assert_eq!(strutils.apply("andres").unwrap(), string("robalino").value);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn find_and_replaces() {
|
||||||
|
let mut strutils = Str::new();
|
||||||
|
|
||||||
|
strutils.for_replace(ReplaceAction::FindAndReplace(
|
||||||
|
"kittens".to_string(),
|
||||||
|
"jotandrehuda".to_string(),
|
||||||
|
));
|
||||||
|
|
||||||
|
assert_eq!(
|
||||||
|
strutils.apply("wykittens").unwrap(),
|
||||||
|
string("wyjotandrehuda").value
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
|
@ -9,6 +9,7 @@ license = "MIT"
|
||||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
|
nu-plugin = { path = "../nu-plugin", version="0.7.0" }
|
||||||
nu-protocol = { path = "../nu-protocol", version = "0.7.0" }
|
nu-protocol = { path = "../nu-protocol", version = "0.7.0" }
|
||||||
nu-source = { path = "../nu-source", version = "0.7.0" }
|
nu-source = { path = "../nu-source", version = "0.7.0" }
|
||||||
nu-errors = { path = "../nu-errors", version = "0.7.0" }
|
nu-errors = { path = "../nu-errors", version = "0.7.0" }
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
use nu_errors::ShellError;
|
use nu_errors::ShellError;
|
||||||
|
use nu_plugin::{serve_plugin, Plugin};
|
||||||
use nu_protocol::{
|
use nu_protocol::{
|
||||||
serve_plugin, CallInfo, Plugin, Primitive, ReturnSuccess, ReturnValue, Signature,
|
CallInfo, Primitive, ReturnSuccess, ReturnValue, Signature, UntaggedValue, Value,
|
||||||
UntaggedValue, Value,
|
|
||||||
};
|
};
|
||||||
|
|
||||||
struct Sum {
|
struct Sum {
|
||||||
|
|
|
@ -9,6 +9,7 @@ license = "MIT"
|
||||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
|
nu-plugin = { path = "../nu-plugin", version="0.7.0" }
|
||||||
nu-protocol = { path = "../nu-protocol", version = "0.7.0" }
|
nu-protocol = { path = "../nu-protocol", version = "0.7.0" }
|
||||||
nu-source = { path = "../nu-source", version = "0.7.0" }
|
nu-source = { path = "../nu-source", version = "0.7.0" }
|
||||||
nu-errors = { path = "../nu-errors", version = "0.7.0" }
|
nu-errors = { path = "../nu-errors", version = "0.7.0" }
|
||||||
|
|
|
@ -6,9 +6,9 @@ use futures_util::StreamExt;
|
||||||
use heim::units::{frequency, information, thermodynamic_temperature, time};
|
use heim::units::{frequency, information, thermodynamic_temperature, time};
|
||||||
use heim::{disk, host, memory, net, sensors};
|
use heim::{disk, host, memory, net, sensors};
|
||||||
use nu_errors::ShellError;
|
use nu_errors::ShellError;
|
||||||
|
use nu_plugin::{serve_plugin, Plugin};
|
||||||
use nu_protocol::{
|
use nu_protocol::{
|
||||||
serve_plugin, CallInfo, Plugin, ReturnSuccess, ReturnValue, Signature, TaggedDictBuilder,
|
CallInfo, ReturnSuccess, ReturnValue, Signature, TaggedDictBuilder, UntaggedValue, Value,
|
||||||
UntaggedValue, Value,
|
|
||||||
};
|
};
|
||||||
use nu_source::Tag;
|
use nu_source::Tag;
|
||||||
|
|
||||||
|
|
|
@ -9,6 +9,7 @@ license = "MIT"
|
||||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
|
nu-plugin = { path = "../nu-plugin", version="0.7.0" }
|
||||||
nu-protocol = { path = "../nu-protocol", version = "0.7.0" }
|
nu-protocol = { path = "../nu-protocol", version = "0.7.0" }
|
||||||
nu-source = { path = "../nu-source", version = "0.7.0" }
|
nu-source = { path = "../nu-source", version = "0.7.0" }
|
||||||
nu-errors = { path = "../nu-errors", version = "0.7.0" }
|
nu-errors = { path = "../nu-errors", version = "0.7.0" }
|
||||||
|
|
|
@ -1,9 +1,8 @@
|
||||||
use crossterm::{cursor, terminal, RawScreen};
|
use crossterm::{cursor, terminal, RawScreen};
|
||||||
use crossterm::{InputEvent, KeyEvent};
|
use crossterm::{InputEvent, KeyEvent};
|
||||||
use nu_errors::ShellError;
|
use nu_errors::ShellError;
|
||||||
use nu_protocol::{
|
use nu_plugin::{serve_plugin, Plugin};
|
||||||
outln, serve_plugin, CallInfo, Plugin, Primitive, Signature, UntaggedValue, Value,
|
use nu_protocol::{outln, CallInfo, Primitive, Signature, UntaggedValue, Value};
|
||||||
};
|
|
||||||
use nu_source::AnchorLocation;
|
use nu_source::AnchorLocation;
|
||||||
|
|
||||||
use syntect::easy::HighlightLines;
|
use syntect::easy::HighlightLines;
|
||||||
|
|
|
@ -9,6 +9,7 @@ license = "MIT"
|
||||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
|
nu-plugin = { path = "../nu-plugin", version="0.7.0" }
|
||||||
nu-protocol = { path = "../nu-protocol", version = "0.7.0" }
|
nu-protocol = { path = "../nu-protocol", version = "0.7.0" }
|
||||||
nu-source = { path = "../nu-source", version = "0.7.0" }
|
nu-source = { path = "../nu-source", version = "0.7.0" }
|
||||||
nu-errors = { path = "../nu-errors", version = "0.7.0" }
|
nu-errors = { path = "../nu-errors", version = "0.7.0" }
|
||||||
|
|
|
@ -1,8 +1,7 @@
|
||||||
use derive_new::new;
|
use derive_new::new;
|
||||||
use nu_errors::ShellError;
|
use nu_errors::ShellError;
|
||||||
use nu_protocol::{
|
use nu_plugin::{serve_plugin, Plugin};
|
||||||
format_primitive, serve_plugin, CallInfo, Plugin, Signature, UntaggedValue, Value,
|
use nu_protocol::{format_primitive, CallInfo, Signature, UntaggedValue, Value};
|
||||||
};
|
|
||||||
use ptree::item::StringItem;
|
use ptree::item::StringItem;
|
||||||
use ptree::output::print_tree_with;
|
use ptree::output::print_tree_with;
|
||||||
use ptree::print_config::PrintConfig;
|
use ptree::print_config::PrintConfig;
|
||||||
|
|
|
@ -31,4 +31,5 @@ pub use nu_value_ext::ValueExt;
|
||||||
pub use num_traits::cast::ToPrimitive;
|
pub use num_traits::cast::ToPrimitive;
|
||||||
|
|
||||||
// TODO: Temporary redirect
|
// TODO: Temporary redirect
|
||||||
pub use nu_protocol::{did_you_mean, serve_plugin, Plugin, TaggedDictBuilder};
|
pub use nu_protocol::{did_you_mean, TaggedDictBuilder};
|
||||||
|
//pub use nu_plugin::{serve_plugin, Plugin};
|
||||||
|
|
|
@ -1,7 +1,8 @@
|
||||||
use nu_errors::ShellError;
|
use nu_errors::ShellError;
|
||||||
|
use nu_plugin::{serve_plugin, Plugin};
|
||||||
use nu_protocol::{
|
use nu_protocol::{
|
||||||
did_you_mean, serve_plugin, CallInfo, ColumnPath, Plugin, Primitive, ReturnSuccess,
|
did_you_mean, CallInfo, ColumnPath, Primitive, ReturnSuccess, ReturnValue, ShellTypeName,
|
||||||
ReturnValue, ShellTypeName, Signature, SyntaxShape, UntaggedValue, Value,
|
Signature, SyntaxShape, UntaggedValue, Value,
|
||||||
};
|
};
|
||||||
use nu_source::{span_for_spanned_list, HasSpan, SpannedItem, Tagged};
|
use nu_source::{span_for_spanned_list, HasSpan, SpannedItem, Tagged};
|
||||||
use nu_value_ext::ValueExt;
|
use nu_value_ext::ValueExt;
|
||||||
|
@ -218,11 +219,11 @@ mod tests {
|
||||||
|
|
||||||
use super::{Inc, SemVerAction};
|
use super::{Inc, SemVerAction};
|
||||||
use indexmap::IndexMap;
|
use indexmap::IndexMap;
|
||||||
|
use nu_plugin::Plugin;
|
||||||
use nu_protocol::{
|
use nu_protocol::{
|
||||||
CallInfo, EvaluatedArgs, PathMember, ReturnSuccess, UnspannedPathMember, UntaggedValue,
|
CallInfo, EvaluatedArgs, PathMember, ReturnSuccess, TaggedDictBuilder, UnspannedPathMember,
|
||||||
Value,
|
UntaggedValue, Value,
|
||||||
};
|
};
|
||||||
use nu_protocol::{Plugin, TaggedDictBuilder};
|
|
||||||
use nu_source::{Span, Tag};
|
use nu_source::{Span, Tag};
|
||||||
|
|
||||||
struct CallStub {
|
struct CallStub {
|
||||||
|
|
|
@ -7,9 +7,9 @@ use heim::units::{information, ratio, Ratio};
|
||||||
use std::usize;
|
use std::usize;
|
||||||
|
|
||||||
use nu_errors::ShellError;
|
use nu_errors::ShellError;
|
||||||
|
use nu_plugin::{serve_plugin, Plugin};
|
||||||
use nu_protocol::{
|
use nu_protocol::{
|
||||||
serve_plugin, CallInfo, Plugin, ReturnSuccess, ReturnValue, Signature, TaggedDictBuilder,
|
CallInfo, ReturnSuccess, ReturnValue, Signature, TaggedDictBuilder, UntaggedValue, Value,
|
||||||
UntaggedValue, Value,
|
|
||||||
};
|
};
|
||||||
use nu_source::Tag;
|
use nu_source::Tag;
|
||||||
|
|
||||||
|
|
|
@ -1,980 +1,5 @@
|
||||||
use nu_errors::ShellError;
|
use nu_plugin::serve_plugin;
|
||||||
use nu_protocol::{
|
use nu_plugin_str::Str;
|
||||||
did_you_mean, serve_plugin, CallInfo, ColumnPath, Plugin, Primitive, ReturnSuccess,
|
|
||||||
ReturnValue, ShellTypeName, Signature, SyntaxShape, UntaggedValue, Value,
|
|
||||||
};
|
|
||||||
use nu_source::{span_for_spanned_list, Tagged};
|
|
||||||
use nu_value_ext::ValueExt;
|
|
||||||
|
|
||||||
use regex::Regex;
|
|
||||||
use std::cmp;
|
|
||||||
|
|
||||||
#[derive(Debug, Eq, PartialEq)]
|
|
||||||
enum Action {
|
|
||||||
Downcase,
|
|
||||||
Upcase,
|
|
||||||
ToInteger,
|
|
||||||
Substring(usize, usize),
|
|
||||||
Replace(ReplaceAction),
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug, Eq, PartialEq)]
|
|
||||||
enum ReplaceAction {
|
|
||||||
Direct(String),
|
|
||||||
FindAndReplace(String, String),
|
|
||||||
}
|
|
||||||
|
|
||||||
struct Str {
|
|
||||||
field: Option<Tagged<ColumnPath>>,
|
|
||||||
error: Option<String>,
|
|
||||||
action: Option<Action>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Str {
|
|
||||||
fn new() -> Str {
|
|
||||||
Str {
|
|
||||||
field: None,
|
|
||||||
error: None,
|
|
||||||
action: None,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn apply(&self, input: &str) -> Result<UntaggedValue, ShellError> {
|
|
||||||
let applied = match self.action.as_ref() {
|
|
||||||
Some(Action::Downcase) => UntaggedValue::string(input.to_ascii_lowercase()),
|
|
||||||
Some(Action::Upcase) => UntaggedValue::string(input.to_ascii_uppercase()),
|
|
||||||
Some(Action::Substring(s, e)) => {
|
|
||||||
let end: usize = cmp::min(*e, input.len());
|
|
||||||
let start: usize = *s;
|
|
||||||
if start > input.len() - 1 {
|
|
||||||
UntaggedValue::string("")
|
|
||||||
} else {
|
|
||||||
UntaggedValue::string(
|
|
||||||
&input
|
|
||||||
.chars()
|
|
||||||
.skip(start)
|
|
||||||
.take(end - start)
|
|
||||||
.collect::<String>(),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Some(Action::Replace(mode)) => match mode {
|
|
||||||
ReplaceAction::Direct(replacement) => UntaggedValue::string(replacement.as_str()),
|
|
||||||
ReplaceAction::FindAndReplace(find, replacement) => {
|
|
||||||
let regex = Regex::new(find.as_str());
|
|
||||||
|
|
||||||
match regex {
|
|
||||||
Ok(re) => UntaggedValue::string(
|
|
||||||
re.replace(input, replacement.as_str()).to_owned(),
|
|
||||||
),
|
|
||||||
Err(_) => UntaggedValue::string(input),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
Some(Action::ToInteger) => match input.trim() {
|
|
||||||
other => match other.parse::<i64>() {
|
|
||||||
Ok(v) => UntaggedValue::int(v),
|
|
||||||
Err(_) => UntaggedValue::string(input),
|
|
||||||
},
|
|
||||||
},
|
|
||||||
None => UntaggedValue::string(input),
|
|
||||||
};
|
|
||||||
|
|
||||||
Ok(applied)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn for_field(&mut self, column_path: Tagged<ColumnPath>) {
|
|
||||||
self.field = Some(column_path);
|
|
||||||
}
|
|
||||||
|
|
||||||
fn permit(&mut self) -> bool {
|
|
||||||
self.action.is_none()
|
|
||||||
}
|
|
||||||
|
|
||||||
fn log_error(&mut self, message: &str) {
|
|
||||||
self.error = Some(message.to_string());
|
|
||||||
}
|
|
||||||
|
|
||||||
fn for_to_int(&mut self) {
|
|
||||||
if self.permit() {
|
|
||||||
self.action = Some(Action::ToInteger);
|
|
||||||
} else {
|
|
||||||
self.log_error("can only apply one");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn for_downcase(&mut self) {
|
|
||||||
if self.permit() {
|
|
||||||
self.action = Some(Action::Downcase);
|
|
||||||
} else {
|
|
||||||
self.log_error("can only apply one");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn for_upcase(&mut self) {
|
|
||||||
if self.permit() {
|
|
||||||
self.action = Some(Action::Upcase);
|
|
||||||
} else {
|
|
||||||
self.log_error("can only apply one");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn for_substring(&mut self, s: String) {
|
|
||||||
let v: Vec<&str> = s.split(',').collect();
|
|
||||||
let start: usize = match v[0] {
|
|
||||||
"" => 0,
|
|
||||||
_ => v[0].trim().parse().unwrap(),
|
|
||||||
};
|
|
||||||
let end: usize = match v[1] {
|
|
||||||
"" => usize::max_value(),
|
|
||||||
_ => v[1].trim().parse().unwrap(),
|
|
||||||
};
|
|
||||||
if start > end {
|
|
||||||
self.log_error("End must be greater than or equal to Start");
|
|
||||||
} else if self.permit() {
|
|
||||||
self.action = Some(Action::Substring(start, end));
|
|
||||||
} else {
|
|
||||||
self.log_error("can only apply one");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn for_replace(&mut self, mode: ReplaceAction) {
|
|
||||||
if self.permit() {
|
|
||||||
self.action = Some(Action::Replace(mode));
|
|
||||||
} else {
|
|
||||||
self.log_error("can only apply one");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn usage() -> &'static str {
|
|
||||||
"Usage: str field [--downcase|--upcase|--to-int|--substring \"start,end\"|--replace|--find-replace [pattern replacement]]]"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Str {
|
|
||||||
fn strutils(&self, value: Value) -> Result<Value, ShellError> {
|
|
||||||
match &value.value {
|
|
||||||
UntaggedValue::Primitive(Primitive::String(ref s)) => {
|
|
||||||
Ok(self.apply(&s)?.into_value(value.tag()))
|
|
||||||
}
|
|
||||||
UntaggedValue::Primitive(Primitive::Line(ref s)) => {
|
|
||||||
Ok(self.apply(&s)?.into_value(value.tag()))
|
|
||||||
}
|
|
||||||
UntaggedValue::Row(_) => match self.field {
|
|
||||||
Some(ref f) => {
|
|
||||||
let fields = f.clone();
|
|
||||||
|
|
||||||
let replace_for =
|
|
||||||
value.get_data_by_column_path(
|
|
||||||
&f,
|
|
||||||
Box::new(move |(obj_source, column_path_tried, error)| {
|
|
||||||
match did_you_mean(&obj_source, &column_path_tried) {
|
|
||||||
Some(suggestions) => ShellError::labeled_error(
|
|
||||||
"Unknown column",
|
|
||||||
format!("did you mean '{}'?", suggestions[0].1),
|
|
||||||
span_for_spanned_list(fields.iter().map(|p| p.span)),
|
|
||||||
),
|
|
||||||
None => error,
|
|
||||||
}
|
|
||||||
}),
|
|
||||||
);
|
|
||||||
|
|
||||||
let got = replace_for?;
|
|
||||||
let replacement = self.strutils(got.clone())?;
|
|
||||||
|
|
||||||
match value.replace_data_at_column_path(
|
|
||||||
&f,
|
|
||||||
replacement.value.clone().into_untagged_value(),
|
|
||||||
) {
|
|
||||||
Some(v) => Ok(v),
|
|
||||||
None => Err(ShellError::labeled_error(
|
|
||||||
"str could not find field to replace",
|
|
||||||
"column name",
|
|
||||||
value.tag(),
|
|
||||||
)),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
None => Err(ShellError::untagged_runtime_error(format!(
|
|
||||||
"{}: {}",
|
|
||||||
"str needs a column when applied to a value in a row",
|
|
||||||
Str::usage()
|
|
||||||
))),
|
|
||||||
},
|
|
||||||
_ => Err(ShellError::labeled_error(
|
|
||||||
"Unrecognized type in stream",
|
|
||||||
value.type_name(),
|
|
||||||
value.tag,
|
|
||||||
)),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Plugin for Str {
|
|
||||||
fn config(&mut self) -> Result<Signature, ShellError> {
|
|
||||||
Ok(Signature::build("str")
|
|
||||||
.desc("Apply string function. Optional use the column of a table")
|
|
||||||
.switch("downcase", "convert string to lowercase")
|
|
||||||
.switch("upcase", "convert string to uppercase")
|
|
||||||
.switch("to-int", "convert string to integer")
|
|
||||||
.named("replace", SyntaxShape::String, "replaces the string")
|
|
||||||
.named(
|
|
||||||
"find-replace",
|
|
||||||
SyntaxShape::Any,
|
|
||||||
"finds and replaces [pattern replacement]",
|
|
||||||
)
|
|
||||||
.named(
|
|
||||||
"substring",
|
|
||||||
SyntaxShape::String,
|
|
||||||
"convert string to portion of original, requires \"start,end\"",
|
|
||||||
)
|
|
||||||
.rest(SyntaxShape::ColumnPath, "the column(s) to convert")
|
|
||||||
.filter())
|
|
||||||
}
|
|
||||||
|
|
||||||
fn begin_filter(&mut self, call_info: CallInfo) -> Result<Vec<ReturnValue>, ShellError> {
|
|
||||||
let args = call_info.args;
|
|
||||||
|
|
||||||
if args.has("downcase") {
|
|
||||||
self.for_downcase();
|
|
||||||
}
|
|
||||||
if args.has("upcase") {
|
|
||||||
self.for_upcase();
|
|
||||||
}
|
|
||||||
if args.has("to-int") {
|
|
||||||
self.for_to_int();
|
|
||||||
}
|
|
||||||
if args.has("substring") {
|
|
||||||
if let Some(start_end) = args.get("substring") {
|
|
||||||
match start_end {
|
|
||||||
Value {
|
|
||||||
value: UntaggedValue::Primitive(Primitive::String(s)),
|
|
||||||
..
|
|
||||||
} => {
|
|
||||||
self.for_substring(s.to_string());
|
|
||||||
}
|
|
||||||
_ => {
|
|
||||||
return Err(ShellError::labeled_error(
|
|
||||||
"Unrecognized type in params",
|
|
||||||
start_end.type_name(),
|
|
||||||
&start_end.tag,
|
|
||||||
))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if args.has("replace") {
|
|
||||||
if let Some(Value {
|
|
||||||
value: UntaggedValue::Primitive(Primitive::String(replacement)),
|
|
||||||
..
|
|
||||||
}) = args.get("replace")
|
|
||||||
{
|
|
||||||
self.for_replace(ReplaceAction::Direct(replacement.clone()));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if args.has("find-replace") {
|
|
||||||
if let Some(Value {
|
|
||||||
value: UntaggedValue::Table(arguments),
|
|
||||||
..
|
|
||||||
}) = args.get("find-replace")
|
|
||||||
{
|
|
||||||
self.for_replace(ReplaceAction::FindAndReplace(
|
|
||||||
arguments.get(0).unwrap().as_string()?.to_string(),
|
|
||||||
arguments.get(1).unwrap().as_string()?.to_string(),
|
|
||||||
));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if let Some(possible_field) = args.nth(0) {
|
|
||||||
let possible_field = possible_field.as_column_path()?;
|
|
||||||
self.for_field(possible_field);
|
|
||||||
}
|
|
||||||
|
|
||||||
match &self.error {
|
|
||||||
Some(reason) => Err(ShellError::untagged_runtime_error(format!(
|
|
||||||
"{}: {}",
|
|
||||||
reason,
|
|
||||||
Str::usage()
|
|
||||||
))),
|
|
||||||
None => Ok(vec![]),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn filter(&mut self, input: Value) -> Result<Vec<ReturnValue>, ShellError> {
|
|
||||||
Ok(vec![ReturnSuccess::value(self.strutils(input)?)])
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn main() {
|
fn main() {
|
||||||
serve_plugin(&mut Str::new());
|
serve_plugin(&mut Str::new());
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(test)]
|
|
||||||
mod tests {
|
|
||||||
use super::{Action, ReplaceAction, Str};
|
|
||||||
use indexmap::IndexMap;
|
|
||||||
use nu_protocol::{
|
|
||||||
CallInfo, EvaluatedArgs, Plugin, Primitive, ReturnSuccess, TaggedDictBuilder,
|
|
||||||
UntaggedValue, Value,
|
|
||||||
};
|
|
||||||
use nu_source::Tag;
|
|
||||||
use nu_value_ext::ValueExt;
|
|
||||||
use num_bigint::BigInt;
|
|
||||||
|
|
||||||
fn string(input: impl Into<String>) -> Value {
|
|
||||||
UntaggedValue::string(input.into()).into_untagged_value()
|
|
||||||
}
|
|
||||||
|
|
||||||
fn table(list: &Vec<Value>) -> Value {
|
|
||||||
UntaggedValue::table(list).into_untagged_value()
|
|
||||||
}
|
|
||||||
|
|
||||||
fn column_path(paths: &Vec<Value>) -> Value {
|
|
||||||
UntaggedValue::Primitive(Primitive::ColumnPath(
|
|
||||||
table(&paths.iter().cloned().collect())
|
|
||||||
.as_column_path()
|
|
||||||
.unwrap()
|
|
||||||
.item,
|
|
||||||
))
|
|
||||||
.into_untagged_value()
|
|
||||||
}
|
|
||||||
struct CallStub {
|
|
||||||
positionals: Vec<Value>,
|
|
||||||
flags: IndexMap<String, Value>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl CallStub {
|
|
||||||
fn new() -> CallStub {
|
|
||||||
CallStub {
|
|
||||||
positionals: vec![],
|
|
||||||
flags: indexmap::IndexMap::new(),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn with_named_parameter(&mut self, name: &str, value: Value) -> &mut Self {
|
|
||||||
self.flags.insert(name.to_string(), value);
|
|
||||||
self
|
|
||||||
}
|
|
||||||
|
|
||||||
fn with_long_flag(&mut self, name: &str) -> &mut Self {
|
|
||||||
self.flags.insert(
|
|
||||||
name.to_string(),
|
|
||||||
UntaggedValue::boolean(true).into_value(Tag::unknown()),
|
|
||||||
);
|
|
||||||
self
|
|
||||||
}
|
|
||||||
|
|
||||||
fn with_parameter(&mut self, name: &str) -> &mut Self {
|
|
||||||
let fields: Vec<Value> = name
|
|
||||||
.split(".")
|
|
||||||
.map(|s| UntaggedValue::string(s.to_string()).into_value(Tag::unknown()))
|
|
||||||
.collect();
|
|
||||||
|
|
||||||
self.positionals.push(column_path(&fields));
|
|
||||||
self
|
|
||||||
}
|
|
||||||
|
|
||||||
fn create(&self) -> CallInfo {
|
|
||||||
CallInfo {
|
|
||||||
args: EvaluatedArgs::new(Some(self.positionals.clone()), Some(self.flags.clone())),
|
|
||||||
name_tag: Tag::unknown(),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn structured_sample_record(key: &str, value: &str) -> Value {
|
|
||||||
let mut record = TaggedDictBuilder::new(Tag::unknown());
|
|
||||||
record.insert_untagged(key.clone(), UntaggedValue::string(value));
|
|
||||||
record.into_value()
|
|
||||||
}
|
|
||||||
|
|
||||||
fn unstructured_sample_record(value: &str) -> Value {
|
|
||||||
UntaggedValue::string(value).into_value(Tag::unknown())
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_configuration_flags_wired() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
let configured = plugin.config().unwrap();
|
|
||||||
|
|
||||||
for action_flag in &[
|
|
||||||
"downcase",
|
|
||||||
"upcase",
|
|
||||||
"to-int",
|
|
||||||
"substring",
|
|
||||||
"replace",
|
|
||||||
"find-replace",
|
|
||||||
] {
|
|
||||||
assert!(configured.named.get(*action_flag).is_some());
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_accepts_downcase() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(CallStub::new().with_long_flag("downcase").create())
|
|
||||||
.is_ok());
|
|
||||||
assert_eq!(plugin.action.unwrap(), Action::Downcase);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_accepts_upcase() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(CallStub::new().with_long_flag("upcase").create())
|
|
||||||
.is_ok());
|
|
||||||
assert_eq!(plugin.action.unwrap(), Action::Upcase);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_accepts_to_int() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(CallStub::new().with_long_flag("to-int").create())
|
|
||||||
.is_ok());
|
|
||||||
assert_eq!(plugin.action.unwrap(), Action::ToInteger);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_accepts_replace() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
let argument = String::from("replace_text");
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(
|
|
||||||
CallStub::new()
|
|
||||||
.with_named_parameter("replace", string(&argument))
|
|
||||||
.create()
|
|
||||||
)
|
|
||||||
.is_ok());
|
|
||||||
|
|
||||||
match plugin.action {
|
|
||||||
Some(Action::Replace(ReplaceAction::Direct(replace_with))) => {
|
|
||||||
assert_eq!(replace_with, argument)
|
|
||||||
}
|
|
||||||
Some(_) | None => panic!("Din't accept."),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_accepts_find_replace() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
let search_argument = String::from("kittens");
|
|
||||||
let replace_argument = String::from("jotandrehuda");
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(
|
|
||||||
CallStub::new()
|
|
||||||
.with_named_parameter(
|
|
||||||
"find-replace",
|
|
||||||
table(&vec![string(&search_argument), string(&replace_argument)])
|
|
||||||
)
|
|
||||||
.create()
|
|
||||||
)
|
|
||||||
.is_ok());
|
|
||||||
|
|
||||||
match plugin.action {
|
|
||||||
Some(Action::Replace(ReplaceAction::FindAndReplace(find_with, replace_with))) => {
|
|
||||||
assert_eq!(find_with, search_argument);
|
|
||||||
assert_eq!(replace_with, replace_argument);
|
|
||||||
}
|
|
||||||
Some(_) | None => panic!("Din't accept."),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_accepts_field() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(
|
|
||||||
CallStub::new()
|
|
||||||
.with_parameter("package.description")
|
|
||||||
.create()
|
|
||||||
)
|
|
||||||
.is_ok());
|
|
||||||
|
|
||||||
let actual = &*plugin.field.unwrap();
|
|
||||||
let actual = UntaggedValue::Primitive(Primitive::ColumnPath(actual.clone()));
|
|
||||||
let actual = actual.into_value(Tag::unknown());
|
|
||||||
|
|
||||||
assert_eq!(
|
|
||||||
actual,
|
|
||||||
column_path(&vec![string("package"), string("description")])
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_accepts_only_one_action() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(
|
|
||||||
CallStub::new()
|
|
||||||
.with_long_flag("upcase")
|
|
||||||
.with_long_flag("downcase")
|
|
||||||
.with_long_flag("to-int")
|
|
||||||
.with_long_flag("substring")
|
|
||||||
.create(),
|
|
||||||
)
|
|
||||||
.is_err());
|
|
||||||
assert_eq!(plugin.error, Some("can only apply one".to_string()));
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_downcases() {
|
|
||||||
let mut strutils = Str::new();
|
|
||||||
strutils.for_downcase();
|
|
||||||
assert_eq!(
|
|
||||||
strutils.apply("ANDRES").unwrap(),
|
|
||||||
UntaggedValue::string("andres")
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_upcases() {
|
|
||||||
let mut strutils = Str::new();
|
|
||||||
strutils.for_upcase();
|
|
||||||
assert_eq!(
|
|
||||||
strutils.apply("andres").unwrap(),
|
|
||||||
UntaggedValue::string("ANDRES")
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_to_int() {
|
|
||||||
let mut strutils = Str::new();
|
|
||||||
strutils.for_to_int();
|
|
||||||
assert_eq!(
|
|
||||||
strutils.apply("9999").unwrap(),
|
|
||||||
UntaggedValue::int(9999 as i64)
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_replace() {
|
|
||||||
let mut strutils = Str::new();
|
|
||||||
strutils.for_replace(ReplaceAction::Direct("robalino".to_string()));
|
|
||||||
|
|
||||||
assert_eq!(
|
|
||||||
strutils.apply("andres").unwrap(),
|
|
||||||
UntaggedValue::string("robalino")
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_find_replace() {
|
|
||||||
let mut strutils = Str::new();
|
|
||||||
strutils.for_replace(ReplaceAction::FindAndReplace(
|
|
||||||
"kittens".to_string(),
|
|
||||||
"jotandrehuda".to_string(),
|
|
||||||
));
|
|
||||||
assert_eq!(
|
|
||||||
strutils.apply("wykittens").unwrap(),
|
|
||||||
UntaggedValue::string("wyjotandrehuda")
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_applies_upcase_with_field() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(
|
|
||||||
CallStub::new()
|
|
||||||
.with_long_flag("upcase")
|
|
||||||
.with_parameter("name")
|
|
||||||
.create()
|
|
||||||
)
|
|
||||||
.is_ok());
|
|
||||||
|
|
||||||
let subject = structured_sample_record("name", "jotandrehuda");
|
|
||||||
let output = plugin.filter(subject).unwrap();
|
|
||||||
|
|
||||||
match output[0].as_ref().unwrap() {
|
|
||||||
ReturnSuccess::Value(Value {
|
|
||||||
value: UntaggedValue::Row(o),
|
|
||||||
..
|
|
||||||
}) => assert_eq!(
|
|
||||||
*o.get_data(&String::from("name")).borrow(),
|
|
||||||
UntaggedValue::string(String::from("JOTANDREHUDA")).into_untagged_value()
|
|
||||||
),
|
|
||||||
_ => {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_applies_upcase_without_field() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(CallStub::new().with_long_flag("upcase").create())
|
|
||||||
.is_ok());
|
|
||||||
|
|
||||||
let subject = unstructured_sample_record("jotandrehuda");
|
|
||||||
let output = plugin.filter(subject).unwrap();
|
|
||||||
|
|
||||||
match output[0].as_ref().unwrap() {
|
|
||||||
ReturnSuccess::Value(Value {
|
|
||||||
value: UntaggedValue::Primitive(Primitive::String(s)),
|
|
||||||
..
|
|
||||||
}) => assert_eq!(*s, String::from("JOTANDREHUDA")),
|
|
||||||
_ => {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_applies_downcase_with_field() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(
|
|
||||||
CallStub::new()
|
|
||||||
.with_long_flag("downcase")
|
|
||||||
.with_parameter("name")
|
|
||||||
.create()
|
|
||||||
)
|
|
||||||
.is_ok());
|
|
||||||
|
|
||||||
let subject = structured_sample_record("name", "JOTANDREHUDA");
|
|
||||||
let output = plugin.filter(subject).unwrap();
|
|
||||||
|
|
||||||
match output[0].as_ref().unwrap() {
|
|
||||||
ReturnSuccess::Value(Value {
|
|
||||||
value: UntaggedValue::Row(o),
|
|
||||||
..
|
|
||||||
}) => assert_eq!(
|
|
||||||
*o.get_data(&String::from("name")).borrow(),
|
|
||||||
UntaggedValue::string(String::from("jotandrehuda")).into_untagged_value()
|
|
||||||
),
|
|
||||||
_ => {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_applies_downcase_without_field() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(CallStub::new().with_long_flag("downcase").create())
|
|
||||||
.is_ok());
|
|
||||||
|
|
||||||
let subject = unstructured_sample_record("JOTANDREHUDA");
|
|
||||||
let output = plugin.filter(subject).unwrap();
|
|
||||||
|
|
||||||
match output[0].as_ref().unwrap() {
|
|
||||||
ReturnSuccess::Value(Value {
|
|
||||||
value: UntaggedValue::Primitive(Primitive::String(s)),
|
|
||||||
..
|
|
||||||
}) => assert_eq!(*s, String::from("jotandrehuda")),
|
|
||||||
_ => {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_applies_to_int_with_field() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(
|
|
||||||
CallStub::new()
|
|
||||||
.with_long_flag("to-int")
|
|
||||||
.with_parameter("Nu_birthday")
|
|
||||||
.create()
|
|
||||||
)
|
|
||||||
.is_ok());
|
|
||||||
|
|
||||||
let subject = structured_sample_record("Nu_birthday", "10");
|
|
||||||
let output = plugin.filter(subject).unwrap();
|
|
||||||
|
|
||||||
match output[0].as_ref().unwrap() {
|
|
||||||
ReturnSuccess::Value(Value {
|
|
||||||
value: UntaggedValue::Row(o),
|
|
||||||
..
|
|
||||||
}) => assert_eq!(
|
|
||||||
*o.get_data(&String::from("Nu_birthday")).borrow(),
|
|
||||||
UntaggedValue::int(10).into_untagged_value()
|
|
||||||
),
|
|
||||||
_ => {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_applies_to_int_without_field() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(CallStub::new().with_long_flag("to-int").create())
|
|
||||||
.is_ok());
|
|
||||||
|
|
||||||
let subject = unstructured_sample_record("10");
|
|
||||||
let output = plugin.filter(subject).unwrap();
|
|
||||||
|
|
||||||
match output[0].as_ref().unwrap() {
|
|
||||||
ReturnSuccess::Value(Value {
|
|
||||||
value: UntaggedValue::Primitive(Primitive::Int(i)),
|
|
||||||
..
|
|
||||||
}) => assert_eq!(*i, BigInt::from(10)),
|
|
||||||
_ => {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_applies_substring_without_field() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(
|
|
||||||
CallStub::new()
|
|
||||||
.with_named_parameter("substring", string("0,1"))
|
|
||||||
.create()
|
|
||||||
)
|
|
||||||
.is_ok());
|
|
||||||
|
|
||||||
let subject = unstructured_sample_record("0123456789");
|
|
||||||
let output = plugin.filter(subject).unwrap();
|
|
||||||
|
|
||||||
match output[0].as_ref().unwrap() {
|
|
||||||
ReturnSuccess::Value(Value {
|
|
||||||
value: UntaggedValue::Primitive(Primitive::String(s)),
|
|
||||||
..
|
|
||||||
}) => assert_eq!(*s, String::from("0")),
|
|
||||||
_ => {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_applies_substring_exceeding_string_length() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(
|
|
||||||
CallStub::new()
|
|
||||||
.with_named_parameter("substring", string("0,11"))
|
|
||||||
.create()
|
|
||||||
)
|
|
||||||
.is_ok());
|
|
||||||
|
|
||||||
let subject = unstructured_sample_record("0123456789");
|
|
||||||
let output = plugin.filter(subject).unwrap();
|
|
||||||
|
|
||||||
match output[0].as_ref().unwrap() {
|
|
||||||
ReturnSuccess::Value(Value {
|
|
||||||
value: UntaggedValue::Primitive(Primitive::String(s)),
|
|
||||||
..
|
|
||||||
}) => assert_eq!(*s, String::from("0123456789")),
|
|
||||||
_ => {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_applies_substring_returns_blank_if_start_exceeds_length() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(
|
|
||||||
CallStub::new()
|
|
||||||
.with_named_parameter("substring", string("20,30"))
|
|
||||||
.create()
|
|
||||||
)
|
|
||||||
.is_ok());
|
|
||||||
|
|
||||||
let subject = unstructured_sample_record("0123456789");
|
|
||||||
let output = plugin.filter(subject).unwrap();
|
|
||||||
|
|
||||||
match output[0].as_ref().unwrap() {
|
|
||||||
ReturnSuccess::Value(Value {
|
|
||||||
value: UntaggedValue::Primitive(Primitive::String(s)),
|
|
||||||
..
|
|
||||||
}) => assert_eq!(*s, String::from("")),
|
|
||||||
_ => {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_applies_substring_treats_blank_start_as_zero() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(
|
|
||||||
CallStub::new()
|
|
||||||
.with_named_parameter("substring", string(",5"))
|
|
||||||
.create()
|
|
||||||
)
|
|
||||||
.is_ok());
|
|
||||||
|
|
||||||
let subject = unstructured_sample_record("0123456789");
|
|
||||||
let output = plugin.filter(subject).unwrap();
|
|
||||||
|
|
||||||
match output[0].as_ref().unwrap() {
|
|
||||||
ReturnSuccess::Value(Value {
|
|
||||||
value: UntaggedValue::Primitive(Primitive::String(s)),
|
|
||||||
..
|
|
||||||
}) => assert_eq!(*s, String::from("01234")),
|
|
||||||
_ => {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_applies_substring_treats_blank_end_as_length() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(
|
|
||||||
CallStub::new()
|
|
||||||
.with_named_parameter("substring", string("2,"))
|
|
||||||
.create()
|
|
||||||
)
|
|
||||||
.is_ok());
|
|
||||||
|
|
||||||
let subject = unstructured_sample_record("0123456789");
|
|
||||||
let output = plugin.filter(subject).unwrap();
|
|
||||||
|
|
||||||
match output[0].as_ref().unwrap() {
|
|
||||||
ReturnSuccess::Value(Value {
|
|
||||||
value: UntaggedValue::Primitive(Primitive::String(s)),
|
|
||||||
..
|
|
||||||
}) => assert_eq!(*s, String::from("23456789")),
|
|
||||||
_ => {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_applies_substring_returns_error_if_start_exceeds_end() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(
|
|
||||||
CallStub::new()
|
|
||||||
.with_named_parameter("substring", string("3,1"))
|
|
||||||
.create()
|
|
||||||
)
|
|
||||||
.is_err());
|
|
||||||
assert_eq!(
|
|
||||||
plugin.error,
|
|
||||||
Some("End must be greater than or equal to Start".to_string())
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_applies_replace_with_field() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(
|
|
||||||
CallStub::new()
|
|
||||||
.with_parameter("rustconf")
|
|
||||||
.with_named_parameter("replace", string("22nd August 2019"))
|
|
||||||
.create()
|
|
||||||
)
|
|
||||||
.is_ok());
|
|
||||||
|
|
||||||
let subject = structured_sample_record("rustconf", "1st January 1970");
|
|
||||||
let output = plugin.filter(subject).unwrap();
|
|
||||||
|
|
||||||
match output[0].as_ref().unwrap() {
|
|
||||||
ReturnSuccess::Value(Value {
|
|
||||||
value: UntaggedValue::Row(o),
|
|
||||||
..
|
|
||||||
}) => assert_eq!(
|
|
||||||
*o.get_data(&String::from("rustconf")).borrow(),
|
|
||||||
Value {
|
|
||||||
value: UntaggedValue::string(String::from("22nd August 2019")),
|
|
||||||
tag: Tag::unknown()
|
|
||||||
}
|
|
||||||
),
|
|
||||||
_ => {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_applies_replace_without_field() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(
|
|
||||||
CallStub::new()
|
|
||||||
.with_named_parameter("replace", string("22nd August 2019"))
|
|
||||||
.create()
|
|
||||||
)
|
|
||||||
.is_ok());
|
|
||||||
|
|
||||||
let subject = unstructured_sample_record("1st January 1970");
|
|
||||||
let output = plugin.filter(subject).unwrap();
|
|
||||||
|
|
||||||
match output[0].as_ref().unwrap() {
|
|
||||||
ReturnSuccess::Value(Value {
|
|
||||||
value: UntaggedValue::Primitive(Primitive::String(s)),
|
|
||||||
..
|
|
||||||
}) => assert_eq!(*s, String::from("22nd August 2019")),
|
|
||||||
_ => {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_applies_find_replace_with_field() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(
|
|
||||||
CallStub::new()
|
|
||||||
.with_parameter("staff")
|
|
||||||
.with_named_parameter(
|
|
||||||
"find-replace",
|
|
||||||
table(&vec![string("kittens"), string("jotandrehuda")])
|
|
||||||
)
|
|
||||||
.create()
|
|
||||||
)
|
|
||||||
.is_ok());
|
|
||||||
|
|
||||||
let subject = structured_sample_record("staff", "wykittens");
|
|
||||||
let output = plugin.filter(subject).unwrap();
|
|
||||||
|
|
||||||
match output[0].as_ref().unwrap() {
|
|
||||||
ReturnSuccess::Value(Value {
|
|
||||||
value: UntaggedValue::Row(o),
|
|
||||||
..
|
|
||||||
}) => assert_eq!(
|
|
||||||
*o.get_data(&String::from("staff")).borrow(),
|
|
||||||
Value {
|
|
||||||
value: UntaggedValue::string(String::from("wyjotandrehuda")),
|
|
||||||
tag: Tag::unknown()
|
|
||||||
}
|
|
||||||
),
|
|
||||||
_ => {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn str_plugin_applies_find_replace_without_field() {
|
|
||||||
let mut plugin = Str::new();
|
|
||||||
|
|
||||||
assert!(plugin
|
|
||||||
.begin_filter(
|
|
||||||
CallStub::new()
|
|
||||||
.with_named_parameter(
|
|
||||||
"find-replace",
|
|
||||||
table(&vec![string("kittens"), string("jotandrehuda")])
|
|
||||||
)
|
|
||||||
.create()
|
|
||||||
)
|
|
||||||
.is_ok());
|
|
||||||
|
|
||||||
let subject = unstructured_sample_record("wykittens");
|
|
||||||
let output = plugin.filter(subject).unwrap();
|
|
||||||
|
|
||||||
match output[0].as_ref().unwrap() {
|
|
||||||
ReturnSuccess::Value(Value {
|
|
||||||
value: UntaggedValue::Primitive(Primitive::String(s)),
|
|
||||||
..
|
|
||||||
}) => assert_eq!(*s, String::from("wyjotandrehuda")),
|
|
||||||
_ => {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
|
@ -6,9 +6,9 @@ use futures_util::StreamExt;
|
||||||
use heim::units::{frequency, information, thermodynamic_temperature, time};
|
use heim::units::{frequency, information, thermodynamic_temperature, time};
|
||||||
use heim::{disk, host, memory, net, sensors};
|
use heim::{disk, host, memory, net, sensors};
|
||||||
use nu_errors::ShellError;
|
use nu_errors::ShellError;
|
||||||
|
use nu_plugin::{serve_plugin, Plugin};
|
||||||
use nu_protocol::{
|
use nu_protocol::{
|
||||||
serve_plugin, CallInfo, Plugin, ReturnSuccess, ReturnValue, Signature, TaggedDictBuilder,
|
CallInfo, ReturnSuccess, ReturnValue, Signature, TaggedDictBuilder, UntaggedValue, Value,
|
||||||
UntaggedValue, Value,
|
|
||||||
};
|
};
|
||||||
use nu_source::Tag;
|
use nu_source::Tag;
|
||||||
|
|
||||||
|
|
|
@ -1,9 +1,8 @@
|
||||||
use crossterm::{cursor, terminal, RawScreen};
|
use crossterm::{cursor, terminal, RawScreen};
|
||||||
use crossterm::{InputEvent, KeyEvent};
|
use crossterm::{InputEvent, KeyEvent};
|
||||||
use nu_errors::ShellError;
|
use nu_errors::ShellError;
|
||||||
use nu_protocol::{
|
use nu_plugin::{serve_plugin, Plugin};
|
||||||
outln, serve_plugin, CallInfo, Plugin, Primitive, Signature, UntaggedValue, Value,
|
use nu_protocol::{outln, CallInfo, Primitive, Signature, UntaggedValue, Value};
|
||||||
};
|
|
||||||
use nu_source::AnchorLocation;
|
use nu_source::AnchorLocation;
|
||||||
|
|
||||||
use syntect::easy::HighlightLines;
|
use syntect::easy::HighlightLines;
|
||||||
|
|
Loading…
Reference in a new issue