Merge pull request #191 from androbtech/rm-command-addition

Can remove files and directories.

README.md

@@ -124,6 +124,7 @@ Nu adheres closely to a set of goals that make up its design philosophy. As feat
 | ps | View current processes |
 | sysinfo | View information about the current system |
 | open {filename or url} | Load a file into a cell, convert to table if possible (avoid by appending '--raw') |
+| rm   {file or directory} | Remove a file, (for removing directory append '--recursive') |
 | exit | Exit the shell |
 
 ## Filters on tables (structured data)

src/cli.rs

@@ -175,7 +175,7 @@ pub async fn cli() -> Result<(), Box<dyn Error>> {
             command("to-toml", Box::new(to_toml::to_toml)),
             command("to-yaml", Box::new(to_yaml::to_yaml)),
             command("sort-by", Box::new(sort_by::sort_by)),
-            command("sort-by", Box::new(sort_by::sort_by)),
+            Arc::new(Remove),
             Arc::new(Open),
             Arc::new(Where),
             Arc::new(Config),

src/commands.rs

@@ -4,6 +4,7 @@ crate mod macros;
 crate mod args;
 crate mod autoview;
 crate mod cd;
+crate mod rm;
 crate mod classified;
 crate mod clip;
 crate mod command;
@@ -41,6 +42,7 @@ crate mod where_;
 
 crate use command::command;
 crate use config::Config;
+crate use rm::Remove;
 crate use open::Open;
 crate use skip_while::SkipWhile;
 crate use where_::Where;

src/commands/rm.rs

@@ -0,0 +1,63 @@
+use crate::errors::ShellError;
+use crate::prelude::*;
+use crate::parser::registry::{CommandConfig, NamedType, PositionalType};
+use crate::parser::hir::SyntaxType;
+use indexmap::IndexMap;
+
+pub struct Remove;
+
+impl Command for Remove {
+    fn run(&self, args: CommandArgs) -> Result<OutputStream, ShellError> {
+        rm(args)
+    }
+
+    fn name(&self) -> &str {
+        "rm"
+    }
+
+    fn config(&self) -> CommandConfig {
+        let mut named: IndexMap<String, NamedType> = IndexMap::new();
+        named.insert("recursive".to_string(), NamedType::Switch);
+
+        CommandConfig {
+            name: self.name().to_string(),
+            positional: vec![PositionalType::mandatory("file", SyntaxType::Path)],
+            rest_positional: false,
+            named,
+            is_sink: true,
+            is_filter: false,
+        }
+    }
+}
+
+pub fn rm(args: CommandArgs) -> Result<OutputStream, ShellError> {
+    let mut full_path = args.env
+                            .lock()
+                            .unwrap()
+                            .path()
+                            .to_path_buf();
+
+
+     match args.nth(0)
+               .ok_or_else(|| ShellError::string(&format!("No file or directory specified")))?
+               .as_string()?
+               .as_str() {
+                   "." | ".." => return Err(ShellError::string("\".\" and \"..\" may not be removed")),
+                   file       => full_path.push(file),
+    }
+
+
+    if full_path.is_dir() {
+        if !args.has("recursive") {
+            return Err(ShellError::labeled_error(
+                    "is a directory",
+                    "",
+                    args.name_span.unwrap()));
+        }
+        std::fs::remove_dir_all(&full_path).expect("can not remove directory");
+    } else if full_path.is_file() {
+        std::fs::remove_file(&full_path).expect("can not remove file");
+    }
+
+    Ok(OutputStream::empty())
+}

tests/commands_test.rs

@@ -1,6 +1,7 @@
 mod helpers;
 
-use helpers::in_directory as cwd;
+use helpers as h;
+use h::in_directory as cwd;
 
 #[test]
 fn lines() {
@@ -56,3 +57,69 @@ fn open_error_if_file_not_found() {
     assert!(output.contains("File cound not be opened"));
 }
 
+
+#[test]
+fn rm() {
+    let directory = "tests/fixtures/nuplayground";
+    let file = format!("{}/rm_test.txt", directory);
+
+    h::create_file_at(&file);
+
+    nu!(_output,
+        cwd(directory),
+        "rm rm_test.txt");
+
+    assert!(!h::file_exists_at(&file));
+}
+
+#[test]
+fn can_remove_directory_contents_with_recursive_flag() {
+    let path = "tests/fixtures/nuplayground/rm_test";
+
+    if h::file_exists_at(&path) { h::delete_directory_at(path) }
+    h::create_directory_at(path);
+
+    for f in ["yehuda.txt", "jonathan.txt", "andres.txt"].iter() {
+        h::create_file_at(&format!("{}/{}", path, f));
+    };
+
+    nu!(_output,
+        cwd("tests/fixtures/nuplayground"),
+        "rm rm_test --recursive");
+
+    assert!(!h::file_exists_at(&path));
+}
+
+#[test]
+fn rm_error_if_attempting_to_delete_a_directory_without_recursive_flag() {
+    let path = "tests/fixtures/nuplayground/rm_test";
+
+    if h::file_exists_at(&path) { h::delete_directory_at(path) }
+    h::create_directory_at(path);
+
+    nu_error!(output,
+        cwd("tests/fixtures/nuplayground"),
+        "rm rm_test");
+
+    assert!(h::file_exists_at(&path));
+    assert!(output.contains("is a directory"));
+    h::delete_directory_at(path);
+}
+
+#[test]
+fn rm_error_if_attempting_to_delete_single_dot_as_argument() {
+    nu_error!(output,
+        cwd("tests/fixtures/nuplayground"),
+        "rm .");
+
+    assert!(output.contains("may not be removed"));
+}
+
+#[test]
+fn rm_error_if_attempting_to_delete_two_dot_as_argument() {
+    nu_error!(output,
+        cwd("tests/fixtures/nuplayground"),
+        "rm ..");
+
+    assert!(output.contains("may not be removed"));
+}

tests/fixtures/formats/skinfolds.unsupported

@@ -1 +0,0 @@
-"ABS:3.0-PEC:3.0"

tests/fixtures/nuplayground/.gitignore

@@ -0,0 +1,2 @@
+rm_test
+*.txt

tests/helpers/mod.rs

@@ -1,11 +1,13 @@
-use std::path::PathBuf;
+#![allow(dead_code)]
+
+pub use std::path::PathBuf;
 
 #[macro_export]
 macro_rules! nu {
     ($out:ident, $cwd:expr, $commands:expr) => {
-        use std::error::Error;
-        use std::io::prelude::*;
-        use std::process::{Command, Stdio};
+        pub use std::io::prelude::*;
+        pub use std::process::{Command, Stdio};
+        pub use std::error::Error;
 
         let commands = &*format!(
             "
@@ -75,6 +77,22 @@ macro_rules! nu_error {
     };
 }
 
+pub fn create_file_at(full_path: &str) {
+    std::fs::write(PathBuf::from(full_path), "fake data".as_bytes()).expect("can not create file");
+}
+
+pub fn file_exists_at(full_path: &str) -> bool {
+    PathBuf::from(full_path).exists()
+}
+
+pub fn delete_directory_at(full_path: &str) {
+    std::fs::remove_dir_all(PathBuf::from(full_path)).expect("can not remove directory");
+}
+
+pub fn create_directory_at(full_path: &str) {
+    std::fs::create_dir(PathBuf::from(full_path)).expect("can not create directory");
+}
+
 pub fn executable_path() -> PathBuf {
     let mut buf = PathBuf::new();
     buf.push("target");