na 1.1.19 → 1.1.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a57cbddd075c808316dbf206b6ff65d4d0caf307c4c27524faf94f6e86517d3
-  data.tar.gz: 2e0ff764b2a777eb5089c228f7979c131c7669557f033f657241052cd3345b53
+  metadata.gz: '0430897c007446c9ad1a1e3463ddc3d8e192a43e8d60a46a9669745086ea45f3'
+  data.tar.gz: e33799f49bbaf623d188c64f549e71dcea41b317b95b3b5d0f72f8a378a3f9fd
 SHA512:
-  metadata.gz: 4516162349290992f0a156161e3f3b1e7831ad383c38d9061ff44d267b862037e5cfb04796ac1143c4bdd1b60fa77b6c9576ee265add84abc19a5958d30dd8a6
-  data.tar.gz: 91c86e3ea2c36fd66cbbc7211c9ebab460af7a9ba14668bb1f55a7a14d7e8b5aaf2ff8b7795672ee7c3856a3ae47b0783a40033c427b2df69ff2c0c6c60697e4
+  metadata.gz: d8c9a03b08abf20cb826e452ad75478b0f58dc0309ce51bee29e3b31b6c37de8e99cdd22926aef1ffe10183b151b54b6047196ce5c8987c32b0fa013942d5673
+  data.tar.gz: 7bb18376e8b53aa2c283206058c48dce786576d3a50d6e9567a0958011cab7f2f7203fecf0142cc49f3d5abc49a0342a4a3c20ff19318f79ac2d26ca00af206b

data/.travis.yml

@@ -0,0 +1,11 @@
+---
+language: ruby
+sudo: required
+dist: trusty
+cache: bundler
+rvm:
+  - ruby-3.0.1
+install:
+  - gem install bundler --version '2.2.29'
+  - bundle install
+script: "bundle exec rake test"

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+### 1.1.21
+
+2022-10-07 04:26
+
+#### NEW
+
+- `na todos` will list (and optionally search) known todo files from history
+
+#### IMPROVED
+
+- Fuzzier matching of todo file history
+- Help output fixes
+- Code documentation
+
+### 1.1.20
+
+2022-10-07 03:16
+
+#### IMPROVED
+
+- Date comparisons that don't specify a time are automatically adjusted to "noon" to allow direct comparison of days
+
 ### 1.1.19
 
 2022-10-07 03:06

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    na (1.1.19)
+    na (1.1.21)
       chronic (~> 0.10, >= 0.10.2)
       gli (~> 2.21.0)
       tty-reader (~> 0.9, >= 0.9.0)

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.19
+The current version of `na` is 1.1.21
 .
 
 `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. 
@@ -59,7 +59,7 @@ SYNOPSIS
     na [global options] command [command options] [arguments...]
 
 VERSION
-    1.1.19
+    1.1.21
 
 GLOBAL OPTIONS
     -a, --[no-]add          - Add a next action (deprecated, for backwards compatibility)
@@ -83,6 +83,7 @@ COMMANDS
     next, show   - Show next actions
     prompt       - Show or install prompt hooks for the current shell
     tagged       - Find actions matching a tag
+    todos        - Show list of known todo files
 ```
 
 #### Commands
@@ -102,7 +103,7 @@ SYNOPSIS
     na [global options] add [command options] ACTION
 
 DESCRIPTION
-    Provides an easy way to store todos while you work. Add quick reminders and (if you set up Prompt Hooks)   they'll automatically display next time you enter the directory.   If multiple todo files are found in the current directory, a menu will allow you to pick to which   file the action gets added. 
+    Provides an easy way to store todos while you work. Add quick   reminders and (if you set up Prompt Hooks) they'll automatically display   next time you enter the directory.   If multiple todo files are found in the current directory, a menu will   allow you to pick to which file the action gets added. 
 
 COMMAND OPTIONS
     -d, --depth=DEPTH   - Search for files X directories deep (default: 1)
@@ -206,7 +207,7 @@ EXAMPLES
 
 ##### next, show
 
-Examples: 
+Examples:
 
 - `na show` (list all next actions in the current directory)
 - `na show -d 3` (list all next actions in the current directory and look for additional files 3 levels deep from there)
@@ -218,7 +219,10 @@ NAME
 
 SYNOPSIS
 
