xapian_db 1.2.1.1 → 1.2.2

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+##1.2.2 (November 15th, 2011)
+
+Features:
+
+  - resultset accepts limit and paging options as strings
+  - added natural sort order option for blueprints (see README for details)
+
+IMPORTANT: FULL INDEX REBUILD REQUIRED FOR THIS RELEASE!
+
 ##1.2.1.1 (November 10th, 2011)
 
 Fixes:

data/README.rdoc

@@ -143,6 +143,19 @@ If you use associations in your blueprints, it might be a good idea to specify a
     blueprint.base_query Person.includes(:addresses)
   end
 
+You can specify a natural sort order for each class using a method symbol or a block. If you don't specify an order expression in your xapian query, the matches
+are ordered by relevance and - within the same relevance - by the natural sort order. If you don't specify the natural sort order, it defaults to id. Examples:
+
+  XapianDb::DocumentBlueprint.setup(House) do |blueprint|
+    blueprint.natural_sort_order :number
+  end
+
+  XapianDb::DocumentBlueprint.setup(Person) do |blueprint|
+    blueprint.natural_sort_order do
+      "#{surname} #{name}"
+    end
+  end
+
 Place these configurations either into the corresponding class or - I prefer to have the index configurations outside
 the models - into the file config/xapian_blueprints.rb.
 

data/lib/xapian_db/database.rb

@@ -74,10 +74,13 @@ module XapianDb
       sort_indices   = opts.delete :sort_indices
       sort_decending = opts.delete :sort_decending
 
+      sorter = Xapian::MultiValueKeyMaker.new
       if sort_indices
-        sorter = Xapian::MultiValueKeyMaker.new
         sort_indices.each { |index| sorter.add_value index }
         enquiry.set_sort_by_key_then_relevance(sorter, sort_decending)
+      else
+        sorter.add_value DocumentBlueprint.value_number_for(:natural_sort_order)
+        enquiry.set_sort_by_relevance_then_key sorter, true
       end
 
       opts[:spelling_suggestion] = @query_parser.spelling_suggestion

data/lib/xapian_db/document_blueprint.rb

@@ -74,12 +74,13 @@ module XapianDb
       # @param [attribute] The name of an attribute
       # @return [Integer] The value number
       def value_number_for(attribute)
-        raise ArgumentError.new "attribute #{attribute} is not configured in any blueprint" if @attributes.nil?
         return 0 if attribute.to_sym == :indexed_class
+        return 1 if attribute.to_sym == :natural_sort_order
+        raise ArgumentError.new "attribute #{attribute} is not configured in any blueprint" if @attributes.nil?
         position = @attributes.index attribute.to_sym
         if position
-          # We add 1 because value slot 0 is reserved for the class name
-          return position + 1
+          # We add 2 because slot 0 and 1 are reserved for indexed_class and natural_sort_order
+          return position + 2
         else
           raise ArgumentError.new "attribute #{attribute} is not configured in any blueprint"
         end
@@ -206,13 +207,14 @@ module XapianDb
     # ---------------------------------------------------------------------------------
 
     attr_accessor :_adapter
-    attr_reader :_base_query
+    attr_reader :_base_query, :_natural_sort_order
 
     # Construct the blueprint
     def initialize
-      @attributes_hash =      {}
+      @attributes_hash      = {}
       @indexed_methods_hash = {}
-      @type_map =             {}
+      @type_map             = {}
+      @_natural_sort_order  = :id
     end
 
     # Set the adapter
@@ -316,6 +318,15 @@ module XapianDb
       @_base_query = expression
     end
 
+    # Define the natural sort order.
+    # @param [String] name The name of the method that delivers the sort expression
+    # @param [Block] &block An optional block for complex configurations
+    # Pass a method name or a block, but not both
+    def natural_sort_order(name=nil, &block)
+      raise ArgumentError.new("natural_sort_order accepts a method name or a block, but not both") if name && block
+      @_natural_sort_order = name || block
+    end
+
     # Options for an indexed method
     class IndexOptions
 

data/lib/xapian_db/indexer.rb

@@ -32,15 +32,22 @@ module XapianDb
     # Store all configured fields
     def store_fields
 
