na 1.2.79 → 1.2.81

data/lib/na/colors.rb

@@ -5,7 +5,7 @@ module NA
   # Terminal output color functions.
   module Color
     # Regexp to match excape sequences
-    ESCAPE_REGEX = /(?<=\[)(?:(?:(?:[349]|10)[0-9]|[0-9])?;?)+(?=m)/
+    ESCAPE_REGEX = /(?<=\[)(?:(?:(?:[349]|10)[0-9]|[0-9])?;?)+(?=m)/.freeze
 
     # All available color names. Available as methods and string extensions.
     #
@@ -99,35 +99,33 @@ module NA
 
     # Template coloring
     class ::String
-      ##
-      ## Extract the longest valid %color name from a string.
-      ##
-      ## Allows %colors to bleed into other text and still
-      ## be recognized, e.g. %greensomething still finds
-      ## %green.
-      ##
-      ## @return     [String] a valid color name
-      ##
+      # Extract the longest valid %color name from a string.
+      #
+      # Allows %colors to bleed into other text and still
+      # be recognized, e.g. %greensomething still finds
+      # %green.
+      #
+      # @return [String] a valid color name
       def validate_color
         valid_color = nil
         compiled = ''
-        normalize_color.split('').each do |char|
+        normalize_color.chars.each do |char|
           compiled += char
-          valid_color = compiled if Color.attributes.include?(compiled.to_sym) || compiled =~ /^([fb]g?)?#([a-f0-9]{6})$/i
+          if Color.attributes.include?(compiled.to_sym) || compiled =~ /^([fb]g?)?#([a-f0-9]{6})$/i
+            valid_color = compiled
+          end
         end
 
         valid_color
       end
 
-      ##
-      ## Normalize a color name, removing underscores,
-      ## replacing "bright" with "bold", and converting
-      ## bgbold to boldbg
-      ##
-      ## @return     [String] Normalized color name
-      ##
+      # Normalize a color name, removing underscores,
+      # replacing "bright" with "bold", and converting
+      # bgbold to boldbg
+      #
+      # @return [String] Normalized color name
       def normalize_color
-        gsub(/_/, '').sub(/bright/i, 'bold').sub(/bgbold/, 'boldbg')
+        gsub('_', '').sub(/bright/i, 'bold').sub('bgbold', 'boldbg')
       end
 
       # Get the calculated ANSI color at the end of the
@@ -159,20 +157,20 @@ module NA
               rgbb = c
             end
           else
-            c.split(/;/).each do |i|
+            c.split(';').each do |i|
               x = i.to_i
               if x <= 9
                 em << x
-              elsif x >= 30 && x <= 39
+              elsif x.between?(30, 39)
                 rgbf = nil
                 fg = x
-              elsif x >= 40 && x <= 49
+              elsif x.between?(40, 49)
                 rgbb = nil
                 bg = x
-              elsif x >= 90 && x <= 97
+              elsif x.between?(90, 97)
                 rgbf = nil
                 fg = x
-              elsif x >= 100 && x <= 107
+              elsif x.between?(100, 107)
                 rgbb = nil
                 bg = x
               end
@@ -196,63 +194,86 @@ module NA
 
       attr_writer :coloring
 
-      ##
-      ## Enables colored output
-      ##
-      ## @example Turn color on or off based on TTY
-      ##   NA::Color.coloring = STDOUT.isatty
+      # Cache for compiled templates to avoid repeated regex processing
+      def template_cache
+        @template_cache ||= {}
+      end
+
+      def clear_template_cache
+        @template_cache = {}
+      end
+
+      # Pre-computed colors hash (expensive to create, so we cache it)
+      def colors_hash
+        @colors_hash ||= { w: white, k: black, g: green, l: blue,
+                           y: yellow, c: cyan, m: magenta, r: red,
+                           W: bgwhite, K: bgblack, G: bggreen, L: bgblue,
+                           Y: bgyellow, C: bgcyan, M: bgmagenta, R: bgred,
+                           d: dark, b: bold, u: underline, i: italic, x: reset }
+      end
+
+      #
+      # Enables colored output
+      #
+      # @example Turn color on or off based on TTY
+      #   NA::Color.coloring = STDOUT.isatty
       def coloring
         @coloring ||= true
       end
 
-      ##
-      ## Convert a template string to a colored string.
-      ## Colors are specified with single letters inside
-      ## curly braces. Uppercase changes background color.
-      ##
-      ## w: white, k: black, g: green, l: blue, y: yellow,
-      ## c: cyan, m: magenta, r: red, b: bold, u: underline,
-      ## i: italic, x: reset (remove background, color,
-      ## emphasis)
-      ##
-      ## Also accepts {#RGB} and {#RRGGBB} strings. Put a b
-      ## before the hash to make it a background color
-      ##
-      ## @example    Convert a templated string
-      ## Color.template('{Rwb}Warning:{x} {w}you look a
-      ## little {g}ill{x}')
-      ##
-      ## @example    Convert using RGB colors
-      ## Color.template('{#f0a}This is an RGB color')
-      ##
-      ## @param      input  [String, Array] The template
-      ##                    string. If this is an array, the
-      ##                    elements will be joined with a
-      ##                    space.
-      ##
-      ## @return     [String] Colorized string
-      ##
+      #
+      # Convert a template string to a colored string.
+      # Colors are specified with single letters inside
+      # curly braces. Uppercase changes background color.
+      #
+      # w: white, k: black, g: green, l: blue, y: yellow,
+      # c: cyan, m: magenta, r: red, b: bold, u: underline,
+      # i: italic, x: reset (remove background, color,
+      # emphasis)
+      #
+      # Also accepts {#RGB} and {#RRGGBB} strings. Put a b
+      # before the hash to make it a background color
+      #
+      # @example    Convert a templated string
+      # Color.template('{Rwb}Warning:{x} {w}you look a
+      # little {g}ill{x}')
+      #
+      # @example    Convert using RGB colors
+      # Color.template('{#f0a}This is an RGB color')
+      #
+      # @param      input  [String, Array] The template
+      #                    string. If this is an array, the
+      #                    elements will be joined with a
+      #                    space.
+      #
+      # @return     [String] Colorized string
+      #
       def template(input)
         input = input.join(' ') if input.is_a? Array
         return input.gsub(/(?<!\\)\{#?(\w+)\}/i, '') unless NA::Color.coloring?
 
-        input = input.gsub(/(?<!\\)\{((?:[fb]g?)?#[a-f0-9]{3,6})\}/i) do
-                  hex = Regexp.last_match(1)
-                  rgb(hex)
-                end
+        # Check cache first
+        cache_key = input.hash
+        return template_cache[cache_key] if template_cache.key?(cache_key)
 
-        fmt = input.gsub(/%/, '%%')
+        # Process hex colors first
+        processed_input = input.gsub(/(?<!\\)\{((?:[fb]g?)?#[a-f0-9]{3,6})\}/i) do
+          hex = Regexp.last_match(1)
+          rgb(hex)
+        end
+
+        # Convert to format string
+        fmt = processed_input.gsub('%', '%%')
         fmt = fmt.gsub(/(?<!\\)\{(\w+)\}/i) do
-          Regexp.last_match(1).split('').map { |c| "%<#{c}>s" }.join('')
+          Regexp.last_match(1).chars.map { |c| "%<#{c}>s" }.join
         end
 
-        colors = { w: white, k: black, g: green, l: blue,
-                   y: yellow, c: cyan, m: magenta, r: red,
-                   W: bgwhite, K: bgblack, G: bggreen, L: bgblue,
-                   Y: bgyellow, C: bgcyan, M: bgmagenta, R: bgred,
-                   d: dark, b: bold, u: underline, i: italic, x: reset }
+        # Use pre-computed colors hash
+        result = format(fmt, colors_hash)
 
-        format(fmt, colors)
+        # Cache the result
+        template_cache[cache_key] = result
+        result
       end
     end
 
@@ -260,18 +281,18 @@ module NA
       new_method = <<-EOSCRIPT
         # Color string as #{c}
         def #{c}(string = nil)
-          result = ''
-          result << "\e[#{v}m" if NA::Color.coloring?
+          result = ''.dup
+          result << "\e[#{v}m".dup if NA::Color.coloring?
           if block_given?
             result << yield
           elsif string.respond_to?(:to_str)
-            result << string.to_str
+            result << string.to_str.dup
           elsif respond_to?(:to_str)
-            result << to_str
+            result << to_str.dup
           else
             return result #only switch on
           end
-          result << "\e[0m" if NA::Color.coloring?
+          result << "\e[0m".dup if NA::Color.coloring?
           result
         end
       EOSCRIPT
@@ -283,19 +304,19 @@ module NA
       # Accept brightwhite in addition to boldwhite
       new_method = <<-EOSCRIPT
         # color string as #{c}
-        def #{c.to_s.sub(/bold/, 'bright')}(string = nil)
-          result = ''
-          result << "\e[#{v}m" if NA::Color.coloring?
+        def #{c.to_s.sub('bold', 'bright')}(string = nil)
+          result = ''.dup
+          result << "\e[#{v}m".dup if NA::Color.coloring?
           if block_given?
             result << yield
           elsif string.respond_to?(:to_str)
-            result << string.to_str
+            result << string.to_str.dup
           elsif respond_to?(:to_str)
-            result << to_str
+            result << to_str.dup
           else
             return result #only switch on
           end
-          result << "\e[0m" if NA::Color.coloring?
+          result << "\e[0m".dup if NA::Color.coloring?
           result
         end
       EOSCRIPT
@@ -303,13 +324,13 @@ module NA
       module_eval(new_method)
     end
 
-    ##
-    ## Generate escape codes for hex colors
-    ##
-    ## @param      hex   [String] The hexadecimal color code
-    ##
-    ## @return     [String] ANSI escape string
-    ##
+    #
+    # Generate escape codes for hex colors
+    #
+    # @param      hex   [String] The hexadecimal color code
+    #
+    # @return     [String] ANSI escape string
+    #
     def rgb(hex)
       is_bg = hex.match(/^bg?#/) ? true : false
       hex_string = hex.sub(/^([fb]g?)?#/, '')
@@ -322,13 +343,12 @@ module NA
           t << parts[e]
           t << parts[e]
         end
-        hex_string = t.join('')
+        hex_string = t.join
       end
 
       parts = hex_string.match(/(?<r>..)(?<g>..)(?<b>..)/)
-      t = []
-      %w[r g b].each do |e|
-        t << parts[e].hex
+      t = %w[r g b].map do |e|
+        parts[e].hex
       end
 
       "\e[#{is_bg ? '48' : '38'};2;#{t.join(';')}m"
@@ -336,7 +356,7 @@ module NA
 
     # Regular expression that is used to scan for ANSI-sequences while
     # uncoloring strings.
-    COLORED_REGEXP = /\e\[(?:(?:(?:[349]|10)[0-9]|[0-9])?;?)+m/
+    COLORED_REGEXP = /\e\[(?:(?:(?:[349]|10)[0-9]|[0-9])?;?)+m/.freeze
 
     # Returns an uncolored version of the string, that is all
     # ANSI-sequences are stripped from the string.
@@ -356,6 +376,7 @@ module NA
     def attributes
       ATTRIBUTE_NAMES
     end
+
     extend self
   end
 end

data/lib/na/editor.rb

@@ -1,16 +1,20 @@
+# frozen_string_literal: true
+
+require 'English'
+
 module NA
   module Editor
     class << self
       def default_editor(prefer_git_editor: true)
-        if prefer_git_editor
-          editor ||= ENV['NA_EDITOR'] || ENV['GIT_EDITOR'] || ENV['EDITOR']
-        else
-          editor ||= ENV['NA_EDITOR'] || ENV['EDITOR'] || ENV['GIT_EDITOR']
-        end
+        editor ||= if prefer_git_editor
+                     ENV['NA_EDITOR'] || ENV['GIT_EDITOR'] || ENV.fetch('EDITOR', nil)
+                   else
+                     ENV['NA_EDITOR'] || ENV['EDITOR'] || ENV.fetch('GIT_EDITOR', nil)
+                   end
 
         return editor if editor&.good? && TTY::Which.exist?(editor)
 
-        NA.notify("No EDITOR environment variable, testing available editors", debug: true)
+        NA.notify('No EDITOR environment variable, testing available editors', debug: true)
         editors = %w[vim vi code subl mate mvim nano emacs]
         editors.each do |ed|
           try = TTY::Which.which(ed)
@@ -43,11 +47,10 @@ module NA
         "#{editor} #{args.join(' ')}"
       end
 
-      ##
-      ## Create a process for an editor and wait for the file handle to return
-      ##
-      ## @param      input  [String] Text input for editor
-      ##
+      # Create a process for an editor and wait for the file handle to return
+      #
+      # @param input [String] Text input for editor
+      # @return [String] Edited text
       def fork_editor(input = '', message: :default)
         # raise NonInteractive, 'Non-interactive terminal' unless $stdout.isatty || ENV['DOING_EDITOR_TEST']
 
@@ -78,8 +81,8 @@ module NA
         Process.wait(pid)
 
         begin
-          if $?.exitstatus == 0
-            input = IO.read(tmpfile.path)
+          if $CHILD_STATUS.exitstatus.zero?
+            input = File.read(tmpfile.path)
           else
             exit_now! 'Cancelled'
           end
@@ -88,16 +91,13 @@ module NA
           tmpfile.unlink
         end
 
-        input.split(/\n/).delete_if(&:ignore?).join("\n")
+        input.split("\n").delete_if(&:ignore?).join("\n")
       end
 
-      ##
-      ## Takes a multi-line string and formats it as an entry
-      ##
-      ## @param      input  [String] The string to parse
-      ##
-      ## @return     [Array] [[String]title, [Note]note]
-      ##
+      # Takes a multi-line string and formats it as an entry
+      #
+      # @param input [String] The string to parse
+      # @return [Array] [[String]title, [Note]note]
       def format_input(input)
         NA.notify("#{NA.theme[:error]}No content in entry", exit_code: 1) if input.nil? || input.strip.empty?
 
@@ -108,7 +108,7 @@ module NA
         title = title.expand_date_tags
 
         note = if input_lines.length > 1
-                 input_lines[1..-1]
+                 input_lines[1..]
                else
                  []
                end

data/lib/na/hash.rb

@@ -1,15 +1,17 @@
 # frozen_string_literal: true
 
 class ::Hash
+  # Convert all keys in the hash to symbols recursively
+  #
+  # @return [Hash] Hash with symbolized keys
   def symbolize_keys
     each_with_object({}) { |(k, v), hsh| hsh[k.to_sym] = v.is_a?(Hash) ? v.symbolize_keys : v }
   end
 
-  ##
-  ## Freeze all values in a hash
-  ##
-  ## @return     Hash with all values frozen
-  ##
+  #
+  # Freeze all values in a hash
+  #
+  # @return     Hash with all values frozen
   def deep_freeze
     chilled = {}
     each do |k, v|
@@ -19,10 +21,16 @@ class ::Hash
     chilled.freeze
   end
 
+  # Freeze all values in a hash in place
+  #
+  # @return [Hash] Hash with all values frozen
   def deep_freeze!
     replace deep_thaw.deep_freeze
   end
 
+  # Recursively duplicate all values in a hash
+  #
+  # @return [Hash] Hash with all values duplicated
   def deep_thaw
     chilled = {}
     each do |k, v|
@@ -32,12 +40,27 @@ class ::Hash
     chilled.dup
   end
 
+  # Recursively duplicate all values in a hash in place
+  #
+  # @return [Hash] Hash with all values duplicated
   def deep_thaw!
     replace deep_thaw
   end
 
-	def deep_merge(second)
-	    merger = proc { |_, v1, v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : Array === v1 && Array === v2 ? v1 | v2 : [:undefined, nil, :nil].include?(v2) ? v1 : v2 }
-	    merge(second.to_h, &merger)
-	end
+  # Recursively merge two hashes, combining arrays and preferring non-nil values
+  #
+  # @param second [Hash] The hash to merge with
+  # @return [Hash] The merged hash
+  def deep_merge(second)
+    merger = proc { |_, v1, v2|
+      if v1.is_a?(Hash) && v2.is_a?(Hash)
+        v1.merge(v2, &merger)
+      elsif v1.is_a?(Array) && v2.is_a?(Array)
+        v1 | v2
+      else
+        [:undefined, nil, :nil].include?(v2) ? v1 : v2
+      end
+    }
+    merge(second.to_h, &merger)
+  end
 end

data/lib/na/help_monkey_patch.rb

@@ -4,7 +4,15 @@ module GLI
   module Commands
     # Help Command Monkeypatch for paginated output
     class Help < Command
-      def show_help(global_options, options, arguments, out, error)
+      # Show help output for GLI commands with paginated output
+      #
+      # @param global_options [Hash] Global CLI options
+      # @param options [Hash] Command-specific options
+      # @param arguments [Array] Command arguments
+      # @param out [IO] Output stream
+      # @param error [IO] Error stream
+      # @return [void]
+      def show_help(_global_options, options, arguments, out, error)
         NA::Pager.paginate = true
 
         command_finder = HelpModules::CommandFinder.new(@app, arguments, error)