Merge pull request #32 from primis/master

Added quicknotes

Author: pimterry

README.md

@@ -49,6 +49,8 @@ You'll need to open a new shell for this to take effect.
 
 You can set your favourite text editor and your notes directory by setting the `$EDITOR` and `$NOTES_DIRECTORY` environmental variables.
 
+You can also set `$QUICKNOTE_FORMAT` to change the way that quicknotes are generated. The string is formatted using the `date` command. 
+
 Most users shouldn't need to do any more than that. If you're doing anything more complicated though, you can configure `notes` config directly in "~/.config/notes/config", including EDITOR and NOTES_DIRECTORY. We've included an example in this repo for you ([config.example](config.example)) that you can copy. Any values set in the config file override values in environment variables.
 
 Right now this mainly exists in case you want to use a different `EDITOR` for notes than the one you have set in your environment generally, but this is where all other config will be living in future.
@@ -59,6 +61,9 @@ Right now this mainly exists in case you want to use a different `EDITOR` for no
 
 Opens your `$EDITOR` of choice for a new note, with the given name. The name can include slashes, if you want to put your note in a subfolder. Shorthand alias also available with `notes n`.
 
+### `notes new`
+Creates a quicknote with the name of the format `quicknote-YYYY-MM-DD.md`. This can be changed in the configuration file.
+
 ### `notes find <part-of-a-note-name>`
 
 Searches note filenames and paths for the given string, and returns every single match. If no pattern is specified, this returns every single note. Shorthand alias also available with `notes f`.

config.example

@@ -4,3 +4,6 @@
 
 # Set the editor that notes are opened with
 EDITOR=nano
+
+# Change the quicknote format to get rid of the word "quicknote"
+QUICKNOTE_FORMAT="%Y-%m-%d"

notes

@@ -1,5 +1,8 @@
 #!/usr/bin/env bash
 
+# Default Date string before config
+QUICKNOTE_FORMAT="quicknote-%Y-%m-%d"
+
 # Look for configuration file at ~/.config/notes/config and use it
 if [ -f ~/.config/notes/config ]; then
     . ~/.config/notes/config
@@ -90,15 +93,30 @@ grep_notes() {
         return 2
     fi
 }
+generate_name() {
+    local append_num=0
+    local format_string="`date +$QUICKNOTE_FORMAT`"
+    # Initial test has no append
+    resolved_name=$format_string
+    while [[ -e "$notes_dir/$resolved_name.md" ]]
+    do
+        append_num=$[$append_num+1]
+        resolved_name=$format_string.$append_num
+    done
+}
 
 new_note() {
     local note_name="$*"
+    if [[ $note_name == "" ]]; then
+         generate_name 
+         note_name=$resolved_name
+    fi
     mkdir -p "$(dirname "$notes_dir/$note_name")"
     open_note "$note_name.md"
 }
 
 remove_note() {
-    local rm_args=()
+    local rm_arga=()
     if [[ "$1" == "-r" || "$1" == "--recursive" ]]; then
         rm_args+=("--recursive")
         shift

test/test-config.bats

@@ -7,13 +7,23 @@ load 'helpers'
 setup() {
   setupNotesEnv
 }
-
 teardown() {
   teardownNotesEnv
 }
-
+export EDITOR=touch
 notes="./notes"
 
+
+@test "Configuration should override QUICKNOTE_FORMAT" {
+  mkdir -p $HOME/.config/notes
+  echo "QUICKNOTE_FORMAT=test" > $HOME/.config/notes/config
+  
+  run $notes new
+  
+  assert_success
+  assert_exists "$NOTES_DIRECTORY/test.md"
+}
+
 @test "Configuration should override EDITOR" {
   mkdir -p $HOME/.config/notes
   echo "EDITOR=echo" > $HOME/.config/notes/config

test/test-new.bats

@@ -22,6 +22,23 @@ notes="./notes"
   assert_exists "$NOTES_DIRECTORY/note.md"
 }
 
+@test "Should create quicknote without a name given" {
+  today=`date "+%Y-%m-%d"`
+  run $notes new
+
+  assert_success
+  assert_exists "$NOTES_DIRECTORY/quicknote-$today.md"
+}
+
+@test "Should append to name if quicknote already exists" {
+  today=`date "+%Y-%m-%d"`
+  run $notes new
+  run $notes new
+
+  assert_success
+  assert_exists "$NOTES_DIRECTORY/quicknote-$today.1.md"
+}
+
 @test "Should create new notes when using the shorthand alias" {
   run $notes n note