na 1.2.59 → 1.2.60

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 271fbdd631a1b52f0f642ceb291de5b1827282b568d0b510d4cf3ab745660327
-  data.tar.gz: 730d5d92191a55c352282429f16215a0a2aab0087bb7072278034d44340ac0ac
+  metadata.gz: c10e15eae9292e8245903b543c8adbb990be7fe7f166ee7d8636e557b4324aa5
+  data.tar.gz: e625f1a56c6aa903ba273909b0dad8e230313ab119276d44f76a58da51c8561d
 SHA512:
-  metadata.gz: 9b67d5f684b95260f3df6b991b9ad86004ab0a55a088f71aaf7028ac41671538109315dbc8e96188cc4ab3efd37472d1da1d3bf2c1f51cd2af3757bf687f5463
-  data.tar.gz: 8c3af84aac1bcc1355dcc0eb116146c28cbb2da00d6d636516a58d533bb71aff02960034fcdad9773989e746a01d7e64e0865bf20f3896092ecb4edf7a1475df
+  metadata.gz: e84356c63836c19be6d87c3acb213c3741d8476b9c9ce4f03df6ce5024b21cdb6e0ba01dcdeca8bda0a8fbeea6a8fbd4bf42db6a44c77b574162f94e2e1bb868
+  data.tar.gz: 93f0d4512a6fed663e7717e2ba3a64358dd8f3d931aa39ae0a44744ba0c479c6b0b3a24fd312bf7c754f24b3be07adf46d85342065e18fc012a52728069a6bf9

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+### 1.2.60
+
+2023-10-03 12:31
+
+#### NEW
+
+- Added `--search_notes` to allow searching of notes when using `find` or `tagged --search`. Defaults to true, can be disabled with `--no-search_notes`
+
+#### IMPROVED
+
+- Added `--search_notes` to completed, restore, edit, and update
+- Add `--search_notes` to `tag`
+- Add `--search_notes` to `complete`
+- Add `--search_notes` to `next`
+
 ### 1.2.59
 
 2023-10-03 07:43

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    na (1.2.59)
+    na (1.2.60)
       chronic (~> 0.10, >= 0.10.2)
       gli (~> 2.21.0)
       mdless (~> 1.0, >= 1.0.32)

data/README.md

@@ -9,7 +9,7 @@
 _If you're one of the rare people like me who find this useful, feel free to
 [buy me some coffee][donate]._
 
-The current version of `na` is 1.2.59
+The current version of `na` is 1.2.60
 .
 
 `na` ("next action") is a command line tool designed to make it easy to see what your next actions are for any project, right from the command line. It works with TaskPaper-formatted files (but any plain text format will do), looking for `@na` tags (or whatever you specify) in todo files in your current folder. 
@@ -77,7 +77,7 @@ SYNOPSIS
     na [global options] command [command options] [arguments...]
 
 VERSION
-    1.2.59
+    1.2.60
 
 GLOBAL OPTIONS
     -a, --add               - Add a next action (deprecated, for backwards compatibility)
@@ -190,6 +190,7 @@ COMMAND OPTIONS
     -e, --regex            - Interpret search pattern as regular expression
     --file=PATH            - Specify the file to search for the task (default: none)
     --in, --todo=TODO_FILE - Use a known todo file, partial matches allowed (default: none)
+    --[no-]search_notes    - Include notes in search (default: enabled)
     --tagged=TAG           - Match actions containing tag. Allows value comparisons (may be used more than once, default: none)
     -x, --exact            - Match pattern exactly
 
@@ -227,6 +228,7 @@ COMMAND OPTIONS
     --omnifocus                            - Output actions nested by file and project
     --proj, --project=PROJECT[/SUBPROJECT] - Show actions from a specific project (default: none)
     --save=TITLE                           - Save this search for future use (default: none)
+    --[no-]search_notes                    - Include notes in search (default: enabled)
     --tagged=TAG                           - Match actions containing tag. Allows value comparisons (may be used more than once, default: none)
     -v, --invert                           - Show actions not matching search pattern
     -x, --exact                            - Match pattern exactly
