fastri 0.2.0.1 → 0.2.1.1

data/CHANGES

@@ -1,6 +1,17 @@
 
 User-visible changes in FastRI
 
+Since version 0.2.0 (2006-11-15)
+================================
+Features
+--------
+* fri will use a pager in full-text search mode, and also when asked to 
+  (-P, -T, --[no-]pager, --pager-cmd)
+* multiple queries supported:  fri upcase downcase
+* fri -S is 100ms faster since it avoids requiring rubygems.rb
+* list all classes/modules and methods with --classes and --methods, and both
+  with --list-names (-l)
+
 Since version 0.1.1 (2006-11-10)
 ================================
 Features

data/bin/fri

@@ -3,7 +3,6 @@
 # Copyright (C) 2006 Mauricio Fernandez <mfp@acm.org>
 #
 
-require 'rinda/ring'
 require 'optparse'
 require 'fastri/util'
 require 'fastri/full_text_index'
@@ -31,6 +30,10 @@ options = {
   :show_matches => false,
   :do_full_text => false, 
   :full_text_dir => File.join(FastRI::Util.find_home, ".fastri-fulltext"),
+  :use_pager => nil,
+  :pager => nil,
+  :list_classes => nil,
+  :list_methods => nil,
 }
 override_addr_env = false
 optparser = OptionParser.new do |opts|
@@ -57,14 +60,32 @@ optparser = OptionParser.new do |opts|
 
   opts.on("--show-matches", "Only show matching entries."){ options[:show_matches] = true }
 
+  opts.on("--classes", "List all known classes/modules.") do 
+    options[:use_pager]    = true
+    options[:list_classes] = true
+  end
+  opts.on("--methods", "List all known methods.") do 
+    options[:use_pager]    = true
+    options[:list_methods] = true
+  end
+  opts.on("-l", "--list-names", "List all known namespaces/methods.") do
+    options[:use_pager]    = true
+    options[:list_classes] = true
+    options[:list_methods] = true
+  end
+
   opts.on("-S", "--full-text", "Perform full-text search.") do 
     options[:do_full_text] = true
+    options[:use_pager]    = true if options[:use_pager].nil?
+    options[:format]       = "plain"
   end
 
   opts.on("-F", "--full-text-dir DIR", "Use full-text index in DIR",
           "(default: #{options[:full_text_dir]})") do |dir|
     options[:full_text_dir] = dir if dir
     options[:do_full_text]  = true
