Class: String

Inherits:
Object
  • Object
show all
Defined in:
lib/na/colors.rb,
lib/na/string.rb

Overview

String helpers

Instance Method Summary collapse

Instance Method Details

#action ⇒ Object 



52
53
54
 
# File 'lib/na/string.rb', line 52

def action
  sub(/^[ \t]*- /, '')
end

#action? ⇒ Boolean

Returns:

  • (Boolean) 


35
36
37
 
# File 'lib/na/string.rb', line 35

def action?
  self =~ /^[ \t]*- /
end

#blank? ⇒ Boolean

Returns:

  • (Boolean) 


39
40
41
 
# File 'lib/na/string.rb', line 39

def blank?
  strip =~ /^$/
end

#cap_first ⇒ String

Capitalize first character, leaving other capitalization in place

Returns:

  • (String) —

    capitalized string



173
174
175
176
177
178
 
# File 'lib/na/string.rb', line 173

def cap_first
  sub(/^([a-z])(.*)$/) do
    m = Regexp.last_match
    m[1].upcase << m[2]
  end
end

#cap_first! ⇒ Object 



163
164
165
 
# File 'lib/na/string.rb', line 163

def cap_first!
  replace cap_first
end

#dir_matches(any: [], all: [], none: [], require_last: true, distance: 1) ⇒ Object 



143
144
145
146
147
148
 
# File 'lib/na/string.rb', line 143

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) }
  none_rx = none.map { |q| q.dir_to_rx(distance: distance, require_last: false) }
  matches_any(any_rx) && matches_all(all_rx) && matches_none(none_rx)
end

#dir_to_rx(distance: 1, require_last: true) ⇒ Object

Note:

Splits at / or :, adds variable distance between characters, joins segments with slashes and requires that last segment match last segment of target path

Convert a directory path to a regular expression

Parameters:

  • distance (defaults to: 1) —

    The distance allowed between characters

  • require_last (defaults to: true) —

    Require match to be last element in path



139
140
141
 
# File 'lib/na/string.rb', line 139