@@ -288,7 +290,8 @@ COMMAND OPTIONS
     -d, --depth=DEPTH                      - Recurse to depth (default: none)
     --[no-]done                            - Include @done actions
     --exact                                - Search query is exact text match (not tokens)
-    --in, --todo=TODO_FILE                 - Display matches from a known todo file (may be used more than once, default: none)
+    --file=TODO_FILE                       - Display matches from specific todo file ([relative] path) (default: none)
+    --in, --todo=TODO                      - Display matches from a known todo file anywhere in history (short name) (may be used more than once, default: none)
     --nest                                 - Output actions nested by file
     --[no-]notes                           - Include notes in output
     --omnifocus                            - Output actions nested by file and project
@@ -296,6 +299,7 @@ COMMAND OPTIONS
     --regex                                - Search query is regular expression
     --save=TITLE                           - Save this search for future use (default: none)
     --search, --find, --grep=QUERY         - Filter results using search terms (may be used more than once, default: none)
+    --[no-]search_notes                    - Include notes in search (default: enabled)
     -t, --tag=TAG                          - Alternate tag to search for (default: none)
     --tagged=TAG                           - Match actions containing tag. Allows value comparisons (may be used more than once, default: none)
 
@@ -402,7 +406,8 @@ COMMAND OPTIONS
     -d, --depth=DEPTH                      - Recurse to depth (default: none)
     --[no-]done                            - Include @done actions
     --exact                                - Search query is exact text match (not tokens)
-    --in, --todo=TODO_FILE                 - Display matches from a known todo file (may be used more than once, default: none)
+    --file=TODO_FILE                       - Display matches from specific todo file ([relative] path) (default: none)
+    --in, --todo=TODO                      - Display matches from a known todo file anywhere in history (short name) (may be used more than once, default: none)
     --nest                                 - Output actions nested by file
     --[no-]notes                           - Include notes in output
     --omnifocus                            - Output actions nested by file and project
@@ -410,6 +415,7 @@ COMMAND OPTIONS
     --regex                                - Search query is regular expression
     --save=TITLE                           - Save this search for future use (default: none)
     --search, --find, --grep=QUERY         - Filter results using search terms (may be used more than once, default: none)
+    --[no-]search_notes                    - Include notes in search (default: enabled)
     -t, --tag=TAG                          - Alternate tag to search for (default: none)
     --tagged=TAG                           - Match actions containing tag. Allows value comparisons (may be used more than once, default: none)
 
@@ -509,6 +515,7 @@ COMMAND OPTIONS
     --replace=TEXT                         - Use with --find to find and replace with new text. Enables --exact when used (default: none)
     --restore                              - Remove @done tag from action
     --search, --find, --grep=QUERY         - Filter results using search terms (may be used more than once, default: none)
+    --[no-]search_notes                    - Include notes in search (default: enabled)
     -t, --tag=TAG                          - Add a tag to the action, @tag(values) allowed, use multiple times or combine multiple tags with a comma (may be used more than once, default: none)
     --tagged=TAG                           - Match actions containing tag. Allows value comparisons (may be used more than once, default: none)
     --to, --move=PROJECT                   - Move action to specific project (default: none)
@@ -562,6 +569,7 @@ COMMAND OPTIONS
     -o, --overwrite                        - Overwrite note instead of appending
     --proj, --project=PROJECT[/SUBPROJECT] - Affect actions from a specific project (default: none)
     --search, --find, --grep=QUERY         - Filter results using search terms (may be used more than once, default: none)
+    --[no-]search_notes                    - Include notes in search (default: enabled)
     --tagged=TAG                           - Match actions containing tag. Allows value comparisons (may be used more than once, default: none)
     --to, --move=PROJECT                   - Move action to specific project (default: none)
     -x, --exact                            - Match pattern exactly