-      # We store the class name of the object at position 0
-      @xapian_doc.add_value(0, @obj.class.name)
+      # class name of the object goes to position 0
+      @xapian_doc.add_value 0, @obj.class.name
+      # natural sort order goes to position 1
+      if @blueprint._natural_sort_order.is_a? Proc
+        sort_value = @obj.instance_eval &@blueprint._natural_sort_order
+      else
+        sort_value = @obj.send @blueprint._natural_sort_order
+      end
+      @xapian_doc.add_value 1, sort_value.to_s
 
       @blueprint.attribute_names.each do |attribute|
         block = @blueprint.block_for_attribute attribute
         if block
-          value = @obj.instance_eval(&block)
+          value = @obj.instance_eval &block
         else
-          value = @obj.send(attribute)
+          value = @obj.send attribute
         end
 
         codec          = XapianDb::TypeCodec.codec_for @blueprint.type_map[attribute]

data/lib/xapian_db/resultset.rb

@@ -63,12 +63,11 @@ module XapianDb
       raise ArgumentError.new "unsupported options for resultset: #{options}" if options.size > 0
       raise ArgumentError.new "db_size option is required" unless db_size
 
-
-      limit       ||= @hits
-      per_page    ||= limit
+      limit    = limit.nil? ? @hits : limit.to_i
+      per_page = per_page.nil? ? limit : per_page.to_i
+      page     = page.nil? ? 1 : page.to_i
+      offset   = (page - 1) * per_page
       @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
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xapian_db
 version: !ruby/object:Gem::Version
-  version: 1.2.1.1
+  version: 1.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-10 00:00:00.000000000 +01:00
+date: 2011-11-15 00:00:00.000000000 +01:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: daemons
-  requirement: &70195167722940 !ruby/object:Gem::Requirement
+  requirement: &70092616807260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 1.0.10
   type: :runtime
   prerelease: false
-  version_requirements: *70195167722940
+  version_requirements: *70092616807260
 - !ruby/object:Gem::Dependency
   name: xapian-ruby
-  requirement: &70195167722480 !ruby/object:Gem::Requirement
+  requirement: &70092616806800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,21 @@ dependencies:
         version: 1.2.6
   type: :runtime
   prerelease: false
-  version_requirements: *70195167722480
+  version_requirements: *70092616806800
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &70092616806420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70092616806420
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70195167722020 !ruby/object:Gem::Requirement
+  requirement: &70092616822240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +55,10 @@ dependencies:
         version: 2.3.1
   type: :development
   prerelease: false
-  version_requirements: *70195167722020
+  version_requirements: *70092616822240
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70195167721560 !ruby/object:Gem::Requirement
+  requirement: &70092616821640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +66,10 @@ dependencies:
         version: 0.3.7
   type: :development
   prerelease: false
-  version_requirements: *70195167721560
+  version_requirements: *70092616821640
 - !ruby/object:Gem::Dependency
   name: beanstalk-client
-  requirement: &70195167737400 !ruby/object:Gem::Requirement
+  requirement: &70092616821140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +77,10 @@ dependencies:
         version: 1.1.0
   type: :development
   prerelease: false
-  version_requirements: *70195167737400
+  version_requirements: *70092616821140
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70195167736960 !ruby/object:Gem::Requirement
+  requirement: &70092616820720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +88,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70195167736960
+  version_requirements: *70092616820720
 - !ruby/object:Gem::Dependency
   name: progressbar
-  requirement: &70195167736440 !ruby/object:Gem::Requirement
+  requirement: &70092616820240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,10 +99,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70195167736440
+  version_requirements: *70092616820240
 - !ruby/object:Gem::Dependency
   name: resque
-  requirement: &70195167735900 !ruby/object:Gem::Requirement
+  requirement: &70092616819740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,7 +110,7 @@ dependencies:
         version: 1.19.0
   type: :development
   prerelease: false
-  version_requirements: *70195167735900
+  version_requirements: *70092616819740
 description: XapianDb is a ruby gem that combines features of nosql databases and
   fulltext indexing. It is based on Xapian, an efficient and powerful indexing library
 email: gernot.kogler (at) garaio (dot) com