xapian_db 0.5.7 → 0.5.8

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+##0.5.8 (March 22th, 2011)
+
+Fixes:
+
+  - automatic reindexing of a changed object now works when using beanstalk and the worker rake task
+
+Features:
+
+  - support for transactions (see the README for details)
+
 ##0.5.7 (March 7th, 2011)
 
 Fixes:

data/README.rdoc

@@ -116,6 +116,14 @@ You may add a filter expression to exclude objects from the index. This is handy
       blueprint.ignore_if {active == false}
     end
 
+You can override the global adapter configuration in a specific blueprint. Let's say you use ActiveRecord, but you have
+one more class that is not stored in the database, but you want it to be indexed:
+
+XapianDb::DocumentBlueprint.setup(SpecialClass) do |blueprint|
+  blueprint.adapter :generic
+  blueprint.index   :some_stuff
+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.
 
@@ -226,6 +234,16 @@ A global facet search always groups the results by the class of the indexed obje
 
 At the class level, any attribute can be used for a facet query.
 
+=== Transactions
+
+You can execute a block of code inside a XapianDb transaction. This ensures that the changed objects in your block will get reindexed
+only if the block does not raise an exception.
+
+  XapianDb.transaction do
+    object1.save
+    object2.save
+  end
+
 == Production setup
 
 Since Xapian allows only one database instance to write to the index, the default setup of XapianDb will not work

data/lib/xapian_db/adapters/active_record_adapter.rb

@@ -10,7 +10,7 @@ module XapianDb
     # This adapter does the following:
     # - adds the instance method <code>xapian_id</code> to an indexed class
     # - adds the class method <code>rebuild_xapian_index</code> to an indexed class
-    # - adds an after save block to an indexed class to update the index
+    # - adds an after commit block to an indexed class to update the index
     # - adds an after destroy block to an indexed class to update the index
     # - adds the instance method <code>indexed_object</code> to the module that will be included
     #   in every found xapian document
@@ -38,24 +38,24 @@ module XapianDb
            klass.class_eval do
 
              # add the after save logic
-             after_save do
+             after_commit do
                blueprint = XapianDb::DocumentBlueprint.blueprint_for klass
                if blueprint.should_index?(self)
-                 XapianDb::Config.writer.index(self)
+                 XapianDb.index(self)
                else
-                 XapianDb::Config.writer.unindex(self)
+                 XapianDb.unindex(self)
                end
              end
 
              # add the after destroy logic
              after_destroy do
-               XapianDb::Config.writer.unindex(self)
+               XapianDb.unindex(self)
              end
 
              # Add a method to reindex all models of this class
              define_singleton_method(:rebuild_xapian_index) do |options={}|
                options[:primary_key] = klass.primary_key
-               XapianDb::Config.writer.reindex_class(klass, options)
+               XapianDb.reindex_class(klass, options)
              end
            end
 

data/lib/xapian_db/adapters/datamapper_adapter.rb

@@ -40,21 +40,21 @@ module XapianDb
              after :save do
                blueprint = XapianDb::DocumentBlueprint.blueprint_for klass
                if blueprint.should_index?(self)
-                 XapianDb::Config.writer.index(self)
+                 XapianDb.index(self)
                else
-                 XapianDb::Config.writer.unindex(self)
+                 XapianDb.unindex(self)
                end
              end
 
              # add the after destroy logic
              after :destroy do
-               XapianDb::Config.writer.unindex(self)
+               XapianDb.unindex(self)
              end
 
              # Add a method to reindex all models of this class
              define_singleton_method(:rebuild_xapian_index) do |options={}|
                options[:primary_key] = klass.serial.name
-               XapianDb::Config.writer.reindex_class(self, options)
+               XapianDb.reindex_class(self, options)
              end
            end
 

data/lib/xapian_db/config.rb

@@ -12,6 +12,8 @@ module XapianDb
   # @author Gernot Kogler
   class Config
 
+    include XapianDb::Utilities
+
     # ---------------------------------------------------------------------------------
     # Singleton methods
     # ---------------------------------------------------------------------------------
@@ -48,7 +50,6 @@ module XapianDb
     # DSL methods
     # ---------------------------------------------------------------------------------
 
