na 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5290fe44194d8eb6ff2b2f70631b3967578a19b50f2348ebd6ef49eeea59048c
-  data.tar.gz: f3f7dc1aaa95e528da23be7746ea9dd026e0b6d8f7ae1dd2252ce93cab204a32
+  metadata.gz: f9da419b49e24864d0adfc81fa3834c8920d482de91597124b3640b14d5fb0e6
+  data.tar.gz: ed6cb25a6889ff354baef255e7abeeb6a8ff13aee6907f84af5078c4aaee9954
 SHA512:
-  metadata.gz: 2ac4b5941f07ff5f45519d29b8f795b3e9f28aa23e7e602e7b01df51c60b411ae6085534c956ffb835197f5bf29b1028170c8b5fb72965350082a276a6892ab4
-  data.tar.gz: 5fe1d62fdbaeebefcdaee6d08d025b2abce25229115da812bed89f6ad67b8fc50847471f4f16c1930976236f9139791aa4a71a1fbc49617fcdf8ef5ccb128fb3
+  metadata.gz: 6e4c30403c700644291354a66cc542eb98545c429a843119083b2251535df823fce89f8b218e4fb8a778e6f07dac8b5d562a09df0c75569383798b5659489082
+  data.tar.gz: 59bee0616ecfa10cf204028776538cd0ec4cb268a5a903a3f16558a84b464824cd09c848098b5767c48e8c8e7d53273fd79773487857a5c18b0e7ee6e84461b9

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+### 1.0.4
+
+2022-09-28 01:18
+
+#### NEW
+
+- OS agnostic command to open todo file in an editor
+- `na init` command to generate a new todo file
+
+#### IMPROVED
+
+- Output formatting
+- Make directory matching fuzzy for `na next`
+- --verbose global switch to output debug info
+
 ### 1.0.3
 
 2022-09-27 14:30

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    na (1.0.2)
+    na (1.0.4)
       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.0.2.
+The current version of `na` is 1.0.3.
 
 `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. 
 
@@ -49,15 +49,11 @@ If you don't have Ruby/RubyGems, you can install them pretty easily with Homebre
 NAME
     na - Add and list next actions for the current project
 
-
 SYNOPSIS
     na [global options] command [command options] [arguments...]
 
-
 VERSION
-    1.0.2
-
-
+    1.0.4
 
 GLOBAL OPTIONS
     -a, --[no-]add          - Add a next action (deprecated, for backwards compatibility)
@@ -67,18 +63,19 @@ GLOBAL OPTIONS
     -n, --[no-]note         - Prompt for additional notes (deprecated, for backwards compatibility)
     --na_tag=TAG            - Tag to consider a next action (default: na)
     -p, --priority=PRIORITY - Set a priority 0-5 (deprecated, for backwards compatibility) (default: none)
-    -r, --[no-]recurse      - Recurse 3 directories deep (deprecated, for backwards compatability)
+    -r, --[no-]recurse      - Recurse 3 directories deep (deprecated, for backwards compatability) (default: enabled)
+    --[no-]verbose          - Display verbose output
     --version               - Display the program version
 
-
-
 COMMANDS
-    add        - Add a new next action
-    find       - Find actions matching a search pattern
-    help       - Shows a list of commands or help for one command
-    initconfig - Initialize the config file using current global options
-    next, show - Show next actions
-    tagged     - Find actions matching a tag
+    add          - Add a new next action
+    edit         - Open a todo file in the default editor
+    find         - Find actions matching a search pattern
+    help         - Shows a list of commands or help for one command
+    init, create - Create a new todo file in the current directory
+    initconfig   - Initialize the config file using current global options
+    next, show   - Show next actions
+    tagged       - Find actions matching a tag
 ```
 
 #### Commands