@@ -632,6 +640,7 @@ COMMAND OPTIONS
     --file=PATH                    - Specify the file to search for the task (default: none)
     --in, --todo=TODO_FILE         - Use a known todo file, partial matches allowed (default: none)
     --search, --find, --grep=QUERY - Filter results using search terms (may be used more than once, default: none)
+    --[no-]search_notes            - Include notes in search (default: enabled)
     --tagged=TAG                   - Match actions containing tag. Allows value comparisons (may be used more than once, default: none)
     -x, --exact                    - Match pattern exactly
 

data/bin/commands/complete.rb

@@ -44,6 +44,9 @@ class App
     c.arg_name 'QUERY'
     c.flag %i[search find grep], multiple: true
 
+    c.desc 'Include notes in search'
+    c.switch %i[search_notes], negatable: true, default_value: true
+
     c.desc 'Match actions containing tag. Allows value comparisons'
     c.arg_name 'TAG'
     c.flag %i[tagged], multiple: true

data/bin/commands/completed.rb

@@ -44,6 +44,9 @@ class App
     c.desc 'Include notes in output'
     c.switch %i[notes], negatable: true, default_value: false
 
+    c.desc 'Include notes in search'
+    c.switch %i[search_notes], negatable: true, default_value: true
+
     c.desc 'Show actions from a specific project'
     c.arg_name 'PROJECT[/SUBPROJECT]'
     c.flag %i[proj project]
@@ -75,9 +78,9 @@ class App
       tag_string.concat(options[:tagged]) if options[:tagged]
 
       if args.empty?
-        cmd_string = %(tagged --done "#{tag_string.join(',')}")
+        cmd_string = %(tagged --done)
       else