-    #
     attr_reader :_database, :_adapter, :_writer, :_beanstalk_daemon, :_stemmer, :_stopper
 
     # Set the global database to use
@@ -108,16 +109,9 @@ module XapianDb
     #   end
     # see {LANGUAGE_MAP} for supported languages
     def language(lang)
-      key = lang.to_sym
-      @_stemmer = XapianDb::Repositories::Stemmer.stemmer_for key
-      key == :none ? @_stopper = nil : @_stopper = XapianDb::Repositories::Stopper.stopper_for(key)
-    end
-
-    private
-
-    # TODO: move this to a helper module
-    def camelize(string)
-      string.split(/[^a-z0-9]/i).map{|w| w.capitalize}.join
+      lang ||= :none
+      @_stemmer = XapianDb::Repositories::Stemmer.stemmer_for lang
+      @_stopper = lang == :none ? nil : XapianDb::Repositories::Stopper.stopper_for(lang)
     end
 
   end

data/lib/xapian_db/document_blueprint.rb

@@ -19,6 +19,8 @@ module XapianDb
   # @author Gernot Kogler
   class DocumentBlueprint
 
+    include XapianDb::Utilities
+
     # ---------------------------------------------------------------------------------
     # Singleton methods
     # ---------------------------------------------------------------------------------
@@ -295,13 +297,6 @@ module XapianDb
       @reserved_method_names.include?(attr_name.to_sym)
     end
 
-    private
-
-    # TODO: move this to a helper module
-    def camelize(string)
-      string.split(/[^a-z0-9]/i).map{|w| w.capitalize}.join
-    end
-
   end
 
 end

data/lib/xapian_db/index_writers/transactional_writer.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+# This writer collects index change requests but does not submit them immediately to the database.
+# The index changes are applied when the commit method is called.
+# This writer is intended for internal use only. Do not use it in a xapian configuration!
+# @author Gernot Kogler
+
+module XapianDb
+  module IndexWriters
+
+    class TransactionalWriter
+
+      attr_reader :index_requests, :unindex_requests
+
+      # Constructor
+      def initialize
+        @index_requests   = []
+        @unindex_requests = []
+      end
+
+      # Update an object in the index
+      # @param [Object] obj An instance of a class with a blueprint configuration
+      def index(obj)
+        @index_requests << obj
+      end
+
+      # Remove an object from the index
+      # @param [Object] obj An instance of a class with a blueprint configuration
+      def unindex(obj)
+        @unindex_requests << obj
+      end
+
+      # Reindex all objects of a given class
+      # @param [Class] klass The class to reindex
+      # @param [Hash] options Options for reindexing
+      # @option options [Boolean] :verbose (false) Should the reindexing give status informations?
+      def reindex_class(klass, options={})
+        raise "rebuild_xapian_index is not supported in transactions"
+      end
+
+      # Commit all pending changes to the database
+      # @param [DirectWriter, BeanstalkWriter] writer The writer to use
+      def commit_using(writer)
+        @index_requests.each { |obj| writer.index obj }
+        @unindex_requests.each { |obj| writer.unindex obj }
+      end
+
+    end
+
+  end
+end

data/lib/xapian_db/railtie.rb

@@ -34,10 +34,10 @@ module XapianDb
         else
           config.database File.expand_path @database_path
         end
-        config.adapter @adapter.to_sym
-        config.writer @writer.to_sym
+        config.adapter @adapter.try(:to_sym)
+        config.writer @writer.try(:to_sym)
         config.beanstalk_daemon_url @beanstalk_daemon
-        config.language @language
+        config.language @language.try(:to_sym)
       end
 
     end
@@ -66,7 +66,6 @@ module XapianDb
     @adapter          = :active_record
     @writer           = :direct
     @beanstalk_daemon = nil
-    @language         = :en
   end
 
   end

data/lib/xapian_db/utilities.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+# Collection of utility methods
+# @author Gernot Kogler
+module XapianDb
+  module Utilities
+
+    # Convert a string to camel case
+    # @param [String] The string to camelize
+    # @return [String] The camelized string
+    def camelize(string)
+      string.split(/[^a-z0-9]/i).map{|w| w.capitalize}.join
+    end
+
+  end
+end

