na 1.2.79 → 1.2.81

data/lib/na/theme.rb

@@ -3,6 +3,8 @@
 module NA
   module Theme
     class << self
+      # Returns a help string describing available color placeholders for themes.
+      # @return [String] Help text for theme placeholders
       def template_help
         <<~EOHELP
           Use {X} placeholders to apply colors. Available colors are:
@@ -22,50 +24,56 @@ module NA
         EOHELP
       end
 
+      # Loads the theme configuration, merging defaults with any custom theme file and the provided template.
+      # Writes the help text and theme YAML to the theme file.
+      # @param template [Hash] Additional theme settings to merge
+      # @return [Hash] The merged theme configuration
       def load_theme(template: {})
-        # Default colorization, can be overridden with full or partial template variable
-        default_template = {
-          parent: '{c}',
-          bracket: '{dc}',
-          parent_divider: '{xw}/',
-          action: '{bg}',
-          project: '{xbk}',
-          tags: '{m}',
-          value_parens: '{m}',
-          values: '{c}',
-          search_highlight: '{y}',
-          note: '{dw}',
-          dirname: '{xdw}',
-          filename: '{xb}{#eccc87}',
-          prompt: '{m}',
-          success: '{bg}',
-          error: '{b}{#b61d2a}',
-          warning: '{by}',
-          debug: '{dw}',
-          templates: {
-            output: '%filename%parents| %action',
-            default: '%parent%action',
-            single_file: '%parent%action',
-            multi_file: '%filename%parent%action',
-            no_file: '%parent%action'
+        NA::Benchmark.measure('Theme.load_theme') do
+          # Default colorization, can be overridden with full or partial template variable
+          default_template = {
+            parent: '{c}',
+            bracket: '{dc}',
+            parent_divider: '{xw}/',
+            action: '{bg}',
+            project: '{xbk}',
+            tags: '{m}',
+            value_parens: '{m}',
+            values: '{c}',
+            search_highlight: '{y}',
+            note: '{dw}',
+            dirname: '{xdw}',
+            filename: '{xb}{#eccc87}',
+            prompt: '{m}',
+            success: '{bg}',
+            error: '{b}{#b61d2a}',
+            warning: '{by}',
+            debug: '{dw}',
+            templates: {
+              output: '%filename%parents| %action',
+              default: '%parent%action',
+              single_file: '%parent%action',
+              multi_file: '%filename%parent%action',
+              no_file: '%parent%action'
+            }
           }
-        }
 
-        # Load custom theme
-        theme_file = NA.database_path(file: 'theme.yaml')
-        theme = if File.exist?(theme_file)
-                  YAML.load(IO.read(theme_file)) || {}
-                else
-                  {}
-                end
-        theme = default_template.deep_merge(theme)
+          # Load custom theme
+          theme_file = NA.database_path(file: 'theme.yaml')
+          theme = if File.exist?(theme_file)
+                    YAML.load(File.read(theme_file)) || {}
+                  else
+                    {}
+                  end
+          theme = default_template.deep_merge(theme)
 
-        File.open(theme_file, 'w') do |f|
-          f.puts template_help.comment
-          f.puts YAML.dump(theme)
-        end
+          File.open(theme_file, 'w') do |f|
+            f.puts template_help.comment
+            f.puts YAML.dump(theme)
+          end
 
-        theme.merge(template)
+          theme.merge(template)
+        end
       end
     end
   end

data/lib/na/todo.rb

@@ -4,172 +4,209 @@ module NA
   class Todo
     attr_accessor :actions, :projects, :files
 
+    # Initialize a Todo object and parse actions/projects/files
+    #
+    # @param options [Hash] Options for parsing todo files
+    # @return [void]
     def initialize(options = {})
       @files, @actions, @projects = parse(options)
     end
 
-    ##
-    ## Read a todo file and create a list of actions
-    ##
-    ## @param      options  The options
-    ##
-    ## @option      depth       [Number] The directory depth to
-    ##                         search for files
-    ## @option      done        [Boolean] include @done actions
-    ## @option      query       [Hash] The todo file query
-    ## @option      tag         [Array] Tags to search for
-    ## @option      search      [String] A search string
-    ## @option      negate      [Boolean] Invert results
-    ## @option      regex       [Boolean] Interpret as regular
-    ##                         expression
-    ## @option      project     [String] The project
-    ## @option      require_na  [Boolean] Require @na tag
-    ## @option      file_path   [String] file path to parse
-    ##
+    # Read a todo file and create a list of actions
+    #
+    # @param options [Hash] The options
+    # @option options [Number] :depth The directory depth to search for files
+    # @option options [Boolean] :done include @done actions
+    # @option options [Hash] :query The todo file query
+    # @option options [Array] :tag Tags to search for
+    # @option options [String] :search A search string
+    # @option options [Boolean] :negate Invert results
+    # @option options [Boolean] :regex Interpret as regular expression
+    # @option options [String] :project The project
+    # @option options [Boolean] :require_na Require @na tag
+    # @option options [String] :file_path file path to parse
+    # @return [Array] files, actions, projects
     def parse(options)
-      defaults = {
-        depth: 1,
-        done: false,
-        file_path: nil,
-        negate: false,
-        project: nil,
-        query: nil,
-        regex: false,
-        require_na: true,
-        search: nil,
-        search_note: true,
-        tag: nil
-      }
-
-      settings = defaults.merge(options)
-
-      actions = NA::Actions.new
-      required = []
-      optional = []
-      negated = []
-      required_tag = []
-      optional_tag = []
-      negated_tag = []
-      projects = []
-
-      NA.notify("Tags: #{settings[:tag]}", debug:true)
-      NA.notify("Search: #{settings[:search]}", debug:true)
-
-      settings[:tag]&.each do |t|
-        unless t[:tag].nil?
-          if settings[:negate]
-            optional_tag.push(t) if t[:negate]
-            required_tag.push(t) if t[:required] && t[:negate]
-            negated_tag.push(t) unless t[:negate]
-          else
-            optional_tag.push(t) unless t[:negate] || t[:required]
-            required_tag.push(t) if t[:required] && !t[:negate]
-            negated_tag.push(t) if t[:negate]
-          end
-        end
-      end
-
-      unless settings[:search].nil? || settings[:search].empty?
-        if settings[:regex] || settings[:search].is_a?(String)
-          if settings[:negate]
-            negated.push(settings[:search])
-          else
-            optional.push(settings[:search])
-            required.push(settings[:search])
-          end
-        else
-          settings[:search].each do |t|
-            opt, req, neg = parse_search(t, settings[:negate])
-            optional.concat(opt)
-            required.concat(req)
-            negated.concat(neg)
-          end
+      NA::Benchmark.measure('Todo.parse') do
+        defaults = {
+          depth: 1,
+          done: false,
+          file_path: nil,
+          negate: false,
+          hidden: false,
+          project: nil,
+          query: nil,
+          regex: false,
+          require_na: true,
+          search: nil,
+          search_note: true,
+          tag: nil
+        }
+
+        settings = defaults.merge(options)
+        # Ensure tag is always an Array
+        if settings[:tag].nil?
+          settings[:tag] = []
+        elsif !settings[:tag].is_a?(Array)
+          settings[:tag] = [settings[:tag]]
         end
-      end
 
-      files = if !settings[:file_path].nil?
-                [settings[:file_path]]
-              elsif settings[:query].nil?
-                NA.find_files(depth: settings[:depth])
+        actions = NA::Actions.new
+        required = []
+        optional = []
+        negated = []
+        required_tag = []
+        optional_tag = []
+        negated_tag = []
+        projects = []
+
+        NA.notify("Tags: #{settings[:tag]}", debug: true)
+        NA.notify("Search: #{settings[:search]}", debug: true)
+
+        settings[:tag]&.each do |t|
+          # If t is a Hash, use its keys; if String, treat as a tag string
+          if t.is_a?(Hash)
+            unless t[:tag].nil?
+              if settings[:negate]
+                optional_tag.push(t) if t[:negate]
+                required_tag.push(t) if t[:required] && t[:negate]
+                negated_tag.push(t) unless t[:negate]
               else
-                NA.match_working_dir(settings[:query])
+                optional_tag.push(t) unless t[:negate] || t[:required]
+                required_tag.push(t) if t[:required] && !t[:negate]
+                negated_tag.push(t) if t[:negate]
               end
-
-      NA.notify("Files: #{files.join(', ')}", debug: true)
-      files.each do |file|
-        NA.save_working_dir(File.expand_path(file))
-        content = file.read_file
-        indent_level = 0
-        parent = []
-        in_yaml = false
-        in_action = false
-        content.split(/\n/).each.with_index do |line, idx|
-          if in_yaml && line !~ /^(---|~~~)\s*$/
-            NA.notify("YAML: #{line}", debug: true)
-          elsif line =~ /^(---|~~~)\s*$/
-            in_yaml = !in_yaml
-          elsif line.project? && !in_yaml
-            in_action = false
-            proj = line.project
-            indent = line.indent_level
-
-            if indent.zero? # top level project
-              parent = [proj]
-            elsif indent <= indent_level # if indent level is same or less, split parent before indent level and append
-              parent.slice!(indent, parent.count - indent)
-              parent.push(proj)
-            else # if indent level is greater, append project to parent
-              parent.push(proj)
             end
+          elsif t.is_a?(String)
+            # Treat string as a simple tag
+            optional_tag.push({ tag: t })
+          end
+        end
 
-            projects.push(NA::Project.new(parent.join(':'), indent, idx, idx))
+        unless settings[:search].nil? || settings[:search].empty?
+          if settings[:regex] || settings[:search].is_a?(String)
+            if settings[:negate]
+              negated.push(settings[:search])
+            else
+              optional.push(settings[:search])
+              required.push(settings[:search])
+            end
+          else
+            settings[:search].each do |t|
+              opt, req, neg = parse_search(t, settings[:negate])
+              optional.concat(opt)
+              required.concat(req)
+              negated.concat(neg)
+            end
+          end
+        end
 
-            indent_level = indent
-          elsif line.blank?
-            in_action = false # Comment out to allow line breaks in of notes, which isn't TaskPaper-compatible
-          elsif line.action?
+        # Pre-compile regexes for better performance
+        optional = optional.map { |rx| rx.is_a?(Regexp) ? rx : Regexp.new(rx, Regexp::IGNORECASE) }
+        required = required.map { |rx| rx.is_a?(Regexp) ? rx : Regexp.new(rx, Regexp::IGNORECASE) }
+        negated = negated.map { |rx| rx.is_a?(Regexp) ? rx : Regexp.new(rx, Regexp::IGNORECASE) }
+
+        files = if !settings[:file_path].nil?
+                  [settings[:file_path]]
+                elsif settings[:query].nil?
+                  NA.find_files(depth: settings[:depth], include_hidden: settings[:hidden])
+                else
+                  NA.match_working_dir(settings[:query])
+                end
+
+        NA.notify("Files: #{files.join(', ')}", debug: true)
+        # Cache project regex compilation outside the line loop for better performance
+        project_regex = if settings[:project]
+                          rx = settings[:project].split(%r{[/:]}).join('.*?/')
+                          Regexp.new("#{rx}.*?", Regexp::IGNORECASE)
+                        end
+
+        files.each do |file|
+          next if File.directory?(file)
+
+          NA::Benchmark.measure("Parse file: #{File.basename(file)}") do
+            NA.save_working_dir(File.expand_path(file))
+            content = file.read_file
+            indent_level = 0
+            parent = []
+            in_yaml = false
             in_action = false
-
-            action = line.action
-            new_action = NA::Action.new(file, File.basename(file, ".#{NA.extension}"), parent.dup, action, idx)
-
-            projects[-1].last_line = idx if projects.count.positive?
-
-            next if line.done? && !settings[:done]
-
-            next if settings[:require_na] && !line.na?
-
-            if settings[:project]
-              rx = settings[:project].split(%r{[/:]}).join('.*?/')
-              next unless parent.join('/') =~ Regexp.new("#{rx}.*?", Regexp::IGNORECASE)
+            content.split("\n").each.with_index do |line, idx|
+              if in_yaml && line !~ /^(---|~~~)\s*$/
+                NA.notify("YAML: #{line}", debug: true)
+              elsif line =~ /^(---|~~~)\s*$/
+                in_yaml = !in_yaml
+              elsif line.project? && !in_yaml
+                in_action = false
+                proj = line.project
+                indent = line.indent_level
+
+                if indent.zero? # top level project
+                  parent = [proj]
+                elsif indent <= indent_level # if indent level is same or less, split parent before indent level and append
+                  parent.slice!(indent, parent.count - indent)
+                  parent.push(proj)
+                else # if indent level is greater, append project to parent
+                  parent.push(proj)
+                end
+
+                projects.push(NA::Project.new(parent.join(':'), indent, idx, idx))
+
+                indent_level = indent
+              elsif line.blank?
+                in_action = false # Comment out to allow line breaks in of notes, which isn't TaskPaper-compatible
+              elsif line.action?
+                in_action = false
+
+                # Early exits before creating Action object
+                next if line.done? && !settings[:done]
+
+                next if settings[:require_na] && !line.na?
+
+                next if project_regex && parent.join('/') !~ project_regex
+
+                # Only create Action if we passed basic filters
+                action = line.action
+                new_action = NA::Action.new(file, File.basename(file, ".#{NA.extension}"), parent.dup, action, idx)
+
+                projects[-1].last_line = idx if projects.count.positive?
+
+                # Tag matching
+                has_tag = !optional_tag.empty? || !required_tag.empty? || !negated_tag.empty?
+                next if has_tag && !new_action.tags_match?(any: optional_tag,
+                                                           all: required_tag,
+                                                           none: negated_tag)
+
+                actions.push(new_action)
+                in_action = true
+              elsif in_action
+                actions[-1].note.push(line.strip) if actions.count.positive?
+                projects[-1].last_line = idx if projects.count.positive?
+              end
             end
+            projects = projects.dup
+          end
+        end
 
-            has_tag = !optional_tag.empty? || !required_tag.empty? || !negated_tag.empty?
-            next if has_tag && !new_action.tags_match?(any: optional_tag,
-                                                       all: required_tag,
-                                                       none: negated_tag)
-
-            actions.push(new_action)
-            in_action = true
-          elsif in_action
-            actions[-1].note.push(line.strip) if actions.count.positive?
-            projects[-1].last_line = idx if projects.count.positive?
+        NA::Benchmark.measure('Filter actions by search') do
+          actions.delete_if do |new_action|
+            has_search = !optional.empty? || !required.empty? || !negated.empty?
+            has_search && !new_action.search_match?(any: optional,
+                                                    all: required,
+                                                    none: negated,
+                                                    include_note: settings[:search_note])
           end
         end
-        projects = projects.dup
-      end
 
-      actions.delete_if do |new_action|
-        has_search = !optional.empty? || !required.empty? || !negated.empty?
-        has_search && !new_action.search_match?(any: optional,
-                                                all: required,
-                                                none: negated,
-                                                include_note: settings[:search_note])
+        [files, actions, projects]
       end
-
-      [files, actions, projects]
     end
 
+    # Parse a search tag and categorize as optional, required, or negated
+    #
+    # @param tag [Hash] Search tag with :token, :negate, :required
+    # @param negate [Boolean] Invert results
+    # @return [Array<Array>] Arrays of optional, required, and negated regexes
     def parse_search(tag, negate)
       required = []
       optional = []

data/lib/na/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Na
-  VERSION = '1.2.79'
+  VERSION = '1.2.81'
 end

data/lib/na.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
+require 'na/benchmark'
 require 'na/version'
 require 'na/pager'
 require 'time'
 require 'fileutils'
 require 'shellwords'
-require 'chronic'
+# Lazy load heavy gems - only load when needed
+# require 'chronic'  # Loaded in action.rb and string.rb when needed
 require 'tty-screen'
 require 'tty-reader'
 require 'tty-which'
@@ -13,6 +15,7 @@ require 'na/hash'
 require 'na/colors'
 require 'na/string'
 require 'na/array'
+require 'yaml'
 require 'na/theme'
 require 'na/todo'
 require 'na/actions'

data/na.gemspec

@@ -24,12 +24,14 @@ spec = Gem::Specification.new do |s|
   s.add_development_dependency('minitest', '~> 5.14')
   s.add_development_dependency('rdoc', '~> 4.3')
   s.add_runtime_dependency('chronic', '~> 0.10', '>= 0.10.2')
+  s.add_runtime_dependency('git', '~> 3.0.0')
   s.add_runtime_dependency('gli','~> 2.21.0')
   s.add_runtime_dependency('mdless', '~> 1.0', '>= 1.0.32')
+  s.add_runtime_dependency('ostruct', '~> 0.6', '>= 0.6.1')
   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')
-	s.add_runtime_dependency('git', '~> 3.0.0')
-  s.add_runtime_dependency('ostruct', '~> 0.6', '>= 0.6.1')
   s.add_development_dependency('tty-spinner', '~> 0.9', '>= 0.9.0')
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'bump', '~> 0.6.0'
 end

data/scripts/generate-fish-completions.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require 'tty-progressbar'
 require 'shellwords'
 
@@ -21,7 +23,6 @@ class ::String
 end
 
 class FishCompletions
-
   attr_accessor :commands, :global_options
 
   def generate_helpers
@@ -68,7 +69,7 @@ class FishCompletions
     sections = {}
     scanned.each do |sect|
       title = sect[0].downcase.strip.gsub(/ +/, '_').to_sym
-      content = sect[1].split(/\n/).map(&:strip).delete_if(&:empty?)
+      content = sect[1].split("\n").map(&:strip).delete_if(&:empty?)
       sections[title] = content
     end
     sections
@@ -77,6 +78,7 @@ class FishCompletions
   def parse_option(option)
     res = option.match(/(?:-(?<short>\w), )?(?:--(?:\[no-\])?(?<long>w+)(?:=(?<arg>\w+))?)\s+- (?<desc>.*?)$/)
     return nil unless res
+
     {
       short: res['short'],
       long: res['long'],
@@ -92,7 +94,7 @@ class FishCompletions
   def parse_command(command)
     res = command.match(/^(?<cmd>[^, \t]+)(?<alias>(?:, [^, \t]+)*)?\s+- (?<desc>.*?)$/)
     commands = [res['cmd']]
-    commands.concat(res['alias'].split(/, /).delete_if(&:empty?)) if res['alias']
+    commands.concat(res['alias'].split(', ').delete_if(&:empty?)) if res['alias']
 
     {
       commands: commands,
@@ -106,7 +108,7 @@ class FishCompletions
 
   def generate_subcommand_completions
     out = []
-    @commands.each_with_index do |cmd, i|
+    @commands.each_with_index do |cmd, _i|
       out << "complete -xc na -n '__fish_na_needs_command' -a '#{cmd[:commands].join(' ')}' -d #{Shellwords.escape(cmd[:description])}"
     end
 
@@ -114,35 +116,30 @@ class FishCompletions
   end
 
   def generate_subcommand_option_completions
-
     out = []
     need_export = []
 
-    @commands.each_with_index do |cmd, i|
+    @commands.each_with_index do |cmd, _i|
       @bar.advance
       data = get_help_sections(cmd[:commands].first)
 
-      if data[:synopsis].join(' ').strip.split(/ /).last =~ /(path|file)/i
-        out << "complete -c na -F -n '__fish_na_using_command #{cmd[:commands].join(" ")}'"
-      end
+      out << "complete -c na -F -n '__fish_na_using_command #{cmd[:commands].join(' ')}'" if data[:synopsis].join(' ').strip.split(/ /).last =~ /(path|file)/i
 
-      if data[:command_options]
-        parse_options(data[:command_options]).each do |option|
-          next if option.nil?
+      next unless data[:command_options]
 
-          arg = option[:arg] ? '-r' : ''
-          short = option[:short] ? "-s #{option[:short]}" : ''
-          long = option[:long] ? "-l #{option[:long]}" : ''
-          out << "complete -c na #{long} #{short} -f #{arg} -n '__fish_na_using_command #{cmd[:commands].join(' ')}' -d #{Shellwords.escape(option[:description])}"
+      parse_options(data[:command_options]).each do |option|
+        next if option.nil?
 
-          need_export.concat(cmd[:commands]) if option[:long] == 'output'
-        end
+        arg = option[:arg] ? '-r' : ''
+        short = option[:short] ? "-s #{option[:short]}" : ''
+        long = option[:long] ? "-l #{option[:long]}" : ''
+        out << "complete -c na #{long} #{short} -f #{arg} -n '__fish_na_using_command #{cmd[:commands].join(' ')}' -d #{Shellwords.escape(option[:description])}"
+
+        need_export.concat(cmd[:commands]) if option[:long] == 'output'
       end
     end
 
-    unless need_export.empty?
-      out << "complete -f -c na -s o -l output -x -n '__fish_na_using_command #{need_export.join(' ')}' -a '(__fish_na_export_plugins)'"
-    end
+    out << "complete -f -c na -s o -l output -x -n '__fish_na_using_command #{need_export.join(' ')}' -a '(__fish_na_export_plugins)'" unless need_export.empty?
 
     # clear
     out.join("\n")

data/src/_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 <!--VER-->1.2.78<!--END VER-->.
+The current version of `na` is <!--VER-->1.2.80<!--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. 
+`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.
 
@@ -82,7 +82,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.
 
@@ -163,6 +163,16 @@ Run `na saved` without an argument to list your saved searches.
 @cli(bundle exec bin/na help 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.
+
+```
+@cli(bundle exec bin/na help scan)
+```
+
 ##### tagged
 
 Example: `na tagged feature +maybe`.