+    options[:use_pager]     = true
+    options[:format]        = "plain"
   end
 
   opts.on("-f", "--format FMT", "Format to use when displaying output:",
@@ -72,6 +93,19 @@ optparser = OptionParser.new do |opts|
     options[:format] = format
   end
 
+  opts.on("-P", "--[no-]pager", "Use pager.", "(default: don't)") do |usepager|
+    options[:use_pager] = usepager
+    options[:format] = "plain" if usepager
+  end
+
+  opts.on("-T", "Don't use a pager."){ options[:use_pager] = false }
+
+  opts.on("--pager-cmd PAGER", "Use pager PAGER.", "(default: don't)") do |pager|
+    options[:pager]     = pager
+    options[:use_pager] = true
+    options[:format]    = "plain"
+  end
+
   opts.on("-w", "--width WIDTH", "Set the width of the output.") do |width|
     w = width.to_i
     options[:width] = w > 0 ? w : options[:width]
@@ -84,7 +118,7 @@ optparser = OptionParser.new do |opts|
 end
 optparser.parse!
 
-if ARGV.empty?
+if !options[:list_classes] && !options[:list_methods] && ARGV.empty?
   puts optparser
   exit
 end
@@ -122,43 +156,7 @@ def magic_help(query)
     query
   end
 end
-help_query = magic_help(ARGV[0])
-
-#{{{ determine the address to bind to
-if override_addr_env
-  addr_spec = options[:addr]
-else
-  addr_spec = ENV["FASTRI_ADDR"] || options[:addr]
-end
-
-ip   = addr_spec[/^[^:]+/]    || "127.0.0.1"
-port = addr_spec[/:(\d+)/, 1] || 0
-addr = "druby://#{ip}:#{port}"
-
-#{{{ start DRb and perform request
-begin
-  DRb.start_service(addr)
-  ring_server = Rinda::RingFinger.primary
-rescue Exception
-  puts <<EOF
-Couldn't initialize DRb and locate the Ring server.
 
-Please make sure that:
- * the fastri-server is running, the server is bound to the correct interface,
-   and the ACL setup allows connections from this host
- * fri is using the correct interface for incoming DRb requests:
-   either set the FASTRI_ADDR environment variable, or use --bind ADDR, e.g
-      export FASTRI_ADDR="192.168.1.12"
-      fri Array
-EOF
-  exit(-1)
-end
-service = ring_server.read([:name, :FastRI, nil, nil])[2]
-info_options = {
-  :formatter => options[:format],
-  :width     => options[:width],
-  :lookup_order => options[:lookup_order],
-}
 
 MAX_CONTEXT_LINES = 20
 def context_wrap(text, width)
@@ -197,7 +195,7 @@ def display_fulltext_search_results(results, gem_dir_info = FastRI::Util.gem_dir
   puts
 end
 
-if options[:do_full_text]
+def perform_fulltext_search(options)
   fulltext = File.join(options[:full_text_dir], "full_text.dat")
   suffixes = File.join(options[:full_text_dir], "suffixes.dat")
   begin
@@ -231,8 +229,9 @@ EOF
     puts "nil"
   else
     puts "#{paths.size} hits"
-    paths.sort_by{|path| -path_map[path].size}.map do |path|
+    paths.sort_by{|path| 1.0 * -path_map[path].size / path_map[path].first.metadata[:size] ** 0.5}.map do |path|
       puts "=" * options[:width]
+      puts 1.0 * path_map[path].size / path_map[path].first.metadata[:size] ** 0.5
       display_fulltext_search_results(path_map[path], gem_dir_info, options[:width])
     end
   end
@@ -240,9 +239,74 @@ EOF
   exit 0
 end
 
-if options[:show_matches]
-  puts service.matches(help_query, info_options).sort
+#{{{ set up pager
+if options[:use_pager]
+  [options[:pager], ENV["PAGER"], "less", "more", "pager"].compact.uniq.each do |pager|
+    begin
+      $stdout = IO.popen(pager, "w")
+      at_exit{ $stdout.close }
+      break
+    rescue Exception
+    end
+  end
+end
+
+#{{{ perform full text search if asked to
+perform_fulltext_search(options) if options[:do_full_text]
+
+#{{{ normal query
+require 'rinda/ring'
+
+
+#{{{ determine the address to bind to
+if override_addr_env
+  addr_spec = options[:addr]
 else
-  puts service.info(help_query, info_options)
+  addr_spec = ENV["FASTRI_ADDR"] || options[:addr]
+end
+
+ip   = addr_spec[/^[^:]+/]    || "127.0.0.1"
+port = addr_spec[/:(\d+)/, 1] || 0
+addr = "druby://#{ip}:#{port}"
+
+#{{{ start DRb and perform request
+begin
+  DRb.start_service(addr)
+  ring_server = Rinda::RingFinger.primary
+rescue Exception
+  $stderr.puts <<EOF
+Couldn't initialize DRb and locate the Ring server.
+
+Please make sure that:
+ * the fastri-server is running, the server is bound to the correct interface,
+   and the ACL setup allows connections from this host
+ * fri is using the correct interface for incoming DRb requests:
+   either set the FASTRI_ADDR environment variable, or use --bind ADDR, e.g
+      export FASTRI_ADDR="192.168.1.12"
+      fri Array
+EOF
+  exit(-1)
+end
+service = ring_server.read([:name, :FastRI, nil, nil])[2]
+info_options = {
+  :formatter => options[:format],
+  :width     => options[:width],
+  :lookup_order => options[:lookup_order],
+}
+
+# {{{ list classes or methods
+puts service.all_classes if options[:list_classes]
+puts service.all_methods if options[:list_methods]
+exit if options[:list_classes] || options[:list_methods]
+
+# {{{ normal query
+
+ARGV.each do |term|
+  help_query = magic_help(term)
+  if options[:show_matches]
+    puts service.matches(help_query, info_options).sort
+  else
+    puts service.info(help_query, info_options)
+  end
 end
 # vi: set sw=2 expandtab:

data/bin/ri-emacs

@@ -182,7 +182,7 @@ end
 
 
 #{{{ event loop
-$stdout.sync = true
+#$stdout.sync = true # better not set sync=true, causes problems with emacs
 EventLoop.new(service).run
 
 # vi: set sw=2 expandtab:

data/lib/fastri/full_text_indexer.rb

@@ -17,7 +17,7 @@ class FullTextIndexer
   end
 
   def add_document(name, data, metadata = {})
-    @doc_hash[name] = [data, metadata]
+    @doc_hash[name] = [data, metadata.merge(:size => data.size)]
     @documents << name
   end
 

data/lib/fastri/ri_service.rb

@@ -256,6 +256,16 @@ class RiService
     r ? r.map{|x| x.gsub(/\./, "::")} : nil
   end
 
+  # Return array of strings with the names of all known methods.
+  def all_methods
+    @ri_reader.full_method_names
+  end
+
+  # Return array of strings with the names of all known classes.
+  def all_classes
+    @ri_reader.full_class_names
+  end
+
   private
 
   def obtain_unqualified_method_entries(name, separators, order)

data/lib/fastri/util.rb

@@ -1,11 +1,28 @@
 # Copyright (C) 2006  Mauricio Fernandez <mfp@acm.org>
 
-require 'rdoc/ri/ri_paths'
-begin
-  require 'rubygems'
-rescue LoadError
+# emulate rubygems.rb and define Gem.path if not loaded
+# This is much faster than requiring rubygems.rb, which loads way too much
+# stuff.
+unless defined? ::Gem
+  require 'rbconfig'
+  module Gem
+    def self.path
+      ENV['GEM_HOME'] || default_dir
+    end
+    def self.default_dir
+      if defined? RUBY_FRAMEWORK_VERSION
+        return File.join(File.dirname(Config::CONFIG["sitedir"]), "Gems")
+      else
+        File.join(Config::CONFIG['libdir'], 'ruby', 'gems', Config::CONFIG['ruby_version'])
+      end
+    end
+  end
 end
-
+# don't let rdoc/ri/ri_paths load rubygems.rb, that takes ~100ms !
+emulation = $".all?{|x| /rubygems\.rb$/ !~ x} # 1.9 compatibility
+$".unshift "rubygems.rb" if emulation
+require 'rdoc/ri/ri_paths'
+$".delete "rubygems.rb" if emulation
 require 'rdoc/ri/ri_writer'
 
 module FastRI

data/lib/fastri/version.rb

@@ -2,11 +2,11 @@
 #
 
 module FastRI
-  FASTRI_VERSION      = "0.2.0"
-  FASTRI_RELEASE_DATE = "2006-11-15"
+  FASTRI_VERSION      = "0.2.1"
+  FASTRI_RELEASE_DATE = "2006-11-23"
   FASTRI_INDEX_FORMAT = "0.1.0"
-  FASTRI_FT_INDEX_FORMAT = "0.0.0"
-  FASTRI_FT_INDEX_FORMAT_MAJOR = "0"
+  FASTRI_FT_INDEX_FORMAT = "1.0.0"
+  FASTRI_FT_INDEX_FORMAT_MAJOR = "1"
   FASTRI_FT_INDEX_FORMAT_MINOR = "0"
   FASTRI_FT_INDEX_FORMAT_TEENY = "0"
 end

data/test/test_full_text_indexer.rb

@@ -53,7 +53,7 @@ EOF
     fulltext    = StringIO.new("")
     suffixarray = StringIO.new("")
     @indexer.build_index(fulltext, suffixarray)
-    assert_equal(["\000\r\000\000\000foo.txt\000\004\b{\000\000"], 
+    assert_equal(["\000\027\000\000\000foo.txt\000\004\b{\006:\tsizei\002\230:\000"], 
                  fulltext.string[-200..-1].scan(/\0.*$/))
     assert_equal(4000 * 4, suffixarray.string.size)
   end

data/test/test_integration_full_text_index.rb

@@ -37,7 +37,7 @@ class TestIntegrationFullTextIndex < Test::Unit::TestCase
     index = get_index
     assert_equal("first.txt", index.lookup("foo").path)
     assert_equal("second.doc", index.lookup("bar").path)
-    assert_equal({:foo=>"baz", :type=>"text/plain"}, index.lookup("foo").metadata)
-    assert_equal({:bar=>"foo", :type=>"application/msword"}, index.lookup("bar").metadata)
+    assert_equal({:foo=>"baz", :type=>"text/plain", :size => 31}, index.lookup("foo").metadata)
+    assert_equal({:bar=>"foo", :type=>"application/msword", :size => 32}, index.lookup("bar").metadata)
   end
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: fastri
 version: !ruby/object:Gem::Version 
-  version: 0.2.0.1
-date: 2006-11-15 00:00:00 +01:00
+  version: 0.2.1.1
+date: 2006-11-23 00:00:00 +01:00
 summary: RI docs across machines, faster and smarter than ri.
 require_paths: 
 - lib