Merge remote-tracking branch 'upstream/master'

Signed-off-by: primis <nick@primis.org>

Author: primis

README.md

@@ -27,7 +27,7 @@ Download `notes`, `chmod +x`, put it in your `$path`. This will probably do it:
 curl https://cdn.rawgit.com/pimterry/notes/v0.2.0/notes > /usr/local/bin/notes && chmod +x /usr/local/bin/notes
 ```
 
-By default your notes live in ~/notes, but you can change that to anywhere you like by setting the `$NOTES_DIRECTORY` environmental variable.
+By default your notes live in ~/notes, but you can change that to anywhere you like by setting the `$NOTES_DIRECTORY` environmental variable. See [how do I configure this?](#how-do-i-configure-this) for more details.
 
 #### Installing Bash completion
 
@@ -47,12 +47,9 @@ You'll need to open a new shell for this to take effect.
 
 ## How do I configure this?
 
-You can set your favourite text editor and your notes directory by setting the `$EDITOR` and `$NOTES_DIRECTORY` environmental variables.
+To get started with you'll want to set `$EDITOR` to your favourite text editor, and probably `$NOTES_DIRECTORY` to the directory in which you'd like to use to store your notes (this defaults to `~/notes`). You'll typically want to set these as environment variables in your `.bashrc`, `.zshrc`, or similar.
 
-
-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.
+There are also more complex options available. You can set any configuration properties either in the environment, or in a config file (stored in `~/.config/notes/config`), with settings in config overriding those in your environment. This allows you to configure a different `$EDITOR` for notes to everything else, if you like. The config file is a good choice for more complex set ups, but probably not worth worrying about to start with. We've included an example config in this repo for you ([config.example](config.example)) that you can copy if you like. 
 
 ### What are the configuration options?
 
@@ -66,10 +63,7 @@ Right now this mainly exists in case you want to use a different `EDITOR` for no
 
 ### `notes new <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. 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.
