na 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4841ea0f17ec2751c09ae7277fa773dd0730a9055eaae68389f4651b606f5fc6
-  data.tar.gz: 3d056faf540401934754cac051bd29f75c8c851607731d5f16bd937baa8e0968
+  metadata.gz: 17064787b8afa01f88d01971b93f9f28593f40666ff8c2d49ecd52dff678654c
+  data.tar.gz: f14105b3e652e320b91022a6d4fb6c8cafc0811e6bbc5f7a0888b915e1ba1f99
 SHA512:
-  metadata.gz: 612464ec3687922763b9469a65f32b6773dfdc1a98f965f8c3b2f16ba3709c7972fe4771f6c68e5bff3506d329e9e39c4fe1f3bb2257aa2b09dbe06f0389cb85
-  data.tar.gz: 4e770547abaa252ef7f5b4a691476b1f6c48eb8d9d6304bbf408c12d741ea606d70f7d5331dc8943f445a25622127358fbd96fd03c12bfbaec0384ba4e841943
+  metadata.gz: e01fa0fc9027be241d59414d555661df5f1794db2b30fa969562f7db08f22ae1abcd4289f69178a839cb18f4077213b3ae4ee106a776325016633af9f4c6cf12
+  data.tar.gz: a13918d2f66aba2b5d84622e33bb60d9404c0795b5ad6c0badcee1ea3e6fe523168d8bdcb46bc45b2fb15df7a62cc54e5f630c9f7c01929982b09fc25b60da79

data/CHANGELOG.md

@@ -1,7 +1,28 @@
+### 1.0.2
+
+2022-09-27 14:18
+
+#### IMPROVED
+
+- When using gum input, make the input field the width of the terminal
+
+#### FIXED
+
+- -a with no arguments will work for backward compatability
+
+### 1.0.1
+
+2022-09-27 12:52
+
+#### NEW
+
+- Add arguments to `na next` to query previously-seen na files in other directories
+
 ### 1.0.0
 
 2022-09-27 10:45
 
 #### IMPROVED
 
+- Initial rewrite from Bash script to Ruby gem
 - Backwards compatibility with the Bash version of NA

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    na (1.0.1)
+    na (1.0.2)
       gli (~> 2.21.0)
       tty-reader (~> 0.9, >= 0.9.0)
+      tty-screen (~> 0.8, >= 0.8.1)
       tty-which (~> 0.5, >= 0.5.0)
 
 GEM

data/README.md

@@ -1,19 +1,17 @@
 # na
 
