na 1.1.12 → 1.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da1e1113960a99932feda46ee18cd7a8b9e8d309f479c9e3a6ec323d97db686a
-  data.tar.gz: 871fcae47831f04efcff94b7034abb70d32cb47b2f504247b94705ad015c191f
+  metadata.gz: 2324b729bcc5e20eab3e063427fa5c6480274ea844fe72117e7f25c7e9801764
+  data.tar.gz: 68d00ee26f320e14afd0e6a72a072b2cf30c82beaaf7818962b90e7fa0884914
 SHA512:
-  metadata.gz: c8e8c92c9d3a3ffa4a00fe8fcdd8ace94681e19f9ac53a3d8b988bcf4bd69d3b032765b4a870e3d9f660cd58b18783e97e8333cdb252164cb60f0062495210b5
-  data.tar.gz: de5596e85883b893afbe2ca43833fe60f82fd96ab12e1f2506d84d13a90644d5d403b748b6598c9fb4c4d4db3998bdd0e560a1c071f4f7c2946b5f75dd45c728
+  metadata.gz: b6b7fd0066ba41b9fa184ab3231cb8d7b68e68526bc380f21f2b12048de1c4a4eae24d2da8e47abe95c2389536e90ee32fa35ebdf786570745b8153c72d65e4a
+  data.tar.gz: 320264ba4f636f8a68804f7767bd09a4c2105adf684b603514d933003f06f72e2cebb978476a659c2a7ee716fbdaadf7f9fd507c3985ec2dc870162da2751414

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+### 1.1.14
+
+2022-10-06 12:30
+
+#### IMPROVED
+
+- Code cleanup
+- Highlight search terms in results
+
+#### FIXED
+
+- Multiple search terms overriding each other
+
+### 1.1.13
+
+2022-10-06 06:28
+
+#### IMPROVED
+
+- When specifying arguments to `next`, allow paths separated by / to do more exact matching
+
 ### 1.1.12
 
 2022-10-06 05:42

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    na (1.1.12)
+    na (1.1.14)
       gli (~> 2.21.0)
       tty-reader (~> 0.9, >= 0.9.0)
       tty-screen (~> 0.8, >= 0.8.1)

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.1.12
+The current version of `na` is 1.1.14
 .
 
 `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. 
@@ -37,7 +37,7 @@ You can list next actions in files in the current directory by typing `na`. By d
 
 #### Easy matching
 
-`na` features intelligent project matching. Every time it locates a todo file, it adds the project to the database. Once a project is recorded, you can list its actions by using any portion of the parent directories or file names. If your project is in `~/Sites/dev/markedapp`, you could quickly list its next actions by typing `na next dev mark`. It will always look for the shortest match.
+`na` features intelligent project matching. Every time it locates a todo file, it adds the project to the database. Once a project is recorded, you can list its actions by using any portion of the parent directories or file names. If your project is in `~/Sites/dev/markedapp`, you could quickly list its next actions by typing `na next dev/mark`. Creat paths by separating with / or :, separate multiple queries with spaces. na will always look for the shortest match for a path.
 
 #### Recursion
 
@@ -152,6 +152,8 @@ EXAMPLES
 
 Example: `na find cool feature idea`
 
+Unless `--exact` is specified, search is tokenized and combined with OR, so `na find cool feature idea` translates to `cool OR feature OR idea`, matching any string that contains any of the words. To make a token required, add a `+` before it (e.g. `cool +feature idea` is `(cool OR idea) AND feature`). Wildcards allowed (`*` and `?`), use `--regex` to interpret the search as a regular expression. Use `-v` to invert the results (display non-matching actions only).
+
 ```
 NAME
     find - Find actions matching a search pattern
@@ -229,7 +231,9 @@ EXAMPLES
 
 ##### tagged
 
