xapian_db 0.5.5 → 0.5.6

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+##0.5.6 (February 28th, 2011)
+
+Features:
+
+  - documents returned by a query have the new score property that reflects the match relevance in percent (1-100%)
+  - added compatibility to the kaminari pagination gem (thanks, Javi)
+  - added support for phrase searches (XapianDb.search('"this exact sentence"'))
+
 ##0.5.5 (February 25th, 2011)
 
 Fixes:

data/README.rdoc

@@ -155,6 +155,10 @@ You can query objects of a specific class:
 
   results = Person.search "name:Foo"
 
+You can search for exact phrases:
+
+  results = XapianDb.search('"this exact sentence"')
+
 If you want to paginate the result, pass the :per_page argument:
 
   results = Person.search "name:Foo", :per_page => 20
@@ -186,6 +190,7 @@ If you use a persistent database, the resultset may contain a spelling correctio
 The results behave like an array:
 
   doc = results.first
+  puts doc.score.to_s         # Get the relevance of the document
   puts doc.indexed_class      # Get the type of the indexed object as a string, e.g. "Person"
   puts doc.name               # We can access the configured attributes
   person = doc.indexed_object # Access the object behind this doc (lazy loaded)
@@ -194,6 +199,10 @@ Use a search result with will_paginate in a view:
 
   <%= will_paginate @results %>
 
+Or with kaminari:
+
+  <%= kaminari @results %>
+
 === Facets
 
 If you want to implement a simple drilldown for your searches, you can use a global facets query:

data/lib/xapian_db/database.rb

@@ -43,7 +43,7 @@ module XapianDb
     # Perform a search
     # @param [String] expression A valid search expression.
     # @param [Hash] options
-    # @option options [Integer] :per_page (10) How many docs per page?
+    # @option options [Integer] :per_page How many docs per page?
     # @option options [Array<Integer>] :sort_indices (nil) An array of attribute indices to sort by. This
     #   option is used internally by the search method implemented on configured classes. Do not use it
     #   directly unless
@@ -58,7 +58,7 @@ module XapianDb
     #   resultset = db.search("name:foo")
     # @return [XapianDb::Resultset] The resultset
     def search(expression, options={})
-      opts          = {:per_page => 10, :sort_decending => false}.merge(options)
+      opts          = {:sort_decending => false}.merge(options)
       @query_parser ||= QueryParser.new(self)
       query         = @query_parser.parse(expression)
 

data/lib/xapian_db/document_blueprint.rb

@@ -142,11 +142,17 @@ module XapianDb
       return @accessors_module unless @accessors_module.nil?
       @accessors_module = Module.new
 
-      # Add the accessor for the indexed class
+      # Add the accessors for the indexed class and the score
       @accessors_module.instance_eval do
+
         define_method :indexed_class do
           self.values[0].value
         end
+
+        define_method :score do
+          @score
+        end
+
       end
 
       # Add an accessor for each attribute

data/lib/xapian_db/query_parser.rb

@@ -21,6 +21,7 @@ module XapianDb
       @query_flags |= Xapian::QueryParser::FLAG_BOOLEAN             # enable boolean operators
       @query_flags |= Xapian::QueryParser::FLAG_BOOLEAN_ANY_CASE    # enable case insensitive boolean operators
       @query_flags |= Xapian::QueryParser::FLAG_SPELLING_CORRECTION # enable spelling corrections
+      @query_flags |= Xapian::QueryParser::FLAG_PHRASE              # enable phrase searches
     end
 
     # Parse an expression

data/lib/xapian_db/resultset.rb

@@ -4,23 +4,27 @@ module XapianDb
 
   # The resultset encapsulates a Xapian::Query object and allows paged access
   # to the found documents.
-  # The resultset is compatible with will_paginate.
+  # The resultset is compatible with will_paginate and kaminari.
   # @example Process the first page of a resultsest
   #   resultset.paginate(:page => 1, :per_page => 10).each do |doc|
   #     # do something with the xapian document
   #   end
   # @example Use the resultset and will_paginate in a view
   #   <%= will_paginate resultset %>
+  # @example Use the resultset and kaminari in a view
+  #   <%= paginate resultset %>
   # @author Gernot Kogler
   class Resultset < Array
 
     # The number of hits
     # @return [Integer]
     attr_reader :hits
+    alias_method :total_count, :hits
 
     # The number of pages
     # @return [Integer]
     attr_reader :total_pages
+    alias_method :num_pages, :total_pages
 
     # The current page
     # @return [Integer]
@@ -30,6 +34,9 @@ module XapianDb
     # @return [String]
     attr_accessor :spelling_suggestion
 
+    # The number of records per page
+    attr_reader :limit_value
+
     # Constructor
     # @param [Xapian::Enquire] enquiry a Xapian query result (see http://xapian.org/docs/apidoc/html/classXapian_1_1Enquire.html).
     #   Pass nil to get an empty result set.
@@ -41,18 +48,20 @@ module XapianDb
     # @option options [String] :spelling_suggestion (nil) The spelling corrected query (if a language is configured)
     def initialize(enquiry, options={})
 
-      @enquiry = enquiry
-      return build_empty_resultset if @enquiry.nil?
-
+      enquiry = enquiry
+      return build_empty_resultset if enquiry.nil?
       db_size              = options.delete :db_size
+      @spelling_suggestion = options.delete :spelling_suggestion
+      @hits                = enquiry.mset(0, db_size).matches_estimated
+      return build_empty_resultset if @hits == 0
+
       limit                = options.delete :limit
       page                 = options.delete :page
       per_page             = options.delete :per_page
-      @spelling_suggestion = options.delete :spelling_suggestion
       raise ArgumentError.new "unsupported options for resultset: #{options}" if options.size > 0
       raise ArgumentError.new "db_size option is required" unless db_size
 
-      @hits         = enquiry.mset(0, db_size).matches_estimated
+
       limit       ||= @hits
       per_page    ||= limit
       @total_pages  = (limit / per_page.to_f).ceil
@@ -61,9 +70,10 @@ module XapianDb
       count  = offset + per_page < limit ? per_page : limit - offset
       raise ArgumentError.new "page #{@page} does not exist" if @hits > 0 && offset >= limit
 
-      result_window = @enquiry.mset(offset, count)
-      self.replace result_window.matches.map{|match| decorate(match.document)}
+      result_window = enquiry.mset(offset, count)
+      self.replace result_window.matches.map{|match| decorate(match).document}
       @current_page = page
+      @limit_value = per_page
     end
 
     # The previous page number
@@ -88,11 +98,15 @@ module XapianDb
       self
     end
 
-    # Decorate a Xapian document with field accessors for each configured attribute
-    def decorate(document)
-      klass_name = document.values[0].value
+    # Decorate a Xapian match with field accessors for each configured attribute
+    # @param [Xapian::Match] a match
+    # @return [Xapian::Match] the decorated match
+    def decorate(match)
+      klass_name = match.document.values[0].value
       blueprint  = XapianDb::DocumentBlueprint.blueprint_for(Kernel.const_get(klass_name))
-      document.extend blueprint.accessors_module
+      match.document.extend blueprint.accessors_module
+      match.document.instance_variable_set :@score, match.percent
+      match
     end
 
   end

metadata

@@ -2,7 +2,7 @@
 name: xapian_db
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.5.5
+  version: 0.5.6
 platform: ruby
 authors: 
 - Gernot Kogler
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-25 00:00:00 +01:00
+date: 2011-02-28 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency