Module: Bri::Renderer

Defined in:
lib/bri/renderer.rb

Constant Summary collapse

Color = 
::Term::ANSIColor
INDENT = 
' ' * 2
INDENT_WIDTH = 
2
LOWER_ALPHABET = 
('a'..'z').to_a.map { |char| "#{char}." }.freeze
UPPER_ALPHABET = 
('A'..'Z').to_a.map { |char| "#{char}." }.freeze

Class Method Summary collapse

Class Method Details

.extract_text(element, width, label_alignment_width = 0, conserve_newlines = false) ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/bri/renderer.rb', line 68

def self.extract_text( element, width, label_alignment_width = 0, conserve_newlines = false )
  case element
    when RDoc::Markup::Paragraph
      join_char = conserve_newlines ? "\n" : " "
      element.parts.map(&:strip).join( join_char ) + "\n"

    when RDoc::Markup::BlankLine
      "\n"

    when RDoc::Markup::Rule
      "-" * width + "\n"

    when RDoc::Markup::Verbatim
      element.parts.map { |part| part.prepend( "  " ) }.join + "\n"

    when RDoc::Markup::Heading
      "<h>#{element.text}</h>\n" 

    when RDoc::Markup::ListItem
      parts = element.parts.map { |part| extract_text( part, width, 0, true ) }.join

      if element.label
        labels = element.label.map { |l| "#{l}:" }.join("\n")
        sprintf( "%*s %s", -label_alignment_width, labels, parts )
      else
        parts
      end

    when RDoc::Markup::List
      render( element, width - INDENT_WIDTH ) + "\n"

     when RDoc::Markup::Document
       element.parts.
               map { |part| extract_text( part, width, label_alignment_width, conserve_newlines ) }.
               join + "\n"
    else  
      raise "Don't know how to handle type #{element.class}: #{element.inspect}"
  end
end

.indent(text) ⇒ Object 



191
192
193
 
# File 'lib/bri/renderer.rb', line 191

def self.indent( text )
  text.split( "\n" ).map { |row| "#{INDENT}#{row}" }.join("\n" )
end

.printable_length(text) ⇒ Object 



151
152
153
 
# File 'lib/bri/renderer.rb', line 151

def self.printable_length( text )
  Term::ANSIColor.uncolored( text ).length
end

.render(element, width = Bri.width, alignment_width = 0) ⇒ Object 



12
13
14
15
16
17
18
19
20
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
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/bri/renderer.rb', line 12

def self.render( element, width = Bri.width, alignment_width = 0 )
  case element
    when RDoc::Markup::Verbatim 
      text = extract_text( element, width )
      styled_text = replace_markup( text )
      "#{indent( styled_text )}\n"

    when RDoc::Markup::List
      item_width = width - INDENT_WIDTH
      case element.type
        when :BULLET 
          rendered_items = element.items.map { |item| render( item, item_width ) }
          rendered_items.map! { |item| item.gsub( /\n/, "\n#{INDENT}" ) }
          rendered_items.map! { |item| item.prepend( ' *' ) }

        when :NUMBER
          rendered_items = element.items.map { |item| render( item, item_width ) }
          rendered_items.map! { |item| item.gsub( /\n/, "\n#{INDENT}" ) }
          rendered_items.map!.with_index( 1 ) { |item, i| item.prepend( "#{i}." ) }

        when :LALPHA
          rendered_items = element.items.map { |item| render( item, item_width ) }
          rendered_items.map! { |item| item.gsub( /\n/, "\n#{INDENT}" ) }
          rendered_items.map!.with_index { |item, i| item.prepend( LOWER_ALPHABET[i] ) }

        when :UALPHA
          rendered_items = element.items.map { |item| render( item, item_width ) }
          rendered_items.map! { |item| item.gsub( /\n/, "\n#{INDENT}" ) }
          rendered_items.map!.with_index { |item, index| item.prepend( UPPER_ALPHABET[i] ) }
          
        when :LABEL
          # do nothing
          rendered_items = element.items.map { |item| render( item, item_width ) }
          rendered_items.map! { |item| item.gsub( /\n/, "\n#{INDENT}" ) }

        when :NOTE
          alignment_width = element.items.flat_map(&:label).map(&:size).max + 1
          rendered_items = element.items.map { |item| render( item, item_width, alignment_width ) }
          rendered_items.map! { |item| item.gsub( /\n/, "\n#{INDENT}" ) }
      end

      "#{rendered_items.join( "\n" )}\n"

    else
      text = extract_text( element, width, alignment_width )

      if text == "\n"
        nil
      else
        styled_text = replace_markup( text )
        wrapped_text = wrap_to_width( styled_text, width )
        indent( wrapped_text )
      end
  end
