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 



85
86
87
 
# File 'lib/na/string.rb', line 85

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

#action? ⇒ Boolean

Returns:

  • (Boolean) 


68
69
70
 
# File 'lib/na/string.rb', line 68

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

#blank? ⇒ Boolean

Returns:

  • (Boolean) 


72
73
74
 
# File 'lib/na/string.rb', line 72

def blank?
  strip =~ /^$/
end

#cap_first ⇒ String

Capitalize first character, leaving other capitalization in place

Returns:

  • (String) —

    capitalized string



255
256
257
258
259
260
 
# File 'lib/na/string.rb', line 255

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

#cap_first! ⇒ Object 



245
246
247
 
# File 'lib/na/string.rb', line 245

def cap_first!
  replace cap_first
end

#chronify(**options) ⇒ DateTime

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'

Parameters:

  • options —

    Additional options

Options Hash (**options):

  • :future (Boolean) —

    assume future date (default: false)

  • :guess (Symbol) —

    :begin or :end to assume beginning or end of arbitrary time range

Returns:

  • (DateTime) —

    result

Raises:

  • (StandardError) 


336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/na/string.rb', line 336

def chronify(**options)
  now = Time.now
  raise StandardError, "Invalid time expression #{inspect}" if to_s.strip == ''

  secs_ago = if match(/^(\d+)$/)
               # plain number, assume minutes
               Regexp.last_match(1).to_i * 60
             elsif (m = match(/^(?:(?<day>\d+)d)? *(?:(?<hour>\d+)h)? *(?:(?<min>\d+)m)?$/i))
               # day/hour/minute format e.g. 1d2h30m
               [[m['day'], 24 * 3600],
                [m['hour'], 3600],
                [m['min'], 60]].map { |qty, secs| qty ? (qty.to_i * secs) : 0 }.reduce(0, :+)
             end

  if secs_ago
    res = now - secs_ago
    notify(%(date/time string "#{self}" interpreted as #{res} (#{secs_ago} seconds ago)), debug: true)
  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]

    res = Chronic.parse(date_string, {
                          guess: options.fetch(:guess, :begin),
                          context: options.fetch(:future, false) ? :future : :past,
                          ambiguous_time_range: 8
                        })

    NA.notify(%(date/time string "#{self}" interpreted as #{res}), debug: true)
  end

  res
end

#comment(char = "#") ⇒ Object

Insert a comment character at the start of every line

Parameters:

  • char (String) (defaults to: "#") —

    The character to insert (default #)



14
15
16
 
# File 'lib/na/string.rb', line 14

def comment(char = "#")
  split(/\n/).map { |l| "# #{l}" }.join("\n")
end

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



225
226
227
228
229
230
 
# File 'lib/na/string.rb', line 225

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



221
222
223
 
# File 'lib/na/string.rb', line 221

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) 


89
90
91
 
# File 'lib/na/string.rb', line 89

def done?
  self =~ /@done/
end

#expand_date_tags(additional_tags = nil) ⇒ Object

Convert (chronify) natural language dates within configured date tags (tags whose value is expected to be a date). Modifies string in place.

Parameters:

  • additional_tags (Array) (defaults to: nil) —

    An array of additional tags to consider date_tags



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/na/string.rb', line 280

def expand_date_tags(additional_tags = nil)
  iso_rx = /\d{4}-\d\d-\d\d \d\d:\d\d/

  watch_tags = [
    'due',
    'start(?:ed)?',
    'beg[ia]n',
    'done',
    'finished',
    'completed?',
    'waiting',
    'defer(?:red)?'
  ]

  if additional_tags
    date_tags = additional_tags
    date_tags = date_tags.split(/ *, */) if date_tags.is_a?(String)
    date_tags.map! do |tag|
      tag.sub(/^@/, '').gsub(/\((?!\?:)(.*?)\)/, '(?:\1)').strip
    end
    watch_tags.concat(date_tags).uniq!
  end

  done_rx = /(?<=^| )@(?<tag>#{watch_tags.join('|')})\((?<date>.*?)\)/i

  dup.gsub(done_rx) do
    m = Regexp.last_match
    t = m['tag']
    d = m['date']
    future = t =~ /^(done|complete)/ ? false : true
    parsed_date = d =~ iso_rx ? Time.parse(d) : d.chronify(guess: :begin, future: future)
    parsed_date.nil? ? m[0] : "@#{t}(#{parsed_date.strftime('%F %R')})"
  end
end

#good? ⇒ Boolean

Tests if object is nil or empty

Returns:

  • (Boolean) —

    true if object is defined and has content



24
25
26
 
# File 'lib/na/string.rb', line 24

def good?
  !strip.empty?
end

#highlight_filename ⇒ Object

Colorize the dirname and filename of a path

Returns:

  • Colorized string



102
103
104
105
106
 
# File 'lib/na/string.rb', line 102

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

#highlight_search(regexes, color: NA.theme[:search_highlight], last_color: NA.theme[:action]) ⇒ Object

Highlight search results

Parameters:

  • regexes (Array) —

    The regexes for the search

  • color (String) (defaults to: NA.theme[:search_highlight]) —

    The highlight color template

  • last_color (String) (defaults to: NA.theme[:action]) —

    Color to restore after highlight



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/na/string.rb', line 145

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
      m = Regexp.last_match
      last = m.pre_match.last_color
      "#{color}#{m[0]}#{NA::Color.template(last)}"
    end
  end
  string
end

#highlight_tags(color: NA.theme[:tags], value: NA.theme[:value], parens: NA.theme[:value_parens], last_color: NA.theme[:action]) ⇒ String

Colorize @tags with ANSI escapes

Parameters:

  • color (String) (defaults to: NA.theme[:tags]) —

    color (see #Color)

  • value (String) (defaults to: NA.theme[:value]) —

    The value color template

  • parens (String) (defaults to: NA.theme[:value_parens]) —

    The parens color template

  • last_color (String) (defaults to: NA.theme[:action]) —

    Color to restore after tag highlight

Returns:

  • (String) —

    string with @tags highlighted



121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/na/string.rb', line 121

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)
  gsub(/(?<pre>\s|m)(?<tag>@[^ ("']+)(?:(?<lparen>\()(?<val>.*?)(?<rparen>\)))?/) do
    m = Regexp.last_match
    if m['val']
      "#{m['pre']}#{tag_color}#{m['tag']}#{paren_color}(#{value_color}#{m['val']}#{paren_color})#{last_color}"
    else
      "#{m['pre']}#{tag_color}#{m['tag']}#{last_color}"
    end
  end
end

#ignore? ⇒ Boolean

Test if line should be ignored

Returns:

  • (Boolean) —

    line is empty or comment



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

def ignore?
  line = self
  line =~ /^#/ || line.strip.empty?
end

#indent_level ⇒ Number

Determine indentation level of line

Returns:

  • (Number) —

    number of indents detected



61
62
63
64
65
66
 
# File 'lib/na/string.rb', line 61

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



206
207
208
 
# File 'lib/na/string.rb', line 206

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 



232
233
234
 
# File 'lib/na/string.rb', line 232

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

#na? ⇒ Boolean

Returns:

  • (Boolean) 


93
94
95
 
# File 'lib/na/string.rb', line 93

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 



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

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

#project? ⇒ Boolean

Returns:

  • (Boolean) 


76
77
78
 
# File 'lib/na/string.rb', line 76

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

#read_file ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/na/string.rb', line 38

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

  if File.directory?(file)
    if File.exist?("#{file}.#{NA.extension}")
      file = "#{file}.#{NA.extension}"
    elsif File.exist?("#{file}/#{File.basename(file)}.#{NA.extension}")
      file = "#{file}/#{File.basename(file)}.#{NA.extension}"
    else
      NA.notify("#{NA.theme[:error]}#{file} is a directory", exit_code: 2)
    end
  end

  # 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:



267
268
269
 
# File 'lib/na/string.rb', line 267

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

#trunc_middle(max) ⇒ Object 



161
162
163
164
165
166
167
168
169
 
# File 'lib/na/string.rb', line 161

def trunc_middle(max)
  return self unless length > max

  half = (max / 2).floor - 3
  chars = split('')
  pre = chars.slice(0, half)
  post = chars.reverse.slice(0, half).reverse
  "#{pre.join('')}[...]#{post.join('')}"
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:



241
242
243
 
# File 'lib/na/string.rb', line 241

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

#wrap(width, indent) ⇒ Object 



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/na/string.rb', line 171

def wrap(width, indent)
  return "\n#{self}" if width <= 80

  output = []
  line = []
  length = indent
  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
      line << word
      length += uncolored.length + 1
    else
      output << line.join(' ')
      line = [word]
      length = indent + uncolored.length + 1
    end
  end
  output << line.join(' ')
  output.join("\n" + ' ' * (indent + 2)).gsub(/†/, ' ')
end