bri 0.4.4 → 1.0.0.pre.beta1

data/lib/bri/renderer/default.rb

@@ -0,0 +1,27 @@
+module Bri
+  module Renderer
+    class Default
+      include ::Bri::TextFormattingUtils
+
+      attr_reader :element
+
+      def initialize( element )
+        @element = element
+      end
+
+      def render( width = Bri.width )
+        text = extract_text( width )
+
+        if text.empty?
+          nil
+        else
+          ::Bri::Renderer::Result.new( text, width )
+        end
+      end
+
+      def extract_text( width, conserve_newslines = false )
+        raise "Don't know how to handle type #{element.class}: #{element.inspect}"
+      end
+    end
+  end
+end

data/lib/bri/renderer/document.rb

@@ -0,0 +1,11 @@
+module Bri
+  module Renderer
+    class Document < Default
+      def extract_text( width, conserve_newlines = false )
+         element.parts.
+                 map { |part| ::Bri::Renderer.new( part ).extract_text( width, conserve_newlines ) }.
+                 join
+      end
+    end
+  end
+end

data/lib/bri/renderer/heading.rb

@@ -0,0 +1,9 @@
+module Bri
+  module Renderer
+    class Heading < Default
+      def extract_text( width, conserve_newlines = false )
+        "<h>#{element.text.chomp}</h>" 
+      end
+    end
+  end
+end

data/lib/bri/renderer/list.rb

@@ -0,0 +1,24 @@
+module Bri
+  module Renderer
+    class List < Default
+      def self.new( element )
+        case element.type
+          when :BULLET then ::Bri::Renderer::List::Bullet.new( element )
+          when :NUMBER then ::Bri::Renderer::List::Numbered.new( element )
+          when :LALPHA then ::Bri::Renderer::List::LowerLettered.new( element )
+          when :UALPHA then ::Bri::Renderer::List::UpperLettered.new( element )
+          when :LABEL  then ::Bri::Renderer::List::Labeled.new( element )
+          when :NOTE   then ::Bri::Renderer::List::Note.new( element )
+        end
+      end
+    end
+  end
+end
+
+require_relative 'list/base'
+require_relative 'list/bullet'
+require_relative 'list/numbered'
+require_relative 'list/lower_lettered'
+require_relative 'list/upper_lettered'
+require_relative 'list/labeled'
+require_relative 'list/note'

data/lib/bri/renderer/list/base.rb

@@ -0,0 +1,18 @@
+module Bri
+  module Renderer
+    class List
+      class Base < ::Bri::Renderer::Default
+        def extract_text( width, conserve_newlines = false )
+          item_width = width - max_bullet_width
+          rendered_items = element.items.each_with_index.
+                                   map do |item, index|
+                                     bullet = next_bullet( item )
+                                     ::Bri::Renderer.new( item ).text( item_width, bullet )
+                                   end
+
+          rendered_items.join
+        end
+      end
+    end
+  end
+end

data/lib/bri/renderer/list/bullet.rb

@@ -0,0 +1,15 @@
+module Bri
+  module Renderer
+    class List
+      class Bullet < Base
+        def max_bullet_width
+          3
+        end
+
+        def next_bullet( item )
+          '* '
+        end
+      end
+    end
+  end
+end

data/lib/bri/renderer/list/labeled.rb

@@ -0,0 +1,15 @@
+module Bri
+  module Renderer
+    class List
+      class Labeled < Base
+        def max_bullet_width
+          @max_bullet_width ||= element.items.map(&:label).map(&:size).max
+        end
+
+        def next_bullet( item )
+          "#{item.label.first}: "
+        end
+      end
+    end
+  end
+end

data/lib/bri/renderer/list/lower_lettered.rb

@@ -0,0 +1,18 @@
+module Bri
+  module Renderer
+    class List
+      class LowerLettered < Base
+        def max_bullet_width
+          @max_bullet_width ||= ( Math.log10( element.items.size ) / Math.log10( 26 ) ).ceil + 3
+        end
+
+        def next_bullet( item )
+          @current_bullet ||= 'a'
+          result = "#{@current_bullet}. "
+          @current_bullet.succ!
+          result
+        end
+      end
+    end
+  end
+end

data/lib/bri/renderer/list/note.rb