@@ -113,6 +110,34 @@ EXAMPLES
     na add "A bug I need to fix" -p 4 -n
 ```
 
+##### edit
+
+```
+NAME
+    edit - Open a todo file in the default editor
+
+SYNOPSIS
+
+    na [global options] edit [command options] 
+
+DESCRIPTION
+    Let the system choose the defualt, (e.g. TaskPaper), or specify a command line utility (e.g. vim).              If more than one todo file is found, a menu is displayed. 
+
+COMMAND OPTIONS
+    -a, --app=EDITOR    - Specify a Mac app (default: none)
+    -d, --depth=DEPTH   - Recurse to depth (default: 1)
+    -e, --editor=EDITOR - Specify an editor CLI (default: none)
+
+EXAMPLES
+
+    # Open the main todo file in the default editor
+    na edit
+
+    # Display a menu of all todo files three levels deep from the
+               current directory, open selection in vim.
+    na edit -d 3 -a vim
+```
+
 ##### find
 
 Example: `na find cool feature idea`
@@ -144,6 +169,25 @@ EXAMPLES
     na find -d 3 swift obj-c
 ```
 
+##### init, create
+
+```
+NAME
+    init - Create a new todo file in the current directory
+
+SYNOPSIS
+
+    na [global options] init [PROJECT]
+
+EXAMPLES
+
+    # Generate a new todo file, prompting for project name
+    na init
+
+    # Generate a new todo for a project called warpspeed
+    na init warpspeed
+```
+
 ##### next, show
 
 Examples: 

data/bin/na

@@ -47,12 +47,15 @@ class App
   default_value 1
   flag %i[d depth], type: :integer, must_match: /^\d+$/
 
+  desc 'Display verbose output'
+  switch %i[verbose]
+
   desc 'Show next actions'
   arg_name 'OPTIONAL_QUERY'
   command %i[next show] do |c|
     c.example 'doing next', desc: 'display the next actions from any todo files in the current directory'
-    c.example 'doing next -d 3', desc: 'display the next actions from the current directory and its children, 3 levels deep'
-
+    c.example 'doing next -d 3', desc: 'display the next actions from the current directory, traversing 3 levels deep'
+    c.example 'doing next marked', desc: 'display next actions for a project you visited in the past'
     c.desc 'Recurse to depth'
     c.arg_name 'DEPTH'
     c.flag %i[d depth], type: :integer, must_match: /^\d+$/
@@ -71,6 +74,11 @@ class App
         exit run(cmd)
       end
 
+      depth = if global_options[:recurse] && options[:depth].nil? && global_options[:depth] == 1
+                3
+              else
+                options[:depth].nil? ? global_options[:depth].to_i : options[:depth].to_i
+              end
 
       if args.count.positive?
         tokens = []
@@ -83,19 +91,14 @@ class App
         end
       end
 
-      depth = if global_options[:recurse] && options[:depth].nil? && global_options[:depth] == 1
-                3
-              else
-                options[:depth].nil? ? global_options[:depth].to_i : options[:depth].to_i
-              end
       tag = options[:tag] == global_options[:na_tag] ? nil : options[:tag]
-      actions = NA.parse_actions(depth: depth,
-                                 query: tokens,
-                                 extension: global_options[:ext],
-                                 na_tag: global_options[:na_tag],
-                                 tag: tag)
+      files, actions = NA.parse_actions(depth: depth,
+                                        query: tokens,
+                                        extension: global_options[:ext],
+                                        na_tag: global_options[:na_tag],
+                                        tag: tag)
 
-      NA.output_actions(actions, depth, global_options[:ext])
+      NA.output_actions(actions, depth, global_options[:ext], files: files)
     end
   end
 
@@ -232,23 +235,23 @@ class App
         end
       end
 
-      actions = NA.parse_actions(depth: depth,
-                                 extension: global_options[:ext],
-                                 na_tag: global_options[:na_tag],
-                                 search: tokens)
-      NA.output_actions(actions, depth, global_options[:ext])
+      files, actions = NA.parse_actions(depth: depth,
+                                        extension: global_options[:ext],
+                                        na_tag: global_options[:na_tag],
+                                        search: tokens)
+      NA.output_actions(actions, depth, global_options[:ext], files: files)
     end
   end
 
 
   desc 'Find actions matching a tag'
   long_desc 'Finds actions with tags matching the arguments. An action is shown if it
-  contains any of the tags listed. Add a + before a tag to make it required,
-  e.g. `na tagged feature +maybe`'
+  contains any of the tags listed. Add a + before a tag to make it required. You can specify values using TAG=VALUE pairs.'
   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 either @feature or @idea, recurse 3 levels'
+    c.example 'na tagged +priority=5', desc: 'Show actions with @priority(5)'
 
     c.desc 'Recurse to depth'
     c.arg_name 'DEPTH'