def dir_to_rx(distance: 1, require_last: true)
  "#{split(%r{[/:]}).map { |comp| comp.split('').join(".{0,#{distance}}").gsub(/\*/, '[^ ]*?') }.join('.*?/.*?')}#{require_last ? '[^/]*?$' : ''}"
end

#done? ⇒ Boolean

Returns:

  • (Boolean) 


56
57
58
 
# File 'lib/na/string.rb', line 56

def done?
  self =~ /@done/
end

#good? ⇒ Boolean

Tests if object is nil or empty

Returns:

  • (Boolean) —

    true if object is defined and has content



11
12
13
 
# File 'lib/na/string.rb', line 11

def good?
  !strip.empty?
end

#highlight_search(regexes, color: '{y}', last_color: '{xg}') ⇒ Object

Highlight search results

Parameters:

  • regexes (Array) —

    The regexes for the search

  • color (String) (defaults to: '{y}') —

    The highlight color template

  • last_color (String) (defaults to: '{xg}') —

    Color to restore after highlight



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/na/string.rb', line 95

def highlight_search(regexes, color: '{y}', last_color: '{xg}')
  string = dup
  color = NA::Color.template(color)
  regexes.each do |rx|
    next if rx.nil?

    rx = Regexp.new(rx.wildcard_to_rx, Regexp::IGNORECASE) if rx.is_a?(String)

    string.gsub!(rx) do
      m = Regexp.last_match
      last = m.pre_match.last_color
      "#{color}#{m[0]}#{NA::Color.template(last)}"
    end
  end
  string
end

#highlight_tags(color: '{m}', value: '{y}', parens: '{m}', last_color: '{xg}') ⇒ String

Colorize @tags with ANSI escapes

Parameters:

  • color (String) (defaults to: '{m}') —

    color (see #Color)

  • value (String) (defaults to: '{y}') —

    The value color template

  • parens (String) (defaults to: '{m}') —

    The parens color template

  • last_color (String) (defaults to: '{xg}') —

    Color to restore after tag highlight

Returns:

  • (String) —

    string with @tags highlighted



77
78
79
80
81
82
83
 
# File 'lib/na/string.rb', line 77

def highlight_tags(color: '{m}', value: '{y}', parens: '{m}', last_color: '{xg}')
  tag_color = NA::Color.template(color)
  paren_color = NA::Color.template(parens)
  value_color = NA::Color.template(value)
  gsub(/(\s|m)(@[^ ("']+)(?:(\()(.*?)(\)))?/,
       "\\1#{tag_color}\\2#{paren_color}\\3#{value_color}\\4#{paren_color}\\5#{last_color}")
end

#indent_level ⇒ Number

Determine indentation level of line

Returns:

  • (Number) —

    number of indents detected



28
29
30
31
32
33
 
# File 'lib/na/string.rb', line 28

def indent_level
  prefix = match(/(^[ \t]+)/)
  return 0 if prefix.nil?

  prefix[1].gsub(/  /, "\t").scan(/\t/).count
end

#last_color ⇒ 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.

Returns the last escape sequence from a string.

Returns:

  • (String) —

    All escape codes in string



124
125
126
 
# File 'lib/na/string.rb', line 124

def last_color
  scan(/\e\[[\d;]+m/).join('').gsub(/\e\[0m/, '')
end

#last_color_code ⇒ Object

Get the calculated ANSI color at the end of the string

Returns:

  • ANSI escape sequence to match color



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/na/colors.rb', line 138

def last_color_code
  m = scan(ESCAPE_REGEX)

  em = ['0']
  fg = nil
  bg = nil
  rgbf = nil
  rgbb = nil

  m.each do |c|
    case c
    when '0'
      em = ['0']
      fg, bg, rgbf, rgbb = nil
    when /^[34]8/
      case c
      when /^3/
        fg = nil
        rgbf = c
      when /^4/
        bg = nil
        rgbb = c
      end
    else
      c.split(/;/).each do |i|
        x = i.to_i
        if x <= 9
          em << x
        elsif x >= 30 && x <= 39
          rgbf = nil
          fg = x
        elsif x >= 40 && x <= 49
          rgbb = nil
          bg = x
        elsif x >= 90 && x <= 97
          rgbf = nil
          fg = x
        elsif x >= 100 && x <= 107
          rgbb = nil
          bg = x
        end
      end
    end
  end

  escape = "\e[#{em.join(';')}m"
  escape += "\e[#{rgbb}m" if rgbb
  escape += "\e[#{rgbf}m" if rgbf
  escape + "\e[#{[fg, bg].delete_if(&:nil?).join(';')}m"
end

#matches(any: [], all: [], none: []) ⇒ Object 



150
151
152
 
# File 'lib/na/string.rb', line 150

def matches(any: [], all: [], none: [])
  matches_any(any) && matches_all(all) && matches_none(none)
end

#na? ⇒ Boolean

Returns:

  • (Boolean) 


60
61
62
 
# File 'lib/na/string.rb', line 60

def na?
  self =~ /@#{NA.na_tag}\b/
end

#normalize_color ⇒ String

Normalize a color name, removing underscores, replacing “bright” with “bold”, and converting bgbold to boldbg

Returns:

  • (String) —

    Normalized color name



129
130
131
 
# File 'lib/na/colors.rb', line 129

def normalize_color
  gsub(/_/, '').sub(/bright/i, 'bold').sub(/bgbold/, 'boldbg')
end

#project ⇒ Object 



47
48
49
50
 
# File 'lib/na/string.rb', line 47

def project
  m = match(/^([ \t]*)([^\-][^@:]*?): *(@\S+ *)*$/)
  m ? m[2] : nil
end

#project? ⇒ Boolean

Returns:

  • (Boolean) 


43
44
45
 
# File 'lib/na/string.rb', line 43

def project?
  !action? && self =~ /:( +@\S+(\([^)]*\))?)*$/
end

#read_file ⇒ Object 



15
16
17
18
19
20
21
 
# File 'lib/na/string.rb', line 15

def read_file
  file = File.expand_path(self)
  raise "Missing file #{file}" unless File.exist?(file)

  # IO.read(file).force_encoding('ASCII-8BIT').encode('UTF-8', invalid: :replace, undef: :replace, replace: '?')
  IO.read(file).force_encoding('utf-8')
end

#shorten_path ⇒ String

Replace home directory with tilde

Returns:



185
186
187
 
# File 'lib/na/string.rb', line 185

def shorten_path
  sub(/^#{ENV['HOME']}/, '~')
end

#validate_color ⇒ 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.

Returns:

  • (String) —

    a valid color name



111
112
113
114
115
116
117
118
119
120
 
# File 'lib/na/colors.rb', line 111

def validate_color
  valid_color = nil
  compiled = ''
  normalize_color.split('').each do |char|
    compiled += char
    valid_color = compiled if Color.attributes.include?(compiled.to_sym) || compiled =~ /^([fb]g?)?#([a-f0-9]{6})$/i
  end

  valid_color
end

#wildcard_to_rx ⇒ String

Convert wildcard characters to regular expressions

Returns:



159
160
161
 
# File 'lib/na/string.rb', line 159

def wildcard_to_rx
  gsub(/\./, '\\.').gsub(/\?/, '.').gsub(/\*/, '[^ ]*?')
end