fastri 0.1.1.1 → 0.2.0.1

data/test/test_integration_full_text_index.rb

@@ -0,0 +1,43 @@
+# Copyright (C) 2006  Mauricio Fernandez <mfp@acm.org>
+#
+
+require 'test/unit'
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+$:.unshift "lib"
+require 'fastri/full_text_indexer'
+require 'fastri/full_text_index'
+
+class TestIntegrationFullTextIndex < Test::Unit::TestCase
+  include FastRI
+  def setup
+    @indexer = FullTextIndexer.new(20)
+  end
+
+  require 'stringio'
+  def get_index
+    fulltextIO = StringIO.new("")
+    suffixIO   = StringIO.new("")
+    @indexer.build_index(fulltextIO, suffixIO)
+    FullTextIndex.new_from_ios(fulltextIO, suffixIO)
+  end
+
+  def test_basic_matching
+    @indexer.add_document("first.txt", "this is the first document: foo")
+    @indexer.add_document("second.txt", "this is the second document: bar")
+    index = get_index
+    assert_equal("first.txt", index.lookup("foo").path)
+    assert_equal("second.txt", index.lookup("bar").path)
+  end
+
+  def test_metadata
+    @indexer.add_document("first.txt", "this is the first document: foo",
+                          :type => "text/plain", :foo => 'baz')
+    @indexer.add_document("second.doc", "this is the second document: bar",
+                          :type => "application/msword", :bar => "foo")
+    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)
+  end
+end

data/test/test_ri_index.rb

@@ -89,6 +89,7 @@ EOF
   end
 
   def test_get_class_entry
+    assert_nil(@index.get_class_entry("NONEXISTENT_FOO"))
     assert_equal("ABC", @index.get_class_entry("ABC", nil).full_name)
     assert_nil(@index.get_class_entry("ABC", nil).source_index)
     assert_nil(@index.get_class_entry("ABC::DEF::Foo", 0))
@@ -141,6 +142,22 @@ EOF
                  @index.namespaces_under(toplevel, true, "stuff-1.1.0").map{|x| x.full_name})
   end
 
+  def test_source_paths_for_string
+    assert_equal([], @index.source_paths_for(""))
+    assert_equal([], @index.source_paths_for(nil))
+
+    assert_equal(["/usr/share/ri/system/", "/long/path/somegem-0.1.0"], @index.source_paths_for("ABC::DEF"))
+    assert_equal(["/long/path/somegem-0.1.0", "/long/path/stuff-1.1.0"], @index.source_paths_for("CDE.foo"))
+  end
+
+  def test_source_paths_for_entry
+    assert_equal(["/usr/share/ri/system/", "/long/path/somegem-0.1.0"],
+                 @index.source_paths_for(@index.get_class_entry("ABC::DEF")))
+    assert_equal(["/long/path/somegem-0.1.0", "/long/path/stuff-1.1.0"],
+                 @index.source_paths_for(@index.get_method_entry("CDE.foo")))
+  end
+
+
   def test_methods_under_scoped
     results = @index.methods_under("ABC", true, 1)
     assert_equal(["ABC::DEF::Foo#baz", "ABC::DEF::Foo#foo", "ABC::Zzz.foo"], results.map{|x| x.full_name})
@@ -255,7 +272,16 @@ EOF
     assert_equal(["CDE.foo"], @index.find_methods("foo", true, toplevel).map{|x| x.full_name})
   end
 
-  def test_classentry_contained_modules_matching
+  def test_num_namespaces
+    assert_equal(7, @index.num_namespaces)
+  end
+
+  def test_num_methods
+    assert_equal(7, @index.num_methods)
+  end
+
+  #{{{ ClassEntry and MethodEntry
+  def test_ClassEntry_contained_modules_matching
     toplevel = @index.top_level_namespace[0]
     assert_equal(["ABC"], toplevel.contained_modules_matching("ABC").map{|x| x.full_name})
 
@@ -263,5 +289,77 @@ EOF
     assert_equal([], class_entry.contained_modules_matching("ABC").map{|x| x.full_name})
     assert_equal(["ABC::DEF", "ABC::Zzz"], class_entry.contained_modules_matching("").map{|x| x.full_name})
   end