-    na [global options] next [command options] OPTIONAL_QUERY
+    na [global options] next [command options] [QUERY]
+
+DESCRIPTION
+    Next actions are actions which contain the next action tag (default @na),   do not contain @done, and are not in the Archive project. 
 
 COMMAND OPTIONS
     -d, --depth=DEPTH                      - Recurse to depth (default: 2)
@@ -245,38 +249,30 @@ Separate multiple tags with spaces or commas. By default tags are combined with
 
 ```
 NAME
-    tagged - Find actions matching a tag
+    next - Show next actions
 
 SYNOPSIS
 
-    na [global options] tagged [command options] TAG [VALUE]
+    na [global options] next [command options] [QUERY]
 
 DESCRIPTION
-    Finds actions with tags matching the arguments. An action is shown if it              contains all of the tags listed. Add a + before a tag to make it required              and others optional. You can specify values using TAG=VALUE pairs.              Use <, >, and = for numeric comparisons, and *=, ^=, and $= for text comparisons.              Date comparisons use natural language (`na tagged "due<=today"`) and              are detected automatically. 
+    Next actions are actions which contain the next action tag (default @na),   do not contain @done, and are not in the Archive project. 
 
 COMMAND OPTIONS
-    -d, --depth=DEPTH                      - Recurse to depth (default: 1)
-    --in=TODO_PATH                         - Show actions from a specific todo file in history (default: none)
-    -o, --or                               - Combine tags with OR, displaying actions matching ANY of the tags
+    -d, --depth=DEPTH                      - Recurse to depth (default: 2)
     --proj, --project=PROJECT[/SUBPROJECT] - Show actions from a specific project (default: none)
-    -v, --invert                           - Show actions not matching tags
+    -t, --tag=TAG                          - Alternate tag to search for (default: none)
 
 EXAMPLES
 
-    # Show all actions tagged @maybe
-    na tagged maybe
-
-    # Show all actions tagged @feature AND @idea, recurse 3 levels
-    na tagged -d 3 "feature, idea"
-
-    # Show all actions tagged @feature OR @idea
-    na tagged --or "feature, idea"
+    # display the next actions from any todo files in the current directory
+    na next
 
-    # Show actions with @priority(4) or @priority(5)
-    na tagged "priority>=4"
+    # display the next actions from the current directory, traversing 3 levels deep
+    na next -d 3
 
-    # Show actions with a due date coming up in the next 2 days
-    na tagged "due<in 2 days"
+    # display next actions for a project you visited in the past
+    na next marked
 ```
 
 ### Configuration

data/bin/na

@@ -54,7 +54,9 @@ class App
   switch %i[debug]
 
   desc 'Show next actions'
-  arg_name 'OPTIONAL_QUERY'
+  long_desc "Next actions are actions which contain the next action tag (default @na),
+  do not contain @done, and are not in the Archive project."
+  arg_name 'QUERY', optional: true
   command %i[next show] do |c|
     c.example 'na next', desc: 'display the next actions from any todo files in the current directory'
     c.example 'na next -d 3', desc: 'display the next actions from the current directory, traversing 3 levels deep'
@@ -114,11 +116,12 @@ class App
   end
 
   desc 'Add a new next action'
-  long_desc 'Provides an easy way to store todos while you work. Add quick reminders and (if you set up Prompt Hooks)
-  they\'ll automatically display next time you enter the directory.
+  long_desc 'Provides an easy way to store todos while you work. Add quick
+  reminders and (if you set up Prompt Hooks) they\'ll automatically display
+  next time you enter the directory.
 
-  If multiple todo files are found in the current directory, a menu will allow you to pick to which
-  file the action gets added.'
+  If multiple todo files are found in the current directory, a menu will
+  allow you to pick to which file the action gets added.'
   arg_name 'ACTION'
   command :add do |c|
     c.example 'na add "A cool feature I thought of @idea"', desc: 'Add a new action to the Inbox, including a tag'
@@ -314,12 +317,12 @@ class App
 
   desc 'Find actions matching a tag'
   long_desc 'Finds actions with tags matching the arguments. An action is shown if it
