na 1.1.18 → 1.1.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca265b21ae87e7ce77028f5a5a61d335d54136998db65495aacda0d8f6ea1a67
-  data.tar.gz: 10c5a7a4d7dda293f9d10cee00255a3c7e91e36be5adaf57677ff57cac8352c4
+  metadata.gz: 3a57cbddd075c808316dbf206b6ff65d4d0caf307c4c27524faf94f6e86517d3
+  data.tar.gz: 2e0ff764b2a777eb5089c228f7979c131c7669557f033f657241052cd3345b53
 SHA512:
-  metadata.gz: cce03bc78f6622640b3d707b804af98838782786a6b9d026f50ab97715611a34fe26829d1c3b09850679779b5c838e8b41168922973f5e4cf94d3b25859c6746
-  data.tar.gz: aa8965262c15291fadada3b61be77d7da36710f4a77b4e32a3909e072c30b6a67fb3c5aa8969bb6361e71cbf6efbf7bec8cf9400e0646ba10a4246e82e526359
+  metadata.gz: 4516162349290992f0a156161e3f3b1e7831ad383c38d9061ff44d267b862037e5cfb04796ac1143c4bdd1b60fa77b6c9576ee265add84abc19a5958d30dd8a6
+  data.tar.gz: 91c86e3ea2c36fd66cbbc7211c9ebab460af7a9ba14668bb1f55a7a14d7e8b5aaf2ff8b7795672ee7c3856a3ae47b0783a40033c427b2df69ff2c0c6c60697e4

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+### 1.1.19
+
+2022-10-07 03:06
+
+#### IMPROVED
+
+- More help updates
+- Added `--or` flag to `tagged` and `find` to default to OR boolean combination of search terms/tags
+- Special handling for date comparisons to "today"
+
 ### 1.1.18
 
 2022-10-06 17:23

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    na (1.1.17)
+    na (1.1.19)
       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.18
+The current version of `na` is 1.1.19
 .
 
 `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,24 +59,24 @@ SYNOPSIS
     na [global options] command [command options] [arguments...]
 
 VERSION
-    1.1.1
+    1.1.19
 
 GLOBAL OPTIONS
     -a, --[no-]add          - Add a next action (deprecated, for backwards compatibility)
     -d, --depth=DEPTH       - Recurse to depth (default: 1)
     --[no-]debug            - Display verbose output
-    --ext=FILE_EXTENSION    - File extension to consider a todo file (default: taskpaper)
+    --ext=EXT               - File extension to consider a todo file (default: taskpaper)
     --help                  - Show this message
-    -n, --[no-]note         - Prompt for additional notes (deprecated, for backwards compatibility)
-    --na_tag=TAG            - Tag to consider a next action (default: na)
+    -n, --note              - Prompt for additional notes (deprecated, for backwards compatibility)
     -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) (default: enabled)
+    -r, --[no-]recurse      - Recurse 3 directories deep (deprecated, for backwards compatability)
+    -t, --na_tag=TAG        - Tag to consider a next action (default: na)
     --version               - Display the program version
 
 COMMANDS
     add          - Add a new next action
     edit         - Open a todo file in the default editor
-    find         - Find actions matching a search pattern
+    find, grep   - 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
@@ -99,17 +99,19 @@ NAME
 
 SYNOPSIS
 
-    na [global options] add [command options] TASK
+    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. 
 
 COMMAND OPTIONS
-    -f, --file=PATH    - Specify the file to which the task should be added (default: none)
-    -n, --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)
-    -x                 - Don't add next action tag to new entry
+    -d, --depth=DEPTH   - Search for files X directories deep (default: 1)
+    -f, --file=PATH     - Specify the file to which the task should be added (default: none)
+    -n, --note          - Prompt for additional notes
+    -p, --priority=PRIO - Add a priority level 1-5 (default: 0)
+    -t, --tag=TAG       - Use a tag other than the default next action tag (default: none)
+    --to=PROJECT        - Add action to specific project (default: Inbox)
+    -x                  - Don't add next action tag to new entry
 
 EXAMPLES
 
@@ -163,22 +165,24 @@ 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 all tokens 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, --exact       - Match pattern exactly
+    -d, --depth=DEPTH                      - Recurse to depth (default: none)
+    -e, --regex                            - Interpret search pattern as regular expression
+    --in=TODO_PATH                         - Show actions from a specific todo file in history (default: none)
+    -o, --or                               - Combine search tokens with OR, displaying actions matching ANY of the terms
+    --proj, --project=PROJECT[/SUBPROJECT] - Show actions from a specific project (default: none)
+    -v, --invert                           - Show actions not matching search pattern
+    -x, --exact                            - Match pattern exactly
 
 EXAMPLES
 
     # Find all actions containing feature, idea, and swift
-    na find feature +idea +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
 ```
 
 ##### init, create