end

.replace_markup(text) ⇒ Object 



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/bri/renderer.rb', line 108

def self.replace_markup( text )
  text.gsub!( /(?<!\\)<(?:tt|code)>/, Color.cyan )
  text.gsub!( /(?<!\\)<\/(?:tt|code)>/, Color.reset )

  text.gsub!( /(?<!\\)<b>/, Color.bold )
  text.gsub!( /(?<!\\)<\/b>/, Color.reset )

  text.gsub!( /(?<!\\)<(?:em|i)>/, Color.yellow )
  text.gsub!( /(?<!\\)<\/(?:em|i)>/, Color.reset )

  text.gsub!( "<h>", Color.green )
  text.gsub!( "</h>", Color.reset )

  text.gsub!( "\\<", "<" )

  text.gsub!( /(#\s*=>)(.*)/,
              "#{Color.dark}\\1#{Color.reset}#{Color.bold}\\2#{Color.reset}" )

  text.gsub!( /(^|\s)\*(.*?[a-zA-Z0-9]+.*?)\*/, 
              "\\1#{Color.bold}\\2#{Color.reset}" )
  text.gsub!( /(^|\s)\+(.*?[a-zA-Z0-9]+.*?)\+/, 
              "\\1#{Color.cyan}\\2#{Color.reset}" )
  text.gsub!( /(^|\s)_(.*?[a-zA-Z0-9]+.*?)_/, 
              "\\1#{Color.yellow}\\2#{Color.reset}" )

  text.gsub!( %r{\b((?:https?|ftp)://[-\w.?%&=/]+)\b}, 
              "#{Color.underline}\\1#{Color.reset}" )

  text.gsub!( %r{\b(mailto:[-\w.%]+@[-\w.]+)\b}, 
              "#{Color.underline}\\1#{Color.reset}" )

  text.gsub!( %r{\b((?<!:\/\/)www.[-\w.?%&=]+)\b}, 
              "#{Color.underline}\\1#{Color.reset}" )

  text.gsub!( %r{\blink:(.*?)(\s|$)}, 
              "#{Color.underline}\\1#{Color.reset}\\2" )

  text.gsub!( %r{\{(.*?)\}\[(.*?)\]}, "\\1 (\\2)" )
  text.gsub!( %r{\[(#{Regexp.escape( Color.underline )}.*?#{Regexp.escape( Color.reset )})\]}, 
              " (\\1)" )
  text
end

.wrap_list(array, width = Bri.width) ⇒ Object 



155
156
157
 
# File 'lib/bri/renderer.rb', line 155

def self.wrap_list( array, width = Bri.width )
  indent( wrap_to_width( array.join("  "), width ) )
end

.wrap_row(physical_row, width) ⇒ Object 



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
188
189
 
# File 'lib/bri/renderer.rb', line 163

def self.wrap_row( physical_row, width )
  output_text = ''
  logical_row = ''
  printable_row_length = 0

  scanner = StringScanner.new( physical_row )

  while( !scanner.eos? ) 
    token = scanner.scan( /\S+/ ).to_s
    printable_token_length = printable_length( token )

    if printable_token_length + printable_row_length > width
      output_text << logical_row << "\n"
      logical_row = ''
      printable_row_length = 0
    end

    logical_row << token
    printable_row_length += printable_token_length

    token = scanner.scan( /\s*/ ).to_s
    logical_row << token
    printable_row_length += token.length
  end

  output_text << logical_row << "\n"
end

.wrap_to_width(styled_text, width) ⇒ Object 



159
160
161
 
# File 'lib/bri/renderer.rb', line 159

def self.wrap_to_width( styled_text, width )
  styled_text.split( "\n" ).map { |row| wrap_row( row, width ) }.join
end