@@ -274,24 +277,89 @@ class App
                   })
       end
 
-      actions = NA.parse_actions(depth: depth,
-                                 extension: global_options[:ext],
-                                 na_tag: global_options[:na_tag],
-                                 tag: tags)
-      NA.output_actions(actions, depth, global_options[:ext])
+      files, actions = NA.parse_actions(depth: depth,
+                                        extension: global_options[:ext],
+                                        na_tag: global_options[:na_tag],
+                                        tag: tags)
+      NA.output_actions(actions, depth, global_options[:ext], files: files)
+    end
+  end
+
+  desc 'Create a new todo file in the current directory'
+  arg_name '[PROJECT]'
+  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'
+
+    c.action do |global_options, _, args|
+      reader = TTY::Reader.new
+      if args.count.positive?
+        project = args.join(' ')
+      else
+        project = File.expand_path('.').split('/').last
+        project = reader.read_line(NA::Color.template('{y}Project name {bw}> {x}'), value: project).strip
+      end
+
+      target = "#{project}.#{global_options[:ext]}"
+
+      if File.exist?(target)
+        print NA::Color.template("{r}File {bw}#{target}{r} already exists, overwrite it? {br}y{w}/{bg}N{x} ")
+        res = reader.read_char
+        Process.exit 1 unless res =~ /y/i
+      end
+
+      NA.create_todo(target, project)
+    end
+  end
+
+  desc 'Open a todo file in the default editor'
+  long_desc 'Let the system choose the defualt, (e.g. TaskPaper), or specify a command line utility (e.g. vim).
+             If more than one todo file is found, a menu is displayed.'
+  command %i[edit] do |c|
+    c.example 'na edit', desc: 'Open the main todo file in the default editor'
+    c.example 'na edit -d 3 -a vim', desc: 'Display a menu of all todo files three levels deep from the
+               current directory, open selection in vim.'
+
+    c.desc 'Recurse to depth'
+    c.arg_name 'DEPTH'
+    c.default_value 1
+    c.flag %i[d depth], type: :integer, must_match: /^\d+$/
+
+    c.desc 'Specify an editor CLI'
+    c.arg_name 'EDITOR'
+    c.flag %i[e editor]
+
+    c.desc 'Specify a Mac app'
+    c.arg_name 'EDITOR'
+    c.flag %i[a app]
+
+    c.action do |global_options, options, args|
+      depth = if global_options[:recurse] && options[:depth].nil? && global_options[:depth] == 1
+                3
+              else
+                options[:depth].nil? ? global_options[:depth].to_i : options[:depth].to_i
+              end
+      files = NA.find_files(depth: depth, extension: global_options[:ext])
+      file = if files.count > 1
+               NA.select_file(files)
+             else
+               files[0]
+             end
+
+      if options[:editor]
+        system %(#{options[:editor]} "#{file}")
+      else
+        NA.edit_file(file: file, app: options[:app])
+      end
     end
   end
 
-  pre do |global,command,options,args|
-    # Pre logic here
-    # Return true to proceed; false to abort and not call the
-    # chosen command
-    # Use skips_pre before a command to skip this block
-    # on that command only
+  pre do |global, command, options, args|
+    NA.verbose = global[:verbose]
     true
   end
 
-  post do |global,command,options,args|
+  post do |global, command, options, args|
     # Post logic here
     # Use skips_post before a command to skip this
     # block on that command only

data/lib/na/action.rb

@@ -44,17 +44,24 @@ module NA
         parents = @parent.map do |par|
           NA::Color.template("#{template[:parent]}#{par}")
         end.join(NA::Color.template(template[:parent_divider]))
-        parents = "#{parents} "
+        parents = "{dc}[{x}#{parents}{dc}]{x} "
       else
         parents = ''
       end
 
       project = NA::Color.template("#{template[:project]}#{@project}{x} ")
 
-      filename = NA::Color.template("#{template[:file]}#{@file.sub(/^\.\//, '').sub(/\.#{extension}$/, '')} {x}")
+      file = @file.sub(%r{^\./}, '').sub(/#{ENV['HOME']}/, '~')
+      file = file.sub(/\.#{extension}$/, '')
+      file = file.sub(/#{File.basename(@file, ".#{extension}")}$/, "{dw}#{File.basename(@file, ".#{extension}")}{x}")
+      file_tpl = "#{template[:file]}#{file} {x}"
+      filename = NA::Color.template(file_tpl)
 
       action = NA::Color.template("#{template[:action]}#{@action}{x}")
-      action = action.highlight_tags(color: template[:tags], parens: template[:value_parens], value: template[:values], last_color: template[:action])
+      action = action.highlight_tags(color: template[:tags],
+                                     parens: template[:value_parens],
+                                     value: template[:values],
+                                     last_color: template[:action])
 
       NA::Color.template(template[:output].gsub(/%filename/, filename)
                           .gsub(/%project/, project)

data/lib/na/next_action.rb

@@ -3,20 +3,22 @@
 # Next Action methods
 module NA
   class << self
+    attr_accessor :verbose
+
     def create_todo(target, basename)
       File.open(target, 'w') do |f|
         content = <<~ENDCONTENT
-        Inbox: @inbox
-        #{basename}:
-        \tNew Features:
-        \tIdeas:
-        \tBugs:
-        Archive:
-        Search Definitions:
-        \tTop Priority @search(@priority = 5 and not @done)
-        \tHigh Priority @search(@priority > 3 and not @done)
-        \tMaybe @search(@maybe)
-        \tNext @search(@na and not @done and not project = \"Archive\")
+          Inbox: @inbox
+          #{basename}:
+          \tFeature Requests:
+          \tIdeas:
+          \tBugs:
+          Archive:
+          Search Definitions:
+          \tTop Priority @search(@priority = 5 and not @done)
+          \tHigh Priority @search(@priority > 3 and not @done)
+          \tMaybe @search(@maybe)
+          \tNext @search(@na and not @done and not project = \"Archive\")
         ENDCONTENT
         f.puts(content)
       end
@@ -70,8 +72,14 @@ module NA
       puts NA::Color.template("{by}Task added to {bw}#{file}{x}")
     end
 
-    def output_actions(actions, depth, extension)
-      template = if NA.find_files(depth: depth, extension: extension).count > 1
+    def output_actions(actions, depth, extension, files: nil)
+      template = if files&.count.positive?
+                   if files.count == 1
+                     '%parent%action'
+                   else
+                     '%filename%parent%action'
+                   end
+                 elsif NA.find_files(depth: depth, extension: extension).count > 1
                    if depth > 1
                      '%filename%parent%action'
                    else
@@ -80,6 +88,10 @@ module NA
                  else
                    '%parent%action'
                  end
+      if files && @verbose
+        puts files.map { |f| NA::Color.template("{dw}#{f}{x}") }
+      end
+
       puts actions.map { |action| action.pretty(template: { output: template }) }
     end
 
@@ -150,7 +162,7 @@ module NA
           end
         end
       end
-      actions
+      [files, actions]
     end
 
     ##
@@ -184,20 +196,25 @@ module NA
       res
     end
 
+    def database_path
+      db_dir = File.expand_path('~/.local/share/na')
+      FileUtils.mkdir_p(db_dir) unless File.directory?(db_dir)
+      db_file = 'tdlist.txt'
+      File.join(db_dir, db_file)
+    end
+
     def match_working_dir(search)
       optional = []
       required = []
 
       search&.each do |t|
-        new_rx = t[:token].to_s
+        new_rx = t[:token].to_s.split('').join('.{0,1}')
 
         optional.push(new_rx)
         required.push(new_rx) if t[:required]
       end
 
-      db_dir = File.expand_path('~/.local/share/na')
-      db_file = 'tdlist.txt'
-      file = File.join(db_dir, db_file)
+      file = database_path
       if File.exist?(file)
         dirs = IO.read(file).split("\n")
         dirs.delete_if { |d| !d.matches(any: optional, all: required) }
@@ -209,10 +226,7 @@ module NA
     end
 
     def save_working_dir(todo_file)
-      db_dir = File.expand_path('~/.local/share/na')
-      FileUtils.mkdir_p(db_dir) unless File.directory?(db_dir)
-      db_file = 'tdlist.txt'
-      file = File.join(db_dir, db_file)
+      file = database_path
       content = File.exist?(file) ? IO.read(file) : ''
       dirs = content.split(/\n/)
       dirs.push(File.expand_path(todo_file))
@@ -230,5 +244,34 @@ module NA
         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
+
+    ##
+    ## 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
+        if app
+          `open -a "#{app}" #{Shellwords.escape(file)}`
+        else
+          `open #{Shellwords.escape(file)}`
+        end
+      when /mingw|mswin/i
+        `start #{Shellwords.escape(file)}`
+      else
+        if 'xdg-open'.available?
+          `xdg-open #{Shellwords.escape(file)}`
+        else
+          puts NA::Color.template('{r}Unable to determine executable for `open`.{x}')
+        end
+      end
+    end
   end
 end

data/lib/na/version.rb

@@ -1,3 +1,3 @@
 module Na
-  VERSION = '1.0.3'
+  VERSION = '1.0.4'
 end

data/scripts/fixreadme.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-current_ver = ARGV[0]
+current_ver = `git ver`
 src = 'src/README.md'
 dest = 'README.md'
 

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.0.2<!--END VER-->.
+The current version of `na` is <!--VER-->1.0.3<!--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. 
 
@@ -49,15 +49,11 @@ If you don't have Ruby/RubyGems, you can install them pretty easily with Homebre
 NAME
     na - Add and list next actions for the current project
 
-
 SYNOPSIS
     na [global options] command [command options] [arguments...]
 
-
 VERSION
-    1.0.2
-
-
+    1.0.4
 
 GLOBAL OPTIONS
     -a, --[no-]add          - Add a next action (deprecated, for backwards compatibility)
@@ -67,18 +63,19 @@ GLOBAL OPTIONS
     -n, --[no-]note         - Prompt for additional notes (deprecated, for backwards compatibility)
     --na_tag=TAG            - Tag to consider a next action (default: na)
     -p, --priority=PRIORITY - Set a priority 0-5 (deprecated, for backwards compatibility) (default: none)
-    -r, --[no-]recurse      - Recurse 3 directories deep (deprecated, for backwards compatability)
+    -r, --[no-]recurse      - Recurse 3 directories deep (deprecated, for backwards compatability) (default: enabled)
+    --[no-]verbose          - Display verbose output
     --version               - Display the program version
 
-
-
 COMMANDS
-    add        - Add a new next action
-    find       - Find actions matching a search pattern
-    help       - Shows a list of commands or help for one command
-    initconfig - Initialize the config file using current global options
-    next, show - Show next actions
-    tagged     - Find actions matching a tag
+    add          - Add a new next action
+    edit         - Open a todo file in the default editor
+    find         - Find actions matching a search pattern
+    help         - Shows a list of commands or help for one command
+    init, create - Create a new todo file in the current directory
+    initconfig   - Initialize the config file using current global options
+    next, show   - Show next actions
+    tagged       - Find actions matching a tag
 ```
 
 #### Commands
@@ -113,6 +110,34 @@ EXAMPLES
     na add "A bug I need to fix" -p 4 -n
 ```
 
+##### edit
+
+```
+NAME
+    edit - Open a todo file in the default editor
+
+SYNOPSIS
+
+    na [global options] edit [command options] 
+
+DESCRIPTION
+    Let the system choose the defualt, (e.g. TaskPaper), or specify a command line utility (e.g. vim).              If more than one todo file is found, a menu is displayed. 
+
+COMMAND OPTIONS
+    -a, --app=EDITOR    - Specify a Mac app (default: none)
+    -d, --depth=DEPTH   - Recurse to depth (default: 1)
+    -e, --editor=EDITOR - Specify an editor CLI (default: none)
+
+EXAMPLES
+
+    # Open the main todo file in the default editor
+    na edit
+
+    # Display a menu of all todo files three levels deep from the
+               current directory, open selection in vim.
+    na edit -d 3 -a vim
+```
+
 ##### find
 
 Example: `na find cool feature idea`
@@ -144,6 +169,25 @@ EXAMPLES
     na find -d 3 swift obj-c
 ```
 
+##### init, create
+
+```
+NAME
+    init - Create a new todo file in the current directory
+
+SYNOPSIS
+
+    na [global options] init [PROJECT]
+
+EXAMPLES
+
+    # Generate a new todo file, prompting for project name
+    na init
+
+    # Generate a new todo for a project called warpspeed
+    na init warpspeed
+```
+
 ##### next, show
 
 Examples: 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: na
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-27 00:00:00.000000000 Z
+date: 2022-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake