na 1.2.80 → 1.2.81

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    na (1.2.80)
+    na (1.2.81)
       chronic (~> 0.10, >= 0.10.2)
       git (~> 3.0.0)
       gli (~> 2.21.0)
@@ -14,14 +14,14 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (8.0.2)
+    activesupport (8.1.0)
       base64
-      benchmark (>= 0.3)
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
+      json
       logger (>= 1.4.2)
       minitest (>= 5.1)
       securerandom (>= 0.3)
@@ -30,11 +30,12 @@ GEM
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
     base64 (0.3.0)
-    benchmark (0.4.1)
-    bigdecimal (3.2.3)
+    bigdecimal (3.3.1)
+    bump (0.6.1)
     chronic (0.10.2)
     concurrent-ruby (1.3.5)
-    connection_pool (2.5.3)
+    connection_pool (2.5.4)
+    diff-lcs (1.6.2)
     drb (2.2.3)
     git (3.0.2)
       activesupport (>= 5.0)
@@ -44,15 +45,29 @@ GEM
     gli (2.21.5)
     i18n (1.14.7)
       concurrent-ruby (~> 1.0)
+    json (2.15.2)
     logger (1.7.0)
     mdless (1.0.37)
-    minitest (5.25.5)
-    ostruct (0.6.1)
+    minitest (5.26.0)
+    ostruct (0.6.3)
     process_executer (1.3.0)
     public_suffix (6.0.2)
     rake (13.3.0)
-    rchardet (1.9.0)
+    rchardet (1.10.0)
     rdoc (4.3.0)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.3)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.6)
     securerandom (0.4.1)
     tty-cursor (0.7.1)
     tty-reader (0.9.0)