-Example: `na tagged feature +maybe`
+Example: `na tagged feature +maybe`.
+
+Separate multiple tags with spaces or commas. By default tags are combined with OR, so actions matching any of the tags listed will be displayed. Use `+` to make a tag required and `!` to negate a tag (only display if the action does _not_ contain the tag). Use `-v` to invert the search and display all actions that _don't_ match.
 
 ```
 NAME

data/bin/na

@@ -269,7 +269,7 @@ class App
         tokens = Regexp.new(args.join(' '), Regexp::IGNORECASE)
       else
         tokens = []
-        args.each do |arg|
+        args.join(' ').split(/ /).each do |arg|
           m = arg.match(/^(?<req>[+\-!])?(?<tok>.*?)$/)
           tokens.push({
                         token: m['tok'],
@@ -285,7 +285,8 @@ class App
                                         regex: options[:regex],
                                         project: options[:project],
                                         require_na: false)
-      NA.output_actions(actions, depth, files: files)
+      regexes = tokens.delete_if { |token| token[:negate] }.map { |token| token[:token] }
+      NA.output_actions(actions, depth, files: files, regexes: regexes)
     end
   end
 
@@ -336,7 +337,8 @@ class App
                                         negate: options[:invert],
                                         project: options[:project],
                                         require_na: false)
-      NA.output_actions(actions, depth, files: files)
+      regexes = tags.delete_if { |token| token[:negate] }.map { |token| token[:token] }
+      NA.output_actions(actions, depth, files: files, regexes: regexes)
     end
   end
 

data/lib/na/action.rb

@@ -27,7 +27,7 @@ module NA
       EOINSPECT
     end
 
-    def pretty(extension: 'taskpaper', template: {})
+    def pretty(extension: 'taskpaper', template: {}, regexes: [])
       default_template = {
         file: '{xbk}',
         parent: '{c}',
@@ -67,7 +67,7 @@ module NA
       NA::Color.template(template[:output].gsub(/%filename/, filename)
                           .gsub(/%project/, project)
                           .gsub(/%parents?/, parents)
-                          .gsub(/%action/, action))
+                          .gsub(/%action/, action.highlight_search(regexes)))
     end
 
     def tags_match?(any: [], all: [], none: [])

data/lib/na/next_action.rb

@@ -80,8 +80,10 @@ module NA
       notify("{by}Task added to {bw}#{file}")
     end
 
-    def output_actions(actions, depth, files: nil)
-      template = if files&.count.positive?
+    def output_actions(actions, depth, files: nil, regexes: [])
+      return if files.nil?
+
+      template = if files.count.positive?
                    if files.count == 1
                      '%parent%action'
                    else
@@ -96,11 +98,10 @@ module NA
                  else
                    '%parent%action'
                  end
-      if files && @verbose
-        files.map { |f| notify("{dw}#{f}") }
-      end
 
-      puts actions.map { |action| action.pretty(template: { output: template }) }
+      files.map { |f| notify("{dw}#{f}") } if files && @verbose
+
+      puts(actions.map { |action| action.pretty(template: { output: template }, regexes: regexes) })
     end
 
     def parse_actions(depth: 1, query: nil, tag: nil, search: nil, negate: false, regex: false, project: nil, require_na: true)
@@ -136,28 +137,19 @@ module NA
           end
         else
           search.each do |t|
-            new_rx = t[:token].to_s.wildcard_to_rx
-
-            if negate
-              optional.push(new_rx) if t[:negate]
-              required.push(new_rx) if t[:required] && t[:negate]
-              negated.push(new_rx) unless t[:negate]
-            else
-              optional.push(new_rx) unless t[:negate]
-              required.push(new_rx) if t[:required] && !t[:negate]
-              negated.push(new_rx) if t[:negate]
-            end
+            opt, req, neg = parse_search(t, negate)
+            optional.concat(opt)
+            required.concat(req)
+            negated.concat(neg)
           end
         end
       end
 
-      na_tag = "@#{NA.na_tag.sub(/^@/, '')}"
-
-      if query.nil?
-        files = find_files(depth: depth)
-      else
-        files = match_working_dir(query)
-      end
+      files = if query.nil?
+                find_files(depth: depth)
+              else
+                match_working_dir(query)
+              end
 
       files.each do |file|
         save_working_dir(File.expand_path(file))
@@ -207,6 +199,40 @@ module NA
       [files, actions]
     end
 
+    def edit_file(file: nil, app: nil)
+      os_open(file, app: app) if file && File.exist?(file)
+    end
+
+    ##
+    ## Platform-agnostic open command
+    ##
+    ## @param      file  [String] The file to open
+    ##
+    def os_open(file, app: nil)
+      os = RbConfig::CONFIG['target_os']
+      case os
+      when /darwin.*/i
+        darwin_open(file, app: app)
+      when /mingw|mswin/i
+        win_open(file)
+      else
+        linux_open(file)
+      end
+    end
+
+    def weed_cache_file
+      db_dir = File.expand_path('~/.local/share/na')
+      db_file = 'tdlist.txt'
+      file = File.join(db_dir, db_file)
+      if File.exist?(file)
+        dirs = IO.read(file).split("\n")
+        dirs.delete_if { |f| !File.exist?(f) }
+        File.open(file, 'w') { |f| f.puts dirs.join("\n") }
+      end
+    end
+
+    private
+
     ##
     ## Generate a menu of options and allow user selection
     ##
@@ -234,6 +260,25 @@ module NA
       res
     end
 
+    def parse_search(tag, negate)
+      required = []
+      optional = []
+      negated = []
+      new_rx = tag[:token].to_s.wildcard_to_rx
+
+      if negate
+        optional.push(new_rx) if tag[:negate]
+        required.push(new_rx) if tag[:required] && tag[:negate]
+        negated.push(new_rx) unless tag[:negate]
+      else
+        optional.push(new_rx) unless tag[:negate]
+        required.push(new_rx) if tag[:required] && !tag[:negate]
+        negated.push(new_rx) if tag[:negate]
+      end
+
+      [optional, required, negated]
+    end
+
     ##
     ## Get path to database of known todo files
     ##
@@ -276,7 +321,7 @@ module NA
       notify('{r}No na database found', exit_code: 1) unless File.exist?(file)
 
       dirs = IO.read(file).split("\n")
-      dirs.delete_if { |d| !d.matches(any: optional, all: required) }
+      dirs.delete_if { |d| !d.dir_matches(any: optional, all: required) }
       dirs.sort.uniq
     end
 
@@ -289,21 +334,6 @@ module NA
       File.open(file, 'w') { |f| f.puts dirs.join("\n") }
     end
 
-    def weed_cache_file
-      db_dir = File.expand_path('~/.local/share/na')
-      db_file = 'tdlist.txt'
-      file = File.join(db_dir, db_file)
-      if File.exist?(file)
-        dirs = IO.read(file).split("\n")
-        dirs.delete_if { |f| !File.exist?(f) }
-        File.open(file, 'w') { |f| f.puts dirs.join("\n") }
-      end
-    end
-
-    def edit_file(file: nil, app: nil)
-      os_open(file, app: app) if file && File.exist?(file)
-    end
-
     def darwin_open(file, app: nil)
       if app
         `open -a "#{app}" #{Shellwords.escape(file)}`