-             contains all of the tags listed. Add a + before a tag to make it required
-             and others optional. You can specify values using TAG=VALUE pairs.
-             Use <, >, and = for numeric comparisons, and *=, ^=, and $= for text comparisons.
-             Date comparisons use natural language (`na tagged "due<=today"`) and
-             are detected automatically.'
-  arg_name 'TAG [VALUE]'
+  contains all of the tags listed. Add a + before a tag to make it required
+  and others optional. You can specify values using TAG=VALUE pairs.
+  Use <, >, and = for numeric comparisons, and *=, ^=, and $= for text comparisons.
+  Date comparisons use natural language (`na tagged "due<=today"`) and
+  are detected automatically.'
+  arg_name 'TAG[=VALUE]'
   command %i[tagged] do |c|
     c.example 'na tagged maybe', desc: 'Show all actions tagged @maybe'
     c.example 'na tagged -d 3 "feature, idea"', desc: 'Show all actions tagged @feature AND @idea, recurse 3 levels'
@@ -388,7 +391,7 @@ class App
   end
 
   desc 'Create a new todo file in the current directory'
-  arg_name '[PROJECT]'
+  arg_name 'PROJECT', optional: true
   command %i[init create] do |c|
     c.example 'na init', desc: 'Generate a new todo file, prompting for project name'
     c.example 'na init warpspeed', desc: 'Generate a new todo for a project called warpspeed'
@@ -456,13 +459,35 @@ class App
     end
   end
 
+  desc 'Show list of known todo files'
+  long_desc 'Arguments will be interpreted as a query against which the
+  list of todos will be fuzzy matched. Separate directories with
+  /, :, or a space, e.g. `na todos code/marked`'
+  arg_name 'QUERY', optional: true
+  command %i[todos] do |c|
+    c.action do |_global_options, _options, args|
+      if args.count.positive?
+        tokens = []
+        args.each do |arg|
+          m = arg.match(/^(?<req>\+)?(?<tok>.*?)$/)
+          tokens.push({
+                        token: m['tok'],
+                        required: !m['req'].nil?
+                      })
+        end
+      end
+
+      NA.list_todos(query: tokens)
+    end
+  end
+
   desc 'Show or install prompt hooks for the current shell'
   long_desc 'Installing the prompt hook allows you to automatically
   list next actions when you cd into a directory'
   command %i[prompt] do |c|
     c.desc 'Output the prompt hook for the current shell to STDOUT. Pass an argument to
             specify a shell (zsh, bash, fish)'
-    c.arg_name '[SHELL]'
+    c.arg_name 'SHELL', optional: true
     c.command %i[show] do |s|
       s.action do |_global_options, _options, args|
         shell = if args.count.positive?
@@ -483,7 +508,7 @@ class App
     end
 
     c.desc 'Install the hook for the current shell to the appropriate startup file.'
-    c.arg_name '[SHELL]'
+    c.arg_name 'SHELL', optional: true
     c.command %i[install] do |s|
       s.action do |_global_options, _options, args|
         shell = if args.count.positive?

data/lib/na/action.rb

@@ -137,14 +137,14 @@ module NA
       return false if tag_val.nil?
 
       begin
-        if val =~ /^today$/i
-          val = 'today at 12am'
-          tag_val = tag_val.sub(/\d\d:\d\d/, '00:00')
-        end
-
         tag_date = Time.parse(tag_val)
         date = Chronic.parse(val)
 
+        unless val =~ /(\d:\d|a[mp]|now)/i
+          tag_date = Time.parse(tag_date.strftime('%Y-%m-%d 12:00'))
+          date = Time.parse(date.strftime('%Y-%m-%d 12:00'))
+        end
+
         puts "Comparing #{tag_date} #{tag[:comp]} #{date}" if NA.verbose
 
         case tag[:comp]

data/lib/na/next_action.rb

@@ -5,13 +5,27 @@ module NA
   class << self
     attr_accessor :verbose, :extension, :na_tag
 
-    def notify(msg, exit_code: false)
+    ##
+    ## Output to STDERR
+    ##
+    ## @param      msg        [String] The message
+    ## @param      exit_code  [Number] The exit code, no exit if false
+    ##
+    def notify(msg, exit_code: false, debug: false)
+      return if debug && !@verbose
+
       $stderr.puts NA::Color.template("{x}#{msg}{x}")
       if exit_code && exit_code.is_a?(Number)
         Process.exit exit_code
       end
     end
 