@@ -65,7 +80,7 @@ GEM
     tty-which (0.5.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    uri (1.0.3)
+    uri (1.0.4)
     wisper (2.0.1)
 
 PLATFORMS
@@ -82,10 +97,12 @@ PLATFORMS
   x86_64-linux-musl
 
 DEPENDENCIES
+  bump (~> 0.6.0)
   minitest (~> 5.14)
   na!
   rake
   rdoc (~> 4.3)
+  rspec (~> 3.0)
   tty-spinner (~> 0.9, >= 0.9.0)
 
 BUNDLED WITH

data/README.md

@@ -9,9 +9,9 @@
 _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.2.80.
+The current version of `na` is 1.2.81.
 
-`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. 
+`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 action items quickly from the command line, automatically tagging them as next actions. It can also mark actions as completed, delete them, archive them, and move them between projects.
 
@@ -48,7 +48,7 @@ You can list next actions in files in the current directory by typing `na`. By d
 
 #### Adding todos
 
-You can also quickly add todo items from the command line with the `add` subcommand. The script will look for a file in the current directory with a `.taskpaper` extension (configurable). 
+You can also quickly add todo items from the command line with the `add` subcommand. The script will look for a file in the current directory with a `.taskpaper` extension (configurable).
 
 If found, it will try to locate an `Inbox:` project, or create one if it doesn't exist. Any arguments after `add` will be combined to create a new task in TaskPaper format. They will automatically be assigned as next actions (tagged `@na`) and will show up when `na` lists the tasks for the project.
 
@@ -76,7 +76,7 @@ SYNOPSIS
     na [global options] command [command options] [arguments...]
 
 VERSION
-    1.2.80
+    1.2.81
 
 GLOBAL OPTIONS
     -a, --add               - Add a next action (deprecated, for backwards compatibility)
@@ -116,6 +116,7 @@ COMMANDS
     prompt              - Show or install prompt hooks for the current shell
     restore, unfinish   - Find and remove @done tag from an action
     saved               - Execute a saved search
+    scan                - Scan a directory tree for todo files and cache them
     tag                 - Add tags to matching action(s)
     tagged              - Find actions matching a tag
     todos               - Show list of known todo files
@@ -133,7 +134,7 @@ If you run the `add` command with no arguments, you'll be asked for input on the
 
 ###### Adding notes
 
-Use the `--note` switch to add a note. If STDIN (piped) input is present when this switch is used, it will be included in the note. A prompt will be displayed for adding additional notes, which will be appended to any STDIN note passed. Press CTRL-d to end editing and save the note. 
+Use the `--note` switch to add a note. If STDIN (piped) input is present when this switch is used, it will be included in the note. A prompt will be displayed for adding additional notes, which will be appended to any STDIN note passed. Press CTRL-d to end editing and save the note.
 
 Notes are not displayed by the `next/tagged/find` commands unless `--notes` is specified.
 
@@ -335,6 +336,7 @@ COMMAND OPTIONS
     --[no-]done                            - Include @done actions
     --exact                                - Search query is exact text match (not tokens)
     --file=TODO_FILE                       - Display matches from specific todo file ([relative] path) (default: none)
+    --hidden                               - Include hidden directories while traversing
     --in, --todo=TODO                      - Display matches from a known todo file anywhere in history (short name) (may be used more than once, default: none)
     --nest                                 - Output actions nested by file
     --no_file                              - No filename in output
@@ -426,6 +428,44 @@ EXAMPLES
     na saved
 ```
 
+##### scan
+
+Scan a directory tree for todo files and cache them in tdlist.txt. Avoids duplicates and can optionally prune non-existent entries.
+
+Scan reports how many files were added and, if --prune is used, how many were pruned. With --dry-run, it lists the full file paths that would be added and/or pruned.
+
+```
+NAME
+    scan - Scan a directory tree for todo files and cache them
+
+SYNOPSIS
+
+    na [global options] scan [command options] [PATH]
+
+DESCRIPTION
+    Searches PATH (default: current directory) for files matching the current NA.extension and adds their absolute paths to the tdlist.txt cache. Avoids duplicates. Optionally prunes non-existent entries from the cache. 
+
+COMMAND OPTIONS
+    -d, --depth=DEPTH - Recurse to depth (1..N or i/inf for infinite) (default: 5)
+    --hidden          - Include hidden directories and files while scanning
+    -n, --dry-run     - Show what would be added/pruned, but do not write tdlist.txt
+    -p, --prune       - Prune removed files from cache after scan
+
+EXAMPLES
+
+    # Scan current directory up to default depth (5)
+    na scan
+
+    # Scan a specific path up to depth 3
+    na scan -d 3 ~/Projects
+
+    # Scan current directory recursively with no depth limit
+    na scan -d inf
+
+    # Prune non-existent entries from the cache (in addition to scanning)
+    na scan --prune
+```
+
 ##### tagged
 
 Example: `na tagged feature +maybe`.
@@ -453,6 +493,7 @@ COMMAND OPTIONS
     --[no-]done                            - Include @done actions
     --exact                                - Search query is exact text match (not tokens)
     --file=TODO_FILE                       - Display matches from specific todo file ([relative] path) (default: none)
+    --hidden                               - Include hidden directories while traversing
     --in, --todo=TODO                      - Display matches from a known todo file anywhere in history (short name) (may be used more than once, default: none)
     --nest                                 - Output actions nested by file
     --no_file                              - No filename in output

data/Rakefile

@@ -207,3 +207,9 @@ end
 
 desc "alias for build"
 task package: :build
+
+desc 'Run tests with coverage'
+task :coverage do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task[:test].invoke
+end

data/bin/commands/next.rb

@@ -19,6 +19,9 @@ class App
     c.arg_name "DEPTH"
     c.flag %i[d depth], type: :integer, must_match: /^[1-9]$/
 
+    c.desc "Include hidden directories while traversing"
+    c.switch %i[hidden], negatable: false, default_value: false
+
     c.desc "Show next actions from all known todo files (in any directory)"
     c.switch %i[all], negatable: false, default_value: false
 
@@ -217,6 +220,7 @@ class App
       file_path = options[:file] ? File.expand_path(options[:file]) : nil
 
       todo = NA::Todo.new({ depth: depth,
+                            hidden: options[:hidden],
                             done: options[:done],
                             file_path: file_path,
                             project: options[:project],

data/bin/commands/scan.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+class App
+  extend GLI::App
+  desc 'Scan a directory tree for todo files and cache them'
+  long_desc 'Searches PATH (default: current directory) for files matching the current NA.extension
+and adds their absolute paths to the tdlist.txt cache. Avoids duplicates. Optionally prunes
+non-existent entries from the cache.'
+  arg_name 'PATH', optional: true
+  command %i[scan] do |c|
+    c.example 'na scan', desc: 'Scan current directory up to default depth (5)'
+    c.example 'na scan -d 3 ~/Projects', desc: 'Scan a specific path up to depth 3'
+    c.example 'na scan -d inf', desc: 'Scan current directory recursively with no depth limit'
+    c.example 'na scan --prune', desc: 'Prune non-existent entries from the cache (in addition to scanning)'
+
+    c.desc 'Recurse to depth (1..N or i/inf for infinite)'
+    c.arg_name 'DEPTH'
+    c.default_value '5'
+    c.flag %i[d depth], must_match: /^(\d+|i\w*)$/i
+
+    c.desc 'Prune removed files from cache after scan'
+    c.switch %i[p prune], negatable: false, default_value: false
+
+    c.desc 'Include hidden directories and files while scanning'
+    c.switch %i[hidden], negatable: false, default_value: false
+
+    c.desc 'Show what would be added/pruned, but do not write tdlist.txt'
+    c.switch %i[n dry-run], negatable: false, default_value: false
+
+    c.action do |_global_options, options, args|
+      base = args.first || Dir.pwd
+      ext = NA.extension
+
+      # Parse depth: numeric or starts-with-i for infinite
+      depth_arg = (options[:depth] || '5').to_s
+      infinite = depth_arg =~ /^i/i ? true : false
+      depth = infinite ? nil : depth_arg.to_i
+      depth = 5 if depth.nil? && !infinite
+
+      # Prepare existing cache
+      db = NA.database_path
+      existing = if File.exist?(db)
+                   File.read(db).split(/\n/).map(&:strip)
+                 else
+                   []
+                 end
+
+      found = []
+      Dir.chdir(base) do
+        patterns = if infinite
+                     ["*.#{ext}", "**/*.#{ext}"]
+                   else
+                     (1..[depth, 1].max).map { |d| (d > 1 ? ('*/' * (d - 1)) : '') + "*.#{ext}" }
+                   end
+        pattern = patterns.length == 1 ? patterns.first : "{#{patterns.join(',')}}"
+        files = Dir.glob(pattern, File::FNM_DOTMATCH)
+        # Exclude hidden dirs/files (any segment starting with '.') unless --hidden
+        files.reject! { |f| f.split('/').any? { |seg| seg.start_with?('.') && seg !~ /^\.\.?$/ } } unless options[:hidden]
+        found = files.map { |f| File.expand_path(f) }
+      end
+
+      merged = (existing + found).map(&:strip).uniq.sort
+      merged.select! { |f| File.exist?(f) } if options[:prune]
+
+      added_files = (merged - existing)
+      pruned_files = options[:prune] ? (existing - merged) : []
+      added = added_files.count
+      pruned = pruned_files.count
+
+      if options[:dry_run]
+        msg = "#{NA.theme[:success]}Dry run: would add #{added} file#{added == 1 ? '' : 's'}"
+        msg << ", prune #{pruned} file#{pruned == 1 ? '' : 's'}" if options[:prune]
+        NA.notify(msg)
+        NA.notify("{bw}Would add:{x}\n#{added_files.join("\n")}") if added_files.any?
+        NA.notify("{bw}Would prune:{x}\n#{pruned_files.join("\n")}") if options[:prune] && pruned_files.any?
+      else
+        File.open(db, 'w') { |f| f.puts merged.join("\n") }
+        msg = "#{NA.theme[:success]}Scan complete: #{NA.theme[:filename]}#{added}{x}#{NA.theme[:success]} added"
+        msg << ", #{NA.theme[:filename]}#{pruned}{x}#{NA.theme[:success]} pruned" if options[:prune]
+        NA.notify(msg)
+      end
+    end
+  end
+end

data/bin/commands/update.rb

@@ -192,7 +192,7 @@ class App
       # Require at least one actionable option to be provided
       actionable = [
         options[:note],
-        (options[:priority].to_i if options[:priority]).to_i > 0,
+        (options[:priority].to_i if options[:priority]).to_i.positive?,
         !options[:move].to_s.empty?,
         !(options[:tag].nil? || options[:tag].empty?),
         !(options[:remove].nil? || options[:remove].empty?),

data/bin/na

@@ -10,11 +10,11 @@ require 'fcntl'
 require 'tempfile'
 
 NA::Benchmark.init
-NA::Benchmark.measure('Gem loading') { nil }  # Measures time up to this point
+NA::Benchmark.measure('Gem loading') { nil } # Measures time up to this point
 
 # Search for XDG compliant config first. Default to ~/.na.rc for compatibility
 def self.find_config_file
-  home = ENV['HOME']
+  home = Dir.home
   xdg_config_home = ENV['XDG_CONFIG_HOME'] || File.join(home, '.config')
 
   rc_paths = [
@@ -30,7 +30,6 @@ def self.find_config_file
   existing_path || File.join(xdg_config_home, 'na', 'na.rc')
 end
 
-
 # Main application
 class App
   extend GLI::App
@@ -84,7 +83,7 @@ class App
   switch %i[repo-top], default_value: false
 
   desc 'Provide a template for new/blank todo files, use initconfig to make permanent'
-  flag %[template]
+  flag %(template)
 
   desc 'Use current working directory as [p]roject, [t]ag, or [n]one'
   arg_name 'TYPE'
@@ -121,7 +120,7 @@ class App
     NA.include_ext = global[:include_ext]
     NA.na_tag = global[:na_tag]
     NA.global_file = global[:file]
-    NA.cwd = File.basename(ENV['PWD'])
+    NA.cwd = File.basename(ENV.fetch('PWD', nil))
     NA.cwd_is = if global[:cwd_as] =~ /^n/
                   :none
                 else
@@ -146,7 +145,8 @@ class App
           NA.global_file = taskpaper_file
           # Add this block to create the file if it doesn't exist
           unless File.exist?(taskpaper_file)
-            res = NA.yn(NA::Color.template("#{NA.theme[:warning]}Repository file not found, create #{taskpaper_file}"), default: true)
+            res = NA.yn(NA::Color.template("#{NA.theme[:warning]}Repository file not found, create #{taskpaper_file}"),
+                        default: true)
             if res
               NA.create_todo(taskpaper_file, repo_name, template: global[:template])
             else
@@ -198,7 +198,7 @@ class App
 end
 
 NA.stdin = $stdin.read.strip if $stdin.stat.size.positive? || $stdin.fcntl(Fcntl::F_GETFL, 0).zero?
-NA.stdin = nil unless NA.stdin && NA.stdin.length.positive?
+NA.stdin = nil unless NA.stdin&.length&.positive?
 
 NA.globals = []
 NA.command_line = []

data/lib/na/action.rb

@@ -12,12 +12,20 @@ module NA
       @file = file
       @project = project
       @parent = parent
-      @action = action.gsub(/\{/, '\\{')
+      @action = action.gsub('{', '\\{')
       @tags = scan_tags
       @line = idx
       @note = note
     end
 
+    # Update the action string and note with priority, tags, and completion status
+    #
+    # @param priority [Integer] Priority value to set
+    # @param finish [Boolean] Mark as finished
+    # @param add_tag [Array<String>] Tags to add
+    # @param remove_tag [Array<String>] Tags to remove
+    # @param note [Array<String>] Notes to set
+    # @return [void]
     def process(priority: 0, finish: false, add_tag: [], remove_tag: [], note: [])
       string = @action.dup
 
@@ -44,6 +52,9 @@ module NA
       @note = note unless note.empty?
     end
 
+    # String representation of the action
+    #
+    # @return [String]
     def to_s
       note = if @note.count.positive?
                "\n#{@note.join("\n")}"
@@ -53,36 +64,41 @@ module NA
       "(#{@file}:#{@line}) #{@project}:#{@parent.join('>')} | #{@action}#{note}"
     end
 
+    # Pretty string representation of the action with color formatting
+    #
+    # @return [String]
     def to_s_pretty
       note = if @note.count.positive?
                "\n#{@note.join("\n")}"
              else
                ''
              end
-      "#{NA.theme[:filename]}#{File.basename(@file)}:#{@line}#{NA.theme[:bracket]}[#{NA.theme[:project]}#{@project}:#{@parent.join(">")}#{NA.theme[:bracket]}]{x} | #{NA.theme[:action]}#{@action}#{NA.theme[:note]}#{note}"
+      "{x}#{NA.theme[:filename]}#{File.basename(@file)}:#{@line}{x}#{NA.theme[:bracket]}[{x}#{NA.theme[:project]}#{@project}:#{@parent.join('>')}{x}#{NA.theme[:bracket]}]{x} | #{NA.theme[:action]}#{@action}{x}#{NA.theme[:note]}#{note}"
     end
 
+    # Inspect the action object
+    #
+    # @return [String]
     def inspect
       <<~EOINSPECT
-      @file: #{@file}
-      @project: #{@project}
-      @parent: #{@parent.join('>')}
-      @action: #{@action}
-      @tags: #{@tags}
-      @note: #{@note}
+        @file: #{@file}
+        @project: #{@project}
+        @parent: #{@parent.join('>')}
+        @action: #{@action}
+        @tags: #{@tags}
+        @note: #{@note}
       EOINSPECT
     end
 
-    ##
-    ## Pretty print an action
-    ##
-    ## @param      extension  [String] The file extension
-    ## @param      template   [Hash] The template to use for
-    ##                        colorization
-    ## @param      regexes    [Array] The regexes to
-    ##                        highlight (searches)
-    ## @param      notes      [Boolean] Include notes
-    ##
+    #
+    # Pretty print an action with color and template formatting
+    #
+    # @param extension [String] File extension
+    # @param template [Hash] Color template
+    # @param regexes [Array] Regexes to highlight
+    # @param notes [Boolean] Include notes
+    # @param detect_width [Boolean] Detect terminal width
+    # @return [String]
     def pretty(extension: 'taskpaper', template: {}, regexes: [], notes: false, detect_width: true)
       NA::Benchmark.measure('Action.pretty') do
         # Use cached theme instead of loading every time
@@ -98,24 +114,29 @@ module NA
         # Create the hierarchical parent string (optimized)
         parents = if needs_parents && @parent.any?
                     parent_parts = @parent.map { |par| "#{template[:parent]}#{par}" }.join(template[:parent_divider])
-                    NA::Color.template("{x}#{template[:bracket]}[#{template[:error]}#{parent_parts}#{template[:bracket]}]{x} ")
+                    NA::Color.template("{x}#{template[:bracket]}[#{template[:error]}#{parent_parts}{x}#{template[:bracket]}]{x} ")
                   else
                     ''
                   end
 
         # Create the project string (optimized)
         project = if needs_project && !@project.empty?
-                    NA::Color.template("#{template[:project]}#{@project}{x} ")
+                    NA::Color.template("{x}#{template[:project]}#{@project}{x} ")
                   else
                     ''
                   end
 
         # Create the source filename string (optimized)
         filename = if needs_filename
-                     file = @file.sub(%r{^\./}, '').sub(/#{ENV['HOME']}/, '~')
-                     file = file.sub(/\.#{extension}$/, '') unless NA.include_ext
-                     file = file.highlight_filename
-                     NA::Color.template("#{template[:filename]}#{file} {x}")
+                     path = @file.sub(%r{^\./}, '').sub(/#{Dir.home}/, '~')
+                     if File.dirname(path) == '.'
+                       fname = NA.include_ext ? File.basename(path) : File.basename(path, ".#{extension}")
+                       fname = "./#{fname}" if NA.show_cwd_indicator
+                       NA::Color.template("#{template[:filename]}#{fname} {x}")
+                     else
+                       colored = (NA.include_ext ? path : path.sub(/\.#{extension}$/, '')).highlight_filename
+                       NA::Color.template("#{template[:filename]}#{colored} {x}")
+                     end
                    else
                      ''
                    end
@@ -138,44 +159,58 @@ module NA
               # Cache width calculation
               width = @cached_width ||= TTY::Screen.columns
               # Calculate indent more efficiently - avoid repeated template processing
-              base_template = output_template.gsub(/%action/, '').gsub(/%note/, '')
-              base_output = base_template.gsub(/%filename/, filename).gsub(/%project/, project).gsub(/%parents?/, parents)
+              base_template = output_template.gsub('%action', '').gsub('%note', '')
+              base_output = base_template.gsub('%filename', filename).gsub('%project', project).gsub(/%parents?/,
+                                                                                                     parents)
               indent = NA::Color.uncolor(NA::Color.template(base_output)).length
               note = NA::Color.template(@note.wrap(width, indent, template[:note]))
             else
-              note = NA::Color.template("\n#{@note.map { |l| "  #{template[:note]}• #{l}{x}" }.join("\n")}")
+              note = NA::Color.template("\n#{@note.map { |l| "  {x}#{template[:note]}• #{l}{x}" }.join("\n")}")
             end
           else
-            action += "#{template[:note]}*"
+            action += "{x}#{template[:note]}*"
           end
         end
 
         # Wrap action if needed (optimized)
         if detect_width && !action.empty?
           width = @cached_width ||= TTY::Screen.columns
-          base_template = output_template.gsub(/%action/, '').gsub(/%note/, '')
-          base_output = base_template.gsub(/%filename/, filename).gsub(/%project/, project).gsub(/%parents?/, parents)
+          base_template = output_template.gsub('%action', '').gsub('%note', '')
+          base_output = base_template.gsub('%filename', filename).gsub('%project', project).gsub(/%parents?/, parents)
           indent = NA::Color.uncolor(NA::Color.template(base_output)).length
           action = action.wrap(width, indent)
         end
 
         # Replace variables in template string and output colorized (optimized)
         final_output = output_template.dup
-        final_output.gsub!(/%filename/, filename)
-        final_output.gsub!(/%project/, project)
+        final_output.gsub!('%filename', filename)
+        final_output.gsub!('%project', project)
         final_output.gsub!(/%parents?/, parents)
-        final_output.gsub!(/%action/, action.highlight_search(regexes))
-        final_output.gsub!(/%note/, note)
-        final_output.gsub!(/\\\{/, '{')
+        final_output.gsub!('%action', action.highlight_search(regexes))
+        final_output.gsub!('%note', note)
+        final_output.gsub!('\\{', '{')
 
         NA::Color.template(final_output)
       end
     end
 
+    # Check if action tags match any, all, and none criteria
+    #
+    # @param any [Array] Tags to match any
+    # @param all [Array] Tags to match all
+    # @param none [Array] Tags to match none
+    # @return [Boolean]
     def tags_match?(any: [], all: [], none: [])
       tag_matches_any(any) && tag_matches_all(all) && tag_matches_none(none)
     end
 
+    # Check if action or note matches any, all, and none search criteria
+    #
+    # @param any [Array] Regexes to match any
+    # @param all [Array] Regexes to match all
+    # @param none [Array] Regexes to match none
+    # @param include_note [Boolean] Include note in search
+    # @return [Boolean]
     def search_match?(any: [], all: [], none: [], include_note: true)
       search_matches_any(any, include_note: include_note) &&
         search_matches_all(all, include_note: include_note) &&
@@ -184,6 +219,11 @@ module NA
 
     private
 
+    # Check if action and note do not match any regexes
+    #
+    # @param regexes [Array] Regexes to check
+    # @param include_note [Boolean] Include note in search
+    # @return [Boolean]
     def search_matches_none(regexes, include_note: true)
       regexes.each do |rx|
         regex = rx.is_a?(Regexp) ? rx : Regexp.new(rx, Regexp::IGNORECASE)
@@ -193,6 +233,11 @@ module NA
       true
     end
 
+    # Check if action or note matches any regexes
+    #
+    # @param regexes [Array] Regexes to check
+    # @param include_note [Boolean] Include note in search
+    # @return [Boolean]
     def search_matches_any(regexes, include_note: true)
       return true if regexes.empty?
 
@@ -204,6 +249,11 @@ module NA
       false
     end
 
+    # Check if action or note matches all regexes
+    #
+    # @param regexes [Array] Regexes to check
+    # @param include_note [Boolean] Include note in search
+    # @return [Boolean]
     def search_matches_all(regexes, include_note: true)
       regexes.each do |rx|
         regex = rx.is_a?(Regexp) ? rx : Regexp.new(rx, Regexp::IGNORECASE)
@@ -213,6 +263,10 @@ module NA
       true
     end
 
+    # Check if none of the tags match
+    #
+    # @param tags [Array] Tags to check
+    # @return [Boolean]
     def tag_matches_none(tags)
       tags.each do |tag|
         return false if compare_tag(tag)
@@ -220,6 +274,10 @@ module NA
       true
     end
 
+    # Check if any of the tags match
+    #
+    # @param tags [Array] Tags to check
+    # @return [Boolean]
     def tag_matches_any(tags)
       return true if tags.empty?
 
@@ -229,6 +287,10 @@ module NA
       false
     end
 
+    # Check if all of the tags match
+    #
+    # @param tags [Array] Tags to check
+    # @return [Boolean]
     def tag_matches_all(tags)
       tags.each do |tag|
         return false unless compare_tag(tag)
@@ -236,6 +298,10 @@ module NA
       true
     end
 
+    # Compare a tag against the action's tags with optional value comparison
+    #
+    # @param tag [Hash] Tag criteria
+    # @return [Boolean]
     def compare_tag(tag)
       tag_regex = tag[:tag].is_a?(Regexp) ? tag[:tag] : Regexp.new(tag[:tag], Regexp::IGNORECASE)
       keys = @tags.keys.delete_if { |k| k !~ tag_regex }