na 1.2.80 → 1.2.82

data/lib/na/pager.rb

@@ -7,22 +7,21 @@ module NA
   module Pager
     class << self
       # Boolean determines whether output is paginated
+      #
+      # @return [Boolean] true if paginated
       def paginate
         @paginate ||= false
       end
 
       # Enable/disable pagination
       #
-      # @param      should_paginate  [Boolean] true to paginate
-      def paginate=(should_paginate)
-        @paginate = should_paginate
-      end
+      # @return [void]
+      attr_writer :paginate
 
-      # Page output. If @paginate is false, just dump to
-      # STDOUT
-      #
-      # @param      text  [String] text to paginate
+      # Page output. If @paginate is false, just dump to STDOUT
       #
+      # @param text [String] text to paginate
+      # @return [Boolean, nil] true if paged, false if not, nil if no pager
       def page(text)
         unless @paginate
           puts text
@@ -53,31 +52,53 @@ module NA
           # Wait for pager to complete
           _, status = Process.waitpid2(pid)
           status.success?
-        rescue SystemCallError => e
+        rescue SystemCallError
           # Clean up on error
-          write_io.close rescue nil
-          Process.kill('TERM', pid) rescue nil
-          Process.waitpid(pid) rescue nil
+          begin
+            write_io.close
+          rescue StandardError
+            nil
+          end
+          begin
+            Process.kill('TERM', pid)
+          rescue StandardError
+            nil
+          end
+          begin
+            Process.waitpid(pid)
+          rescue StandardError
+            nil
+          end
           false
         end
       end
 
       private
 
+      # Get the git pager command if available
+      #
+      # @return [String, nil] git pager command
       def git_pager
         TTY::Which.exist?('git') ? `#{TTY::Which.which('git')} config --get-all core.pager` : nil
       end
 
+      # List of possible pager commands
+      #
+      # @return [Array<String>] pager commands
       def pagers
         [
-          ENV['PAGER'],
+          ENV.fetch('PAGER', nil),
           'less -FXr',
-          ENV['GIT_PAGER'],
+          ENV.fetch('GIT_PAGER', nil),
           git_pager,
           'more -r'
         ].remove_bad
       end
 
+      # Find the first available executable pager command
+      #
+      # @param commands [Array<String>] commands to check
+      # @return [String, nil] first available command
       def find_executable(*commands)
         execs = commands.empty? ? pagers : commands
         execs
@@ -85,6 +106,9 @@ module NA
           .find { |cmd| TTY::Which.exist?(cmd.split.first) }
       end
 
+      # Determine which pager to use
+      #
+      # @return [String, nil] pager command
       def which_pager
         @which_pager ||= find_executable(*pagers)
       end

data/lib/na/project.rb

@@ -4,6 +4,13 @@ module NA
   class Project < Hash
     attr_accessor :project, :indent, :line, :last_line
 
+    # Initialize a Project object
+    #
+    # @param project [String] Project name
+    # @param indent [Integer] Indentation level
+    # @param line [Integer] Starting line number
+    # @param last_line [Integer] Ending line number
+    # @return [void]
     def initialize(project, indent = 0, line = 0, last_line = 0)
       super()
       @project = project
@@ -12,17 +19,23 @@ module NA
       @last_line = last_line
     end
 
+    # String representation of the project
+    #
+    # @return [String]
     def to_s
       { project: @project, indent: @indent, line: @line, last_line: @last_line }.to_s
     end
 
+    # Inspect the project object
+    #
+    # @return [String]
     def inspect
       [
         "@project: #{@project}",
         "@indent: #{@indent}",
         "@line: #{@line}",
         "@last_line: #{@last_line}"
-      ].join(" ")
+      ].join(' ')
     end
   end
 end

data/lib/na/prompt.rb

@@ -4,6 +4,10 @@ module NA
   # Prompt Hooks
   module Prompt
     class << self
+      # Generate the shell prompt hook script for na
+      #
+      # @param shell [Symbol] Shell type (:zsh, :fish, :bash)
+      # @return [String] Shell script for prompt hook
       def prompt_hook(shell)
         case shell
         when :zsh
@@ -14,7 +18,9 @@ module NA
                   when :tag
                     'na tagged $(basename "$PWD")'
                   else
