bri 0.1.1 → 0.1.2

data/TODO

@@ -2,5 +2,3 @@
 - Extend unqualified search to include class methods and case insensitive searches
 - Misc. error handlings
 - Do more specs
-- Add command line option parsing and help
-- Set output width dynamically leveraging all synergy effects

data/bin/bri

@@ -1,9 +1,32 @@
 #!/usr/bin/env ruby
 require 'bri'
+require 'optparse'
 
-if ARGV.size != 1 
-  STDERR.puts "Usage: #{$0} <reference>"
-  exit 0
+@options = {
+  :list_classes => false,
+  :list_methods => false,
+  :list_names   => false
+}
+
+def parse_options 
+  parser = OptionParser.new do |opts|
+    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 }
+    opts.on( "-w", "--width [COLUMNS]", "Set the output width", Integer ) { |v| Bri.width = v.to_i - 8 }
+    opts.on_tail( "-h", "--help", "This help text" ) { puts opts; exit }
+  end
+  parser.parse!( ARGV )
 end
 
-puts Bri.ri( ARGV[0] )
+parse_options
+
+if @options[:list_classes] 
+  puts Bri.list_classes
+elsif @options[:list_methods]
+  puts Bri.list_methods
+elsif @options[:list_names]
+  puts Bri.list_names
+else
+  puts Bri.ri( ARGV[0] )
+end

data/lib/bri.rb

@@ -10,7 +10,7 @@ require 'bri/search'
 require 'bri/match'
 
 module Bri
-  WIDTH = 72
+  DEFAULT_WIDTH = 72
 
   def self.format_elements( array )
     rows = []
@@ -20,7 +20,7 @@ module Bri
     array.each do |element|
       element_length_with_separator = element.length + 2
 
-      if row_length + element_length_with_separator >= WIDTH
+      if row_length + element_length_with_separator >= Bri.width
         rows << row
         row = []
         row_length = 0
@@ -47,5 +47,28 @@ module Bri
     end
   end
 
+  def self.width
+    @@width ||= [ ( ENV['COLUMNS'] || 80 ) - 8, 1 ].max
+  end
+
+  def self.width=( width )
+    @@width = [ width, 1 ].max
+  end
+
+  def self.list_classes
+    Bri::Mall.instance.classes.join("\n" )
+  end
+
+  def self.list_methods
+    ( Bri::Mall.instance.instance_methods + 
+      Bri::Mall.instance.class_methods ).sort.join( "\n" )
+  end
+
+  def self.list_names
+    ( Bri::Mall.instance.classes +
+      Bri::Mall.instance.instance_methods +
+      Bri::Mall.instance.class_methods ).sort.join( "\n" )
+  end
+
 end
 

data/lib/bri/mall.rb

@@ -12,6 +12,22 @@ module Bri
       @stores.collect { |store| store.modules }.flatten.uniq.sort
     end
 
+    def class_methods
+      Bri::Mall.instance.stores.map do |store|
+        store.class_methods.map do |klass, methods|
+          methods.map { |method| "#{klass}.#{method}" }
+        end
+      end.flatten.uniq
+    end
+
+    def instance_methods
+      Bri::Mall.instance.stores.map do |store|
+        store.instance_methods.map do |klass, methods|
+          methods.map { |method| "#{klass}##{method}" }
+        end
+      end.flatten.uniq
+    end
+
     private
     def initialize
       @stores = []

data/lib/bri/match/base.rb

@@ -16,7 +16,7 @@ module Bri
             when RDoc::Markup::BlankLine
               result << ""
             when RDoc::Markup::Rule
-              result << "-" * Bri::WIDTH
+              result << "-" * Bri.width
             when RDoc::Markup::Verbatim
               result << element.text
             when RDoc::Markup::Heading
@@ -45,7 +45,7 @@ module Bri
         result
       end
 
-      def reflow( text, width = Bri::WIDTH )
+      def reflow( text, width = Bri.width )
         array_to_width( text.split( /\s+/ ), width, " ", 1 )
       end
     end

data/lib/bri/match/class.rb

@@ -14,10 +14,11 @@ module Bri
       def initialize( rdoc_result )
         @type = rdoc_result.type
         @name = rdoc_result.name
-        @description_paragraphs = rdoc_result.comment.parts.collect { |p| p.parts.join( " " ) }
+        @description_paragraphs = build_description( rdoc_result.comment.parts )
         @includes = rdoc_result.includes.collect { |i| i.full_name }
-        @constants = rdoc_result.constants.collect { |c| { :name => c.name,
-                                                           :value => c.value } }
+        @constants = rdoc_result.constants.collect do |c|
+                       c.value ? "#{c.name} = #{c.value}" : c.name
+                     end
         @attributes = rdoc_result.attributes.collect { |a| "#{a.name} (#{a.rw})" }
 
         class_methods, instance_methods = rdoc_result.method_list.

data/lib/bri/templates.rb

@@ -14,7 +14,7 @@ module Bri
   (no description...)
 <% else %>
 <% description_paragraphs.each do |paragraph| %>
-<%= array_to_width( paragraph.split( /\s+/ ), 72, " ") %>
+<%= array_to_width( paragraph.split( /\s+/ ), Bri.width, " ") %>
 <% end %>
 <% end %>
 
@@ -65,7 +65,7 @@ module Bri
     EOT
 
     module Helpers
-      def hrule( text = '', width = Bri::WIDTH )
+      def hrule( text = '', width = Bri.width )
         '-' * ( width - text.length - 1 ) + " " + 
           Term::ANSIColor::bold + text + Term::ANSIColor::reset + 
           "\n"
@@ -77,7 +77,7 @@ module Bri
       end
       module_function :section_header
 
-      def array_to_width( array, width = Bri::WIDTH, separator = ", ", indent_steps = 1 )
+      def array_to_width( array, width = Bri.width, separator = ", ", indent_steps = 1 )
         indentation = '  '
         rows = '' + indentation * indent_steps
         row = ''
@@ -85,7 +85,7 @@ module Bri
 
         array = add_separators( array, separator )
 
-        array.each do |element|
+        array.compact.each do |element|
           if row.length + element.length >= width
             rows << row + "\n" + indentation * indent_steps
             row = ''

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Sven Riedel
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-19 00:00:00 +02:00
+date: 2010-09-30 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -83,7 +83,7 @@ files:
 - spec/lib/bri/search/instance_method_spec.rb
 - spec/lib/bri/search/method_spec.rb
 has_rdoc: true
-homepage: 
+homepage: http://github.com/sriedel/bri
 licenses: []
 
 post_install_message: