Introduce --all and prefer core docs by default

Author: Sven Riedel

Changelog

@@ -1,3 +1,9 @@
+0.4.4
+  - No longer display all found class/module documentation found. If core
+  documentation is available, output only that, otherwise falls back to gem
+  documentation. To show all found documentation use the --all command line
+  paramter.
+
 0.4.3
   - If multiple documentations are found that are all class documentations,
     display all of these. This is useful in cases that gems extend core 

README.rdoc

@@ -24,7 +24,14 @@ Bri is a Beautiful RI formatter.
 
 = Usage
 
- bri Array # looks up the class description of Array in the ri documentation
+ bri Array # looks up the class description of Array in the ri documentation.
+           # As of 0.4.4 this form will only output core documentation if
+           # available, falling back to gem documentation if no core
+           # documentation is found. This way you can look at the documentation
+           # of core classes that gems love to money patch without having
+           # to scroll back through your terminal.
+           # If you really want to see everything there is, use --all:
+ bri --all Array
 
  bri Array.class_method # looks up the class method of the given class
 

bin/bri

@@ -5,7 +5,8 @@ require 'optparse'
 @options = {
   :list_classes => false,
   :list_methods => false,
-  :list_names   => false
+  :list_names   => false,
+  :show_all     => false
 }
 
 def parse_options 
@@ -23,6 +24,7 @@ def parse_options
     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( "-a", "--all", "Output all documentation for the term. Prefers core documents otherwise") { |v| @options[:show_all] = true }
     opts.on_tail( "-h", "--help", "This help text" ) { puts opts; exit }
   end
   parser.parse!( ARGV )
@@ -43,5 +45,5 @@ elsif @options[:list_methods]
 elsif @options[:list_names]
   puts Bri.list_names
 else
-  puts Bri.ri( ARGV[0] )
+  puts Bri.ri( ARGV[0], show_all: @options[:show_all] )
 end

lib/bri.rb

@@ -11,15 +11,22 @@
 module Bri
   DEFAULT_WIDTH = 72
 
-  def self.ri( query )
+  def self.ri( query, show_all: false )
     results = Bri::Matcher.new( query ).find
 
     if results.size == 0
       "No matching results found"
     elsif results.size == 1
       results.first.to_s
     elsif results.all? { |r| r.is_a?(Bri::Match::Class) }
-      results.map(&:to_s)
+      if show_all
+        results.map(&:to_s)
+      else
+        gem_docs, core_docs = results.partition { |r| r.origin =~ %r{gem\b} }
+
+        docs_to_output = core_docs.empty? ? gem_docs : core_docs
+        docs_to_output.map(&:to_s)
+      end
     else
       qualified_methods = results.map(&:full_name).sort
       ERB.new( Bri::Templates::MULTIPLE_CHOICES, nil, '<>' ).result( binding )