data/lib/xapian_db.rb

@@ -34,6 +34,7 @@ module XapianDb
   # for available options
   def self.setup(&block)
     XapianDb::Config.setup(&block)
+    @writer = XapianDb::Config.writer
   end
 
   # Create a database
@@ -84,6 +85,26 @@ module XapianDb
     XapianDb::Config.database.facets(expression)
   end
 
+  # Update an object in the index
+  # @param [Object] obj An instance of a class with a blueprint configuration
+  def self.index(obj)
+    @writer.index obj
+  end
+
+  # Remove an object from the index
+  # @param [Object] obj An instance of a class with a blueprint configuration
+  def self.unindex(obj)
+    @writer.unindex obj
+  end
+
+  # Reindex all objects of a given class
+  # @param [Class] klass The class to reindex
+  # @param [Hash] options Options for reindexing
+  # @option options [Boolean] :verbose (false) Should the reindexing give status informations?
+  def self.reindex_class(klass, options={})
+    @writer.reindex_class klass, options
+  end
+
   # Rebuild the xapian index for all configured blueprints
   # @param [Hash] options Options for reindexing
   # @option options [Boolean] :verbose (false) Should the reindexing give status informations?
@@ -97,11 +118,32 @@ module XapianDb
     true
   end
 
+  # Execute a block as a transaction
+  def self.transaction(&block)
+    # Temporarily use the transactional writer
+    @writer = XapianDb::IndexWriters::TransactionalWriter.new
+    begin
+      block.call
+      @writer.commit_using XapianDb::Config.writer
+    rescue Exception => ex
+      msg = "error in XapianDb transaction block: #{ex}, transaction aborted"
+      if defined?(Rails)
+        Rails.logger.error msg
+      else
+        puts msg
+      end
+    ensure
+      # switch back to the configured writer
+      @writer = XapianDb::Config.writer
+    end
+  end
+
 end
 
-do_not_require = %w(update_stopwords.rb railtie.rb base_adapter.rb beanstalk_writer.rb)
+do_not_require = %w(update_stopwords.rb railtie.rb base_adapter.rb beanstalk_writer.rb utilities.rb)
 files = Dir.glob("#{File.dirname(__FILE__)}/**/*.rb").reject{|path| do_not_require.include?(File.basename(path))}
-# Require the base adapter first
+# Require these first
+require "#{File.dirname(__FILE__)}/xapian_db/utilities"
 require "#{File.dirname(__FILE__)}/xapian_db/adapters/base_adapter"
 files.each {|file| require file}
 

metadata

@@ -1,8 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: xapian_db
 version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.5.7
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 8
+  version: 0.5.8
 platform: ruby
 authors: 
 - Gernot Kogler
@@ -10,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-07 00:00:00 +01:00
+date: 2011-03-23 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -21,6 +25,10 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 1
         version: 2.3.1
   type: :development
   version_requirements: *id001
@@ -32,6 +40,10 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 7
         version: 0.3.7
   type: :development
   version_requirements: *id002
@@ -43,6 +55,10 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 0
         version: 1.1.0
   type: :development
   version_requirements: *id003
@@ -65,6 +81,7 @@ files:
 - lib/xapian_db/index_writers/beanstalk_worker.rb
 - lib/xapian_db/index_writers/beanstalk_writer.rb
 - lib/xapian_db/index_writers/direct_writer.rb
+- lib/xapian_db/index_writers/transactional_writer.rb
 - lib/xapian_db/indexer.rb
 - lib/xapian_db/query_parser.rb
 - lib/xapian_db/railtie.rb
@@ -86,6 +103,7 @@ files:
 - lib/xapian_db/stopwords/ru.txt
 - lib/xapian_db/stopwords/sv.txt
 - lib/xapian_db/stopwords/update_stopwords.rb
+- lib/xapian_db/utilities.rb
 - lib/xapian_db.rb
 - tasks/beanstalk_worker.rake
 - xapian_source/xapian-bindings-1.2.4.tar.gz
@@ -113,17 +131,23 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
       version: 1.3.6
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.0
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Ruby library to use a Xapian db as a key/value store with high performance fulltext search