xspond-xapian-ruby 0.1 → 0.1.1

data/ext/extconf.rb

@@ -1,6 +1,6 @@
 require 'mkmf'
 
-XAPIAN_RUBY_VERSION = 0.1
+XAPIAN_RUBY_VERSION = '0.1.1'
 
 # Shamelessly borrowed from the RMagick project
 # Thanks!

data/lib/xapian.rb

@@ -49,21 +49,64 @@ module Xapian
   # underlying Iterator
   def _safelyIterate(dangerousStart, dangerousEnd) #:nodoc:
     retval = Array.new
-    
+
     item = dangerousStart
     lastTerm = dangerousEnd
-    
+
     return retval if dangerousStart.equals(dangerousEnd)
 
-    begin      
+    begin
       retval.push(yield(item))
       item.next()
-    end while not item.equals(lastTerm) # must use primitive C++ comparator 
-    
+    end while not item.equals(lastTerm) # must use primitive C++ comparator
+
     return retval
   end # _safelyIterate
   module_function :_safelyIterate
 
+  # A class to wrap safelyIterate to eliminate the overhead of generating an array
+  #
+  # new takes the start iterorator, end iterator, and a block used to generate an
+  # appropriate Ruby object to wrap the underlying Iterator
+  class ProxyIterator
+    instance_methods.each {|name| undef_method name if name !~ /^(__|instance_eval)/ }
+
+    include Enumerable
+
+    def initialize(object, dangerousStart, dangerousEnd, &block)
+      @object = object
+      @dangerousStart = dangerousStart
+      @dangerousEnd = @object.send(dangerousEnd)
+      @block = block
+      @proxy_target = nil
+    end
+
+    def each
+      # if the array is already loaded use it
+      # otherwise use iterator
+      if @proxy_target
+        @proxy_target.each {|i| yield(i) }
+      else
+        item = @object.send(@dangerousStart)
+        # Must use .equals NOT ==
+        while !item.equals(@dangerousEnd)
+          yield(@block.call(item))
+          item.next
+        end
+      end
+    end
+
+    def method_missing(method, *args)
+      self.load_target.send(method, *args)
+    end
+
+    protected
+
+    def load_target
+      @proxy_target ||= self.entries
+    end
+  end
+
   #--
   ### safe Ruby wrapper for the dangerous C++ Xapian::TermIterator class
   class Xapian::Term
@@ -85,7 +128,7 @@ module Xapian
   # non-iterative data.
   # (MSetIterator is not dangerous, but it is inconvenient to use from a Ruby
   # idiom, so we wrap it..)
-  class Xapian::Match     
+  class Xapian::Match
     attr_accessor :docid, :document, :rank, :weight, :collapse_count, :percent
 
     def initialize(docid, document, rank, weight, collapse_count, percent)
@@ -98,7 +141,7 @@ module Xapian
     end # initialize
 
     def ==(other)
-      return other.is_a?(Xapian::Match) && other.docid == @docid && other.rank == @rank && 
+      return other.is_a?(Xapian::Match) && other.docid == @docid && other.rank == @rank &&
         other.weight == @weight && other.collapse_count == @collapse_count && other.percent == @percent
     end
 
@@ -124,7 +167,7 @@ module Xapian
   # Ruby wrapper for Xapian::ValueIterator
   class Xapian::Value
     attr_accessor :value, :valueno
-    
+
     def initialize(value, valueno)
       @value = value
       @valueno = valueno
@@ -139,13 +182,13 @@ module Xapian
   # Extend Xapian::Document with a nice wrapper for its nasty input_iterators
   class Xapian::Document
     def terms
-      Xapian._safelyIterate(self._dangerous_termlist_begin(), self._dangerous_termlist_end()) { |item|
+      ProxyIterator.new(self, :_dangerous_termlist_begin, :_dangerous_termlist_end) { |item|
         Xapian::Term.new(item.term, item.wdf)
       }
     end # terms
 
     def values
-      Xapian._safelyIterate(self._dangerous_values_begin(), self._dangerous_values_end()) { |item|
+      ProxyIterator.new(self, :_dangerous_values_begin, :_dangerous_values_end) { |item|
         Xapian::Value.new(item.value, item.valueno)
       }
     end # terms
@@ -156,7 +199,7 @@ module Xapian
   # Extend Xapian::Query with a nice wrapper for its dangerous iterators
   class Xapian::Query
     def terms
-      Xapian._safelyIterate(self._dangerous_terms_begin(), self._dangerous_terms_end()) { |item|
+      ProxyIterator.new(self, :_dangerous_terms_begin, :_dangerous_terms_end) { |item|
         Xapian::Term.new(item.term, item.wdf)
         # termfreq is not supported by TermIterators from Queries
       }
@@ -169,7 +212,7 @@ module Xapian
     # Get matching terms for some document.
     # document can be either a Xapian::DocID or a Xapian::MSetIterator
     def matching_terms(document)
-      Xapian._safelyIterate(self._dangerous_matching_terms_begin(document), 
+      Xapian._safelyIterate(self._dangerous_matching_terms_begin(document),
                             self._dangerous_matching_terms_end(document)) { |item|
         Xapian::Term.new(item.term, item.wdf)
       }
@@ -180,8 +223,7 @@ module Xapian
   # programming idiom. So we wrap them.
   class Xapian::MSet
     def matches
-      Xapian._safelyIterate(self._begin(), 
-                            self._end()) { |item|
+      ProxyIterator.new(self, :_begin, :_end) { |item|
         Xapian::Match.new(item.docid, item.document, item.rank, item.weight, item.collapse_count, item.percent)
       }
 
@@ -192,10 +234,9 @@ module Xapian
   # programming idiom. So we wrap them.
   class Xapian::ESet
     def terms
-      Xapian._safelyIterate(self._begin(), 
-                            self._end()) { |item|
-	# note: in the ExpandTerm wrapper, we implicitly rename
-	# ESetIterator#termname() (defined in xapian.i) to ExpandTerm#term()
+      ProxyIterator.new(self, :_begin, :_end) { |item|
+        # note: in the ExpandTerm wrapper, we implicitly rename
+        # ESetIterator#termname() (defined in xapian.i) to ExpandTerm#term()
         Xapian::ExpandTerm.new(item.termname, item.weight)
       }
 
@@ -225,8 +266,7 @@ module Xapian
   class Xapian::Database
     # Returns an Array of all Xapian::Terms for this database.
     def allterms
-      Xapian._safelyIterate(self._dangerous_allterms_begin(), 
-                            self._dangerous_allterms_end()) { |item|
+      ProxyIterator.new(self, :_dangerous_allterms_begin, :_dangerous_allterms_end) { |item|
         Xapian::Term.new(item.term, 0, item.termfreq)
       }
     end # allterms
@@ -234,10 +274,10 @@ module Xapian
     # Returns an Array of Xapian::Postings for the given term.
     # term is a string.
     def postlist(term)
-      Xapian._safelyIterate(self._dangerous_postlist_begin(term), 
+      Xapian._safelyIterate(self._dangerous_postlist_begin(term),
                             self._dangerous_postlist_end(term)) { |item|
         Xapian::Posting.new(item.docid, item.doclength, item.wdf)
-      }      
+      }
     end # postlist(term)
 
     # Returns an Array of Terms for the given docid.
@@ -247,7 +287,7 @@ module Xapian
         Xapian::Term.new(item.term, item.wdf, item.termfreq)
       }
     end # termlist(docid)
-    
+
 
     # Returns an Array of Xapian::Termpos objects for the given term (a String)
     # in the given docid.

data/tests/smoketest.rb

@@ -34,7 +34,7 @@ end
 
 class XapianSmoketest < Test::Unit::TestCase
 
-  def setup 
+  def setup
     @stem = Xapian::Stem.new("english")
 
     @doc = Xapian::Document.new()
@@ -43,7 +43,7 @@ class XapianSmoketest < Test::Unit::TestCase
     @doc.add_posting(@stem.call("there"), 2)
     @doc.add_posting(@stem.call("anybody"), 3)
     @doc.add_posting(@stem.call("out"), 4)
-    @doc.add_posting(@stem.call("there"), 5)    
+    @doc.add_posting(@stem.call("there"), 5)
     @doc.add_term("XYzzy")
 
     @db = Xapian::inmemory_open()
@@ -61,7 +61,7 @@ class XapianSmoketest < Test::Unit::TestCase
   end # test_version
 
   def test_stem
-    assert_equal("Xapian::Stem(english)", @stem.description())    
+    assert_equal("Xapian::Stem(english)", @stem.description())
 
     assert_equal("is", @stem.call("is"))
     assert_equal("go", @stem.call("going"))
@@ -84,6 +84,14 @@ class XapianSmoketest < Test::Unit::TestCase
 
   end # test_document
 
+  def test_document_terms
+    terms = @doc.terms
+
+    assert_not_nil(terms.find {|i| i.term == "there" })
+    assert_not_nil(terms.find {|i| i.term == "out" })
+    assert_equal(terms.size, terms.map {|i| i }.size)
+  end
+
   def test_001_database
     assert_not_nil(@db)
     assert_equal("WritableDatabase()", @db.description())
@@ -91,7 +99,7 @@ class XapianSmoketest < Test::Unit::TestCase
   end # test_database
 
   def test_002_queries
-    assert_equal("Xapian::Query((smoke OR test OR terms))",  
+    assert_equal("Xapian::Query((smoke OR test OR terms))",
                  Xapian::Query.new(Xapian::Query::OP_OR ,["smoke", "test", "terms"]).description())
 
     phraseQuery = Xapian::Query.new(Xapian::Query::OP_PHRASE ,["smoke", "test", "tuple"])
@@ -100,9 +108,9 @@ class XapianSmoketest < Test::Unit::TestCase
     assert_equal("Xapian::Query((smoke PHRASE 3 test PHRASE 3 tuple))", phraseQuery.description())
     assert_equal("Xapian::Query((smoke XOR (smoke PHRASE 3 test PHRASE 3 tuple) XOR string))", xorQuery.description())
 
-    assert_equal([Xapian::Term.new("smoke", 1), 
-                  Xapian::Term.new("string", 1), 
-                  Xapian::Term.new("test", 1), 
+    assert_equal([Xapian::Term.new("smoke", 1),
+                  Xapian::Term.new("string", 1),
+                  Xapian::Term.new("test", 1),
                   Xapian::Term.new("tuple", 1)], xorQuery.terms())
 
     assert_equal(Xapian::Query::OP_ELITE_SET, 10)
@@ -111,7 +119,7 @@ class XapianSmoketest < Test::Unit::TestCase
   def test_003_enquire
     @enq = Xapian::Enquire.new(@db)
     assert_not_nil(@enq)
-    
+
     @enq.query = Xapian::Query.new(Xapian::Query::OP_OR, "there", "is")
     mset = @enq.mset(0, 10)
 
@@ -126,7 +134,7 @@ class XapianSmoketest < Test::Unit::TestCase
   def test_004_mset_iterator
     @enq = Xapian::Enquire.new(@db)
     assert_not_nil(@enq)
-    
+
     @enq.query = Xapian::Query.new(Xapian::Query::OP_OR, "there", "is")
     mset = @enq.mset(0, 10)
 
@@ -152,7 +160,7 @@ class XapianSmoketest < Test::Unit::TestCase
   def test_006_database_allterms
     assert_equal(5, @db.allterms.size())
   end
-  
+
   # Feature test for Database.postlist
   def test_007_database_postlist
     assert_equal(1, @db.postlist("there").size())

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: xspond-xapian-ruby
 version: !ruby/object:Gem::Version 
-  version: "0.1"
+  version: 0.1.1
 platform: ruby
 authors: 
 - William Weidendorf
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-10 00:00:00 -07:00
+date: 2009-03-11 00:00:00 -07:00
 default_executable: 
 dependencies: []