na 1.1.9 → 1.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1c1a61c33eaccbf930903d5adbc75fd4ef717b31bdb21539240535d03b71922
-  data.tar.gz: 1c1067564d9e0e8452512cf146ff9443ecc8a61456ed1d1d46dc5a76c5cf2280
+  metadata.gz: b309ba145cf0859f1a9011cf62268261766338d79cb956810fab9c64863c37f2
+  data.tar.gz: 6fc7e065d4d85bf70b9122634414274e6a44d640ffffeeee7409e9102115f11d
 SHA512:
-  metadata.gz: a39268399afd4fdb653b5578f729967fca4c4313b1c0698e42b714d775257cbdae511380c895066ef7a399dc0637f806cc6890d6664919244cbacbca23a2182b
-  data.tar.gz: 7cc6f8938f297e23352d9b5d5bdfa6d3727d316cd6508dc29cf829e8a68939c30964e40036e04624921e157ccbcc45df2e71fd426a06d1e80d59cdcd8b80d98a
+  metadata.gz: 63ee0b1ac9370533379956e8cd5f6571c8d39731c12c02404b2912d5cb97f49d32c988e4d23c12c50d1b2080412296bc58351680122abd26281580c49d93f722
+  data.tar.gz: b7500123c7ea092acc42ccba0873942fe871bd201405e3ef2faa66f3d155c3d0ac60b530078d962114a4d0d66bdb8ea427b1452873c14e2b06419cb2675e822e

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+### 1.1.11
+
+2022-10-05 08:56
+
+#### IMPROVED
+
+- Respect na_tag setting when creating new todo file
+- Code cleanup
+
+### 1.1.10
+
+2022-10-05 08:19
+
+#### FIXED
+
+- When adding a project, don't use Ruby #capitalize, which downcases the rest of the project name
+
 ### 1.1.9
 
 2022-10-03 12:08

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    na (1.1.9)
+    na (1.1.11)
       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.9
+The current version of `na` is 1.1.11
 .
 
 `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 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`. It will always look for the shortest match.
 
 #### Recursion
 

data/bin/na

@@ -1,8 +1,11 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift File.join(__dir__, '..', 'lib')
 require 'gli'
 require 'na'
 
+# Main application
 class App
   extend GLI::App
 
@@ -123,7 +126,7 @@ class App
 
     c.desc 'Add action to specific project'
     c.default_value 'Inbox'
-    c.flag %[to]
+    c.flag %i[to]
 
     c.desc 'Use a tag other than the default next action tag'
     c.arg_name 'TAG'
@@ -136,7 +139,7 @@ class App
     c.arg_name 'PATH'
     c.flag %i[f file]
 
-    c.action do |global_options, options, args|
+    c.action do |_global_options, options, args|
       reader = TTY::Reader.new
       action = if args.count.positive?
                  args.join(' ').strip
@@ -168,7 +171,10 @@ class App
 
       note = if options[:note]
                if TTY::Which.exist?('gum')
-                 `gum write --placeholder "Enter a note, CTRL-d to save" --width $(tput cols) --char-limit 0`.strip.split("\n")
+                 args = ['--placeholder "Enter a note, CTRL-d to save"']
+                 args << '--char-limit 0'
+                 args << '--width $(tput cols)'
+                 `gum write #{args.join(' ')}`.strip.split("\n")
                else
                  puts NA::Color.template('{bm}Enter a note, {bw}CTRL-d{bm} to end editing{bw}')
                  reader.read_multiline
@@ -190,7 +196,7 @@ class App
         end
       else
         files = NA.find_files(depth: 1)
-        if files.count == 0
+        if files.count.zero?
           print NA::Color.template('{by}No todo file found, create one? {w}(y/{g}N{w}){x} ')
           res = reader.read_char
           if res =~ /y/i
@@ -256,10 +262,10 @@ class App
     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. You can specify values using TAG=VALUE pairs.'
+             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'
@@ -304,7 +310,7 @@ class App
     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|
+    c.action do |_global_options, _options, args|
       reader = TTY::Reader.new
       if args.count.positive?
         project = args.join(' ')
@@ -346,7 +352,7 @@ class App
     c.arg_name 'EDITOR'
     c.flag %i[a app]
 
-    c.action do |global_options, options, args|
+    c.action do |global_options, options, _args|
       depth = if global_options[:recurse] && options[:depth].nil? && global_options[:depth] == 1
                 3
               else
@@ -371,15 +377,16 @@ class App
   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.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.command %i[show] do |s|
-      s.action do |global_options, options, args|
-        if args.count.positive?
-          shell = args[0]
-        else
-          shell = File.basename(ENV['SHELL'])
-        end
+      s.action do |_global_options, _options, args|
+        shell = if args.count.positive?
+                  args[0]
+                else
+                  File.basename(ENV['SHELL'])
+                end
 
         case shell
         when /^f/i
@@ -395,12 +402,12 @@ class App
     c.desc 'Install the hook for the current shell to the appropriate startup file.'
     c.arg_name '[SHELL]'
     c.command %i[install] do |s|
-      s.action do |global_options, options, args|
-        if args.count.positive?
-          shell = args[0]
-        else
-          shell = File.basename(ENV['SHELL'])
-        end
+      s.action do |_global_options, _options, args|
+        shell = if args.count.positive?
+                  args[0]
+                else
+                  File.basename(ENV['SHELL'])
+                end
 
         case shell
         when /^f/i
@@ -414,7 +421,7 @@ class App
     end
   end
 
-  pre do |global, command, options, args|
+  pre do |global, _command, _options, _args|
     NA.verbose = global[:debug]
     NA.extension = global[:ext]
     NA.na_tag = global[:na_tag]
@@ -432,9 +439,7 @@ class App
     case exception
     when GLI::UnknownCommand
       cmd = ['add']
-      if ARGV.count.positive?
-        cmd.concat(ARGV.unshift($first_arg))
-      end
+      cmd.concat(ARGV.unshift($first_arg)) if ARGV.count.positive?
 
       exit run(cmd)
     when SystemExit

data/lib/na/next_action.rb

@@ -5,10 +5,17 @@ module NA
   class << self
     attr_accessor :verbose, :extension, :na_tag
 
+    def notify(msg, exit_code: false)
+      $stderr.puts NA::Color.template("{x}#{msg}{x}")
+      if exit_code && exit_code.is_a?(Number)
+        Process.exit exit_code
+      end
+    end
+
     def create_todo(target, basename)
       File.open(target, 'w') do |f|
         content = <<~ENDCONTENT
-          Inbox: @inbox
+          Inbox:
           #{basename}:
           \tFeature Requests:
           \tIdeas:
@@ -18,11 +25,11 @@ module NA
           \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\")
