Add ri --list and make interactive ri the default if no names are given

Author: drbrain

History.txt

@@ -1,10 +1,14 @@
 === 3.6
 
+* Major Enhancements
+  * Interactive ri is now the default when no names are given.
 * Minor Enhancements
   * RDoc::RDoc#generate was added to allow multiple generators to be used with
     a set of parsed file info.
   * RDoc::Options#finish can be called multiple times now.
   * `ri -i` only shows one level of namespace when completing class names.
+  * Added `ri --list` for explicit listing.  `ri -l F G` will list all classes
+    or modules starting with F or G
 * Bug fixes
   * Remove windows-specific test for test_check_files, it is too hard to do.
     Ruby commit r30811 by Usaku Nakamura.

lib/rdoc/ri/driver.rb

@@ -197,6 +197,13 @@ def self.process_args argv
 
       opt.separator nil
 
+      opt.on("--list", "-l",
+             "List classes ri knows about.") do
+        options[:list] = true
+      end
+
+      opt.separator nil
+
       opt.on("--[no-]profile",
              "Run with the ruby profiler") do |value|
         options[:profile] = value
@@ -331,6 +338,7 @@ def initialize initial_options = {}
     require 'profile' if options[:profile]
 
     @names = options[:names]
+    @list = options[:list]
 
     @doc_dirs = []
     @stores   = []
@@ -881,9 +889,10 @@ def in_path? file
   end
 
   ##
-  # Lists classes known to ri
+  # Lists classes known to ri starting with +names+.  If +names+ is empty all
+  # known classes are shown.
 
-  def list_known_classes
+  def list_known_classes names = []
     classes = []
 
     stores.each do |store|
@@ -892,9 +901,19 @@ def list_known_classes
 
     classes = classes.flatten.uniq.sort
 
+    unless names.empty? then
+      filter = Regexp.union names.map { |name| /^#{name}/ }
+
+      classes = classes.grep filter
+    end
+
     page do |io|
       if paging? or io.tty? then
-        io.puts "Classes and Modules known to ri:"
+        if names.empty? then
+          io.puts "Classes and Modules known to ri:"
+        else
+          io.puts "Classes and Modules starting with #{names.join ', '}:"
+        end
         io.puts
       end
 
@@ -1067,10 +1086,10 @@ def parse_name(name)
   def run
     if @list_doc_dirs then
       puts @doc_dirs
-    elsif @interactive then
+    elsif @list then
+      list_known_classes @names
+    elsif @interactive or @names.empty? then
       interactive
-    elsif @names.empty? then
-      list_known_classes
     else
       display_names @names
     end

test/test_rdoc_ri_driver.rb

@@ -600,6 +600,16 @@ def test_list_known_classes
     assert_equal "Ambiguous\nFoo\nFoo::Bar\nFoo::Baz\nInc\n", out
   end
 
+  def test_list_known_classes_name
+    util_store
+
+    out, = capture_io do
+      @driver.list_known_classes %w[F I]
+    end
+
+    assert_equal "Foo\nFoo::Bar\nFoo::Baz\nInc\n", out
+  end
+
   def test_list_methods_matching
     util_store