-        cmd_string = %(find --tagged "#{tag_string.join(',')}" --done #{args.join(' ')})
+        cmd_string = %(find --tagged "#{tag_string.join(',')}" --done)
       end
 
       cmd_string += ' --or' if options[:or]
@@ -86,13 +89,20 @@ class App
       cmd_string += %( --depth #{options[:depth]}) if options[:depth]
       cmd_string += ' --nest' if options[:nest]
       cmd_string += ' --omnifocus' if options[:omnifocus]
+      cmd_string += " --#{options[:search_notes] ? 'search_notes' : 'no-search_notes'}"
       cmd_string += " --#{options[:notes] ? 'notes' : 'no-notes' }"
 
+      if args.empty?
+        cmd_string += " #{tag_string.join(',')}"
+      else
+        cmd_string += " #{args.join(' ')}"
+      end
+
       if options[:save]
         title = options[:save].gsub(/[^a-z0-9]/, '_').gsub(/_+/, '_')
         NA.save_search(title, cmd_string)
       end
-
+      puts cmd_string
       exit run(Shellwords.shellsplit(cmd_string))
     end
   end

data/bin/commands/edit.rb

@@ -39,6 +39,9 @@ class App
     c.desc 'Match pattern exactly'
     c.switch %i[x exact], negatable: false
 
+    c.desc 'Include notes in search'
+    c.switch %i[search_notes], negatable: true, default_value: true
+
     c.action do |global_options, options, args|
       options[:edit] = true
       action = if args.count.positive?
@@ -130,6 +133,7 @@ class App
       targets.each do |target|
         NA.update_action(target,
                          tokens,
+                         search_note: options[:search_notes],
                          done: options[:done],
                          edit: options[:edit],
                          project: target_proj,

data/bin/commands/find.rb

@@ -29,6 +29,9 @@ class App
     c.desc 'Include notes in output'
     c.switch %i[notes], negatable: true, default_value: false
 
+    c.desc 'Include notes in search'
+    c.switch %i[search_notes], negatable: true, default_value: true
+
     c.desc 'Combine search tokens with OR, displaying actions matching ANY of the terms'
     c.switch %i[o or], negatable: false
 
@@ -93,7 +96,7 @@ class App
 
       search = search.gsub(/ +/, ' ').strip
 
-      all_req = options[:tagged].join(' ') !~ /[+!-]/ && !options[:or]
+      all_req = options[:tagged].join(' ') !~ /(?<=[, ])[+!-]/ && !options[:or]
       tags = []
       options[:tagged].join(',').split(/ *, */).each do |arg|
         m = arg.match(/^(?<req>[+!-])?(?<tag>[^ =<>$~\^]+?) *(?:(?<op>[=<>~]{1,2}|[*$\^]=) *(?<val>.*?))?$/)
@@ -149,6 +152,7 @@ class App
                             done: options[:done],
                             query: todos,
                             search: tokens,
+                            search_note: options[:search_notes],
                             tag: tags,
                             negate: options[:invert],
                             regex: options[:regex],

data/bin/commands/next.rb

@@ -22,10 +22,14 @@ class App
     c.desc 'Show next actions from all known todo files (in any directory)'
     c.switch %i[all], negatable: false, default_value: false
 
-    c.desc 'Display matches from a known todo file'
-    c.arg_name 'TODO_FILE'
+    c.desc 'Display matches from a known todo file anywhere in history (short name)'
+    c.arg_name 'TODO'
     c.flag %i[in todo], multiple: true
 
+    c.desc 'Display matches from specific todo file ([relative] path)'
+    c.arg_name 'TODO_FILE'
+    c.flag %i[file]
+
     c.desc 'Alternate tag to search for'
     c.arg_name 'TAG'
     c.flag %i[t tag]
@@ -42,6 +46,9 @@ class App
     c.arg_name 'QUERY'
     c.flag %i[search find grep], multiple: true
 
+    c.desc 'Include notes in search'
+    c.switch %i[search_notes], negatable: true, default_value: true
+
     c.desc 'Search query is regular expression'
     c.switch %i[regex], negatable: false
 
@@ -169,13 +176,17 @@ class App
       tag << { tag: 'done', value: nil, negate: true } unless options[:done]
       tag.concat(tags)
 
+      file_path = options[:file] ? File.expand_path(options[:file]) : nil
+
       todo = NA::Todo.new({ depth: depth,
                             done: options[:done],
+                            file_path: file_path,
+                            project: options[:project],
                             query: tokens,
-                            tag: tag,
+                            require_na: require_na,
                             search: search_tokens,
-                            project: options[:project],
-                            require_na: require_na })
+                            search_note: options[:search_notes],
+                            tag: tag })
       if todo.files.empty? && tokens
         NA.notify("#{NA.theme[:error]}No matches found for #{tokens[0][:token]}.
                   Run `na todos` to see available todo files.")
@@ -183,9 +194,9 @@ class App
       NA::Pager.paginate = false if options[:omnifocus]
       todo.actions.output(depth,
                           files: todo.files,
-                          notes: options[:notes],
                           nest: options[:nest],
-                          nest_projects: options[:omnifocus])
+                          nest_projects: options[:omnifocus],
+                          notes: options[:notes])
     end
   end
 end

data/bin/commands/restore.rb

@@ -23,7 +23,7 @@ class App
 
     c.desc 'Specify the file to search for the task'
     c.arg_name 'PATH'
-    c.flag %i[file]
+    c.flag %i[file in]
 
     c.desc 'Search for files X directories deep'
     c.arg_name 'DEPTH'
@@ -42,6 +42,9 @@ class App
     c.desc 'Match pattern exactly'
     c.switch %i[x exact], negatable: false
 
+    c.desc 'Include notes in search'
+    c.switch %i[search_notes], negatable: true, default_value: true
+
     c.action do |global, options, args|
       options[:remove] = ['done']
       options[:done] = true

data/bin/commands/tag.rb

@@ -46,6 +46,9 @@ class App
     c.arg_name 'QUERY'
     c.flag %i[search find grep], multiple: true
 
+    c.desc 'Include notes in search'
+    c.switch %i[search_notes], negatable: true, default_value: true
+
     c.desc 'Interpret search pattern as regular expression'
     c.switch %i[e regex], negatable: false
 
@@ -152,6 +155,7 @@ class App
 
       targets.each do |target|
         NA.update_action(target, tokens,
+                         search_note: options[:search_notes],
                          add_tag: add_tags,
                          all: options[:all],
                          done: options[:done],

data/bin/commands/tagged.rb

@@ -40,6 +40,9 @@ class App
     c.arg_name 'QUERY'
     c.flag %i[search find grep], multiple: true
 
+    c.desc 'Include notes in search'
+    c.switch %i[search_notes], negatable: true, default_value: true
+
     c.desc 'Search query is regular expression'
     c.switch %i[regex], negatable: false
 
@@ -139,6 +142,7 @@ class App
                             done: options[:done],
                             query: todos,
                             search: tokens,
+                            search_note: options[:search_notes],
                             tag: tags,
                             negate: options[:invert],
                             project: options[:project],

data/bin/commands/update.rb

@@ -87,6 +87,9 @@ class App
     c.arg_name 'QUERY'
     c.flag %i[search find grep], multiple: true
 
+    c.desc 'Include notes in search'
+    c.switch %i[search_notes], negatable: true, default_value: true
+
     c.desc 'Match actions containing tag. Allows value comparisons'
     c.arg_name 'TAG'
     c.flag %i[tagged], multiple: true
@@ -103,7 +106,7 @@ class App
     c.action do |global_options, options, args|
       reader = TTY::Reader.new
 
-      args.concat(options[:search])
+      args.concat(options[:search]) unless options[:search].nil?
 
       append = options[:at] ? options[:at] =~ /^[ae]/i : global_options[:add_at] =~ /^[ae]/i
 
@@ -257,6 +260,7 @@ class App
                          project: options[:project],
                          remove_tag: remove_tags,
                          replace: options[:replace],
+                         search_note: options[:search_notes],
                          tagged: tags)
       end
     end

data/lib/na/action.rb

@@ -140,31 +140,36 @@ module NA
       tag_matches_any(any) && tag_matches_all(all) && tag_matches_none(none)
     end
 
-    def search_match?(any: [], all: [], none: [])
-      search_matches_any(any) && search_matches_all(all) && search_matches_none(none)
+    def search_match?(any: [], all: [], none: [], include_note: true)
+      search_matches_any(any, include_note: include_note) &&
+        search_matches_all(all, include_note: include_note) &&
+        search_matches_none(none, include_note: include_note)
     end
 
     private
 
-    def search_matches_none(regexes)
+    def search_matches_none(regexes, include_note: true)
       regexes.each do |rx|
-        return false if @action.match(Regexp.new(rx, Regexp::IGNORECASE))
+        note_matches = include_note && @note.join(' ').match(Regexp.new(rx, Regexp::IGNORECASE))
+        return false if @action.match(Regexp.new(rx, Regexp::IGNORECASE)) || note_matches
       end
       true
     end
 
-    def search_matches_any(regexes)
+    def search_matches_any(regexes, include_note: true)
       return true if regexes.empty?
 
       regexes.each do |rx|
-        return true if @action.match(Regexp.new(rx, Regexp::IGNORECASE))
+        note_matches = include_note && @note.join(' ').match(Regexp.new(rx, Regexp::IGNORECASE))
+        return true if @action.match(Regexp.new(rx, Regexp::IGNORECASE)) || note_matches
       end
       false
     end
 
-    def search_matches_all(regexes)
+    def search_matches_all(regexes, include_note: true)
       regexes.each do |rx|
-        return false unless @action.match(Regexp.new(rx, Regexp::IGNORECASE))
+        note_matches = include_note && @note.join(' ').match(Regexp.new(rx, Regexp::IGNORECASE))
+        return false unless @action.match(Regexp.new(rx, Regexp::IGNORECASE)) || note_matches
       end
       true
     end

data/lib/na/next_action.rb

@@ -139,8 +139,9 @@ module NA
       todo.projects
     end
 
-    def find_actions(target, search, tagged = nil, all: false, done: false, project: nil)
+    def find_actions(target, search, tagged = nil, all: false, done: false, project: nil, search_note: true)
       todo = NA::Todo.new({ search: search,
+                            search_note: search_note,
                             require_na: false,
                             file_path: target,
                             project: project,
@@ -231,6 +232,7 @@ module NA
 
     def update_action(target,
                       search,
+                      search_note: true,
                       add: nil,
                       add_tag: [],
                       all: false,
@@ -327,7 +329,7 @@ module NA
 
         notify(add.pretty)
       else
-        _, actions = find_actions(target, search, tagged, done: done, all: all, project: project)
+        _, actions = find_actions(target, search, tagged, done: done, all: all, project: project, search_note: search_note)
 
         return if actions.nil?
 

data/lib/na/string.rb

@@ -39,6 +39,8 @@ class ::String
     file = File.expand_path(self)
     raise "Missing file #{file}" unless File.exist?(file)
 
+    NA.notify("#{NA.theme[:error]}#{file} is a directory", exit_code: 2) if File.directory?(file)
+
     # IO.read(file).force_encoding('ASCII-8BIT').encode('UTF-8', invalid: :replace, undef: :replace, replace: '?')
     IO.read(file).force_encoding('utf-8')
   end

data/lib/na/todo.rb

@@ -37,6 +37,7 @@ module NA
         regex: false,
         require_na: true,
         search: nil,
+        search_note: true,
         tag: nil
       }
 
@@ -93,7 +94,7 @@ module NA
               else
                 NA.match_working_dir(settings[:query])
               end
-
+      NA.notify("Files: #{files.join(', ')}", debug:true)
       files.each do |file|
         NA.save_working_dir(File.expand_path(file))
         content = file.read_file
@@ -124,7 +125,7 @@ module NA
 
             indent_level = indent
           elsif line.blank?
-            in_action = false
+            in_action = false # Comment out to allow line breaks in of notes, which isn't TaskPaper-compatible
           elsif line.action?
             in_action = false
 
@@ -137,10 +138,6 @@ module NA
 
             next if settings[:require_na] && !line.na?
 
-            has_search = !optional.empty? || !required.empty? || !negated.empty?
-            next if has_search && !new_action.search_match?(any: optional,
-                                                            all: required,
-                                                            none: negated)
             if settings[:project]
               rx = settings[:project].split(%r{[/:]}).join('.*?/')
               next unless parent.join('/') =~ Regexp.new("#{rx}.*?", Regexp::IGNORECASE)
@@ -161,6 +158,14 @@ module NA
         projects = projects.dup
       end
 
+      actions.delete_if do |new_action|
+        has_search = !optional.empty? || !required.empty? || !negated.empty?
+        has_search && !new_action.search_match?(any: optional,
+                                                all: required,
+                                                none: negated,
+                                                include_note: settings[:search_note])
+      end
+
       [files, actions, projects]
     end
 

data/lib/na/version.rb

@@ -1,3 +1,3 @@
 module Na
-  VERSION = '1.2.59'
+  VERSION = '1.2.60'
 end

data/src/_README.md

@@ -9,7 +9,7 @@
 _If you're one of the rare people like me who find this useful, feel free to
 [buy me some coffee][donate]._
 
-The current version of `na` is <!--VER-->1.2.58<!--END VER-->.
+The current version of `na` is <!--VER-->1.2.59<!--END VER-->.
 
 `na` ("next action") is a command line tool designed to make it easy to see what your next actions are for any project, right from the command line. It works with TaskPaper-formatted files (but any plain text format will do), looking for `@na` tags (or whatever you specify) in todo files in your current folder. 
 

data/test.md

@@ -3,13 +3,18 @@ comment: 2023-09-03
 keywords:
 ---
 Other New Project:
-	- testing @na
+	- testing @na @butter
 Brand New Project:
 	- testing @na
+		A multi line (multiline) note
+		with a line break
 	- testing @na
 Project0:
+
 - Test1
+
 - Test2
+
 Project1:
 - Test4
 - Test5

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: na
 version: !ruby/object:Gem::Version
-  version: 1.2.59
+  version: 1.2.60
 platform: ruby
 authors:
 - Brett Terpstra