@@ -217,16 +221,20 @@ 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)
+    -d, --depth=DEPTH                      - Recurse to depth (default: 2)
+    --proj, --project=PROJECT[/SUBPROJECT] - Show actions from a specific project (default: none)
+    -t, --tag=TAG                          - Alternate tag to search for (default: none)
 
 EXAMPLES
 
     # display the next actions from any todo files in the current directory
-    doing next
+    na next
+
+    # display the next actions from the current directory, traversing 3 levels deep
+    na next -d 3
 
-    # display the next actions from the current directory and its children, 3 levels deep
-    doing next -d 3
+    # display next actions for a project you visited in the past
+    na next marked
 ```
 
 ##### tagged
@@ -244,18 +252,31 @@ 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 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. 
 
 COMMAND OPTIONS
-    -d, --depth=DEPTH - Recurse to depth (default: 1)
+    -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
+    --proj, --project=PROJECT[/SUBPROJECT] - Show actions from a specific project (default: none)
+    -v, --invert                           - Show actions not matching tags
 
 EXAMPLES
 
     # Show all actions tagged @maybe
-    na 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"
+
+    # Show actions with @priority(4) or @priority(5)
+    na tagged "priority>=4"
 
-    # Show all actions tagged @feature and @idea, recurse 3 levels
-    na tagged -d 3 feature idea
+    # Show actions with a due date coming up in the next 2 days
+    na tagged "due<in 2 days"
 ```
 
 ### Configuration

data/bin/na

@@ -119,7 +119,7 @@ class App
 
   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'
+  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'
     c.example 'na add "A bug I need to fix" -p 4 -n',
@@ -231,7 +231,7 @@ class App
   end
 
   desc 'Find actions matching a search pattern'
-  long_desc 'Search tokens are separated by spaces. Actions matching any token in the pattern will be shown
+  long_desc 'Search tokens are separated by spaces. Actions matching all tokens in the pattern will be shown
   (partial matches allowed). Add a + before a token to make it required, e.g. `na find +feature +maybe`'
   arg_name 'PATTERN'
   command %i[find grep] do |c|
@@ -252,6 +252,9 @@ class App
     c.arg_name 'TODO_PATH'
     c.flag %i[in]
 
+    c.desc 'Combine search tokens with OR, displaying actions matching ANY of the terms'
+    c.switch %i[o or], negatable: false
+
     c.desc 'Show actions from a specific project'
     c.arg_name 'PROJECT[/SUBPROJECT]'
     c.flag %i[proj project]
@@ -272,7 +275,7 @@ class App
         tokens = Regexp.new(args.join(' '), Regexp::IGNORECASE)
       else
         tokens = []
-        all_req = args.join(' ') !~ /[+!\-]/
+        all_req = args.join(' ') !~ /[+!\-]/ && !options[:or]
 
         args.join(' ').split(/ /).each do |arg|
           m = arg.match(/^(?<req>[+\-!])?(?<tok>.*?)$/)
@@ -311,13 +314,18 @@ class App
 
   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 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'
-    c.example 'na tagged priority>=4', desc: 'Show actions with @priority(4) or @priority(5)'
+    c.example 'na tagged -d 3 "feature, idea"', desc: 'Show all actions tagged @feature AND @idea, recurse 3 levels'
+    c.example 'na tagged --or "feature, idea"', desc: 'Show all actions tagged @feature OR @idea'
+    c.example 'na tagged "priority>=4"', desc: 'Show actions with @priority(4) or @priority(5)'
+    c.example 'na tagged "due<in 2 days"', desc: 'Show actions with a due date coming up in the next 2 days'
 
     c.desc 'Recurse to depth'
     c.arg_name 'DEPTH'
@@ -328,6 +336,9 @@ class App
     c.arg_name 'TODO_PATH'
     c.flag %i[in]
 
