Class: Cri::StringFormatter

Inherits:
Object
  • Object
show all
Defined in:
lib/cri/string_formatter.rb

Instance Method Summary collapse

Instance Method Details

#format_as_command(str, io) ⇒ String

Returns The string, formatted to be used as the name of a command in the help.

Parameters:

  • s (String)

    The string to format

Returns:

  • (String)

    The string, formatted to be used as the name of a command in the help


89
90
91
92
93
94
95
# File 'lib/cri/string_formatter.rb', line 89

def format_as_command(str, io)
  if Cri::Platform.color?(io)
    str.green
  else
    str
  end
end

#format_as_option(str, io) ⇒ String

Returns The string, formatted to be used as an option definition of a command in the help.

Parameters:

  • s (String)

    The string to format

Returns:

  • (String)

    The string, formatted to be used as an option definition of a command in the help


101
102
103
104
105
106
107
# File 'lib/cri/string_formatter.rb', line 101

def format_as_option(str, io)
  if Cri::Platform.color?(io)
    str.yellow
  else
    str
  end
end

#format_as_title(str, io) ⇒ String

Returns The string, formatted to be used as a title in a section in the help.

Parameters:

  • s (String)

    The string to format

Returns:

  • (String)

    The string, formatted to be used as a title in a section in the help


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

def format_as_title(str, io)
  if Cri::Platform.color?(io)
    str.upcase.red.bold
  else
    str.upcase
  end
end

#to_paragraphs(str) ⇒ Array<String>

Extracts individual paragraphs (separated by two newlines).

Parameters:

  • s (String)

    The string to format

Returns:

  • (Array<String>)

    A list of paragraphs in the string


8
9
10
11
12
13
14
15
16
17
18
19
20
21
# File 'lib/cri/string_formatter.rb', line 8

def to_paragraphs(str)
  lines = str.scan(/([^\n]+\n|[^\n]*$)/).map { |l| l[0].strip }

  paragraphs = [[]]
  lines.each do |line|
    if line.empty?
      paragraphs << []
    else
      paragraphs.last << line
    end
  end

  paragraphs.reject(&:empty?).map { |p| p.join(' ') }
end

#wrap_and_indent(str, width, indentation, first_line_already_indented = false) ⇒ String

Word-wraps and indents the string.

Parameters:

  • s (String)

    The string to format

  • width (Number)

    The maximal width of each line. This also includes indentation, i.e. the actual maximal width of the text is `width`-`indentation`.

  • indentation (Number)

    The number of spaces to indent each line.

  • first_line_already_indented (Boolean) (defaults to: false)

    Whether or not the first line is already indented

Returns:

  • (String)

    The word-wrapped and indented string


37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
# File 'lib/cri/string_formatter.rb', line 37

def wrap_and_indent(str, width, indentation, first_line_already_indented = false)
  indented_width = width - indentation
  indent = ' ' * indentation  # Split into paragraphs

  paragraphs = to_paragraphs(str)

  # Wrap and indent each paragraph
  text = paragraphs.map do |paragraph|
    # Initialize
    lines = []
    line = ''

    # Split into words
    paragraph.split(/\s/).each do |word|
      # Begin new line if it's too long
      if (line + ' ' + word).length >= indented_width
        lines << line
        line = ''
      end

      # Add word to line
      line += (line == '' ? '' : ' ') + word
    end
    lines << line

    # Join lines
    lines.map { |l| indent + l }.join("\n")
  end.join("\n\n")

  if first_line_already_indented
    text[indentation..-1]
  else
    text
  end
end