Module: Canis::TextUtils

Defined in:
lib/canis/core/util/textutils.rb

Class Method Summary collapse

Class Method Details

.clean_string!(content) ⇒ Object

remove tabs, newlines and non-print chars from a string since these can mess display



67
68
69
70
71
72
 
# File 'lib/canis/core/util/textutils.rb', line 67

def self.clean_string! content
  content.chomp! # don't display newline
  content.gsub!(/[\t\n]/, '  ') # don't display tab
  content.gsub!(/[^[:print:]]/, '')  # don't display non print characters
  content
end

.help2tmux(arr) ⇒ Object

Convert an array of Strings that has help markup into tmux style which can then by parsed into native format by the tmux parser ‘help’ markup is very much like markdown, but a very restricted subset. Currently called only by help_manager in rwidgets.rb Some of these need to be fixed since they may not allow some characters, maybe too restrictive, or may match within a word. FIXME



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/canis/core/util/textutils.rb', line 21

def self.help2tmux arr
  arr.each do |e|
    # double sq brackets are like wiki links, to internal documents in same location
    e.gsub! /\[\[(\S+)\]\]/, '#[style=link][\1]#[/end]'
    # double asterisk needs to be more permissive and take a space FIXME
    e.gsub! /\*\*(\S.*?\S)\*\*/, '#[style=strong]\1#[/end]'
    # the next is wrong and could match two asteriks also
    #e.gsub! /\*(\S[^\*]+\S)\*/, '#[style=em]\1#[/end]'
    e.gsub! /\*(?!\s)([^\*]+)(?<!\s)\*/, '#[style=em]\1#[/end]'
    e.gsub! /\|([^\|]+)\|/, '#[style=ul]\1#[/end]'
    #e.gsub! /__(\w+)__/, '#[style=em]\1#[/end]'
    #e.gsub! /_(\w+)_/, '#[style=em]\1#[/end]'
    # next one is a bit too restrictive, but did not want a line
    # full of underlines to get selected.
    # __(?!_)(.+?)(?<!_)__/
    #e.gsub! /__([a-zA-Z]+)__/, '#[style=strong]\1#[/end]'
    # also avoid if a space or _ is after starting __ and before
    # ending __
    e.gsub! /__(?![_\s])(.+?)(?<![_\s])__/, '#[style=strong]\1#[/end]'
    # make sure this does not match inside a word or code
    # will not accept an underscore inside
    e.gsub! /\b_([^_]+)_\b/, '#[style=em]\1#[/end]'
    e.gsub! /`([^`]+)`/, '#[style=code]\1#[/end]'
    # keys are mentioned with "<" and ">" surrounding
    e.gsub! /(\<\S+\>)/, '#[style=key]\1#[/end]'
    # headers start with "#"
    e.sub! /^###\s*(.*)$/, '#[style=h3]\1#[/end]'
    e.sub! /^## (.*)$/, '#[style=h2]\1#[/end]'
    e.sub! /^# (.*)$/, '#[style=h1]\1#[/end]'
    # line starting with "">" starts a white bold block as in vim's help. "<" ends block.
    e.sub! /^\>$/, '#[style=wb]'
    e.sub! /^\<$/, '#[/end]'
  end
  return arr
end

.wrap_text(txt, max) ⇒ Object

wraps text given max length, puts newlines in it. it does not take into account existing newlines Some classes have @maxlen or display_length which may be passed as the second parameter



60
61
62
63
 
# File 'lib/canis/core/util/textutils.rb', line 60

def self.wrap_text(txt, max )
  txt.gsub(/(.{1,#{max}})( +|$\n?)|(.{1,#{max}})/,
           "\\1\\3\n") 
end