+    c.desc 'Combine tags with OR, displaying actions matching ANY of the tags'
+    c.switch %i[o or], negatable: false
+
     c.desc 'Show actions from a specific project'
     c.arg_name 'PROJECT[/SUBPROJECT]'
     c.flag %i[proj project]
@@ -344,7 +355,7 @@ class App
 
       tags = []
 
-      all_req = args.join(' ') !~ /[+!\-]/
+      all_req = args.join(' ') !~ /[+!\-]/ && !options[:or]
       args.join(',').split(/ *, */).each do |arg|
         # TODO: <> comparisons do nothing right now
         m = arg.match(/^(?<req>[+\-!])?(?<tag>[^ =<>*$\^]+)(?:(?<op>[=<>*$\^]+)(?<val>.*?))?$/)

data/lib/na/action.rb

@@ -137,6 +137,11 @@ 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)
 

data/lib/na/version.rb

@@ -1,3 +1,3 @@
 module Na
-  VERSION = '1.1.18'
+  VERSION = '1.1.19'
 end

data/scripts/fixreadme.rb

@@ -13,6 +13,11 @@ content.gsub!(/<!--VER-->(.*?)<!--END VER-->/, current_ver)
 content.gsub!(/<!--GITHUB-->(.*?)<!--END GITHUB-->/m, '\1')
 content.gsub!(/<!--JEKYLL(.*?)-->/m, '')
 
+content.gsub!(/^@cli\((.*?)\)/) do
+  cmd = Regexp.last_match(1)
+  `#{cmd}`.strip.gsub(/\n{2,}/, "\n\n")
+end
+
 File.open(dest, 'w') { |f| f.puts(content) }
 
 Process.exit 0

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.17<!--END VER-->.
+The current version of `na` is <!--VER-->1.1.18<!--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. 
 
@@ -51,37 +51,7 @@ If found, it will try to locate an `Inbox:` project, or create one if it doesn't
 ### Usage
 
 ```
-NAME
-    na - Add and list next actions for the current project
-
-SYNOPSIS
-    na [global options] command [command options] [arguments...]
-
-VERSION
-    1.1.1
-
-GLOBAL OPTIONS
-    -a, --[no-]add          - Add a next action (deprecated, for backwards compatibility)
-    -d, --depth=DEPTH       - Recurse to depth (default: 1)
-    --[no-]debug            - Display verbose output
-    --ext=FILE_EXTENSION    - File extension to consider a todo file (default: taskpaper)
-    --help                  - Show this message
-    -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) (default: enabled)
-    --version               - Display the program version
-
-COMMANDS
-    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
-    prompt       - Show or install prompt hooks for the current shell
-    tagged       - Find actions matching a tag
+@cli(bundle exec bin/na help)
 ```
 
 #### Commands
@@ -93,58 +63,13 @@ Example: `na add This feature @idea I have`
 If you run the `add` command with no arguments, you'll be asked for input on the command line.
 
 ```
-NAME
-    add - Add a new next action
-
-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, --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)
-    -x                 - Don't add next action tag to new entry
-
-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
+@cli(bundle exec bin/na help add)
 ```
 
 ##### 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
+@cli(bundle exec bin/na help edit)
 ```
 
 ##### find
@@ -154,49 +79,13 @@ Example: `na find cool feature idea`
 Unless `--exact` is specified, search is tokenized and combined with AND, so `na find cool feature idea` translates to `cool AND feature AND idea`, matching any string that contains all of the words. To make a token required and others optional, 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
-
-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` 
-
-COMMAND OPTIONS
-    -d, --depth=DEPTH - Recurse to depth (default: 1)
-    -x, --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
+@cli(bundle exec bin/na help find)
 ```
 
 ##### 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
+@cli(bundle exec bin/na help init)
 ```
 
 ##### next, show
@@ -208,24 +97,7 @@ Examples:
 - `na show marked2` (show next actions from another directory you've previously used na on)
 
 ```
-NAME
-    next - Show next actions
-
-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
+@cli(bundle exec bin/na help next)
 ```
 
 ##### tagged
@@ -235,26 +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.
 
 ```
-NAME
-    tagged - Find actions matching a tag
-
-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` 
-
-COMMAND OPTIONS
-    -d, --depth=DEPTH - Recurse to depth (default: 1)
-
-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
+@cli(bundle exec bin/na help tagged)
 ```
 
 ### Configuration

metadata

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