-                    NA.notify("#{NA.theme[:error]}When using a global file, a prompt hook requires `--cwd_as [tag|project]`", exit_code: 1)
+                    NA.notify(
+                      "#{NA.theme[:error]}When using a global file, a prompt hook requires `--cwd_as [tag|project]`", exit_code: 1
+                    )
                   end
                 else
                   'na next'
@@ -31,7 +37,9 @@ module NA
                   when :tag
                     'na tagged (basename "$PWD")'
                   else
-                    NA.notify("#{NA.theme[:error]}When using a global file, a prompt hook requires `--cwd_as [tag|project]`", exit_code: 1)
+                    NA.notify(
+                      "#{NA.theme[:error]}When using a global file, a prompt hook requires `--cwd_as [tag|project]`", exit_code: 1
+                    )
                   end
                 else
                   'na next'
@@ -50,7 +58,9 @@ module NA
                   when :tag
                     'na tagged $(basename "$PWD")'
                   else
-                    NA.notify("#{NA.theme[:error]}When using a global file, a prompt hook requires `--cwd_as [tag|project]`", exit_code: 1)
+                    NA.notify(
+                      "#{NA.theme[:error]}When using a global file, a prompt hook requires `--cwd_as [tag|project]`", exit_code: 1
+                    )
                   end
                 else
                   'na next'
@@ -70,6 +80,10 @@ module NA
         end
       end
 
