bri 0.1.4 → 0.1.5

data/Changelog

@@ -1,3 +1,9 @@
+0.1.5
+  - Fix rendering of nested lists
+  - Fix highlighting of sequences of + and _ characters
+  - Add a more elaborate help banner
+  - Show the help banner if no arguments are passed to the executable
+
 0.1.4
   - Better rendering of list items
   - Bulleted Lists now have bullets in front of the list items

data/bin/bri

@@ -10,6 +10,15 @@ require 'optparse'
 
 def parse_options 
   parser = OptionParser.new do |opts|
+    opts.banner = "Usage: #{$0} [options] <method_name>"
+    opts.separator ""
+    opts.separator "  method_name should be in one of the following formats:"
+    opts.separator ""
+    opts.separator "  * ClassOrModuleName#instance_method_name"
+    opts.separator "  * ClassOrModuleName.class_method_name"
+    opts.separator "  * #instance_method_name"
+    opts.separator "  * .class_method_name"
+    opts.separator ""
     opts.on( nil, "--classes", "List known classes" ) { |v| @options[:list_classes] = true }
     opts.on( nil, "--methods", "List known methods" ) { |v| @options[:list_methods] = true }
     opts.on( "-l", "--list-names", "List known namespaces/methods" ) { |v| @options[:list_names] = true }
@@ -17,6 +26,11 @@ def parse_options
     opts.on_tail( "-h", "--help", "This help text" ) { puts opts; exit }
   end
   parser.parse!( ARGV )
+
+  if ARGV.size == 0
+    puts parser.summarize
+    exit 0
+  end
 end
 
 parse_options

data/lib/bri/match/base.rb

@@ -1,7 +1,6 @@
 module Bri
   module Match
     class Base
-      @@renderer = Bri::Renderer.new
       def to_s
         ERB.new( self.class.const_get( :TEMPLATE ), nil, '<>' ).
             result( binding )
@@ -9,7 +8,7 @@ module Bri
 
       private 
       def build_description( source )
-        source.collect { |element| @@renderer.render element }
+        source.collect { |element| Bri::Renderer.render element }
       end
     end
   end

data/lib/bri/renderer.rb

@@ -1,13 +1,10 @@
 require 'strscan'
 
 module Bri
-  class Renderer
+  module Renderer
     INDENT = ' ' * 2
 
-    def initialize
-    end
-
-    def render( element, width = Bri.width )
+    def self.render( element, width = Bri.width )
       case element
         when RDoc::Markup::Verbatim 
           text = extract_text( element, width )
@@ -24,6 +21,8 @@ module Bri
             when :NUMBER
               i = 0
               rendered_items.map! { |item| i+=1; sprintf "%d.%s", i, item }
+            when :NOTE, :LABEL
+              # do nothing
           end
 
           rendered_items.join( "\n\n" ) + "\n"
@@ -36,7 +35,7 @@ module Bri
       end
     end
 
-    def extract_text( element, width )
+    def self.extract_text( element, width )
       text = case element
                when RDoc::Markup::Paragraph 
                  element.text
@@ -49,14 +48,17 @@ module Bri
                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
+                 parts = element.parts.collect { |part| extract_text part, width }.join
+                 element.label ? "#{element.label}: #{parts}" : parts
+               when RDoc::Markup::List
+                 render( element, width - INDENT.length )
                else  
                  raise "Don't know how to handle type #{element.class}: #{element.inspect}"
              end
       text + "\n"
     end
 
-    def replace_markup( text )
+    def self.replace_markup( text )
       text.gsub!( "<tt>", Term::ANSIColor::cyan )
       text.gsub!( "</tt>", Term::ANSIColor::reset )
 
@@ -66,22 +68,26 @@ module Bri
       text.gsub!( "<h>", Term::ANSIColor::green )
       text.gsub!( "</h>", Term::ANSIColor::reset )
 