@@ -323,22 +353,5 @@ module NA
         notify('{r}Unable to determine executable for `xdg-open`.')
       end
     end
-
-    ##
-    ## Platform-agnostic open command
-    ##
-    ## @param      file  [String] The file to open
-    ##
-    def os_open(file, app: nil)
-      os = RbConfig::CONFIG['target_os']
-      case os
-      when /darwin.*/i
-        darwin_open(file, app: app)
-      when /mingw|mswin/i
-        win_open(file)
-      else
-        linux_open(file)
-      end
-    end
   end
 end

data/lib/na/string.rb

@@ -5,9 +5,7 @@ class ::String
     prefix = match(/(^[ \t]+)/)
     return 0 if prefix.nil?
 
-    tabs = prefix[1].gsub(/  /, "\t").scan(/\t/).count
-
-    tabs
+    prefix[1].gsub(/  /, "\t").scan(/\t/).count
   end
 
   ##
@@ -21,13 +19,65 @@ class ::String
     tag_color = NA::Color.template(color)
     paren_color = NA::Color.template(parens)
     value_color = NA::Color.template(value)
-    gsub(/(\s|m)(@[^ ("']+)(?:(\()(.*?)(\)))?/, "\\1#{tag_color}\\2#{paren_color}\\3#{value_color}\\4#{paren_color}\\5#{last_color}")
+    gsub(/(\s|m)(@[^ ("']+)(?:(\()(.*?)(\)))?/,
+         "\\1#{tag_color}\\2#{paren_color}\\3#{value_color}\\4#{paren_color}\\5#{last_color}")
+  end
+
+  def highlight_search(regexes, color: '{y}')
+    string = dup
+    color = NA::Color.template(color)
+    regexes.each do |rx|
+      next if rx.nil?
+
+      string.gsub!(/(#{rx.wildcard_to_rx})/i, "#{color}\\1#{NA::Color.template('{xg}')}")
+    end
+    string
+  end
+
+  # Returns the last escape sequence from a string.
+  #
+  # Actually returns all escape codes, with the assumption
+  # that the result of inserting them will generate the
+  # same color as was set at the end of the string.
+  # Because you can send modifiers like dark and bold
+  # separate from color codes, only using the last code
+  # may not render the same style.
+  #
+  # @return     [String]  All escape codes in string
+  #
+  def last_color
+    scan(/\e\[[\d;]+m/).join('').gsub(/\e\[0m/, '')
+  end
+
+  def dir_to_rx
+    "#{split(%r{[/:]}).join('.*?/.*?')}[^/]+$"
+  end
+
+  def dir_matches(any: [], all: [])
+    matches_any(any.map(&:dir_to_rx)) && matches_all(all.map(&:dir_to_rx))
   end
 
   def matches(any: [], all: [], none: [])
     matches_any(any) && matches_all(all) && matches_none(none)
   end
 
+  def wildcard_to_rx
+    gsub(/\./, '\\.').gsub(/\*/, '.*?').gsub(/\?/, '.')
+  end
+
+  def cap_first!
+    replace cap_first
+  end
+
+  def cap_first
+    sub(/^([a-z])(.*)$/) do
+      m = Regexp.last_match
+      m[1].upcase << m[2]
+    end
+  end
+
+  private
+
   def matches_none(regexes)
     regexes.each do |rx|
       return false if match(Regexp.new(rx, Regexp::IGNORECASE))
@@ -48,19 +98,4 @@ class ::String
     end
     true
   end
-
-  def wildcard_to_rx
-    gsub(/\./, '\\.').gsub(/\*/, '.*?').gsub(/\?/, '.')
-  end
-
-  def cap_first!
-    replace cap_first
-  end
-
-  def cap_first
-    sub(/^([a-z])(.*)$/) do
-      m = Regexp.last_match
-      m[1].upcase << m[2]
-    end
-  end
 end

data/lib/na/version.rb

@@ -1,3 +1,3 @@
 module Na
-  VERSION = '1.1.12'
+  VERSION = '1.1.14'
 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.1.11<!--END VER-->.
+The current version of `na` is <!--VER-->1.1.13<!--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. 
 
@@ -36,7 +36,7 @@ You can list next actions in files in the current directory by typing `na`. By d
 
 #### Easy matching
 
-`na` features intelligent project matching. Every time it locates a todo file, it adds the project to the database. Once a project is recorded, you can list its actions by using any portion of the parent directories or file names. If your project is in `~/Sites/dev/markedapp`, you could quickly list its next actions by typing `na next dev mark`. It will always look for the shortest match.
+`na` features intelligent project matching. Every time it locates a todo file, it adds the project to the database. Once a project is recorded, you can list its actions by using any portion of the parent directories or file names. If your project is in `~/Sites/dev/markedapp`, you could quickly list its next actions by typing `na next dev/mark`. Creat paths by separating with / or :, separate multiple queries with spaces. na will always look for the shortest match for a path.
 
 #### Recursion
 
@@ -151,6 +151,8 @@ EXAMPLES
 
 Example: `na find cool feature idea`
 
+Unless `--exact` is specified, search is tokenized and combined with OR, so `na find cool feature idea` translates to `cool OR feature OR idea`, matching any string that contains any of the words. To make a token required, add a `+` before it (e.g. `cool +feature idea` is `(cool OR idea) AND feature`). Wildcards allowed (`*` and `?`), use `--regex` to interpret the search as a regular expression. Use `-v` to invert the results (display non-matching actions only).
+
 ```
 NAME
     find - Find actions matching a search pattern
@@ -228,7 +230,9 @@ EXAMPLES
 
 ##### tagged
 
-Example: `na tagged feature +maybe`
+Example: `na tagged feature +maybe`.
+
+Separate multiple tags with spaces or commas. By default tags are combined with OR, so actions matching any of the tags listed will be displayed. Use `+` to make a tag required and `!` to negate a tag (only display if the action does _not_ contain the tag). Use `-v` to invert the search and display all actions that _don't_ match.
 
 ```
 NAME

metadata

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