+      # Get the configuration file path for the given shell
+      #
+      # @param shell [Symbol] Shell type
+      # @return [String] Path to shell config file
       def prompt_file(shell)
         files = {
           zsh: '~/.zshrc',
@@ -80,6 +94,10 @@ module NA
         files[shell]
       end
 
+      # Display the prompt hook script and notify user of config file
+      #
+      # @param shell [Symbol] Shell type
+      # @return [void]
       def show_prompt_hook(shell)
         file = prompt_file(shell)
 
@@ -87,6 +105,10 @@ module NA
         puts prompt_hook(shell)
       end
 
+      # Install the prompt hook script into the shell config file
+      #
+      # @param shell [Symbol] Shell type
+      # @return [void]
       def install_prompt_hook(shell)
         file = prompt_file(shell)
 

data/lib/na/string.rb

@@ -6,30 +6,20 @@ REGEX_TIME = /^#{REGEX_CLOCK}$/i.freeze
 
 # String helpers
 class ::String
-  ##
-  ## Insert a comment character at the start of every line
-  ##
-  ## @param      char  [String] The character to insert (default #)
-  ##
-  def comment(char = "#")
-    split(/\n/).map { |l| "# #{l}" }.join("\n")
+  # Insert a comment character at the start of every line
+  # @param char [String] The character to insert (default #)
+  def comment(_char = '#')
+    split("\n").map { |l| "# #{l}" }.join("\n")
   end
 
-  ##
-  ## Tests if object is nil or empty
-  ##
-  ## @return     [Boolean] true if object is defined and
-  ##             has content
-  ##
+  # Tests if object is nil or empty
+  # @return [Boolean] true if object is defined and has content
   def good?
     !strip.empty?
   end
 
-  ##
-  ## Test if line should be ignored
-  ##
-  ## @return     [Boolean] line is empty or comment
-  ##
+  # Test if line should be ignored
+  # @return [Boolean] line is empty or comment
   def ignore?
     line = self
     line =~ /^#/ || line.strip.empty?
@@ -50,19 +40,16 @@ class ::String
     end
 
     # IO.read(file).force_encoding('ASCII-8BIT').encode('UTF-8', invalid: :replace, undef: :replace, replace: '?')
-    IO.read(file).force_encoding('utf-8')
+    File.read(file).force_encoding('utf-8')
   end
 
-  ##
-  ## Determine indentation level of line
-  ##
-  ## @return     [Number] number of indents detected
-  ##
+  # Determine indentation level of line
+  # @return [Number] number of indents detected
   def indent_level
     prefix = match(/(^[ \t]+)/)
     return 0 if prefix.nil?
 
-    prefix[1].gsub(/    /, "\t").scan(/\t/).count
+    prefix[1].gsub('    ', "\t").scan("\t").count
   end
 
   def action?
@@ -94,31 +81,22 @@ class ::String
     self =~ /@#{NA.na_tag}\b/
   end
 
-  ##
-  ## Colorize the dirname and filename of a path
-  ##
-  ## @return     Colorized string
-  ##
+  # Colorize the dirname and filename of a path
+  # @return [String] Colorized string
   def highlight_filename
     dir = File.dirname(self).shorten_path.trunc_middle(TTY::Screen.columns / 3)
     file = NA.include_ext ? File.basename(self) : File.basename(self, ".#{NA.extension}")
     "#{NA.theme[:dirname]}#{dir}/#{NA.theme[:filename]}#{file}{x}"
   end
 
-  ##
-  ## Colorize @tags with ANSI escapes
-  ##
-  ## @param      color       [String] color (see #Color)
-  ## @param      value       [String] The value color
-  ##                         template
-  ## @param      parens      [String] The parens color
-  ##                         template
-  ## @param      last_color  [String] Color to restore after
-  ##                         tag highlight
-  ##
-  ## @return     [String] string with @tags highlighted
-  ##
-  def highlight_tags(color: NA.theme[:tags], value: NA.theme[:value], parens: NA.theme[:value_parens], last_color: NA.theme[:action])
+  # Colorize @tags with ANSI escapes
+  # @param color [String] color (see #Color)
+  # @param value [String] The value color template
+  # @param parens [String] The parens color template
+  # @param last_color [String] Color to restore after tag highlight
+  # @return [String] string with @tags highlighted
+  def highlight_tags(color: NA.theme[:tags], value: NA.theme[:value], parens: NA.theme[:value_parens],
+                     last_color: NA.theme[:action])
     tag_color = NA::Color.template(color)
     paren_color = NA::Color.template(parens)
     value_color = NA::Color.template(value)
@@ -132,21 +110,16 @@ class ::String
     end
   end
 
-  ##
-  ## Highlight search results
-  ##
-  ## @param      regexes     [Array] The regexes for the
-  ##                         search
-  ## @param      color       [String] The highlight color
-  ##                         template
-  ## @param      last_color  [String] Color to restore after
-  ##                         highlight
-  ##
+  # Highlight search results
+  # @param regexes [Array] The regexes for the search
+  # @param color [String] The highlight color template
+  # @param last_color [String] Color to restore after highlight
   def highlight_search(regexes, color: NA.theme[:search_highlight], last_color: NA.theme[:action])
     string = dup
     color = NA::Color.template(color.dup)
     regexes.each do |rx|
       next if rx.nil?
+
       rx = Regexp.new(rx, Regexp::IGNORECASE) if rx.is_a?(String)
 
       string.gsub!(rx) do
@@ -158,70 +131,71 @@ class ::String
     string
   end
 
+  # Truncate the string in the middle, replacing the removed section with '[...]'.
+  # @param max [Integer] Maximum allowed length of the string
+  # @return [String] Truncated string with middle replaced if necessary
   def trunc_middle(max)
     return self unless length > max
 
     half = (max / 2).floor - 3
-    chars = split('')
+    chars = chars
     pre = chars.slice(0, half)
     post = chars.reverse.slice(0, half).reverse
-    "#{pre.join('')}[...]#{post.join('')}"
+    "#{pre.join}[...]#{post.join}"
   end
 
+  # Wrap the string to a given width, indenting each line and preserving tag formatting.
+  # @param width [Integer] The maximum line width
+  # @param indent [Integer] Number of spaces to indent each line
+  # @return [String] Wrapped string
   def wrap(width, indent)
     return "\n#{self}" if width <= 80
 
     output = []
     line = []
-    length = indent
+    length = 0
     gsub!(/(@\S+)\((.*?)\)/) { "#{Regexp.last_match(1)}(#{Regexp.last_match(2).gsub(/ /, '†')})" }
 
     split(' ').each do |word|
       uncolored = NA::Color.uncolor(word)
-      if (length + uncolored.length + 1) < width
+      if (length + uncolored.length + 1) <= width
         line << word
         length += uncolored.length + 1
       else
         output << line.join(' ')
         line = [word]
-        length = indent + uncolored.length + 1
+        length = uncolored.length + 1
       end
     end
     output << line.join(' ')
-    output.join("\n" + ' ' * (indent + 2)).gsub(/†/, ' ')
+    # Indent all lines after the first
+    output.each_with_index.map { |l, i| i.zero? ? l : (' ' * indent) + l }.join("\n").gsub(/†/, ' ')
   end
 
   # Returns the last escape sequence from a string.
-  #
-  # @note       Actually returns all escape codes, with the
-  #             assumption that the result of inserting them
-  #             will generate the same color as was set at
-  #             the end of the string. Because you can send
-  #             modifiers like dark and bold separate from
-  #             color codes, only using the last code may
-  #             not render the same style.
-  #
-  # @return     [String]  All escape codes in string
-  #
+  # @note Actually returns all escape codes, with the assumption that the result of inserting them will generate the same color as was set at end of the string. Because you can send modifiers like dark and bold separate from color codes, only using the last code may not render the same style.
+  # @return [String] All escape codes in string
   def last_color
-    scan(/\e\[[\d;]+m/).join('').gsub(/\e\[0m/, '')
+    scan(/\e\[[\d;]+m/).join.gsub("\e[0m", '')
   end
 
-  ##
-  ## Convert a directory path to a regular expression
-  ##
-  ## @note       Splits at / or :, adds variable distance
-  ##             between characters, joins segments with
-  ##             slashes and requires that last segment
-  ##             match last segment of target path
-  ##
-  ## @param      distance      The distance allowed between characters
-  ## @param      require_last  Require match to be last element in path
-  ##
+  # Convert a directory path to a regular expression
+  # @note Splits at / or :, adds variable distance between characters, joins segments with slashes and requires that last segment match last segment of target path
+  # @param distance [Integer] The distance allowed between characters
+  # @param require_last [Boolean] Require match to be last element in path
   def dir_to_rx(distance: 1, require_last: true)
-    "#{split(%r{[/:]}).map { |comp| comp.split('').join(".{0,#{distance}}").gsub(/\*/, '[^ ]*?') }.join('.*?/.*?')}#{require_last ? '[^/]*?$' : ''}"
+    "#{split(%r{[/:]}).map do |comp|
+      comp.chars.join(".{0,#{distance}}").gsub('*', '[^ ]*?')
+    end.join('.*?/.*?')}#{require_last ? '[^/]*?$' : ''}"
   end
 
+  # Check if the string matches directory patterns using any, all, and none criteria.
+  # @param any [Array] Patterns where any match is sufficient
+  # @param all [Array] Patterns where all must match
+  # @param none [Array] Patterns where none must match
+  # @param require_last [Boolean] Require last segment match
+  # @param distance [Integer] Allowed character distance in regex
+  # @return [Boolean] True if matches criteria
   def dir_matches(any: [], all: [], none: [], require_last: true, distance: 1)
     any_rx = any.map { |q| q.dir_to_rx(distance: distance, require_last: require_last) }
     all_rx = all.map { |q| q.dir_to_rx(distance: distance, require_last: require_last) }
@@ -229,29 +203,29 @@ class ::String
     matches_any(any_rx) && matches_all(all_rx) && matches_none(none_rx)
   end
 
+  # Check if the string matches any, all, and none regex patterns.
+  # @param any [Array] Patterns where any match is sufficient
+  # @param all [Array] Patterns where all must match
+  # @param none [Array] Patterns where none must match
+  # @return [Boolean] True if matches criteria
   def matches(any: [], all: [], none: [])
     matches_any(any) && matches_all(all) && matches_none(none)
   end
 
-  ##
-  ## Convert wildcard characters to regular expressions
-  ##
-  ## @return     [String] Regex string
-  ##
+  # Convert wildcard characters to regular expressions
+  # @return [String] Regex string
   def wildcard_to_rx
-    gsub(/\./, '\\.').gsub(/\?/, '.').gsub(/\*/, '[^ ]*?')
+    gsub('.', '\\.').gsub('?', '.').gsub('*', '[^ ]*?')
   end
 
+  # Capitalize the first character of the string in place.
+  # @return [String] The modified string
   def cap_first!
     replace cap_first
   end
 
-  ##
-  ## Capitalize first character, leaving other
-  ## capitalization in place
-  ##
-  ## @return     [String] capitalized string
-  ##
+  # Capitalize first character, leaving other capitalization in place
+  # @return [String] capitalized string
   def cap_first
     sub(/^([a-z])(.*)$/) do
       m = Regexp.last_match
@@ -259,24 +233,14 @@ class ::String
     end
   end
 
-  ##
-  ## Replace home directory with tilde
-  ##
-  ## @return     [String] shortened path
-  ##
+  # Replace home directory with tilde
+  # @return [String] shortened path
   def shorten_path
-    sub(/^#{ENV['HOME']}/, '~')
+    sub(/^#{Dir.home}/, '~')
   end
 
-  ##
-  ## Convert (chronify) natural language dates
-  ## within configured date tags (tags whose value is
-  ## expected to be a date). Modifies string in place.
-  ##
-  ## @param      additional_tags  [Array] An array of
-  ##                              additional tags to
-  ##                              consider date_tags
-  ##
+  # Convert (chronify) natural language dates within configured date tags (tags whose value is expected to be a date). Modifies string in place.
+  # @param additional_tags [Array] An array of additional tags to consider date_tags
   def expand_date_tags(additional_tags = nil)
     iso_rx = /\d{4}-\d\d-\d\d \d\d:\d\d/
 
@@ -312,27 +276,14 @@ class ::String
     end
   end
 
-  ##
-  ## Converts input string into a Time object when input
-  ## takes on the following formats:
-  ##             - interval format e.g. '1d2h30m', '45m'
-  ##               etc.
-  ##             - a semantic phrase e.g. 'yesterday
-  ##               5:30pm'
-  ##             - a strftime e.g. '2016-03-15 15:32:04
-  ##               PDT'
-  ##
-  ## @param      options  Additional options
-  ##
-  ## @option options :future [Boolean] assume future date
-  ##                                   (default: false)
-  ##
-  ## @option options :guess  [Symbol] :begin or :end to
-  ##                                   assume beginning or end of
-  ##                                   arbitrary time range
-  ##
-  ## @return     [DateTime] result
-  ##
+  # Converts input string into a Time object when input takes on the following formats:
+  #   - interval format e.g. '1d2h30m', '45m' etc.
+  #   - a semantic phrase e.g. 'yesterday 5:30pm'
+  #   - a strftime e.g. '2016-03-15 15:32:04 PDT'
+  # @param options [Hash] Additional options
+  # @option options :future [Boolean] assume future date (default: false)
+  # @option options :guess [Symbol] :begin or :end to assume beginning or end of arbitrary time range
+  # @return [DateTime] result
   def chronify(**options)
     now = Time.now
     raise StandardError, "Invalid time expression #{inspect}" if to_s.strip == ''
@@ -353,7 +304,7 @@ class ::String
     else
       date_string = dup
       date_string = 'today' if date_string.match(REGEX_DAY) && now.strftime('%a') =~ /^#{Regexp.last_match(1)}/i
-      date_string = "#{options[:context].to_s} #{date_string}" if date_string =~ REGEX_TIME && options[:context]
+      date_string = "#{options[:context]} #{date_string}" if date_string =~ REGEX_TIME && options[:context]
 
       require 'chronic' unless defined?(Chronic)
       res = Chronic.parse(date_string, {
@@ -368,8 +319,12 @@ class ::String
     res
   end
 
+  # Private helper methods for pattern matching
   private
 
+  # Returns true if none of the regexes match the string.
+  # @param regexes [Array] Array of regex patterns
+  # @return [Boolean] True if none match
   def matches_none(regexes)
     regexes.each do |rx|
       return false if match(Regexp.new(rx, Regexp::IGNORECASE))
@@ -377,6 +332,9 @@ class ::String
     true
   end
 
+  # Returns true if any of the regexes match the string.
+  # @param regexes [Array] Array of regex patterns
+  # @return [Boolean] True if any match
   def matches_any(regexes)
     regexes.each do |rx|
       return true if match(Regexp.new(rx, Regexp::IGNORECASE))
@@ -384,6 +342,9 @@ class ::String
     false
   end
 
+  # Returns true if all of the regexes match the string.
+  # @param regexes [Array] Array of regex patterns
+  # @return [Boolean] True if all match
   def matches_all(regexes)
     regexes.each do |rx|
       return false unless match(Regexp.new(rx, Regexp::IGNORECASE))