bri 0.1.2 → 0.1.3

data/lib/bri.rb

@@ -3,6 +3,7 @@ require 'erb'
 require 'term/ansicolor'
 
 
+require 'bri/renderer'
 require 'bri/mall'
 require 'bri/matcher'
 require 'bri/templates'
@@ -48,7 +49,11 @@ module Bri
   end
 
   def self.width
-    @@width ||= [ ( ENV['COLUMNS'] || 80 ) - 8, 1 ].max
+    return @@width if defined?( @@width )
+    base_width = ENV['COLUMNS'].to_i 
+    base_width = 80 if base_width == 0
+
+    @@width ||= [ base_width - 8, 1 ].max
   end
 
   def self.width=( width )

data/lib/bri/match/base.rb

@@ -1,6 +1,7 @@
 module Bri
   module Match
     class Base
+      @@renderer = Bri::Renderer.new
       def to_s
         ERB.new( self.class.const_get( :TEMPLATE ), nil, '<>' ).
             result( binding )
@@ -8,45 +9,7 @@ module Bri
 
       private 
       def build_description( source )
-        result = []
-        source.each do |element|
-          case element
-            when RDoc::Markup::Paragraph 
-              result << reflow( element.text )
-            when RDoc::Markup::BlankLine
-              result << ""
-            when RDoc::Markup::Rule
-              result << "-" * Bri.width
-            when RDoc::Markup::Verbatim
-              result << element.text
-            when RDoc::Markup::Heading
-              result << '  ' * element.level + element.text
-            when RDoc::Markup::ListItem
-              result << "#{element.label} #{build_description( element.parts ).join}"
-            when RDoc::Markup::List
-              case element.type
-                when :NOTE, :LABEL
-                  result << "Note:"
-                  result << build_description( element.items ).join( "\n" )
-                when :NUMBER
-                  result << "Numbered List:"
-                  result << build_description( element.items ).join( "\n" )
-                when :BULLET
-                  #FIXME: Add bullet symbol to each item
-                  result << "Bulletet List:"
-                  result << build_description( element.items ).join( "\n" )
-                else 
-                  raise "Don't know how to handle list type #{element.type}: #{element.inspect}"
-              end
-            else  
-              raise "Don't know how to handle type #{element.class}: #{element.inspect}"
-          end
-        end
-        result
-      end
-
-      def reflow( text, width = Bri.width )
-        array_to_width( text.split( /\s+/ ), width, " ", 1 )
+        source.collect { |element| @@renderer.render element }
       end
     end
   end

data/lib/bri/match/method.rb

@@ -8,7 +8,7 @@ module Bri
 
       def initialize( rdoc_method )
         @full_name = rdoc_method.full_name
-        @call_syntaxes = rdoc_method.call_seq.split( "\n" ).
+        @call_syntaxes = rdoc_method.arglists.split( "\n" ).
                                               map { |e| "  " + e }.
                                               join( "\n" ) + "\n" rescue ''
         @description_paragraphs = build_description( rdoc_method.comment.parts )

data/lib/bri/renderer.rb

@@ -0,0 +1,108 @@
+require 'strscan'
+
+module Bri
+  class Renderer
+    INDENT = ' ' * 2
+
+    def initialize
+    end
+
+    def render( element, width = Bri.width )
+      text = extract_text( element, width )
+      styled_text = replace_markup( text )
+      element.kind_of?( RDoc::Markup::Verbatim ) ? 
+        wrapped_text = styled_text :
+        wrapped_text = wrap_to_width( styled_text, width )
+      indent( wrapped_text )
+    end
+
+    def extract_text( element, width )
+      text = case element
+               when RDoc::Markup::Paragraph 
+                 element.text
+               when RDoc::Markup::BlankLine
+                 ""
+               when RDoc::Markup::Rule
+                 "-" * width
+               when RDoc::Markup::Verbatim
+                 element.text
+               when RDoc::Markup::Heading
+                 "<h>#{element.text}</h>"
+               when RDoc::Markup::ListItem
+                 element.label.to_s + element.parts.collect { |part| extract_text part, width }.join
+               when RDoc::Markup::List
+                 prefix = case element.type
+                            when :NOTE, :LABEL then "Note:\n" 
+                            when :NUMBER       then "Numbered List:\n"
+                            when :BULLET       then "Bulletet List:\n"
+                            else 
+                              raise "Don't know how to handle list type #{element.type}: #{element.inspect}"
+                          end
+                 prefix + element.items.collect { |item| extract_text item, width }.join
+               else  
+                 raise "Don't know how to handle type #{element.class}: #{element.inspect}"
+             end
+      text + "\n"
+    end
+
+    def replace_markup( text )
+      text.gsub!( "<tt>", Term::ANSIColor::cyan )
+      text.gsub!( "</tt>", Term::ANSIColor::reset )
+
+      text.gsub!( "<code>", Term::ANSIColor::cyan )
+      text.gsub!( "</code>", Term::ANSIColor::reset )
+
+      text.gsub!( "<h>", Term::ANSIColor::green )
+      text.gsub!( "</h>", Term::ANSIColor::reset )
+
+      text.gsub!( /(^|\s)\+(.*?)\+/, 
+                  "\\1#{Term::ANSIColor::yellow}\\2#{Term::ANSIColor::reset}" )
+      text.gsub!( /(^|\s)_(.*?)_/, 
+                  "\\1#{Term::ANSIColor::yellow}\\2#{Term::ANSIColor::reset}" )
+      text
+    end
+
+    def printable_length( text )
+      embedded_ansi_codes = text.scan( Term::ANSIColor::COLORED_REGEXP )
+      if embedded_ansi_codes.empty?
+        text.length
+      else
+        text.length - embedded_ansi_codes.reduce( 0 ) { |total, code| code.length + total }
+      end
+    end
+
+    def wrap_to_width( styled_text, width )
+      styled_text.split( "\n" ).collect { |row| wrap_row row, width }.join
+    end
+
+    def 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
+
+    def indent( text )
+      text.split( "\n" ).collect { |row| "#{INDENT}#{row}" }.join("\n" )
+    end
+  end
+end

data/lib/bri/templates.rb

@@ -13,9 +13,7 @@ module Bri
 <% if description_paragraphs.empty? %>
   (no description...)
 <% else %>
-<% description_paragraphs.each do |paragraph| %>
-<%= array_to_width( paragraph.split( /\s+/ ), Bri.width, " ") %>
-<% end %>
+<%= description_paragraphs.join("\n" ) %>
 <% end %>
 
 <%= hrule %>

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Sven Riedel
@@ -73,6 +73,7 @@ files:
 - lib/bri/search/class_method.rb
 - lib/bri/search/instance_method.rb
 - lib/bri/templates.rb
+- lib/bri/renderer.rb
 - spec/spec_helper.rb
 - spec/lib/bri/mall_spec.rb
 - spec/lib/bri/matcher_spec.rb