@@ -0,0 +1,15 @@
+module Bri
+  module Renderer
+    class List
+      class Note < Base
+        def max_bullet_width
+          @max_bullet_width ||= element.items.flat_map(&:label).map(&:size).max
+        end
+
+        def next_bullet( item )
+          "#{item.label.first}:" + " " * (max_bullet_width - item.label.first.size + 1)
+        end
+      end
+    end
+  end
+end

data/lib/bri/renderer/list/numbered.rb

@@ -0,0 +1,18 @@
+module Bri
+  module Renderer
+    class List
+      class Numbered < Base
+        def next_bullet( item )
+          @current_bullet ||= '1'
+          result = "#{@current_bullet}. "
+          @current_bullet.succ!
+          result
+        end
+
+        def max_bullet_width
+          @max_bullet_width ||= Math.log10( element.items.size ).ceil + 3
+        end
+      end
+    end
+  end
+end

data/lib/bri/renderer/list/upper_lettered.rb

@@ -0,0 +1,18 @@
+module Bri
+  module Renderer
+    class List
+      class UpperLettered < Base
+        def max_bullet_width
+          @max_bullet_width ||= ( Math.log10( element.items.size ) / Math.log10( 26 ) ).ceil + 3
+        end
+
+        def next_bullet( item )
+          @current_bullet ||= 'A'
+          result = "#{@current_bullet}. "
+          @current_bullet.succ!
+          result
+        end
+      end
+    end
+  end
+end

data/lib/bri/renderer/list_item.rb

@@ -0,0 +1,24 @@
+module Bri
+  module Renderer
+    class ListItem < Default
+      def text( total_width, bullet )
+        element.parts.map.with_index do |part, index|
+          part_is_list = part.is_a?(RDoc::Markup::List)
+          first_line_indent = ( part_is_list || index > 0 ) ? bullet.size : 0
+          following_line_indent = bullet.size
+
+          text = ::Bri::Renderer.new( part ).extract_text( total_width, true )
+          text.prepend( bullet ) if index == 0 && !part_is_list
+          lines = text.lines
+
+          result = indent( lines.first, indent_depth: first_line_indent )
+          lines.drop( 1 ).each do |line|
+            result << indent( line, indent_depth: following_line_indent )
+          end
+
+          result
+        end
+      end
+    end
+  end
+end

data/lib/bri/renderer/paragraph.rb

@@ -0,0 +1,11 @@
+module Bri
+  module Renderer
+    class Paragraph < Default
+      def extract_text( width, conserve_newlines = false )
+        join_char = conserve_newlines ? "\n" : " "
+        intermediate = element.parts.map(&:strip).join( join_char )
+        wrap_to_width( intermediate, width )
+      end
+    end
+  end
+end

data/lib/bri/renderer/result.rb