+
+  def test_ClassEntry_type
+    class_entry = @index.get_class_entry("ABC")
+    assert_equal(:namespace, class_entry.type)
+  end
+
+  def test_ClassEntry_path_names
+    class_entry = @index.get_class_entry("ABC")
+    assert_equal(["/usr/share/ri/system/ABC", "/long/path/somegem-0.1.0/ABC"], class_entry.path_names)
+
+    class_entry = @index.get_class_entry("ABC", 0)
+    assert_equal(["/usr/share/ri/system/ABC"], class_entry.path_names)
+    class_entry = @index.get_class_entry("ABC", 1)
+    assert_equal(["/long/path/somegem-0.1.0/ABC"], class_entry.path_names)
+  end
+
+  def test_ClassEntry_classes_and_modules
+    class_entry = @index.get_class_entry("ABC")
+    assert_equal(["ABC::DEF", "ABC::Zzz"], 
+                 class_entry.classes_and_modules.map{|x| x.full_name})
+    class_entry = @index.get_class_entry("ABC::DEF")
+    assert_equal(["ABC::DEF::Foo"], class_entry.classes_and_modules.map{|x| x.full_name})
+  end
+
+  def test_ClassEntry_contained_class_named
+    class_entry = @index.get_class_entry("ABC")
+    class_entry = class_entry.contained_class_named("DEF")
+    assert_equal("ABC::DEF", class_entry.full_name)
+    assert_equal(1, class_entry.index)
+    class_entry = class_entry.contained_class_named("Foo")
+    assert_equal(2, class_entry.index)
+    assert_nil(class_entry.contained_class_named("Bar"))
+    assert_equal(3, @index.get_class_entry("ABC").contained_class_named("Zzz").index)
+  end
+
+  def test_ClassEntry_methods_matching
+    class_entry = @index.get_class_entry("ABC::Zzz")
+    assert_equal([], class_entry.methods_matching("nonexistent", false))
+    assert_equal([3], class_entry.methods_matching("foo", true).map{|x| x.index})
+    assert_equal([4], class_entry.methods_matching("foo", false).map{|x| x.index})
+  end
+
+  def test_ClassEntry_recursively_find_methods_matching
+    class_entry = @index.get_class_entry("ABC")
+    assert_equal(["ABC::DEF.bar", "ABC::Zzz.foo"], 
+                 class_entry.recursively_find_methods_matching(//, true).map{|x| x.full_name})
+    assert_equal(["ABC::DEF::Foo#baz", "ABC::DEF::Foo#foo", "ABC::Zzz#foo"], 
+                 class_entry.recursively_find_methods_matching(//, false).map{|x| x.full_name})
+    assert_equal([], class_entry.recursively_find_methods_matching(/nonono/, false).map{|x| x.full_name})
+  end
+
+  def test_ClassEntry_all_method_names
+    class_entry = @index.get_class_entry("ABC")
+    assert_equal([], class_entry.all_method_names)
+    class_entry = @index.get_class_entry("ABC::Zzz")
+    assert_equal(["ABC::Zzz.foo", "ABC::Zzz#foo"], class_entry.all_method_names)
+  end
+
+  def test_MethodEntry_path_name
+    method_entry = @index.get_method_entry("CDE.foo")
+    assert_equal("/long/path/somegem-0.1.0/CDE/foo-c.yaml", method_entry.path_name)
+
+    method_entry = @index.get_method_entry("CDE.foo", 1)
+    assert_equal("/long/path/somegem-0.1.0/CDE/foo-c.yaml", method_entry.path_name)
+    method_entry = @index.get_method_entry("CDE.foo", 2)
+    assert_equal("/long/path/stuff-1.1.0/CDE/foo-c.yaml", method_entry.path_name)
+  end
+
+  def test_MethodEntry_type
+    method_entry = @index.get_method_entry("CDE.foo")
+    assert_equal(:method, method_entry.type)
+  end
 end
 

data/test/test_util.rb

@@ -0,0 +1,38 @@
+# Copyright (C) 2006  Mauricio Fernandez <mfp@acm.org>
+#
+
+require 'test/unit'
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+$:.unshift "lib"
+require 'fastri/util'
+
+class TestUtil < Test::Unit::TestCase
+  data = <<EOF
+foo 0.1.1 /usr/local/lib/ruby/gems/1.8/doc/foo-0.1.1/ri
+foo 1.1.1 /usr/local/lib/ruby/gems/1.8/doc/foo-1.1.1/ri
+bar 0.1.1 /usr/local/lib/ruby/gems/1.8/doc/bar-0.1.1/ri
+baz 0.1.1 /usr/local/lib/ruby/gems/1.8/doc/baz-0.1.1/ri
+EOF
+  GEM_DIR_INFO = data.split(/\n/).map{|l| l.split(/\s+/)}
+
+  include FastRI::Util
+  def test_gem_info_for_path
+    assert_equal(["foo", "0.1.1", "/usr/local/lib/ruby/gems/1.8/doc/foo-0.1.1/ri"],
+                 gem_info_for_path("/usr/local/lib/ruby/gems/1.8/doc/foo-0.1.1/ri/Array/cdesc-Array.yaml", GEM_DIR_INFO))
+    assert_equal(["foo", "1.1.1", "/usr/local/lib/ruby/gems/1.8/doc/foo-1.1.1/ri"],
+                 gem_info_for_path("/usr/local/lib/ruby/gems/1.8/doc/foo-1.1.1/ri/Array/cdesc-Array.yaml", GEM_DIR_INFO))
+    assert_equal(["bar", "0.1.1", "/usr/local/lib/ruby/gems/1.8/doc/bar-0.1.1/ri"],
+                 gem_info_for_path("/usr/local/lib/ruby/gems/1.8/doc/bar-0.1.1/ri/Array/cdesc-Array.yaml", GEM_DIR_INFO))
+    assert_equal(["baz", "0.1.1", "/usr/local/lib/ruby/gems/1.8/doc/baz-0.1.1/ri"],
+                 gem_info_for_path("/usr/local/lib/ruby/gems/1.8/doc/baz-0.1.1/ri/Array/cdesc-Array.yaml", GEM_DIR_INFO))
+    assert_nil(gem_info_for_path("/usr/lib/ruby/gems/1.8/doc/baz-1.1.1/ri/Array/cdesc-Array.yaml", GEM_DIR_INFO))
+  end
+
+  def test_gem_relpath_to_full_name
+    assert_equal("Array", gem_relpath_to_full_name("Array/cdesc-Array.yaml"))
+    assert_equal("String", gem_relpath_to_full_name("String/cdesc-String.yaml"))
+    assert_equal("Foo::Bar::String", gem_relpath_to_full_name("Foo/Bar/String/cdesc-String.yaml"))
+    assert_equal("Foo::Bar#eql?", gem_relpath_to_full_name("Foo/Bar/eql%3f-i.yaml"))
+    assert_equal("Foo::Bar.eql?", gem_relpath_to_full_name("Foo/Bar/eql%3f-c.yaml"))
+  end
+end

metadata

@@ -3,15 +3,15 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: fastri
 version: !ruby/object:Gem::Version 
-  version: 0.1.1.1
-date: 2006-11-10 00:00:00 +01:00
+  version: 0.2.0.1
+date: 2006-11-15 00:00:00 +01:00
 summary: RI docs across machines, faster and smarter than ri.
 require_paths: 
 - lib
 email: mfp@acm.org
 homepage: http://eigenclass.org/hiki.rb?fastri
 rubyforge_project: 
-description: FastRI is an alternative to the ri command-line tool. It is *much* faster, and also allows you to offer RI lookup services over DRb. FastRI is a bit smarter than ri, and can find classes anywhere in the hierarchy without specifying the "full path". It also knows about gems, and can tell you e.g. which extensions to a core class were added by a specific gem.
+description: FastRI is an alternative to the ri command-line tool. It is *much* faster, and also allows you to offer RI lookup services over DRb. FastRI is smarter than ri, and can find classes anywhere in the hierarchy without specifying the "full path". FastRI can perform fast full-text searches. It also knows about gems, and can tell you e.g. which extensions to a core class were added by a specific gem.
 autorequire: 
 default_executable: 
 bindir: bin
@@ -60,6 +60,9 @@ files:
 - lib/fastri/ri_index.rb
 - lib/fastri/ri_service.rb
 - lib/fastri/version.rb
+- lib/fastri/util.rb
+- lib/fastri/full_text_indexer.rb
+- lib/fastri/full_text_index.rb
 - lib/fastri/name_descriptor.rb
 - CHANGES
 - COPYING
@@ -68,14 +71,22 @@ files:
 - Rakefile
 - README.en
 - test/test_ri_index.rb
+- test/test_full_text_index.rb
 - test/test_functional_ri_service.rb
+- test/test_full_text_indexer.rb
 - test/test_name_descriptor.rb
+- test/test_util.rb
+- test/test_integration_full_text_index.rb
 - setup.rb
 - pre-install.rb
 test_files: 
 - test/test_ri_index.rb
+- test/test_full_text_index.rb
 - test/test_functional_ri_service.rb
+- test/test_full_text_indexer.rb
 - test/test_name_descriptor.rb
+- test/test_util.rb
+- test/test_integration_full_text_index.rb
 rdoc_options: 
 - --title
 - "FastRI: better, faster ri"