-      text.gsub!( /(^|\s)\+(.*?)\+/, 
+      text.gsub!( /(^|\s)\+(.*?[a-zA-Z0-9]+.*?)\+/, 
                   "\\1#{Term::ANSIColor::yellow}\\2#{Term::ANSIColor::reset}" )
-      text.gsub!( /(^|\s)_(.*?)_/, 
+      text.gsub!( /(^|\s)_(.*?[a-zA-Z0-9]+.*?)_/, 
                   "\\1#{Term::ANSIColor::yellow}\\2#{Term::ANSIColor::reset}" )
       text
     end
 
-    def printable_length( text )
+    def self.printable_length( text )
       Term::ANSIColor.uncolored( text ).length
     end
 
-    def wrap_to_width( styled_text, width )
+    def self.wrap_list( array, width = Bri.width )
+      indent( wrap_to_width( array.join(", "), width ) )
+    end
+
+    def self.wrap_to_width( styled_text, width )
       styled_text.split( "\n" ).collect { |row| wrap_row row, width }.join
     end
 
-    def wrap_row( physical_row, width )
+    def self.wrap_row( physical_row, width )
       output_text = ''
       logical_row = ''
       printable_row_length = 0
@@ -107,7 +113,7 @@ module Bri
       output_text << logical_row << "\n"
     end
 
-    def indent( text )
+    def self.indent( text )
       text.split( "\n" ).collect { |row| "#{INDENT}#{row}" }.join("\n" )
     end
   end

data/lib/bri/templates.rb

@@ -3,7 +3,7 @@ module Bri
     MULTIPLE_CHOICES =<<-EOT
 <%= Bri::Templates::Helpers.hrule( "Multiple choices:" ) %>
 
-<%= Bri::Templates::Helpers.array_to_width( qualified_methods.sort ) %>
+<%= Bri::Renderer.wrap_list( qualified_methods.sort ) %>
 
 
     EOT
@@ -20,31 +20,31 @@ module Bri
 
 <% if !includes.empty? %>
 <%= section_header( "Includes:" ) %>
-<%= array_to_width( includes.sort ) %>
+<%= Bri::Renderer.wrap_list( includes.sort ) %>
 
 
 <% end %>
 <% if !constants.empty? %>
 <%= section_header( "Constants:" ) %>
-<%= array_to_width( constants.sort ) %>
+<%= Bri::Renderer.wrap_list( constants.sort ) %>
 
 
 <% end %>
 <% if !class_methods.empty? %>
 <%= section_header( "Class methods:" ) %>
-<%= array_to_width( class_methods.sort ) %>
+<%= Bri::Renderer.wrap_list( class_methods.sort ) %>
 
 
 <% end %>
 <% if !instance_methods.empty? %>
 <%= section_header( "Instance methods:" ) %>
-<%= array_to_width( instance_methods.sort ) %>
+<%= Bri::Renderer.wrap_list( instance_methods.sort ) %>
 
 
 <% end %>
 <% if !attributes.empty? %>
 <%= section_header( "Attributes:" ) %>
-<%= array_to_width( attributes.sort ) %>
+<%= Bri::Renderer.wrap_list( attributes.sort ) %>
 
 
 <% end %>
@@ -68,9 +68,7 @@ module Bri
           '-' * width + "\n"
         else
           text = " " + text if text != ''
-          '-' * ( width - text.length ) + 
-            Term::ANSIColor::bold + text + Term::ANSIColor::reset + 
-            "\n"
+          '-' * ( width - text.length ) + Term::ANSIColor::bold( text ) + "\n"
         end
       end
       module_function :hrule
@@ -79,34 +77,6 @@ module Bri
         Term::ANSIColor::green + Term::ANSIColor::underline + text + Term::ANSIColor::reset + "\n"
       end
       module_function :section_header
-
-      def array_to_width( array, width = Bri.width, separator = ", ", indent_steps = 1 )
-        indentation = '  '
-        rows = '' + indentation * indent_steps
-        row = ''
-        row_length = 0
-
-        array = add_separators( array, separator )
-
-        array.compact.each do |element|
-          if row.length + element.length >= width
-            rows << row + "\n" + indentation * indent_steps
-            row = ''
-          end
-
-          row << element
-        end
-
-        rows << row
-        rows
-      end
-      module_function :array_to_width
-
-      def add_separators( array, separator )
-        last_element = array.pop
-        array.map { |e| e + separator } + [ last_element ]
-      end
-      module_function :add_separators
     end
   end
 end

data/spec/lib/bri/match/method_match_spec.rb

@@ -11,7 +11,7 @@ describe Bri::Match::Method do
 
   let( :rdoc_method ) do
     mock( RDoc::AnyMethod, :full_name => "This::IS::My.full_name",
-                           :call_seq => "First\nSecond\nThird",
+                           :arglists => "First\nSecond\nThird",
                            :comment => fake_description )
   end
 

data/spec/lib/bri/search/class_method_search_spec.rb

@@ -5,7 +5,7 @@ describe Bri::Search::ClassMethod do
     let( :paragraph ) { RDoc::Markup::Paragraph.new( "Foo Description" ) }
     let( :document ) { mock( RDoc::Markup::Document, :parts => [ paragraph ] ) }
     let( :rdoc_method ) { mock( RDoc::AnyMethod, :full_name => "Foo",
-                                                 :call_seq => "",
+                                                 :arglists => "",
                                                  :comment => document ) }
     before( :each ) do
       store_one = mock( RDoc::RI::Store, :load_cache => true, 

data/spec/lib/bri/search/instance_method_spec.rb

@@ -5,7 +5,7 @@ describe Bri::Search::InstanceMethod do
     let( :paragraph ) { RDoc::Markup::Paragraph.new( "Foo Description" ) }
     let( :document ) { mock( RDoc::Markup::Document, :parts => [ paragraph ] ) }
     let( :rdoc_method ) { mock( RDoc::AnyMethod, :full_name => "Foo",
-                                                 :call_seq => "",
+                                                 :arglists => "",
                                                  :comment => document ) }
     before( :each ) do
       store_one = mock( RDoc::RI::Store, :load_cache => true, 

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: bri
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 4
-  version: 0.1.4
+  prerelease: 
+  version: 0.1.5
 platform: ruby
 authors: 
 - Sven Riedel
@@ -14,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-06 00:00:00 +02:00
+date: 2011-02-04 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,10 +21,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 5
         version: 1.0.5
   type: :runtime
   version_requirements: *id001
@@ -38,13 +30,9 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 5
-        - 0
-        version: 2.5.0
+        version: 3.5.2
   type: :runtime
   version_requirements: *id002
 description: An alternative to the ri command
@@ -98,23 +86,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 9
-      - 2
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
 summary: Beautified RI in the spirit of fastri/qri. Unlike fastri, bri builds on top of the rdoc 2.x backend, only output and formatting is handled by bri