+          \tNext @search(@#{NA.na_tag} and not @done and not project = \"Archive\")
         ENDCONTENT
         f.puts(content)
       end
-      $stderr.puts NA::Color.template("{y}Created {bw}#{target}{x}")
+      notify("{y}Created {bw}#{target}")
     end
 
     def find_files(depth: 1)
@@ -41,8 +48,7 @@ module NA
       elsif TTY::Which.exist?('fzf')
         res = choose_from(files, prompt: 'Use which file?')
         unless res
-          $stderr.puts 'No file selected, cancelled'
-          Process.exit 1
+          notify('{r}No file selected, cancelled', exit_code: 1)
         end
 
         res.strip
@@ -60,18 +66,18 @@ module NA
     def add_action(file, project, action, note = nil)
       content = IO.read(file)
       unless content =~ /^[ \t]*#{project}:/i
-        content = "#{project.capitalize}:\n#{content}"
+        content = "#{project.cap_first}:\n#{content}"
       end
 
       content.sub!(/^([ \t]*)#{project}:(.*?)$/i) do
         m = Regexp.last_match
         note = note.nil? ? '' : "\n#{m[1]}\t\t#{note.join('').strip}"
-        "#{m[1]}#{project.capitalize}:#{m[2]}\n#{m[1]}\t- #{action}#{note}"
+        "#{m[1]}#{project.cap_first}:#{m[2]}\n#{m[1]}\t- #{action}#{note}"
       end
 
       File.open(file, 'w') { |f| f.puts content }
 
-      $stderr.puts NA::Color.template("{by}Task added to {bw}#{file}{x}")
+      notify("{by}Task added to {bw}#{file}")
     end
 
     def output_actions(actions, depth, files: nil)
@@ -91,7 +97,7 @@ module NA
                    '%parent%action'
                  end
       if files && @verbose
-        $stderr.puts files.map { |f| NA::Color.template("{dw}#{f}{x}") }
+        files.map { |f| notify("{dw}#{f}") }
       end
 
       puts actions.map { |action| action.pretty(template: { output: template }) }
@@ -188,11 +194,7 @@ module NA
     def choose_from(options, prompt: 'Make a selection: ', multiple: false, sorted: true, fzf_args: [])
       return nil unless $stdout.isatty
 
-      # fzf_args << '-1' # User is expecting a menu, and even if only one it seves as confirmation
-      default_args = []
-      default_args << %(--prompt="#{prompt}")
-      default_args << "--height=#{options.count + 2}"
-      default_args << '--info=inline'
+      default_args = [%(--prompt="#{prompt}"), "--height=#{options.count + 2}", '--info=inline']
       default_args << '--multi' if multiple
       header = "esc: cancel,#{multiple ? ' tab: multi-select, ctrl-a: select all,' : ''} return: confirm"
       default_args << %(--header="#{header}")
@@ -205,33 +207,50 @@ module NA
       res
     end
 
+    ##
+    ## Get path to database of known todo files
+    ##
+    ## @return     [String] File path
+    ##
     def database_path
       db_dir = File.expand_path('~/.local/share/na')
+      # Create directory if needed
       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)
+    ##
+    ## Find a matching path using semi-fuzzy matching.
+    ## Search tokens can include ! and + to negate or make
+    ## required.
+    ##
+    ## @param      search    [Array] search tokens to match
+    ## @param      distance  [Integer] allowed distance
+    ##                       between characters
+    ##
+    def match_working_dir(search, distance: 1)
       optional = []
       required = []
 
       search&.each do |t|
-        new_rx = t[:token].to_s.split('').join('.{0,1}')
+        # 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
 
+      match_dir(optional, required)
+    end
+
+    def match_dir(optional, required)
       file = database_path
-      if File.exist?(file)
-        dirs = IO.read(file).split("\n")
-        dirs.delete_if { |d| !d.matches(any: optional, all: required) }
-        dirs.sort.uniq
-      else
-        $stderr.puts NA::Color.template('{r}No na database found{x}')
-        Process.exit 1
-      end
+      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.sort.uniq
     end
 
     def save_working_dir(todo_file)
@@ -258,6 +277,26 @@ module NA
       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)}`
+      else
+        `open #{Shellwords.escape(file)}`
+      end
+    end
+
+    def win_open(file)
+      `start #{Shellwords.escape(file)}`
+    end
+
+    def linux_open(file)
+      if TTY::Which.exist?('xdg-open')
+        `xdg-open #{Shellwords.escape(file)}`
+      else
+        notify('{r}Unable to determine executable for `xdg-open`.')
+      end
+    end
+
     ##
     ## Platform-agnostic open command
     ##
@@ -267,19 +306,11 @@ module NA
       os = RbConfig::CONFIG['target_os']
       case os
       when /darwin.*/i
-        if app
-          `open -a "#{app}" #{Shellwords.escape(file)}`
-        else
-          `open #{Shellwords.escape(file)}`
-        end
+        darwin_open(file, app: app)
       when /mingw|mswin/i
-        `start #{Shellwords.escape(file)}`
+        win_open(file)
       else
-        if 'xdg-open'.available?
-          `xdg-open #{Shellwords.escape(file)}`
-        else
-          $stderr.puts NA::Color.template('{r}Unable to determine executable for `open`.{x}')
-        end
+        linux_open(file)
       end
     end
   end

data/lib/na/string.rb

@@ -48,4 +48,15 @@ class ::String
     end
     true
   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.9'
+  VERSION = '1.1.11'
 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.8<!--END VER-->.
+The current version of `na` is <!--VER-->1.1.10<!--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 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`. It will always look for the shortest match.
 
 #### Recursion
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: na
 version: !ruby/object:Gem::Version
-  version: 1.1.9
+  version: 1.1.11
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-03 00:00:00.000000000 Z
+date: 2022-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake