xapian_db 0.5.3 → 0.5.4

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+##0.5.4 (February 22th, 2011)
+
+Fixes:
+
+  - relative database paths in the config file are resolved correctly when the Rails server is started as a daemon (-d)
+
+Breaking Changes:
+
+  - the spelling suggestion of a query is now nil instead of an empty string if no suggestions were returned from xapian
+  - the resultset class (what you get back from a query) has been refactored for easier handling. See the README ("Process the results")
+    for details
+
 ##0.5.3 (February 15th, 2011)
 
 Fixes:

data/README.rdoc

@@ -149,22 +149,27 @@ You can query objects of a specific class:
 
   results = Person.search "name:Foo"
 
-If you want to override the default of 10 docs per page, pass the :per_page argument:
+If you want to paginate the result, pass the :per_page argument:
 
   results = Person.search "name:Foo", :per_page => 20
 
+If you want to limit the number of results, pass the :limit argument (handy if you use the query for autocompletion):
+
+    results = Person.search "name:Foo", :limit => 10
+
 On class queries you can specifiy order options:
 
   results = Person.search "name:Foo", :order => :first_name
   results = Person.search "Fo*", :order => [:name, :first_name], :sort_decending => true
 
-Please note that the order option is not avaliable for global searches (XapianDb.search...)
+Please note that the order option is not available for global searches (XapianDb.search...)
 
 === Process the results
 
 <code>XapianDb.search</code> returns a resultset object. You can access the number of hits directly:
 
-  results.size # Very fast, does not load the resulting documents
+  results.hits # Very fast, does not load the resulting documents; always returns the actual hit count
+               # even if a limit option was set in the query
 
 If you use a persistent database, the resultset may contain a spelling correction:
 
@@ -172,14 +177,9 @@ If you use a persistent database, the resultset may contain a spelling correctio
   results = XapianDb.search("moose")
   results.spelling_suggestion # "mouse"
 
-To access the found documents, get a page from the resultset:
-
-  page = results.paginate            # Get the first page
-  page = results.paginate :page => 2 # Get the second page
-
-Now you can access the documents:
+The results behave like an array:
 
-  doc = page.first
+  doc = results.first
   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)

data/lib/xapian_db/adapters/base_adapter.rb

@@ -30,8 +30,9 @@ module XapianDb
                options = {:sort_decending => false}.merge options
                class_scope = "indexed_class:#{klass.name.downcase}"
 
-               if options[:order]
-                 attr_names             = [options[:order]].flatten
+               order = options.delete :order
+               if order
+                 attr_names             = [order].flatten
                  blueprint              = XapianDb::DocumentBlueprint.blueprint_for klass
                  sort_indices           = attr_names.map {|attr_name| blueprint.value_index_for(attr_name)}
                  options[:sort_indices] = attr_names.map {|attr_name| blueprint.value_index_for(attr_name)}
@@ -39,7 +40,7 @@ module XapianDb
                result = XapianDb.database.search "#{class_scope} and (#{expression})", options
 
                # Remove the class scope from the spelling suggestion (if any)
-               unless result.spelling_suggestion.empty?
+               if result.spelling_suggestion
                  scope_length = "#{class_scope} and (".size
                  result.spelling_suggestion = result.spelling_suggestion.slice scope_length..-2
                end

data/lib/xapian_db/database.rb

@@ -67,13 +67,17 @@ module XapianDb
 
       Rails.logger.info "Executing XapianDb search: #{expression}" if defined?(Rails)
 
-      enquiry       = Xapian::Enquire.new(reader)
-      enquiry.query = query
-      if opts[:sort_indices]
+      enquiry        = Xapian::Enquire.new(reader)
+      enquiry.query  = query
+      sort_indices   = opts.delete :sort_indices
+      sort_decending = opts.delete :sort_decending
+
+      if sort_indices
         raise ArgumentError.new("Sorting is available for class scoped searches only") unless expression =~ /^indexed_class:/
         sorter = Xapian::MultiValueSorter.new
+
         options[:sort_indices].each do |index|
-          sorter.add(index, opts[:sort_decending])
+          sorter.add(index, sort_decending)
         end
         enquiry.set_sort_by_key_then_relevance(sorter)
       end

data/lib/xapian_db/query_parser.rb

@@ -41,6 +41,7 @@ module XapianDb
       XapianDb::DocumentBlueprint.searchable_prefixes.each{|prefix| parser.add_prefix(prefix.to_s.downcase, "X#{prefix.to_s.upcase}") }
       query = parser.parse_query(expression, @query_flags)
       @spelling_suggestion = parser.get_corrected_query_string
+      @spelling_suggestion = nil if @spelling_suggestion.empty?
       query
     end
 

data/lib/xapian_db/railtie.rb

@@ -21,13 +21,13 @@ module XapianDb
       if File.exist?(config_file_path)
         db_config = YAML::load_file config_file_path
         env_config = db_config[Rails.env]
-        database_path    = env_config["database"] || ":memory:"
+        database_path    = File.expand_path(env_config["database"]) || ":memory:"
         adapter          = env_config["adapter"]  || :active_record
         writer           = env_config["writer"]   || :direct
         beanstalk_daemon = env_config["beanstalk_daemon"]
       else
         # No config file, set the defaults
-        Rails.env == "test" ? database_path = ":memory:" : database_path = "db/xapian_db/#{Rails.env}"
+        Rails.env == "test" ? database_path = ":memory:" : database_path = File.expand_path("db/xapian_db/#{Rails.env}")
         adapter          = :active_record
         writer           = :direct
         beanstalk_daemon = nil

data/lib/xapian_db/resultset.rb

@@ -12,11 +12,11 @@ module XapianDb
   # @example Use the resultset and will_paginate in a view
   #   <%= will_paginate resultset %>
   # @author Gernot Kogler
-  class Resultset
+  class Resultset < Array
 
-    # The number of documents found
+    # The number of hits
     # @return [Integer]
-    attr_reader :size
+    attr_reader :hits
 
     # The number of pages
     # @return [Integer]
@@ -34,29 +34,36 @@ module XapianDb
     # @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.
     # @param [Hash] options
-    # @option options [Integer] :per_page (10) How many docs per page?
+    # @option options [Integer] :db_size The current size (nr of docs) of the database
+    # @option options [Integer] :limit The maximum number of documents to retrieve
+    # @option options [Integer] :page (1) The page number to retrieve
+    # @option options [Integer] :per_page (10) How many docs per page? Ignored if a limit option is given
     # @option options [String] :spelling_suggestion (nil) The spelling corrected query (if a language is configured)
-    def initialize(enquiry, options)
+    def initialize(enquiry, options={})
+
       @enquiry = enquiry
-      if @enquiry.nil?
-        @size = 0
-      else
-        # To get more accurate results, we pass the doc count to the mset method
-        @size = enquiry.mset(0, options[:db_size]).matches_estimated
-      end
-      @spelling_suggestion = options[:spelling_suggestion]
-      @per_page            = options[:per_page]
-      @total_pages         = @size == 0 ? 0 : (@size / @per_page.to_f).ceil
-      @current_page        = 1
-    end
+      return build_empty_resultset if @enquiry.nil?
+
+      db_size              = options.delete :db_size
+      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
+      page = page.nil? ? 1 : page.to_i
+      offset = (page - 1) * per_page
+      count  = offset + per_page < limit ? per_page : limit - offset
+      raise ArgumentError.new "page #{@page} does not exist" if @hits > 0 && offset >= limit
 
-    # Paginate the result
-    # @param [Hash] options Options for the persistent database
-    # @option options [Integer] :page (1) The page to access
-    def paginate(options={})
-      @current_page = options[:page] ? options[:page].to_i : 1
-      return [] if @current_page < 1 || @current_page > @total_pages
-      build_page(@current_page)
+      result_window = @enquiry.mset(offset, count)
+      self.replace result_window.matches.map{|match| decorate(match.document)}
+      @current_page = page
     end
 
     # The previous page number
@@ -73,17 +80,12 @@ module XapianDb
 
     private
 
-    # Build a page of Xapian documents
-    # @return [Array<Xapian::Document>] An array of xapian documents
-    def build_page(page)
-      docs = []
-      offset = (page - 1) * @per_page
-      return [] if offset > @size
-      result_window = @enquiry.mset(offset, @per_page)
-      result_window.matches.each do |match|
-        docs << decorate(match.document)
-      end
-      docs
+    # Build an empty resultset
+    def build_empty_resultset
+      @hits         = 0
+      @total_pages  = 0
+      @current_page = 0
+      self
     end
 
     # Decorate a Xapian document with field accessors for each configured attribute

metadata

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