Merge pull request #11 from ecksun/rm

Add support for removing notes

Author: pimterry

README.md

@@ -51,6 +51,10 @@ Opens your notes folder in your default configured file explorer. Shorthand alia
 
 Opens a given note in your `$EDITOR`. Name can be an absolute path, or a relative path in your notes (.md suffix optional). Shorthand alias also available with `notes o`.
 
+### `notes rm [-r | --recursive] <note-name>`
+
+Remove the given note if it exists. If `-r` or `--recursive` is given, delete the folders/notes recursively.
+
 ### `notes grep/find <pattern> | notes open`
 
 Combine these together! This opens each matching note in your `$EDITOR` in turn.

notes

@@ -50,6 +50,22 @@ new_note() {
     open_note "$note_name.md"
 }
 
+remove_note() {
+    local rm_args=()
+    if [[ "$1" == "-r" || "$1" == "--recursive" ]]; then
+        rm_args+=("--recursive")
+        shift
+    fi
+
+    local note_name="$*"
+    local to_remove="$notes_dir/$note_name"
+
+    if [ -f "$notes_dir/$note_name.md" ]; then
+        to_remove="$notes_dir/$note_name.md"
+    fi
+    rm "${rm_args[@]}" "$to_remove"
+}
+
 open_something() {
     if [[ -p /dev/stdin ]]; then
         read -d'\n' note_names
@@ -90,6 +106,7 @@ Usage:
     notes grep|g <pattern>                # Search notes by content
     notes open|o                          # Open your notes directory
     notes open|o <name>                   # Open a note for editing by full name
+    notes rm [-r | --recursive] <name>    # Remove note, or folder if -r or --recursive is given
     echo <name> | notes open|o            # Open all note filenames piped in
     notes --help                          # Print this usage information
 
@@ -123,6 +140,9 @@ main() {
         "open"|"o" )
             cmd="open_something"
             ;;
+        "rm" )
+            cmd="remove_note"
+            ;;
         --help | -help | -h )
             cmd="usage"
             ;;

test/helpers.bash

@@ -1,5 +1,9 @@
 assert_exists() {
-  assert [ -f "$1" ]
+  assert [ -e "$1" ]
+}
+
+refute_exists() {
+  assert [ ! -e "$1" ]
 }
 
 setupNotesEnv() {
@@ -12,4 +16,4 @@ teardownNotesEnv() {
   else
     echo "** Did not delete $NOTES_DIRECTORY, as test failed **"
   fi
-}
+}

test/test-rm.bats

@@ -0,0 +1,76 @@
+#!./libs/bats/bin/bats
+
+load 'libs/bats-support/load'
+load 'libs/bats-assert/load'
+load 'helpers'
+
+setup() {
+  setupNotesEnv
+}
+
+teardown() {
+  teardownNotesEnv
+}
+
+notes="./notes"
+
+@test "Should remove created note" {
+  touch "$NOTES_DIRECTORY/note.md"
+  run $notes rm note
+
+  assert_success
+  refute_exists "$NOTES_DIRECTORY/note.md"
+}
+
+@test "Should fail to delete non-existent note" {
+  run $notes rm note
+
+  assert_failure
+}
+
+@test "Should remove note in folder" {
+  mkdir "$NOTES_DIRECTORY/folder"
+  touch "$NOTES_DIRECTORY/folder/note.md"
+  run $notes rm folder/note
+
+  assert_success
+  refute_exists "$NOTES_DIRECTORY/folder/note.md"
+}
+
+@test "Should fail to remove folder" {
+  mkdir "$NOTES_DIRECTORY/folder"
+  run $notes rm folder
+
+  assert_failure
+  assert_exists "$NOTES_DIRECTORY/folder"
+}
+
+@test "-r Should remove folder recursively" {
+  mkdir "$NOTES_DIRECTORY/folder"
+  touch "$NOTES_DIRECTORY/folder/note.md"
+  run $notes rm -r folder
+
+  assert_success
+  refute_exists "$NOTES_DIRECTORY/folder"
+  refute_exists "$NOTES_DIRECTORY/folder/notes.md"
+}
+
+@test "--recursive Should remove folder recursively" {
+  mkdir "$NOTES_DIRECTORY/folder"
+  touch "$NOTES_DIRECTORY/folder/note.md"
+  run $notes rm --recursive folder
+
+  assert_success
+  refute_exists "$NOTES_DIRECTORY/folder"
+  refute_exists "$NOTES_DIRECTORY/folder/notes.md"
+}
+
+@test "should delete file if both folder and file exists" {
+  mkdir "$NOTES_DIRECTORY/folder"
+  touch "$NOTES_DIRECTORY/folder.md"
+  run $notes rm --recursive folder
+
+  assert_success
+  assert_exists "$NOTES_DIRECTORY/folder"
+  refute_exists "$NOTES_DIRECTORY/folder.md"
+}