+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`). Shorthand alias also available with `notes n`.
 
 ### `notes find <part-of-a-note-name>`
 
@@ -79,6 +73,10 @@ Searches note filenames and paths for the given string, and returns every single
 
 Searches all note content for the given string and returns all the matches. Shorthand alias also available with `notes g`.
 
+### `notes search <part-of-a-note-name-or-note-content>`
+
+Searches all note content and note filenames for the given string and returns all the matches. Shorthand alias also available with `notes s`.
+
 ### `notes ls <directory>`
 
 Lists note names and note directories at a single level. Lists all top level notes and directories if no path is provided, or the top-level contents of a directory if one is provided.
@@ -103,7 +101,6 @@ Combine these together! This opens each matching note in your `$EDITOR` in turn.
 
 All the above works. Here's what's coming next:
 
-- [ ] Combining find and grep, to match either one (https://github.com/pimterry/notes/issues/16)
 - [ ] More interesting and nicer looking file/grep search result formatting, perhaps only when not piping? (https://github.com/pimterry/notes/issues/27)
 - [ ] Make the file extension optional (https://github.com/pimterry/notes/issues/24)
 - [ ] zsh command and note name autocompletion (https://github.com/pimterry/notes/issues/25)

notes

@@ -4,7 +4,7 @@
 QUICKNOTE_FORMAT="quicknote-%Y-%m-%d"
 NOTES_EXT="md"
 # Look for configuration file at ~/.config/notes/config and use it
-if [ -f ~/.config/notes/config ]; then 
+if [ -f ~/.config/notes/config ]; then
     . ~/.config/notes/config
 fi
 
@@ -41,6 +41,28 @@ ls_notes() {
     fi
 }
 
+search_filenames_and_contents() {
+    if [ "$#" -gt 0 ]; then
+        find_output=$(find "$notes_dir" -type f -exec bash -c \
+            "shopt -s nocasematch
+            grep -il \"$*\" \"{}\" || if [[ \"{}\" =~ \"$*\" ]]; then
+                echo \"{}\";
+            fi" \;\
+        )
+    else
+        find_output=$(find "$notes_dir" -type f)
+    fi
+    find_result=$?
+    formatted_output=$(printf "$find_output" | without_notes_dir)
+
+    if [[ $find_result == 0 && "$formatted_output" ]]; then
+        printf "$formatted_output\n"
+        return 0
+    else
+        return 2
+    fi
+}
+
 find_notes() {
     local find_output=$(find "$notes_dir" -ipath "$notes_dir/*$**" -type f 2>&1)
     local find_result=$?
@@ -71,30 +93,31 @@ 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
+    local resolved_name=$format_string
     while [[ -e "$notes_dir/$resolved_name.$NOTES_EXT" ]]
     do
         append_num=$[$append_num+1]
         resolved_name=$format_string.$append_num
     done
+    printf $resolved_name
 }
 
 new_note() {
     local note_name="$*"
     if [[ $note_name == "" ]]; then
-         generate_name 
-         note_name=$resolved_name
+         note_name="$(generate_name)"
     fi
     mkdir -p "$(dirname "$notes_dir/$note_name")"
     open_note "$note_name.$NOTES_EXT"
 }
 
 remove_note() {
-    local rm_arga=()
+    local rm_args=()
     if [[ "$1" == "-r" || "$1" == "--recursive" ]]; then
         rm_args+=("--recursive")
         shift
@@ -148,6 +171,7 @@ Usage:
     notes ls <pattern>                    # List notes by path
     notes find|f [pattern]                # Search notes by filename and path
     notes grep|g <pattern>                # Search notes by content
+    notes search|s [pattern]              # Search notes by filename or 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
@@ -178,6 +202,9 @@ main() {
         "ls" )
             cmd="ls_notes"
             ;;
+        "search"|"s" )
+            cmd="search_filenames_and_contents"
+            ;;
         "find"|"f" )
             cmd="find_notes"
             ;;

test/test-config.bats

@@ -7,13 +7,14 @@ 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

test/test-search.bats

@@ -0,0 +1,115 @@
+#!./libs/bats/bin/bats
+
+load 'libs/bats-support/load'
+load 'libs/bats-assert/load'
+load 'helpers'
+
+setup() {
+  setupNotesEnv
+}
+
+teardown() {
+  teardownNotesEnv
+}
+
+notes="./notes"
+
+@test "Should output nothing and return non-zero if there are no notes to search" {
+  run $notes search
+
+  assert_failure
+  echo $output
+  assert_equal $(echo $output | wc -w) 0
+}
+
+@test "Should show all notes found if no pattern is provided to search" {
+  touch $NOTES_DIRECTORY/note1.md
+  touch $NOTES_DIRECTORY/note2.md
+
+  run $notes search
+  assert_success
+  assert_line "note1.md"
+  assert_line "note2.md"
+}
+
+@test "Should search notes when using the search shorthand alias" {
+  touch $NOTES_DIRECTORY/note.md
+
+  run $notes s
+  assert_success
+  assert_line "note.md"
+}
+
+@test "Should show matching notes only if a pattern is provided to search" {
+  touch $NOTES_DIRECTORY/match-note1.md
+  touch $NOTES_DIRECTORY/hide-note2.md
+
+  run $notes search "match"
+
+  assert_success
+  assert_line "match-note1.md"
+  refute_line "hide-note2.md"
+}
+
+@test "Should match notes case insensitively with search" {
+  touch $NOTES_DIRECTORY/MATCH-note1.md
+  touch $NOTES_DIRECTORY/hide-note2.md
+
+  run $notes search "match"
+
+  assert_success
+  assert_line "MATCH-note1.md"
+  refute_line "hide-note2.md"
+}
+
+@test "Should match subdirectory or file names with search" {
+  touch "$NOTES_DIRECTORY/hide-note.md"
+  mkdir "$NOTES_DIRECTORY/match-directory"
+  touch "$NOTES_DIRECTORY/match-directory/note.md"
+
+  run $notes search "match"
+
+  assert_success
+  assert_output "match-directory/note.md"
+}
+
+# These are the 'grep' tests.
+
+@test "Should match only the files containing the given pattern when searching" {
+  echo "my-pattern" > $NOTES_DIRECTORY/matching-note.md
+  echo "some-other-pattern" > $NOTES_DIRECTORY/non-matching-note.md
+
+  run $notes search my-pattern
+
+  assert_success
+  assert_line "matching-note.md"
+  refute_line "non-matching-note.md"
+}
+
+@test "Should search notes when using the search shorthand alias" {
+  echo "my-pattern" > $NOTES_DIRECTORY/matching-note.md
+
+  run $notes s my-pattern
+
+  assert_success
+  assert_line "matching-note.md"
+}
+
+@test "Should search case-insensitively" {
+  echo "LETTERS" > $NOTES_DIRECTORY/matching-note.md
+
+  run $notes search letter
+
+  assert_success
+  assert_line "matching-note.md"
+}
+
+@test "Should search files with paths including spaces" {
+  mkdir "$NOTES_DIRECTORY/path with spaces"
+  echo 'match' > "$NOTES_DIRECTORY/path with spaces/note file.md"
+
+  run $notes search match
+
+  assert_success
+  assert_output "path with spaces/note file.md"
+}