xapian_db 1.2.3 → 1.2.4

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+##1.2.4 (March 6th, 2012)
+
+Features:
+
+  - Codec for DateTime objects added
+  - autoindex option for blueprints added
+
+Fixes:
+
+  - the ActiveRecord after_commit hook must not reindex the object if it is a destroy action
+
 ##1.2.3 (December 12th, 2011)
 
 Changes:

data/README.rdoc

@@ -1,5 +1,7 @@
 = XapianDb
 
+{<img src="https://secure.travis-ci.org/garaio/xapian_db.png" />}[http://travis-ci.org/garaio/xapian_db]
+
 == Important Information
 
 If you upgrade from an earlier version of xapian_db to 1.1, you MUST rebuild your entire index (XapianDb.rebuild_xapian_index)!
@@ -128,12 +130,13 @@ You may add a filter expression to exclude objects from the index. This is handy
       blueprint.ignore_if {active == false}
     end
 
-You can add a type information to an attribute. As of now the special types :string, :date and :number are supported (and required for range queries):
+You can add a type information to an attribute. As of now the special types :string, :date, :date_time and :number are supported (and required for range queries):
 
     XapianDb::DocumentBlueprint.setup(:Person) do |blueprint|
       blueprint.attribute :age,           :as => :number
       blueprint.attribute :date_of_birth, :as => :date
       blueprint.attribute :name,          :as => :string
+      blueprint.attribute :updated_at,    :as => :date_time
     end
 
 You can override the global adapter configuration in a specific blueprint. Let's say you use ActiveRecord, but you have
@@ -164,6 +167,15 @@ are ordered by relevance and - within the same relevance - by the natural sort o
     end
   end
 
+If you want to manage the (re)indexing of your objects on your own, turn off autoindexing in your blueprint:
+
+  XapianDb::DocumentBlueprint.setup(:Person) do |blueprint|
+    blueprint.autoindex false
+  end
+
+This will turn off the auto-reindexing for any object of the configured class. Use XapianDb.reindex(object) to trigger the reindexing logic in your code. Please note that destroying an object will always remove it from the xapian index.
+
+
 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/Rakefile

@@ -1 +1,7 @@
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
+
+import 'tasks/spec.rake'
+
+desc 'Default: run all specs'
+task :default => :spec
+

data/lib/type_codec.rb

@@ -96,6 +96,32 @@ module XapianDb
       end
     end
 
+    class DateTimeCodec
+
+      # Encode a datetime to a string in the format 'yyyymmdd h:m:s+l'
+      # @param [DateTime] datetime a datetime object to encode
+      # @return [String] the encoded datetime
+      def self.encode(datetime)
+        return '' unless datetime
+        begin
+          datetime.strftime "%Y%m%d %H:%M:%S+%L"
+        rescue NoMethodError
+          raise ArgumentError.new "#{datetime} was expected to be a datetime"
+        end
+      end
+
+      # Decode a string to a datetime
+      # @param [String] datetime_as_string a string representing a datetime
+      # @return [DateTime] the parsed datetime
+      def self.decode(datetime_as_string)
+        begin
+          DateTime.parse datetime_as_string
+        rescue ArgumentError
+          raise ArgumentError.new "'#{datetime_as_string}' cannot be converted to a datetime"
+        end
+      end
+    end
+
     class NumberCodec
 
       # Encode a number to a sortable string

data/lib/xapian_db/adapters/active_record_adapter.rb

@@ -46,9 +46,11 @@ module XapianDb
            end
 
            klass.class_eval do
-             # add the after commit logic
-             after_commit do
-               XapianDb.reindex(self)
+             # add the after commit logic, unless the blueprint has autoindexing turned off
+             if XapianDb::DocumentBlueprint.blueprint_for(klass.name).autoindex?
+               after_commit do
+                 XapianDb.reindex(self) unless self.destroyed?
+               end
              end
 
              # add the after destroy logic

data/lib/xapian_db/document_blueprint.rb

@@ -248,6 +248,7 @@ module XapianDb
       @indexed_methods_hash = {}
       @type_map             = {}
       @_natural_sort_order  = :id
+      @autoindex            = true
     end
 
     # Set the adapter
@@ -265,6 +266,18 @@ module XapianDb
       @_adapter || XapianDb::Config.adapter || XapianDb::Adapters::GenericAdapter
     end
 
+    # Should objects for this blueprint be automatically reindexed?
+    # @param [Boolean] boolean Yes or no?
+    def autoindex(boolean)
+      @autoindex = boolean
+    end
+
+    # Get the autoindex value
+    # @return [Boolean] The autoindex value
+    def autoindex?
+      @autoindex
+    end
+
     # Add an attribute to the blueprint. Attributes will be stored in the xapian documents an can be
     # accessed from a search result.
     # @param [String] name The name of the method that delivers the value for the attribute

data/tasks/spec.rake

@@ -0,0 +1,9 @@
+require 'rspec/core/rake_task'
+
+namespace :spec do
+  RSpec::Core::RakeTask.new(:unit) do |t|
+    t.pattern    = "spec/**/*_spec.rb"
+  end
+end
+
+task :spec => ['spec:unit']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xapian_db
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-13 00:00:00.000000000 Z
+date: 2012-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: daemons
-  requirement: &70136488601320 !ruby/object:Gem::Requirement
+  requirement: &70101802013500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.0.10
   type: :runtime
   prerelease: false
-  version_requirements: *70136488601320
+  version_requirements: *70101802013500
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70136488600860 !ruby/object:Gem::Requirement
+  requirement: &70101802012640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70136488600860
+  version_requirements: *70101802012640
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70136488600080 !ruby/object:Gem::Requirement
+  requirement: &70101802011100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 2.3.1
   type: :development
   prerelease: false
-  version_requirements: *70136488600080
+  version_requirements: *70101802011100
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70136488599340 !ruby/object:Gem::Requirement
+  requirement: &70101802025080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 0.3.7
   type: :development
   prerelease: false
-  version_requirements: *70136488599340
+  version_requirements: *70101802025080
 - !ruby/object:Gem::Dependency
   name: beanstalk-client
-  requirement: &70136488615000 !ruby/object:Gem::Requirement
+  requirement: &70101802021980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 1.1.0
   type: :development
   prerelease: false
-  version_requirements: *70136488615000
+  version_requirements: *70101802021980
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70136488614460 !ruby/object:Gem::Requirement
+  requirement: &70101802020280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70136488614460
+  version_requirements: *70101802020280
 - !ruby/object:Gem::Dependency
   name: progressbar
-  requirement: &70136488613860 !ruby/object:Gem::Requirement
+  requirement: &70101802019120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70136488613860
+  version_requirements: *70101802019120
 - !ruby/object:Gem::Dependency
   name: resque
-  requirement: &70136488613340 !ruby/object:Gem::Requirement
+  requirement: &70101802032660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +98,18 @@ dependencies:
         version: 1.19.0
   type: :development
   prerelease: false
-  version_requirements: *70136488613340
+  version_requirements: *70101802032660
+- !ruby/object:Gem::Dependency
+  name: xapian-ruby
+  requirement: &70101802028880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.7.1
+  type: :development
+  prerelease: false
+  version_requirements: *70101802028880
 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
@@ -148,6 +159,7 @@ files:
 - lib/xapian_db/stopwords/update_stopwords.rb
 - lib/xapian_db/utilities.rb
 - lib/xapian_db.rb
+- tasks/spec.rake
 - tasks/xapian_rebuild_index.rake
 - LICENSE
 - README.rdoc
@@ -179,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.12
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Ruby library to use a Xapian db as a key/value store with high performance