@@ -0,0 +1,73 @@
+module Bri
+  module Renderer
+    class Result
+      include ::Bri::TextFormattingUtils
+
+      Color = ::Term::ANSIColor
+
+      attr_reader :input, :width
+
+      def initialize(input, width )
+        @input = input
+        @width = width
+      end
+
+      def output
+        return @output if instance_variable_defined?( :@output )
+
+        @output = replace_markup( input ).
+                  then { |styled_text| width ? wrap_to_width( styled_text, width ) : styled_text }.
+                  then { |wrapped_text| indent( wrapped_text ) }
+      end
+
+      def concat( other )
+        output.concat( other.output )
+      end
+
+      private
+
+      def 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{\{(.*?)\}\[(.*?)\]}m, "\\1 (\\2)" )
+        text.gsub!( %r{\[(#{Regexp.escape( Color.underline )}.*?#{Regexp.escape( Color.reset )})\]}, 
+                    " (\\1)" )
+        text
+      end
+    end
+  end
+end

data/lib/bri/renderer/rule.rb

@@ -0,0 +1,9 @@
+module Bri
+  module Renderer
+    class Rule < Default
+      def extract_text( width, conserve_newlines = false )
+        "#{"-" * width}\n"
+      end
+    end
+  end
+end

data/lib/bri/renderer/verbatim.rb

@@ -0,0 +1,14 @@
+module Bri
+  module Renderer
+    class Verbatim < Default
+      def render( width = Bri.width )
+        text = ::Bri::Renderer.new( element ).extract_text( width )
+        ::Bri::Renderer::Result.new( "#{text}\n", nil )
+      end
+
+      def extract_text( width, conserve_newlines = false )
+        element.parts.map { |part| indent(part) }.join + "\n"
+      end
+    end
+  end
+end

data/lib/bri/search/class.rb

@@ -3,7 +3,9 @@ module Bri
     class Class < Base
       def search( type = :fully_qualified )
         # NOTE: classes are only searched as fully qualified for the time being
-        Bri::Mall.instance.stores.select { |s| s.module_names.include?( @term ) }.each do |store|
+        Bri::Mall.stores.
+                  select { |s| s.module_names.include?( @term ) }.
+                  each do |store|
           @matches << Bri::Match::Class.new( store.load_class( @term ), store )
         end
       end

data/lib/bri/search/method.rb

@@ -31,7 +31,7 @@ module Bri
       end
 
       def store_for_method
-        Bri::Mall.instance.stores.detect do |store|
+        Bri::Mall.stores.detect do |store|
           store_methods( store ).has_key?( @class_term ) &&
           store_methods( store )[@class_term].include?( @method_term )
         end
@@ -54,7 +54,7 @@ module Bri
 
 
       def partially_qualified_search  
-        Bri::Mall.instance.stores.each do |store|
+        Bri::Mall.stores.each do |store|
           classes_with_method( store, @method_term ).each do |klass|
             match_data = method_rdoc( store, klass, @method_term ) 
             next unless match_data
@@ -74,7 +74,7 @@ module Bri
       end
 
       def unqualified_search_worker( method_re )
-        Bri::Mall.instance.stores.each do |store|
+        Bri::Mall.stores.each do |store|
           candidates_from_method_re( store, method_re ).each do |klass, methods|
             methods.each do |method|
               match_data = method_rdoc( store, klass, method )

data/lib/bri/templates.rb

@@ -1,9 +1,7 @@
 module Bri
   module Templates
-    RULE_CHARACTER = '-'.freeze
-
     MULTIPLE_CHOICES =<<-EOT
-<%= Bri::Templates::Helpers.hrule( "Multiple choices:" ) %>
+<%= hrule( "Multiple choices:" ) %>
 
 <%= qualified_methods.sort.join("\n") %>
 
@@ -24,38 +22,32 @@ module Bri
 
 <% if !includes.empty? %>
 <%= section_header( "Includes:" ) %>
-<%= Bri::Renderer.wrap_list( includes.sort ) %>
-
+<%= wrap_list( includes.sort ) %>
 
 <% end %>
 <% if !extends.empty? %>
 <%= section_header( "Extends:" ) %>
-<%= Bri::Renderer.wrap_list( extends.sort ) %>
-
+<%= wrap_list( extends.sort ) %>
 
 <% end %>
 <% if !constants.empty? %>
 <%= section_header( "Constants:" ) %>
-<%= Bri::Renderer.wrap_list( constants.sort ) %>
-
+<%= wrap_list( constants.sort ) %>
 
 <% end %>
 <% if !class_methods.empty? %>
 <%= section_header( "Class methods:" ) %>
-<%= Bri::Renderer.wrap_list( class_methods.sort ) %>
-
+<%= wrap_list( class_methods.sort ) %>
 
 <% end %>
 <% if !instance_methods.empty? %>
 <%= section_header( "Instance methods:" ) %>
-<%= Bri::Renderer.wrap_list( instance_methods.sort ) %>
-
+<%= wrap_list( instance_methods.sort ) %>
 
 <% end %>
 <% if !attributes.empty? %>
 <%= section_header( "Attributes:" ) %>
-<%= Bri::Renderer.wrap_list( attributes.sort ) %>
-
+<%= wrap_list( attributes.sort ) %>
 
 <% end %>
     EOT
@@ -73,28 +65,5 @@ module Bri
 <% end %>
 
     EOT
-
-    module Helpers
-      def hrule( text = '', width = Bri.width )
-        text.prepend( " " ) unless text.empty?
-
-        rule_length = width - text.length
-        rule_length = 1 if rule_length < 1
-
-        rule = RULE_CHARACTER * rule_length
-        "#{rule}#{Term::ANSIColor::bold( text )}\n"
-      end
-      module_function :hrule
-
-      def print_origin( origin_text, width = Bri.width )
-        return unless origin_text
-        "(#{origin_text})".rjust( width )
-      end
-
-      def section_header( text )
-        "#{Term::ANSIColor.green}#{Term::ANSIColor.underline}#{text}#{Term::ANSIColor.reset}\n"
-      end
-      module_function :section_header
-    end
   end
 end