update: create notes from templates

Author: Rooyca

README.md

@@ -95,14 +95,15 @@ There are also more complex options available. You can set any configuration pro
 
 * `QUICKNOTE_FORMAT` changes the way that quicknotes are generated. The string formatted using the `date` command.
 * `NOTES_EXT` changes the default extension that notes are saved with.
+* `TEMPLATES_DIR` changes the directory in which templates are stored.
 * `NOTES_DIRECTORY` changes the directory in which notes are stored.
 * `EDITOR` can also be overriden here, for `notes` only.
 * `POST_COMMAND` sets the command to run after any modification command (e.g. `open`, `mv`, ...) succeeds
 
 
 ## How do I use it?
 
-### `notes new [-t] <template-name> <note-name>`
+### `notes new [-t <template-name>] <note-name>`
 
 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. Leave out the name if you want one to be generated for you (e.g. `quicknote-2016-12-21.md` - format configurable with `$QUICKNOTE_FORMAT`). If you want to place a quicknote in a subfolder, use a trailing slash: `notes new subfolder/`. Shorthand alias also available with `notes n`.
 

_notes

@@ -17,7 +17,7 @@ __notes_cmd ()
 {
   local -a list
   list=(
-    new:'Create new file, if -t is given, use template'
+    new:'Create new file'
     ls:'<pattern> List notes by path'
     find:'[pattern] Search notes by filename and path'
     grep:'<pattern> Search notes by content'

config

@@ -14,5 +14,8 @@
 # Define the directory where notes are stored
 # NOTES_DIRECTORY=~/notes
 
+# Define the directory where templates are stored
+# TEMPLATES_DIR=.templates
+
 # Define command to run after modification command
 # POST_COMMAND="/path/to/custom_script.sh"

notes

@@ -1,11 +1,12 @@
 #!/usr/bin/env bash
 
 # Version
-notes_version="1.3.0"
+notes_version="1.2.0"
 
 # Default Date string before config
 QUICKNOTE_FORMAT="quicknote-%Y-%m-%d"
 NOTES_EXT="md"
+TEMPLATES_DIR=".templates"
 # Look for configuration file at ~/.config/notes/config and use it
 if [ -f ~/.config/notes/config ]; then
     . ~/.config/notes/config
@@ -21,12 +22,6 @@ if ! $(mkdir -p "$notes_dir"); then
     exit 1
 fi
 
-# Make 'template' directory if it doesn't exist
-if ! $(mkdir -p "$notes_dir/templates"); then
-    echo "Could not create directory $notes_dir/templates, please update your \$NOTES_DIRECTORY" >&2
-    exit 1
-fi
-
 # If no $EDITOR, look for `editor` (symlink on debian/ubuntu/etc)
 if [ -z "$EDITOR" ] && type editor &>/dev/null; then
     EDITOR=editor
@@ -123,22 +118,47 @@ generate_name() {
 }
 
 new_note() {
+    local template_used=false
+    local note_name=""
+
     if [[ "$1" == "-t" ]]; then
+        template_used=true
         shift
-        note_from_template "$@"
-        return
     fi
 
-    local note_name="$*"
-    if [[ $note_name == "" ]]; then
-         note_name="$(generate_name)"
+    if [[ "$#" -eq 0 ]]; then
+        note_name="$(generate_name).$NOTES_EXT"
+    elif [[ "$#" -eq 1 ]]; then
+        note_name="$1"
+    else
+        note_name="$2.$NOTES_EXT"
     fi
 
     if echo "$note_name" | grep "/$" &> /dev/null; then
         note_name="${note_name}/$(generate_name)"
     fi
 
-    mkdir -p "$(dirname "$notes_dir/$note_name")"
+    local note_dir="$(dirname "$notes_dir/$note_name")"
+    mkdir -p "$note_dir"
+
+    if "$template_used"; then
+        local template_folder="$notes_dir/$TEMPLATES_DIR"
+
+        if [[ ! -d "$template_folder" ]]; then
+            printf "Template folder not found: $template_folder\n"
+            exit 1
+        fi
+
+        local template_name="$1"
+
+        if [[ ! "$template_name" == *.$NOTES_EXT ]]; then
+            template_name="$template_name.$NOTES_EXT"
+        fi
+
+        local template_path="$template_folder/$template_name"
+        local note_path="$notes_dir/$note_name"
+        cp "$template_path" "$note_path"
+    fi
 
     open_note "$note_name"
 }
@@ -290,48 +310,13 @@ cat_note() {
     cat "$note_path"
 }
 
-note_from_template() {
-    local tn=$1
-
-    if [[ ! "$tn" == *.$NOTES_EXT ]]; then
-        tn="$1.$NOTES_EXT"
-    fi
-
-    local template="$notes_dir/templates/$tn"
-    local note_name="$2"
-
-    if [[ ! "$note_name" == *.$NOTES_EXT ]]; then
-        note_name="$note_name.$NOTES_EXT"
-    fi
-
-    local note_path="$notes_dir/$note_name"
-
-    if [[ ! -f "$template" ]]; then
-        printf "Template not found: $template\n"
-        exit 1
-    fi
-
-    if [[ -z "$note_name" ]]; then
-        printf "New note requires a name, but none was provided.\n"
-        exit 1
-    fi
-
-    if [[ -e "$note_path" ]]; then
-        printf "Note already exists: $note_path\n"
-        exit 1
-    fi
-
-    cp "$template" "$note_path"
-    open_note "$note_name"
-}
-
 usage() {
   local name=$(basename $0)
 	cat <<EOF
 $name is a command line note taking tool.
 
 Usage:
-    $name new|n [-t] <template> <name>    # Create a new note, if -t is given, use template
+    $name new|n [-t <template>] <name>    # Create a new note, if -t is given, use template
     $name ls <pattern>                    # List notes by path
     $name find|f [pattern]                # Search notes by filename and path
     $name grep|g <pattern>                # Search notes by content

test/test-ls.bats

@@ -12,12 +12,12 @@ teardown() {
 
 notes="./notes"
 
-@test "Should display the templates folder when no notes are present" {
+@test "Should output nothing and return non-zero if there are no notes to list" {
   run $notes ls
 
-  assert_success
+  assert_failure
   echo $output
-  assert_equal $(echo $output | wc -w) 1
+  assert_equal $(echo $output | wc -w) 0
 }
 
 @test "Should list all notes in notes directory if no pattern is provided to find" {

test/test-new.bats

@@ -88,16 +88,33 @@ notes="./notes"
 }
 
 @test "Should create a new template note" {
-  run $notes new templates/basic
+  run $notes new .templates/basic
 
   assert_success
-  assert_exists "$NOTES_DIRECTORY/templates/basic.md"
+  assert_exists "$NOTES_DIRECTORY/.templates/basic.md"
 }
 
 @test "Should create a new note with the given template" {
-  run $notes new templates/basic
+  run $notes new .templates/basic
   run $notes new -t basic note_with_template
 
   assert_success
   assert_exists "$NOTES_DIRECTORY/note_with_template.md"
-}
+}
+
+@test "Should create new note from template within subfolders" {
+  run $notes new .templates/basic
+  run $notes new -t basic subfolder/note_with_template
+
+  assert_success
+  assert_exists "$NOTES_DIRECTORY/subfolder/note_with_template.md"
+}
+
+@test "Check that the template is used" {
+  run $notes append .templates/basic "This is a basic template"
+  run $notes new -t basic note_with_template
+  run $notes cat note_with_template
+
+  assert_success
+  assert_output "This is a basic template"
+}