-[![Gem](https://img.shields.io/gem/v/doing.svg)](https://rubygems.org/gems/na)
-[![Travis](https://app.travis-ci.com/ttscoff/doing.svg?branch=master)](https://travis-ci.org/makenew/na_gem)
-[![GitHub license](https://img.shields.io/github/license/ttscoff/doing.svg)](./LICENSE.txt)
+[![Gem](https://img.shields.io/gem/v/na.svg)](https://rubygems.org/gems/na)
+[![Travis](https://app.travis-ci.com/ttscoff/na_gem.svg?branch=main)](https://travis-ci.org/makenew/na_gem)
+[![GitHub license](https://img.shields.io/github/license/ttscoff/na_gem.svg)](./LICENSE.txt)
 
 **A command line tool for adding and listing per-project todos.**
 
 _If you're one of the rare people like me who find this useful, feel free to
 [buy me some coffee][donate]._
 
-<!--README-->
+The current version of `na` is 1.0.1.
 
-The current version of `na` is <!--VER-->1.0.0<!--END VER-->.
-
-`na` 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. 
+`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. 
 
 Used with Taskpaper files, it can add new todo items quickly from the command line, automatically tagging them as next actions.
 
@@ -39,11 +37,28 @@ If found, it will try to locate an `Inbox:` project, or create one if it doesn't
 
 ### Installation
 
-Just run `gem install na`. If you run into errors, use `sudo gem install na`.
+Assuming you have Ruby and RubyGems installed, you can just run `gem install na`. If you run into errors, use `sudo gem install na`.
+
+If you don't have Ruby/RubyGems, you can install them pretty easily with Homebrew, rvm, or asdf. I can't swear this tool is worth the time, but there _are_ a lot of great gems available...
+
+
 
 ### Usage
 
 ```
+NAME
+    na - Add and list next actions for the current project
+
+
+SYNOPSIS
+    na [global options] command [command options] [arguments...]
+
+
+VERSION
+    1.0.2
+
+
+
 GLOBAL OPTIONS
     -a, --[no-]add          - Add a next action (deprecated, for backwards compatibility)
     -d, --depth=DEPTH       - Recurse to depth (default: 1)
@@ -80,12 +95,22 @@ SYNOPSIS
 
     na [global options] add [command options] TASK
 
+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. 
 
 COMMAND OPTIONS
     -f, --file=PATH    - Specify the file to which the task should be added (default: none)
     -n, --[no-]note    - Prompt for additional notes
     -p, --priority=arg - Add a priority level 1-5 (default: 0)
     -t, --tag=TAG      - Use a tag other than the default next action tag (default: none)
+
+EXAMPLES
+
+    # Add a new action to the Inbox, including a tag
+    na add "A cool feature I thought of @idea"
+
+    # Add a new action to the Inbox, set its @priority to 4, and prompt for an additional note
+    na add "A bug I need to fix" -p 4 -n
 ```
 
 ##### find
@@ -100,17 +125,23 @@ SYNOPSIS
 
     na [global options] find [command options] PATTERN
 
-
-
 DESCRIPTION
-    Search tokens are separated by spaces. Actions matching any token in the pattern will be shown (partial matches allowed). Add a +
-    before a token to make it required, e.g. `na find +feature +maybe`
-
-
+    Search tokens are separated by spaces. Actions matching any token in the pattern will be shown   (partial matches allowed). Add a + before a token to make it required, e.g. `na find +feature +maybe` 
 
 COMMAND OPTIONS
     -d, --depth=DEPTH - Recurse to depth (default: 1)
     -x, --[no-]exact  - Match pattern exactly
+
+EXAMPLES
+
+    # Find all actions containing feature, idea, and swift
+    na find feature +idea +swift
+
+    # Find all actions containing the exact text "feature idea"
+    na find -x feature idea
+
+    # Find all actions 3 directories deep containing either swift or obj-c
+    na find -d 3 swift obj-c
 ```
 
 ##### next, show
@@ -129,10 +160,17 @@ SYNOPSIS
 
     na [global options] next [command options] OPTIONAL_QUERY
 
-
 COMMAND OPTIONS
     -d, --depth=DEPTH - Recurse to depth (default: none)
     -t, --tag=arg     - Alternate tag to search for (default: na)
+
+EXAMPLES
+
+    # display the next actions from any todo files in the current directory
+    doing next
+
+    # display the next actions from the current directory and its children, 3 levels deep
+    doing next -d 3
 ```
 
 ##### tagged
@@ -147,16 +185,19 @@ SYNOPSIS
 
     na [global options] tagged [command options] TAG [VALUE]
 
-
-
 DESCRIPTION
-    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`
-
-
+    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` 
 
 COMMAND OPTIONS
     -d, --depth=DEPTH - Recurse to depth (default: 1)
+
+EXAMPLES
+
+    # Show all actions tagged @maybe
+    na tagged +maybe
+
+    # Show all actions tagged either @feature or @idea, recurse 3 levels
+    na tagged -d 3 feature idea
 ```
 
 ### Configuration
@@ -165,6 +206,26 @@ Global options such as todo extension and default next action tag can be stored
 
 Example: `na --ext md --na_tag next initconfig --force`
 
+When this command is run, it doesn't include options for subcommands, but inserts placeholders for them. If you want to permanently set an option for a subcommand, you'll need to edit `~/.na.rc`. For example, if you wanted the `next` command to always recurse 2 levels deep, you could edit it to look like this:
+
+```yaml
+---
+:ext: taskpaper
+:na_tag: na
+:d: 1
+commands:
+  :next:
+    :depth: 2
+  :add: {}
+  :find: {}
+  :tagged: {}
+```
+
+Note that I created a new YAML dictionary inside of the `:next:` command, and added a `:depth:` key that matches the setting I want to make permanent.
+
+> **WARNING** Don't touch most of the settings at the top of the auto-generated file. Setting any of them to true will alter the way na interprets the commands you're running. Most of those options are there for backwards compatibility with the bash version of this tool and will eventually be removed.
+
+
 ### Prompt Hooks
 
 You can add a prompt command to your shell to have na automatically list your next actions when you `cd` into a directory. Add the appropriate command to your login file for your shell:
@@ -208,10 +269,4 @@ If you have [gum][] installed, na will use it for command line input when adding
 [donate]: http://brettterpstra.com/donate/
 [github]: https://github.com/ttscoff/na_gem/
 
-<!--END README-->
-
 PayPal link: [paypal.me/ttscoff](https://paypal.me/ttscoff)
-
-## Changelog
-
-See [CHANGELOG.md](https://github.com/ttscoff/na_gem/blob/master/CHANGELOG.md)

data/bin/na

@@ -50,6 +50,9 @@ class App
   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.desc 'Recurse to depth'
     c.arg_name 'DEPTH'
     c.flag %i[d depth], type: :integer, must_match: /^\d+$/
@@ -63,8 +66,8 @@ class App
         cmd = ['add']
         cmd.push('--note') if global_options[:note]
         cmd.concat(['--priority', global_options[:priority]]) if global_options[:priority]
-        cmd.push(ARGV.unshift(@command))
-        p cmd
+        cmd.push(ARGV.unshift($first_arg)) if ARGV.count.positive?
+
         exit run(cmd)
       end
 
@@ -97,8 +100,17 @@ 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.
+
+  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 'TASK'
   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'
+    c.example 'na add "A bug I need to fix" -p 4 -n',
+              desc: 'Add a new action to the Inbox, set its @priority to 4, and prompt for an additional note'
+
     c.desc 'Prompt for additional notes'
     c.switch %i[n note]
 
@@ -118,7 +130,7 @@ class App
       action = if args.count.positive?
                  args.join(' ').strip
                elsif TTY::Which.exist?('gum')
-                 `gum input --placeholder "Enter a task"`.strip
+                 `gum input --placeholder "Enter a task" --char-limit=500 --width=#{TTY::Screen.columns}`.strip
                else
                  puts NA::Color.template('{bm}Enter task:{x}')
                  reader.read_line(NA::Color.template('{by}> {bw}')).strip
@@ -178,7 +190,7 @@ class App
         end
       end
 
-      save_working_dir(File.expand_path(target))
+      NA.save_working_dir(File.expand_path(target))
       NA.add_action(target, action, note)
     end
   end
@@ -188,6 +200,10 @@ class App
   (partial matches allowed). Add a + before a token to make it required, e.g. `na find +feature +maybe`'
   arg_name 'PATTERN'
   command %i[find] do |c|
+    c.example 'na find feature +idea +swift', desc: 'Find all actions containing feature, idea, and swift'
+    c.example 'na find -x feature idea', desc: 'Find all actions containing the exact text "feature idea"'
+    c.example 'na find -d 3 swift obj-c', desc: 'Find all actions 3 directories deep containing either swift or obj-c'
+
     c.desc 'Match pattern exactly'
     c.switch %i[x exact]
 
@@ -231,6 +247,9 @@ class App
   e.g. `na tagged feature +maybe`'
   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.desc 'Recurse to depth'
     c.arg_name 'DEPTH'
     c.default_value 1
@@ -285,7 +304,7 @@ class App
       if ARGV.count.positive?
         cmd.concat(ARGV.unshift($first_arg))
       end
-      p cmd
+
       exit run(cmd)
     when SystemExit
       false

data/lib/na/version.rb

@@ -1,3 +1,3 @@
 module Na
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

data/lib/na.rb

@@ -4,6 +4,7 @@ require 'na/version.rb'
 # you just need to require this one file in your bin file
 require 'fileutils'
 require 'shellwords'
+require 'tty-screen'
 require 'tty-reader'
 require 'tty-which'
 require 'na/colors.rb'

data/na.gemspec

@@ -5,16 +5,21 @@ spec = Gem::Specification.new do |s|
   s.version = Na::VERSION
   s.author = 'Brett Terpstra'
   s.email = 'me@brettterpstra.com'
-  s.homepage = 'https://brettterpstra.com'
+  s.homepage = 'https://brettterpstra.com/projects/na/'
   s.platform = Gem::Platform::RUBY
   s.summary = 'A command line tool for adding and listing project todos'
+  s.description = [
+    'A tool for managing a TaskPaper file of project todos for the current directory.',
+    'Easily create "next actions" to come back to, add tags and priorities, and notes.',
+    'Add prompt hooks to display your next actions automatically when cd\'ing into a directory.'
+  ].join(' ')
   s.license = 'MIT'
   s.files = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.strip =~ %r{^((test|spec|features)/|\.git|buildnotes|.*\.taskpaper)} }
   end
   s.require_paths << 'lib'
-  s.extra_rdoc_files = ['README.rdoc','na.rdoc']
-  s.rdoc_options << '--title' << 'na' << '--main' << 'README.rdoc' << '-ri'
+  s.extra_rdoc_files = ['README.md','na.rdoc']
+  s.rdoc_options << '--title' << 'na' << '--main' << 'README.md' << '--markup' << 'markdown'
   s.bindir = 'bin'
   s.executables << 'na'
   s.add_development_dependency('rake','~> 0.9.2')
@@ -23,5 +28,6 @@ spec = Gem::Specification.new do |s|
   s.add_development_dependency('yard', '~> 0.9', '>= 0.9.26')
   s.add_runtime_dependency('gli','~> 2.21.0')
   s.add_runtime_dependency('tty-reader', '~> 0.9', '>= 0.9.0')
+  s.add_runtime_dependency('tty-screen', '~> 0.8', '>= 0.8.1')
   s.add_runtime_dependency('tty-which', '~> 0.5', '>= 0.5.0')
 end

data/na.rdoc

@@ -1,6 +1,6 @@
 == na - Add and list next actions for the current project
 
-v1.0.0
+v1.0.2
 
 === Global Options
 === -d|--depth DEPTH
@@ -61,7 +61,11 @@ Display the program version
 ==== Command: <tt>add  TASK</tt>
 Add a new next action
 
+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.
 ===== Options
 ===== -f|--file PATH
 
@@ -129,7 +133,7 @@ force overwrite of existing config file
 
 
 
-==== Command: <tt>next|show </tt>
+==== Command: <tt>next|show  OPTIONAL_QUERY</tt>
 Show next actions
 
 

data/scripts/fixreadme.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+current_ver = ARGV[0]
+src = 'src/README.md'
+dest = 'README.md'
+
+readme = IO.read(src).force_encoding('ASCII-8BIT').encode('UTF-8', invalid: :replace, undef: :replace, replace: '?')
+
+content = readme.match(/(?<=\<!--README-->)(.*?)(?=\<!--END README-->)/m)[0]
+
+content.gsub!(/<!--VER-->(.*?)<!--END VER-->/, current_ver)
+content.gsub!(/<!--GITHUB-->(.*?)<!--END GITHUB-->/m, '\1')
+content.gsub!(/<!--JEKYLL(.*?)-->/m, '')
+
+File.open(dest, 'w') { |f| f.puts(content) }
+
+Process.exit 0