+    ##
+    ## Create a new todo file
+    ##
+    ## @param      target    [String] The target path
+    ## @param      basename  [String] The project base name
+    ##
     def create_todo(target, basename)
       File.open(target, 'w') do |f|
         content = <<~ENDCONTENT
@@ -32,12 +46,24 @@ module NA
       notify("{y}Created {bw}#{target}")
     end
 
+    ##
+    ## Use the *nix `find` command to locate files matching NA.extension
+    ##
+    ## @param      depth  [Number] The depth at which to search
+    ##
     def find_files(depth: 1)
       files = `find . -name "*.#{NA.extension}" -maxdepth #{depth}`.strip.split("\n")
       files.each { |f| save_working_dir(File.expand_path(f)) }
       files
     end
 
+    ##
+    ## Select from multiple files
+    ##
+    ## @note If `gum` or `fzf` are available, they'll be used (in that order)
+    ##
+    ## @param      files  [Array] The files
+    ##
     def select_file(files)
       if TTY::Which.exist?('gum')
         args = [
@@ -63,12 +89,22 @@ module NA
       end
     end
 
+    ##
+    ## Add an action to a todo file
+    ##
+    ## @param      file     [String] The target file
+    ## @param      project  [String] The project name
+    ## @param      action   [String] The action
+    ## @param      note     [String] The note
+    ##
     def add_action(file, project, action, note = nil)
       content = IO.read(file)
+      # Insert the target project at the top if it doesn't exist
       unless content =~ /^[ \t]*#{project}:/i
         content = "#{project.cap_first}:\n#{content}"
       end
 
+      # Insert the action at the top of the target project
       content.sub!(/^([ \t]*)#{project}:(.*?)$/i) do
         m = Regexp.last_match
         note = note.nil? ? '' : "\n#{m[1]}\t\t#{note.join('').strip}"
@@ -80,6 +116,14 @@ module NA
       notify("{by}Task added to {bw}#{file}")
     end
 
+    ##
+    ## Pretty print a list of actions
+    ##
+    ## @param      actions  [Array] The actions
+    ## @param      depth    [Number] The depth
+    ## @param      files    [Array] The files actions originally came from
+    ## @param      regexes  [Array] The regexes used to gather actions
+    ##
     def output_actions(actions, depth, files: nil, regexes: [])
       return if files.nil?
 
@@ -99,11 +143,23 @@ module NA
                    '%parent%action'
                  end
 
-      files.map { |f| notify("{dw}#{f}") } if files && @verbose
+      files.map { |f| notify("{dw}#{f}", debug: true) } if files
 
       puts(actions.map { |action| action.pretty(template: { output: template }, regexes: regexes) })
     end
 
+    ##
+    ## Read a todo file and create a list of actions
+    ##
+    ## @param      depth       [Number] The directory depth to search for files
+    ## @param      query       [Hash] The project query
+    ## @param      tag         [Hash] Tags to search for
+    ## @param      search      [String] A search string
+    ## @param      negate      [Boolean] Invert results
+    ## @param      regex       [Boolean] Interpret as regular expression
+    ## @param      project     [String] The project
+    ## @param      require_na  [Boolean] Require @na tag
+    ##
     def parse_actions(depth: 1, query: nil, tag: nil, search: nil, negate: false, regex: false, project: nil, require_na: true)
       actions = []
       required = []
@@ -220,6 +276,9 @@ module NA
       end
     end
 
+    ##
+    ## Remove entries from cache database that no longer exist
+    ##
     def weed_cache_file
       db_dir = File.expand_path('~/.local/share/na')
       db_file = 'tdlist.txt'
@@ -231,6 +290,24 @@ module NA
       end
     end
 
+    def list_todos(query: [])
+      if query
+        dirs = match_working_dir(query)
+      else
+        file = database_path
+        content = File.exist?(file) ? IO.read(file).strip : ''
+        notify('{br}Database empty', exit_code: 1) if content.empty?
+
+        dirs = content.split(/\n/)
+      end
+
+      dirs.map! do |dir|
+        "{xg}#{dir.sub(/^#{ENV['HOME']}/, '~').sub(%r{/([^/]+)\.#{NA.extension}$}, '/{xbw}\1{x}')}"
+      end
+
+      puts NA::Color.template(dirs.join("\n"))
+    end
+
     private
 
     ##
@@ -302,29 +379,26 @@ module NA
     ##                       between characters
     ##
     def match_working_dir(search, distance: 1)
-      optional = []
-      required = []
-
-      search&.each do |t|
-        # Make "search" into "s.{0,1}e.{0,1}a.{0,1}r.{0,1}c.{0,1}h"
-        new_rx = t[:token].to_s.split('').join(".{0,#{distance}}")
-
-        optional.push(new_rx)
-        required.push(new_rx) if t[:required]
-      end
+      search = search.map { |t| t[:token] }.join('/')
+      optional = [search]
+      required = [search]
 
-      match_dir(optional, required)
-    end
-
-    def match_dir(optional, required)
       file = database_path
       notify('{r}No na database found', exit_code: 1) unless File.exist?(file)
 
       dirs = IO.read(file).split("\n")
+
+      NA.notify("{bw}Directory regex: {x}#{required.map(&:dir_to_rx)}", debug: true)
+
       dirs.delete_if { |d| !d.dir_matches(any: optional, all: required) }
       dirs.sort.uniq
     end
 
+    ##
+    ## Save a todo file path to the database
+    ##
+    ## @param      todo_file  The todo file path
+    ##
     def save_working_dir(todo_file)
       file = database_path
       content = File.exist?(file) ? IO.read(file) : ''
@@ -334,6 +408,12 @@ module NA
       File.open(file, 'w') { |f| f.puts dirs.join("\n") }
     end
 
+    ##
+    ## macOS open command
+    ##
+    ## @param      file  The file
+    ## @param      app   The application
+    ##
     def darwin_open(file, app: nil)
       if app
         `open -a "#{app}" #{Shellwords.escape(file)}`
@@ -342,10 +422,20 @@ module NA
       end
     end
 
+    ##
+    ## Windows open command
+    ##
+    ## @param      file  The file
+    ##
     def win_open(file)
       `start #{Shellwords.escape(file)}`
     end
 
+    ##
+    ## Linux open command
+    ##
+    ## @param      file  The file
+    ##
     def linux_open(file)
       if TTY::Which.exist?('xdg-open')
         `xdg-open #{Shellwords.escape(file)}`

data/lib/na/string.rb

@@ -55,8 +55,8 @@ class ::String
     scan(/\e\[[\d;]+m/).join('').gsub(/\e\[0m/, '')
   end
 
-  def dir_to_rx
-    "#{split(%r{[/:]}).join('.*?/.*?')}[^/]+$"
+  def dir_to_rx(distance: 2)
+    "#{split(%r{[/:]}).map { |comp| comp.split('').join(".{0,#{distance}}") }.join('.*?/.*?')}[^/]+$"
   end
 
   def dir_matches(any: [], all: [])

data/lib/na/version.rb

@@ -1,3 +1,3 @@
 module Na
-  VERSION = '1.1.19'
+  VERSION = '1.1.21'
 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.18<!--END VER-->.
+The current version of `na` is <!--VER-->1.1.20<!--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. 
 
@@ -90,7 +90,7 @@ Unless `--exact` is specified, search is tokenized and combined with AND, so `na
 
 ##### next, show
 
-Examples: 
+Examples:
 
 - `na show` (list all next actions in the current directory)
 - `na show -d 3` (list all next actions in the current directory and look for additional files 3 levels deep from there)
@@ -107,7 +107,7 @@ Example: `na tagged feature +maybe`.
 Separate multiple tags with spaces or commas. By default tags are combined with AND, so actions matching all 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). When `+` and/or `!` are used, undecorated tokens become optional matches. Use `-v` to invert the search and display all actions that _don't_ match.
 
 ```
-@cli(bundle exec bin/na help tagged)
+@cli(bundle exec bin/na help show)
 ```
 
 ### Configuration

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: na
 version: !ruby/object:Gem::Version
-  version: 1.1.19
+  version: 1.1.21
 platform: ruby
 authors:
 - Brett Terpstra
@@ -178,6 +178,7 @@ extra_rdoc_files:
 - README.md
 - na.rdoc
 files:
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock